/usr/share/proton-0.7/docs/api-c/a00053.html is in libqpid-proton2-dev-doc 0.7-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 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 | <!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.8"/>
<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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 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.8 -->
<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><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)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></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="a00046.html">Engine</a> » <a class="el" href="a00058.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="a00053.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.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="a00053.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_outcome_t</a> { <br />
  <a class="el" href="a00053.html#ggad44e79f52e0669b1930689b56dfa9c3ba1c90ef54986e694f0d94036977681785">PN_SASL_NONE</a> =-1,
<a class="el" href="a00053.html#ggad44e79f52e0669b1930689b56dfa9c3ba0050b91650a3826a090e13f57b3b941e">PN_SASL_OK</a> =0,
<a class="el" href="a00053.html#ggad44e79f52e0669b1930689b56dfa9c3bac63734ecde7c8170554f6bf04f6ce64a">PN_SASL_AUTH</a> =1,
<a class="el" href="a00053.html#ggad44e79f52e0669b1930689b56dfa9c3bacd46a2fda23f674c23ed81e6076c1939">PN_SASL_SYS</a> =2,
<br />
  <a class="el" href="a00053.html#ggad44e79f52e0669b1930689b56dfa9c3ba03019f909ba1d98aae94437ca4bd0191">PN_SASL_PERM</a> =3,
<a class="el" href="a00053.html#ggad44e79f52e0669b1930689b56dfa9c3baee28d2c03fa80dccf771e37aae1bcdf3">PN_SASL_TEMP</a> =4
<br />
}</td></tr>
<tr class="memdesc:gad44e79f52e0669b1930689b56dfa9c3b"><td class="mdescLeft"> </td><td class="mdescRight">The result of the SASL negotiation. <a href="a00053.html#gad44e79f52e0669b1930689b56dfa9c3b">More...</a><br /></td></tr>
<tr class="separator:gad44e79f52e0669b1930689b56dfa9c3b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5c80c44ea92bb4d028df81d6bed2d92f"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.html#ga5c80c44ea92bb4d028df81d6bed2d92f">pn_sasl_state_t</a> { <br />
  <a class="el" href="a00053.html#gga5c80c44ea92bb4d028df81d6bed2d92fa2f9a77cddbed7345e153266644e4283b">PN_SASL_CONF</a>,
<a class="el" href="a00053.html#gga5c80c44ea92bb4d028df81d6bed2d92fa5269985dcfd36a951e9d300d9f61e62a">PN_SASL_IDLE</a>,
<a class="el" href="a00053.html#gga5c80c44ea92bb4d028df81d6bed2d92fa2912da90da1d54e5c793afc19e9c8f76">PN_SASL_STEP</a>,
<a class="el" href="a00053.html#gga5c80c44ea92bb4d028df81d6bed2d92fafcd5cd18e5d196e2fc212b809283b52c">PN_SASL_PASS</a>,
<br />
  <a class="el" href="a00053.html#gga5c80c44ea92bb4d028df81d6bed2d92fa4a94b1b9b8a34ab3f6a8222dd7e5f5cf">PN_SASL_FAIL</a>
