| <!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-plugin.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-plugin_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-plugin.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef PROTON_SASL_PLUGIN_H</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define PROTON_SASL_PLUGIN_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="l00035"></a><span class="lineno"> 35</span> <span class="comment">/*</span></div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> Internal SASL authenticator interface: These are the entry points to a SASL implementations</span></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span> </div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> Free up all data structures allocated by the SASL implementation</span></div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> void free(pn_transport_t *transport);</span></div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"></span> </div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> Return space separated list of supported mechanisms (client and server)</span></div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> If the returned string is dynamically allocated by the SASL implemetation</span></div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> it must stay valid until the free entry point is called.</span></div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> const char *list_mechs(pn_transport_t *transport);</span></div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"></span> </div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> Initialise for either client or server (can't call both for a</span></div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> given transport/connection):</span></div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> bool init_server(pn_transport_t *transport);</span></div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> bool init_client(pn_transport_t *transport);</span></div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"></span> </div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> Writing:</span></div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> void prepare_write(pn_transport_t *transport);</span></div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"></span> </div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> Reading:</span></div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> Server side (process server SASL messages):</span></div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> void process_init(pn_transport_t *transport, const char *mechanism, const pn_bytes_t *recv);</span></div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> void process_response(pn_transport_t *transport, const pn_bytes_t *recv);</span></div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"></span> </div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> Client side (process client SASL messages)</span></div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> bool process_mechanisms(pn_transport_t *transport, const char *mechs);</span></div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> void process_challenge(pn_transport_t *transport, const pn_bytes_t *recv);</span></div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> void process_outcome(pn_transport_t *transport);</span></div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"></span> </div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> Security layer interface (active after SASL succeeds)</span></div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> bool can_encrypt(pn_transport_t *transport);</span></div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> ssize_t max_encrypt_size(pn_transport_t *transport);</span></div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> ssize_t encode(pn_transport_t *transport, pn_bytes_t in, pn_bytes_t *out);</span></div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> ssize_t decode(pn_transport_t *transport, pn_bytes_t in, pn_bytes_t *out);</span></div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">*/</span></div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>pnx_sasl_implementation</div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> {</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  void (*free)(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* (*list_mechs)(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  bool (*init_server)(<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>  bool (*init_client)(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  void (*prepare_write)(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  </div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  void (*process_init)(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, <span class="keyword">const</span> <span class="keywordtype">char</span> *mechanism, <span class="keyword">const</span> <a class="code" href="group__api__types.html#structpn__bytes__t">pn_bytes_t</a> *recv);</div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  void (*process_response)(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, <span class="keyword">const</span> <a class="code" href="group__api__types.html#structpn__bytes__t">pn_bytes_t</a> *recv);</div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  bool (*process_mechanisms)(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, <span class="keyword">const</span> <span class="keywordtype">char</span> *mechs);</div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  void (*process_challenge)(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, <span class="keyword">const</span> <a class="code" href="group__api__types.html#structpn__bytes__t">pn_bytes_t</a> *recv);</div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  void (*process_outcome)(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  bool (*can_encrypt)(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  ssize_t (*max_encrypt_size)(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div> |
| <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  ssize_t (*encode)(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, <a class="code" href="group__api__types.html#structpn__bytes__t">pn_bytes_t</a> in, <a class="code" href="group__api__types.html#structpn__bytes__t">pn_bytes_t</a> *out);</div> |
| <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  ssize_t (*decode)(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, <a class="code" href="group__api__types.html#structpn__bytes__t">pn_bytes_t</a> in, <a class="code" href="group__api__types.html#structpn__bytes__t">pn_bytes_t</a> *out);</div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  </div> |
| <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> } pnx_sasl_implementation;</div> |
| <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  </div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment">/* Shared SASL API used by the actual SASL authenticators */</span></div> |
| <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="keyword">enum</span> pnx_sasl_state {</div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  SASL_NONE,</div> |
| <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  SASL_POSTED_INIT,</div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  SASL_POSTED_MECHANISMS,</div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  SASL_POSTED_RESPONSE,</div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  SASL_POSTED_CHALLENGE,</div> |
| <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  SASL_RECVED_OUTCOME_SUCCEED,</div> |
| <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  SASL_RECVED_OUTCOME_FAIL,</div> |
| <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  SASL_POSTED_OUTCOME,</div> |
| <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  SASL_ERROR</div> |
| <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> };</div> |
| <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  </div> |
| <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment">/* APIs used by sasl implementations */</span></div> |
| <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> PN_EXTERN <span class="keywordtype">void</span> pnx_sasl_logf(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, <span class="keyword">const</span> <span class="keywordtype">char</span> *format, ...);</div> |
| <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> PN_EXTERN <span class="keywordtype">void</span> pnx_sasl_error(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, <span class="keyword">const</span> <span class="keywordtype">char</span>* err, <span class="keyword">const</span> <span class="keywordtype">char</span>* condition_name);</div> |
| <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  </div> |
| <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> PN_EXTERN <span class="keywordtype">void</span> *pnx_sasl_get_context(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div> |
| <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> PN_EXTERN <span class="keywordtype">void</span> pnx_sasl_set_context(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, <span class="keywordtype">void</span> *context);</div> |
| <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  </div> |
| <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> PN_EXTERN <span class="keywordtype">bool</span> pnx_sasl_is_client(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div> |
| <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> PN_EXTERN <span class="keywordtype">bool</span> pnx_sasl_is_included_mech(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, <a class="code" href="group__api__types.html#structpn__bytes__t">pn_bytes_t</a> s);</div> |
| <div class="line"><a name="l00118"></a><span class="lineno"> 118</span> PN_EXTERN <span class="keywordtype">bool</span> pnx_sasl_is_transport_encrypted(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div> |
| <div class="line"><a name="l00119"></a><span class="lineno"> 119</span> PN_EXTERN <span class="keywordtype">bool</span> pnx_sasl_get_allow_insecure_mechs(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div> |
| <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> PN_EXTERN <span class="keywordtype">bool</span> pnx_sasl_get_auth_required(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div> |
| <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> PN_EXTERN <span class="keyword">const</span> <span class="keywordtype">char</span> *pnx_sasl_get_external_username(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div> |
| <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> PN_EXTERN <span class="keywordtype">int</span> pnx_sasl_get_external_ssf(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div> |
| <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  </div> |
| <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> PN_EXTERN <span class="keyword">const</span> <span class="keywordtype">char</span> *pnx_sasl_get_username(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div> |
| <div class="line"><a name="l00125"></a><span class="lineno"> 125</span> PN_EXTERN <span class="keyword">const</span> <span class="keywordtype">char</span> *pnx_sasl_get_password(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div> |
| <div class="line"><a name="l00126"></a><span class="lineno"> 126</span> PN_EXTERN <span class="keywordtype">void</span> pnx_sasl_clear_password(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div> |
| <div class="line"><a name="l00127"></a><span class="lineno"> 127</span> PN_EXTERN <span class="keyword">const</span> <span class="keywordtype">char</span> *pnx_sasl_get_remote_fqdn(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div> |
| <div class="line"><a name="l00128"></a><span class="lineno"> 128</span> PN_EXTERN <span class="keyword">const</span> <span class="keywordtype">char</span> *pnx_sasl_get_selected_mechanism(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div> |
| <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  </div> |
| <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> PN_EXTERN <span class="keywordtype">void</span> pnx_sasl_set_bytes_out(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, <a class="code" href="group__api__types.html#structpn__bytes__t">pn_bytes_t</a> bytes);</div> |
| <div class="line"><a name="l00131"></a><span class="lineno"> 131</span> PN_EXTERN <span class="keywordtype">void</span> pnx_sasl_set_desired_state(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, <span class="keyword">enum</span> pnx_sasl_state desired_state);</div> |
| <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> PN_EXTERN <span class="keywordtype">void</span> pnx_sasl_set_selected_mechanism(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, <span class="keyword">const</span> <span class="keywordtype">char</span> *mechanism);</div> |
| <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> PN_EXTERN <span class="keywordtype">void</span> pnx_sasl_set_local_hostname(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * transport, <span class="keyword">const</span> <span class="keywordtype">char</span> * fqdn);</div> |
| <div class="line"><a name="l00134"></a><span class="lineno"> 134</span> PN_EXTERN <span class="keywordtype">void</span> pnx_sasl_succeed_authentication(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, <span class="keyword">const</span> <span class="keywordtype">char</span> *username);</div> |
| <div class="line"><a name="l00135"></a><span class="lineno"> 135</span> PN_EXTERN <span class="keywordtype">void</span> pnx_sasl_fail_authentication(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div> |
| <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  </div> |
| <div class="line"><a name="l00137"></a><span class="lineno"> 137</span> PN_EXTERN <span class="keywordtype">void</span> pnx_sasl_set_implementation(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, <span class="keyword">const</span> pnx_sasl_implementation *impl, <span class="keywordtype">void</span> *context);</div> |
| <div class="line"><a name="l00138"></a><span class="lineno"> 138</span> PN_EXTERN <span class="keywordtype">void</span> pnx_sasl_set_default_implementation(<span class="keyword">const</span> pnx_sasl_implementation *impl);</div> |
| <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  </div> |
| <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="preprocessor">#ifdef __cplusplus</span></div> |
| <div class="line"><a name="l00143"></a><span class="lineno"> 143</span> }</div> |
| <div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  </div> |
| <div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="preprocessor">#endif </span><span class="comment">/* sasl-plugin.h */</span><span class="preprocessor"></span></div> |
| </div><!-- fragment --></div><!-- contents --> |
| </div><!-- doc-content --> |
| <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__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__api__types_html_structpn__bytes__t"><div class="ttname"><a href="group__api__types.html#structpn__bytes__t">pn_bytes_t</a></div><div class="ttdoc">A const byte buffer.</div><div class="ttdef"><b>Definition:</b> types.h:216</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"><b>sasl-plugin.h</b></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> |
