| <!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/git/checkouts/incubator-teaclave-crates-c8106113f74feefc/ede1f68/ring/src/agreement.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>agreement.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="../../ring/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="../../ring/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> |
| </pre><pre class="rust"><code><span class="comment">// Copyright 2015-2017 Brian Smith. |
| // |
| // Permission to use, copy, modify, and/or distribute this software for any |
| // purpose with or without fee is hereby granted, provided that the above |
| // copyright notice and this permission notice appear in all copies. |
| // |
| // THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES |
| // WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
| // MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY |
| // SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
| // WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION |
| // OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN |
| // CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
| |
| </span><span class="doccomment">//! Key Agreement: ECDH, including X25519. |
| //! |
| //! # Example |
| //! |
| //! Note that this example uses X25519, but ECDH using NIST P-256/P-384 is done |
| //! exactly the same way, just substituting |
| //! `agreement::ECDH_P256`/`agreement::ECDH_P384` for `agreement::X25519`. |
| //! |
| //! ``` |
| //! use ring::{agreement, rand}; |
| //! |
| //! let rng = rand::SystemRandom::new(); |
| //! |
| //! let my_private_key = agreement::EphemeralPrivateKey::generate(&agreement::X25519, &rng)?; |
| //! |
| //! // Make `my_public_key` a byte slice containing my public key. In a real |
| //! // application, this would be sent to the peer in an encoded protocol |
| //! // message. |
| //! let my_public_key = my_private_key.compute_public_key()?; |
| //! |
| //! let peer_public_key = { |
| //! // In a real application, the peer public key would be parsed out of a |
| //! // protocol message. Here we just generate one. |
| //! let peer_public_key = { |
| //! let peer_private_key = |
| //! agreement::EphemeralPrivateKey::generate(&agreement::X25519, &rng)?; |
| //! peer_private_key.compute_public_key()? |
| //! }; |
| //! |
| //! agreement::UnparsedPublicKey::new(&agreement::X25519, peer_public_key) |
| //! }; |
| //! |
| //! agreement::agree_ephemeral( |
| //! my_private_key, |
| //! &peer_public_key, |
| //! ring::error::Unspecified, |
| //! |_key_material| { |
| //! // In a real application, we'd apply a KDF to the key material and the |
| //! // public keys (as recommended in RFC 7748) and then derive session |
| //! // keys from the result. We omit all that here. |
| //! Ok(()) |
| //! }, |
| //! )?; |
| //! |
| //! # Ok::<(), ring::error::Unspecified>(()) |
| //! ``` |
| |
| </span><span class="comment">// The "NSA Guide" steps here are from from section 3.1, "Ephemeral Unified |
| // Model." |
| |
| </span><span class="kw">use crate</span>::{cpu, debug, ec, error, rand}; |
| |
| <span class="kw">pub use </span><span class="kw">crate</span>::ec::{ |
| curve25519::x25519::X25519, |
| suite_b::ecdh::{ECDH_P256, ECDH_P384}, |
| }; |
| |
| <span class="doccomment">/// A key agreement algorithm. |
| </span><span class="kw">pub struct </span>Algorithm { |
| <span class="kw">pub</span>(<span class="kw">crate</span>) curve: <span class="kw-2">&</span><span class="lifetime">'static </span>ec::Curve, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) ecdh: <span class="kw">fn</span>( |
| out: <span class="kw-2">&mut </span>[u8], |
| private_key: <span class="kw-2">&</span>ec::Seed, |
| peer_public_key: untrusted::Input, |
| ) -> <span class="prelude-ty">Result</span><(), error::Unspecified>, |
| } |
| |
| <span class="macro">derive_debug_via_field!</span>(Algorithm, curve); |
| |
| <span class="kw">impl </span>Eq <span class="kw">for </span>Algorithm {} |
| <span class="kw">impl </span>PartialEq <span class="kw">for </span>Algorithm { |
| <span class="kw">fn </span>eq(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span>Algorithm) -> bool { |
| <span class="self">self</span>.curve.id == other.curve.id |
| } |
| } |
| |
| <span class="doccomment">/// An ephemeral private key for use (only) with `agree_ephemeral`. The |
| /// signature of `agree_ephemeral` ensures that an `EphemeralPrivateKey` can be |
| /// used for at most one key agreement. |
| </span><span class="kw">pub struct </span>EphemeralPrivateKey { |
| private_key: ec::Seed, |
| algorithm: <span class="kw-2">&</span><span class="lifetime">'static </span>Algorithm, |
| } |
| |
| <span class="macro">derive_debug_via_field!</span>( |
| EphemeralPrivateKey, |
| <span class="macro">stringify!</span>(EphemeralPrivateKey), |
| algorithm |
| ); |
| |
| <span class="kw">impl </span>EphemeralPrivateKey { |
| <span class="doccomment">/// Generate a new ephemeral private key for the given algorithm. |
| </span><span class="kw">pub fn </span>generate( |
| alg: <span class="kw-2">&</span><span class="lifetime">'static </span>Algorithm, |
| rng: <span class="kw-2">&</span><span class="kw">dyn </span>rand::SecureRandom, |
| ) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, error::Unspecified> { |
| <span class="kw">let </span>cpu_features = cpu::features(); |
| |
| <span class="comment">// NSA Guide Step 1. |
| // |
| // This only handles the key generation part of step 1. The rest of |
| // step one is done by `compute_public_key()`. |
| </span><span class="kw">let </span>private_key = ec::Seed::generate(<span class="kw-2">&</span>alg.curve, rng, cpu_features)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(<span class="self">Self </span>{ |
| private_key, |
| algorithm: alg, |
| }) |
| } |
| |
| <span class="doccomment">/// Computes the public key from the private key. |
| </span><span class="attribute">#[inline(always)] |
| </span><span class="kw">pub fn </span>compute_public_key(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><PublicKey, error::Unspecified> { |
| <span class="comment">// NSA Guide Step 1. |
| // |
| // Obviously, this only handles the part of Step 1 between the private |
| // key generation and the sending of the public key to the peer. `out` |
| // is what should be sent to the peer. |
| </span><span class="self">self</span>.private_key |
| .compute_public_key() |
| .map(|public_key| PublicKey { |
| algorithm: <span class="self">self</span>.algorithm, |
| bytes: public_key, |
| }) |
| } |
| |
| <span class="doccomment">/// The algorithm for the private key. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>algorithm(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="lifetime">'static </span>Algorithm { |
| <span class="self">self</span>.algorithm |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">pub fn </span>bytes(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[u8] { |
| <span class="self">self</span>.private_key.bytes_less_safe() |
| } |
| } |
| |
| <span class="doccomment">/// A public key for key agreement. |
| </span><span class="attribute">#[derive(Clone)] |
| </span><span class="kw">pub struct </span>PublicKey { |
| algorithm: <span class="kw-2">&</span><span class="lifetime">'static </span>Algorithm, |
| bytes: ec::PublicKey, |
| } |
| |
| <span class="kw">impl </span>AsRef<[u8]> <span class="kw">for </span>PublicKey { |
| <span class="kw">fn </span>as_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[u8] { |
| <span class="self">self</span>.bytes.as_ref() |
| } |
| } |
| |
| <span class="kw">impl </span>core::fmt::Debug <span class="kw">for </span>PublicKey { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>core::fmt::Formatter) -> <span class="prelude-ty">Result</span><(), core::fmt::Error> { |
| f.debug_struct(<span class="string">"PublicKey"</span>) |
| .field(<span class="string">"algorithm"</span>, <span class="kw-2">&</span><span class="self">self</span>.algorithm) |
| .field(<span class="string">"bytes"</span>, <span class="kw-2">&</span>debug::HexStr(<span class="self">self</span>.as_ref())) |
| .finish() |
| } |
| } |
| |
| <span class="kw">impl </span>PublicKey { |
| <span class="doccomment">/// The algorithm for the public key. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>algorithm(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="lifetime">'static </span>Algorithm { |
| <span class="self">self</span>.algorithm |
| } |
| } |
| |
| <span class="doccomment">/// An unparsed, possibly malformed, public key for key agreement. |
| </span><span class="kw">pub struct </span>UnparsedPublicKey<B: AsRef<[u8]>> { |
| algorithm: <span class="kw-2">&</span><span class="lifetime">'static </span>Algorithm, |
| bytes: B, |
| } |
| |
| <span class="kw">impl</span><B: Copy> Copy <span class="kw">for </span>UnparsedPublicKey<B> <span class="kw">where </span>B: AsRef<[u8]> {} |
| |
| <span class="kw">impl</span><B: Clone> Clone <span class="kw">for </span>UnparsedPublicKey<B> |
| <span class="kw">where |
| </span>B: AsRef<[u8]>, |
| { |
| <span class="kw">fn </span>clone(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| algorithm: <span class="self">self</span>.algorithm, |
| bytes: <span class="self">self</span>.bytes.clone(), |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><B: core::fmt::Debug> core::fmt::Debug <span class="kw">for </span>UnparsedPublicKey<B> |
| <span class="kw">where |
| </span>B: AsRef<[u8]>, |
| { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>core::fmt::Formatter) -> <span class="prelude-ty">Result</span><(), core::fmt::Error> { |
| f.debug_struct(<span class="string">"UnparsedPublicKey"</span>) |
| .field(<span class="string">"algorithm"</span>, <span class="kw-2">&</span><span class="self">self</span>.algorithm) |
| .field(<span class="string">"bytes"</span>, <span class="kw-2">&</span>debug::HexStr(<span class="self">self</span>.bytes.as_ref())) |
| .finish() |
| } |
| } |
| |
| <span class="kw">impl</span><B: AsRef<[u8]>> UnparsedPublicKey<B> { |
| <span class="doccomment">/// Constructs a new `UnparsedPublicKey`. |
| </span><span class="kw">pub fn </span>new(algorithm: <span class="kw-2">&</span><span class="lifetime">'static </span>Algorithm, bytes: B) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ algorithm, bytes } |
| } |
| |
| <span class="doccomment">/// TODO: doc |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>algorithm(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="lifetime">'static </span>Algorithm { |
| <span class="self">self</span>.algorithm |
| } |
| |
| <span class="doccomment">/// TODO: doc |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>bytes(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>B { |
| <span class="kw-2">&</span><span class="self">self</span>.bytes |
| } |
| } |
| |
| <span class="doccomment">/// Performs a key agreement with an ephemeral private key and the given public |
| /// key. |
| /// |
| /// `my_private_key` is the ephemeral private key to use. Since it is moved, it |
| /// will not be usable after calling `agree_ephemeral`, thus guaranteeing that |
| /// the key is used for only one key agreement. |
| /// |
| /// `peer_public_key` is the peer's public key. `agree_ephemeral` will return |
| /// `Err(error_value)` if it does not match `my_private_key's` algorithm/curve. |
| /// `agree_ephemeral` verifies that it is encoded in the standard form for the |
| /// algorithm and that the key is *valid*; see the algorithm's documentation for |
| /// details on how keys are to be encoded and what constitutes a valid key for |
| /// that algorithm. |
| /// |
| /// `error_value` is the value to return if an error occurs before `kdf` is |
| /// called, e.g. when decoding of the peer's public key fails or when the public |
| /// key is otherwise invalid. |
| /// |
| /// After the key agreement is done, `agree_ephemeral` calls `kdf` with the raw |
| /// key material from the key agreement operation and then returns what `kdf` |
| /// returns. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>agree_ephemeral<B: AsRef<[u8]>, F, R, E>( |
| my_private_key: EphemeralPrivateKey, |
| peer_public_key: <span class="kw-2">&</span>UnparsedPublicKey<B>, |
| error_value: E, |
| kdf: F, |
| ) -> <span class="prelude-ty">Result</span><R, E> |
| <span class="kw">where |
| </span>F: FnOnce(<span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Result</span><R, E>, |
| { |
| <span class="kw">let </span>peer_public_key = UnparsedPublicKey { |
| algorithm: peer_public_key.algorithm, |
| bytes: peer_public_key.bytes.as_ref(), |
| }; |
| agree_ephemeral_(my_private_key, peer_public_key, error_value, kdf) |
| } |
| |
| <span class="kw">fn </span>agree_ephemeral_<F, R, E>( |
| my_private_key: EphemeralPrivateKey, |
| peer_public_key: UnparsedPublicKey<<span class="kw-2">&</span>[u8]>, |
| error_value: E, |
| kdf: F, |
| ) -> <span class="prelude-ty">Result</span><R, E> |
| <span class="kw">where |
| </span>F: FnOnce(<span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Result</span><R, E>, |
| { |
| <span class="comment">// NSA Guide Prerequisite 1. |
| // |
| // The domain parameters are hard-coded. This check verifies that the |
| // peer's public key's domain parameters match the domain parameters of |
| // this private key. |
| </span><span class="kw">if </span>peer_public_key.algorithm != my_private_key.algorithm { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(error_value); |
| } |
| |
| <span class="kw">let </span>alg = <span class="kw-2">&</span>my_private_key.algorithm; |
| |
| <span class="comment">// NSA Guide Prerequisite 2, regarding which KDFs are allowed, is delegated |
| // to the caller. |
| |
| // NSA Guide Prerequisite 3, "Prior to or during the key-agreement process, |
| // each party shall obtain the identifier associated with the other party |
| // during the key-agreement scheme," is delegated to the caller. |
| |
| // NSA Guide Step 1 is handled by `EphemeralPrivateKey::generate()` and |
| // `EphemeralPrivateKey::compute_public_key()`. |
| |
| </span><span class="kw">let </span><span class="kw-2">mut </span>shared_key = [<span class="number">0u8</span>; ec::ELEM_MAX_BYTES]; |
| <span class="kw">let </span>shared_key = <span class="kw-2">&mut </span>shared_key[..alg.curve.elem_scalar_seed_len]; |
| |
| <span class="comment">// NSA Guide Steps 2, 3, and 4. |
| // |
| // We have a pretty liberal interpretation of the NIST's spec's "Destroy" |
| // that doesn't meet the NSA requirement to "zeroize." |
| </span>(alg.ecdh)( |
| shared_key, |
| <span class="kw-2">&</span>my_private_key.private_key, |
| untrusted::Input::from(peer_public_key.bytes), |
| ) |
| .map_err(|<span class="kw">_</span>| error_value)<span class="question-mark">?</span>; |
| |
| <span class="comment">// NSA Guide Steps 5 and 6. |
| // |
| // Again, we have a pretty liberal interpretation of the NIST's spec's |
| // "Destroy" that doesn't meet the NSA requirement to "zeroize." |
| </span>kdf(shared_key) |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="ring" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