<br />
}</td></tr>
<tr class="memdesc:ga5c80c44ea92bb4d028df81d6bed2d92f"><td class="mdescLeft"> </td><td class="mdescRight">The state of the SASL negotiation process. <a href="a00053.html#ga5c80c44ea92bb4d028df81d6bed2d92f">More...</a><br /></td></tr>
<tr class="separator:ga5c80c44ea92bb4d028df81d6bed2d92f"><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="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00053.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.html#ga473c3092ebf00792106cdc741d0b14ac">pn_sasl</a> (<a class="el" href="a00058.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:gac61d26e02a7cb58b12073caaa3cce771"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00053.html#ga5c80c44ea92bb4d028df81d6bed2d92f">pn_sasl_state_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.html#gac61d26e02a7cb58b12073caaa3cce771">pn_sasl_state</a> (<a class="el" href="a00053.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl)</td></tr>
<tr class="memdesc:gac61d26e02a7cb58b12073caaa3cce771"><td class="mdescLeft"> </td><td class="mdescRight">Access the current state of the layer. <a href="#gac61d26e02a7cb58b12073caaa3cce771">More...</a><br /></td></tr>
<tr class="separator:gac61d26e02a7cb58b12073caaa3cce771"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac868787274f42c4c8dcd48a29d607b4c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.html#gac868787274f42c4c8dcd48a29d607b4c">pn_sasl_mechanisms</a> (<a class="el" href="a00053.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, const char *mechanisms)</td></tr>
<tr class="memdesc:gac868787274f42c4c8dcd48a29d607b4c"><td class="mdescLeft"> </td><td class="mdescRight">Set the acceptable SASL mechanisms for the layer. <a href="#gac868787274f42c4c8dcd48a29d607b4c">More...</a><br /></td></tr>
<tr class="separator:gac868787274f42c4c8dcd48a29d607b4c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf7b9cc1d6a9614d96e539ea6fa887c3f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.html#gaf7b9cc1d6a9614d96e539ea6fa887c3f">pn_sasl_remote_mechanisms</a> (<a class="el" href="a00053.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl)</td></tr>
<tr class="memdesc:gaf7b9cc1d6a9614d96e539ea6fa887c3f"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the list of SASL mechanisms provided by the remote. <a href="#gaf7b9cc1d6a9614d96e539ea6fa887c3f">More...</a><br /></td></tr>
<tr class="separator:gaf7b9cc1d6a9614d96e539ea6fa887c3f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4e6f4a68e3f57cd471172ebf5d1a94c6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.html#ga4e6f4a68e3f57cd471172ebf5d1a94c6">pn_sasl_client</a> (<a class="el" href="a00053.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl)</td></tr>
<tr class="memdesc:ga4e6f4a68e3f57cd471172ebf5d1a94c6"><td class="mdescLeft"> </td><td class="mdescRight">Configure the SASL layer to act as a SASL client. <a href="#ga4e6f4a68e3f57cd471172ebf5d1a94c6">More...</a><br /></td></tr>
<tr class="separator:ga4e6f4a68e3f57cd471172ebf5d1a94c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga79b89314182657fa1ef1d61d53b96ef0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.html#ga79b89314182657fa1ef1d61d53b96ef0">pn_sasl_server</a> (<a class="el" href="a00053.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl)</td></tr>
<tr class="memdesc:ga79b89314182657fa1ef1d61d53b96ef0"><td class="mdescLeft"> </td><td class="mdescRight">Configure the SASL layer to act as a server. <a href="#ga79b89314182657fa1ef1d61d53b96ef0">More...</a><br /></td></tr>
<tr class="separator:ga79b89314182657fa1ef1d61d53b96ef0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabffe993ccdc03b308b1fd87780ab0b21"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.html#gabffe993ccdc03b308b1fd87780ab0b21">pn_sasl_plain</a> (<a class="el" href="a00053.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, const char *username, const char *password)</td></tr>
<tr class="memdesc:gabffe993ccdc03b308b1fd87780ab0b21"><td class="mdescLeft"> </td><td class="mdescRight">Configure the SASL layer to use the "PLAIN" mechanism. <a href="#gabffe993ccdc03b308b1fd87780ab0b21">More...</a><br /></td></tr>
<tr class="separator:gabffe993ccdc03b308b1fd87780ab0b21"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacfc766232fc757fe958188e5381ec917"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.html#gacfc766232fc757fe958188e5381ec917">pn_sasl_pending</a> (<a class="el" href="a00053.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl)</td></tr>
<tr class="memdesc:gacfc766232fc757fe958188e5381ec917"><td class="mdescLeft"> </td><td class="mdescRight">Determine the size of the bytes available via <a class="el" href="a00053.html#ga88b10e72bd9b598e2cd3e65bf56d037c" title="Read challenge/response data sent from the peer. ">pn_sasl_recv()</a>. <a href="#gacfc766232fc757fe958188e5381ec917">More...</a><br /></td></tr>
<tr class="separator:gacfc766232fc757fe958188e5381ec917"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga88b10e72bd9b598e2cd3e65bf56d037c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.html#ga88b10e72bd9b598e2cd3e65bf56d037c">pn_sasl_recv</a> (<a class="el" href="a00053.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, char *bytes, size_t size)</td></tr>
<tr class="memdesc:ga88b10e72bd9b598e2cd3e65bf56d037c"><td class="mdescLeft"> </td><td class="mdescRight">Read challenge/response data sent from the peer. <a href="#ga88b10e72bd9b598e2cd3e65bf56d037c">More...</a><br /></td></tr>
<tr class="separator:ga88b10e72bd9b598e2cd3e65bf56d037c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2fd97ffa4b133e8b898d263e15a94519"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.html#ga2fd97ffa4b133e8b898d263e15a94519">pn_sasl_send</a> (<a class="el" href="a00053.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, const char *bytes, size_t size)</td></tr>
<tr class="memdesc:ga2fd97ffa4b133e8b898d263e15a94519"><td class="mdescLeft"> </td><td class="mdescRight">Send challenge or response data to the peer. <a href="#ga2fd97ffa4b133e8b898d263e15a94519">More...</a><br /></td></tr>
<tr class="separator:ga2fd97ffa4b133e8b898d263e15a94519"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaecd3b1f55fc81c6586bc435772f829d3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.html#gaecd3b1f55fc81c6586bc435772f829d3">pn_sasl_done</a> (<a class="el" href="a00053.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> *sasl, <a class="el" href="a00053.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="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00053.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_outcome_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.html#gaec4ace7d77037c60f1df02f2bb0be0f8">pn_sasl_outcome</a> (<a class="el" href="a00053.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>
</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="a00053.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a> <a class="el" href="a00053.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="a00053.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>
<a class="anchor" id="ga5c80c44ea92bb4d028df81d6bed2d92f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="a00053.html#ga5c80c44ea92bb4d028df81d6bed2d92f">pn_sasl_state_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The state of the SASL negotiation process. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga5c80c44ea92bb4d028df81d6bed2d92fa2f9a77cddbed7345e153266644e4283b"></a>PN_SASL_CONF </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga5c80c44ea92bb4d028df81d6bed2d92fa5269985dcfd36a951e9d300d9f61e62a"></a>PN_SASL_IDLE </td><td class="fielddoc">
<p>Pending configuration by application. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga5c80c44ea92bb4d028df81d6bed2d92fa2912da90da1d54e5c793afc19e9c8f76"></a>PN_SASL_STEP </td><td class="fielddoc">
<p>Pending SASL Init. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga5c80c44ea92bb4d028df81d6bed2d92fafcd5cd18e5d196e2fc212b809283b52c"></a>PN_SASL_PASS </td><td class="fielddoc">
<p>negotiation in progress </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga5c80c44ea92bb4d028df81d6bed2d92fa4a94b1b9b8a34ab3f6a8222dd7e5f5cf"></a>PN_SASL_FAIL </td><td class="fielddoc">
<p>negotiation completed successfully </p>
<p>negotiation failed </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="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00053.html#ga4d21fddba80d3f88d0529aafe12328b0">pn_sasl_t</a>* pn_sasl </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00058.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>
<dl class="section return"><dt>Returns</dt><dd>a new SASL object representing the layer. </dd></dl>
</div>
</div>
<a class="anchor" id="ga4e6f4a68e3f57cd471172ebf5d1a94c6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_sasl_client </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00053.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>Configure the SASL layer to act as a SASL client. </p>
<p>The role of client is similar to a TCP client - the peer requesting the connection.</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 to configure as a client </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="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_sasl_done </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00053.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="a00053.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="a00062.html#_todo000004">Todo:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="gac868787274f42c4c8dcd48a29d607b4c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_sasl_mechanisms </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00053.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>mechanisms</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the acceptable SASL mechanisms for the layer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">sasl</td><td>the layer to update </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mechanisms</td><td>a list of acceptable SASL mechanisms, separated by space </td></tr>
</table>
</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="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00053.html#gad44e79f52e0669b1930689b56dfa9c3b">pn_sasl_outcome_t</a> pn_sasl_outcome </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00053.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="a00062.html#_todo000005">Todo:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="gacfc766232fc757fe958188e5381ec917"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> size_t pn_sasl_pending </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00053.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>Determine the size of the bytes available via <a class="el" href="a00053.html#ga88b10e72bd9b598e2cd3e65bf56d037c" title="Read challenge/response data sent from the peer. ">pn_sasl_recv()</a>. </p>
<p>Returns the size in bytes available via <a class="el" href="a00053.html#ga88b10e72bd9b598e2cd3e65bf56d037c" title="Read challenge/response data sent from the peer. ">pn_sasl_recv()</a>.</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 number of bytes available, zero if no available data. </dd></dl>
</div>
</div>
<a class="anchor" id="gabffe993ccdc03b308b1fd87780ab0b21"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_sasl_plain </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00053.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>username</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>password</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Configure the SASL layer to use the "PLAIN" mechanism. </p>
<p>A utility function to configure a simple client SASL layer using PLAIN authentication.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">sasl</td><td>the layer to configure. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">username</td><td>credential for the PLAIN authentication mechanism </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">password</td><td>credential for the PLAIN authentication mechanism </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga88b10e72bd9b598e2cd3e65bf56d037c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> ssize_t pn_sasl_recv </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00053.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">char * </td>
<td class="paramname"><em>bytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read challenge/response data sent from the peer. </p>
<p>Use pn_sasl_pending to determine the size of the data.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">sasl</td><td>the layer to read from. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">bytes</td><td>written with up to size bytes of inbound data. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>maximum number of bytes that bytes can accept. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes written to bytes, or an error code if < 0. </dd></dl>
</div>
</div>
<a class="anchor" id="gaf7b9cc1d6a9614d96e539ea6fa887c3f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> const char* pn_sasl_remote_mechanisms </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00053.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 list of SASL mechanisms provided by the remote. </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>a string containing a list of the SASL mechanisms advertised by the remote (separated by spaces) </dd></dl>
</div>
</div>
<a class="anchor" id="ga2fd97ffa4b133e8b898d263e15a94519"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> ssize_t pn_sasl_send </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00053.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>bytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send challenge or response data to the peer. </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">bytes</td><td>The challenge/response data. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The number of data octets in bytes. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of octets read from bytes, or an error code if < 0 </dd></dl>
</div>
</div>
<a class="anchor" id="ga79b89314182657fa1ef1d61d53b96ef0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_sasl_server </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00053.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>Configure the SASL layer to act as a server. </p>
<p>The role of server is similar to a TCP server - the peer accepting the connection.</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 to configure as a server </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gac61d26e02a7cb58b12073caaa3cce771"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00053.html#ga5c80c44ea92bb4d028df81d6bed2d92f">pn_sasl_state_t</a> pn_sasl_state </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00053.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>Access the current state of the layer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">sasl</td><td>the layer to retrieve the state from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The state of the sasl layer. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Nov 17 2014 10:28:04 for proton by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
|