/usr/share/proton-0.10/docs/api-c/a00057.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 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 | <!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: SASL</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 class="current"><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><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><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">SASL<div class="ingroups"><a class="el" href="a00048.html">Engine</a> » <a class="el" href="a00062.html">Transport</a></div></div> </div>
</div><!--header-->
<div class="contents">
<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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga4d21fddba80d3f88d0529aafe12328b0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> <a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="gad44e79f52e0669b1930689b56dfa9c3b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="a00057.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_outcome_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The result of the SASL negotiation. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggad44e79f52e0669b1930689b56dfa9c3ba1c90ef54986e694f0d94036977681785"></a>PN_SASL_NONE </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggad44e79f52e0669b1930689b56dfa9c3ba0050b91650a3826a090e13f57b3b941e"></a>PN_SASL_OK </td><td class="fielddoc">
<p>negotiation not completed </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggad44e79f52e0669b1930689b56dfa9c3bac63734ecde7c8170554f6bf04f6ce64a"></a>PN_SASL_AUTH </td><td class="fielddoc">
<p>authentication succeeded </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggad44e79f52e0669b1930689b56dfa9c3bacd46a2fda23f674c23ed81e6076c1939"></a>PN_SASL_SYS </td><td class="fielddoc">
<p>failed due to bad credentials </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggad44e79f52e0669b1930689b56dfa9c3ba03019f909ba1d98aae94437ca4bd0191"></a>PN_SASL_PERM </td><td class="fielddoc">
<p>failed due to a system error </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggad44e79f52e0669b1930689b56dfa9c3baee28d2c03fa80dccf771e37aae1bcdf3"></a>PN_SASL_TEMP </td><td class="fielddoc">
<p>failed due to unrecoverable error </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga473c3092ebf00792106cdc741d0b14ac"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a>* pn_sasl </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00062.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td>
<td class="paramname"><em>transport</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct an Authentication and Security Layer object. </p>
<p>This will return the SASL layer object for the supplied transport object. If there is currently no SASL layer one will be created.</p>
<p>On the client side of an AMQP connection this will have the effect of ensuring that the AMQP SASL layer is used for that connection.</p>
<dl class="section return"><dt>Returns</dt><dd>an object representing the SASL layer. </dd></dl>
</div>
</div>
<a class="anchor" id="gacdc9d99d6717e74fa5df4de1515644db"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_sasl_allowed_mechs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> * </td>
<td class="paramname"><em>sasl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>mechs</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>SASL mechanisms that are to be considered for authentication. </p>
<p>This can be used on either the client or the server to restrict the SASL mechanisms that may be used to the mechanisms on the list.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">sasl</td><td>the SASL layer </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mechs</td><td>space separated list of mechanisms that are allowed for authentication </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gae4ef8946525b044cc2d84ff801e1ae20"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_sasl_config_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> * </td>
<td class="paramname"><em>sasl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the sasl configuration name. </p>
<p>This is used to construct the SASL configuration filename. In the current implementation it ".conf" is added to the name and the file is looked for in the configuration directory.</p>
<p>If not set it will default to "proton-server" for a sasl server and "proton-client" for a client.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">sasl</td><td>the SASL layer </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>the configuration name </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga8aa6f7e87a9eabf2d4ad8533fd7a4d3c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_sasl_config_path </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> * </td>
<td class="paramname"><em>sasl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>path</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the sasl configuration path. </p>
<p>This is used to tell SASL where to look for the configuration file. In the current implementation it can be a colon separated list of directories.</p>
<p>The environment variable PN_SASL_CONFIG_PATH can also be used to set this path, but if both methods are used then this <a class="el" href="a00057.html#ga8aa6f7e87a9eabf2d4ad8533fd7a4d3c" title="Set the sasl configuration path. ">pn_sasl_config_path()</a> will take precedence.</p>
<p>If not set the underlying implementation default will be used. for a client.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">sasl</td><td>the SASL layer </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>the configuration path </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaecd3b1f55fc81c6586bc435772f829d3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_sasl_done </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> * </td>
<td class="paramname"><em>sasl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00057.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_outcome_t</a> </td>
<td class="paramname"><em>outcome</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the outcome of SASL negotiation. </p>
<p>Used by the server to set the result of the negotiation process.</p>
<dl class="todo"><dt><b><a class="el" href="a00002.html#_todo000002">Todo:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="ga8ab2ab1ca7ed8a476fbf01e742425f3d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool pn_sasl_extended </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Do we support extended SASL negotiation. </p>
<p>Do we support extended SASL negotiation? All implementations of Proton support ANONYMOUS and EXTERNAL on both client and server sides and PLAIN on the client side.</p>
<p>Extended SASL implememtations use an external library (Cyrus SASL) to support other mechanisms beyond these basic ones.</p>
<dl class="section return"><dt>Returns</dt><dd>true if we support extended SASL negotiation, false if we only support basic negotiation. </dd></dl>
</div>
</div>
<a class="anchor" id="ga4f18db720611136dd7d6798b8bfbc94c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool pn_sasl_get_allow_insecure_mechs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> * </td>
<td class="paramname"><em>sasl</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the current value for allow_insecure_mechs. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">sasl</td><td>the SASL layer </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga77adf112018a4b457df4abbf5b31873b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> const char* pn_sasl_get_mech </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> * </td>
<td class="paramname"><em>sasl</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the selected SASL mechanism. </p>
<p>The returned value is only reliable after the PN_TRANSPORT_AUTHENTICATED event has been received.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">sasl</td><td>the SASL layer</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The authentication mechanism selected by the SASL layer </dd></dl>
</div>
</div>
<a class="anchor" id="gafff63feb3a2eccd74f7b472ee235a886"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> const char* pn_sasl_get_user </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> * </td>
<td class="paramname"><em>sasl</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the authenticated user. </p>
<p>This is usually used at the the server end to find the name of the authenticated user. On the client it will merely return whatever user was passed in to the pn_transport_set_user_password() API.</p>
<p>If <a class="el" href="a00057.html#gaec4ace7d77037c60f1df02f2bb0be0f8" title="Retrieve the outcome of SASL negotiation. ">pn_sasl_outcome()</a> returns a value other than PN_SASL_OK, then there will be no user to return. The returned value is only reliable after the PN_TRANSPORT_AUTHENTICATED event has been received.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">sasl</td><td>the sasl layer</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>If the SASL layer was not negotiated then 0 is returned If the ANONYMOUS mechanism is used then the user will be "anonymous" Otherwise a string containing the user is returned. </dd></dl>
</div>
</div>
<a class="anchor" id="gaec4ace7d77037c60f1df02f2bb0be0f8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00057.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_outcome_t</a> pn_sasl_outcome </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> * </td>
<td class="paramname"><em>sasl</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the outcome of SASL negotiation. </p>
<dl class="todo"><dt><b><a class="el" href="a00002.html#_todo000003">Todo:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="ga841eea7a3e34539aa6176ebc055cdc16"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_sasl_set_allow_insecure_mechs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00057.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> * </td>
<td class="paramname"><em>sasl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>insecure</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Boolean to allow use of clear text authentication mechanisms. </p>
<p>By default the SASL layer is configured not to allow mechanisms that disclose the clear text of the password over an unencrypted AMQP connection. This specifically will disallow the use of the PLAIN mechanism without using SSL encryption.</p>
<p>This default is to avoid disclosing password information accidentally over an insecure network.</p>
<p>If you actually wish to use a clear text password unencrypted then you can use this API to set allow_insecure_mechs to true.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">sasl</td><td>the SASL layer </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">insecure</td><td>set this to true to allow unencrypted PLAIN authentication. </td></tr>
</table>
</dd>
</dl>
</div>
</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>
|