blob: 3f037c72898187d559d3ca4d42e17855b245060d [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/aead/block.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>block.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>
</pre><pre class="rust"><code><span class="comment">// Copyright 2018 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 crate</span>::{endian::<span class="kw-2">*</span>, polyfill};
<span class="doccomment">/// An array of 16 bytes that can (in the x86_64 and AAarch64 ABIs, at least)
/// be efficiently passed by value and returned by value (i.e. in registers),
/// and which meets the alignment requirements of `u32` and `u64` (at least)
/// for the target.
</span><span class="attribute">#[repr(C)]
#[derive(Copy, Clone)]
</span><span class="kw">pub struct </span>Block {
subblocks: [u64; <span class="number">2</span>],
}
<span class="kw">pub const </span>BLOCK_LEN: usize = <span class="number">16</span>;
<span class="kw">impl </span>Block {
<span class="attribute">#[inline]
</span><span class="kw">pub fn </span>zero() -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{ subblocks: [<span class="number">0</span>, <span class="number">0</span>] }
}
<span class="comment">// TODO: Remove this.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>from_u64_le(first: LittleEndian&lt;u64&gt;, second: LittleEndian&lt;u64&gt;) -&gt; <span class="self">Self </span>{
<span class="attribute">#[allow(deprecated)]
</span><span class="self">Self </span>{
subblocks: [first.into_raw_value(), second.into_raw_value()],
}
}
<span class="comment">// TODO: Remove this.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>from_u64_be(first: BigEndian&lt;u64&gt;, second: BigEndian&lt;u64&gt;) -&gt; <span class="self">Self </span>{
<span class="attribute">#[allow(deprecated)]
</span><span class="self">Self </span>{
subblocks: [first.into_raw_value(), second.into_raw_value()],
}
}
<span class="kw">pub fn </span>u64s_be_to_native(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; [u64; <span class="number">2</span>] {
[
u64::from_be(<span class="self">self</span>.subblocks[<span class="number">0</span>]),
u64::from_be(<span class="self">self</span>.subblocks[<span class="number">1</span>]),
]
}
<span class="attribute">#[inline]
</span><span class="kw">pub fn </span>overwrite_part_at(<span class="kw-2">&amp;mut </span><span class="self">self</span>, index: usize, a: <span class="kw-2">&amp;</span>[u8]) {
<span class="kw">let </span><span class="kw-2">mut </span>tmp: [u8; BLOCK_LEN] = <span class="kw-2">*</span><span class="self">self</span>.as_ref();
tmp[index..][..a.len()].copy_from_slice(a);
<span class="kw-2">*</span><span class="self">self </span>= <span class="self">Self</span>::from(<span class="kw-2">&amp;</span>tmp)
}
<span class="attribute">#[inline]
</span><span class="kw">pub fn </span>zero_from(<span class="kw-2">&amp;mut </span><span class="self">self</span>, index: usize) {
<span class="kw">let </span><span class="kw-2">mut </span>tmp: [u8; BLOCK_LEN] = <span class="kw-2">*</span><span class="self">self</span>.as_ref();
polyfill::slice::fill(<span class="kw-2">&amp;mut </span>tmp[index..], <span class="number">0</span>);
<span class="kw-2">*</span><span class="self">self </span>= <span class="self">Self</span>::from(<span class="kw-2">&amp;</span>tmp)
}
<span class="attribute">#[inline]
</span><span class="kw">pub fn </span>bitxor_assign(<span class="kw-2">&amp;mut </span><span class="self">self</span>, a: Block) {
<span class="kw">for </span>(r, a) <span class="kw">in </span><span class="self">self</span>.subblocks.iter_mut().zip(a.subblocks.iter()) {
<span class="kw-2">*</span>r ^= <span class="kw-2">*</span>a;
}
}
}
<span class="kw">impl </span>From&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;_ </span>[u8; BLOCK_LEN]&gt; <span class="kw">for </span>Block {
<span class="attribute">#[inline]
</span><span class="kw">fn </span>from(bytes: <span class="kw-2">&amp;</span>[u8; BLOCK_LEN]) -&gt; <span class="self">Self </span>{
<span class="kw">unsafe </span>{ core::mem::transmute_copy(bytes) }
}
}
<span class="kw">impl </span>AsRef&lt;[u8; BLOCK_LEN]&gt; <span class="kw">for </span>Block {
<span class="attribute">#[allow(clippy::transmute_ptr_to_ptr)]
#[inline]
</span><span class="kw">fn </span>as_ref(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>[u8; BLOCK_LEN] {
<span class="kw">unsafe </span>{ core::mem::transmute(<span class="self">self</span>) }
}
}
<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="attribute">#[test]
</span><span class="kw">fn </span>test_bitxor_assign() {
<span class="kw">const </span>ONES: u64 = -<span class="number">1i64 </span><span class="kw">as </span>u64;
<span class="kw">const </span>TEST_CASES: <span class="kw-2">&amp;</span>[([u64; <span class="number">2</span>], [u64; <span class="number">2</span>], [u64; <span class="number">2</span>])] = <span class="kw-2">&amp;</span>[
([<span class="number">0</span>, <span class="number">0</span>], [<span class="number">0</span>, <span class="number">0</span>], [<span class="number">0</span>, <span class="number">0</span>]),
([<span class="number">0</span>, <span class="number">0</span>], [ONES, ONES], [ONES, ONES]),
([<span class="number">0</span>, ONES], [ONES, <span class="number">0</span>], [ONES, ONES]),
([ONES, <span class="number">0</span>], [<span class="number">0</span>, ONES], [ONES, ONES]),
([ONES, ONES], [ONES, ONES], [<span class="number">0</span>, <span class="number">0</span>]),
];
<span class="kw">for </span>(expected_result, a, b) <span class="kw">in </span>TEST_CASES {
<span class="kw">let </span><span class="kw-2">mut </span>r = Block::from_u64_le(a[<span class="number">0</span>].into(), a[<span class="number">1</span>].into());
r.bitxor_assign(Block::from_u64_le(b[<span class="number">0</span>].into(), b[<span class="number">1</span>].into()));
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span>expected_result, r.subblocks);
<span class="comment">// XOR is symmetric.
</span><span class="kw">let </span><span class="kw-2">mut </span>r = Block::from_u64_le(b[<span class="number">0</span>].into(), b[<span class="number">1</span>].into());
r.bitxor_assign(Block::from_u64_le(a[<span class="number">0</span>].into(), a[<span class="number">1</span>].into()));
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span>expected_result, r.subblocks);
}
}
}
</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>