blob: 328f34b169678de7296b9903f412efb646a14a5c [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.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>suite_b.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>
</pre><pre class="rust"><code><span class="comment">// Copyright 2016 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">//! Elliptic curve operations on P-256 &amp; P-384.
</span><span class="kw">use </span><span class="self">self</span>::ops::<span class="kw-2">*</span>;
<span class="kw">use crate</span>::{arithmetic::montgomery::<span class="kw-2">*</span>, cpu, ec, error, io::der, limb::LimbMask, pkcs8};
<span class="comment">// NIST SP 800-56A Step 3: &quot;If q is an odd prime p, verify that
// yQ**2 = xQ**3 + axQ + b in GF(p), where the arithmetic is performed modulo
// p.&quot;
//
// That is, verify that (x, y) is on the curve, which is true iif:
//
// y**2 == x**3 + a*x + b (mod q)
//
// Or, equivalently, but more efficiently:
//
// y**2 == (x**2 + a)*x + b (mod q)
//
</span><span class="kw">fn </span>verify_affine_point_is_on_the_curve(
ops: <span class="kw-2">&amp;</span>CommonOps,
(x, y): (<span class="kw-2">&amp;</span>Elem&lt;R&gt;, <span class="kw-2">&amp;</span>Elem&lt;R&gt;),
) -&gt; <span class="prelude-ty">Result</span>&lt;(), error::Unspecified&gt; {
verify_affine_point_is_on_the_curve_scaled(ops, (x, y), <span class="kw-2">&amp;</span>ops.a, <span class="kw-2">&amp;</span>ops.b)
}
<span class="comment">// Use `verify_affine_point_is_on_the_curve` instead of this function whenever
// the affine coordinates are available or will become available. This function
// should only be used then the affine coordinates are never calculated. See
// the notes for `verify_affine_point_is_on_the_curve_scaled`.
//
// The value `z**2` is returned on success because it is useful for ECDSA
// verification.
//
// This function also verifies that the point is not at infinity.
</span><span class="kw">fn </span>verify_jacobian_point_is_on_the_curve(
ops: <span class="kw-2">&amp;</span>CommonOps,
p: <span class="kw-2">&amp;</span>Point,
) -&gt; <span class="prelude-ty">Result</span>&lt;Elem&lt;R&gt;, error::Unspecified&gt; {
<span class="kw">let </span>z = ops.point_z(p);
<span class="comment">// Verify that the point is not at infinity.
</span>ops.elem_verify_is_not_zero(<span class="kw-2">&amp;</span>z)<span class="question-mark">?</span>;
<span class="kw">let </span>x = ops.point_x(p);
<span class="kw">let </span>y = ops.point_y(p);
<span class="comment">// We are given Jacobian coordinates (x, y, z). So, we have:
//
// (x/z**2, y/z**3) == (x&#39;, y&#39;),
//
// where (x&#39;, y&#39;) are the affine coordinates. The curve equation is:
//
// y&#39;**2 == x&#39;**3 + a*x&#39; + b == (x&#39;**2 + a)*x&#39; + b
//
// Substituting our Jacobian coordinates, we get:
//
// / y \**2 / / x \**2 \ / x \
// | ---- | == | | ---- | + a | * | ---- | + b
// \ z**3 / \ \ z**2 / / \ z**2 /
//
// Simplify:
//
// y**2 / x**2 \ x
// ---- == | ---- + a | * ---- + b
// z**6 \ z**4 / z**2
//
// Multiply both sides by z**6:
//
// z**6 / x**2 \ z**6
// ---- * y**2 == | ---- + a | * ---- * x + (z**6) * b
// z**6 \ z**4 / z**2
//
// Simplify:
//
// / x**2 \
// y**2 == | ---- + a | * z**4 * x + (z**6) * b
// \ z**4 /
//
// Distribute z**4:
//
// / z**4 \
// y**2 == | ---- * x**2 + z**4 * a | * x + (z**6) * b
// \ z**4 /
//
// Simplify:
//
// y**2 == (x**2 + z**4 * a) * x + (z**6) * b
//
</span><span class="kw">let </span>z2 = ops.elem_squared(<span class="kw-2">&amp;</span>z);
<span class="kw">let </span>z4 = ops.elem_squared(<span class="kw-2">&amp;</span>z2);
<span class="kw">let </span>z4_a = ops.elem_product(<span class="kw-2">&amp;</span>z4, <span class="kw-2">&amp;</span>ops.a);
<span class="kw">let </span>z6 = ops.elem_product(<span class="kw-2">&amp;</span>z4, <span class="kw-2">&amp;</span>z2);
<span class="kw">let </span>z6_b = ops.elem_product(<span class="kw-2">&amp;</span>z6, <span class="kw-2">&amp;</span>ops.b);
verify_affine_point_is_on_the_curve_scaled(ops, (<span class="kw-2">&amp;</span>x, <span class="kw-2">&amp;</span>y), <span class="kw-2">&amp;</span>z4_a, <span class="kw-2">&amp;</span>z6_b)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(z2)
}
<span class="comment">// Handles the common logic of point-is-on-the-curve checks for both affine and
// Jacobian cases.
//
// When doing the check that the point is on the curve after a computation,
// to avoid fault attacks or mitigate potential bugs, it is better for security
// to use `verify_affine_point_is_on_the_curve` on the affine coordinates,
// because it provides some protection against faults that occur in the
// computation of the inverse of `z`. See the paper and presentation &quot;Fault
// Attacks on Projective-to-Affine Coordinates Conversion&quot; by Diana Maimuţ,
// Cédric Murdica, David Naccache, Mehdi Tibouchi. That presentation concluded
// simply &quot;Check the validity of the result after conversion to affine
// coordinates.&quot; (It seems like a good idea to verify that
// z_inv * z == 1 mod q too).
//
// In the case of affine coordinates (x, y), `a_scaled` and `b_scaled` are
// `a` and `b`, respectively. In the case of Jacobian coordinates (x, y, z),
// the computation and comparison is the same, except `a_scaled` and `b_scaled`
// are (z**4 * a) and (z**6 * b), respectively. Thus, performance is another
// reason to prefer doing the check on the affine coordinates, as Jacobian
// computation requires 3 extra multiplications and 2 extra squarings.
//
// An example of a fault attack that isn&#39;t mitigated by a point-on-the-curve
// check after multiplication is given in &quot;Sign Change Fault Attacks On
// Elliptic Curve Cryptosystems&quot; by Johannes Blömer, Martin Otto, and
// Jean-Pierre Seifert.
</span><span class="kw">fn </span>verify_affine_point_is_on_the_curve_scaled(
ops: <span class="kw-2">&amp;</span>CommonOps,
(x, y): (<span class="kw-2">&amp;</span>Elem&lt;R&gt;, <span class="kw-2">&amp;</span>Elem&lt;R&gt;),
a_scaled: <span class="kw-2">&amp;</span>Elem&lt;R&gt;,
b_scaled: <span class="kw-2">&amp;</span>Elem&lt;R&gt;,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), error::Unspecified&gt; {
<span class="kw">let </span>lhs = ops.elem_squared(y);
<span class="kw">let </span><span class="kw-2">mut </span>rhs = ops.elem_squared(x);
ops.elem_add(<span class="kw-2">&amp;mut </span>rhs, a_scaled);
ops.elem_mul(<span class="kw-2">&amp;mut </span>rhs, x);
ops.elem_add(<span class="kw-2">&amp;mut </span>rhs, b_scaled);
<span class="kw">if </span>ops.elems_are_equal(<span class="kw-2">&amp;</span>lhs, <span class="kw-2">&amp;</span>rhs) != LimbMask::True {
<span class="kw">return </span><span class="prelude-val">Err</span>(error::Unspecified);
}
<span class="prelude-val">Ok</span>(())
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>key_pair_from_pkcs8(
curve: <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>ec::Curve,
template: <span class="kw-2">&amp;</span>pkcs8::Template,
input: untrusted::Input,
cpu_features: cpu::Features,
) -&gt; <span class="prelude-ty">Result</span>&lt;ec::KeyPair, error::KeyRejected&gt; {
<span class="kw">let </span>(ec_private_key, <span class="kw">_</span>) = pkcs8::unwrap_key(template, pkcs8::Version::V1Only, input)<span class="question-mark">?</span>;
<span class="kw">let </span>(private_key, public_key) =
ec_private_key.read_all(error::KeyRejected::invalid_encoding(), |input| {
<span class="comment">// https://tools.ietf.org/html/rfc5915#section-3
</span>der::nested(
input,
der::Tag::Sequence,
error::KeyRejected::invalid_encoding(),
|input| key_pair_from_pkcs8_(template, input),
)
})<span class="question-mark">?</span>;
key_pair_from_bytes(curve, private_key, public_key, cpu_features)
}
<span class="kw">fn </span>key_pair_from_pkcs8_&lt;<span class="lifetime">&#39;a</span>&gt;(
template: <span class="kw-2">&amp;</span>pkcs8::Template,
input: <span class="kw-2">&amp;mut </span>untrusted::Reader&lt;<span class="lifetime">&#39;a</span>&gt;,
) -&gt; <span class="prelude-ty">Result</span>&lt;(untrusted::Input&lt;<span class="lifetime">&#39;a</span>&gt;, untrusted::Input&lt;<span class="lifetime">&#39;a</span>&gt;), error::KeyRejected&gt; {
<span class="kw">let </span>version = der::small_nonnegative_integer(input)
.map_err(|error::Unspecified| error::KeyRejected::invalid_encoding())<span class="question-mark">?</span>;
<span class="kw">if </span>version != <span class="number">1 </span>{
<span class="kw">return </span><span class="prelude-val">Err</span>(error::KeyRejected::version_not_supported());
}
<span class="kw">let </span>private_key = der::expect_tag_and_get_value(input, der::Tag::OctetString)
.map_err(|error::Unspecified| error::KeyRejected::invalid_encoding())<span class="question-mark">?</span>;
<span class="comment">// [0] parameters (optional).
</span><span class="kw">if </span>input.peek(u8::from(der::Tag::ContextSpecificConstructed0)) {
<span class="kw">let </span>actual_alg_id =
der::expect_tag_and_get_value(input, der::Tag::ContextSpecificConstructed0)
.map_err(|error::Unspecified| error::KeyRejected::invalid_encoding())<span class="question-mark">?</span>;
<span class="kw">if </span>actual_alg_id != template.curve_oid() {
<span class="kw">return </span><span class="prelude-val">Err</span>(error::KeyRejected::wrong_algorithm());
}
}
<span class="comment">// [1] publicKey. The RFC says it is optional, but we require it
// to be present.
</span><span class="kw">let </span>public_key = der::nested(
input,
der::Tag::ContextSpecificConstructed1,
error::Unspecified,
der::bit_string_with_no_unused_bits,
)
.map_err(|error::Unspecified| error::KeyRejected::invalid_encoding())<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>((private_key, public_key))
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>key_pair_from_bytes(
curve: <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>ec::Curve,
private_key_bytes: untrusted::Input,
public_key_bytes: untrusted::Input,
cpu_features: cpu::Features,
) -&gt; <span class="prelude-ty">Result</span>&lt;ec::KeyPair, error::KeyRejected&gt; {
<span class="kw">let </span>seed = ec::Seed::from_bytes(curve, private_key_bytes, cpu_features)
.map_err(|error::Unspecified| error::KeyRejected::invalid_component())<span class="question-mark">?</span>;
<span class="kw">let </span>r = ec::KeyPair::derive(seed)
.map_err(|error::Unspecified| error::KeyRejected::unexpected_error())<span class="question-mark">?</span>;
<span class="kw">if </span>public_key_bytes != <span class="kw-2">*</span>r.public_key().as_ref() {
<span class="kw">return </span><span class="prelude-val">Err</span>(error::KeyRejected::inconsistent_components());
}
<span class="prelude-val">Ok</span>(r)
}
<span class="kw">pub mod </span>curve;
<span class="kw">pub mod </span>ecdh;
<span class="kw">pub mod </span>ecdsa;
<span class="kw">mod </span>ops;
<span class="kw">mod </span>private_key;
<span class="kw">mod </span>public_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>