/usr/share/proton-0.10/docs/api-c/a00060.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 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 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 | <!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: SSL</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">SSL<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:gaba83c3a1779c8b35a479bf3a7bb5b175"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00060.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a></td></tr>
<tr class="separator:gaba83c3a1779c8b35a479bf3a7bb5b175"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga215da63662423b00d34605ba4f9761f5"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="a00060.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a></td></tr>
<tr class="separator:ga215da63662423b00d34605ba4f9761f5"><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:ga0f1d40875c45b14a31a77f27430bc225"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#ga0f1d40875c45b14a31a77f27430bc225">pn_ssl_mode_t</a> { <a class="el" href="a00060.html#gga0f1d40875c45b14a31a77f27430bc225a4e2fe24fcd2692e4c20c27668091a49c">PN_SSL_MODE_CLIENT</a> =1,
<a class="el" href="a00060.html#gga0f1d40875c45b14a31a77f27430bc225a0c4550c70a6bc74cb906a74c5f1e5078">PN_SSL_MODE_SERVER</a>
}<tr class="memdesc:ga0f1d40875c45b14a31a77f27430bc225"><td class="mdescLeft"> </td><td class="mdescRight">Determines the type of SSL endpoint. <a href="a00060.html#ga0f1d40875c45b14a31a77f27430bc225">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ga0f1d40875c45b14a31a77f27430bc225"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf175c116d52a91001f9a3559b580f56d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#gaf175c116d52a91001f9a3559b580f56d">pn_ssl_resume_status_t</a> { <a class="el" href="a00060.html#ggaf175c116d52a91001f9a3559b580f56dad1385651f6078177d6652c385453280d">PN_SSL_RESUME_UNKNOWN</a>,
<a class="el" href="a00060.html#ggaf175c116d52a91001f9a3559b580f56dac8a5515a69c89007f681b3c555328e8f">PN_SSL_RESUME_NEW</a>,
<a class="el" href="a00060.html#ggaf175c116d52a91001f9a3559b580f56dabb1b88b78dcb91ee80cd6f0eb5873d6d">PN_SSL_RESUME_REUSED</a>
}<tr class="memdesc:gaf175c116d52a91001f9a3559b580f56d"><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether an SSL session has been resumed. <a href="a00060.html#gaf175c116d52a91001f9a3559b580f56d">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:gaf175c116d52a91001f9a3559b580f56d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae5e33024ed6af3432d4c76d1484d7ecb"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#gae5e33024ed6af3432d4c76d1484d7ecb">pn_ssl_verify_mode_t</a> { <a class="el" href="a00060.html#ggae5e33024ed6af3432d4c76d1484d7ecbada1e3837cc900bd6419de72c25b253cc">PN_SSL_VERIFY_NULL</a> =0,
<a class="el" href="a00060.html#ggae5e33024ed6af3432d4c76d1484d7ecbad80276abde5d95760c63d0b9685d4d44">PN_SSL_VERIFY_PEER</a>,
<a class="el" href="a00060.html#ggae5e33024ed6af3432d4c76d1484d7ecbafa6dbe705dd0366ff4799616f788a9f5">PN_SSL_ANONYMOUS_PEER</a>,
<a class="el" href="a00060.html#ggae5e33024ed6af3432d4c76d1484d7ecbaac956f0febf05ab579de839700895e36">PN_SSL_VERIFY_PEER_NAME</a>
}<tr class="memdesc:gae5e33024ed6af3432d4c76d1484d7ecb"><td class="mdescLeft"> </td><td class="mdescRight">Determines the level of peer validation. <a href="a00060.html#gae5e33024ed6af3432d4c76d1484d7ecb">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:gae5e33024ed6af3432d4c76d1484d7ecb"><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:ga94467860b566683a4c646487dc537b34"><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="a00060.html#ga94467860b566683a4c646487dc537b34">pn_ssl_present</a> (void)</td></tr>
<tr class="memdesc:ga94467860b566683a4c646487dc537b34"><td class="mdescLeft"> </td><td class="mdescRight">Tests for SSL implementation present. <a href="#ga94467860b566683a4c646487dc537b34">More...</a><br /></td></tr>
<tr class="separator:ga94467860b566683a4c646487dc537b34"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabc9e5e64b23bf03316aa825ba036fb4f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00060.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#gabc9e5e64b23bf03316aa825ba036fb4f">pn_ssl_domain</a> (<a class="el" href="a00060.html#ga0f1d40875c45b14a31a77f27430bc225">pn_ssl_mode_t</a> mode)</td></tr>
<tr class="memdesc:gabc9e5e64b23bf03316aa825ba036fb4f"><td class="mdescLeft"> </td><td class="mdescRight">Create an SSL configuration domain. <a href="#gabc9e5e64b23bf03316aa825ba036fb4f">More...</a><br /></td></tr>
<tr class="separator:gabc9e5e64b23bf03316aa825ba036fb4f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2f0254dda9b35b5af99e744be243daaf"><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="a00060.html#ga2f0254dda9b35b5af99e744be243daaf">pn_ssl_domain_free</a> (<a class="el" href="a00060.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> *domain)</td></tr>
<tr class="memdesc:ga2f0254dda9b35b5af99e744be243daaf"><td class="mdescLeft"> </td><td class="mdescRight">Release an SSL configuration domain. <a href="#ga2f0254dda9b35b5af99e744be243daaf">More...</a><br /></td></tr>
<tr class="separator:ga2f0254dda9b35b5af99e744be243daaf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga13bc3cf2d0d2f3f612a513752e929251"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#ga13bc3cf2d0d2f3f612a513752e929251">pn_ssl_domain_set_credentials</a> (<a class="el" href="a00060.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> *domain, const char *credential_1, const char *credential_2, const char *password)</td></tr>
<tr class="memdesc:ga13bc3cf2d0d2f3f612a513752e929251"><td class="mdescLeft"> </td><td class="mdescRight">Set the certificate that identifies the local node to the remote. <a href="#ga13bc3cf2d0d2f3f612a513752e929251">More...</a><br /></td></tr>
<tr class="separator:ga13bc3cf2d0d2f3f612a513752e929251"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga20761fc3f72ab4d947a7c468a43758c9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#ga20761fc3f72ab4d947a7c468a43758c9">pn_ssl_domain_set_trusted_ca_db</a> (<a class="el" href="a00060.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> *domain, const char *certificate_db)</td></tr>
<tr class="memdesc:ga20761fc3f72ab4d947a7c468a43758c9"><td class="mdescLeft"> </td><td class="mdescRight">Configure the set of trusted CA certificates used by this domain to verify peers. <a href="#ga20761fc3f72ab4d947a7c468a43758c9">More...</a><br /></td></tr>
<tr class="separator:ga20761fc3f72ab4d947a7c468a43758c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacba0321d3d8cd67c601b604a5b42a190"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#gacba0321d3d8cd67c601b604a5b42a190">pn_ssl_domain_set_peer_authentication</a> (<a class="el" href="a00060.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> *domain, const <a class="el" href="a00060.html#gae5e33024ed6af3432d4c76d1484d7ecb">pn_ssl_verify_mode_t</a> mode, const char *trusted_CAs)</td></tr>
<tr class="memdesc:gacba0321d3d8cd67c601b604a5b42a190"><td class="mdescLeft"> </td><td class="mdescRight">Configure the level of verification used on the peer certificate. <a href="#gacba0321d3d8cd67c601b604a5b42a190">More...</a><br /></td></tr>
<tr class="separator:gacba0321d3d8cd67c601b604a5b42a190"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7bf33cfae6dcd6513da926eff993896d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#ga7bf33cfae6dcd6513da926eff993896d">pn_ssl_domain_allow_unsecured_client</a> (<a class="el" href="a00060.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> *domain)</td></tr>
<tr class="memdesc:ga7bf33cfae6dcd6513da926eff993896d"><td class="mdescLeft"> </td><td class="mdescRight">Permit a server to accept connection requests from non-SSL clients. <a href="#ga7bf33cfae6dcd6513da926eff993896d">More...</a><br /></td></tr>
<tr class="separator:ga7bf33cfae6dcd6513da926eff993896d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gace9c2c01043714e64fe97a390ffeac87"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00060.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#gace9c2c01043714e64fe97a390ffeac87">pn_ssl</a> (<a class="el" href="a00062.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr>
<tr class="memdesc:gace9c2c01043714e64fe97a390ffeac87"><td class="mdescLeft"> </td><td class="mdescRight">Create a new SSL session object associated with a transport. <a href="#gace9c2c01043714e64fe97a390ffeac87">More...</a><br /></td></tr>
<tr class="separator:gace9c2c01043714e64fe97a390ffeac87"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac5f8d77f86808ae8401691bcd17daa77"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#gac5f8d77f86808ae8401691bcd17daa77">pn_ssl_init</a> (<a class="el" href="a00060.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *ssl, <a class="el" href="a00060.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> *domain, const char *session_id)</td></tr>
<tr class="memdesc:gac5f8d77f86808ae8401691bcd17daa77"><td class="mdescLeft"> </td><td class="mdescRight">Initialize an SSL session. <a href="#gac5f8d77f86808ae8401691bcd17daa77">More...</a><br /></td></tr>
<tr class="separator:gac5f8d77f86808ae8401691bcd17daa77"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7ea4334e4925b50cb6c6daa4795cdfa0"><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="a00060.html#ga7ea4334e4925b50cb6c6daa4795cdfa0">pn_ssl_get_cipher_name</a> (<a class="el" href="a00060.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *ssl, char *buffer, size_t size)</td></tr>
<tr class="memdesc:ga7ea4334e4925b50cb6c6daa4795cdfa0"><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the Cipher that is currently in use. <a href="#ga7ea4334e4925b50cb6c6daa4795cdfa0">More...</a><br /></td></tr>
<tr class="separator:ga7ea4334e4925b50cb6c6daa4795cdfa0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4a1837eb135461f71da666f3438c7602"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#ga4a1837eb135461f71da666f3438c7602">pn_ssl_get_ssf</a> (<a class="el" href="a00060.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *ssl)</td></tr>
<tr class="memdesc:ga4a1837eb135461f71da666f3438c7602"><td class="mdescLeft"> </td><td class="mdescRight">Get the SSF (security strength factor) of the Cipher that is currently in use. <a href="#ga4a1837eb135461f71da666f3438c7602">More...</a><br /></td></tr>
<tr class="separator:ga4a1837eb135461f71da666f3438c7602"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1636bdfcc884dbae248f0316ae2a076f"><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="a00060.html#ga1636bdfcc884dbae248f0316ae2a076f">pn_ssl_get_protocol_name</a> (<a class="el" href="a00060.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *ssl, char *buffer, size_t size)</td></tr>
<tr class="memdesc:ga1636bdfcc884dbae248f0316ae2a076f"><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the SSL protocol that is currently in use. <a href="#ga1636bdfcc884dbae248f0316ae2a076f">More...</a><br /></td></tr>
<tr class="separator:ga1636bdfcc884dbae248f0316ae2a076f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga543c4d6b34f107f41a2812b15e370523"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="a00060.html#gaf175c116d52a91001f9a3559b580f56d">pn_ssl_resume_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#ga543c4d6b34f107f41a2812b15e370523">pn_ssl_resume_status</a> (<a class="el" href="a00060.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *ssl)</td></tr>
<tr class="memdesc:ga543c4d6b34f107f41a2812b15e370523"><td class="mdescLeft"> </td><td class="mdescRight">Check whether the state has been resumed. <a href="#ga543c4d6b34f107f41a2812b15e370523">More...</a><br /></td></tr>
<tr class="separator:ga543c4d6b34f107f41a2812b15e370523"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga733943a1e722653b5c1f36b7de670ee5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#ga733943a1e722653b5c1f36b7de670ee5">pn_ssl_set_peer_hostname</a> (<a class="el" href="a00060.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *ssl, const char *hostname)</td></tr>
<tr class="memdesc:ga733943a1e722653b5c1f36b7de670ee5"><td class="mdescLeft"> </td><td class="mdescRight">Set the expected identity of the remote peer. <a href="#ga733943a1e722653b5c1f36b7de670ee5">More...</a><br /></td></tr>
<tr class="separator:ga733943a1e722653b5c1f36b7de670ee5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabc678b1162484ec8eeddba8b594b1f74"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#gabc678b1162484ec8eeddba8b594b1f74">pn_ssl_get_peer_hostname</a> (<a class="el" href="a00060.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *ssl, char *hostname, size_t *bufsize)</td></tr>
<tr class="memdesc:gabc678b1162484ec8eeddba8b594b1f74"><td class="mdescLeft"> </td><td class="mdescRight">Access the configured peer identity. <a href="#gabc678b1162484ec8eeddba8b594b1f74">More...</a><br /></td></tr>
<tr class="separator:gabc678b1162484ec8eeddba8b594b1f74"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga41e9ea2af96fcbc34fda2e72cff40f2c"><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="a00060.html#ga41e9ea2af96fcbc34fda2e72cff40f2c">pn_ssl_get_remote_subject</a> (<a class="el" href="a00060.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> *ssl)</td></tr>
<tr class="memdesc:ga41e9ea2af96fcbc34fda2e72cff40f2c"><td class="mdescLeft"> </td><td class="mdescRight">Get the subject from the peers certificate. <a href="#ga41e9ea2af96fcbc34fda2e72cff40f2c">More...</a><br /></td></tr>
<tr class="separator:ga41e9ea2af96fcbc34fda2e72cff40f2c"><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="gaba83c3a1779c8b35a479bf3a7bb5b175"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="a00060.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> <a class="el" href="a00060.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga215da63662423b00d34605ba4f9761f5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="a00060.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> <a class="el" href="a00060.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga0f1d40875c45b14a31a77f27430bc225"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="a00060.html#ga0f1d40875c45b14a31a77f27430bc225">pn_ssl_mode_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines the type of SSL endpoint. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga0f1d40875c45b14a31a77f27430bc225a4e2fe24fcd2692e4c20c27668091a49c"></a>PN_SSL_MODE_CLIENT </td><td class="fielddoc">
<p>Local connection endpoint is an SSL client. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga0f1d40875c45b14a31a77f27430bc225a0c4550c70a6bc74cb906a74c5f1e5078"></a>PN_SSL_MODE_SERVER </td><td class="fielddoc">
<p>Local connection endpoint is an SSL server. </p>
</td></tr>
</table>
</div>
</div>
<a class="anchor" id="gaf175c116d52a91001f9a3559b580f56d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="a00060.html#gaf175c116d52a91001f9a3559b580f56d">pn_ssl_resume_status_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates whether an SSL session has been resumed. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggaf175c116d52a91001f9a3559b580f56dad1385651f6078177d6652c385453280d"></a>PN_SSL_RESUME_UNKNOWN </td><td class="fielddoc">
<p>Session resume state unknown/not supported. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggaf175c116d52a91001f9a3559b580f56dac8a5515a69c89007f681b3c555328e8f"></a>PN_SSL_RESUME_NEW </td><td class="fielddoc">
<p>Session renegotiated - not resumed. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggaf175c116d52a91001f9a3559b580f56dabb1b88b78dcb91ee80cd6f0eb5873d6d"></a>PN_SSL_RESUME_REUSED </td><td class="fielddoc">
<p>Session resumed from previous session. </p>
</td></tr>
</table>
</div>
</div>
<a class="anchor" id="gae5e33024ed6af3432d4c76d1484d7ecb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="a00060.html#gae5e33024ed6af3432d4c76d1484d7ecb">pn_ssl_verify_mode_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines the level of peer validation. </p>
<p>ANONYMOUS_PEER does not require a valid certificate, and permits use of ciphers that do not provide authentication.</p>
<p>VERIFY_PEER will only connect to those peers that provide a valid identifying certificate signed by a trusted CA and are using an authenticated cipher.</p>
<p>VERIFY_PEER_NAME is like VERIFY_PEER, but also requires the peer's identity as contained in the certificate to be valid (see <a class="el" href="a00060.html#ga733943a1e722653b5c1f36b7de670ee5" title="Set the expected identity of the remote peer. ">pn_ssl_set_peer_hostname</a>).</p>
<p>ANONYMOUS_PEER is configured by default. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggae5e33024ed6af3432d4c76d1484d7ecbada1e3837cc900bd6419de72c25b253cc"></a>PN_SSL_VERIFY_NULL </td><td class="fielddoc">
<p>internal use only </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggae5e33024ed6af3432d4c76d1484d7ecbad80276abde5d95760c63d0b9685d4d44"></a>PN_SSL_VERIFY_PEER </td><td class="fielddoc">
<p>require peer to provide a valid identifying certificate </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggae5e33024ed6af3432d4c76d1484d7ecbafa6dbe705dd0366ff4799616f788a9f5"></a>PN_SSL_ANONYMOUS_PEER </td><td class="fielddoc">
<p>do not require a certificate nor cipher authorization </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggae5e33024ed6af3432d4c76d1484d7ecbaac956f0febf05ab579de839700895e36"></a>PN_SSL_VERIFY_PEER_NAME </td><td class="fielddoc">
<p>require valid certificate and matching name </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gace9c2c01043714e64fe97a390ffeac87"></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="a00060.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a>* pn_ssl </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>Create a new SSL session object associated with a transport. </p>
<p>A transport must have an SSL object in order to "speak" SSL over its connection. This method allocates an SSL object associates it with the transport.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>the transport that will own the new SSL session. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the SSL object configured for this transport. Returns NULL if no SSL session is associated with the transport. </dd></dl>
</div>
</div>
<a class="anchor" id="gabc9e5e64b23bf03316aa825ba036fb4f"></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="a00060.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a>* pn_ssl_domain </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00060.html#ga0f1d40875c45b14a31a77f27430bc225">pn_ssl_mode_t</a> </td>
<td class="paramname"><em>mode</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an SSL configuration domain. </p>
<p>This method allocates an SSL domain object. This object is used to hold the SSL configuration for one or more SSL sessions. The SSL session object (pn_ssl_t) is allocated from this object.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>the role, client or server, assumed by all SSL sessions created with this domain. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the SSL domain, if SSL support is present. </dd></dl>
</div>
</div>
<a class="anchor" id="ga7bf33cfae6dcd6513da926eff993896d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int pn_ssl_domain_allow_unsecured_client </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00060.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> * </td>
<td class="paramname"><em>domain</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Permit a server to accept connection requests from non-SSL clients. </p>
<p>This configures the server to "sniff" the incoming client data stream, and dynamically determine whether SSL/TLS is being used. This option is disabled by default: only clients using SSL/TLS are accepted.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">domain</td><td>the domain (server) that will accept the client connections. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success </dd></dl>
</div>
</div>
<a class="anchor" id="ga2f0254dda9b35b5af99e744be243daaf"></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_ssl_domain_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00060.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> * </td>
<td class="paramname"><em>domain</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Release an SSL configuration domain. </p>
<p>This method frees an SSL domain object allocated by <a class="el" href="a00060.html#gabc9e5e64b23bf03316aa825ba036fb4f" title="Create an SSL configuration domain. ">pn_ssl_domain</a>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">domain</td><td>the domain to destroy. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga13bc3cf2d0d2f3f612a513752e929251"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int pn_ssl_domain_set_credentials </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00060.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> * </td>
<td class="paramname"><em>domain</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>credential_1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>credential_2</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>Set the certificate that identifies the local node to the remote. </p>
<p>This certificate establishes the identity for the local node for all SSL sessions created from this domain. It will be sent to the remote if the remote needs to verify the identity of this node. This may be used for both SSL servers and SSL clients (if client authentication is required by the server).</p>
<dl class="section note"><dt>Note</dt><dd>This setting effects only those pn_ssl_t objects created after this call returns. pn_ssl_t objects created before invoking this method will use the domain's previous setting.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">domain</td><td>the ssl domain that will use this certificate. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">credential_1</td><td>specifier for the file/database containing the identifying certificate. For Openssl users, this is a PEM file. For Windows SChannel users, this is the PKCS#12 file or system store. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">credential_2</td><td>an optional key to access the identifying certificate. For Openssl users, this is an optional PEM file containing the private key used to sign the certificate. For Windows SChannel users, this is the friendly name of the self-identifying certificate if there are multiple certificates in the store. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">password</td><td>the password used to sign the key, else NULL if key is not protected. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success </dd></dl>
</div>
</div>
<a class="anchor" id="gacba0321d3d8cd67c601b604a5b42a190"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int pn_ssl_domain_set_peer_authentication </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00060.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> * </td>
<td class="paramname"><em>domain</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00060.html#gae5e33024ed6af3432d4c76d1484d7ecb">pn_ssl_verify_mode_t</a> </td>
<td class="paramname"><em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>trusted_CAs</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Configure the level of verification used on the peer certificate. </p>
<p>This method controls how the peer's certificate is validated, if at all. By default, neither servers nor clients attempt to verify their peers (PN_SSL_ANONYMOUS_PEER). Once certificates and trusted CAs are configured, peer verification can be enabled.</p>
<dl class="section note"><dt>Note</dt><dd>In order to verify a peer, a trusted CA must be configured. See <a class="el" href="a00060.html#ga20761fc3f72ab4d947a7c468a43758c9" title="Configure the set of trusted CA certificates used by this domain to verify peers. ...">pn_ssl_domain_set_trusted_ca_db()</a>.</dd>
<dd>
Servers must provide their own certificate when verifying a peer. See <a class="el" href="a00060.html#ga13bc3cf2d0d2f3f612a513752e929251" title="Set the certificate that identifies the local node to the remote. ">pn_ssl_domain_set_credentials()</a>.</dd>
<dd>
This setting effects only those pn_ssl_t objects created after this call returns. pn_ssl_t objects created before invoking this method will use the domain's previous setting.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">domain</td><td>the ssl domain to configure. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>the level of validation to apply to the peer </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">trusted_CAs</td><td>path to a database of trusted CAs that the server will advertise to the peer client if the server has been configured to verify its peer. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success </dd></dl>
</div>
</div>
<a class="anchor" id="ga20761fc3f72ab4d947a7c468a43758c9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int pn_ssl_domain_set_trusted_ca_db </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00060.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> * </td>
<td class="paramname"><em>domain</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>certificate_db</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Configure the set of trusted CA certificates used by this domain to verify peers. </p>
<p>If the local SSL client/server needs to verify the identity of the remote, it must validate the signature of the remote's certificate. This function sets the database of trusted CAs that will be used to verify the signature of the remote's certificate.</p>
<dl class="section note"><dt>Note</dt><dd>This setting effects only those pn_ssl_t objects created after this call returns. pn_ssl_t objects created before invoking this method will use the domain's previous setting.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">domain</td><td>the ssl domain that will use the database. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">certificate_db</td><td>database of trusted CAs, used to authenticate the peer. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success </dd></dl>
</div>
</div>
<a class="anchor" id="ga7ea4334e4925b50cb6c6daa4795cdfa0"></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_ssl_get_cipher_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00060.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> * </td>
<td class="paramname"><em>ssl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>buffer</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>Get the name of the Cipher that is currently in use. </p>
<p>Gets a text description of the cipher that is currently active, or returns FALSE if SSL is not active (no cipher). Note that the cipher in use may change over time due to renegotiation or other changes to the SSL state.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ssl</td><td>the ssl client/server to query. </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">buffer</td><td>buffer of size bytes to hold cipher name </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>maximum number of bytes in buffer. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if cipher name written to buffer, False if no cipher in use. </dd></dl>
</div>
</div>
<a class="anchor" id="gabc678b1162484ec8eeddba8b594b1f74"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int pn_ssl_get_peer_hostname </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00060.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> * </td>
<td class="paramname"><em>ssl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>hostname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t * </td>
<td class="paramname"><em>bufsize</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Access the configured peer identity. </p>
<p>Return the expected identity of the remote peer, as set by <a class="el" href="a00060.html#ga733943a1e722653b5c1f36b7de670ee5" title="Set the expected identity of the remote peer. ">pn_ssl_set_peer_hostname</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ssl</td><td>the ssl session. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">hostname</td><td>buffer to hold the null-terminated name string. If null, no string is written. </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">bufsize</td><td>on input set to the number of octets in hostname. On output, set to the number of octets needed to hold the value of hostname plus a null byte. Zero if no hostname set. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success. </dd></dl>
</div>
</div>
<a class="anchor" id="ga1636bdfcc884dbae248f0316ae2a076f"></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_ssl_get_protocol_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00060.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> * </td>
<td class="paramname"><em>ssl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>buffer</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>Get the name of the SSL protocol that is currently in use. </p>
<p>Gets a text description of the SSL protocol that is currently active, or returns FALSE if SSL is not active. Note that the protocol may change over time due to renegotiation.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ssl</td><td>the ssl client/server to query. </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">buffer</td><td>buffer of size bytes to hold the version identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>maximum number of bytes in buffer. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the version information was written to buffer, False if SSL connection not ready. </dd></dl>
</div>
</div>
<a class="anchor" id="ga41e9ea2af96fcbc34fda2e72cff40f2c"></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_ssl_get_remote_subject </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00060.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> * </td>
<td class="paramname"><em>ssl</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the subject from the peers certificate. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ssl</td><td>the ssl client/server to query. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A null terminated string representing the full subject, which is valid until the ssl object is destroyed. </dd></dl>
</div>
</div>
<a class="anchor" id="ga4a1837eb135461f71da666f3438c7602"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int pn_ssl_get_ssf </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00060.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> * </td>
<td class="paramname"><em>ssl</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the SSF (security strength factor) of the Cipher that is currently in use. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ssl</td><td>the ssl client/server to query. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the ssf, note that 0 means no security. </dd></dl>
</div>
</div>
<a class="anchor" id="gac5f8d77f86808ae8401691bcd17daa77"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int pn_ssl_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00060.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> * </td>
<td class="paramname"><em>ssl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00060.html#gaba83c3a1779c8b35a479bf3a7bb5b175">pn_ssl_domain_t</a> * </td>
<td class="paramname"><em>domain</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>session_id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize an SSL session. </p>
<p>This method configures an SSL object using the configuration provided by the given domain.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ssl</td><td>the ssl session to configured. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">domain</td><td>the ssl domain used to configure the SSL session. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">session_id</td><td>if supplied, attempt to resume a previous SSL session that used the same session_id. If no previous SSL session is available, a new session will be created using the session_id and stored for future session restore (see ::<a class="el" href="a00060.html#ga543c4d6b34f107f41a2812b15e370523" title="Check whether the state has been resumed. ">pn_ssl_resume_status</a>). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, else an error code. </dd></dl>
</div>
</div>
<a class="anchor" id="ga94467860b566683a4c646487dc537b34"></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_ssl_present </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tests for SSL implementation present. </p>
<dl class="section return"><dt>Returns</dt><dd>true if we support SSL, false if not </dd></dl>
</div>
</div>
<a class="anchor" id="ga543c4d6b34f107f41a2812b15e370523"></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="a00060.html#gaf175c116d52a91001f9a3559b580f56d">pn_ssl_resume_status_t</a> pn_ssl_resume_status </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00060.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> * </td>
<td class="paramname"><em>ssl</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether the state has been resumed. </p>
<p>Used for client session resume. When called on an active session, indicates whether the state has been resumed from a previous session.</p>
<dl class="section note"><dt>Note</dt><dd>This is a best-effort service - there is no guarantee that the remote server will accept the resumed parameters. The remote server may choose to ignore these parameters, and request a re-negotiation instead.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ssl</td><td>the ssl session to check </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status code indicating whether or not the session has been resumed. </dd></dl>
</div>
</div>
<a class="anchor" id="ga733943a1e722653b5c1f36b7de670ee5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int pn_ssl_set_peer_hostname </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00060.html#ga215da63662423b00d34605ba4f9761f5">pn_ssl_t</a> * </td>
<td class="paramname"><em>ssl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>hostname</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the expected identity of the remote peer. </p>
<p>By default, SSL will use the hostname associated with the connection that the transport is bound to (see <a class="el" href="a00044.html#ga204a7c356658d414f5d08da4f25f5d9e" title="Set the value of the AMQP Hostname used by a connection object. ">pn_connection_set_hostname</a>). This method allows the caller to override that default.</p>
<p>The hostname is used for two purposes: 1) when set on an SSL client, it is sent to the server during the handshake (if Server Name Indication is supported), and 2) it is used to check against the identifying name provided in the peer's certificate. If the supplied name does not exactly match a SubjectAltName (type DNS name), or the CommonName entry in the peer's certificate, the peer is considered unauthenticated (potential imposter), and the SSL connection is aborted.</p>
<dl class="section note"><dt>Note</dt><dd>Verification of the hostname is only done if PN_SSL_VERIFY_PEER_NAME is enabled. See <a class="el" href="a00060.html#gacba0321d3d8cd67c601b604a5b42a190" title="Configure the level of verification used on the peer certificate. ">pn_ssl_domain_set_peer_authentication</a>.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ssl</td><td>the ssl session. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">hostname</td><td>the expected identity of the remote. Must conform to the syntax as given in RFC1034, Section 3.5. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success. </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>
|