| <!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 Source File</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_source.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="headertitle"> |
| <div class="title">sasl.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="sasl_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"><a class="line" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0"> 1</a></span> <span class="preprocessor">#ifndef PROTON_SASL_H</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define PROTON_SASL_H 1</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/*</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * under the License.</span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <proton/import_export.h></span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <proton/type_compat.h></span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="types_8h.html">proton/types.h</a>></span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#ifdef __cplusplus</span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> <a class="code" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a>;</div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div> |
| <div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="group__sasl.html#gad44e79f52e0669b1930689b56dfa9c3b"> 54</a></span> <span class="keyword">typedef</span> <span class="keyword">enum</span> {</div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  PN_SASL_NONE = -1, </div> |
| <div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3ba0050b91650a3826a090e13f57b3b941e"> 56</a></span>  <a class="code" href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3ba0050b91650a3826a090e13f57b3b941e">PN_SASL_OK</a> = 0, </div> |
| <div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3bac63734ecde7c8170554f6bf04f6ce64a"> 57</a></span>  <a class="code" href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3bac63734ecde7c8170554f6bf04f6ce64a">PN_SASL_AUTH</a> = 1, </div> |
| <div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3bacd46a2fda23f674c23ed81e6076c1939"> 58</a></span>  <a class="code" href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3bacd46a2fda23f674c23ed81e6076c1939">PN_SASL_SYS</a> = 2, </div> |
| <div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3ba03019f909ba1d98aae94437ca4bd0191"> 59</a></span>  <a class="code" href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3ba03019f909ba1d98aae94437ca4bd0191">PN_SASL_PERM</a> = 3, </div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <a class="code" href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3baee28d2c03fa80dccf771e37aae1bcdf3">PN_SASL_TEMP</a> = 4 </div> |
| <div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3baee28d2c03fa80dccf771e37aae1bcdf3"> 61</a></span> } <a class="code" href="group__sasl.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_outcome_t</a>;</div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div> |
| <div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="group__sasl.html#ga7968e80e2fe9360fc14cf865dd1ac21c"> 77</a></span> PN_EXTERN <a class="code" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *<a class="code" href="group__sasl.html#ga7968e80e2fe9360fc14cf865dd1ac21c">pn_sasl</a>(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  </div> |
| <div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="group__sasl.html#ga1737191972d5dded0993bf1431e71df0"> 91</a></span> PN_EXTERN <span class="keywordtype">bool</span> <a class="code" href="group__sasl.html#ga1737191972d5dded0993bf1431e71df0">pn_sasl_extended</a>(<span class="keywordtype">void</span>);</div> |
| <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  </div> |
| <div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="group__sasl.html#ga0199871440c4ff89a204cc1d8a09f283"> 101</a></span> PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__sasl.html#ga0199871440c4ff89a204cc1d8a09f283">pn_sasl_done</a>(<a class="code" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, <a class="code" href="group__sasl.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_outcome_t</a> outcome);</div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  </div> |
| <div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="group__sasl.html#ga03b6daf742db6a07bd7d03cb197aedb6"> 106</a></span> PN_EXTERN <a class="code" href="group__sasl.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_outcome_t</a> <a class="code" href="group__sasl.html#ga03b6daf742db6a07bd7d03cb197aedb6">pn_sasl_outcome</a>(<a class="code" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl);</div> |
| <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  </div> |
| <div class="line"><a name="l00125"></a><span class="lineno"><a class="line" href="group__sasl.html#ga700e1d505068f895383dd932af55987e"> 125</a></span> PN_EXTERN <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__sasl.html#ga700e1d505068f895383dd932af55987e">pn_sasl_get_user</a>(<a class="code" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl);</div> |
| <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  </div> |
| <div class="line"><a name="l00136"></a><span class="lineno"><a class="line" href="group__sasl.html#ga895b6a957bf0c0204aaddb3ec5b9d863"> 136</a></span> PN_EXTERN <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__sasl.html#ga895b6a957bf0c0204aaddb3ec5b9d863">pn_sasl_get_mech</a>(<a class="code" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl);</div> |
| <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  </div> |
| <div class="line"><a name="l00155"></a><span class="lineno"><a class="line" href="group__sasl.html#ga73299a6a22e141e7911a739590032625"> 155</a></span> PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__sasl.html#ga73299a6a22e141e7911a739590032625">pn_sasl_allowed_mechs</a>(<a class="code" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, <span class="keyword">const</span> <span class="keywordtype">char</span> *mechs);</div> |
| <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  </div> |
| <div class="line"><a name="l00174"></a><span class="lineno"><a class="line" href="group__sasl.html#gaf472325bc055bb18a5a6f5ca03eda315"> 174</a></span> PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__sasl.html#gaf472325bc055bb18a5a6f5ca03eda315">pn_sasl_set_allow_insecure_mechs</a>(<a class="code" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, <span class="keywordtype">bool</span> insecure);</div> |
| <div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  </div> |
| <div class="line"><a name="l00181"></a><span class="lineno"><a class="line" href="group__sasl.html#gac53ad15ee429b7ce9d0c598d1e347243"> 181</a></span> PN_EXTERN <span class="keywordtype">bool</span> <a class="code" href="group__sasl.html#gac53ad15ee429b7ce9d0c598d1e347243">pn_sasl_get_allow_insecure_mechs</a>(<a class="code" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl);</div> |
| <div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  </div> |
| <div class="line"><a name="l00195"></a><span class="lineno"><a class="line" href="group__sasl.html#gad1a6932135165f0e5b7639b79ac71c56"> 195</a></span> PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__sasl.html#gad1a6932135165f0e5b7639b79ac71c56">pn_sasl_config_name</a>(<a class="code" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, <span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div> |
| <div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  </div> |
| <div class="line"><a name="l00212"></a><span class="lineno"><a class="line" href="group__sasl.html#gabf4176414424ce02a4e03b4338d30521"> 212</a></span> PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__sasl.html#gabf4176414424ce02a4e03b4338d30521">pn_sasl_config_path</a>(<a class="code" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, <span class="keyword">const</span> <span class="keywordtype">char</span> *path);</div> |
| <div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  </div> |
| <div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="preprocessor">#ifdef __cplusplus</span></div> |
| <div class="line"><a name="l00219"></a><span class="lineno"> 219</span> }</div> |
| <div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  </div> |
| <div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="preprocessor">#endif </span><span class="comment">/* sasl.h */</span><span class="preprocessor"></span></div> |
| </div><!-- fragment --></div><!-- contents --> |
| </div><!-- doc-content --> |
| <div class="ttc" id="agroup__sasl_html_ggad44e79f52e0669b1930689b56dfa9c3ba0050b91650a3826a090e13f57b3b941e"><div class="ttname"><a href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3ba0050b91650a3826a090e13f57b3b941e">PN_SASL_OK</a></div><div class="ttdeci">@ PN_SASL_OK</div><div class="ttdoc">negotiation not completed</div><div class="ttdef"><b>Definition:</b> sasl.h:56</div></div> |
| <div class="ttc" id="agroup__sasl_html_gac53ad15ee429b7ce9d0c598d1e347243"><div class="ttname"><a href="group__sasl.html#gac53ad15ee429b7ce9d0c598d1e347243">pn_sasl_get_allow_insecure_mechs</a></div><div class="ttdeci">bool pn_sasl_get_allow_insecure_mechs(pn_sasl_t *sasl)</div><div class="ttdoc">Return the current value for allow_insecure_mechs.</div></div> |
| <div class="ttc" id="atypes_8h_html"><div class="ttname"><a href="types_8h.html">types.h</a></div><div class="ttdoc">AMQP and API data types.</div></div> |
| <div class="ttc" id="agroup__sasl_html_ggad44e79f52e0669b1930689b56dfa9c3baee28d2c03fa80dccf771e37aae1bcdf3"><div class="ttname"><a href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3baee28d2c03fa80dccf771e37aae1bcdf3">PN_SASL_TEMP</a></div><div class="ttdeci">@ PN_SASL_TEMP</div><div class="ttdoc">failed due to unrecoverable error</div><div class="ttdef"><b>Definition:</b> sasl.h:60</div></div> |
| <div class="ttc" id="agroup__sasl_html_ga700e1d505068f895383dd932af55987e"><div class="ttname"><a href="group__sasl.html#ga700e1d505068f895383dd932af55987e">pn_sasl_get_user</a></div><div class="ttdeci">const char * pn_sasl_get_user(pn_sasl_t *sasl)</div><div class="ttdoc">Retrieve the authenticated user.</div></div> |
| <div class="ttc" id="agroup__sasl_html_ggad44e79f52e0669b1930689b56dfa9c3bacd46a2fda23f674c23ed81e6076c1939"><div class="ttname"><a href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3bacd46a2fda23f674c23ed81e6076c1939">PN_SASL_SYS</a></div><div class="ttdeci">@ PN_SASL_SYS</div><div class="ttdoc">failed due to bad credentials</div><div class="ttdef"><b>Definition:</b> sasl.h:58</div></div> |
| <div class="ttc" id="agroup__sasl_html_gaf472325bc055bb18a5a6f5ca03eda315"><div class="ttname"><a href="group__sasl.html#gaf472325bc055bb18a5a6f5ca03eda315">pn_sasl_set_allow_insecure_mechs</a></div><div class="ttdeci">void pn_sasl_set_allow_insecure_mechs(pn_sasl_t *sasl, bool insecure)</div><div class="ttdoc">Boolean to allow use of clear text authentication mechanisms.</div></div> |
| <div class="ttc" id="agroup__transport_html_gac26eda05f649bbf0399f3d8d78d12fa8"><div class="ttname"><a href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a></div><div class="ttdeci">struct pn_transport_t pn_transport_t</div><div class="ttdoc">A network channel supporting an AMQP connection.</div><div class="ttdef"><b>Definition:</b> types.h:435</div></div> |
| <div class="ttc" id="agroup__sasl_html_ga1737191972d5dded0993bf1431e71df0"><div class="ttname"><a href="group__sasl.html#ga1737191972d5dded0993bf1431e71df0">pn_sasl_extended</a></div><div class="ttdeci">bool pn_sasl_extended(void)</div><div class="ttdoc">Do we support extended SASL negotiation.</div></div> |
| <div class="ttc" id="agroup__sasl_html_ga03b6daf742db6a07bd7d03cb197aedb6"><div class="ttname"><a href="group__sasl.html#ga03b6daf742db6a07bd7d03cb197aedb6">pn_sasl_outcome</a></div><div class="ttdeci">pn_sasl_outcome_t pn_sasl_outcome(pn_sasl_t *sasl)</div><div class="ttdoc">Retrieve the outcome of SASL negotiation.</div></div> |
| <div class="ttc" id="agroup__sasl_html_gad44e79f52e0669b1930689b56dfa9c3b"><div class="ttname"><a href="group__sasl.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_outcome_t</a></div><div class="ttdeci">pn_sasl_outcome_t</div><div class="ttdoc">The result of the SASL negotiation.</div><div class="ttdef"><b>Definition:</b> sasl.h:54</div></div> |
| <div class="ttc" id="agroup__sasl_html_ggad44e79f52e0669b1930689b56dfa9c3bac63734ecde7c8170554f6bf04f6ce64a"><div class="ttname"><a href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3bac63734ecde7c8170554f6bf04f6ce64a">PN_SASL_AUTH</a></div><div class="ttdeci">@ PN_SASL_AUTH</div><div class="ttdoc">authentication succeeded</div><div class="ttdef"><b>Definition:</b> sasl.h:57</div></div> |
| <div class="ttc" id="agroup__sasl_html_gad1a6932135165f0e5b7639b79ac71c56"><div class="ttname"><a href="group__sasl.html#gad1a6932135165f0e5b7639b79ac71c56">pn_sasl_config_name</a></div><div class="ttdeci">void pn_sasl_config_name(pn_sasl_t *sasl, const char *name)</div><div class="ttdoc">Set the sasl configuration name.</div></div> |
| <div class="ttc" id="agroup__sasl_html_ga73299a6a22e141e7911a739590032625"><div class="ttname"><a href="group__sasl.html#ga73299a6a22e141e7911a739590032625">pn_sasl_allowed_mechs</a></div><div class="ttdeci">void pn_sasl_allowed_mechs(pn_sasl_t *sasl, const char *mechs)</div><div class="ttdoc">SASL mechanisms that are to be considered for authentication.</div></div> |
| <div class="ttc" id="agroup__sasl_html_gabf4176414424ce02a4e03b4338d30521"><div class="ttname"><a href="group__sasl.html#gabf4176414424ce02a4e03b4338d30521">pn_sasl_config_path</a></div><div class="ttdeci">void pn_sasl_config_path(pn_sasl_t *sasl, const char *path)</div><div class="ttdoc">Set the sasl configuration path.</div></div> |
| <div class="ttc" id="agroup__sasl_html_ggad44e79f52e0669b1930689b56dfa9c3ba03019f909ba1d98aae94437ca4bd0191"><div class="ttname"><a href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3ba03019f909ba1d98aae94437ca4bd0191">PN_SASL_PERM</a></div><div class="ttdeci">@ PN_SASL_PERM</div><div class="ttdoc">failed due to a system error</div><div class="ttdef"><b>Definition:</b> sasl.h:59</div></div> |
| <div class="ttc" id="agroup__sasl_html_ga4d21fddba80d3f88d0529aafe12328b0"><div class="ttname"><a href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a></div><div class="ttdeci">struct pn_sasl_t pn_sasl_t</div><div class="ttdoc">The SASL layer is responsible for establishing an authenticated and/or encrypted tunnel over which AM...</div><div class="ttdef"><b>Definition:</b> sasl.h:49</div></div> |
| <div class="ttc" id="agroup__sasl_html_ga895b6a957bf0c0204aaddb3ec5b9d863"><div class="ttname"><a href="group__sasl.html#ga895b6a957bf0c0204aaddb3ec5b9d863">pn_sasl_get_mech</a></div><div class="ttdeci">const char * pn_sasl_get_mech(pn_sasl_t *sasl)</div><div class="ttdoc">Return the selected SASL mechanism.</div></div> |
| <div class="ttc" id="agroup__sasl_html_ga7968e80e2fe9360fc14cf865dd1ac21c"><div class="ttname"><a href="group__sasl.html#ga7968e80e2fe9360fc14cf865dd1ac21c">pn_sasl</a></div><div class="ttdeci">pn_sasl_t * pn_sasl(pn_transport_t *transport)</div><div class="ttdoc">Construct an Authentication and Security Layer object.</div></div> |
| <div class="ttc" id="agroup__sasl_html_ga0199871440c4ff89a204cc1d8a09f283"><div class="ttname"><a href="group__sasl.html#ga0199871440c4ff89a204cc1d8a09f283">pn_sasl_done</a></div><div class="ttdeci">void pn_sasl_done(pn_sasl_t *sasl, pn_sasl_outcome_t outcome)</div><div class="ttdoc">Deprecated - Do not use.</div></div> |
| <!-- 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> |
