Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-app / src / ring / aead / poly1305.rs.html
blob: 343637cef3ba933e917a8d544f31e47dd77eb61c [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/registry/src/github.com-1ecc6299db9ec823/ring-0.16.20/src/aead/poly1305.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>poly1305.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>
</pre><pre class="rust"><code><span class="comment">// Copyright 2015-2016 Brian Smith.
// Portions Copyright (c) 2014, 2015, Google Inc.
//
// 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.
// TODO: enforce maximum input length.
</span><span class="kw">use super</span>::{block::BLOCK_LEN, Tag, TAG_LEN};
<span class="kw">use crate</span>::{c, cpu};
<span class="doccomment">/// A Poly1305 key.
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">struct </span>Key {
key_and_nonce: [u8; KEY_LEN],
cpu_features: cpu::Features,
}
<span class="kw">const </span>KEY_LEN: usize = <span class="number">2 </span>* BLOCK_LEN;
<span class="kw">impl </span>Key {
<span class="attribute">#[inline]
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>new(key_and_nonce: [u8; KEY_LEN], cpu_features: cpu::Features) -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{
key_and_nonce,
cpu_features,
}
}
}
<span class="kw">pub struct </span>Context {
state: poly1305_state,
<span class="attribute">#[allow(dead_code)]
</span>cpu_features: cpu::Features,
}
<span class="comment">// Keep in sync with `poly1305_state` in GFp/poly1305.h.
//
// The C code, in particular the way the `poly1305_aligned_state` functions
// are used, is only correct when the state buffer is 64-byte aligned.
</span><span class="attribute">#[repr(C, align(<span class="number">64</span>))]
</span><span class="kw">struct </span>poly1305_state([u8; OPAQUE_LEN]);
<span class="kw">const </span>OPAQUE_LEN: usize = <span class="number">512</span>;
<span class="comment">// Abstracts the dispatching logic that chooses the NEON implementation if and
// only if it would work.
</span><span class="macro">macro_rules! </span>dispatch {
( <span class="macro-nonterminal">$features</span>:expr =&gt;
( <span class="macro-nonterminal">$f</span>:ident | <span class="macro-nonterminal">$neon_f</span>:ident )
( $( <span class="macro-nonterminal">$p</span>:ident : <span class="macro-nonterminal">$t</span>:ty ),+ )
( $( <span class="macro-nonterminal">$a</span>:expr ),+ ) ) =&gt; {
<span class="kw">match </span>() {
<span class="comment">// Apple&#39;s 32-bit ARM ABI is incompatible with the assembly code.
</span><span class="attribute">#[cfg(all(target_arch = <span class="string">&quot;arm&quot;</span>, not(target_vendor = <span class="string">&quot;apple&quot;</span>)))]
</span>() <span class="kw">if </span>cpu::arm::NEON.available(<span class="macro-nonterminal">$features</span>) =&gt; {
<span class="kw">extern </span><span class="string">&quot;C&quot; </span>{
<span class="kw">fn </span><span class="macro-nonterminal">$neon_f</span>( $( <span class="macro-nonterminal">$p </span>: <span class="macro-nonterminal">$t </span>),+ );
}
<span class="kw">unsafe </span>{ <span class="macro-nonterminal">$neon_f</span>( $( <span class="macro-nonterminal">$a </span>),+ ) }
}
() =&gt; {
<span class="kw">extern </span><span class="string">&quot;C&quot; </span>{
<span class="kw">fn </span><span class="macro-nonterminal">$f</span>( $( <span class="macro-nonterminal">$p </span>: <span class="macro-nonterminal">$t </span>),+ );
}
<span class="kw">unsafe </span>{ <span class="macro-nonterminal">$f</span>( $( <span class="macro-nonterminal">$a </span>),+ ) }
}
}
}
}
<span class="kw">impl </span>Context {
<span class="attribute">#[inline]
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>from_key(
Key {
key_and_nonce,
cpu_features,
}: Key,
) -&gt; <span class="self">Self </span>{
<span class="kw">let </span><span class="kw-2">mut </span>ctx = <span class="self">Self </span>{
state: poly1305_state([<span class="number">0u8</span>; OPAQUE_LEN]),
cpu_features,
};
<span class="macro">dispatch!</span>(
cpu_features =&gt;
(GFp_poly1305_init | GFp_poly1305_init_neon)
(statep: <span class="kw-2">&amp;mut </span>poly1305_state, key: <span class="kw-2">&amp;</span>[u8; KEY_LEN])
(<span class="kw-2">&amp;mut </span>ctx.state, <span class="kw-2">&amp;</span>key_and_nonce));
ctx
}
<span class="attribute">#[inline(always)]
</span><span class="kw">pub fn </span>update(<span class="kw-2">&amp;mut </span><span class="self">self</span>, input: <span class="kw-2">&amp;</span>[u8]) {
<span class="macro">dispatch!</span>(
<span class="self">self</span>.cpu_features =&gt;
(GFp_poly1305_update | GFp_poly1305_update_neon)
(statep: <span class="kw-2">&amp;mut </span>poly1305_state, input: <span class="kw-2">*const </span>u8, in_len: c::size_t)
(<span class="kw-2">&amp;mut </span><span class="self">self</span>.state, input.as_ptr(), input.len()));
}
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>finish(<span class="kw-2">mut </span><span class="self">self</span>) -&gt; Tag {
<span class="kw">let </span><span class="kw-2">mut </span>tag = Tag([<span class="number">0u8</span>; TAG_LEN]);
<span class="macro">dispatch!</span>(
<span class="self">self</span>.cpu_features =&gt;
(GFp_poly1305_finish | GFp_poly1305_finish_neon)
(statep: <span class="kw-2">&amp;mut </span>poly1305_state, mac: <span class="kw-2">&amp;mut </span>[u8; TAG_LEN])
(<span class="kw-2">&amp;mut </span><span class="self">self</span>.state, <span class="kw-2">&amp;mut </span>tag.<span class="number">0</span>));
tag
}
}
<span class="doccomment">/// Implements the original, non-IETF padding semantics.
///
/// This is used by chacha20_poly1305_openssh and the standalone
/// poly1305 test vectors.
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>sign(key: Key, input: <span class="kw-2">&amp;</span>[u8]) -&gt; Tag {
<span class="kw">let </span><span class="kw-2">mut </span>ctx = Context::from_key(key);
ctx.update(input);
ctx.finish()
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="kw">use </span><span class="kw">crate</span>::test;
<span class="kw">use </span>core::convert::TryInto;
<span class="comment">// Adapted from BoringSSL&#39;s crypto/poly1305/poly1305_test.cc.
</span><span class="attribute">#[test]
</span><span class="kw">pub fn </span>test_poly1305() {
<span class="kw">let </span>cpu_features = cpu::features();
test::run(<span class="macro">test_file!</span>(<span class="string">&quot;poly1305_test.txt&quot;</span>), |section, test_case| {
<span class="macro">assert_eq!</span>(section, <span class="string">&quot;&quot;</span>);
<span class="kw">let </span>key = test_case.consume_bytes(<span class="string">&quot;Key&quot;</span>);
<span class="kw">let </span>key: <span class="kw-2">&amp;</span>[u8; BLOCK_LEN * <span class="number">2</span>] = key.as_slice().try_into().unwrap();
<span class="kw">let </span>input = test_case.consume_bytes(<span class="string">&quot;Input&quot;</span>);
<span class="kw">let </span>expected_mac = test_case.consume_bytes(<span class="string">&quot;MAC&quot;</span>);
<span class="kw">let </span>key = Key::new(<span class="kw-2">*</span>key, cpu_features);
<span class="kw">let </span>Tag(actual_mac) = sign(key, <span class="kw-2">&amp;</span>input);
<span class="macro">assert_eq!</span>(expected_mac, actual_mac.as_ref());
<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>