github-actions[bot]
265 lines
104 KiB
HTML
265 lines
104 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `SslContextBuilder` struct in crate `openssl`."><meta name="keywords" content="rust, rustlang, rust-lang, SslContextBuilder"><title>openssl::ssl::SslContextBuilder - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../openssl/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Struct SslContextBuilder</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.add_client_ca">add_client_ca</a><a href="#method.add_custom_ext">add_custom_ext</a><a href="#method.add_extra_chain_cert">add_extra_chain_cert</a><a href="#method.as_ptr">as_ptr</a><a href="#method.build">build</a><a href="#method.cert_store">cert_store</a><a href="#method.cert_store_mut">cert_store_mut</a><a href="#method.check_private_key">check_private_key</a><a href="#method.clear_options">clear_options</a><a href="#method.from_ptr">from_ptr</a><a href="#method.max_proto_version">max_proto_version</a><a href="#method.min_proto_version">min_proto_version</a><a href="#method.new">new</a><a href="#method.options">options</a><a href="#method.set_alpn_protos">set_alpn_protos</a><a href="#method.set_alpn_select_callback">set_alpn_select_callback</a><a href="#method.set_ca_file">set_ca_file</a><a href="#method.set_cert_store">set_cert_store</a><a href="#method.set_certificate">set_certificate</a><a href="#method.set_certificate_chain_file">set_certificate_chain_file</a><a href="#method.set_certificate_file">set_certificate_file</a><a href="#method.set_cipher_list">set_cipher_list</a><a href="#method.set_ciphersuites">set_ciphersuites</a><a href="#method.set_client_ca_list">set_client_ca_list</a><a href="#method.set_client_hello_callback">set_client_hello_callback</a><a href="#method.set_cookie_generate_cb">set_cookie_generate_cb</a><a href="#method.set_cookie_verify_cb">set_cookie_verify_cb</a><a href="#method.set_default_verify_paths">set_default_verify_paths</a><a href="#method.set_ex_data">set_ex_data</a><a href="#method.set_get_session_callback">set_get_session_callback</a><a href="#method.set_groups_list">set_groups_list</a><a href="#method.set_keylog_callback">set_keylog_callback</a><a href="#method.set_max_early_data">set_max_early_data</a><a href="#method.set_max_proto_version">set_max_proto_version</a><a href="#method.set_min_proto_version">set_min_proto_version</a><a href="#method.set_mode">set_mode</a><a href="#method.set_new_session_callback">set_new_session_callback</a><a href="#method.set_options">set_options</a><a href="#method.set_private_key">set_private_key</a><a href="#method.set_private_key_file">set_private_key_file</a><a href="#method.set_psk_callback">set_psk_callback</a><a href="#method.set_psk_client_callback">set_psk_client_callback</a><a href="#method.set_psk_server_callback">set_psk_server_callback</a><a href="#method.set_read_ahead">set_read_ahead</a><a href="#method.set_remove_session_callback">set_remove_session_callback</a><a href="#method.set_servername_callback">set_servername_callback</a><a href="#method.set_session_cache_mode">set_session_cache_mode</a><a href="#method.set_session_cache_size">set_session_cache_size</a><a href="#method.set_session_id_context">set_session_id_context</a><a href="#method.set_sigalgs_list">set_sigalgs_list</a><a href="#method.set_stateless_cookie_generate_cb">set_stateless_cookie_generate_cb</a><a href="#method.set_stateless_cookie_verify_cb">set_stateless_cookie_verify_cb</a><a href="#method.set_status_callback">set_status_callback</a><a href="#method.set_tlsext_use_srtp">set_tlsext_use_srtp</a><a href="#method.set_tmp_dh">set_tmp_dh</a><a href="#method.set_tmp_dh_callback">set_tmp_dh_callback</a><a href="#method.set_tmp_ecdh">set_tmp_ecdh</a><a href="#method.set_verify">set_verify</a><a href="#method.set_verify_callback">set_verify_callback</a><a href="#method.set_verify_cert_store">set_verify_cert_store</a><a href="#method.set_verify_depth">set_verify_depth</a><a href="#method.verify_param">verify_param</a><a href="#method.verify_param_mut">verify_param_mut</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../index.html">openssl</a>::<wbr><a href="index.html">ssl</a></p><div id="sidebar-vars" data-name="SslContextBuilder" data-ty="struct" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Struct <a href="../index.html">openssl</a>::<wbr><a href="index.html">ssl</a>::<wbr><a class="struct" href="">SslContextBuilder</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#656" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct SslContextBuilder(_);</pre></div><div class="docblock"><p>A builder for <code>SslContext</code>s.</p>
|
||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl <a class="struct" href="../../openssl/ssl/struct.SslContextBuilder.html" title="struct openssl::ssl::SslContextBuilder">SslContextBuilder</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#658-1810" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.new" class="method"><code>pub fn <a href="#method.new" class="fnname">new</a>(method: <a class="struct" href="../../openssl/ssl/struct.SslMethod.html" title="struct openssl::ssl::SslMethod">SslMethod</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../openssl/ssl/struct.SslContextBuilder.html" title="struct openssl::ssl::SslContextBuilder">SslContextBuilder</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#664-671" title="goto source code">[src]</a></h4><div class="docblock"><p>Creates a new <code>SslContextBuilder</code>.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/manmaster/man3/SSL_CTX_new.html"><code>SSL_CTX_new</code></a>.</p>
|
||
</div><h4 id="method.from_ptr" class="method"><code>pub unsafe fn <a href="#method.from_ptr" class="fnname">from_ptr</a>(ctx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="../../openssl_sys/ossl_typ/enum.SSL_CTX.html" title="enum openssl_sys::ossl_typ::SSL_CTX">SSL_CTX</a>) -> <a class="struct" href="../../openssl/ssl/struct.SslContextBuilder.html" title="struct openssl::ssl::SslContextBuilder">SslContextBuilder</a></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#678-680" title="goto source code">[src]</a></h4><div class="docblock"><p>Creates an <code>SslContextBuilder</code> from a pointer to a raw OpenSSL value.</p>
|
||
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
|
||
<p>The caller must ensure that the pointer is valid and uniquely owned by the builder.</p>
|
||
</div><h4 id="method.as_ptr" class="method"><code>pub fn <a href="#method.as_ptr" class="fnname">as_ptr</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="../../openssl_sys/ossl_typ/enum.SSL_CTX.html" title="enum openssl_sys::ossl_typ::SSL_CTX">SSL_CTX</a></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#683-685" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a pointer to the raw OpenSSL value.</p>
|
||
</div><h4 id="method.set_verify" class="method"><code>pub fn <a href="#method.set_verify" class="fnname">set_verify</a>(&mut self, mode: <a class="struct" href="../../openssl/ssl/struct.SslVerifyMode.html" title="struct openssl::ssl::SslVerifyMode">SslVerifyMode</a>)</code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#692-696" title="goto source code">[src]</a></h4><div class="docblock"><p>Configures the certificate verification method for new connections.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_set_verify.html"><code>SSL_CTX_set_verify</code></a>.</p>
|
||
</div><h4 id="method.set_verify_callback" class="method"><code>pub fn <a href="#method.set_verify_callback" class="fnname">set_verify_callback</a><F>(&mut self, mode: <a class="struct" href="../../openssl/ssl/struct.SslVerifyMode.html" title="struct openssl::ssl::SslVerifyMode">SslVerifyMode</a>, verify: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, &mut <a class="struct" href="../../openssl/x509/struct.X509StoreContextRef.html" title="struct openssl::x509::X509StoreContextRef">X509StoreContextRef</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#708-716" title="goto source code">[src]</a></h4><div class="docblock"><p>Configures the certificate verification method for new connections and
|
||
registers a verification callback.</p>
|
||
<p>The callback is passed a boolean indicating if OpenSSL's internal verification succeeded as
|
||
well as a reference to the <code>X509StoreContext</code> which can be used to examine the certificate
|
||
chain. It should return a boolean indicating if verification succeeded.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_set_verify.html"><code>SSL_CTX_set_verify</code></a>.</p>
|
||
</div><h4 id="method.set_servername_callback" class="method"><code>pub fn <a href="#method.set_servername_callback" class="fnname">set_servername_callback</a><F>(&mut self, callback: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&mut <a class="struct" href="../../openssl/ssl/struct.SslRef.html" title="struct openssl::ssl::SslRef">SslRef</a>, &mut <a class="struct" href="../../openssl/ssl/struct.SslAlert.html" title="struct openssl::ssl::SslAlert">SslAlert</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/ssl/struct.SniError.html" title="struct openssl::ssl::SniError">SniError</a>> + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#730-747" title="goto source code">[src]</a></h4><div class="docblock"><p>Configures the server name indication (SNI) callback for new connections.</p>
|
||
<p>SNI is used to allow a single server to handle requests for multiple domains, each of which
|
||
has its own certificate chain and configuration.</p>
|
||
<p>Obtain the server name with the <code>servername</code> method and then set the corresponding context
|
||
with <code>set_ssl_context</code></p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/manmaster/man3/SSL_CTX_set_tlsext_servername_callback.html"><code>SSL_CTX_set_tlsext_servername_callback</code></a>.</p>
|
||
</div><h4 id="method.set_verify_depth" class="method"><code>pub fn <a href="#method.set_verify_depth" class="fnname">set_verify_depth</a>(&mut self, depth: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>)</code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#756-760" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the certificate verification depth.</p>
|
||
<p>If the peer's certificate chain is longer than this value, verification will fail.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_set_verify_depth.html"><code>SSL_CTX_set_verify_depth</code></a>.</p>
|
||
</div><h4 id="method.set_verify_cert_store" class="method"><code>pub fn <a href="#method.set_verify_cert_store" class="fnname">set_verify_cert_store</a>(<br> &mut self, <br> cert_store: <a class="struct" href="../../openssl/x509/store/struct.X509Store.html" title="struct openssl::x509::store::X509Store">X509Store</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#770-778" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets a custom certificate store for verifying peer certificates.</p>
|
||
<p>Requires OpenSSL 1.0.2 or newer.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set0_verify_cert_store.html"><code>SSL_CTX_set0_verify_cert_store</code></a>.</p>
|
||
</div><h4 id="method.set_cert_store" class="method"><code>pub fn <a href="#method.set_cert_store" class="fnname">set_cert_store</a>(&mut self, cert_store: <a class="struct" href="../../openssl/x509/store/struct.X509Store.html" title="struct openssl::x509::store::X509Store">X509Store</a>)</code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#785-790" title="goto source code">[src]</a></h4><div class="docblock"><p>Replaces the context's certificate store.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.0.2/man3/SSL_CTX_set_cert_store.html"><code>SSL_CTX_set_cert_store</code></a>.</p>
|
||
</div><h4 id="method.set_read_ahead" class="method"><code>pub fn <a href="#method.set_read_ahead" class="fnname">set_read_ahead</a>(&mut self, read_ahead: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>)</code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#802-806" title="goto source code">[src]</a></h4><div class="docblock"><p>Controls read ahead behavior.</p>
|
||
<p>If enabled, OpenSSL will read as much data as is available from the underlying stream,
|
||
instead of a single record at a time.</p>
|
||
<p>It has no effect when used with DTLS.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_set_read_ahead.html"><code>SSL_CTX_set_read_ahead</code></a>.</p>
|
||
</div><h4 id="method.set_mode" class="method"><code>pub fn <a href="#method.set_mode" class="fnname">set_mode</a>(&mut self, mode: <a class="struct" href="../../openssl/ssl/struct.SslMode.html" title="struct openssl::ssl::SslMode">SslMode</a>) -> <a class="struct" href="../../openssl/ssl/struct.SslMode.html" title="struct openssl::ssl::SslMode">SslMode</a></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#813-818" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the mode used by the context, returning the previous mode.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_mode.html"><code>SSL_CTX_set_mode</code></a>.</p>
|
||
</div><h4 id="method.set_tmp_dh" class="method"><code>pub fn <a href="#method.set_tmp_dh" class="fnname">set_tmp_dh</a>(&mut self, dh: &<a class="struct" href="../../openssl/dh/struct.DhRef.html" title="struct openssl::dh::DhRef">DhRef</a><<a class="enum" href="../../openssl/pkey/enum.Params.html" title="enum openssl::pkey::Params">Params</a>>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#825-827" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the parameters to be used during ephemeral Diffie-Hellman key exchange.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_tmp_dh.html"><code>SSL_CTX_set_tmp_dh</code></a>.</p>
|
||
</div><h4 id="method.set_tmp_dh_callback" class="method"><code>pub fn <a href="#method.set_tmp_dh_callback" class="fnname">set_tmp_dh_callback</a><F>(&mut self, callback: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&mut <a class="struct" href="../../openssl/ssl/struct.SslRef.html" title="struct openssl::ssl::SslRef">SslRef</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../openssl/dh/struct.Dh.html" title="struct openssl::dh::Dh">Dh</a><<a class="enum" href="../../openssl/pkey/enum.Params.html" title="enum openssl::pkey::Params">Params</a>>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>> + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#839-847" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the callback which will generate parameters to be used during ephemeral Diffie-Hellman
|
||
key exchange.</p>
|
||
<p>The callback is provided with a reference to the <code>Ssl</code> for the session, as well as a boolean
|
||
indicating if the selected cipher is export-grade, and the key length. The export and key
|
||
length options are archaic and should be ignored in almost all cases.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_tmp_dh.html"><code>SSL_CTX_set_tmp_dh_callback</code></a>.</p>
|
||
</div><h4 id="method.set_tmp_ecdh" class="method"><code>pub fn <a href="#method.set_tmp_ecdh" class="fnname">set_tmp_ecdh</a>(&mut self, key: &<a class="struct" href="../../openssl/ec/struct.EcKeyRef.html" title="struct openssl::ec::EcKeyRef">EcKeyRef</a><<a class="enum" href="../../openssl/pkey/enum.Params.html" title="enum openssl::pkey::Params">Params</a>>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#852-854" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the parameters to be used during ephemeral elliptic curve Diffie-Hellman key exchange.</p>
|
||
<p>This corresponds to <code>SSL_CTX_set_tmp_ecdh</code>.</p>
|
||
</div><h4 id="method.set_default_verify_paths" class="method"><code>pub fn <a href="#method.set_default_verify_paths" class="fnname">set_default_verify_paths</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#885-887" title="goto source code">[src]</a></h4><div class="docblock"><p>Use the default locations of trusted certificates for verification.</p>
|
||
<p>These locations are read from the <code>SSL_CERT_FILE</code> and <code>SSL_CERT_DIR</code> environment variables
|
||
if present, or defaults specified at OpenSSL build time otherwise.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_set_default_verify_paths.html"><code>SSL_CTX_set_default_verify_paths</code></a>.</p>
|
||
</div><h4 id="method.set_ca_file" class="method"><code>pub fn <a href="#method.set_ca_file" class="fnname">set_ca_file</a><P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.Path.html" title="struct std::path::Path">Path</a>>>(&mut self, file: P) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#896-906" title="goto source code">[src]</a></h4><div class="docblock"><p>Loads trusted root certificates from a file.</p>
|
||
<p>The file should contain a sequence of PEM-formatted CA certificates.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_load_verify_locations.html"><code>SSL_CTX_load_verify_locations</code></a>.</p>
|
||
</div><h4 id="method.set_client_ca_list" class="method"><code>pub fn <a href="#method.set_client_ca_list" class="fnname">set_client_ca_list</a>(&mut self, list: <a class="struct" href="../../openssl/stack/struct.Stack.html" title="struct openssl::stack::Stack">Stack</a><<a class="struct" href="../../openssl/x509/struct.X509Name.html" title="struct openssl::x509::X509Name">X509Name</a>>)</code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#916-921" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the list of CA names sent to the client.</p>
|
||
<p>The CA certificates must still be added to the trust root - they are not automatically set
|
||
as trusted by this method.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/manmaster/man3/SSL_CTX_set_client_CA_list.html"><code>SSL_CTX_set_client_CA_list</code></a>.</p>
|
||
</div><h4 id="method.add_client_ca" class="method"><code>pub fn <a href="#method.add_client_ca" class="fnname">add_client_ca</a>(&mut self, cacert: &<a class="struct" href="../../openssl/x509/struct.X509Ref.html" title="struct openssl::x509::X509Ref">X509Ref</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#930-932" title="goto source code">[src]</a></h4><div class="docblock"><p>Add the provided CA certificate to the list sent by the server to the client when
|
||
requesting client-side TLS authentication.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.0.2/man3/SSL_CTX_set_client_CA_list.html"><code>SSL_CTX_add_client_CA</code></a>.</p>
|
||
</div><h4 id="method.set_session_id_context" class="method"><code>pub fn <a href="#method.set_session_id_context" class="fnname">set_session_id_context</a>(<br> &mut self, <br> sid_ctx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#946-956" title="goto source code">[src]</a></h4><div class="docblock"><p>Set the context identifier for sessions.</p>
|
||
<p>This value identifies the server's session cache to clients, telling them when they're
|
||
able to reuse sessions. It should be set to a unique value per server, unless multiple
|
||
servers share a session cache.</p>
|
||
<p>This value should be set when using client certificates, or each request will fail its
|
||
handshake and need to be restarted.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/manmaster/man3/SSL_CTX_set_session_id_context.html"><code>SSL_CTX_set_session_id_context</code></a>.</p>
|
||
</div><h4 id="method.set_certificate_file" class="method"><code>pub fn <a href="#method.set_certificate_file" class="fnname">set_certificate_file</a><P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.Path.html" title="struct std::path::Path">Path</a>>>(<br> &mut self, <br> file: P, <br> file_type: <a class="struct" href="../../openssl/ssl/struct.SslFiletype.html" title="struct openssl::ssl::SslFiletype">SslFiletype</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#967-981" title="goto source code">[src]</a></h4><div class="docblock"><p>Loads a leaf certificate from a file.</p>
|
||
<p>Only a single certificate will be loaded - use <code>add_extra_chain_cert</code> to add the remainder
|
||
of the certificate chain, or <code>set_certificate_chain_file</code> to load the entire chain from a
|
||
single file.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_use_certificate_file.html"><code>SSL_CTX_use_certificate_file</code></a>.</p>
|
||
</div><h4 id="method.set_certificate_chain_file" class="method"><code>pub fn <a href="#method.set_certificate_chain_file" class="fnname">set_certificate_chain_file</a><P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.Path.html" title="struct std::path::Path">Path</a>>>(<br> &mut self, <br> file: P<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#992-1004" title="goto source code">[src]</a></h4><div class="docblock"><p>Loads a certificate chain from a file.</p>
|
||
<p>The file should contain a sequence of PEM-formatted certificates, the first being the leaf
|
||
certificate, and the remainder forming the chain of certificates up to and including the
|
||
trusted root certificate.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_use_certificate_file.html"><code>SSL_CTX_use_certificate_chain_file</code></a>.</p>
|
||
</div><h4 id="method.set_certificate" class="method"><code>pub fn <a href="#method.set_certificate" class="fnname">set_certificate</a>(&mut self, cert: &<a class="struct" href="../../openssl/x509/struct.X509Ref.html" title="struct openssl::x509::X509Ref">X509Ref</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1013-1015" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the leaf certificate.</p>
|
||
<p>Use <code>add_extra_chain_cert</code> to add the remainder of the certificate chain.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_use_certificate_file.html"><code>SSL_CTX_use_certificate</code></a>.</p>
|
||
</div><h4 id="method.add_extra_chain_cert" class="method"><code>pub fn <a href="#method.add_extra_chain_cert" class="fnname">add_extra_chain_cert</a>(&mut self, cert: <a class="struct" href="../../openssl/x509/struct.X509.html" title="struct openssl::x509::X509">X509</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1025-1031" title="goto source code">[src]</a></h4><div class="docblock"><p>Appends a certificate to the certificate chain.</p>
|
||
<p>This chain should contain all certificates necessary to go from the certificate specified by
|
||
<code>set_certificate</code> to a trusted root.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/manmaster/man3/SSL_CTX_add_extra_chain_cert.html"><code>SSL_CTX_add_extra_chain_cert</code></a>.</p>
|
||
</div><h4 id="method.set_private_key_file" class="method"><code>pub fn <a href="#method.set_private_key_file" class="fnname">set_private_key_file</a><P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.Path.html" title="struct std::path::Path">Path</a>>>(<br> &mut self, <br> file: P, <br> file_type: <a class="struct" href="../../openssl/ssl/struct.SslFiletype.html" title="struct openssl::ssl::SslFiletype">SslFiletype</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1038-1052" title="goto source code">[src]</a></h4><div class="docblock"><p>Loads the private key from a file.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_use_PrivateKey_file.html"><code>SSL_CTX_use_PrivateKey_file</code></a>.</p>
|
||
</div><h4 id="method.set_private_key" class="method"><code>pub fn <a href="#method.set_private_key" class="fnname">set_private_key</a><T>(&mut self, key: &<a class="struct" href="../../openssl/pkey/struct.PKeyRef.html" title="struct openssl::pkey::PKeyRef">PKeyRef</a><T>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>> <span class="where fmt-newline">where<br> T: <a class="trait" href="../../openssl/pkey/trait.HasPrivate.html" title="trait openssl::pkey::HasPrivate">HasPrivate</a>, </span></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1059-1064" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the private key.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_use_PrivateKey_file.html"><code>SSL_CTX_use_PrivateKey</code></a>.</p>
|
||
</div><h4 id="method.set_cipher_list" class="method"><code>pub fn <a href="#method.set_cipher_list" class="fnname">set_cipher_list</a>(&mut self, cipher_list: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1076-1085" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the list of supported ciphers for protocols before TLSv1.3.</p>
|
||
<p>The <code>set_ciphersuites</code> method controls the cipher suites for TLSv1.3.</p>
|
||
<p>See <a href="https://www.openssl.org/docs/man1.1.0/apps/ciphers.html"><code>ciphers</code></a> for details on the format.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/manmaster/man3/SSL_CTX_set_cipher_list.html"><code>SSL_CTX_set_cipher_list</code></a>.</p>
|
||
</div><h4 id="method.set_ciphersuites" class="method"><code>pub fn <a href="#method.set_ciphersuites" class="fnname">set_ciphersuites</a>(&mut self, cipher_list: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1100-1109" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the list of supported ciphers for the TLSv1.3 protocol.</p>
|
||
<p>The <code>set_cipher_list</code> method controls the cipher suites for protocols before TLSv1.3.</p>
|
||
<p>The format consists of TLSv1.3 ciphersuite names separated by <code>:</code> characters in order of
|
||
preference.</p>
|
||
<p>Requires OpenSSL 1.1.1 or newer.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/manmaster/man3/SSL_CTX_set_ciphersuites.html"><code>SSL_CTX_set_ciphersuites</code></a>.</p>
|
||
</div><h4 id="method.set_options" class="method"><code>pub fn <a href="#method.set_options" class="fnname">set_options</a>(&mut self, option: <a class="struct" href="../../openssl/ssl/struct.SslOptions.html" title="struct openssl::ssl::SslOptions">SslOptions</a>) -> <a class="struct" href="../../openssl/ssl/struct.SslOptions.html" title="struct openssl::ssl::SslOptions">SslOptions</a></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1133-1136" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the options used by the context, returning the old set.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/manmaster/man3/SSL_CTX_set_options.html"><code>SSL_CTX_set_options</code></a>.</p>
|
||
<h1 id="note" class="section-header"><a href="#note">Note</a></h1>
|
||
<p>This <em>enables</em> the specified options, but does not disable unspecified options. Use
|
||
<code>clear_options</code> for that.</p>
|
||
</div><h4 id="method.options" class="method"><code>pub fn <a href="#method.options" class="fnname">options</a>(&self) -> <a class="struct" href="../../openssl/ssl/struct.SslOptions.html" title="struct openssl::ssl::SslOptions">SslOptions</a></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1143-1146" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns the options used by the context.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/manmaster/man3/SSL_CTX_set_options.html"><code>SSL_CTX_get_options</code></a>.</p>
|
||
</div><h4 id="method.clear_options" class="method"><code>pub fn <a href="#method.clear_options" class="fnname">clear_options</a>(&mut self, option: <a class="struct" href="../../openssl/ssl/struct.SslOptions.html" title="struct openssl::ssl::SslOptions">SslOptions</a>) -> <a class="struct" href="../../openssl/ssl/struct.SslOptions.html" title="struct openssl::ssl::SslOptions">SslOptions</a></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1153-1156" title="goto source code">[src]</a></h4><div class="docblock"><p>Clears the options used by the context, returning the old set.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/manmaster/man3/SSL_CTX_set_options.html"><code>SSL_CTX_clear_options</code></a>.</p>
|
||
</div><h4 id="method.set_min_proto_version" class="method"><code>pub fn <a href="#method.set_min_proto_version" class="fnname">set_min_proto_version</a>(<br> &mut self, <br> version: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../openssl/ssl/struct.SslVersion.html" title="struct openssl::ssl::SslVersion">SslVersion</a>><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1169-1177" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the minimum supported protocol version.</p>
|
||
<p>A value of <code>None</code> will enable protocol versions down the the lowest version supported by
|
||
OpenSSL.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.1.0/ssl/SSL_set_min_proto_version.html"><code>SSL_CTX_set_min_proto_version</code></a>.</p>
|
||
<p>Requires OpenSSL 1.1.0 or LibreSSL 2.6.1 or newer.</p>
|
||
</div><h4 id="method.set_max_proto_version" class="method"><code>pub fn <a href="#method.set_max_proto_version" class="fnname">set_max_proto_version</a>(<br> &mut self, <br> version: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../openssl/ssl/struct.SslVersion.html" title="struct openssl::ssl::SslVersion">SslVersion</a>><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1190-1198" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the maximum supported protocol version.</p>
|
||
<p>A value of <code>None</code> will enable protocol versions down the the highest version supported by
|
||
OpenSSL.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.1.0/ssl/SSL_set_min_proto_version.html"><code>SSL_CTX_set_max_proto_version</code></a>.</p>
|
||
<p>Requires OpenSSL 1.1.0 or or LibreSSL 2.6.1 or newer.</p>
|
||
</div><h4 id="method.min_proto_version" class="method"><code>pub fn <a href="#method.min_proto_version" class="fnname">min_proto_version</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../openssl/ssl/struct.SslVersion.html" title="struct openssl::ssl::SslVersion">SslVersion</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1211-1220" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the minimum supported protocol version.</p>
|
||
<p>A value of <code>None</code> indicates that all versions down the the lowest version supported by
|
||
OpenSSL are enabled.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.1.0/ssl/SSL_set_min_proto_version.html"><code>SSL_CTX_get_min_proto_version</code></a>.</p>
|
||
<p>Requires OpenSSL 1.1.0g or LibreSSL 2.7.0 or newer.</p>
|
||
</div><h4 id="method.max_proto_version" class="method"><code>pub fn <a href="#method.max_proto_version" class="fnname">max_proto_version</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../openssl/ssl/struct.SslVersion.html" title="struct openssl::ssl::SslVersion">SslVersion</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1233-1242" title="goto source code">[src]</a></h4><div class="docblock"><p>Gets the maximum supported protocol version.</p>
|
||
<p>A value of <code>None</code> indicates that all versions down the the highest version supported by
|
||
OpenSSL are enabled.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.1.0/ssl/SSL_set_min_proto_version.html"><code>SSL_CTX_get_max_proto_version</code></a>.</p>
|
||
<p>Requires OpenSSL 1.1.0g or LibreSSL 2.7.0 or newer.</p>
|
||
</div><h4 id="method.set_alpn_protos" class="method"><code>pub fn <a href="#method.set_alpn_protos" class="fnname">set_alpn_protos</a>(&mut self, protocols: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1257-1272" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the protocols to sent to the server for Application Layer Protocol Negotiation (ALPN).</p>
|
||
<p>The input must be in ALPN "wire format". It consists of a sequence of supported protocol
|
||
names prefixed by their byte length. For example, the protocol list consisting of <code>spdy/1</code>
|
||
and <code>http/1.1</code> is encoded as <code>b"\x06spdy/1\x08http/1.1"</code>. The protocols are ordered by
|
||
preference.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_set_alpn_protos.html"><code>SSL_CTX_set_alpn_protos</code></a>.</p>
|
||
<p>Requires OpenSSL 1.0.2 or LibreSSL 2.6.1 or newer.</p>
|
||
</div><h4 id="method.set_tlsext_use_srtp" class="method"><code>pub fn <a href="#method.set_tlsext_use_srtp" class="fnname">set_tlsext_use_srtp</a>(&mut self, protocols: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1279-1291" title="goto source code">[src]</a></h4><div class="docblock"><p>Enables the DTLS extension "use_srtp" as defined in RFC5764.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.1.1/man3/SSL_CTX_set_tlsext_use_srtp.html"><code>SSL_CTX_set_tlsext_use_srtp</code></a>.</p>
|
||
</div><h4 id="method.set_alpn_select_callback" class="method"><code>pub fn <a href="#method.set_alpn_select_callback" class="fnname">set_alpn_select_callback</a><F>(&mut self, callback: F) <span class="where fmt-newline">where<br> F: for<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&mut <a class="struct" href="../../openssl/ssl/struct.SslRef.html" title="struct openssl::ssl::SslRef">SslRef</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <a class="struct" href="../../openssl/ssl/struct.AlpnError.html" title="struct openssl::ssl::AlpnError">AlpnError</a>> + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1309-1321" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the callback used by a server to select a protocol for Application Layer Protocol
|
||
Negotiation (ALPN).</p>
|
||
<p>The callback is provided with the client's protocol list in ALPN wire format. See the
|
||
documentation for <a href="struct.SslContextBuilder.html#method.set_alpn_protos"><code>SslContextBuilder::set_alpn_protos</code></a> for details. It should return one
|
||
of those protocols on success. The <a href="fn.select_next_proto.html"><code>select_next_proto</code></a> function implements the standard
|
||
protocol selection algorithm.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_set_alpn_protos.html"><code>SSL_CTX_set_alpn_select_cb</code></a>.</p>
|
||
<p>Requires OpenSSL 1.0.2 or LibreSSL 2.6.1 or newer.</p>
|
||
</div><h4 id="method.check_private_key" class="method"><code>pub fn <a href="#method.check_private_key" class="fnname">check_private_key</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1328-1330" title="goto source code">[src]</a></h4><div class="docblock"><p>Checks for consistency between the private key and certificate.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_check_private_key.html"><code>SSL_CTX_check_private_key</code></a>.</p>
|
||
</div><h4 id="method.cert_store" class="method"><code>pub fn <a href="#method.cert_store" class="fnname">cert_store</a>(&self) -> &<a class="struct" href="../../openssl/x509/store/struct.X509StoreBuilderRef.html" title="struct openssl::x509::store::X509StoreBuilderRef">X509StoreBuilderRef</a></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1337-1339" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a shared reference to the context's certificate store.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_get_cert_store.html"><code>SSL_CTX_get_cert_store</code></a>.</p>
|
||
</div><h4 id="method.cert_store_mut" class="method"><code>pub fn <a href="#method.cert_store_mut" class="fnname">cert_store_mut</a>(&mut self) -> &mut <a class="struct" href="../../openssl/x509/store/struct.X509StoreBuilderRef.html" title="struct openssl::x509::store::X509StoreBuilderRef">X509StoreBuilderRef</a></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1346-1348" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a mutable reference to the context's certificate store.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_get_cert_store.html"><code>SSL_CTX_get_cert_store</code></a>.</p>
|
||
</div><h4 id="method.verify_param" class="method"><code>pub fn <a href="#method.verify_param" class="fnname">verify_param</a>(&self) -> &<a class="struct" href="../../openssl/x509/verify/struct.X509VerifyParamRef.html" title="struct openssl::x509::verify::X509VerifyParamRef">X509VerifyParamRef</a></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1358-1360" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a reference to the X509 verification configuration.</p>
|
||
<p>Requires OpenSSL 1.0.2 or newer.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_get0_param.html"><code>SSL_CTX_get0_param</code></a>.</p>
|
||
</div><h4 id="method.verify_param_mut" class="method"><code>pub fn <a href="#method.verify_param_mut" class="fnname">verify_param_mut</a>(&mut self) -> &mut <a class="struct" href="../../openssl/x509/verify/struct.X509VerifyParamRef.html" title="struct openssl::x509::verify::X509VerifyParamRef">X509VerifyParamRef</a></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1370-1372" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a mutable reference to the X509 verification configuration.</p>
|
||
<p>Requires OpenSSL 1.0.2 or newer.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_get0_param.html"><code>SSL_CTX_get0_param</code></a>.</p>
|
||
</div><h4 id="method.set_status_callback" class="method"><code>pub fn <a href="#method.set_status_callback" class="fnname">set_status_callback</a><F>(&mut self, callback: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&mut <a class="struct" href="../../openssl/ssl/struct.SslRef.html" title="struct openssl::ssl::SslRef">SslRef</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>> + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1390-1402" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the callback dealing with OCSP stapling.</p>
|
||
<p>On the client side, this callback is responsible for validating the OCSP status response
|
||
returned by the server. The status may be retrieved with the <code>SslRef::ocsp_status</code> method.
|
||
A response of <code>Ok(true)</code> indicates that the OCSP status is valid, and a response of
|
||
<code>Ok(false)</code> indicates that the OCSP status is invalid and the handshake should be
|
||
terminated.</p>
|
||
<p>On the server side, this callback is resopnsible for setting the OCSP status response to be
|
||
returned to clients. The status may be set with the <code>SslRef::set_ocsp_status</code> method. A
|
||
response of <code>Ok(true)</code> indicates that the OCSP status should be returned to the client, and
|
||
<code>Ok(false)</code> indicates that the status should not be returned to the client.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_tlsext_status_cb.html"><code>SSL_CTX_set_tlsext_status_cb</code></a>.</p>
|
||
</div><h4 id="method.set_psk_client_callback" class="method"><code>pub fn <a href="#method.set_psk_client_callback" class="fnname">set_psk_client_callback</a><F>(&mut self, callback: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&mut <a class="struct" href="../../openssl/ssl/struct.SslRef.html" title="struct openssl::ssl::SslRef">SslRef</a>, <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>> + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1414-1425" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the callback for providing an identity and pre-shared key for a TLS-PSK client.</p>
|
||
<p>The callback will be called with the SSL context, an identity hint if one was provided
|
||
by the server, a mutable slice for each of the identity and pre-shared key bytes. The
|
||
identity must be written as a null-terminated C string.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_psk_client_callback.html"><code>SSL_CTX_set_psk_client_callback</code></a>.</p>
|
||
</div><h4 id="method.set_psk_callback" class="method"><code>pub fn <a href="#method.set_psk_callback" class="fnname">set_psk_callback</a><F>(&mut self, callback: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&mut <a class="struct" href="../../openssl/ssl/struct.SslRef.html" title="struct openssl::ssl::SslRef">SslRef</a>, <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>> + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1429-1437" title="goto source code">[src]</a></h4><div class="item-info"><div class="stab deprecated"><span class="emoji">👎</span> Deprecated since 0.10.10: <p>renamed to <code>set_psk_client_callback</code></p>
|
||
</div></div><h4 id="method.set_psk_server_callback" class="method"><code>pub fn <a href="#method.set_psk_server_callback" class="fnname">set_psk_server_callback</a><F>(&mut self, callback: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&mut <a class="struct" href="../../openssl/ssl/struct.SslRef.html" title="struct openssl::ssl::SslRef">SslRef</a>, <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>> + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1449-1460" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the callback for providing an identity and pre-shared key for a TLS-PSK server.</p>
|
||
<p>The callback will be called with the SSL context, an identity provided by the client,
|
||
and, a mutable slice for the pre-shared key bytes. The callback returns the number of
|
||
bytes in the pre-shared key.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_psk_server_callback.html"><code>SSL_CTX_set_psk_server_callback</code></a>.</p>
|
||
</div><h4 id="method.set_new_session_callback" class="method"><code>pub fn <a href="#method.set_new_session_callback" class="fnname">set_new_session_callback</a><F>(&mut self, callback: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&mut <a class="struct" href="../../openssl/ssl/struct.SslRef.html" title="struct openssl::ssl::SslRef">SslRef</a>, <a class="struct" href="../../openssl/ssl/struct.SslSession.html" title="struct openssl::ssl::SslSession">SslSession</a>) + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1478-1486" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the callback which is called when new sessions are negotiated.</p>
|
||
<p>This can be used by clients to implement session caching. While in TLSv1.2 the session is
|
||
available to access via <a href="struct.SslRef.html#method.session"><code>SslRef::session</code></a> immediately after the handshake completes, this
|
||
is not the case for TLSv1.3. There, a session is not generally available immediately, and
|
||
the server may provide multiple session tokens to the client over a single session. The new
|
||
session callback is a portable way to deal with both cases.</p>
|
||
<p>Note that session caching must be enabled for the callback to be invoked, and it defaults
|
||
off for clients. <a href="#method.set_session_cache_mode"><code>set_session_cache_mode</code></a> controls that behavior.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/manmaster/man3/SSL_CTX_sess_set_new_cb.html"><code>SSL_CTX_sess_set_new_cb</code></a>.</p>
|
||
</div><h4 id="method.set_remove_session_callback" class="method"><code>pub fn <a href="#method.set_remove_session_callback" class="fnname">set_remove_session_callback</a><F>(&mut self, callback: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&<a class="struct" href="../../openssl/ssl/struct.SslContextRef.html" title="struct openssl::ssl::SslContextRef">SslContextRef</a>, &<a class="struct" href="../../openssl/ssl/struct.SslSessionRef.html" title="struct openssl::ssl::SslSessionRef">SslSessionRef</a>) + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1495-1506" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the callback which is called when sessions are removed from the context.</p>
|
||
<p>Sessions can be removed because they have timed out or because they are considered faulty.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/manmaster/man3/SSL_CTX_sess_set_new_cb.html"><code>SSL_CTX_sess_set_remove_cb</code></a>.</p>
|
||
</div><h4 id="method.set_get_session_callback" class="method"><code>pub unsafe fn <a href="#method.set_get_session_callback" class="fnname">set_get_session_callback</a><F>(&mut self, callback: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&mut <a class="struct" href="../../openssl/ssl/struct.SslRef.html" title="struct openssl::ssl::SslRef">SslRef</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../openssl/ssl/struct.SslSession.html" title="struct openssl::ssl::SslSession">SslSession</a>> + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1522-1528" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the callback which is called when a client proposed to resume a session but it was not
|
||
found in the internal cache.</p>
|
||
<p>The callback is passed a reference to the session ID provided by the client. It should
|
||
return the session corresponding to that ID if available. This is only used for servers, not
|
||
clients.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/manmaster/man3/SSL_CTX_sess_set_new_cb.html"><code>SSL_CTX_sess_set_get_cb</code></a>.</p>
|
||
<h1 id="safety-1" class="section-header"><a href="#safety-1">Safety</a></h1>
|
||
<p>The returned <code>SslSession</code> must not be associated with a different <code>SslContext</code>.</p>
|
||
</div><h4 id="method.set_keylog_callback" class="method"><code>pub fn <a href="#method.set_keylog_callback" class="fnname">set_keylog_callback</a><F>(&mut self, callback: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&<a class="struct" href="../../openssl/ssl/struct.SslRef.html" title="struct openssl::ssl::SslRef">SslRef</a>, &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1542-1550" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the TLS key logging callback.</p>
|
||
<p>The callback is invoked whenever TLS key material is generated, and is passed a line of NSS
|
||
SSLKEYLOGFILE-formatted text. This can be used by tools like Wireshark to decrypt message
|
||
traffic. The line does not contain a trailing newline.</p>
|
||
<p>Requires OpenSSL 1.1.1 or newer.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/manmaster/man3/SSL_CTX_set_keylog_callback.html"><code>SSL_CTX_set_keylog_callback</code></a>.</p>
|
||
</div><h4 id="method.set_session_cache_mode" class="method"><code>pub fn <a href="#method.set_session_cache_mode" class="fnname">set_session_cache_mode</a>(<br> &mut self, <br> mode: <a class="struct" href="../../openssl/ssl/struct.SslSessionCacheMode.html" title="struct openssl::ssl::SslSessionCacheMode">SslSessionCacheMode</a><br>) -> <a class="struct" href="../../openssl/ssl/struct.SslSessionCacheMode.html" title="struct openssl::ssl::SslSessionCacheMode">SslSessionCacheMode</a></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1559-1564" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the session caching mode use for connections made with the context.</p>
|
||
<p>Returns the previous session caching mode.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_get_session_cache_mode.html"><code>SSL_CTX_set_session_cache_mode</code></a>.</p>
|
||
</div><h4 id="method.set_stateless_cookie_generate_cb" class="method"><code>pub fn <a href="#method.set_stateless_cookie_generate_cb" class="fnname">set_stateless_cookie_generate_cb</a><F>(&mut self, callback: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&mut <a class="struct" href="../../openssl/ssl/struct.SslRef.html" title="struct openssl::ssl::SslRef">SslRef</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>> + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1574-1585" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the callback for generating an application cookie for TLS1.3
|
||
stateless handshakes.</p>
|
||
<p>The callback will be called with the SSL context and a slice into which the cookie
|
||
should be written. The callback should return the number of bytes written.</p>
|
||
<p>This corresponds to <code>SSL_CTX_set_stateless_cookie_generate_cb</code>.</p>
|
||
</div><h4 id="method.set_stateless_cookie_verify_cb" class="method"><code>pub fn <a href="#method.set_stateless_cookie_verify_cb" class="fnname">set_stateless_cookie_verify_cb</a><F>(&mut self, callback: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&mut <a class="struct" href="../../openssl/ssl/struct.SslRef.html" title="struct openssl::ssl::SslRef">SslRef</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1598-1609" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the callback for verifying an application cookie for TLS1.3
|
||
stateless handshakes.</p>
|
||
<p>The callback will be called with the SSL context and the cookie supplied by the
|
||
client. It should return true if and only if the cookie is valid.</p>
|
||
<p>Note that the OpenSSL implementation independently verifies the integrity of
|
||
application cookies using an HMAC before invoking the supplied callback.</p>
|
||
<p>This corresponds to <code>SSL_CTX_set_stateless_cookie_verify_cb</code>.</p>
|
||
</div><h4 id="method.set_cookie_generate_cb" class="method"><code>pub fn <a href="#method.set_cookie_generate_cb" class="fnname">set_cookie_generate_cb</a><F>(&mut self, callback: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&mut <a class="struct" href="../../openssl/ssl/struct.SslRef.html" title="struct openssl::ssl::SslRef">SslRef</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>> + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1617-1625" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the callback for generating a DTLSv1 cookie</p>
|
||
<p>The callback will be called with the SSL context and a slice into which the cookie
|
||
should be written. The callback should return the number of bytes written.</p>
|
||
<p>This corresponds to <code>SSL_CTX_set_cookie_generate_cb</code>.</p>
|
||
</div><h4 id="method.set_cookie_verify_cb" class="method"><code>pub fn <a href="#method.set_cookie_verify_cb" class="fnname">set_cookie_verify_cb</a><F>(&mut self, callback: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&mut <a class="struct" href="../../openssl/ssl/struct.SslRef.html" title="struct openssl::ssl::SslRef">SslRef</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1633-1641" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the callback for verifying a DTLSv1 cookie</p>
|
||
<p>The callback will be called with the SSL context and the cookie supplied by the
|
||
client. It should return true if and only if the cookie is valid.</p>
|
||
<p>This corresponds to <code>SSL_CTX_set_cookie_verify_cb</code>.</p>
|
||
</div><h4 id="method.set_ex_data" class="method"><code>pub fn <a href="#method.set_ex_data" class="fnname">set_ex_data</a><T>(&mut self, index: <a class="struct" href="../../openssl/ex_data/struct.Index.html" title="struct openssl::ex_data::Index">Index</a><<a class="struct" href="../../openssl/ssl/struct.SslContext.html" title="struct openssl::ssl::SslContext">SslContext</a>, T>, data: T)</code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1651-1653" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the extra data at the specified index.</p>
|
||
<p>This can be used to provide data to callbacks registered with the context. Use the
|
||
<code>SslContext::new_ex_index</code> method to create an <code>Index</code>.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_ex_data.html"><code>SSL_CTX_set_ex_data</code></a>.</p>
|
||
</div><h4 id="method.add_custom_ext" class="method"><code>pub fn <a href="#method.add_custom_ext" class="fnname">add_custom_ext</a><AddFn, ParseFn, T>(<br> &mut self, <br> ext_type: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>, <br> context: <a class="struct" href="../../openssl/ssl/struct.ExtensionContext.html" title="struct openssl::ssl::ExtensionContext">ExtensionContext</a>, <br> add_cb: AddFn, <br> parse_cb: ParseFn<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>> <span class="where fmt-newline">where<br> AddFn: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&mut <a class="struct" href="../../openssl/ssl/struct.SslRef.html" title="struct openssl::ssl::SslRef">SslRef</a>, <a class="struct" href="../../openssl/ssl/struct.ExtensionContext.html" title="struct openssl::ssl::ExtensionContext">ExtensionContext</a>, <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, &<a class="struct" href="../../openssl/x509/struct.X509Ref.html" title="struct openssl::x509::X509Ref">X509Ref</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T>, <a class="struct" href="../../openssl/ssl/struct.SslAlert.html" title="struct openssl::ssl::SslAlert">SslAlert</a>> + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>> + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,<br> ParseFn: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&mut <a class="struct" href="../../openssl/ssl/struct.SslRef.html" title="struct openssl::ssl::SslRef">SslRef</a>, <a class="struct" href="../../openssl/ssl/struct.ExtensionContext.html" title="struct openssl::ssl::ExtensionContext">ExtensionContext</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, &<a class="struct" href="../../openssl/x509/struct.X509Ref.html" title="struct openssl::x509::X509Ref">X509Ref</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/ssl/struct.SslAlert.html" title="struct openssl::ssl::SslAlert">SslAlert</a>> + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1671-1718" title="goto source code">[src]</a></h4><div class="docblock"><p>Adds a custom extension for a TLS/DTLS client or server for all supported protocol versions.</p>
|
||
<p>Requires OpenSSL 1.1.1 or newer.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/manmaster/man3/SSL_CTX_add_custom_ext.html"><code>SSL_CTX_add_custom_ext</code></a>.</p>
|
||
</div><h4 id="method.set_max_early_data" class="method"><code>pub fn <a href="#method.set_max_early_data" class="fnname">set_max_early_data</a>(&mut self, bytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1730-1736" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the maximum amount of early data that will be accepted on incoming connections.</p>
|
||
<p>Defaults to 0.</p>
|
||
<p>Requires OpenSSL 1.1.1 or newer.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.1.1/man3/SSL_CTX_set_max_early_data.html"><code>SSL_CTX_set_max_early_data</code></a>.</p>
|
||
</div><h4 id="method.set_client_hello_callback" class="method"><code>pub fn <a href="#method.set_client_hello_callback" class="fnname">set_client_hello_callback</a><F>(&mut self, callback: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&mut <a class="struct" href="../../openssl/ssl/struct.SslRef.html" title="struct openssl::ssl::SslRef">SslRef</a>, &mut <a class="struct" href="../../openssl/ssl/struct.SslAlert.html" title="struct openssl::ssl::SslAlert">SslAlert</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../openssl/ssl/struct.ClientHelloResponse.html" title="struct openssl::ssl::ClientHelloResponse">ClientHelloResponse</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>> + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1746-1761" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets a callback which will be invoked just after the client's hello message is received.</p>
|
||
<p>Requires OpenSSL 1.1.1 or newer.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.1.1/man3/SSL_CTX_set_client_hello_cb.html"><code>SSL_CTX_set_client_hello_cb</code></a>.</p>
|
||
</div><h4 id="method.set_session_cache_size" class="method"><code>pub fn <a href="#method.set_session_cache_size" class="fnname">set_session_cache_size</a>(&mut self, size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1771-1773" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the context's session cache size limit, returning the previous limit.</p>
|
||
<p>A value of 0 means that the cache size is unbounded.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.0.2/man3/SSL_CTX_sess_set_cache_size.html"><code>SSL_CTX_sess_get_cache_size</code></a>.</p>
|
||
</div><h4 id="method.set_sigalgs_list" class="method"><code>pub fn <a href="#method.set_sigalgs_list" class="fnname">set_sigalgs_list</a>(&mut self, sigalgs: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1783-1789" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the context's supported signature algorithms.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.1.0/man3/SSL_CTX_set1_sigalgs_list.html"><code>SSL_CTX_set1_sigalgs_list</code></a>.</p>
|
||
<p>Requires OpenSSL 1.0.2 or newer.</p>
|
||
</div><h4 id="method.set_groups_list" class="method"><code>pub fn <a href="#method.set_groups_list" class="fnname">set_groups_list</a>(&mut self, groups: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../openssl/error/struct.ErrorStack.html" title="struct openssl::error::ErrorStack">ErrorStack</a>></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1799-1804" title="goto source code">[src]</a></h4><div class="docblock"><p>Sets the context's supported elliptic curve groups.</p>
|
||
<p>This corresponds to <a href="https://www.openssl.org/docs/man1.1.1/man3/SSL_CTX_set1_groups_list.html"><code>SSL_CTX_set1_groups_list</code></a>.</p>
|
||
<p>Requires OpenSSL 1.1.1 or newer.</p>
|
||
</div><h4 id="method.build" class="method"><code>pub fn <a href="#method.build" class="fnname">build</a>(self) -> <a class="struct" href="../../openssl/ssl/struct.SslContext.html" title="struct openssl::ssl::SslContext">SslContext</a></code><a class="srclink" href="../../src/openssl/ssl/mod.rs.html#1807-1809" title="goto source code">[src]</a></h4><div class="docblock"><p>Consumes the builder, returning a new <code>SslContext</code>.</p>
|
||
</div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../openssl/ssl/struct.SslContextBuilder.html" title="struct openssl::ssl::SslContextBuilder">SslContextBuilder</a></code><a href="#impl-RefUnwindSafe" class="anchor"></a><a class="srclink" href="../../src/openssl/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../openssl/ssl/struct.SslContextBuilder.html" title="struct openssl::ssl::SslContextBuilder">SslContextBuilder</a></code><a href="#impl-Send" class="anchor"></a><a class="srclink" href="../../src/openssl/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../openssl/ssl/struct.SslContextBuilder.html" title="struct openssl::ssl::SslContextBuilder">SslContextBuilder</a></code><a href="#impl-Sync" class="anchor"></a><a class="srclink" href="../../src/openssl/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../openssl/ssl/struct.SslContextBuilder.html" title="struct openssl::ssl::SslContextBuilder">SslContextBuilder</a></code><a href="#impl-Unpin" class="anchor"></a><a class="srclink" href="../../src/openssl/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../openssl/ssl/struct.SslContextBuilder.html" title="struct openssl::ssl::SslContextBuilder">SslContextBuilder</a></code><a href="#impl-UnwindSafe" class="anchor"></a><a class="srclink" href="../../src/openssl/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#207-211" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214-218" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#215" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545-549" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#546" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#534-541" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#538" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#582-591" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id="method.try_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#588" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#568-577" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id="method.try_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="openssl"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |