blob: f59814ac156e14eaf433f1d297707691b698710a [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/git/checkouts/incubator-teaclave-crates-c8106113f74feefc/ede1f68/ring/src/ec/suite_b/ecdh.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>ecdh.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>
</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 &quot;AS IS&quot; 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">//! ECDH key agreement using the P-256 and P-384 curves.
</span><span class="kw">use super</span>::{ops::<span class="kw-2">*</span>, private_key::<span class="kw-2">*</span>, public_key::<span class="kw-2">*</span>};
<span class="kw">use crate</span>::{agreement, ec, error};
<span class="doccomment">/// A key agreement algorithm.
</span><span class="macro">macro_rules! </span>ecdh {
( <span class="macro-nonterminal">$NAME</span>:ident, <span class="macro-nonterminal">$curve</span>:expr, <span class="macro-nonterminal">$name_str</span>:expr, <span class="macro-nonterminal">$private_key_ops</span>:expr,
<span class="macro-nonterminal">$public_key_ops</span>:expr, <span class="macro-nonterminal">$ecdh</span>:ident ) =&gt; {
<span class="attribute">#[doc = <span class="string">&quot;ECDH using the NSA Suite B&quot;</span>]
#[doc=<span class="macro-nonterminal">$name_str</span>]
#[doc = <span class="string">&quot;curve.&quot;</span>]
</span><span class="doccomment">///
/// Public keys are encoding in uncompressed form using the
/// Octet-String-to-Elliptic-Curve-Point algorithm in
/// [SEC 1: Elliptic Curve Cryptography, Version 2.0]. Public keys are
/// validated during key agreement according to
/// [NIST Special Publication 800-56A, revision 2] and Appendix B.3 of
/// the NSA&#39;s [Suite B Implementer&#39;s Guide to NIST SP 800-56A].
///
/// [SEC 1: Elliptic Curve Cryptography, Version 2.0]:
/// http://www.secg.org/sec1-v2.pdf
/// [NIST Special Publication 800-56A, revision 2]:
/// http://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-56Ar2.pdf
/// [Suite B Implementer&#39;s Guide to NIST SP 800-56A]:
/// https://github.com/briansmith/ring/blob/main/doc/ecdh.pdf
</span><span class="kw">pub static </span><span class="macro-nonterminal">$NAME</span>: agreement::Algorithm = agreement::Algorithm {
curve: <span class="macro-nonterminal">$curve</span>,
ecdh: <span class="macro-nonterminal">$ecdh</span>,
};
<span class="kw">fn </span><span class="macro-nonterminal">$ecdh</span>(
out: <span class="kw-2">&amp;mut </span>[u8],
my_private_key: <span class="kw-2">&amp;</span>ec::Seed,
peer_public_key: untrusted::Input,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), error::Unspecified&gt; {
ecdh(
<span class="macro-nonterminal">$private_key_ops</span>,
<span class="macro-nonterminal">$public_key_ops</span>,
out,
my_private_key,
peer_public_key,
)
}
};
}
<span class="macro">ecdh!</span>(
ECDH_P256,
<span class="kw-2">&amp;</span>ec::suite_b::curve::P256,
<span class="string">&quot;P-256 (secp256r1)&quot;</span>,
<span class="kw-2">&amp;</span>p256::PRIVATE_KEY_OPS,
<span class="kw-2">&amp;</span>p256::PUBLIC_KEY_OPS,
p256_ecdh
);
<span class="macro">ecdh!</span>(
ECDH_P384,
<span class="kw-2">&amp;</span>ec::suite_b::curve::P384,
<span class="string">&quot;P-384 (secp384r1)&quot;</span>,
<span class="kw-2">&amp;</span>p384::PRIVATE_KEY_OPS,
<span class="kw-2">&amp;</span>p384::PUBLIC_KEY_OPS,
p384_ecdh
);
<span class="kw">fn </span>ecdh(
private_key_ops: <span class="kw-2">&amp;</span>PrivateKeyOps,
public_key_ops: <span class="kw-2">&amp;</span>PublicKeyOps,
out: <span class="kw-2">&amp;mut </span>[u8],
my_private_key: <span class="kw-2">&amp;</span>ec::Seed,
peer_public_key: untrusted::Input,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), error::Unspecified&gt; {
<span class="comment">// The NIST SP 800-56Ar2 steps are from section 5.7.1.2 Elliptic Curve
// Cryptography Cofactor Diffie-Hellman (ECC CDH) Primitive.
//
// The &quot;NSA Guide&quot; steps are from section 3.1 of the NSA guide, &quot;Ephemeral
// Unified Model.&quot;
// NSA Guide Step 1 is handled separately.
// NIST SP 800-56Ar2 5.6.2.2.2.
// NSA Guide Step 2.
//
// `parse_uncompressed_point` verifies that the point is not at infinity
// and that it is on the curve, using the Partial Public-Key Validation
// Routine.
</span><span class="kw">let </span>peer_public_key = parse_uncompressed_point(public_key_ops, peer_public_key)<span class="question-mark">?</span>;
<span class="comment">// NIST SP 800-56Ar2 Step 1.
// NSA Guide Step 3 (except point at infinity check).
//
// Note that the cofactor (h) is one since we only support prime-order
// curves, so we can safely ignore the cofactor.
//
// It is impossible for the result to be the point at infinity because our
// private key is in the range [1, n) and the curve has prime order and
// `parse_uncompressed_point` verified that the peer public key is on the
// curve and not at infinity. However, since the standards require the
// check, we do it using `assert!`.
//
// NIST SP 800-56Ar2 defines &quot;Destroy&quot; thusly: &quot;In this Recommendation, to
// destroy is an action applied to a key or a piece of secret data. After
// a key or a piece of secret data is destroyed, no information about its
// value can be recovered.&quot; We interpret &quot;destroy&quot; somewhat liberally: we
// assume that since we throw away the values to be destroyed, no
// information about their values can be recovered. This doesn&#39;t meet the
// NSA guide&#39;s explicit requirement to &quot;zeroize&quot; them though.
// TODO: this only needs common scalar ops
</span><span class="kw">let </span>my_private_key = private_key_as_scalar(private_key_ops, my_private_key);
<span class="kw">let </span>product = private_key_ops.point_mul(<span class="kw-2">&amp;</span>my_private_key, <span class="kw-2">&amp;</span>peer_public_key);
<span class="comment">// NIST SP 800-56Ar2 Steps 2, 3, 4, and 5.
// NSA Guide Steps 3 (point at infinity check) and 4.
//
// Again, we have a pretty liberal interpretation of the NIST&#39;s spec&#39;s
// &quot;Destroy&quot; that doesn&#39;t meet the NSA requirement to &quot;zeroize.&quot;
// `big_endian_affine_from_jacobian` verifies that the result is not at
// infinity and also does an extra check to verify that the point is on
// the curve.
</span>big_endian_affine_from_jacobian(private_key_ops, <span class="prelude-val">Some</span>(out), <span class="prelude-val">None</span>, <span class="kw-2">&amp;</span>product)
<span class="comment">// NSA Guide Step 5 &amp; 6 are deferred to the caller. Again, we have a
// pretty liberal interpretation of the NIST&#39;s spec&#39;s &quot;Destroy&quot; that
// doesn&#39;t meet the NSA requirement to &quot;zeroize.&quot;
</span>}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span><span class="kw">super</span>::<span class="kw">super</span>::ops;
<span class="kw">use crate</span>::{agreement, ec, limb, test};
<span class="kw">static </span>SUPPORTED_SUITE_B_ALGS: [(<span class="kw-2">&amp;</span>str, <span class="kw-2">&amp;</span>agreement::Algorithm, <span class="kw-2">&amp;</span>ec::Curve, <span class="kw-2">&amp;</span>ops::CommonOps); <span class="number">2</span>] = [
(
<span class="string">&quot;P-256&quot;</span>,
<span class="kw-2">&amp;</span>agreement::ECDH_P256,
<span class="kw-2">&amp;</span><span class="kw">super</span>::<span class="kw">super</span>::curve::P256,
<span class="kw-2">&amp;</span><span class="kw">super</span>::<span class="kw">super</span>::ops::p256::COMMON_OPS,
),
(
<span class="string">&quot;P-384&quot;</span>,
<span class="kw-2">&amp;</span>agreement::ECDH_P384,
<span class="kw-2">&amp;</span><span class="kw">super</span>::<span class="kw">super</span>::curve::P384,
<span class="kw-2">&amp;</span><span class="kw">super</span>::<span class="kw">super</span>::ops::p384::COMMON_OPS,
),
];
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_agreement_suite_b_ecdh_generate() {
<span class="comment">// Generates a string of bytes 0x00...00, which will always result in
// a scalar value of zero.
</span><span class="kw">let </span>random_00 = test::rand::FixedByteRandom { byte: <span class="number">0x00 </span>};
<span class="comment">// Generates a string of bytes 0xFF...FF, which will be larger than the
// group order of any curve that is supported.
</span><span class="kw">let </span>random_ff = test::rand::FixedByteRandom { byte: <span class="number">0xff </span>};
<span class="kw">for </span><span class="kw-2">&amp;</span>(<span class="kw">_</span>, alg, curve, ops) <span class="kw">in </span>SUPPORTED_SUITE_B_ALGS.iter() {
<span class="comment">// Test that the private key value zero is rejected and that
// `generate` gives up after a while of only getting zeros.
</span><span class="macro">assert!</span>(agreement::EphemeralPrivateKey::generate(alg, <span class="kw-2">&amp;</span>random_00).is_err());
<span class="comment">// Test that the private key value larger than the group order is
// rejected and that `generate` gives up after a while of only
// getting values larger than the group order.
</span><span class="macro">assert!</span>(agreement::EphemeralPrivateKey::generate(alg, <span class="kw-2">&amp;</span>random_ff).is_err());
<span class="comment">// Test that a private key value exactly equal to the group order
// is rejected and that `generate` gives up after a while of only
// getting that value from the PRNG.
</span><span class="kw">let </span><span class="kw-2">mut </span>n_bytes = [<span class="number">0u8</span>; ec::SCALAR_MAX_BYTES];
<span class="kw">let </span>num_bytes = curve.elem_scalar_seed_len;
limb::big_endian_from_limbs(<span class="kw-2">&amp;</span>ops.n.limbs[..ops.num_limbs], <span class="kw-2">&amp;mut </span>n_bytes[..num_bytes]);
{
<span class="kw">let </span>n_bytes = <span class="kw-2">&amp;mut </span>n_bytes[..num_bytes];
<span class="kw">let </span>rng = test::rand::FixedSliceRandom { bytes: n_bytes };
<span class="macro">assert!</span>(agreement::EphemeralPrivateKey::generate(alg, <span class="kw-2">&amp;</span>rng).is_err());
}
<span class="comment">// Test that a private key value exactly equal to the group order
// minus 1 is accepted.
</span><span class="kw">let </span><span class="kw-2">mut </span>n_minus_1_bytes = n_bytes;
{
<span class="kw">let </span>n_minus_1_bytes = <span class="kw-2">&amp;mut </span>n_minus_1_bytes[..num_bytes];
n_minus_1_bytes[num_bytes - <span class="number">1</span>] -= <span class="number">1</span>;
<span class="kw">let </span>rng = test::rand::FixedSliceRandom {
bytes: n_minus_1_bytes,
};
<span class="kw">let </span>key = agreement::EphemeralPrivateKey::generate(alg, <span class="kw-2">&amp;</span>rng).unwrap();
<span class="macro">assert_eq!</span>(<span class="kw-2">&amp;</span>n_minus_1_bytes[..], key.bytes());
}
<span class="comment">// Test that n + 1 also fails.
</span><span class="kw">let </span><span class="kw-2">mut </span>n_plus_1_bytes = n_bytes;
{
<span class="kw">let </span>n_plus_1_bytes = <span class="kw-2">&amp;mut </span>n_plus_1_bytes[..num_bytes];
n_plus_1_bytes[num_bytes - <span class="number">1</span>] += <span class="number">1</span>;
<span class="kw">let </span>rng = test::rand::FixedSliceRandom {
bytes: n_plus_1_bytes,
};
<span class="macro">assert!</span>(agreement::EphemeralPrivateKey::generate(alg, <span class="kw-2">&amp;</span>rng).is_err());
}
<span class="comment">// Test recovery from initial RNG failure. The first value will be
// n, then n + 1, then zero, the next value will be n - 1, which
// will be accepted.
</span>{
<span class="kw">let </span>bytes = [
<span class="kw-2">&amp;</span>n_bytes[..num_bytes],
<span class="kw-2">&amp;</span>n_plus_1_bytes[..num_bytes],
<span class="kw-2">&amp;</span>[<span class="number">0u8</span>; ec::SCALAR_MAX_BYTES][..num_bytes],
<span class="kw-2">&amp;</span>n_minus_1_bytes[..num_bytes],
];
<span class="kw">let </span>rng = test::rand::FixedSliceSequenceRandom {
bytes: <span class="kw-2">&amp;</span>bytes,
current: core::cell::UnsafeCell::new(<span class="number">0</span>),
};
<span class="kw">let </span>key = agreement::EphemeralPrivateKey::generate(alg, <span class="kw-2">&amp;</span>rng).unwrap();
<span class="macro">assert_eq!</span>(<span class="kw-2">&amp;</span>n_minus_1_bytes[..num_bytes], key.bytes());
}
}
}
}
</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>