| <!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/aead/chacha.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>chacha.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> |
| </pre><pre class="rust"><code><span class="comment">// Copyright 2016 Brian Smith. |
| // Portions Copyright (c) 2016, 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 "AS IS" 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>::{counter, iv::Iv, quic::Sample, BLOCK_LEN}; |
| <span class="kw">use crate</span>::{c, endian::<span class="kw-2">*</span>}; |
| |
| <span class="attribute">#[repr(transparent)] |
| </span><span class="kw">pub struct </span>Key([LittleEndian<u32>; KEY_LEN / <span class="number">4</span>]); |
| |
| <span class="kw">impl </span>From<[u8; KEY_LEN]> <span class="kw">for </span>Key { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>from(value: [u8; KEY_LEN]) -> <span class="self">Self </span>{ |
| <span class="self">Self</span>(FromByteArray::from_byte_array(<span class="kw-2">&</span>value)) |
| } |
| } |
| |
| <span class="kw">impl </span>Key { |
| <span class="attribute">#[inline] </span><span class="comment">// Optimize away match on `counter`. |
| </span><span class="kw">pub fn </span>encrypt_in_place(<span class="kw-2">&</span><span class="self">self</span>, counter: Counter, in_out: <span class="kw-2">&mut </span>[u8]) { |
| <span class="kw">unsafe </span>{ |
| <span class="self">self</span>.encrypt( |
| CounterOrIv::Counter(counter), |
| in_out.as_ptr(), |
| in_out.len(), |
| in_out.as_mut_ptr(), |
| ); |
| } |
| } |
| |
| <span class="attribute">#[inline] </span><span class="comment">// Optimize away match on `iv` and length check. |
| </span><span class="kw">pub fn </span>encrypt_iv_xor_blocks_in_place(<span class="kw-2">&</span><span class="self">self</span>, iv: Iv, in_out: <span class="kw-2">&mut </span>[u8; <span class="number">2 </span>* BLOCK_LEN]) { |
| <span class="kw">unsafe </span>{ |
| <span class="self">self</span>.encrypt( |
| CounterOrIv::Iv(iv), |
| in_out.as_ptr(), |
| in_out.len(), |
| in_out.as_mut_ptr(), |
| ); |
| } |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>new_mask(<span class="kw-2">&</span><span class="self">self</span>, sample: Sample) -> [u8; <span class="number">5</span>] { |
| <span class="kw">let </span><span class="kw-2">mut </span>out: [u8; <span class="number">5</span>] = [<span class="number">0</span>; <span class="number">5</span>]; |
| <span class="kw">let </span>iv = Iv::assume_unique_for_key(sample); |
| |
| <span class="kw">unsafe </span>{ |
| <span class="self">self</span>.encrypt( |
| CounterOrIv::Iv(iv), |
| out.as_ptr(), |
| out.len(), |
| out.as_mut_ptr(), |
| ); |
| } |
| |
| out |
| } |
| |
| <span class="kw">pub fn </span>encrypt_overlapping(<span class="kw-2">&</span><span class="self">self</span>, counter: Counter, in_out: <span class="kw-2">&mut </span>[u8], in_prefix_len: usize) { |
| <span class="comment">// XXX: The x86 and at least one branch of the ARM assembly language |
| // code doesn't allow overlapping input and output unless they are |
| // exactly overlapping. TODO: Figure out which branch of the ARM code |
| // has this limitation and come up with a better solution. |
| // |
| // https://rt.openssl.org/Ticket/Display.html?id=4362 |
| </span><span class="kw">let </span>len = in_out.len() - in_prefix_len; |
| <span class="kw">if </span><span class="macro">cfg!</span>(any(target_arch = <span class="string">"arm"</span>, target_arch = <span class="string">"x86"</span>)) && in_prefix_len != <span class="number">0 </span>{ |
| in_out.copy_within(in_prefix_len.., <span class="number">0</span>); |
| <span class="self">self</span>.encrypt_in_place(counter, <span class="kw-2">&mut </span>in_out[..len]); |
| } <span class="kw">else </span>{ |
| <span class="kw">unsafe </span>{ |
| <span class="self">self</span>.encrypt( |
| CounterOrIv::Counter(counter), |
| in_out[in_prefix_len..].as_ptr(), |
| len, |
| in_out.as_mut_ptr(), |
| ); |
| } |
| } |
| } |
| |
| <span class="attribute">#[inline] </span><span class="comment">// Optimize away match on `counter.` |
| </span><span class="kw">unsafe fn </span>encrypt( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| counter: CounterOrIv, |
| input: <span class="kw-2">*const </span>u8, |
| in_out_len: usize, |
| output: <span class="kw-2">*mut </span>u8, |
| ) { |
| <span class="kw">let </span>iv = <span class="kw">match </span>counter { |
| CounterOrIv::Counter(counter) => counter.into(), |
| CounterOrIv::Iv(iv) => { |
| <span class="macro">assert!</span>(in_out_len <= <span class="number">32</span>); |
| iv |
| } |
| }; |
| |
| <span class="comment">// XXX: Although this takes an `Iv`, this actually uses it like a |
| // `Counter`. |
| </span><span class="kw">extern </span><span class="string">"C" </span>{ |
| <span class="kw">fn </span>GFp_ChaCha20_ctr32( |
| out: <span class="kw-2">*mut </span>u8, |
| in_: <span class="kw-2">*const </span>u8, |
| in_len: c::size_t, |
| key: <span class="kw-2">&</span>Key, |
| first_iv: <span class="kw-2">&</span>Iv, |
| ); |
| } |
| |
| GFp_ChaCha20_ctr32(output, input, in_out_len, <span class="self">self</span>, <span class="kw-2">&</span>iv); |
| } |
| |
| <span class="attribute">#[cfg(target_arch = <span class="string">"x86_64"</span>)] |
| #[inline] |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>words_less_safe(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[LittleEndian<u32>; KEY_LEN / <span class="number">4</span>] { |
| <span class="kw-2">&</span><span class="self">self</span>.<span class="number">0 |
| </span>} |
| } |
| |
| <span class="kw">pub type </span>Counter = counter::Counter<LittleEndian<u32>>; |
| |
| <span class="kw">enum </span>CounterOrIv { |
| Counter(Counter), |
| Iv(Iv), |
| } |
| |
| <span class="kw">const </span>KEY_BLOCKS: usize = <span class="number">2</span>; |
| <span class="kw">pub const </span>KEY_LEN: usize = KEY_BLOCKS * BLOCK_LEN; |
| |
| <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>alloc::vec; |
| <span class="kw">use </span>core::convert::TryInto; |
| |
| <span class="comment">// This verifies the encryption functionality provided by ChaCha20_ctr32 |
| // is successful when either computed on disjoint input/output buffers, |
| // or on overlapping input/output buffers. On some branches of the 32-bit |
| // x86 and ARM code the in-place operation fails in some situations where |
| // the input/output buffers are not exactly overlapping. Such failures are |
| // dependent not only on the degree of overlapping but also the length of |
| // the data. `open()` works around that by moving the input data to the |
| // output location so that the buffers exactly overlap, for those targets. |
| // This test exists largely as a canary for detecting if/when that type of |
| // problem spreads to other platforms. |
| </span><span class="attribute">#[test] |
| </span><span class="kw">pub fn </span>chacha20_tests() { |
| test::run(<span class="macro">test_file!</span>(<span class="string">"chacha_tests.txt"</span>), |section, test_case| { |
| <span class="macro">assert_eq!</span>(section, <span class="string">""</span>); |
| |
| <span class="kw">let </span>key = test_case.consume_bytes(<span class="string">"Key"</span>); |
| <span class="kw">let </span>key: <span class="kw-2">&</span>[u8; KEY_LEN] = key.as_slice().try_into()<span class="question-mark">?</span>; |
| <span class="kw">let </span>key = Key::from(<span class="kw-2">*</span>key); |
| |
| <span class="kw">let </span>ctr = test_case.consume_usize(<span class="string">"Ctr"</span>); |
| <span class="kw">let </span>nonce = test_case.consume_bytes(<span class="string">"Nonce"</span>); |
| <span class="kw">let </span>input = test_case.consume_bytes(<span class="string">"Input"</span>); |
| <span class="kw">let </span>output = test_case.consume_bytes(<span class="string">"Output"</span>); |
| |
| <span class="comment">// Pre-allocate buffer for use in test_cases. |
| </span><span class="kw">let </span><span class="kw-2">mut </span>in_out_buf = <span class="macro">vec!</span>[<span class="number">0u8</span>; input.len() + <span class="number">276</span>]; |
| |
| <span class="comment">// Run the test case over all prefixes of the input because the |
| // behavior of ChaCha20 implementation changes dependent on the |
| // length of the input. |
| </span><span class="kw">for </span>len <span class="kw">in </span><span class="number">0</span>..(input.len() + <span class="number">1</span>) { |
| chacha20_test_case_inner( |
| <span class="kw-2">&</span>key, |
| <span class="kw-2">&</span>nonce, |
| ctr <span class="kw">as </span>u32, |
| <span class="kw-2">&</span>input[..len], |
| <span class="kw-2">&</span>output[..len], |
| len, |
| <span class="kw-2">&mut </span>in_out_buf, |
| ); |
| } |
| |
| <span class="prelude-val">Ok</span>(()) |
| }); |
| } |
| |
| <span class="kw">fn </span>chacha20_test_case_inner( |
| key: <span class="kw-2">&</span>Key, |
| nonce: <span class="kw-2">&</span>[u8], |
| ctr: u32, |
| input: <span class="kw-2">&</span>[u8], |
| expected: <span class="kw-2">&</span>[u8], |
| len: usize, |
| in_out_buf: <span class="kw-2">&mut </span>[u8], |
| ) { |
| <span class="comment">// Straightforward encryption into disjoint buffers is computed |
| // correctly. |
| </span><span class="kw">unsafe </span>{ |
| key.encrypt( |
| CounterOrIv::Counter(Counter::from_test_vector(nonce, ctr)), |
| input[..len].as_ptr(), |
| len, |
| in_out_buf.as_mut_ptr(), |
| ); |
| } |
| <span class="macro">assert_eq!</span>(<span class="kw-2">&</span>in_out_buf[..len], expected); |
| |
| <span class="comment">// Do not test offset buffers for x86 and ARM architectures (see above |
| // for rationale). |
| </span><span class="kw">let </span>max_offset = <span class="kw">if </span><span class="macro">cfg!</span>(any(target_arch = <span class="string">"x86"</span>, target_arch = <span class="string">"arm"</span>)) { |
| <span class="number">0 |
| </span>} <span class="kw">else </span>{ |
| <span class="number">259 |
| </span>}; |
| |
| <span class="comment">// Check that in-place encryption works successfully when the pointers |
| // to the input/output buffers are (partially) overlapping. |
| </span><span class="kw">for </span>alignment <span class="kw">in </span><span class="number">0</span>..<span class="number">16 </span>{ |
| <span class="kw">for </span>offset <span class="kw">in </span><span class="number">0</span>..(max_offset + <span class="number">1</span>) { |
| in_out_buf[alignment + offset..][..len].copy_from_slice(input); |
| <span class="kw">let </span>ctr = Counter::from_test_vector(nonce, ctr); |
| key.encrypt_overlapping(ctr, <span class="kw-2">&mut </span>in_out_buf[alignment..], offset); |
| <span class="macro">assert_eq!</span>(<span class="kw-2">&</span>in_out_buf[alignment..][..len], expected); |
| } |
| } |
| } |
| } |
| </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> |
