http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/c/api/sasl-plugin_8h_source.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/sasl-plugin_8h_source.html b/content/releases/qpid-proton-master/proton/c/api/sasl-plugin_8h_source.html index 8738f18..0d83235 100755 --- a/content/releases/qpid-proton-master/proton/c/api/sasl-plugin_8h_source.html +++ b/content/releases/qpid-proton-master/proton/c/api/sasl-plugin_8h_source.html @@ -93,9 +93,9 @@ $(document).ready(function(){initNavTree('sasl-plugin_8h_source.html','');}); <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="l ineno"> 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="l00033"></a><span class="lineno"> 33</span> <span class="comment">// Internal SASL authenticator interface: These are the entry points to a SASL implementations</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">//</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// Free up all data structures allocated by the SASL implementation</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// void free(pn_transport_t *transport);</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">// Return space separated list of supported mechanisms (client and server)</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// If the returned string is dynamically allocated by the SASL implemetation</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// it must stay valid until the free entry point is called.</span></div><div c lass="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// const char *list_mechs(pn_transport_t *transport);</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">//</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">// Initialise for either client or server (can't call both for a</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">// given transport/connection):</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">// bool init_server(pn_transport_t *transport);</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">// bool init_client(pn_transport_t *transport);</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  ;<span class="comment">//</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">// Writing:</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">// void prepare_write(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">// Reading:</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// Server side (process server SASL messages):</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</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="l00054"></a><span class="lineno"> 54</ span> <span class="comment">// void process_response(pn_transport_t *transport, const pn_bytes_t *recv);</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">//</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">// Client side (process client SASL messages)</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">// bool process_mechanisms(pn_transport_t *transport, const char *mechs);</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">// void process_challenge(pn_transport_t *transport, const pn_bytes_t *recv);</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">// void process_outcome(pn_transport_t *transport);</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// Security layer interface (active after SASL succeeds)</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">// bool can_encrypt(pn_transport_t *transport);</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">// ssize_t max_encrypt_size(pn_transport_t *transport);</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</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="l00065"></a><span class="lineno"> 65</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="l00066"></a><span class="lineno"> 66</span> </div><div class= "line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>pnx_sasl_implementation</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> {</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  void (*free)(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</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">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="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> 60; bool (*init_server)(<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>  bool (*init_client)(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  void (*prepare_write)(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  void (*process_init)(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, <span class="keyword">const</sp an> <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="l00079"></a><span class="lineno"> 79</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="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</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="l00082"></a><span class="lineno"> 82</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="l00083"></a><span class="lineno"> 83</span>  void (*process_outcome)(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</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 (*can_encrypt)(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  ssize_t (*max_encrypt_size)(<a class="code" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transp ort_t</a> *transport);</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</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="l00088"></a><span class="lineno"> 88</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="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> } pnx_sasl_implementation;</div>< div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment">// Shared SASL API used by the actual SASL authenticators</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="keyword">enum</span> pnx_sasl_state {</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  SASL_NONE,</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  SASL_POSTED_INIT,</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  SASL_POSTED_MECHANISMS,</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  SASL_POSTED_RESPONSE,</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  SASL_POSTED_CHALLENGE,</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  SASL_RE CVED_OUTCOME_SUCCEED,</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  SASL_RECVED_OUTCOME_FAIL,</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  SASL_POSTED_OUTCOME,</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  SASL_ERROR</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> };</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment">// APIs used by sasl implementations</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</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="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</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="l00109"></a><span class="lineno"> 109</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="l00110"></a><span class="lineno"> 110</span> </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</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="l00112"></a><span class="lineno"> 112</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="l00113"></a><span class="lineno"> 113</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="l00114"></a><span class="lineno"> 114</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="l00115"></a><span class="lineno"> 115</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="l00116"></a><span >class="lineno"> 116</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="l00117"></a><span >class="lineno"> 117</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="l00118"></a><span >class="lineno"> 118</span> </div><div class="line"><a >name="l00119"></a><span class="lineno"> 119</span> PN_EXTERN <span >class="keyword">const</span> <span clas s="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="l00120"></a><span class="lineno"> 120</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="l00121"></a><span class="lineno"> 121</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="l00122"></a><span class="lineno"> 122</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#gac26eda05f649bbf0399f3d8d78d 12fa8">pn_transport_t</a> *transport);</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</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="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</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="l00126"></a><span class="lineno"> 126</span> PN_EXTERN <span class="keywordtype">void</span> pnx_sasl_set_desired_state(<a class="code" href="group__transport.html#gac26e da05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport, <span class="keyword">enum</span> pnx_sasl_state desired_state);</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</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="l00128"></a><span class="lineno"> 128</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="l00129"></a><span class="lineno"> 129</span> PN_EXTERN <span class="keywordtype">void</span> pnx_sasl_succeed_authent ication(<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="l00130"></a><span class="lineno"> 130</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="l00131"></a><span class="lineno"> 131</span> </div><div class="line"><a name="l00132"></a><span class="lineno"> 132</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="l00133"></a><span class="lineno"> 133</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="l00134"></a><span class="lineno"> 134</span> </div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="preprocessor">#ifdef __cplusplus</span></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> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="preprocessor">#endif </span><span class="comment">/* sasl-plugin.h */</span><span class="preprocessor"></span></div><div class="ttc" id="types_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="group__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">An AMQP Transport object. </div><div class="ttdef"><b>Definition:</b> types.h:421</div></div> -<div class="ttc" id="group__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:202</div></div> +<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="l ineno"> 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 c lass="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 *tra nsport);</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 *tran sport);</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#gac26eda05f 649bbf0399f3d8d78d12fa8">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 nam e="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#gac26eda05f 649bbf0399f3d8d78d12fa8">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">p n_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="keywordtyp e">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> </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</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="l00113"></a><span class="lineno"> 113</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="l00114"></a><span class="lineno"> 114</span> </div><div class="line" ><a name="l00115"></a><span class="lineno"> 115</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="l00116"></a><span >class="lineno"> 116</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="l00117"></a><span class="lineno"> >117</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="l00118"></a><span >class="lineno"> 118</span> PN_EXTERN <span class="keywordtype">bool</sp an> 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="l00119"></a><span class="lineno"> 119</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="l00120"></a><span class="lineno"> 120</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="l00121"></a><span class="lineno"> 121</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> *transpo rt);</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</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="l00124"></a><span class="lineno"> 124</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="l00125"></a><span class="lineno"> 125</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="l00126 "></a><span class="lineno"> 126</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="l00127"></a><span class="lineno"> 127</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="l00128"></a><span class="lineno"> 128</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</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_by tes_t</a> bytes);</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</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="l00131"></a><span class="lineno"> 131</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="l00132"></a><span class="lineno"> 132</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="l00133"></a><span class="lineno"> 133</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="l00134"></a><span class="lineno"> 134</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="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> PN_EXTERN <span class="keywordtype">void</span> pnx_sasl_set_implementation(<a class="code" href="group__transport.html#gac26 eda05f649bbf0399f3d8d78d12fa8">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="l00137"></a><span class="lineno"> 137</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="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> }</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</ span> <span class="preprocessor">#endif </span><span class="comment">/* sasl-plugin.h */</span><span class="preprocessor"></span></div><div class="ttc" id="types_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="group__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:431</div></div> +<div class="ttc" id="group__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:212</div></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part -->
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/c/api/sasl_8h.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/sasl_8h.html b/content/releases/qpid-proton-master/proton/c/api/sasl_8h.html index c5a4bd7..eed1a0b 100755 --- a/content/releases/qpid-proton-master/proton/c/api/sasl_8h.html +++ b/content/releases/qpid-proton-master/proton/c/api/sasl_8h.html @@ -138,8 +138,9 @@ Functions</h2></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">Set the outcome of SASL negotiation. <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. <a href="group__sasl.html#ga03b6daf742db6a07bd7d03cb197aedb6">More...</a><br /></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> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/c/api/sasl_8h_source.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/sasl_8h_source.html b/content/releases/qpid-proton-master/proton/c/api/sasl_8h_source.html index b61b3f6..ed5ff37 100755 --- a/content/releases/qpid-proton-master/proton/c/api/sasl_8h_source.html +++ b/content/releases/qpid-proton-master/proton/c/api/sasl_8h_source.html @@ -93,9 +93,9 @@ $(document).ready(function(){initNavTree('sasl_8h_source.html','');}); <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"> 1</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><di v 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</s pan> <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"><a class="line" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0"> 49</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__sasl.html#ga4d21fd dba80d3f88d0529aafe12328b0">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#ggad 44e79f52e0669b1930689b56dfa9c3bac63734ecde7c8170554f6bf04f6ce64a"> 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"><a class="line" href="group__sasl.html#ggad4 4e79f52e0669b1930689b56dfa9c3baee28d2c03fa80dccf771e37aae1bcdf3"> 60</a></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"> 61</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="l00074"></a><span class="lineno"> 74</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="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00088">< /a><span class="lineno"> 88</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="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</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="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> PN_EXTERN <a class="code" href="group__sasl.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_o utcome_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="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</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="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</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="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</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="l00146"></a><span class="lineno"> 146</span> </div><div class="line"><a name="l00164"></a><span class="lineno"> 164</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_sa sl_t</a> *sasl, <span class="keywordtype">bool</span> insecure);</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div><div class="line"><a name="l00171"></a><span class="lineno"> 171</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="l00172"></a><span class="lineno"> 172</span> </div><div class="line"><a name="l00185"></a><span class="lineno"> 185</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="l00186"></a><span class="lineno"> 186</span> </div><div class="line"><a name="l00202"></a><span class="lineno"> 202</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="l00203"></a><span class="lineno"> 203</span> </div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> }</div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> </div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="preprocessor">#endif </span><span class="comment">/* sasl.h */</span><span class="preprocessor"></span></div><div class="ttc" id="types_8h_html"><div class="ttname"><a href="types_8h.html">types.h</a></div><div class="ttdoc">AMQP and API data types. </div></div> +<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"> 1</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><di v 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</s pan> <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"><a class="line" href="group__sasl.html#ga4d21fddba80d3f88d0529aafe12328b0"> 49</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__sasl.html#ga4d21fd dba80d3f88d0529aafe12328b0">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#ggad 44e79f52e0669b1930689b56dfa9c3bac63734ecde7c8170554f6bf04f6ce64a"> 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"><a class="line" href="group__sasl.html#ggad4 4e79f52e0669b1930689b56dfa9c3baee28d2c03fa80dccf771e37aae1bcdf3"> 60</a></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"> 61</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="l00074"></a><span class="lineno"> 74</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="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00088">< /a><span class="lineno"> 88</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="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</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="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> PN_EXTERN <a class="code" href="group__sasl.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_o utcome_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="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</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="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</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="l00131"></a><span class="lineno"> 131</span> </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</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="l00142"></a><span class="lineno"> 142</span> </div><div class="line"><a name="l00160"></a><span class="lineno"> 160</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_sa sl_t</a> *sasl, <span class="keywordtype">bool</span> insecure);</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div><div class="line"><a name="l00167"></a><span class="lineno"> 167</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="l00168"></a><span class="lineno"> 168</span> </div><div class="line"><a name="l00181"></a><span class="lineno"> 181</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="l00182"></a><span class="lineno"> 182</span> </div><div class="line"><a name="l00198"></a><span class="lineno"> 198</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="l00199"></a><span class="lineno"> 199</span> </div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> }</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> </div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="preprocessor">#endif </span><span class="comment">/* sasl.h */</span><span class="preprocessor"></span></div><div class="ttc" id="types_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="group__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="group__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:433</div></div> +<div class="ttc" id="group__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:431</div></div> <div class="ttc" id="group__sasl_html_ggad44e79f52e0669b1930689b56dfa9c3bacd46a2fda23f674c23ed81e6076c1939"><div class="ttname"><a href="group__sasl.html#ggad44e79f52e0669b1930689b56dfa9c3bacd46a2fda23f674c23ed81e6076c1939">PN_SASL_SYS</a></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="group__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="group__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> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/701caf21/content/releases/qpid-proton-master/proton/c/api/search/all_2.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/c/api/search/all_2.js b/content/releases/qpid-proton-master/proton/c/api/search/all_2.js index 8545952..c337d55 100755 --- a/content/releases/qpid-proton-master/proton/c/api/search/all_2.js +++ b/content/releases/qpid-proton-master/proton/c/api/search/all_2.js @@ -3,5 +3,6 @@ var searchData= ['data',['Data',['../group__data.html',1,'']]], ['delivery',['Delivery',['../group__delivery.html',1,'']]], ['delivery_2eh',['delivery.h',['../delivery_8h.html',1,'']]], + ['deprecated_20list',['Deprecated List',['../deprecated.html',1,'']]], ['disposition_2eh',['disposition.h',['../disposition_8h.html',1,'']]] ]; --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
