/usr/share/proton-0.10/docs/api-c/a00031.html is in libqpid-proton2-dev-doc 0.10-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.11"/>
<title>proton: /build/qpid-proton-9HU5Bc/qpid-proton-0.10/proton-c/include/proton/sasl.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="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">
$(document).ready(function() { init_search(); });
</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">proton
 <span id="projectnumber">0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
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.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_3d7fee5163f29235853f3037db69c226.html">proton-c</a></li><li class="navelem"><a class="el" href="dir_ca4610195e991eb8124aba7312da0967.html">include</a></li><li class="navelem"><a class="el" href="dir_819e9c3ec552076ba9984156db77a62b.html">proton</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">sasl.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>API for the SASL Secure Transport Layer.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <<a class="el" href="a00022_source.html">proton/import_export.h</a>></code><br />
<code>#include <<a class="el" href="a00039_source.html">proton/type_compat.h</a>></code><br />
<code>#include <<a class="el" href="a00040_source.html">proton/types.h</a>></code><br />
</div>
<p><a href="a00031_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga4d21fddba80d3f88d0529aafe12328b0"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a></td></tr>
<tr class="separator:ga4d21fddba80d3f88d0529aafe12328b0"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gad44e79f52e0669b1930689b56dfa9c3b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_outcome_t</a> { <br />
  <a class="el" href="a00057.html#ggad44e79f52e0669b1930689b56dfa9c3ba1c90ef54986e694f0d94036977681785">PN_SASL_NONE</a> =-1,
<a class="el" href="a00057.html#ggad44e79f52e0669b1930689b56dfa9c3ba0050b91650a3826a090e13f57b3b941e">PN_SASL_OK</a> =0,
<a class="el" href="a00057.html#ggad44e79f52e0669b1930689b56dfa9c3bac63734ecde7c8170554f6bf04f6ce64a">PN_SASL_AUTH</a> =1,
<a class="el" href="a00057.html#ggad44e79f52e0669b1930689b56dfa9c3bacd46a2fda23f674c23ed81e6076c1939">PN_SASL_SYS</a> =2,
<br />
  <a class="el" href="a00057.html#ggad44e79f52e0669b1930689b56dfa9c3ba03019f909ba1d98aae94437ca4bd0191">PN_SASL_PERM</a> =3,
<a class="el" href="a00057.html#ggad44e79f52e0669b1930689b56dfa9c3baee28d2c03fa80dccf771e37aae1bcdf3">PN_SASL_TEMP</a> =4
<br />
}<tr class="memdesc:gad44e79f52e0669b1930689b56dfa9c3b"><td class="mdescLeft"> </td><td class="mdescRight">The result of the SASL negotiation. <a href="a00057.html#gad44e79f52e0669b1930689b56dfa9c3b">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:gad44e79f52e0669b1930689b56dfa9c3b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga473c3092ebf00792106cdc741d0b14ac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#ga473c3092ebf00792106cdc741d0b14ac">pn_sasl</a> (<a class="el" href="a00062.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr>
<tr class="memdesc:ga473c3092ebf00792106cdc741d0b14ac"><td class="mdescLeft"> </td><td class="mdescRight">Construct an Authentication and Security Layer object. <a href="a00057.html#ga473c3092ebf00792106cdc741d0b14ac">More...</a><br /></td></tr>
<tr class="separator:ga473c3092ebf00792106cdc741d0b14ac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8ab2ab1ca7ed8a476fbf01e742425f3d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#ga8ab2ab1ca7ed8a476fbf01e742425f3d">pn_sasl_extended</a> (void)</td></tr>
<tr class="memdesc:ga8ab2ab1ca7ed8a476fbf01e742425f3d"><td class="mdescLeft"> </td><td class="mdescRight">Do we support extended SASL negotiation. <a href="a00057.html#ga8ab2ab1ca7ed8a476fbf01e742425f3d">More...</a><br /></td></tr>
<tr class="separator:ga8ab2ab1ca7ed8a476fbf01e742425f3d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaecd3b1f55fc81c6586bc435772f829d3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#gaecd3b1f55fc81c6586bc435772f829d3">pn_sasl_done</a> (<a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, <a class="el" href="a00057.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_outcome_t</a> outcome)</td></tr>
<tr class="memdesc:gaecd3b1f55fc81c6586bc435772f829d3"><td class="mdescLeft"> </td><td class="mdescRight">Set the outcome of SASL negotiation. <a href="a00057.html#gaecd3b1f55fc81c6586bc435772f829d3">More...</a><br /></td></tr>
<tr class="separator:gaecd3b1f55fc81c6586bc435772f829d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaec4ace7d77037c60f1df02f2bb0be0f8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00057.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_outcome_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#gaec4ace7d77037c60f1df02f2bb0be0f8">pn_sasl_outcome</a> (<a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl)</td></tr>
<tr class="memdesc:gaec4ace7d77037c60f1df02f2bb0be0f8"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the outcome of SASL negotiation. <a href="a00057.html#gaec4ace7d77037c60f1df02f2bb0be0f8">More...</a><br /></td></tr>
<tr class="separator:gaec4ace7d77037c60f1df02f2bb0be0f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafff63feb3a2eccd74f7b472ee235a886"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#gafff63feb3a2eccd74f7b472ee235a886">pn_sasl_get_user</a> (<a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl)</td></tr>
<tr class="memdesc:gafff63feb3a2eccd74f7b472ee235a886"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the authenticated user. <a href="a00057.html#gafff63feb3a2eccd74f7b472ee235a886">More...</a><br /></td></tr>
<tr class="separator:gafff63feb3a2eccd74f7b472ee235a886"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga77adf112018a4b457df4abbf5b31873b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#ga77adf112018a4b457df4abbf5b31873b">pn_sasl_get_mech</a> (<a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl)</td></tr>
<tr class="memdesc:ga77adf112018a4b457df4abbf5b31873b"><td class="mdescLeft"> </td><td class="mdescRight">Return the selected SASL mechanism. <a href="a00057.html#ga77adf112018a4b457df4abbf5b31873b">More...</a><br /></td></tr>
<tr class="separator:ga77adf112018a4b457df4abbf5b31873b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacdc9d99d6717e74fa5df4de1515644db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#gacdc9d99d6717e74fa5df4de1515644db">pn_sasl_allowed_mechs</a> (<a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, const char *mechs)</td></tr>
<tr class="memdesc:gacdc9d99d6717e74fa5df4de1515644db"><td class="mdescLeft"> </td><td class="mdescRight">SASL mechanisms that are to be considered for authentication. <a href="a00057.html#gacdc9d99d6717e74fa5df4de1515644db">More...</a><br /></td></tr>
<tr class="separator:gacdc9d99d6717e74fa5df4de1515644db"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga841eea7a3e34539aa6176ebc055cdc16"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#ga841eea7a3e34539aa6176ebc055cdc16">pn_sasl_set_allow_insecure_mechs</a> (<a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, bool insecure)</td></tr>
<tr class="memdesc:ga841eea7a3e34539aa6176ebc055cdc16"><td class="mdescLeft"> </td><td class="mdescRight">Boolean to allow use of clear text authentication mechanisms. <a href="a00057.html#ga841eea7a3e34539aa6176ebc055cdc16">More...</a><br /></td></tr>
<tr class="separator:ga841eea7a3e34539aa6176ebc055cdc16"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4f18db720611136dd7d6798b8bfbc94c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#ga4f18db720611136dd7d6798b8bfbc94c">pn_sasl_get_allow_insecure_mechs</a> (<a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl)</td></tr>
<tr class="memdesc:ga4f18db720611136dd7d6798b8bfbc94c"><td class="mdescLeft"> </td><td class="mdescRight">Return the current value for allow_insecure_mechs. <a href="a00057.html#ga4f18db720611136dd7d6798b8bfbc94c">More...</a><br /></td></tr>
<tr class="separator:ga4f18db720611136dd7d6798b8bfbc94c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae4ef8946525b044cc2d84ff801e1ae20"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#gae4ef8946525b044cc2d84ff801e1ae20">pn_sasl_config_name</a> (<a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, const char *name)</td></tr>
<tr class="memdesc:gae4ef8946525b044cc2d84ff801e1ae20"><td class="mdescLeft"> </td><td class="mdescRight">Set the sasl configuration name. <a href="a00057.html#gae4ef8946525b044cc2d84ff801e1ae20">More...</a><br /></td></tr>
<tr class="separator:gae4ef8946525b044cc2d84ff801e1ae20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8aa6f7e87a9eabf2d4ad8533fd7a4d3c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00057.html#ga8aa6f7e87a9eabf2d4ad8533fd7a4d3c">pn_sasl_config_path</a> (<a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, const char *path)</td></tr>
<tr class="memdesc:ga8aa6f7e87a9eabf2d4ad8533fd7a4d3c"><td class="mdescLeft"> </td><td class="mdescRight">Set the sasl configuration path. <a href="a00057.html#ga8aa6f7e87a9eabf2d4ad8533fd7a4d3c">More...</a><br /></td></tr>
<tr class="separator:ga8aa6f7e87a9eabf2d4ad8533fd7a4d3c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>API for the SASL Secure Transport Layer. </p>
<p>The SASL layer is responsible for establishing an authenticated and/or encrypted tunnel over which AMQP frames are passed between peers. The peer acting as the SASL Client must provide authentication credentials. The peer acting as the SASL Server must provide authentication against the received credentials. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Apr 4 2016 09:18:57 for proton by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
|