| <!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/rustls-0.19.1/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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="../../rustls/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../rustls/index.html"><img class="rust-logo" src="../../rust-logo.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> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| <span id="334">334</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! # Rustls - a modern TLS library |
| //! Rustls is a TLS library that aims to provide a good level of cryptographic security, |
| //! requires no configuration to achieve that security, and provides no unsafe features or |
| //! obsolete cryptography. |
| //! |
| //! ## Current features |
| //! |
| //! * TLS1.2 and TLS1.3. |
| //! * ECDSA, Ed25519 or RSA server authentication by clients. |
| //! * ECDSA, Ed25519 or RSA server authentication by servers. |
| //! * Forward secrecy using ECDHE; with curve25519, nistp256 or nistp384 curves. |
| //! * AES128-GCM and AES256-GCM bulk encryption, with safe nonces. |
| //! * ChaCha20-Poly1305 bulk encryption ([RFC7905](https://tools.ietf.org/html/rfc7905)). |
| //! * ALPN support. |
| //! * SNI support. |
| //! * Tunable MTU to make TLS messages match size of underlying transport. |
| //! * Optional use of vectored IO to minimise system calls. |
| //! * TLS1.2 session resumption. |
| //! * TLS1.2 resumption via tickets (RFC5077). |
| //! * TLS1.3 resumption via tickets or session storage. |
| //! * TLS1.3 0-RTT data for clients. |
| //! * Client authentication by clients. |
| //! * Client authentication by servers. |
| //! * Extended master secret support (RFC7627). |
| //! * Exporters (RFC5705). |
| //! * OCSP stapling by servers. |
| //! * SCT stapling by servers. |
| //! * SCT verification by clients. |
| //! |
| //! ## Possible future features |
| //! |
| //! * PSK support. |
| //! * OCSP verification by clients. |
| //! * Certificate pinning. |
| //! |
| //! ## Non-features |
| //! |
| //! The following things are broken, obsolete, badly designed, underspecified, |
| //! dangerous and/or insane. Rustls does not support: |
| //! |
| //! * SSL1, SSL2, SSL3, TLS1 or TLS1.1. |
| //! * RC4. |
| //! * DES or triple DES. |
| //! * EXPORT ciphersuites. |
| //! * MAC-then-encrypt ciphersuites. |
| //! * Ciphersuites without forward secrecy. |
| //! * Renegotiation. |
| //! * Kerberos. |
| //! * Compression. |
| //! * Discrete-log Diffie-Hellman. |
| //! * Automatic protocol version downgrade. |
| //! * AES-GCM with unsafe nonces. |
| //! |
| //! There are plenty of other libraries that provide these features should you |
| //! need them. |
| //! |
| //! ### Platform support |
| //! |
| //! Rustls uses [`ring`](https://crates.io/crates/ring) for implementing the |
| //! cryptography in TLS. As a result, rustls only runs on platforms |
| //! [supported by `ring`](https://github.com/briansmith/ring#online-automated-testing). |
| //! At the time of writing this means x86, x86-64, armv7, and aarch64. |
| //! |
| //! ## Design Overview |
| //! ### Rustls does not take care of network IO |
| //! It doesn't make or accept TCP connections, or do DNS, or read or write files. |
| //! |
| //! There's example client and server code which uses mio to do all needed network |
| //! IO. |
| //! |
| //! ### Rustls provides encrypted pipes |
| //! These are the `ServerSession` and `ClientSession` types. You supply raw TLS traffic |
| //! on the left (via the `read_tls()` and `write_tls()` methods) and then read/write the |
| //! plaintext on the right: |
| //! |
| //! ```text |
| //! TLS Plaintext |
| //! === ========= |
| //! read_tls() +-----------------------+ io::Read |
| //! | | |
| //! +---------> ClientSession +---------> |
| //! | or | |
| //! <---------+ ServerSession <---------+ |
| //! | | |
| //! write_tls() +-----------------------+ io::Write |
| //! ``` |
| //! |
| //! ### Rustls takes care of server certificate verification |
| //! You do not need to provide anything other than a set of root certificates to trust. |
| //! Certificate verification cannot be turned off or disabled in the main API. |
| //! |
| //! ## Getting started |
| //! This is the minimum you need to do to make a TLS client connection. |
| //! |
| //! First, we make a `ClientConfig`. You're likely to make one of these per process, |
| //! and use it for all connections made by that process. |
| //! |
| //! ``` |
| //! let mut config = rustls::ClientConfig::new(); |
| //! ``` |
| //! |
| //! Next we load some root certificates. These are used to authenticate the server. |
| //! The recommended way is to depend on the `webpki_roots` crate which contains |
| //! the Mozilla set of root certificates. |
| //! |
| //! ```rust,ignore |
| //! config.root_store.add_server_trust_anchors(&webpki_roots::TLS_SERVER_ROOTS); |
| //! ``` |
| //! |
| //! Now we can make a session. You need to provide the server's hostname so we |
| //! know what to expect to find in the server's certificate. |
| //! |
| //! ```no_run |
| //! # use rustls; |
| //! # use webpki; |
| //! # use std::sync::Arc; |
| //! # let mut config = rustls::ClientConfig::new(); |
| //! let rc_config = Arc::new(config); |
| //! let example_com = webpki::DNSNameRef::try_from_ascii_str("example.com").unwrap(); |
| //! let mut client = rustls::ClientSession::new(&rc_config, example_com); |
| //! ``` |
| //! |
| //! Now you should do appropriate IO for the `client` object. If `client.wants_read()` yields |
| //! true, you should call `client.read_tls()` when the underlying connection has data. |
| //! Likewise, if `client.wants_write()` yields true, you should call `client.write_tls()` |
| //! when the underlying connection is able to send data. You should continue doing this |
| //! as long as the connection is valid. |
| //! |
| //! The return types of `read_tls()` and `write_tls()` only tell you if the IO worked. No |
| //! parsing or processing of the TLS messages is done. After each `read_tls()` you should |
| //! therefore call `client.process_new_packets()` which parses and processes the messages. |
| //! Any error returned from `process_new_packets` is fatal to the session, and will tell you |
| //! why. For example, if the server's certificate is expired `process_new_packets` will |
| //! return `Err(WebPKIError(CertExpired))`. From this point on, `process_new_packets` will |
| //! not do any new work and will return that error continually. |
| //! |
| //! You can extract newly received data by calling `client.read()` (via the `io::Read` |
| //! trait). You can send data to the peer by calling `client.write()` (via the `io::Write` |
| //! trait). Note that `client.write()` buffers data you send if the TLS session is not |
| //! yet established: this is useful for writing (say) a HTTP request, but don't write huge |
| //! amounts of data. |
| //! |
| //! The following code uses a fictional socket IO API for illustration, and does not handle |
| //! errors. |
| //! |
| //! ```text |
| //! use std::io; |
| //! |
| //! client.write(b"GET / HTTP/1.0\r\n\r\n").unwrap(); |
| //! let mut socket = connect("example.com", 443); |
| //! loop { |
| //! if client.wants_read() && socket.ready_for_read() { |
| //! client.read_tls(&mut socket).unwrap(); |
| //! client.process_new_packets().unwrap(); |
| //! |
| //! let mut plaintext = Vec::new(); |
| //! client.read_to_end(&mut plaintext).unwrap(); |
| //! io::stdout().write(&plaintext).unwrap(); |
| //! } |
| //! |
| //! if client.wants_write() && socket.ready_for_write() { |
| //! client.write_tls(&mut socket).unwrap(); |
| //! } |
| //! |
| //! socket.wait_for_something_to_happen(); |
| //! } |
| //! ``` |
| //! |
| //! # Examples |
| //! `tlsserver` and `tlsclient` are full worked examples. These both use mio. |
| //! |
| //! # Crate features |
| //! Here's a list of what features are exposed by the rustls crate and what |
| //! they mean. |
| //! |
| //! - `logging`: this makes the rustls crate depend on the `log` crate. |
| //! rustls outputs interesting protocol-level messages at `trace!` and `debug!` |
| //! level, and protocol-level errors at `warn!` and `error!` level. The log |
| //! messages do not contain secret key data, and so are safe to archive without |
| //! affecting session security. This feature is in the default set. |
| //! |
| //! - `dangerous_configuration`: this feature enables a `dangerous()` method on |
| //! `ClientConfig` and `ServerConfig` that allows setting inadvisable options, |
| //! such as replacing the certificate verification process. Applications |
| //! requesting this feature should be reviewed carefully. |
| //! |
| //! - `quic`: this feature exposes additional constructors and functions |
| //! for using rustls as a TLS library for QUIC. See the `quic` module for |
| //! details of these. You will only need this if you're writing a QUIC |
| //! implementation. |
| //! |
| |
| </span><span class="comment">// Require docs for public APIs, deny unsafe code, etc. |
| </span><span class="attribute">#![forbid(unsafe_code, unused_must_use, unstable_features)] |
| #![deny( |
| trivial_casts, |
| trivial_numeric_casts, |
| missing_docs, |
| unused_import_braces, |
| unused_extern_crates, |
| unused_qualifications |
| )] |
| </span><span class="comment">// Relax these clippy lints: |
| // - ptr_arg: this triggers on references to type aliases that are Vec |
| // underneath. |
| </span><span class="attribute">#![cfg_attr(feature = <span class="string">"cargo-clippy"</span>, allow(clippy::ptr_arg))] |
| </span><span class="comment">// Enable documentation for all features on docs.rs |
| </span><span class="attribute">#![cfg_attr(docsrs, feature(doc_cfg))] |
| |
| </span><span class="comment">// log for logging (optional). |
| </span><span class="attribute">#[cfg(feature = <span class="string">"logging"</span>)] |
| </span><span class="kw">use </span>log; |
| |
| <span class="attribute">#[cfg(not(feature = <span class="string">"logging"</span>))] |
| #[macro_use] |
| </span><span class="kw">mod </span>log { |
| <span class="macro">macro_rules! </span>trace ( ($(<span class="macro-nonterminal">$tt</span>:tt)<span class="kw-2">*</span>) => {{}} ); |
| <span class="macro">macro_rules! </span>debug ( ($(<span class="macro-nonterminal">$tt</span>:tt)<span class="kw-2">*</span>) => {{}} ); |
| <span class="macro">macro_rules! </span>warn ( ($(<span class="macro-nonterminal">$tt</span>:tt)<span class="kw-2">*</span>) => {{}} ); |
| <span class="macro">macro_rules! </span>error ( ($(<span class="macro-nonterminal">$tt</span>:tt)<span class="kw-2">*</span>) => {{}} ); |
| } |
| |
| <span class="attribute">#[allow(missing_docs)] |
| #[macro_use] |
| </span><span class="kw">mod </span>msgs; |
| <span class="kw">mod </span>anchors; |
| <span class="kw">mod </span>cipher; |
| <span class="kw">mod </span>error; |
| <span class="kw">mod </span>hash_hs; |
| <span class="kw">mod </span>key_schedule; |
| <span class="kw">mod </span>pemfile; |
| <span class="kw">mod </span>prf; |
| <span class="kw">mod </span>rand; |
| <span class="kw">mod </span>record_layer; |
| <span class="kw">mod </span>session; |
| <span class="kw">mod </span>stream; |
| <span class="kw">mod </span>vecbuf; |
| <span class="kw">mod </span>verify; |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>verifybench; |
| <span class="kw">mod </span>x509; |
| <span class="attribute">#[macro_use] |
| </span><span class="kw">mod </span>check; |
| <span class="kw">mod </span>bs_debug; |
| <span class="kw">mod </span>client; |
| <span class="kw">mod </span>key; |
| <span class="kw">mod </span>keylog; |
| <span class="kw">mod </span>server; |
| <span class="kw">mod </span>suites; |
| <span class="kw">mod </span>ticketer; |
| |
| <span class="doccomment">/// Internal classes which may be useful outside the library. |
| /// The contents of this section DO NOT form part of the stable interface. |
| </span><span class="kw">pub mod </span>internal { |
| <span class="doccomment">/// Functions for parsing PEM files containing certificates/keys. |
| </span><span class="kw">pub mod </span>pemfile { |
| <span class="kw">pub use </span><span class="kw">crate</span>::pemfile::{certs, pkcs8_private_keys, rsa_private_keys}; |
| } |
| |
| <span class="doccomment">/// Low-level TLS message parsing and encoding functions. |
| </span><span class="kw">pub mod </span>msgs { |
| <span class="kw">pub use </span><span class="kw">crate</span>::msgs::<span class="kw-2">*</span>; |
| } |
| } |
| |
| <span class="comment">// The public interface is: |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::anchors::{DistinguishedNames, OwnedTrustAnchor, RootCertStore}; |
| <span class="kw">pub use </span><span class="kw">crate</span>::client::handy::{ClientSessionMemoryCache, NoClientSessionStorage}; |
| <span class="kw">pub use </span><span class="kw">crate</span>::client::ResolvesClientCert; |
| <span class="kw">pub use </span><span class="kw">crate</span>::client::StoresClientSessions; |
| <span class="kw">pub use </span><span class="kw">crate</span>::client::{ClientConfig, ClientSession, WriteEarlyData}; |
| <span class="kw">pub use </span><span class="kw">crate</span>::error::TLSError; |
| <span class="kw">pub use </span><span class="kw">crate</span>::key::{Certificate, PrivateKey}; |
| <span class="kw">pub use </span><span class="kw">crate</span>::keylog::{KeyLog, KeyLogFile, NoKeyLog}; |
| <span class="kw">pub use </span><span class="kw">crate</span>::msgs::enums::CipherSuite; |
| <span class="kw">pub use </span><span class="kw">crate</span>::msgs::enums::ProtocolVersion; |
| <span class="kw">pub use </span><span class="kw">crate</span>::msgs::enums::SignatureScheme; |
| <span class="kw">pub use </span><span class="kw">crate</span>::server::handy::ResolvesServerCertUsingSNI; |
| <span class="kw">pub use </span><span class="kw">crate</span>::server::handy::{NoServerSessionStorage, ServerSessionMemoryCache}; |
| <span class="kw">pub use </span><span class="kw">crate</span>::server::StoresServerSessions; |
| <span class="kw">pub use </span><span class="kw">crate</span>::server::{ClientHello, ProducesTickets, ResolvesServerCert}; |
| <span class="kw">pub use </span><span class="kw">crate</span>::server::{ServerConfig, ServerSession}; |
| <span class="kw">pub use </span><span class="kw">crate</span>::session::Session; |
| <span class="kw">pub use </span><span class="kw">crate</span>::stream::{Stream, StreamOwned}; |
| <span class="kw">pub use </span><span class="kw">crate</span>::suites::{BulkAlgorithm, SupportedCipherSuite, ALL_CIPHERSUITES}; |
| <span class="kw">pub use </span><span class="kw">crate</span>::ticketer::Ticketer; |
| <span class="kw">pub use </span><span class="kw">crate</span>::verify::{ |
| AllowAnyAnonymousOrAuthenticatedClient, AllowAnyAuthenticatedClient, NoClientAuth, |
| }; |
| |
| <span class="doccomment">/// All defined ciphersuites appear in this module. |
| /// |
| /// ALL_CIPHERSUITES is provided an array of all of these values. |
| </span><span class="kw">pub mod </span>ciphersuite { |
| <span class="kw">pub use </span><span class="kw">crate</span>::suites::TLS13_AES_128_GCM_SHA256; |
| <span class="kw">pub use </span><span class="kw">crate</span>::suites::TLS13_AES_256_GCM_SHA384; |
| <span class="kw">pub use </span><span class="kw">crate</span>::suites::TLS13_CHACHA20_POLY1305_SHA256; |
| <span class="kw">pub use </span><span class="kw">crate</span>::suites::TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256; |
| <span class="kw">pub use </span><span class="kw">crate</span>::suites::TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384; |
| <span class="kw">pub use </span><span class="kw">crate</span>::suites::TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256; |
| <span class="kw">pub use </span><span class="kw">crate</span>::suites::TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256; |
| <span class="kw">pub use </span><span class="kw">crate</span>::suites::TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384; |
| <span class="kw">pub use </span><span class="kw">crate</span>::suites::TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256; |
| } |
| |
| <span class="doccomment">/// Message signing interfaces and implementations. |
| </span><span class="kw">pub mod </span>sign; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"quic"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"quic"</span>)))] |
| </span><span class="doccomment">/// APIs for implementing QUIC TLS |
| </span><span class="kw">pub mod </span>quic; |
| |
| <span class="attribute">#[cfg(not(feature = <span class="string">"quic"</span>))] |
| </span><span class="comment">// If QUIC support is disabled, just define a private module with an empty |
| // trait to allow Session having QuicExt as a trait bound. |
| </span><span class="kw">mod </span>quic { |
| <span class="kw">pub trait </span>QuicExt {} |
| <span class="kw">impl </span>QuicExt <span class="kw">for </span><span class="kw">super</span>::ClientSession {} |
| <span class="kw">impl </span>QuicExt <span class="kw">for </span><span class="kw">super</span>::ServerSession {} |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"dangerous_configuration"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"dangerous_configuration"</span>)))] |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::client::danger::DangerousClientConfig; |
| <span class="attribute">#[cfg(feature = <span class="string">"dangerous_configuration"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"dangerous_configuration"</span>)))] |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::verify::{ |
| ClientCertVerified, ClientCertVerifier, HandshakeSignatureValid, ServerCertVerified, |
| ServerCertVerifier, WebPKIVerifier, |
| }; |
| |
| <span class="doccomment">/// This is the rustls manual. |
| </span><span class="kw">pub mod </span>manual; |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustls" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
