blob: 47625b4a4468a07923e11ebfd21ab99f19c6c110 [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/ecdsa/digest_scalar.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>digest_scalar.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>
</pre><pre class="rust"><code><span class="comment">// Copyright 2015-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">//! ECDSA Signatures using the P-256 and P-384 curves.
</span><span class="kw">use crate</span>::{
digest,
ec::suite_b::ops::<span class="kw-2">*</span>,
limb::{<span class="self">self</span>, LIMB_BYTES},
};
<span class="doccomment">/// Calculate the digest of `msg` using the digest algorithm `digest_alg`. Then
/// convert the digest to a scalar in the range [0, n) as described in
/// NIST&#39;s FIPS 186-4 Section 4.2. Note that this is one of the few cases where
/// a `Scalar` is allowed to have the value zero.
///
/// NIST&#39;s FIPS 186-4 4.2 says &quot;When the length of the output of the hash
/// function is greater than N (i.e., the bit length of q), then the leftmost N
/// bits of the hash function output block shall be used in any calculation
/// using the hash function output during the generation or verification of a
/// digital signature.&quot;
///
/// &quot;Leftmost N bits&quot; means &quot;N most significant bits&quot; because we interpret the
/// digest as a bit-endian encoded integer.
///
/// The NSA guide instead vaguely suggests that we should convert the digest
/// value to an integer and then reduce it mod `n`. However, real-world
/// implementations (e.g. `digest_to_bn` in OpenSSL and `hashToInt` in Go) do
/// what FIPS 186-4 says to do, not what the NSA guide suggests.
///
/// Why shifting the value right by at most one bit is sufficient: P-256&#39;s `n`
/// has its 256th bit set; i.e. 2**255 &lt; n &lt; 2**256. Once we&#39;ve truncated the
/// digest to 256 bits and converted it to an integer, it will have a value
/// less than 2**256. If the value is larger than `n` then shifting it one bit
/// right will give a value less than 2**255, which is less than `n`. The
/// analogous argument applies for P-384. However, it does *not* apply in
/// general; for example, it doesn&#39;t apply to P-521.
</span><span class="kw">pub fn </span>digest_scalar(ops: <span class="kw-2">&amp;</span>ScalarOps, msg: digest::Digest) -&gt; Scalar {
digest_scalar_(ops, msg.as_ref())
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>digest_bytes_scalar(ops: <span class="kw-2">&amp;</span>ScalarOps, digest: <span class="kw-2">&amp;</span>[u8]) -&gt; Scalar {
digest_scalar_(ops, digest)
}
<span class="comment">// This is a separate function solely so that we can test specific digest
// values like all-zero values and values larger than `n`.
</span><span class="kw">fn </span>digest_scalar_(ops: <span class="kw-2">&amp;</span>ScalarOps, digest: <span class="kw-2">&amp;</span>[u8]) -&gt; Scalar {
<span class="kw">let </span>cops = ops.common;
<span class="kw">let </span>num_limbs = cops.num_limbs;
<span class="kw">let </span>digest = <span class="kw">if </span>digest.len() &gt; num_limbs * LIMB_BYTES {
<span class="kw-2">&amp;</span>digest[..(num_limbs * LIMB_BYTES)]
} <span class="kw">else </span>{
digest
};
scalar_parse_big_endian_partially_reduced_variable_consttime(
cops,
limb::AllowZero::Yes,
untrusted::Input::from(digest),
)
.unwrap()
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span><span class="kw">super</span>::digest_bytes_scalar;
<span class="kw">use crate</span>::{
digest,
ec::suite_b::ops::<span class="kw-2">*</span>,
limb::{<span class="self">self</span>, LIMB_BYTES},
test,
};
<span class="attribute">#[test]
</span><span class="kw">fn </span>test() {
test::run(
<span class="macro">test_file!</span>(<span class="string">&quot;ecdsa_digest_scalar_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>digest_name = test_case.consume_string(<span class="string">&quot;Digest&quot;</span>);
<span class="kw">let </span>input = test_case.consume_bytes(<span class="string">&quot;Input&quot;</span>);
<span class="kw">let </span>output = test_case.consume_bytes(<span class="string">&quot;Output&quot;</span>);
<span class="kw">let </span>(ops, digest_alg) = <span class="kw">match </span>(curve_name.as_str(), digest_name.as_str()) {
(<span class="string">&quot;P-256&quot;</span>, <span class="string">&quot;SHA256&quot;</span>) =&gt; (<span class="kw-2">&amp;</span>p256::PUBLIC_SCALAR_OPS, <span class="kw-2">&amp;</span>digest::SHA256),
(<span class="string">&quot;P-256&quot;</span>, <span class="string">&quot;SHA384&quot;</span>) =&gt; (<span class="kw-2">&amp;</span>p256::PUBLIC_SCALAR_OPS, <span class="kw-2">&amp;</span>digest::SHA384),
(<span class="string">&quot;P-384&quot;</span>, <span class="string">&quot;SHA256&quot;</span>) =&gt; (<span class="kw-2">&amp;</span>p384::PUBLIC_SCALAR_OPS, <span class="kw-2">&amp;</span>digest::SHA256),
(<span class="string">&quot;P-384&quot;</span>, <span class="string">&quot;SHA384&quot;</span>) =&gt; (<span class="kw-2">&amp;</span>p384::PUBLIC_SCALAR_OPS, <span class="kw-2">&amp;</span>digest::SHA384),
<span class="kw">_ </span>=&gt; {
<span class="macro">panic!</span>(<span class="string">&quot;Unsupported curve+digest: {}+{}&quot;</span>, curve_name, digest_name);
}
};
<span class="kw">let </span>num_limbs = ops.public_key_ops.common.num_limbs;
<span class="macro">assert_eq!</span>(input.len(), digest_alg.output_len);
<span class="macro">assert_eq!</span>(
output.len(),
ops.public_key_ops.common.num_limbs * LIMB_BYTES
);
<span class="kw">let </span>expected = scalar_parse_big_endian_variable(
ops.public_key_ops.common,
limb::AllowZero::Yes,
untrusted::Input::from(<span class="kw-2">&amp;</span>output),
)
.unwrap();
<span class="kw">let </span>actual = digest_bytes_scalar(ops.scalar_ops, <span class="kw-2">&amp;</span>input);
<span class="macro">assert_eq!</span>(actual.limbs[..num_limbs], expected.limbs[..num_limbs]);
<span class="prelude-val">Ok</span>(())
},
);
}
}
</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>