blob: 68abb6abc44f08ec26300c784f72da7c00655fb4 [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/openssl-0.10.54/src/dh.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>dh.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="../../openssl/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="../../openssl/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>
</pre><pre class="rust"><code><span class="doccomment">//! Diffie-Hellman key agreement.
</span><span class="kw">use </span>cfg_if::cfg_if;
<span class="kw">use </span>foreign_types::{ForeignType, ForeignTypeRef};
<span class="kw">use </span>std::mem;
<span class="kw">use </span>std::ptr;
<span class="kw">use </span><span class="kw">crate</span>::bn::{BigNum, BigNumRef};
<span class="kw">use </span><span class="kw">crate</span>::error::ErrorStack;
<span class="kw">use </span><span class="kw">crate</span>::pkey::{HasParams, HasPrivate, HasPublic, Params, Private, Public};
<span class="kw">use crate</span>::{cvt, cvt_p};
<span class="kw">use </span>openssl_macros::corresponds;
<span class="macro">generic_foreign_type_and_impl_send_sync! </span>{
<span class="kw">type </span>CType = ffi::DH;
<span class="kw">fn </span>drop = ffi::DH_free;
<span class="kw">pub struct </span>Dh&lt;T&gt;;
<span class="kw">pub struct </span>DhRef&lt;T&gt;;
}
<span class="kw">impl</span>&lt;T&gt; DhRef&lt;T&gt;
<span class="kw">where
</span>T: HasParams,
{
<span class="macro">to_pem! </span>{
<span class="doccomment">/// Serializes the parameters into a PEM-encoded PKCS#3 DHparameter structure.
///
/// The output will have a header of `-----BEGIN DH PARAMETERS-----`.
</span><span class="attribute">#[corresponds(PEM_write_bio_DHparams)]
</span>params_to_pem,
ffi::PEM_write_bio_DHparams
}
<span class="macro">to_der! </span>{
<span class="doccomment">/// Serializes the parameters into a DER-encoded PKCS#3 DHparameter structure.
</span><span class="attribute">#[corresponds(i2d_DHparams)]
</span>params_to_der,
ffi::i2d_DHparams
}
<span class="doccomment">/// Validates DH parameters for correctness
</span><span class="attribute">#[corresponds(DH_check_key)]
</span><span class="kw">pub fn </span>check_key(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;bool, ErrorStack&gt; {
<span class="kw">unsafe </span>{
<span class="kw">let </span><span class="kw-2">mut </span>codes = <span class="number">0</span>;
cvt(ffi::DH_check(<span class="self">self</span>.as_ptr(), <span class="kw-2">&amp;mut </span>codes))<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(codes == <span class="number">0</span>)
}
}
}
<span class="kw">impl </span>Dh&lt;Params&gt; {
<span class="kw">pub fn </span>from_params(p: BigNum, g: BigNum, q: BigNum) -&gt; <span class="prelude-ty">Result</span>&lt;Dh&lt;Params&gt;, ErrorStack&gt; {
<span class="self">Self</span>::from_pqg(p, <span class="prelude-val">Some</span>(q), g)
}
<span class="doccomment">/// Creates a DH instance based upon the given primes and generator params.
</span><span class="attribute">#[corresponds(DH_set0_pqg)]
</span><span class="kw">pub fn </span>from_pqg(
prime_p: BigNum,
prime_q: <span class="prelude-ty">Option</span>&lt;BigNum&gt;,
generator: BigNum,
) -&gt; <span class="prelude-ty">Result</span>&lt;Dh&lt;Params&gt;, ErrorStack&gt; {
<span class="kw">unsafe </span>{
<span class="kw">let </span>dh = Dh::from_ptr(cvt_p(ffi::DH_new())<span class="question-mark">?</span>);
cvt(DH_set0_pqg(
dh.<span class="number">0</span>,
prime_p.as_ptr(),
prime_q.as_ref().map_or(ptr::null_mut(), |q| q.as_ptr()),
generator.as_ptr(),
))<span class="question-mark">?</span>;
mem::forget((prime_p, prime_q, generator));
<span class="prelude-val">Ok</span>(dh)
}
}
<span class="doccomment">/// Sets the public key on the DH object.
</span><span class="kw">pub fn </span>set_public_key(<span class="self">self</span>, pub_key: BigNum) -&gt; <span class="prelude-ty">Result</span>&lt;Dh&lt;Public&gt;, ErrorStack&gt; {
<span class="kw">unsafe </span>{
<span class="kw">let </span>dh_ptr = <span class="self">self</span>.<span class="number">0</span>;
cvt(DH_set0_key(dh_ptr, pub_key.as_ptr(), ptr::null_mut()))<span class="question-mark">?</span>;
mem::forget((<span class="self">self</span>, pub_key));
<span class="prelude-val">Ok</span>(Dh::from_ptr(dh_ptr))
}
}
<span class="doccomment">/// Sets the private key on the DH object and recomputes the public key.
</span><span class="kw">pub fn </span>set_private_key(<span class="self">self</span>, priv_key: BigNum) -&gt; <span class="prelude-ty">Result</span>&lt;Dh&lt;Private&gt;, ErrorStack&gt; {
<span class="kw">unsafe </span>{
<span class="kw">let </span>dh_ptr = <span class="self">self</span>.<span class="number">0</span>;
cvt(DH_set0_key(dh_ptr, ptr::null_mut(), priv_key.as_ptr()))<span class="question-mark">?</span>;
mem::forget(priv_key);
cvt(ffi::DH_generate_key(dh_ptr))<span class="question-mark">?</span>;
mem::forget(<span class="self">self</span>);
<span class="prelude-val">Ok</span>(Dh::from_ptr(dh_ptr))
}
}
<span class="doccomment">/// Sets the public and private keys on the DH object.
</span><span class="kw">pub fn </span>set_key(<span class="self">self</span>, pub_key: BigNum, priv_key: BigNum) -&gt; <span class="prelude-ty">Result</span>&lt;Dh&lt;Private&gt;, ErrorStack&gt; {
<span class="kw">unsafe </span>{
<span class="kw">let </span>dh_ptr = <span class="self">self</span>.<span class="number">0</span>;
cvt(DH_set0_key(dh_ptr, pub_key.as_ptr(), priv_key.as_ptr()))<span class="question-mark">?</span>;
mem::forget((<span class="self">self</span>, pub_key, priv_key));
<span class="prelude-val">Ok</span>(Dh::from_ptr(dh_ptr))
}
}
<span class="doccomment">/// Generates DH params based on the given `prime_len` and a fixed `generator` value.
</span><span class="attribute">#[corresponds(DH_generate_parameters_ex)]
</span><span class="kw">pub fn </span>generate_params(prime_len: u32, generator: u32) -&gt; <span class="prelude-ty">Result</span>&lt;Dh&lt;Params&gt;, ErrorStack&gt; {
<span class="kw">unsafe </span>{
<span class="kw">let </span>dh = Dh::from_ptr(cvt_p(ffi::DH_new())<span class="question-mark">?</span>);
cvt(ffi::DH_generate_parameters_ex(
dh.<span class="number">0</span>,
prime_len <span class="kw">as </span>i32,
generator <span class="kw">as </span>i32,
ptr::null_mut(),
))<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(dh)
}
}
<span class="doccomment">/// Generates a public and a private key based on the DH params.
</span><span class="attribute">#[corresponds(DH_generate_key)]
</span><span class="kw">pub fn </span>generate_key(<span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;Dh&lt;Private&gt;, ErrorStack&gt; {
<span class="kw">unsafe </span>{
<span class="kw">let </span>dh_ptr = <span class="self">self</span>.<span class="number">0</span>;
cvt(ffi::DH_generate_key(dh_ptr))<span class="question-mark">?</span>;
mem::forget(<span class="self">self</span>);
<span class="prelude-val">Ok</span>(Dh::from_ptr(dh_ptr))
}
}
<span class="macro">from_pem! </span>{
<span class="doccomment">/// Deserializes a PEM-encoded PKCS#3 DHpararameters structure.
///
/// The input should have a header of `-----BEGIN DH PARAMETERS-----`.
</span><span class="attribute">#[corresponds(PEM_read_bio_DHparams)]
</span>params_from_pem,
Dh&lt;Params&gt;,
ffi::PEM_read_bio_DHparams
}
<span class="macro">from_der! </span>{
<span class="doccomment">/// Deserializes a DER-encoded PKCS#3 DHparameters structure.
</span><span class="attribute">#[corresponds(d2i_DHparams)]
</span>params_from_der,
Dh&lt;Params&gt;,
ffi::d2i_DHparams
}
<span class="doccomment">/// Requires OpenSSL 1.0.2 or newer.
</span><span class="attribute">#[corresponds(DH_get_1024_160)]
#[cfg(any(ossl102, ossl110))]
</span><span class="kw">pub fn </span>get_1024_160() -&gt; <span class="prelude-ty">Result</span>&lt;Dh&lt;Params&gt;, ErrorStack&gt; {
<span class="kw">unsafe </span>{
ffi::init();
cvt_p(ffi::DH_get_1024_160()).map(|p| Dh::from_ptr(p))
}
}
<span class="doccomment">/// Requires OpenSSL 1.0.2 or newer.
</span><span class="attribute">#[corresponds(DH_get_2048_224)]
#[cfg(any(ossl102, ossl110))]
</span><span class="kw">pub fn </span>get_2048_224() -&gt; <span class="prelude-ty">Result</span>&lt;Dh&lt;Params&gt;, ErrorStack&gt; {
<span class="kw">unsafe </span>{
ffi::init();
cvt_p(ffi::DH_get_2048_224()).map(|p| Dh::from_ptr(p))
}
}
<span class="doccomment">/// Requires OpenSSL 1.0.2 or newer.
</span><span class="attribute">#[corresponds(DH_get_2048_256)]
#[cfg(any(ossl102, ossl110))]
</span><span class="kw">pub fn </span>get_2048_256() -&gt; <span class="prelude-ty">Result</span>&lt;Dh&lt;Params&gt;, ErrorStack&gt; {
<span class="kw">unsafe </span>{
ffi::init();
cvt_p(ffi::DH_get_2048_256()).map(|p| Dh::from_ptr(p))
}
}
}
<span class="kw">impl</span>&lt;T&gt; Dh&lt;T&gt;
<span class="kw">where
</span>T: HasParams,
{
<span class="doccomment">/// Returns the prime `p` from the DH instance.
</span><span class="attribute">#[corresponds(DH_get0_pqg)]
</span><span class="kw">pub fn </span>prime_p(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>BigNumRef {
<span class="kw">let </span><span class="kw-2">mut </span>p = ptr::null();
<span class="kw">unsafe </span>{
DH_get0_pqg(<span class="self">self</span>.as_ptr(), <span class="kw-2">&amp;mut </span>p, ptr::null_mut(), ptr::null_mut());
BigNumRef::from_ptr(p <span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">_</span>)
}
}
<span class="doccomment">/// Returns the prime `q` from the DH instance.
</span><span class="attribute">#[corresponds(DH_get0_pqg)]
</span><span class="kw">pub fn </span>prime_q(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>BigNumRef&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>q = ptr::null();
<span class="kw">unsafe </span>{
DH_get0_pqg(<span class="self">self</span>.as_ptr(), ptr::null_mut(), <span class="kw-2">&amp;mut </span>q, ptr::null_mut());
<span class="kw">if </span>q.is_null() {
<span class="prelude-val">None
</span>} <span class="kw">else </span>{
<span class="prelude-val">Some</span>(BigNumRef::from_ptr(q <span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">_</span>))
}
}
}
<span class="doccomment">/// Returns the generator from the DH instance.
</span><span class="attribute">#[corresponds(DH_get0_pqg)]
</span><span class="kw">pub fn </span>generator(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>BigNumRef {
<span class="kw">let </span><span class="kw-2">mut </span>g = ptr::null();
<span class="kw">unsafe </span>{
DH_get0_pqg(<span class="self">self</span>.as_ptr(), ptr::null_mut(), ptr::null_mut(), <span class="kw-2">&amp;mut </span>g);
BigNumRef::from_ptr(g <span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">_</span>)
}
}
}
<span class="kw">impl</span>&lt;T&gt; DhRef&lt;T&gt;
<span class="kw">where
</span>T: HasPublic,
{
<span class="doccomment">/// Returns the public key from the DH instance.
</span><span class="attribute">#[corresponds(DH_get0_key)]
</span><span class="kw">pub fn </span>public_key(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>BigNumRef {
<span class="kw">let </span><span class="kw-2">mut </span>pub_key = ptr::null();
<span class="kw">unsafe </span>{
DH_get0_key(<span class="self">self</span>.as_ptr(), <span class="kw-2">&amp;mut </span>pub_key, ptr::null_mut());
BigNumRef::from_ptr(pub_key <span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">_</span>)
}
}
}
<span class="kw">impl</span>&lt;T&gt; DhRef&lt;T&gt;
<span class="kw">where
</span>T: HasPrivate,
{
<span class="doccomment">/// Computes a shared secret from the own private key and the given `public_key`.
</span><span class="attribute">#[corresponds(DH_compute_key)]
</span><span class="kw">pub fn </span>compute_key(<span class="kw-2">&amp;</span><span class="self">self</span>, public_key: <span class="kw-2">&amp;</span>BigNumRef) -&gt; <span class="prelude-ty">Result</span>&lt;Vec&lt;u8&gt;, ErrorStack&gt; {
<span class="kw">unsafe </span>{
<span class="kw">let </span>key_len = ffi::DH_size(<span class="self">self</span>.as_ptr());
<span class="kw">let </span><span class="kw-2">mut </span>key = <span class="macro">vec!</span>[<span class="number">0u8</span>; key_len <span class="kw">as </span>usize];
cvt(ffi::DH_compute_key(
key.as_mut_ptr(),
public_key.as_ptr(),
<span class="self">self</span>.as_ptr(),
))<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(key)
}
}
<span class="doccomment">/// Returns the private key from the DH instance.
</span><span class="attribute">#[corresponds(DH_get0_key)]
</span><span class="kw">pub fn </span>private_key(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>BigNumRef {
<span class="kw">let </span><span class="kw-2">mut </span>priv_key = ptr::null();
<span class="kw">unsafe </span>{
DH_get0_key(<span class="self">self</span>.as_ptr(), ptr::null_mut(), <span class="kw-2">&amp;mut </span>priv_key);
BigNumRef::from_ptr(priv_key <span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">_</span>)
}
}
}
<span class="macro">cfg_if! </span>{
<span class="kw">if </span><span class="attribute">#[cfg(any(ossl110, libressl270, boringssl))] </span>{
<span class="kw">use </span>ffi::{DH_set0_pqg, DH_get0_pqg, DH_get0_key, DH_set0_key};
} <span class="kw">else </span>{
<span class="attribute">#[allow(bad_style)]
</span><span class="kw">unsafe fn </span>DH_set0_pqg(
dh: <span class="kw-2">*mut </span>ffi::DH,
p: <span class="kw-2">*mut </span>ffi::BIGNUM,
q: <span class="kw-2">*mut </span>ffi::BIGNUM,
g: <span class="kw-2">*mut </span>ffi::BIGNUM,
) -&gt; ::libc::c_int {
(<span class="kw-2">*</span>dh).p = p;
(<span class="kw-2">*</span>dh).q = q;
(<span class="kw-2">*</span>dh).g = g;
<span class="number">1
</span>}
<span class="attribute">#[allow(bad_style)]
</span><span class="kw">unsafe fn </span>DH_get0_pqg(
dh: <span class="kw-2">*mut </span>ffi::DH,
p: <span class="kw-2">*mut *const </span>ffi::BIGNUM,
q: <span class="kw-2">*mut *const </span>ffi::BIGNUM,
g: <span class="kw-2">*mut *const </span>ffi::BIGNUM,
) {
<span class="kw">if </span>!p.is_null() {
<span class="kw-2">*</span>p = (<span class="kw-2">*</span>dh).p;
}
<span class="kw">if </span>!q.is_null() {
<span class="kw-2">*</span>q = (<span class="kw-2">*</span>dh).q;
}
<span class="kw">if </span>!g.is_null() {
<span class="kw-2">*</span>g = (<span class="kw-2">*</span>dh).g;
}
}
<span class="attribute">#[allow(bad_style)]
</span><span class="kw">unsafe fn </span>DH_set0_key(
dh: <span class="kw-2">*mut </span>ffi::DH,
pub_key: <span class="kw-2">*mut </span>ffi::BIGNUM,
priv_key: <span class="kw-2">*mut </span>ffi::BIGNUM,
) -&gt; ::libc::c_int {
(<span class="kw-2">*</span>dh).pub_key = pub_key;
(<span class="kw-2">*</span>dh).priv_key = priv_key;
<span class="number">1
</span>}
<span class="attribute">#[allow(bad_style)]
</span><span class="kw">unsafe fn </span>DH_get0_key(
dh: <span class="kw-2">*mut </span>ffi::DH,
pub_key: <span class="kw-2">*mut *const </span>ffi::BIGNUM,
priv_key: <span class="kw-2">*mut *const </span>ffi::BIGNUM,
) {
<span class="kw">if </span>!pub_key.is_null() {
<span class="kw-2">*</span>pub_key = (<span class="kw-2">*</span>dh).pub_key;
}
<span class="kw">if </span>!priv_key.is_null() {
<span class="kw-2">*</span>priv_key = (<span class="kw-2">*</span>dh).priv_key;
}
}
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span><span class="kw">crate</span>::bn::BigNum;
<span class="kw">use </span><span class="kw">crate</span>::dh::Dh;
<span class="kw">use </span><span class="kw">crate</span>::ssl::{SslContext, SslMethod};
<span class="attribute">#[test]
#[cfg(ossl102)]
</span><span class="kw">fn </span>test_dh_rfc5114() {
<span class="kw">let </span><span class="kw-2">mut </span>ctx = SslContext::builder(SslMethod::tls()).unwrap();
<span class="kw">let </span>dh2 = Dh::get_2048_224().unwrap();
ctx.set_tmp_dh(<span class="kw-2">&amp;</span>dh2).unwrap();
<span class="kw">let </span>dh3 = Dh::get_2048_256().unwrap();
ctx.set_tmp_dh(<span class="kw-2">&amp;</span>dh3).unwrap();
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_dh_params() {
<span class="kw">let </span><span class="kw-2">mut </span>ctx = SslContext::builder(SslMethod::tls()).unwrap();
<span class="kw">let </span>prime_p = BigNum::from_hex_str(
<span class="string">&quot;87A8E61DB4B6663CFFBBD19C651959998CEEF608660DD0F25D2CEED4435E3B00E00DF8F1D61957D4FAF7DF\
4561B2AA3016C3D91134096FAA3BF4296D830E9A7C209E0C6497517ABD5A8A9D306BCF67ED91F9E6725B47\
58C022E0B1EF4275BF7B6C5BFC11D45F9088B941F54EB1E59BB8BC39A0BF12307F5C4FDB70C581B23F76B6\
3ACAE1CAA6B7902D52526735488A0EF13C6D9A51BFA4AB3AD8347796524D8EF6A167B5A41825D967E144E5\
140564251CCACB83E6B486F6B3CA3F7971506026C0B857F689962856DED4010ABD0BE621C3A3960A54E710\
C375F26375D7014103A4B54330C198AF126116D2276E11715F693877FAD7EF09CADB094AE91E1A1597&quot;</span>,
).unwrap();
<span class="kw">let </span>prime_q = BigNum::from_hex_str(
<span class="string">&quot;3FB32C9B73134D0B2E77506660EDBD484CA7B18F21EF205407F4793A1A0BA12510DBC15077BE463FFF4FED\
4AAC0BB555BE3A6C1B0C6B47B1BC3773BF7E8C6F62901228F8C28CBB18A55AE31341000A650196F931C77A\
57F2DDF463E5E9EC144B777DE62AAAB8A8628AC376D282D6ED3864E67982428EBC831D14348F6F2F9193B5\
045AF2767164E1DFC967C1FB3F2E55A4BD1BFFE83B9C80D052B985D182EA0ADB2A3B7313D3FE14C8484B1E\
052588B9B7D2BBD2DF016199ECD06E1557CD0915B3353BBB64E0EC377FD028370DF92B52C7891428CDC67E\
B6184B523D1DB246C32F63078490F00EF8D647D148D47954515E2327CFEF98C582664B4C0F6CC41659&quot;</span>,
).unwrap();
<span class="kw">let </span>generator = BigNum::from_hex_str(
<span class="string">&quot;8CF83642A709A097B447997640129DA299B1A47D1EB3750BA308B0FE64F5FBD3&quot;</span>,
)
.unwrap();
<span class="kw">let </span>dh = Dh::from_params(
prime_p.to_owned().unwrap(),
generator.to_owned().unwrap(),
prime_q.to_owned().unwrap(),
)
.unwrap();
ctx.set_tmp_dh(<span class="kw-2">&amp;</span>dh).unwrap();
<span class="macro">assert_eq!</span>(dh.prime_p(), <span class="kw-2">&amp;</span>prime_p);
<span class="macro">assert_eq!</span>(dh.prime_q().unwrap(), <span class="kw-2">&amp;</span>prime_q);
<span class="macro">assert_eq!</span>(dh.generator(), <span class="kw-2">&amp;</span>generator);
}
<span class="attribute">#[test]
#[cfg(ossl102)]
</span><span class="kw">fn </span>test_dh_stored_restored() {
<span class="kw">let </span>dh1 = Dh::get_2048_256().unwrap();
<span class="kw">let </span>key1 = dh1.generate_key().unwrap();
<span class="kw">let </span>dh2 = Dh::get_2048_256().unwrap();
<span class="kw">let </span>key2 = dh2
.set_private_key(key1.private_key().to_owned().unwrap())
.unwrap();
<span class="macro">assert_eq!</span>(key1.public_key(), key2.public_key());
<span class="macro">assert_eq!</span>(key1.private_key(), key2.private_key());
}
<span class="attribute">#[test]
#[cfg(ossl102)]
</span><span class="kw">fn </span>test_set_keys() {
<span class="kw">let </span>dh1 = Dh::get_2048_256().unwrap();
<span class="kw">let </span>key1 = dh1.generate_key().unwrap();
<span class="kw">let </span>dh2 = Dh::get_2048_256().unwrap();
<span class="kw">let </span>key2 = dh2
.set_public_key(key1.public_key().to_owned().unwrap())
.unwrap();
<span class="macro">assert_eq!</span>(key1.public_key(), key2.public_key());
<span class="kw">let </span>dh3 = Dh::get_2048_256().unwrap();
<span class="kw">let </span>key3 = dh3
.set_key(
key1.public_key().to_owned().unwrap(),
key1.private_key().to_owned().unwrap(),
)
.unwrap();
<span class="macro">assert_eq!</span>(key1.public_key(), key3.public_key());
<span class="macro">assert_eq!</span>(key1.private_key(), key3.private_key());
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_dh_from_pem() {
<span class="kw">let </span><span class="kw-2">mut </span>ctx = SslContext::builder(SslMethod::tls()).unwrap();
<span class="kw">let </span>params = <span class="macro">include_bytes!</span>(<span class="string">&quot;../test/dhparams.pem&quot;</span>);
<span class="kw">let </span>dh = Dh::params_from_pem(params).unwrap();
ctx.set_tmp_dh(<span class="kw-2">&amp;</span>dh).unwrap();
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_dh_from_der() {
<span class="kw">let </span>params = <span class="macro">include_bytes!</span>(<span class="string">&quot;../test/dhparams.pem&quot;</span>);
<span class="kw">let </span>dh = Dh::params_from_pem(params).unwrap();
<span class="kw">let </span>der = dh.params_to_der().unwrap();
Dh::params_from_der(<span class="kw-2">&amp;</span>der).unwrap();
}
<span class="attribute">#[test]
#[cfg(ossl102)]
</span><span class="kw">fn </span>test_dh_generate_key_compute_key() {
<span class="kw">let </span>dh1 = Dh::get_2048_224().unwrap().generate_key().unwrap();
<span class="kw">let </span>dh2 = Dh::get_2048_224().unwrap().generate_key().unwrap();
<span class="kw">let </span>shared_a = dh1.compute_key(dh2.public_key()).unwrap();
<span class="kw">let </span>shared_b = dh2.compute_key(dh1.public_key()).unwrap();
<span class="macro">assert_eq!</span>(shared_a, shared_b);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_dh_generate_params_generate_key_compute_key() {
<span class="kw">let </span>dh_params1 = Dh::generate_params(<span class="number">512</span>, <span class="number">2</span>).unwrap();
<span class="kw">let </span>dh_params2 = Dh::from_pqg(
dh_params1.prime_p().to_owned().unwrap(),
<span class="prelude-val">None</span>,
dh_params1.generator().to_owned().unwrap(),
)
.unwrap();
<span class="kw">let </span>dh1 = dh_params1.generate_key().unwrap();
<span class="kw">let </span>dh2 = dh_params2.generate_key().unwrap();
<span class="kw">let </span>shared_a = dh1.compute_key(dh2.public_key()).unwrap();
<span class="kw">let </span>shared_b = dh2.compute_key(dh1.public_key()).unwrap();
<span class="macro">assert_eq!</span>(shared_a, shared_b);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_dh_check_key() {
<span class="kw">let </span>dh1 = Dh::generate_params(<span class="number">512</span>, <span class="number">2</span>).unwrap();
<span class="kw">let </span>p = BigNum::from_hex_str(<span class="string">&quot;04&quot;</span>).unwrap();
<span class="kw">let </span>g = BigNum::from_hex_str(<span class="string">&quot;02&quot;</span>).unwrap();
<span class="kw">let </span>dh2 = Dh::from_pqg(p, <span class="prelude-val">None</span>, g).unwrap();
<span class="macro">assert!</span>(dh1.check_key().unwrap());
<span class="macro">assert!</span>(!dh2.check_key().unwrap());
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="openssl" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>