blob: f5a7ee3acb4b72fa8c0c672649fcdfab769c7863 [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/reqwest-0.11.18/src/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="../../reqwest/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="../../reqwest/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>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
<span id="469">469</span>
<span id="470">470</span>
<span id="471">471</span>
<span id="472">472</span>
<span id="473">473</span>
<span id="474">474</span>
<span id="475">475</span>
<span id="476">476</span>
<span id="477">477</span>
<span id="478">478</span>
<span id="479">479</span>
<span id="480">480</span>
<span id="481">481</span>
<span id="482">482</span>
<span id="483">483</span>
<span id="484">484</span>
<span id="485">485</span>
<span id="486">486</span>
<span id="487">487</span>
<span id="488">488</span>
<span id="489">489</span>
<span id="490">490</span>
<span id="491">491</span>
<span id="492">492</span>
<span id="493">493</span>
<span id="494">494</span>
<span id="495">495</span>
<span id="496">496</span>
<span id="497">497</span>
<span id="498">498</span>
<span id="499">499</span>
<span id="500">500</span>
<span id="501">501</span>
<span id="502">502</span>
<span id="503">503</span>
<span id="504">504</span>
<span id="505">505</span>
<span id="506">506</span>
<span id="507">507</span>
<span id="508">508</span>
<span id="509">509</span>
<span id="510">510</span>
</pre><pre class="rust"><code><span class="doccomment">//! TLS configuration
//!
//! By default, a `Client` will make use of system-native transport layer
//! security to connect to HTTPS destinations. This means schannel on Windows,
//! Security-Framework on macOS, and OpenSSL on Linux.
//!
//! - Additional X509 certificates can be configured on a `ClientBuilder` with the
//! [`Certificate`](Certificate) type.
//! - Client certificates can be add to a `ClientBuilder` with the
//! [`Identity`][Identity] type.
//! - Various parts of TLS can also be configured or even disabled on the
//! `ClientBuilder`.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;__rustls&quot;</span>)]
</span><span class="kw">use </span>rustls::{
client::HandshakeSignatureValid, client::ServerCertVerified, client::ServerCertVerifier,
DigitallySignedStruct, Error <span class="kw">as </span>TLSError, ServerName,
};
<span class="kw">use </span>std::fmt;
<span class="doccomment">/// Represents a server X509 certificate.
</span><span class="attribute">#[derive(Clone)]
</span><span class="kw">pub struct </span>Certificate {
<span class="attribute">#[cfg(feature = <span class="string">&quot;native-tls-crate&quot;</span>)]
</span>native: native_tls_crate::Certificate,
<span class="attribute">#[cfg(feature = <span class="string">&quot;__rustls&quot;</span>)]
</span>original: Cert,
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;__rustls&quot;</span>)]
#[derive(Clone)]
</span><span class="kw">enum </span>Cert {
Der(Vec&lt;u8&gt;),
Pem(Vec&lt;u8&gt;),
}
<span class="doccomment">/// Represents a private key and X509 cert as a client certificate.
</span><span class="attribute">#[derive(Clone)]
</span><span class="kw">pub struct </span>Identity {
<span class="attribute">#[cfg_attr(not(any(feature = <span class="string">&quot;native-tls&quot;</span>, feature = <span class="string">&quot;__rustls&quot;</span>)), allow(unused))]
</span>inner: ClientCert,
}
<span class="attribute">#[derive(Clone)]
</span><span class="kw">enum </span>ClientCert {
<span class="attribute">#[cfg(feature = <span class="string">&quot;native-tls&quot;</span>)]
</span>Pkcs12(native_tls_crate::Identity),
<span class="attribute">#[cfg(feature = <span class="string">&quot;native-tls&quot;</span>)]
</span>Pkcs8(native_tls_crate::Identity),
<span class="attribute">#[cfg(feature = <span class="string">&quot;__rustls&quot;</span>)]
</span>Pem {
key: rustls::PrivateKey,
certs: Vec&lt;rustls::Certificate&gt;,
},
}
<span class="kw">impl </span>Certificate {
<span class="doccomment">/// Create a `Certificate` from a binary DER encoded certificate
///
/// # Examples
///
/// ```
/// # use std::fs::File;
/// # use std::io::Read;
/// # fn cert() -&gt; Result&lt;(), Box&lt;std::error::Error&gt;&gt; {
/// let mut buf = Vec::new();
/// File::open(&quot;my_cert.der&quot;)?
/// .read_to_end(&amp;mut buf)?;
/// let cert = reqwest::Certificate::from_der(&amp;buf)?;
/// # drop(cert);
/// # Ok(())
/// # }
/// ```
</span><span class="kw">pub fn </span>from_der(der: <span class="kw-2">&amp;</span>[u8]) -&gt; <span class="kw">crate</span>::Result&lt;Certificate&gt; {
<span class="prelude-val">Ok</span>(Certificate {
<span class="attribute">#[cfg(feature = <span class="string">&quot;native-tls-crate&quot;</span>)]
</span>native: native_tls_crate::Certificate::from_der(der).map_err(<span class="kw">crate</span>::error::builder)<span class="question-mark">?</span>,
<span class="attribute">#[cfg(feature = <span class="string">&quot;__rustls&quot;</span>)]
</span>original: Cert::Der(der.to_owned()),
})
}
<span class="doccomment">/// Create a `Certificate` from a PEM encoded certificate
///
/// # Examples
///
/// ```
/// # use std::fs::File;
/// # use std::io::Read;
/// # fn cert() -&gt; Result&lt;(), Box&lt;std::error::Error&gt;&gt; {
/// let mut buf = Vec::new();
/// File::open(&quot;my_cert.pem&quot;)?
/// .read_to_end(&amp;mut buf)?;
/// let cert = reqwest::Certificate::from_pem(&amp;buf)?;
/// # drop(cert);
/// # Ok(())
/// # }
/// ```
</span><span class="kw">pub fn </span>from_pem(pem: <span class="kw-2">&amp;</span>[u8]) -&gt; <span class="kw">crate</span>::Result&lt;Certificate&gt; {
<span class="prelude-val">Ok</span>(Certificate {
<span class="attribute">#[cfg(feature = <span class="string">&quot;native-tls-crate&quot;</span>)]
</span>native: native_tls_crate::Certificate::from_pem(pem).map_err(<span class="kw">crate</span>::error::builder)<span class="question-mark">?</span>,
<span class="attribute">#[cfg(feature = <span class="string">&quot;__rustls&quot;</span>)]
</span>original: Cert::Pem(pem.to_owned()),
})
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;native-tls-crate&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>add_to_native_tls(<span class="self">self</span>, tls: <span class="kw-2">&amp;mut </span>native_tls_crate::TlsConnectorBuilder) {
tls.add_root_certificate(<span class="self">self</span>.native);
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;__rustls&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>add_to_rustls(
<span class="self">self</span>,
root_cert_store: <span class="kw-2">&amp;mut </span>rustls::RootCertStore,
) -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
<span class="kw">use </span>std::io::Cursor;
<span class="kw">match </span><span class="self">self</span>.original {
Cert::Der(buf) =&gt; root_cert_store
.add(<span class="kw-2">&amp;</span>rustls::Certificate(buf))
.map_err(<span class="kw">crate</span>::error::builder)<span class="question-mark">?</span>,
Cert::Pem(buf) =&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>pem = Cursor::new(buf);
<span class="kw">let </span>certs = rustls_pemfile::certs(<span class="kw-2">&amp;mut </span>pem).map_err(|<span class="kw">_</span>| {
<span class="kw">crate</span>::error::builder(TLSError::General(String::from(
<span class="string">&quot;No valid certificate was found&quot;</span>,
)))
})<span class="question-mark">?</span>;
<span class="kw">for </span>c <span class="kw">in </span>certs {
root_cert_store
.add(<span class="kw-2">&amp;</span>rustls::Certificate(c))
.map_err(<span class="kw">crate</span>::error::builder)<span class="question-mark">?</span>;
}
}
}
<span class="prelude-val">Ok</span>(())
}
}
<span class="kw">impl </span>Identity {
<span class="doccomment">/// Parses a DER-formatted PKCS #12 archive, using the specified password to decrypt the key.
///
/// The archive should contain a leaf certificate and its private key, as well any intermediate
/// certificates that allow clients to build a chain to a trusted root.
/// The chain certificates should be in order from the leaf certificate towards the root.
///
/// PKCS #12 archives typically have the file extension `.p12` or `.pfx`, and can be created
/// with the OpenSSL `pkcs12` tool:
///
/// ```bash
/// openssl pkcs12 -export -out identity.pfx -inkey key.pem -in cert.pem -certfile chain_certs.pem
/// ```
///
/// # Examples
///
/// ```
/// # use std::fs::File;
/// # use std::io::Read;
/// # fn pkcs12() -&gt; Result&lt;(), Box&lt;std::error::Error&gt;&gt; {
/// let mut buf = Vec::new();
/// File::open(&quot;my-ident.pfx&quot;)?
/// .read_to_end(&amp;mut buf)?;
/// let pkcs12 = reqwest::Identity::from_pkcs12_der(&amp;buf, &quot;my-privkey-password&quot;)?;
/// # drop(pkcs12);
/// # Ok(())
/// # }
/// ```
///
/// # Optional
///
/// This requires the `native-tls` Cargo feature enabled.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;native-tls&quot;</span>)]
</span><span class="kw">pub fn </span>from_pkcs12_der(der: <span class="kw-2">&amp;</span>[u8], password: <span class="kw-2">&amp;</span>str) -&gt; <span class="kw">crate</span>::Result&lt;Identity&gt; {
<span class="prelude-val">Ok</span>(Identity {
inner: ClientCert::Pkcs12(
native_tls_crate::Identity::from_pkcs12(der, password)
.map_err(<span class="kw">crate</span>::error::builder)<span class="question-mark">?</span>,
),
})
}
<span class="doccomment">/// Parses a chain of PEM encoded X509 certificates, with the leaf certificate first.
/// `key` is a PEM encoded PKCS #8 formatted private key for the leaf certificate.
///
/// The certificate chain should contain any intermediate cerficates that should be sent to
/// clients to allow them to build a chain to a trusted root.
///
/// A certificate chain here means a series of PEM encoded certificates concatenated together.
///
/// # Examples
///
/// ```
/// # use std::fs;
/// # fn pkcs8() -&gt; Result&lt;(), Box&lt;std::error::Error&gt;&gt; {
/// let cert = fs::read(&quot;client.pem&quot;)?;
/// let key = fs::read(&quot;key.pem&quot;)?;
/// let pkcs8 = reqwest::Identity::from_pkcs8_pem(&amp;cert, &amp;key)?;
/// # drop(pkcs8);
/// # Ok(())
/// # }
/// ```
///
/// # Optional
///
/// This requires the `native-tls` Cargo feature enabled.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;native-tls&quot;</span>)]
</span><span class="kw">pub fn </span>from_pkcs8_pem(pem: <span class="kw-2">&amp;</span>[u8], key: <span class="kw-2">&amp;</span>[u8]) -&gt; <span class="kw">crate</span>::Result&lt;Identity&gt; {
<span class="prelude-val">Ok</span>(Identity {
inner: ClientCert::Pkcs8(
native_tls_crate::Identity::from_pkcs8(pem, key).map_err(<span class="kw">crate</span>::error::builder)<span class="question-mark">?</span>,
),
})
}
<span class="doccomment">/// Parses PEM encoded private key and certificate.
///
/// The input should contain a PEM encoded private key
/// and at least one PEM encoded certificate.
///
/// Note: The private key must be in RSA, SEC1 Elliptic Curve or PKCS#8 format.
///
/// # Examples
///
/// ```
/// # use std::fs::File;
/// # use std::io::Read;
/// # fn pem() -&gt; Result&lt;(), Box&lt;std::error::Error&gt;&gt; {
/// let mut buf = Vec::new();
/// File::open(&quot;my-ident.pem&quot;)?
/// .read_to_end(&amp;mut buf)?;
/// let id = reqwest::Identity::from_pem(&amp;buf)?;
/// # drop(id);
/// # Ok(())
/// # }
/// ```
///
/// # Optional
///
/// This requires the `rustls-tls(-...)` Cargo feature enabled.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;__rustls&quot;</span>)]
</span><span class="kw">pub fn </span>from_pem(buf: <span class="kw-2">&amp;</span>[u8]) -&gt; <span class="kw">crate</span>::Result&lt;Identity&gt; {
<span class="kw">use </span>std::io::Cursor;
<span class="kw">let </span>(key, certs) = {
<span class="kw">let </span><span class="kw-2">mut </span>pem = Cursor::new(buf);
<span class="kw">let </span><span class="kw-2">mut </span>sk = Vec::&lt;rustls::PrivateKey&gt;::new();
<span class="kw">let </span><span class="kw-2">mut </span>certs = Vec::&lt;rustls::Certificate&gt;::new();
<span class="kw">for </span>item <span class="kw">in </span>std::iter::from_fn(|| rustls_pemfile::read_one(<span class="kw-2">&amp;mut </span>pem).transpose()) {
<span class="kw">match </span>item.map_err(|<span class="kw">_</span>| {
<span class="kw">crate</span>::error::builder(TLSError::General(String::from(
<span class="string">&quot;Invalid identity PEM file&quot;</span>,
)))
})<span class="question-mark">? </span>{
rustls_pemfile::Item::X509Certificate(cert) =&gt; {
certs.push(rustls::Certificate(cert))
}
rustls_pemfile::Item::PKCS8Key(key) =&gt; sk.push(rustls::PrivateKey(key)),
rustls_pemfile::Item::RSAKey(key) =&gt; sk.push(rustls::PrivateKey(key)),
rustls_pemfile::Item::ECKey(key) =&gt; sk.push(rustls::PrivateKey(key)),
<span class="kw">_ </span>=&gt; {
<span class="kw">return </span><span class="prelude-val">Err</span>(<span class="kw">crate</span>::error::builder(TLSError::General(String::from(
<span class="string">&quot;No valid certificate was found&quot;</span>,
))))
}
}
}
<span class="kw">if let </span>(<span class="prelude-val">Some</span>(sk), <span class="bool-val">false</span>) = (sk.pop(), certs.is_empty()) {
(sk, certs)
} <span class="kw">else </span>{
<span class="kw">return </span><span class="prelude-val">Err</span>(<span class="kw">crate</span>::error::builder(TLSError::General(String::from(
<span class="string">&quot;private key or certificate not found&quot;</span>,
))));
}
};
<span class="prelude-val">Ok</span>(Identity {
inner: ClientCert::Pem { key, certs },
})
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;native-tls&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>add_to_native_tls(
<span class="self">self</span>,
tls: <span class="kw-2">&amp;mut </span>native_tls_crate::TlsConnectorBuilder,
) -&gt; <span class="kw">crate</span>::Result&lt;()&gt; {
<span class="kw">match </span><span class="self">self</span>.inner {
ClientCert::Pkcs12(id) | ClientCert::Pkcs8(id) =&gt; {
tls.identity(id);
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;__rustls&quot;</span>)]
</span>ClientCert::Pem { .. } =&gt; <span class="prelude-val">Err</span>(<span class="kw">crate</span>::error::builder(<span class="string">&quot;incompatible TLS identity type&quot;</span>)),
}
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;__rustls&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>add_to_rustls(
<span class="self">self</span>,
config_builder: rustls::ConfigBuilder&lt;
rustls::ClientConfig,
rustls::client::WantsTransparencyPolicyOrClientCert,
&gt;,
) -&gt; <span class="kw">crate</span>::Result&lt;rustls::ClientConfig&gt; {
<span class="kw">match </span><span class="self">self</span>.inner {
ClientCert::Pem { key, certs } =&gt; config_builder
.with_single_cert(certs, key)
.map_err(<span class="kw">crate</span>::error::builder),
<span class="attribute">#[cfg(feature = <span class="string">&quot;native-tls&quot;</span>)]
</span>ClientCert::Pkcs12(..) | ClientCert::Pkcs8(..) =&gt; {
<span class="prelude-val">Err</span>(<span class="kw">crate</span>::error::builder(<span class="string">&quot;incompatible TLS identity type&quot;</span>))
}
}
}
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Certificate {
<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) -&gt; fmt::Result {
f.debug_struct(<span class="string">&quot;Certificate&quot;</span>).finish()
}
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Identity {
<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) -&gt; fmt::Result {
f.debug_struct(<span class="string">&quot;Identity&quot;</span>).finish()
}
}
<span class="doccomment">/// A TLS protocol version.
</span><span class="attribute">#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
</span><span class="kw">pub struct </span>Version(InnerVersion);
<span class="attribute">#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
#[non_exhaustive]
</span><span class="kw">enum </span>InnerVersion {
Tls1_0,
Tls1_1,
Tls1_2,
Tls1_3,
}
<span class="comment">// These could perhaps be From/TryFrom implementations, but those would be
// part of the public API so let&#39;s be careful
</span><span class="kw">impl </span>Version {
<span class="doccomment">/// Version 1.0 of the TLS protocol.
</span><span class="kw">pub const </span>TLS_1_0: Version = Version(InnerVersion::Tls1_0);
<span class="doccomment">/// Version 1.1 of the TLS protocol.
</span><span class="kw">pub const </span>TLS_1_1: Version = Version(InnerVersion::Tls1_1);
<span class="doccomment">/// Version 1.2 of the TLS protocol.
</span><span class="kw">pub const </span>TLS_1_2: Version = Version(InnerVersion::Tls1_2);
<span class="doccomment">/// Version 1.3 of the TLS protocol.
</span><span class="kw">pub const </span>TLS_1_3: Version = Version(InnerVersion::Tls1_3);
<span class="attribute">#[cfg(feature = <span class="string">&quot;default-tls&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>to_native_tls(<span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;native_tls_crate::Protocol&gt; {
<span class="kw">match </span><span class="self">self</span>.<span class="number">0 </span>{
InnerVersion::Tls1_0 =&gt; <span class="prelude-val">Some</span>(native_tls_crate::Protocol::Tlsv10),
InnerVersion::Tls1_1 =&gt; <span class="prelude-val">Some</span>(native_tls_crate::Protocol::Tlsv11),
InnerVersion::Tls1_2 =&gt; <span class="prelude-val">Some</span>(native_tls_crate::Protocol::Tlsv12),
InnerVersion::Tls1_3 =&gt; <span class="prelude-val">None</span>,
}
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;__rustls&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>from_rustls(version: rustls::ProtocolVersion) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="self">Self</span>&gt; {
<span class="kw">match </span>version {
rustls::ProtocolVersion::SSLv2 =&gt; <span class="prelude-val">None</span>,
rustls::ProtocolVersion::SSLv3 =&gt; <span class="prelude-val">None</span>,
rustls::ProtocolVersion::TLSv1_0 =&gt; <span class="prelude-val">Some</span>(<span class="self">Self</span>(InnerVersion::Tls1_0)),
rustls::ProtocolVersion::TLSv1_1 =&gt; <span class="prelude-val">Some</span>(<span class="self">Self</span>(InnerVersion::Tls1_1)),
rustls::ProtocolVersion::TLSv1_2 =&gt; <span class="prelude-val">Some</span>(<span class="self">Self</span>(InnerVersion::Tls1_2)),
rustls::ProtocolVersion::TLSv1_3 =&gt; <span class="prelude-val">Some</span>(<span class="self">Self</span>(InnerVersion::Tls1_3)),
<span class="kw">_ </span>=&gt; <span class="prelude-val">None</span>,
}
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>TlsBackend {
<span class="comment">// This is the default and HTTP/3 feature does not use it so suppress it.
</span><span class="attribute">#[allow(dead_code)]
#[cfg(feature = <span class="string">&quot;default-tls&quot;</span>)]
</span>Default,
<span class="attribute">#[cfg(feature = <span class="string">&quot;native-tls&quot;</span>)]
</span>BuiltNativeTls(native_tls_crate::TlsConnector),
<span class="attribute">#[cfg(feature = <span class="string">&quot;__rustls&quot;</span>)]
</span>Rustls,
<span class="attribute">#[cfg(feature = <span class="string">&quot;__rustls&quot;</span>)]
</span>BuiltRustls(rustls::ClientConfig),
<span class="attribute">#[cfg(any(feature = <span class="string">&quot;native-tls&quot;</span>, feature = <span class="string">&quot;__rustls&quot;</span>,))]
</span>UnknownPreconfigured,
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>TlsBackend {
<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) -&gt; fmt::Result {
<span class="kw">match </span><span class="self">self </span>{
<span class="attribute">#[cfg(feature = <span class="string">&quot;default-tls&quot;</span>)]
</span>TlsBackend::Default =&gt; <span class="macro">write!</span>(f, <span class="string">&quot;Default&quot;</span>),
<span class="attribute">#[cfg(feature = <span class="string">&quot;native-tls&quot;</span>)]
</span>TlsBackend::BuiltNativeTls(<span class="kw">_</span>) =&gt; <span class="macro">write!</span>(f, <span class="string">&quot;BuiltNativeTls&quot;</span>),
<span class="attribute">#[cfg(feature = <span class="string">&quot;__rustls&quot;</span>)]
</span>TlsBackend::Rustls =&gt; <span class="macro">write!</span>(f, <span class="string">&quot;Rustls&quot;</span>),
<span class="attribute">#[cfg(feature = <span class="string">&quot;__rustls&quot;</span>)]
</span>TlsBackend::BuiltRustls(<span class="kw">_</span>) =&gt; <span class="macro">write!</span>(f, <span class="string">&quot;BuiltRustls&quot;</span>),
<span class="attribute">#[cfg(any(feature = <span class="string">&quot;native-tls&quot;</span>, feature = <span class="string">&quot;__rustls&quot;</span>,))]
</span>TlsBackend::UnknownPreconfigured =&gt; <span class="macro">write!</span>(f, <span class="string">&quot;UnknownPreconfigured&quot;</span>),
}
}
}
<span class="kw">impl </span>Default <span class="kw">for </span>TlsBackend {
<span class="kw">fn </span>default() -&gt; TlsBackend {
<span class="attribute">#[cfg(all(feature = <span class="string">&quot;default-tls&quot;</span>, not(feature = <span class="string">&quot;http3&quot;</span>)))]
</span>{
TlsBackend::Default
}
<span class="attribute">#[cfg(any(
all(feature = <span class="string">&quot;__rustls&quot;</span>, not(feature = <span class="string">&quot;default-tls&quot;</span>)),
feature = <span class="string">&quot;http3&quot;
</span>))]
</span>{
TlsBackend::Rustls
}
}
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;__rustls&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>NoVerifier;
<span class="attribute">#[cfg(feature = <span class="string">&quot;__rustls&quot;</span>)]
</span><span class="kw">impl </span>ServerCertVerifier <span class="kw">for </span>NoVerifier {
<span class="kw">fn </span>verify_server_cert(
<span class="kw-2">&amp;</span><span class="self">self</span>,
_end_entity: <span class="kw-2">&amp;</span>rustls::Certificate,
_intermediates: <span class="kw-2">&amp;</span>[rustls::Certificate],
_server_name: <span class="kw-2">&amp;</span>ServerName,
_scts: <span class="kw-2">&amp;mut </span><span class="kw">dyn </span>Iterator&lt;Item = <span class="kw-2">&amp;</span>[u8]&gt;,
_ocsp_response: <span class="kw-2">&amp;</span>[u8],
_now: std::time::SystemTime,
) -&gt; <span class="prelude-ty">Result</span>&lt;ServerCertVerified, TLSError&gt; {
<span class="prelude-val">Ok</span>(ServerCertVerified::assertion())
}
<span class="kw">fn </span>verify_tls12_signature(
<span class="kw-2">&amp;</span><span class="self">self</span>,
_message: <span class="kw-2">&amp;</span>[u8],
_cert: <span class="kw-2">&amp;</span>rustls::Certificate,
_dss: <span class="kw-2">&amp;</span>DigitallySignedStruct,
) -&gt; <span class="prelude-ty">Result</span>&lt;HandshakeSignatureValid, TLSError&gt; {
<span class="prelude-val">Ok</span>(HandshakeSignatureValid::assertion())
}
<span class="kw">fn </span>verify_tls13_signature(
<span class="kw-2">&amp;</span><span class="self">self</span>,
_message: <span class="kw-2">&amp;</span>[u8],
_cert: <span class="kw-2">&amp;</span>rustls::Certificate,
_dss: <span class="kw-2">&amp;</span>DigitallySignedStruct,
) -&gt; <span class="prelude-ty">Result</span>&lt;HandshakeSignatureValid, TLSError&gt; {
<span class="prelude-val">Ok</span>(HandshakeSignatureValid::assertion())
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="attribute">#[cfg(feature = <span class="string">&quot;default-tls&quot;</span>)]
#[test]
</span><span class="kw">fn </span>certificate_from_der_invalid() {
Certificate::from_der(<span class="string">b&quot;not der&quot;</span>).unwrap_err();
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;default-tls&quot;</span>)]
#[test]
</span><span class="kw">fn </span>certificate_from_pem_invalid() {
Certificate::from_pem(<span class="string">b&quot;not pem&quot;</span>).unwrap_err();
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;native-tls&quot;</span>)]
#[test]
</span><span class="kw">fn </span>identity_from_pkcs12_der_invalid() {
Identity::from_pkcs12_der(<span class="string">b&quot;not der&quot;</span>, <span class="string">&quot;nope&quot;</span>).unwrap_err();
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;native-tls&quot;</span>)]
#[test]
</span><span class="kw">fn </span>identity_from_pkcs8_pem_invalid() {
Identity::from_pkcs8_pem(<span class="string">b&quot;not pem&quot;</span>, <span class="string">b&quot;not key&quot;</span>).unwrap_err();
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;__rustls&quot;</span>)]
#[test]
</span><span class="kw">fn </span>identity_from_pem_invalid() {
Identity::from_pem(<span class="string">b&quot;not pem&quot;</span>).unwrap_err();
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;__rustls&quot;</span>)]
#[test]
</span><span class="kw">fn </span>identity_from_pem_pkcs1_key() {
<span class="kw">let </span>pem = <span class="string">b&quot;-----BEGIN CERTIFICATE-----\n\
-----END CERTIFICATE-----\n\
-----BEGIN RSA PRIVATE KEY-----\n\
-----END RSA PRIVATE KEY-----\n&quot;</span>;
Identity::from_pem(pem).unwrap();
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="reqwest" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>