blob: bc4a1ead793718c42908add1c30306ff1fa30dbb [file] [log] [blame]
<!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/tonic-0.6.2/src/transport/server/tls.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>tls.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../../normalize.css"><link rel="stylesheet" href="../../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../../ayu.css" disabled><link rel="stylesheet" href="../../../../dark.css" disabled><link rel="stylesheet" href="../../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../../storage.js"></script><script defer src="../../../../source-script.js"></script><script defer src="../../../../source-files.js"></script><script defer src="../../../../main.js"></script><noscript><link rel="stylesheet" href="../../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../../tonic/index.html"><div class="logo-container">
<img src="https://raw.githubusercontent.com/tokio-rs/website/master/public/img/icons/tonic.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../../tonic/index.html">
<img src="https://raw.githubusercontent.com/tokio-rs/website/master/public/img/icons/tonic.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
</pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::transport::{
service::TlsAcceptor,
tls::{Certificate, Identity},
};
<span class="kw">use </span>std::fmt;
<span class="doccomment">/// Configures TLS settings for servers.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;tls&quot;</span>)]
#[cfg_attr(docsrs, doc(cfg(feature = <span class="string">&quot;tls&quot;</span>)))]
#[derive(Clone, Default)]
</span><span class="kw">pub struct </span>ServerTlsConfig {
identity: <span class="prelude-ty">Option</span>&lt;Identity&gt;,
client_ca_root: <span class="prelude-ty">Option</span>&lt;Certificate&gt;,
rustls_raw: <span class="prelude-ty">Option</span>&lt;tokio_rustls::rustls::ServerConfig&gt;,
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;tls&quot;</span>)]
</span><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>ServerTlsConfig {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
f.debug_struct(<span class="string">&quot;ServerTlsConfig&quot;</span>).finish()
}
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;tls&quot;</span>)]
</span><span class="kw">impl </span>ServerTlsConfig {
<span class="doccomment">/// Creates a new `ServerTlsConfig`.
</span><span class="kw">pub fn </span>new() -&gt; <span class="self">Self </span>{
ServerTlsConfig {
identity: <span class="prelude-val">None</span>,
client_ca_root: <span class="prelude-val">None</span>,
rustls_raw: <span class="prelude-val">None</span>,
}
}
<span class="doccomment">/// Sets the [`Identity`] of the server.
</span><span class="kw">pub fn </span>identity(<span class="self">self</span>, identity: Identity) -&gt; <span class="self">Self </span>{
ServerTlsConfig {
identity: <span class="prelude-val">Some</span>(identity),
..<span class="self">self
</span>}
}
<span class="doccomment">/// Sets a certificate against which to validate client TLS certificates.
</span><span class="kw">pub fn </span>client_ca_root(<span class="self">self</span>, cert: Certificate) -&gt; <span class="self">Self </span>{
ServerTlsConfig {
client_ca_root: <span class="prelude-val">Some</span>(cert),
..<span class="self">self
</span>}
}
<span class="doccomment">/// Use options specified by the given `ServerConfig` to configure TLS.
///
/// This overrides all other TLS options set via other means.
</span><span class="kw">pub fn </span>rustls_server_config(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
config: tokio_rustls::rustls::ServerConfig,
) -&gt; <span class="kw-2">&amp;mut </span><span class="self">Self </span>{
<span class="self">self</span>.rustls_raw = <span class="prelude-val">Some</span>(config);
<span class="self">self
</span>}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>tls_acceptor(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;TlsAcceptor, <span class="kw">crate</span>::Error&gt; {
<span class="kw">match </span><span class="kw-2">&amp;</span><span class="self">self</span>.rustls_raw {
<span class="prelude-val">None </span>=&gt; TlsAcceptor::new_with_rustls_identity(
<span class="self">self</span>.identity.clone().unwrap(),
<span class="self">self</span>.client_ca_root.clone(),
),
<span class="prelude-val">Some</span>(config) =&gt; TlsAcceptor::new_with_rustls_raw(config.clone()),
}
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="tonic" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>