blob: 129dd9aab0b5279ad337f206226dac3d03dd1d8c [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/public_key.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>public_key.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>
</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">//! Functionality shared by operations on public keys (ECDSA verification and
//! ECDH agreement).
</span><span class="kw">use super</span>::{ops::<span class="kw-2">*</span>, verify_affine_point_is_on_the_curve};
<span class="kw">use crate</span>::{arithmetic::montgomery::<span class="kw-2">*</span>, error};
<span class="doccomment">/// Parses a public key encoded in uncompressed form. The key is validated
/// using the ECC Partial Public-Key Validation Routine from
/// [NIST SP 800-56A, revision 2] Section 5.6.2.3.3, the NSA&#39;s
/// &quot;Suite B Implementer&#39;s Guide to NIST SP 800-56A,&quot; Appendix B.3, and the
/// NSA&#39;s &quot;Suite B Implementer&#39;s Guide to FIPS 186-3 (ECDSA),&quot; Appendix A.3.
///
/// [NIST SP 800-56A, revision 2]:
/// http://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-56Ar2.pdf
</span><span class="kw">pub fn </span>parse_uncompressed_point(
ops: <span class="kw-2">&amp;</span>PublicKeyOps,
input: untrusted::Input,
) -&gt; <span class="prelude-ty">Result</span>&lt;(Elem&lt;R&gt;, Elem&lt;R&gt;), error::Unspecified&gt; {
<span class="comment">// NIST SP 800-56A Step 1: &quot;Verify that Q is not the point at infinity.
// This can be done by inspection if the point is entered in the standard
// affine representation.&quot; (We do it by inspection since we only accept
// the affine representation.)
</span><span class="kw">let </span>(x, y) = input.read_all(error::Unspecified, |input| {
<span class="comment">// The encoding must be 4, which is the encoding for &quot;uncompressed&quot;.
</span><span class="kw">let </span>encoding = input.read_byte()<span class="question-mark">?</span>;
<span class="kw">if </span>encoding != <span class="number">4 </span>{
<span class="kw">return </span><span class="prelude-val">Err</span>(error::Unspecified);
}
<span class="comment">// NIST SP 800-56A Step 2: &quot;Verify that xQ and yQ are integers in the
// interval [0, p-1] in the case that q is an odd prime p[.]&quot;
</span><span class="kw">let </span>x = ops.elem_parse(input)<span class="question-mark">?</span>;
<span class="kw">let </span>y = ops.elem_parse(input)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>((x, y))
})<span class="question-mark">?</span>;
<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;
</span>verify_affine_point_is_on_the_curve(ops.common, (<span class="kw-2">&amp;</span>x, <span class="kw-2">&amp;</span>y))<span class="question-mark">?</span>;
<span class="comment">// NIST SP 800-56A Note: &quot;Since its order is not verified, there is no
// check that the public key is in the correct EC subgroup.&quot;
//
// NSA Suite B Implementer&#39;s Guide Note: &quot;ECC Full Public-Key Validation
// includes an additional check to ensure that the point has the correct
// order. This check is not necessary for curves having prime order (and
// cofactor h = 1), such as P-256 and P-384.&quot;
</span><span class="prelude-val">Ok</span>((x, y))
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use super</span>::{<span class="kw">super</span>::ops, <span class="kw-2">*</span>};
<span class="kw">use </span><span class="kw">crate</span>::test;
<span class="attribute">#[test]
</span><span class="kw">fn </span>parse_uncompressed_point_test() {
test::run(
<span class="macro">test_file!</span>(<span class="string">&quot;suite_b_public_key_tests.txt&quot;</span>),
|section, test_case| {
<span class="macro">assert_eq!</span>(section, <span class="string">&quot;&quot;</span>);
<span class="kw">let </span>curve_name = test_case.consume_string(<span class="string">&quot;Curve&quot;</span>);
<span class="kw">let </span>public_key = test_case.consume_bytes(<span class="string">&quot;Q&quot;</span>);
<span class="kw">let </span>public_key = untrusted::Input::from(<span class="kw-2">&amp;</span>public_key);
<span class="kw">let </span>is_valid = test_case.consume_string(<span class="string">&quot;Result&quot;</span>) == <span class="string">&quot;P&quot;</span>;
<span class="kw">let </span>curve_ops = public_key_ops_from_curve_name(<span class="kw-2">&amp;</span>curve_name);
<span class="kw">let </span>result = parse_uncompressed_point(curve_ops, public_key);
<span class="macro">assert_eq!</span>(is_valid, result.is_ok());
<span class="comment">// TODO: Verify that we when we re-serialize the parsed (x, y), the
// output is equal to the input.
</span><span class="prelude-val">Ok</span>(())
},
);
}
<span class="kw">fn </span>public_key_ops_from_curve_name(curve_name: <span class="kw-2">&amp;</span>str) -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>PublicKeyOps {
<span class="kw">if </span>curve_name == <span class="string">&quot;P-256&quot; </span>{
<span class="kw-2">&amp;</span>ops::p256::PUBLIC_KEY_OPS
} <span class="kw">else if </span>curve_name == <span class="string">&quot;P-384&quot; </span>{
<span class="kw-2">&amp;</span>ops::p384::PUBLIC_KEY_OPS
} <span class="kw">else </span>{
<span class="macro">panic!</span>(<span class="string">&quot;Unsupported curve: {}&quot;</span>, curve_name);
}
}
}
</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>