blob: 27228040d2f426dda71c3cffd4a354dc7a7659f9 [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/chacha20_poly1305.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>chacha20_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>
<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>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</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="kw">use super</span>::{
chacha::{<span class="self">self</span>, Counter},
iv::Iv,
poly1305, Aad, Block, Direction, Nonce, Tag, BLOCK_LEN,
};
<span class="kw">use crate</span>::{aead, cpu, endian::<span class="kw-2">*</span>, error, polyfill};
<span class="kw">use </span>core::convert::TryInto;
<span class="doccomment">/// ChaCha20-Poly1305 as described in [RFC 7539].
///
/// The keys are 256 bits long and the nonces are 96 bits long.
///
/// [RFC 7539]: https://tools.ietf.org/html/rfc7539
</span><span class="kw">pub static </span>CHACHA20_POLY1305: aead::Algorithm = aead::Algorithm {
key_len: chacha::KEY_LEN,
init: chacha20_poly1305_init,
seal: chacha20_poly1305_seal,
open: chacha20_poly1305_open,
id: aead::AlgorithmID::CHACHA20_POLY1305,
max_input_len: <span class="kw">super</span>::max_input_len(<span class="number">64</span>, <span class="number">1</span>),
};
<span class="doccomment">/// Copies |key| into |ctx_buf|.
</span><span class="kw">fn </span>chacha20_poly1305_init(
key: <span class="kw-2">&amp;</span>[u8],
_todo: cpu::Features,
) -&gt; <span class="prelude-ty">Result</span>&lt;aead::KeyInner, error::Unspecified&gt; {
<span class="kw">let </span>key: [u8; chacha::KEY_LEN] = key.try_into()<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(aead::KeyInner::ChaCha20Poly1305(chacha::Key::from(key)))
}
<span class="kw">fn </span>chacha20_poly1305_seal(
key: <span class="kw-2">&amp;</span>aead::KeyInner,
nonce: Nonce,
aad: Aad&lt;<span class="kw-2">&amp;</span>[u8]&gt;,
in_out: <span class="kw-2">&amp;mut </span>[u8],
cpu_features: cpu::Features,
) -&gt; Tag {
<span class="kw">let </span>key = <span class="kw">match </span>key {
aead::KeyInner::ChaCha20Poly1305(key) =&gt; key,
<span class="kw">_ </span>=&gt; <span class="macro">unreachable!</span>(),
};
<span class="attribute">#[cfg(target_arch = <span class="string">&quot;x86_64&quot;</span>)]
</span>{
<span class="kw">if </span>cpu::intel::SSE41.available(cpu_features) {
<span class="comment">// XXX: BoringSSL uses `alignas(16)` on `key` instead of on the
// structure, but Rust can&#39;t do that yet; see
// https://github.com/rust-lang/rust/issues/73557.
//
// Keep in sync with the anonymous struct of BoringSSL&#39;s
// `chacha20_poly1305_seal_data`.
</span><span class="attribute">#[repr(align(<span class="number">16</span>), C)]
#[derive(Clone, Copy)]
</span><span class="kw">struct </span>seal_data_in {
key: [u8; chacha::KEY_LEN],
counter: u32,
nonce: [u8; <span class="kw">super</span>::NONCE_LEN],
extra_ciphertext: <span class="kw-2">*const </span>u8,
extra_ciphertext_len: usize,
}
<span class="kw">let </span><span class="kw-2">mut </span>data = InOut {
input: seal_data_in {
key: <span class="kw-2">*</span>key.words_less_safe().as_byte_array(),
counter: <span class="number">0</span>,
nonce: <span class="kw-2">*</span>nonce.as_ref(),
extra_ciphertext: core::ptr::null(),
extra_ciphertext_len: <span class="number">0</span>,
},
};
<span class="comment">// Encrypts `plaintext_len` bytes from `plaintext` and writes them to `out_ciphertext`.
</span><span class="kw">extern </span><span class="string">&quot;C&quot; </span>{
<span class="kw">fn </span>GFp_chacha20_poly1305_seal(
out_ciphertext: <span class="kw-2">*mut </span>u8,
plaintext: <span class="kw-2">*const </span>u8,
plaintext_len: usize,
ad: <span class="kw-2">*const </span>u8,
ad_len: usize,
data: <span class="kw-2">&amp;mut </span>InOut&lt;seal_data_in&gt;,
);
}
<span class="kw">let </span>out = <span class="kw">unsafe </span>{
GFp_chacha20_poly1305_seal(
in_out.as_mut_ptr(),
in_out.as_ptr(),
in_out.len(),
aad.as_ref().as_ptr(),
aad.as_ref().len(),
<span class="kw-2">&amp;mut </span>data,
);
<span class="kw-2">&amp;</span>data.out
};
<span class="kw">return </span>Tag(out.tag);
}
}
aead(key, nonce, aad, in_out, Direction::Sealing, cpu_features)
}
<span class="kw">fn </span>chacha20_poly1305_open(
key: <span class="kw-2">&amp;</span>aead::KeyInner,
nonce: Nonce,
aad: Aad&lt;<span class="kw-2">&amp;</span>[u8]&gt;,
in_prefix_len: usize,
in_out: <span class="kw-2">&amp;mut </span>[u8],
cpu_features: cpu::Features,
) -&gt; Tag {
<span class="kw">let </span>key = <span class="kw">match </span>key {
aead::KeyInner::ChaCha20Poly1305(key) =&gt; key,
<span class="kw">_ </span>=&gt; <span class="macro">unreachable!</span>(),
};
<span class="attribute">#[cfg(target_arch = <span class="string">&quot;x86_64&quot;</span>)]
</span>{
<span class="kw">if </span>cpu::intel::SSE41.available(cpu_features) {
<span class="comment">// XXX: BoringSSL uses `alignas(16)` on `key` instead of on the
// structure, but Rust can&#39;t do that yet; see
// https://github.com/rust-lang/rust/issues/73557.
//
// Keep in sync with the anonymous struct of BoringSSL&#39;s
// `chacha20_poly1305_open_data`.
</span><span class="attribute">#[derive(Copy, Clone)]
#[repr(align(<span class="number">16</span>), C)]
</span><span class="kw">struct </span>open_data_in {
key: [u8; chacha::KEY_LEN],
counter: u32,
nonce: [u8; <span class="kw">super</span>::NONCE_LEN],
}
<span class="kw">let </span><span class="kw-2">mut </span>data = InOut {
input: open_data_in {
key: <span class="kw-2">*</span>key.words_less_safe().as_byte_array(),
counter: <span class="number">0</span>,
nonce: <span class="kw-2">*</span>nonce.as_ref(),
},
};
<span class="comment">// Decrypts `plaintext_len` bytes from `ciphertext` and writes them to `out_plaintext`.
</span><span class="kw">extern </span><span class="string">&quot;C&quot; </span>{
<span class="kw">fn </span>GFp_chacha20_poly1305_open(
out_plaintext: <span class="kw-2">*mut </span>u8,
ciphertext: <span class="kw-2">*const </span>u8,
plaintext_len: usize,
ad: <span class="kw-2">*const </span>u8,
ad_len: usize,
data: <span class="kw-2">&amp;mut </span>InOut&lt;open_data_in&gt;,
);
}
<span class="kw">let </span>out = <span class="kw">unsafe </span>{
GFp_chacha20_poly1305_open(
in_out.as_mut_ptr(),
in_out.as_ptr().add(in_prefix_len),
in_out.len() - in_prefix_len,
aad.as_ref().as_ptr(),
aad.as_ref().len(),
<span class="kw-2">&amp;mut </span>data,
);
<span class="kw-2">&amp;</span>data.out
};
<span class="kw">return </span>Tag(out.tag);
}
}
aead(
key,
nonce,
aad,
in_out,
Direction::Opening { in_prefix_len },
cpu_features,
)
}
<span class="kw">pub type </span>Key = chacha::Key;
<span class="comment">// Keep in sync with BoringSSL&#39;s `chacha20_poly1305_open_data` and
// `chacha20_poly1305_seal_data`.
</span><span class="attribute">#[repr(C)]
#[cfg(target_arch = <span class="string">&quot;x86_64&quot;</span>)]
</span><span class="kw">union </span>InOut&lt;T&gt;
<span class="kw">where
</span>T: Copy,
{
input: T,
out: Out,
}
<span class="comment">// It isn&#39;t obvious whether the assembly code works for tags that aren&#39;t
// 16-byte aligned. In practice it will always be 16-byte aligned because it
// is embedded in a union where the other member of the union is 16-byte
// aligned.
</span><span class="attribute">#[cfg(target_arch = <span class="string">&quot;x86_64&quot;</span>)]
#[derive(Clone, Copy)]
#[repr(align(<span class="number">16</span>), C)]
</span><span class="kw">struct </span>Out {
tag: [u8; <span class="kw">super</span>::TAG_LEN],
}
<span class="attribute">#[inline(always)] </span><span class="comment">// Statically eliminate branches on `direction`.
</span><span class="kw">fn </span>aead(
chacha20_key: <span class="kw-2">&amp;</span>Key,
nonce: Nonce,
Aad(aad): Aad&lt;<span class="kw-2">&amp;</span>[u8]&gt;,
in_out: <span class="kw-2">&amp;mut </span>[u8],
direction: Direction,
cpu_features: cpu::Features,
) -&gt; Tag {
<span class="kw">let </span><span class="kw-2">mut </span>counter = Counter::zero(nonce);
<span class="kw">let </span><span class="kw-2">mut </span>ctx = {
<span class="kw">let </span>key = derive_poly1305_key(chacha20_key, counter.increment(), cpu_features);
poly1305::Context::from_key(key)
};
poly1305_update_padded_16(<span class="kw-2">&amp;mut </span>ctx, aad);
<span class="kw">let </span>in_out_len = <span class="kw">match </span>direction {
Direction::Opening { in_prefix_len } =&gt; {
poly1305_update_padded_16(<span class="kw-2">&amp;mut </span>ctx, <span class="kw-2">&amp;</span>in_out[in_prefix_len..]);
chacha20_key.encrypt_overlapping(counter, in_out, in_prefix_len);
in_out.len() - in_prefix_len
}
Direction::Sealing =&gt; {
chacha20_key.encrypt_in_place(counter, in_out);
poly1305_update_padded_16(<span class="kw-2">&amp;mut </span>ctx, in_out);
in_out.len()
}
};
ctx.update(
Block::from_u64_le(
LittleEndian::from(polyfill::u64_from_usize(aad.len())),
LittleEndian::from(polyfill::u64_from_usize(in_out_len)),
)
.as_ref(),
);
ctx.finish()
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>poly1305_update_padded_16(ctx: <span class="kw-2">&amp;mut </span>poly1305::Context, input: <span class="kw-2">&amp;</span>[u8]) {
<span class="kw">let </span>remainder_len = input.len() % BLOCK_LEN;
<span class="kw">let </span>whole_len = input.len() - remainder_len;
<span class="kw">if </span>whole_len &gt; <span class="number">0 </span>{
ctx.update(<span class="kw-2">&amp;</span>input[..whole_len]);
}
<span class="kw">if </span>remainder_len &gt; <span class="number">0 </span>{
<span class="kw">let </span><span class="kw-2">mut </span>block = Block::zero();
block.overwrite_part_at(<span class="number">0</span>, <span class="kw-2">&amp;</span>input[whole_len..]);
ctx.update(block.as_ref())
}
}
<span class="comment">// Also used by chacha20_poly1305_openssh.
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>derive_poly1305_key(
chacha_key: <span class="kw-2">&amp;</span>chacha::Key,
iv: Iv,
cpu_features: cpu::Features,
) -&gt; poly1305::Key {
<span class="kw">let </span><span class="kw-2">mut </span>key_bytes = [<span class="number">0u8</span>; <span class="number">2 </span>* BLOCK_LEN];
chacha_key.encrypt_iv_xor_blocks_in_place(iv, <span class="kw-2">&amp;mut </span>key_bytes);
poly1305::Key::new(key_bytes, cpu_features)
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="attribute">#[test]
</span><span class="kw">fn </span>max_input_len_test() {
<span class="comment">// Errata 4858 at https://www.rfc-editor.org/errata_search.php?rfc=7539.
</span><span class="macro">assert_eq!</span>(<span class="kw">super</span>::CHACHA20_POLY1305.max_input_len, <span class="number">274_877_906_880u64</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>