| <!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/quic.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>quic.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> |
| </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 "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="doccomment">//! QUIC Header Protection. |
| //! |
| //! See draft-ietf-quic-tls. |
| |
| </span><span class="kw">use crate</span>::{ |
| aead::{aes, chacha}, |
| cpu, error, hkdf, |
| }; |
| <span class="kw">use </span>core::convert::{TryFrom, TryInto}; |
| |
| <span class="doccomment">/// A key for generating QUIC Header Protection masks. |
| </span><span class="kw">pub struct </span>HeaderProtectionKey { |
| inner: KeyInner, |
| algorithm: <span class="kw-2">&</span><span class="lifetime">'static </span>Algorithm, |
| } |
| |
| <span class="attribute">#[allow(clippy::large_enum_variant, variant_size_differences)] |
| </span><span class="kw">enum </span>KeyInner { |
| Aes(aes::Key), |
| ChaCha20(chacha::Key), |
| } |
| |
| <span class="kw">impl </span>From<hkdf::Okm<<span class="lifetime">'_</span>, <span class="kw-2">&</span><span class="lifetime">'static </span>Algorithm>> <span class="kw">for </span>HeaderProtectionKey { |
| <span class="kw">fn </span>from(okm: hkdf::Okm<<span class="kw-2">&</span><span class="lifetime">'static </span>Algorithm>) -> <span class="self">Self </span>{ |
| <span class="kw">let </span><span class="kw-2">mut </span>key_bytes = [<span class="number">0</span>; <span class="kw">super</span>::MAX_KEY_LEN]; |
| <span class="kw">let </span>algorithm = <span class="kw-2">*</span>okm.len(); |
| <span class="kw">let </span>key_bytes = <span class="kw-2">&mut </span>key_bytes[..algorithm.key_len()]; |
| okm.fill(key_bytes).unwrap(); |
| <span class="self">Self</span>::new(algorithm, key_bytes).unwrap() |
| } |
| } |
| |
| <span class="kw">impl </span>HeaderProtectionKey { |
| <span class="doccomment">/// Create a new header protection key. |
| /// |
| /// `key_bytes` must be exactly `algorithm.key_len` bytes long. |
| </span><span class="kw">pub fn </span>new( |
| algorithm: <span class="kw-2">&</span><span class="lifetime">'static </span>Algorithm, |
| key_bytes: <span class="kw-2">&</span>[u8], |
| ) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, error::Unspecified> { |
| <span class="prelude-val">Ok</span>(<span class="self">Self </span>{ |
| inner: (algorithm.init)(key_bytes, cpu::features())<span class="question-mark">?</span>, |
| algorithm, |
| }) |
| } |
| |
| <span class="doccomment">/// Generate a new QUIC Header Protection mask. |
| /// |
| /// `sample` must be exactly `self.algorithm().sample_len()` bytes long. |
| </span><span class="kw">pub fn </span>new_mask(<span class="kw-2">&</span><span class="self">self</span>, sample: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Result</span><[u8; <span class="number">5</span>], error::Unspecified> { |
| <span class="kw">let </span>sample = <<span class="kw-2">&</span>[u8; SAMPLE_LEN]>::try_from(sample)<span class="question-mark">?</span>; |
| |
| <span class="kw">let </span>out = (<span class="self">self</span>.algorithm.new_mask)(<span class="kw-2">&</span><span class="self">self</span>.inner, <span class="kw-2">*</span>sample); |
| <span class="prelude-val">Ok</span>(out) |
| } |
| |
| <span class="doccomment">/// The key's algorithm. |
| </span><span class="attribute">#[inline(always)] |
| </span><span class="kw">pub fn </span>algorithm(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="lifetime">'static </span>Algorithm { |
| <span class="self">self</span>.algorithm |
| } |
| } |
| |
| <span class="kw">const </span>SAMPLE_LEN: usize = <span class="kw">super</span>::TAG_LEN; |
| |
| <span class="doccomment">/// QUIC sample for new key masks |
| </span><span class="kw">pub type </span>Sample = [u8; SAMPLE_LEN]; |
| |
| <span class="doccomment">/// A QUIC Header Protection Algorithm. |
| </span><span class="kw">pub struct </span>Algorithm { |
| init: <span class="kw">fn</span>(key: <span class="kw-2">&</span>[u8], cpu_features: cpu::Features) -> <span class="prelude-ty">Result</span><KeyInner, error::Unspecified>, |
| |
| new_mask: <span class="kw">fn</span>(key: <span class="kw-2">&</span>KeyInner, sample: Sample) -> [u8; <span class="number">5</span>], |
| |
| key_len: usize, |
| id: AlgorithmID, |
| } |
| |
| <span class="kw">impl </span>hkdf::KeyType <span class="kw">for </span><span class="kw-2">&</span><span class="lifetime">'static </span>Algorithm { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>len(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.key_len() |
| } |
| } |
| |
| <span class="kw">impl </span>Algorithm { |
| <span class="doccomment">/// The length of the key. |
| </span><span class="attribute">#[inline(always)] |
| </span><span class="kw">pub fn </span>key_len(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.key_len |
| } |
| |
| <span class="doccomment">/// The required sample length. |
| </span><span class="attribute">#[inline(always)] |
| </span><span class="kw">pub fn </span>sample_len(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| SAMPLE_LEN |
| } |
| } |
| |
| <span class="macro">derive_debug_via_id!</span>(Algorithm); |
| |
| <span class="attribute">#[derive(Debug, Eq, PartialEq)] |
| </span><span class="kw">enum </span>AlgorithmID { |
| AES_128, |
| AES_256, |
| CHACHA20, |
| } |
| |
| <span class="kw">impl </span>PartialEq <span class="kw">for </span>Algorithm { |
| <span class="kw">fn </span>eq(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span><span class="self">Self</span>) -> bool { |
| <span class="self">self</span>.id == other.id |
| } |
| } |
| |
| <span class="kw">impl </span>Eq <span class="kw">for </span>Algorithm {} |
| |
| <span class="doccomment">/// AES-128. |
| </span><span class="kw">pub static </span>AES_128: Algorithm = Algorithm { |
| key_len: <span class="number">16</span>, |
| init: aes_init_128, |
| new_mask: aes_new_mask, |
| id: AlgorithmID::AES_128, |
| }; |
| |
| <span class="doccomment">/// AES-256. |
| </span><span class="kw">pub static </span>AES_256: Algorithm = Algorithm { |
| key_len: <span class="number">32</span>, |
| init: aes_init_256, |
| new_mask: aes_new_mask, |
| id: AlgorithmID::AES_256, |
| }; |
| |
| <span class="kw">fn </span>aes_init_128(key: <span class="kw-2">&</span>[u8], cpu_features: cpu::Features) -> <span class="prelude-ty">Result</span><KeyInner, error::Unspecified> { |
| <span class="kw">let </span>aes_key = aes::Key::new(key, aes::Variant::AES_128, cpu_features)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(KeyInner::Aes(aes_key)) |
| } |
| |
| <span class="kw">fn </span>aes_init_256(key: <span class="kw-2">&</span>[u8], cpu_features: cpu::Features) -> <span class="prelude-ty">Result</span><KeyInner, error::Unspecified> { |
| <span class="kw">let </span>aes_key = aes::Key::new(key, aes::Variant::AES_256, cpu_features)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(KeyInner::Aes(aes_key)) |
| } |
| |
| <span class="kw">fn </span>aes_new_mask(key: <span class="kw-2">&</span>KeyInner, sample: Sample) -> [u8; <span class="number">5</span>] { |
| <span class="kw">let </span>aes_key = <span class="kw">match </span>key { |
| KeyInner::Aes(key) => key, |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| }; |
| |
| aes_key.new_mask(sample) |
| } |
| |
| <span class="doccomment">/// ChaCha20. |
| </span><span class="kw">pub static </span>CHACHA20: Algorithm = Algorithm { |
| key_len: chacha::KEY_LEN, |
| init: chacha20_init, |
| new_mask: chacha20_new_mask, |
| id: AlgorithmID::CHACHA20, |
| }; |
| |
| <span class="kw">fn </span>chacha20_init(key: <span class="kw-2">&</span>[u8], _todo: cpu::Features) -> <span class="prelude-ty">Result</span><KeyInner, error::Unspecified> { |
| <span class="kw">let </span>chacha20_key: [u8; chacha::KEY_LEN] = key.try_into()<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(KeyInner::ChaCha20(chacha::Key::from(chacha20_key))) |
| } |
| |
| <span class="kw">fn </span>chacha20_new_mask(key: <span class="kw-2">&</span>KeyInner, sample: Sample) -> [u8; <span class="number">5</span>] { |
| <span class="kw">let </span>chacha20_key = <span class="kw">match </span>key { |
| KeyInner::ChaCha20(key) => key, |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| }; |
| |
| chacha20_key.new_mask(sample) |
| } |
| </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> |
