| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Proton DotNet: Apache.Qpid.Proton.Client.SslOptions Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <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 DotNet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.1 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceApache.html">Apache</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid.html">Qpid</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton.html">Proton</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html">Client</a></li><li class="navelem"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html">SslOptions</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-attribs">Static Public Attributes</a> | |
| <a href="#properties">Properties</a> | |
| <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Client.SslOptions Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Options that control the SSL level transport configuration. |
| <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#details">More...</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a0cfb49d4ca45319fcfcee880d830b9f2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#a0cfb49d4ca45319fcfcee880d830b9f2">SslOptions</a> ()</td></tr> |
| <tr class="memdesc:a0cfb49d4ca45319fcfcee880d830b9f2"><td class="mdescLeft"> </td><td class="mdescRight">Creates a default SSL options instance. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#a0cfb49d4ca45319fcfcee880d830b9f2">More...</a><br /></td></tr> |
| <tr class="separator:a0cfb49d4ca45319fcfcee880d830b9f2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adbe6e1c4ebd491085c47bd03f08aac57"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#adbe6e1c4ebd491085c47bd03f08aac57">SslOptions</a> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html">SslOptions</a> other)</td></tr> |
| <tr class="memdesc:adbe6e1c4ebd491085c47bd03f08aac57"><td class="mdescLeft"> </td><td class="mdescRight">Create a target options instance that copies the configuration from the given instance. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#adbe6e1c4ebd491085c47bd03f08aac57">More...</a><br /></td></tr> |
| <tr class="separator:adbe6e1c4ebd491085c47bd03f08aac57"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a29735ae6c4af2697af5d5bfbb7ad070f"><td class="memItemLeft" align="right" valign="top">object </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#a29735ae6c4af2697af5d5bfbb7ad070f">Clone</a> ()</td></tr> |
| <tr class="memdesc:a29735ae6c4af2697af5d5bfbb7ad070f"><td class="mdescLeft"> </td><td class="mdescRight">Clone this options instance, changes to the cloned options are not reflected in this options instance. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#a29735ae6c4af2697af5d5bfbb7ad070f">More...</a><br /></td></tr> |
| <tr class="separator:a29735ae6c4af2697af5d5bfbb7ad070f"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a> |
| Static Public Attributes</h2></td></tr> |
| <tr class="memitem:ae406356c566ee634ae7e97f45781b506"><td class="memItemLeft" align="right" valign="top"><a id="ae406356c566ee634ae7e97f45781b506"></a> |
| static readonly bool </td><td class="memItemRight" valign="bottom"><b>DEFAULT_ENABLED_CERT_REVOCATION_CHECKS</b> = false</td></tr> |
| <tr class="separator:ae406356c566ee634ae7e97f45781b506"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a46c8e205d1cd6080bcda599373375e71"><td class="memItemLeft" align="right" valign="top"><a id="a46c8e205d1cd6080bcda599373375e71"></a> |
| static readonly bool </td><td class="memItemRight" valign="bottom"><b>DEFAULT_VERIFY_HOST</b> = true</td></tr> |
| <tr class="separator:a46c8e205d1cd6080bcda599373375e71"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2d73894de507ad992ce73f786c33c78f"><td class="memItemLeft" align="right" valign="top"><a id="a2d73894de507ad992ce73f786c33c78f"></a> |
| static readonly int </td><td class="memItemRight" valign="bottom"><b>DEFAULT_SSL_PORT</b> = 5671</td></tr> |
| <tr class="separator:a2d73894de507ad992ce73f786c33c78f"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:aad6cf14cb73e4b3d4170a9871b01821e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#aad6cf14cb73e4b3d4170a9871b01821e">SslEnabled</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:aad6cf14cb73e4b3d4170a9871b01821e"><td class="mdescLeft"> </td><td class="mdescRight">Controls if SSL is enabled for the connection these options are applied to. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#aad6cf14cb73e4b3d4170a9871b01821e">More...</a><br /></td></tr> |
| <tr class="separator:aad6cf14cb73e4b3d4170a9871b01821e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a82079b46ddc0ecd1f26ed0bf6afdb238"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#a82079b46ddc0ecd1f26ed0bf6afdb238">DefaultSslPort</a> = DEFAULT_SSL_PORT<code> [get, set]</code></td></tr> |
| <tr class="memdesc:a82079b46ddc0ecd1f26ed0bf6afdb238"><td class="mdescLeft"> </td><td class="mdescRight">Returns the configured default SSL port which if not set otherwise is 5671 <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#a82079b46ddc0ecd1f26ed0bf6afdb238">More...</a><br /></td></tr> |
| <tr class="separator:a82079b46ddc0ecd1f26ed0bf6afdb238"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3e8a10f30bb4ed42c03d9de20422daef"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#a3e8a10f30bb4ed42c03d9de20422daef">VerifyHost</a> = DEFAULT_VERIFY_HOST<code> [get, set]</code></td></tr> |
| <tr class="memdesc:a3e8a10f30bb4ed42c03d9de20422daef"><td class="mdescLeft"> </td><td class="mdescRight">Controls if the default verification mechanism will allow host name mismatch in the servers SN or Common Name field or if a mismatch fails the verification process. By default the client uses the host used in the connection address to validate the server name. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#a3e8a10f30bb4ed42c03d9de20422daef">More...</a><br /></td></tr> |
| <tr class="separator:a3e8a10f30bb4ed42c03d9de20422daef"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae0fe924ca0ae7ba6b566fabc0c223fe0"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#ae0fe924ca0ae7ba6b566fabc0c223fe0">ServerNameOverride</a> = null<code> [get, set]</code></td></tr> |
| <tr class="memdesc:ae0fe924ca0ae7ba6b566fabc0c223fe0"><td class="mdescLeft"> </td><td class="mdescRight">Configure the value used to validate the common name (server name) provided in the servers certificate instead of using the value provided in the connection address. This option is only used when the verify host option is enabled. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#ae0fe924ca0ae7ba6b566fabc0c223fe0">More...</a><br /></td></tr> |
| <tr class="separator:ae0fe924ca0ae7ba6b566fabc0c223fe0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5081c39596351f4bd96e33c3b008077d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#a5081c39596351f4bd96e33c3b008077d">EnableCertificateRevocationChecks</a> = DEFAULT_ENABLED_CERT_REVOCATION_CHECKS<code> [get, set]</code></td></tr> |
| <tr class="memdesc:a5081c39596351f4bd96e33c3b008077d"><td class="mdescLeft"> </td><td class="mdescRight">Controls if the client will enable the system's certificate revocation checking feature (default is disabled). <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#a5081c39596351f4bd96e33c3b008077d">More...</a><br /></td></tr> |
| <tr class="separator:a5081c39596351f4bd96e33c3b008077d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5bf3e131c57f61329518606af7aee9ce"><td class="memItemLeft" align="right" valign="top">SslProtocols </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#a5bf3e131c57f61329518606af7aee9ce">TlsVersionOverride</a> = SslProtocols.None<code> [get, set]</code></td></tr> |
| <tr class="memdesc:a5bf3e131c57f61329518606af7aee9ce"><td class="mdescLeft"> </td><td class="mdescRight">Allows the user to override the TLS version that the client will request from the O/S when performing the TLS handshake. By default the client will let the system choose the best TLS version, however the user may wish to enforce a specific value. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#a5bf3e131c57f61329518606af7aee9ce">More...</a><br /></td></tr> |
| <tr class="separator:a5bf3e131c57f61329518606af7aee9ce"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a86aad3669790b37a49d2a7d36712a063"><td class="memItemLeft" align="right" valign="top">SslPolicyErrors </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#a86aad3669790b37a49d2a7d36712a063">AllowedSslPolicyErrorsOverride</a> = SslPolicyErrors.None<code> [get, set]</code></td></tr> |
| <tr class="memdesc:a86aad3669790b37a49d2a7d36712a063"><td class="mdescLeft"> </td><td class="mdescRight">Provides a means of overriding the default allowable SSL policy errors when validating the server certificate during the TLS handshake. By default no errors are allowed and any that do occur will fail the TLS handshake. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#a86aad3669790b37a49d2a7d36712a063">More...</a><br /></td></tr> |
| <tr class="separator:a86aad3669790b37a49d2a7d36712a063"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a54bbba497f9216aa06f7ded22e1b6db2"><td class="memItemLeft" align="right" valign="top">RemoteCertificateValidationCallback </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#a54bbba497f9216aa06f7ded22e1b6db2">RemoteValidationCallbackOverride</a> = null<code> [get, set]</code></td></tr> |
| <tr class="memdesc:a54bbba497f9216aa06f7ded22e1b6db2"><td class="mdescLeft"> </td><td class="mdescRight">Allows the user to provide an optional remote certificate validation callback which can be used by advanced users who want to customize the validation step of the TLS handshake process instead of relying on the built in mechanism. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#a54bbba497f9216aa06f7ded22e1b6db2">More...</a><br /></td></tr> |
| <tr class="separator:a54bbba497f9216aa06f7ded22e1b6db2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa0eb51ad29514f1365de695f166f0a14"><td class="memItemLeft" align="right" valign="top">LocalCertificateSelectionCallback </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#aa0eb51ad29514f1365de695f166f0a14">LocalCertificateSelectionOverride</a> = null<code> [get, set]</code></td></tr> |
| <tr class="memdesc:aa0eb51ad29514f1365de695f166f0a14"><td class="mdescLeft"> </td><td class="mdescRight">Allows the user to provide an optional local certificate selection callback which can be used by advanced users who want to customize the selection step when choosing the client certificate to provide to the remote during the TLS handshake. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#aa0eb51ad29514f1365de695f166f0a14">More...</a><br /></td></tr> |
| <tr class="separator:aa0eb51ad29514f1365de695f166f0a14"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1399fbc3800487c4bdb9727725641506"><td class="memItemLeft" align="right" valign="top">X509CertificateCollection </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#a1399fbc3800487c4bdb9727725641506">ClientCertificateCollection</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a1399fbc3800487c4bdb9727725641506"><td class="mdescLeft"> </td><td class="mdescRight">Provides a collection of client certificates which will be used when the TLS handshake is performed wherein a single certificate will be selected. This collection takes precedence over any set certificate path however if no collection is provided a call to get this collection will attempt to load a certificate from the configure certificate path if set and return a collection containing the loaded value. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#a1399fbc3800487c4bdb9727725641506">More...</a><br /></td></tr> |
| <tr class="separator:a1399fbc3800487c4bdb9727725641506"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a532270833419152cf86ea9fa65c65478"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#a532270833419152cf86ea9fa65c65478">ClientCertificatePath</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a532270833419152cf86ea9fa65c65478"><td class="mdescLeft"> </td><td class="mdescRight">Provides a system path where a client certificate can be read and supplied for use when performing the TLS handshake. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#a532270833419152cf86ea9fa65c65478">More...</a><br /></td></tr> |
| <tr class="separator:a532270833419152cf86ea9fa65c65478"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4ba8aafaa29afacd73dddc9bd7675771"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#a4ba8aafaa29afacd73dddc9bd7675771">ClientCertificatePassword</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a4ba8aafaa29afacd73dddc9bd7675771"><td class="mdescLeft"> </td><td class="mdescRight">Configures the password used when attempting to load the certificate file specified. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#a4ba8aafaa29afacd73dddc9bd7675771">More...</a><br /></td></tr> |
| <tr class="separator:a4ba8aafaa29afacd73dddc9bd7675771"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Options that control the SSL level transport configuration. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a0cfb49d4ca45319fcfcee880d830b9f2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0cfb49d4ca45319fcfcee880d830b9f2">◆ </a></span>SslOptions() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Apache.Qpid.Proton.Client.SslOptions.SslOptions </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates a default SSL options instance. </p> |
| |
| </div> |
| </div> |
| <a id="adbe6e1c4ebd491085c47bd03f08aac57"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adbe6e1c4ebd491085c47bd03f08aac57">◆ </a></span>SslOptions() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Apache.Qpid.Proton.Client.SslOptions.SslOptions </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html">SslOptions</a> </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a target options instance that copies the configuration from the given instance. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">other</td><td>The target options instance to copy</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a29735ae6c4af2697af5d5bfbb7ad070f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a29735ae6c4af2697af5d5bfbb7ad070f">◆ </a></span>Clone()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">object Apache.Qpid.Proton.Client.SslOptions.Clone </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Clone this options instance, changes to the cloned options are not reflected in this options instance. </p> |
| <dl class="section return"><dt>Returns</dt><dd>A deep copy of this options instance.</dd></dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="a86aad3669790b37a49d2a7d36712a063"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a86aad3669790b37a49d2a7d36712a063">◆ </a></span>AllowedSslPolicyErrorsOverride</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">SslPolicyErrors Apache.Qpid.Proton.Client.SslOptions.AllowedSslPolicyErrorsOverride = SslPolicyErrors.None</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Provides a means of overriding the default allowable SSL policy errors when validating the server certificate during the TLS handshake. By default no errors are allowed and any that do occur will fail the TLS handshake. </p> |
| |
| </div> |
| </div> |
| <a id="a1399fbc3800487c4bdb9727725641506"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1399fbc3800487c4bdb9727725641506">◆ </a></span>ClientCertificateCollection</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">X509CertificateCollection Apache.Qpid.Proton.Client.SslOptions.ClientCertificateCollection</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Provides a collection of client certificates which will be used when the TLS handshake is performed wherein a single certificate will be selected. This collection takes precedence over any set certificate path however if no collection is provided a call to get this collection will attempt to load a certificate from the configure certificate path if set and return a collection containing the loaded value. </p> |
| |
| </div> |
| </div> |
| <a id="a4ba8aafaa29afacd73dddc9bd7675771"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4ba8aafaa29afacd73dddc9bd7675771">◆ </a></span>ClientCertificatePassword</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string Apache.Qpid.Proton.Client.SslOptions.ClientCertificatePassword</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Configures the password used when attempting to load the certificate file specified. </p> |
| |
| </div> |
| </div> |
| <a id="a532270833419152cf86ea9fa65c65478"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a532270833419152cf86ea9fa65c65478">◆ </a></span>ClientCertificatePath</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string Apache.Qpid.Proton.Client.SslOptions.ClientCertificatePath</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Provides a system path where a client certificate can be read and supplied for use when performing the TLS handshake. </p> |
| |
| </div> |
| </div> |
| <a id="a82079b46ddc0ecd1f26ed0bf6afdb238"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a82079b46ddc0ecd1f26ed0bf6afdb238">◆ </a></span>DefaultSslPort</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Apache.Qpid.Proton.Client.SslOptions.DefaultSslPort = DEFAULT_SSL_PORT</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the configured default SSL port which if not set otherwise is 5671 </p> |
| |
| </div> |
| </div> |
| <a id="a5081c39596351f4bd96e33c3b008077d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5081c39596351f4bd96e33c3b008077d">◆ </a></span>EnableCertificateRevocationChecks</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Apache.Qpid.Proton.Client.SslOptions.EnableCertificateRevocationChecks = DEFAULT_ENABLED_CERT_REVOCATION_CHECKS</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Controls if the client will enable the system's certificate revocation checking feature (default is disabled). </p> |
| |
| </div> |
| </div> |
| <a id="aa0eb51ad29514f1365de695f166f0a14"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa0eb51ad29514f1365de695f166f0a14">◆ </a></span>LocalCertificateSelectionOverride</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">LocalCertificateSelectionCallback Apache.Qpid.Proton.Client.SslOptions.LocalCertificateSelectionOverride = null</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Allows the user to provide an optional local certificate selection callback which can be used by advanced users who want to customize the selection step when choosing the client certificate to provide to the remote during the TLS handshake. </p> |
| |
| </div> |
| </div> |
| <a id="a54bbba497f9216aa06f7ded22e1b6db2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a54bbba497f9216aa06f7ded22e1b6db2">◆ </a></span>RemoteValidationCallbackOverride</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">RemoteCertificateValidationCallback Apache.Qpid.Proton.Client.SslOptions.RemoteValidationCallbackOverride = null</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Allows the user to provide an optional remote certificate validation callback which can be used by advanced users who want to customize the validation step of the TLS handshake process instead of relying on the built in mechanism. </p> |
| |
| </div> |
| </div> |
| <a id="ae0fe924ca0ae7ba6b566fabc0c223fe0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae0fe924ca0ae7ba6b566fabc0c223fe0">◆ </a></span>ServerNameOverride</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string Apache.Qpid.Proton.Client.SslOptions.ServerNameOverride = null</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Configure the value used to validate the common name (server name) provided in the servers certificate instead of using the value provided in the connection address. This option is only used when the verify host option is enabled. </p> |
| |
| </div> |
| </div> |
| <a id="aad6cf14cb73e4b3d4170a9871b01821e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aad6cf14cb73e4b3d4170a9871b01821e">◆ </a></span>SslEnabled</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Apache.Qpid.Proton.Client.SslOptions.SslEnabled</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Controls if SSL is enabled for the connection these options are applied to. </p> |
| |
| </div> |
| </div> |
| <a id="a5bf3e131c57f61329518606af7aee9ce"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5bf3e131c57f61329518606af7aee9ce">◆ </a></span>TlsVersionOverride</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">SslProtocols Apache.Qpid.Proton.Client.SslOptions.TlsVersionOverride = SslProtocols.None</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Allows the user to override the TLS version that the client will request from the O/S when performing the TLS handshake. By default the client will let the system choose the best TLS version, however the user may wish to enforce a specific value. </p> |
| |
| </div> |
| </div> |
| <a id="a3e8a10f30bb4ed42c03d9de20422daef"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3e8a10f30bb4ed42c03d9de20422daef">◆ </a></span>VerifyHost</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Apache.Qpid.Proton.Client.SslOptions.VerifyHost = DEFAULT_VERIFY_HOST</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Controls if the default verification mechanism will allow host name mismatch in the servers SN or Common Name field or if a mismatch fails the verification process. By default the client uses the host used in the connection address to validate the server name. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/Proton.Client/Client/SslOptions.cs</li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 |
| </small></address> |
| </body> |
| </html> |
