| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.20"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Qpid Proton C API: proton/sasl.h File Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function() { init_search(); }); |
| /* @license-end */ |
| </script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Qpid Proton C API |
|  <span id="projectnumber">0.32.0</span> |
| </div> |
| </td> |
| <td> <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.svg" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a> |
| </span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.20 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('sasl_8h.html',''); initResizable(); }); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div class="header"> |
| <div class="summary"> |
| <a href="#typedef-members">Typedefs</a> | |
| <a href="#enum-members">Enumerations</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">sasl.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>SASL secure transport layer. |
| <a href="#details">More...</a></p> |
| <div class="textblock"><code>#include <proton/import_export.h></code><br /> |
| <code>#include <proton/type_compat.h></code><br /> |
| <code>#include <<a class="el" href="types_8h_source.html">proton/types.h</a>></code><br /> |
| </div> |
| <p><a href="sasl_8h_source.html">Go to the source code of this file.</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> |
| Typedefs</h2></td></tr> |
| <tr class="memitem:ga4d21fddba80d3f88d0529aafe12328b0"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a></td></tr> |
| <tr class="memdesc:ga4d21fddba80d3f88d0529aafe12328b0"><td class="mdescLeft"> </td><td class="mdescRight">The SASL layer is responsible for establishing an authenticated and/or encrypted tunnel over which AMQP frames are passed between peers. <a href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">More...</a><br /></td></tr> |
| <tr class="separator:ga4d21fddba80d3f88d0529aafe12328b0"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> |
| Enumerations</h2></td></tr> |
| <tr class="memitem:gad44e79f52e0669b1930689b56dfa9c3b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sasl.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_outcome_t</a> { <br /> |
|   <b>PN_SASL_NONE</b>, |
| <a class="el" href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3ba0050b91650a3826a090e13f57b3b941e">PN_SASL_OK</a>, |
| <a class="el" href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3bac63734ecde7c8170554f6bf04f6ce64a">PN_SASL_AUTH</a>, |
| <a class="el" href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3bacd46a2fda23f674c23ed81e6076c1939">PN_SASL_SYS</a>, |
| <br /> |
|   <a class="el" href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3ba03019f909ba1d98aae94437ca4bd0191">PN_SASL_PERM</a>, |
| <a class="el" href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3baee28d2c03fa80dccf771e37aae1bcdf3">PN_SASL_TEMP</a> |
| <br /> |
| }</td></tr> |
| <tr class="memdesc:gad44e79f52e0669b1930689b56dfa9c3b"><td class="mdescLeft"> </td><td class="mdescRight">The result of the SASL negotiation. <a href="group__sasl.html#gad44e79f52e0669b1930689b56dfa9c3b">More...</a><br /></td></tr> |
| <tr class="separator:gad44e79f52e0669b1930689b56dfa9c3b"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:ga7968e80e2fe9360fc14cf865dd1ac21c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sasl.html#ga7968e80e2fe9360fc14cf865dd1ac21c">pn_sasl</a> (<a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> |
| <tr class="memdesc:ga7968e80e2fe9360fc14cf865dd1ac21c"><td class="mdescLeft"> </td><td class="mdescRight">Construct an Authentication and Security Layer object. <a href="group__sasl.html#ga7968e80e2fe9360fc14cf865dd1ac21c">More...</a><br /></td></tr> |
| <tr class="separator:ga7968e80e2fe9360fc14cf865dd1ac21c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga1737191972d5dded0993bf1431e71df0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sasl.html#ga1737191972d5dded0993bf1431e71df0">pn_sasl_extended</a> (void)</td></tr> |
| <tr class="memdesc:ga1737191972d5dded0993bf1431e71df0"><td class="mdescLeft"> </td><td class="mdescRight">Do we support extended SASL negotiation. <a href="group__sasl.html#ga1737191972d5dded0993bf1431e71df0">More...</a><br /></td></tr> |
| <tr class="separator:ga1737191972d5dded0993bf1431e71df0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga0199871440c4ff89a204cc1d8a09f283"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sasl.html#ga0199871440c4ff89a204cc1d8a09f283">pn_sasl_done</a> (<a class="el" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, <a class="el" href="group__sasl.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_outcome_t</a> outcome)</td></tr> |
| <tr class="memdesc:ga0199871440c4ff89a204cc1d8a09f283"><td class="mdescLeft"> </td><td class="mdescRight"><b>Deprecated</b> - Do not use. <a href="group__sasl.html#ga0199871440c4ff89a204cc1d8a09f283">More...</a><br /></td></tr> |
| <tr class="separator:ga0199871440c4ff89a204cc1d8a09f283"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga03b6daf742db6a07bd7d03cb197aedb6"><td class="memItemLeft" align="right" valign="top"> |
| <a class="el" href="group__sasl.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_outcome_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sasl.html#ga03b6daf742db6a07bd7d03cb197aedb6">pn_sasl_outcome</a> (<a class="el" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl)</td></tr> |
| <tr class="memdesc:ga03b6daf742db6a07bd7d03cb197aedb6"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the outcome of SASL negotiation. <br /></td></tr> |
| <tr class="separator:ga03b6daf742db6a07bd7d03cb197aedb6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga700e1d505068f895383dd932af55987e"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sasl.html#ga700e1d505068f895383dd932af55987e">pn_sasl_get_user</a> (<a class="el" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl)</td></tr> |
| <tr class="memdesc:ga700e1d505068f895383dd932af55987e"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the authenticated user. <a href="group__sasl.html#ga700e1d505068f895383dd932af55987e">More...</a><br /></td></tr> |
| <tr class="separator:ga700e1d505068f895383dd932af55987e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga895b6a957bf0c0204aaddb3ec5b9d863"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sasl.html#ga895b6a957bf0c0204aaddb3ec5b9d863">pn_sasl_get_mech</a> (<a class="el" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl)</td></tr> |
| <tr class="memdesc:ga895b6a957bf0c0204aaddb3ec5b9d863"><td class="mdescLeft"> </td><td class="mdescRight">Return the selected SASL mechanism. <a href="group__sasl.html#ga895b6a957bf0c0204aaddb3ec5b9d863">More...</a><br /></td></tr> |
| <tr class="separator:ga895b6a957bf0c0204aaddb3ec5b9d863"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga73299a6a22e141e7911a739590032625"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sasl.html#ga73299a6a22e141e7911a739590032625">pn_sasl_allowed_mechs</a> (<a class="el" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, const char *mechs)</td></tr> |
| <tr class="memdesc:ga73299a6a22e141e7911a739590032625"><td class="mdescLeft"> </td><td class="mdescRight">SASL mechanisms that are to be considered for authentication. <a href="group__sasl.html#ga73299a6a22e141e7911a739590032625">More...</a><br /></td></tr> |
| <tr class="separator:ga73299a6a22e141e7911a739590032625"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gaf472325bc055bb18a5a6f5ca03eda315"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sasl.html#gaf472325bc055bb18a5a6f5ca03eda315">pn_sasl_set_allow_insecure_mechs</a> (<a class="el" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, bool insecure)</td></tr> |
| <tr class="memdesc:gaf472325bc055bb18a5a6f5ca03eda315"><td class="mdescLeft"> </td><td class="mdescRight">Boolean to allow use of clear text authentication mechanisms. <a href="group__sasl.html#gaf472325bc055bb18a5a6f5ca03eda315">More...</a><br /></td></tr> |
| <tr class="separator:gaf472325bc055bb18a5a6f5ca03eda315"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gac53ad15ee429b7ce9d0c598d1e347243"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sasl.html#gac53ad15ee429b7ce9d0c598d1e347243">pn_sasl_get_allow_insecure_mechs</a> (<a class="el" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl)</td></tr> |
| <tr class="memdesc:gac53ad15ee429b7ce9d0c598d1e347243"><td class="mdescLeft"> </td><td class="mdescRight">Return the current value for allow_insecure_mechs. <a href="group__sasl.html#gac53ad15ee429b7ce9d0c598d1e347243">More...</a><br /></td></tr> |
| <tr class="separator:gac53ad15ee429b7ce9d0c598d1e347243"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gad1a6932135165f0e5b7639b79ac71c56"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sasl.html#gad1a6932135165f0e5b7639b79ac71c56">pn_sasl_config_name</a> (<a class="el" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, const char *name)</td></tr> |
| <tr class="memdesc:gad1a6932135165f0e5b7639b79ac71c56"><td class="mdescLeft"> </td><td class="mdescRight">Set the sasl configuration name. <a href="group__sasl.html#gad1a6932135165f0e5b7639b79ac71c56">More...</a><br /></td></tr> |
| <tr class="separator:gad1a6932135165f0e5b7639b79ac71c56"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gabf4176414424ce02a4e03b4338d30521"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sasl.html#gabf4176414424ce02a4e03b4338d30521">pn_sasl_config_path</a> (<a class="el" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, const char *path)</td></tr> |
| <tr class="memdesc:gabf4176414424ce02a4e03b4338d30521"><td class="mdescLeft"> </td><td class="mdescRight">Set the sasl configuration path. <a href="group__sasl.html#gabf4176414424ce02a4e03b4338d30521">More...</a><br /></td></tr> |
| <tr class="separator:gabf4176414424ce02a4e03b4338d30521"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>SASL secure transport layer. </p> |
| </div></div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_3a71568e5d046e5ed52679664c3002a5.html">proton</a></li><li class="navelem"><a class="el" href="sasl_8h.html">sasl.h</a></li> |
| <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
