| <!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.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>aead.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> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| <span id="334">334</span> |
| <span id="335">335</span> |
| <span id="336">336</span> |
| <span id="337">337</span> |
| <span id="338">338</span> |
| <span id="339">339</span> |
| <span id="340">340</span> |
| <span id="341">341</span> |
| <span id="342">342</span> |
| <span id="343">343</span> |
| <span id="344">344</span> |
| <span id="345">345</span> |
| <span id="346">346</span> |
| <span id="347">347</span> |
| <span id="348">348</span> |
| <span id="349">349</span> |
| <span id="350">350</span> |
| <span id="351">351</span> |
| <span id="352">352</span> |
| <span id="353">353</span> |
| <span id="354">354</span> |
| <span id="355">355</span> |
| <span id="356">356</span> |
| <span id="357">357</span> |
| <span id="358">358</span> |
| <span id="359">359</span> |
| <span id="360">360</span> |
| <span id="361">361</span> |
| <span id="362">362</span> |
| <span id="363">363</span> |
| <span id="364">364</span> |
| <span id="365">365</span> |
| <span id="366">366</span> |
| <span id="367">367</span> |
| <span id="368">368</span> |
| <span id="369">369</span> |
| <span id="370">370</span> |
| <span id="371">371</span> |
| <span id="372">372</span> |
| <span id="373">373</span> |
| <span id="374">374</span> |
| <span id="375">375</span> |
| <span id="376">376</span> |
| <span id="377">377</span> |
| <span id="378">378</span> |
| <span id="379">379</span> |
| <span id="380">380</span> |
| <span id="381">381</span> |
| <span id="382">382</span> |
| <span id="383">383</span> |
| <span id="384">384</span> |
| <span id="385">385</span> |
| <span id="386">386</span> |
| <span id="387">387</span> |
| <span id="388">388</span> |
| <span id="389">389</span> |
| <span id="390">390</span> |
| <span id="391">391</span> |
| <span id="392">392</span> |
| <span id="393">393</span> |
| <span id="394">394</span> |
| <span id="395">395</span> |
| <span id="396">396</span> |
| <span id="397">397</span> |
| <span id="398">398</span> |
| <span id="399">399</span> |
| <span id="400">400</span> |
| <span id="401">401</span> |
| <span id="402">402</span> |
| <span id="403">403</span> |
| <span id="404">404</span> |
| <span id="405">405</span> |
| <span id="406">406</span> |
| <span id="407">407</span> |
| <span id="408">408</span> |
| <span id="409">409</span> |
| <span id="410">410</span> |
| <span id="411">411</span> |
| <span id="412">412</span> |
| <span id="413">413</span> |
| <span id="414">414</span> |
| <span id="415">415</span> |
| <span id="416">416</span> |
| <span id="417">417</span> |
| <span id="418">418</span> |
| <span id="419">419</span> |
| <span id="420">420</span> |
| <span id="421">421</span> |
| <span id="422">422</span> |
| <span id="423">423</span> |
| <span id="424">424</span> |
| <span id="425">425</span> |
| <span id="426">426</span> |
| <span id="427">427</span> |
| <span id="428">428</span> |
| <span id="429">429</span> |
| <span id="430">430</span> |
| <span id="431">431</span> |
| <span id="432">432</span> |
| <span id="433">433</span> |
| <span id="434">434</span> |
| <span id="435">435</span> |
| <span id="436">436</span> |
| <span id="437">437</span> |
| <span id="438">438</span> |
| <span id="439">439</span> |
| <span id="440">440</span> |
| <span id="441">441</span> |
| <span id="442">442</span> |
| <span id="443">443</span> |
| <span id="444">444</span> |
| <span id="445">445</span> |
| <span id="446">446</span> |
| <span id="447">447</span> |
| <span id="448">448</span> |
| <span id="449">449</span> |
| <span id="450">450</span> |
| <span id="451">451</span> |
| <span id="452">452</span> |
| <span id="453">453</span> |
| <span id="454">454</span> |
| <span id="455">455</span> |
| <span id="456">456</span> |
| <span id="457">457</span> |
| <span id="458">458</span> |
| <span id="459">459</span> |
| <span id="460">460</span> |
| <span id="461">461</span> |
| <span id="462">462</span> |
| <span id="463">463</span> |
| <span id="464">464</span> |
| <span id="465">465</span> |
| <span id="466">466</span> |
| <span id="467">467</span> |
| <span id="468">468</span> |
| <span id="469">469</span> |
| <span id="470">470</span> |
| <span id="471">471</span> |
| <span id="472">472</span> |
| <span id="473">473</span> |
| <span id="474">474</span> |
| <span id="475">475</span> |
| <span id="476">476</span> |
| <span id="477">477</span> |
| <span id="478">478</span> |
| <span id="479">479</span> |
| <span id="480">480</span> |
| <span id="481">481</span> |
| <span id="482">482</span> |
| <span id="483">483</span> |
| <span id="484">484</span> |
| <span id="485">485</span> |
| <span id="486">486</span> |
| <span id="487">487</span> |
| <span id="488">488</span> |
| <span id="489">489</span> |
| <span id="490">490</span> |
| <span id="491">491</span> |
| <span id="492">492</span> |
| <span id="493">493</span> |
| <span id="494">494</span> |
| <span id="495">495</span> |
| <span id="496">496</span> |
| <span id="497">497</span> |
| <span id="498">498</span> |
| <span id="499">499</span> |
| <span id="500">500</span> |
| <span id="501">501</span> |
| <span id="502">502</span> |
| <span id="503">503</span> |
| <span id="504">504</span> |
| <span id="505">505</span> |
| <span id="506">506</span> |
| <span id="507">507</span> |
| <span id="508">508</span> |
| <span id="509">509</span> |
| <span id="510">510</span> |
| <span id="511">511</span> |
| <span id="512">512</span> |
| <span id="513">513</span> |
| <span id="514">514</span> |
| <span id="515">515</span> |
| <span id="516">516</span> |
| <span id="517">517</span> |
| <span id="518">518</span> |
| <span id="519">519</span> |
| <span id="520">520</span> |
| <span id="521">521</span> |
| <span id="522">522</span> |
| <span id="523">523</span> |
| <span id="524">524</span> |
| <span id="525">525</span> |
| <span id="526">526</span> |
| <span id="527">527</span> |
| <span id="528">528</span> |
| <span id="529">529</span> |
| <span id="530">530</span> |
| <span id="531">531</span> |
| <span id="532">532</span> |
| <span id="533">533</span> |
| <span id="534">534</span> |
| <span id="535">535</span> |
| <span id="536">536</span> |
| <span id="537">537</span> |
| <span id="538">538</span> |
| <span id="539">539</span> |
| <span id="540">540</span> |
| <span id="541">541</span> |
| <span id="542">542</span> |
| <span id="543">543</span> |
| <span id="544">544</span> |
| <span id="545">545</span> |
| <span id="546">546</span> |
| <span id="547">547</span> |
| <span id="548">548</span> |
| <span id="549">549</span> |
| <span id="550">550</span> |
| <span id="551">551</span> |
| <span id="552">552</span> |
| <span id="553">553</span> |
| <span id="554">554</span> |
| <span id="555">555</span> |
| <span id="556">556</span> |
| <span id="557">557</span> |
| <span id="558">558</span> |
| <span id="559">559</span> |
| <span id="560">560</span> |
| <span id="561">561</span> |
| <span id="562">562</span> |
| <span id="563">563</span> |
| <span id="564">564</span> |
| <span id="565">565</span> |
| <span id="566">566</span> |
| <span id="567">567</span> |
| <span id="568">568</span> |
| <span id="569">569</span> |
| <span id="570">570</span> |
| <span id="571">571</span> |
| <span id="572">572</span> |
| <span id="573">573</span> |
| <span id="574">574</span> |
| <span id="575">575</span> |
| <span id="576">576</span> |
| <span id="577">577</span> |
| <span id="578">578</span> |
| <span id="579">579</span> |
| <span id="580">580</span> |
| <span id="581">581</span> |
| <span id="582">582</span> |
| <span id="583">583</span> |
| <span id="584">584</span> |
| <span id="585">585</span> |
| <span id="586">586</span> |
| <span id="587">587</span> |
| <span id="588">588</span> |
| <span id="589">589</span> |
| <span id="590">590</span> |
| <span id="591">591</span> |
| <span id="592">592</span> |
| <span id="593">593</span> |
| <span id="594">594</span> |
| <span id="595">595</span> |
| <span id="596">596</span> |
| <span id="597">597</span> |
| <span id="598">598</span> |
| <span id="599">599</span> |
| <span id="600">600</span> |
| <span id="601">601</span> |
| <span id="602">602</span> |
| <span id="603">603</span> |
| <span id="604">604</span> |
| <span id="605">605</span> |
| <span id="606">606</span> |
| <span id="607">607</span> |
| <span id="608">608</span> |
| <span id="609">609</span> |
| <span id="610">610</span> |
| <span id="611">611</span> |
| <span id="612">612</span> |
| <span id="613">613</span> |
| <span id="614">614</span> |
| <span id="615">615</span> |
| <span id="616">616</span> |
| <span id="617">617</span> |
| <span id="618">618</span> |
| <span id="619">619</span> |
| <span id="620">620</span> |
| <span id="621">621</span> |
| <span id="622">622</span> |
| <span id="623">623</span> |
| <span id="624">624</span> |
| <span id="625">625</span> |
| <span id="626">626</span> |
| <span id="627">627</span> |
| <span id="628">628</span> |
| <span id="629">629</span> |
| <span id="630">630</span> |
| <span id="631">631</span> |
| <span id="632">632</span> |
| <span id="633">633</span> |
| <span id="634">634</span> |
| <span id="635">635</span> |
| <span id="636">636</span> |
| <span id="637">637</span> |
| <span id="638">638</span> |
| <span id="639">639</span> |
| <span id="640">640</span> |
| <span id="641">641</span> |
| <span id="642">642</span> |
| <span id="643">643</span> |
| <span id="644">644</span> |
| <span id="645">645</span> |
| <span id="646">646</span> |
| <span id="647">647</span> |
| <span id="648">648</span> |
| <span id="649">649</span> |
| <span id="650">650</span> |
| <span id="651">651</span> |
| <span id="652">652</span> |
| <span id="653">653</span> |
| <span id="654">654</span> |
| <span id="655">655</span> |
| <span id="656">656</span> |
| <span id="657">657</span> |
| <span id="658">658</span> |
| <span id="659">659</span> |
| <span id="660">660</span> |
| <span id="661">661</span> |
| <span id="662">662</span> |
| <span id="663">663</span> |
| <span id="664">664</span> |
| <span id="665">665</span> |
| <span id="666">666</span> |
| <span id="667">667</span> |
| <span id="668">668</span> |
| <span id="669">669</span> |
| <span id="670">670</span> |
| <span id="671">671</span> |
| <span id="672">672</span> |
| <span id="673">673</span> |
| <span id="674">674</span> |
| <span id="675">675</span> |
| <span id="676">676</span> |
| <span id="677">677</span> |
| <span id="678">678</span> |
| <span id="679">679</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 "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">//! Authenticated Encryption with Associated Data (AEAD). |
| //! |
| //! See [Authenticated encryption: relations among notions and analysis of the |
| //! generic composition paradigm][AEAD] for an introduction to the concept of |
| //! AEADs. |
| //! |
| //! [AEAD]: http://www-cse.ucsd.edu/~mihir/papers/oem.html |
| //! [`crypto.cipher.AEAD`]: https://golang.org/pkg/crypto/cipher/#AEAD |
| |
| </span><span class="kw">use </span><span class="self">self</span>::block::{Block, BLOCK_LEN}; |
| <span class="kw">use crate</span>::{constant_time, cpu, error, hkdf, polyfill}; |
| <span class="kw">use </span>core::ops::RangeFrom; |
| |
| <span class="kw">pub use </span><span class="self">self</span>::{ |
| aes_gcm::{AES_128_GCM, AES_256_GCM}, |
| chacha20_poly1305::CHACHA20_POLY1305, |
| nonce::{Nonce, NONCE_LEN}, |
| }; |
| |
| <span class="doccomment">/// A sequences of unique nonces. |
| /// |
| /// A given `NonceSequence` must never return the same `Nonce` twice from |
| /// `advance()`. |
| /// |
| /// A simple counter is a reasonable (but probably not ideal) `NonceSequence`. |
| /// |
| /// Intentionally not `Clone` or `Copy` since cloning would allow duplication |
| /// of the sequence. |
| </span><span class="kw">pub trait </span>NonceSequence { |
| <span class="doccomment">/// Returns the next nonce in the sequence. |
| /// |
| /// This may fail if "too many" nonces have been requested, where how many |
| /// is too many is up to the implementation of `NonceSequence`. An |
| /// implementation may that enforce a maximum number of records are |
| /// sent/received under a key this way. Once `advance()` fails, it must |
| /// fail for all subsequent calls. |
| </span><span class="kw">fn </span>advance(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><Nonce, error::Unspecified>; |
| } |
| |
| <span class="doccomment">/// An AEAD key bound to a nonce sequence. |
| </span><span class="kw">pub trait </span>BoundKey<N: NonceSequence>: core::fmt::Debug { |
| <span class="doccomment">/// Constructs a new key from the given `UnboundKey` and `NonceSequence`. |
| </span><span class="kw">fn </span>new(key: UnboundKey, nonce_sequence: N) -> <span class="self">Self</span>; |
| |
| <span class="doccomment">/// The key's AEAD algorithm. |
| </span><span class="kw">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="doccomment">/// An AEAD key for authenticating and decrypting ("opening"), bound to a nonce |
| /// sequence. |
| /// |
| /// Intentionally not `Clone` or `Copy` since cloning would allow duplication |
| /// of the nonce sequence. |
| </span><span class="kw">pub struct </span>OpeningKey<N: NonceSequence> { |
| key: UnboundKey, |
| nonce_sequence: N, |
| } |
| |
| <span class="kw">impl</span><N: NonceSequence> BoundKey<N> <span class="kw">for </span>OpeningKey<N> { |
| <span class="kw">fn </span>new(key: UnboundKey, nonce_sequence: N) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| key, |
| nonce_sequence, |
| } |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">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>.key.algorithm |
| } |
| } |
| |
| <span class="kw">impl</span><N: NonceSequence> core::fmt::Debug <span class="kw">for </span>OpeningKey<N> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>core::fmt::Formatter) -> <span class="prelude-ty">Result</span><(), core::fmt::Error> { |
| f.debug_struct(<span class="string">"OpeningKey"</span>) |
| .field(<span class="string">"algorithm"</span>, <span class="kw-2">&</span><span class="self">self</span>.algorithm()) |
| .finish() |
| } |
| } |
| |
| <span class="kw">impl</span><N: NonceSequence> OpeningKey<N> { |
| <span class="doccomment">/// Authenticates and decrypts (“opens”) data in place. |
| /// |
| /// `aad` is the additional authenticated data (AAD), if any. |
| /// |
| /// On input, `in_out` must be the ciphertext followed by the tag. When |
| /// `open_in_place()` returns `Ok(plaintext)`, the input ciphertext |
| /// has been overwritten by the plaintext; `plaintext` will refer to the |
| /// plaintext without the tag. |
| /// |
| /// When `open_in_place()` returns `Err(..)`, `in_out` may have been |
| /// overwritten in an unspecified way. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>open_in_place<<span class="lifetime">'in_out</span>, A>( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| aad: Aad<A>, |
| in_out: <span class="kw-2">&</span><span class="lifetime">'in_out </span><span class="kw-2">mut </span>[u8], |
| ) -> <span class="prelude-ty">Result</span><<span class="kw-2">&</span><span class="lifetime">'in_out </span><span class="kw-2">mut </span>[u8], error::Unspecified> |
| <span class="kw">where |
| </span>A: AsRef<[u8]>, |
| { |
| <span class="self">self</span>.open_within(aad, in_out, <span class="number">0</span>..) |
| } |
| |
| <span class="doccomment">/// Authenticates and decrypts (“opens”) data in place, with a shift. |
| /// |
| /// `aad` is the additional authenticated data (AAD), if any. |
| /// |
| /// On input, `in_out[ciphertext_and_tag]` must be the ciphertext followed |
| /// by the tag. When `open_within()` returns `Ok(plaintext)`, the plaintext |
| /// will be at `in_out[0..plaintext.len()]`. In other words, the following |
| /// two code fragments are equivalent for valid values of |
| /// `ciphertext_and_tag`, except `open_within` will often be more efficient: |
| /// |
| /// |
| /// ```skip |
| /// let plaintext = key.open_within(aad, in_out, cipertext_and_tag)?; |
| /// ``` |
| /// |
| /// ```skip |
| /// let ciphertext_and_tag_len = in_out[ciphertext_and_tag].len(); |
| /// in_out.copy_within(ciphertext_and_tag, 0); |
| /// let plaintext = key.open_in_place(aad, &mut in_out[..ciphertext_and_tag_len])?; |
| /// ``` |
| /// |
| /// Similarly, `key.open_within(aad, in_out, 0..)` is equivalent to |
| /// `key.open_in_place(aad, in_out)`. |
| /// |
| /// When `open_in_place()` returns `Err(..)`, `in_out` may have been |
| /// overwritten in an unspecified way. |
| /// |
| /// The shifting feature is useful in the case where multiple packets are |
| /// being reassembled in place. Consider this example where the peer has |
| /// sent the message “Split stream reassembled in place” split into |
| /// three sealed packets: |
| /// |
| /// ```ascii-art |
| /// Packet 1 Packet 2 Packet 3 |
| /// Input: [Header][Ciphertext][Tag][Header][Ciphertext][Tag][Header][Ciphertext][Tag] |
| /// | +--------------+ | |
| /// +------+ +-----+ +----------------------------------+ |
| /// v v v |
| /// Output: [Plaintext][Plaintext][Plaintext] |
| /// “Split stream reassembled in place” |
| /// ``` |
| /// |
| /// This reassembly be accomplished with three calls to `open_within()`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>open_within<<span class="lifetime">'in_out</span>, A>( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| aad: Aad<A>, |
| in_out: <span class="kw-2">&</span><span class="lifetime">'in_out </span><span class="kw-2">mut </span>[u8], |
| ciphertext_and_tag: RangeFrom<usize>, |
| ) -> <span class="prelude-ty">Result</span><<span class="kw-2">&</span><span class="lifetime">'in_out </span><span class="kw-2">mut </span>[u8], error::Unspecified> |
| <span class="kw">where |
| </span>A: AsRef<[u8]>, |
| { |
| open_within_( |
| <span class="kw-2">&</span><span class="self">self</span>.key, |
| <span class="self">self</span>.nonce_sequence.advance()<span class="question-mark">?</span>, |
| aad, |
| in_out, |
| ciphertext_and_tag, |
| ) |
| } |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>open_within_<<span class="lifetime">'in_out</span>, A: AsRef<[u8]>>( |
| key: <span class="kw-2">&</span>UnboundKey, |
| nonce: Nonce, |
| Aad(aad): Aad<A>, |
| in_out: <span class="kw-2">&</span><span class="lifetime">'in_out </span><span class="kw-2">mut </span>[u8], |
| ciphertext_and_tag: RangeFrom<usize>, |
| ) -> <span class="prelude-ty">Result</span><<span class="kw-2">&</span><span class="lifetime">'in_out </span><span class="kw-2">mut </span>[u8], error::Unspecified> { |
| <span class="kw">fn </span>open_within<<span class="lifetime">'in_out</span>>( |
| key: <span class="kw-2">&</span>UnboundKey, |
| nonce: Nonce, |
| aad: Aad<<span class="kw-2">&</span>[u8]>, |
| in_out: <span class="kw-2">&</span><span class="lifetime">'in_out </span><span class="kw-2">mut </span>[u8], |
| ciphertext_and_tag: RangeFrom<usize>, |
| ) -> <span class="prelude-ty">Result</span><<span class="kw-2">&</span><span class="lifetime">'in_out </span><span class="kw-2">mut </span>[u8], error::Unspecified> { |
| <span class="kw">let </span>in_prefix_len = ciphertext_and_tag.start; |
| <span class="kw">let </span>ciphertext_and_tag_len = in_out |
| .len() |
| .checked_sub(in_prefix_len) |
| .ok_or(error::Unspecified)<span class="question-mark">?</span>; |
| <span class="kw">let </span>ciphertext_len = ciphertext_and_tag_len |
| .checked_sub(TAG_LEN) |
| .ok_or(error::Unspecified)<span class="question-mark">?</span>; |
| check_per_nonce_max_bytes(key.algorithm, ciphertext_len)<span class="question-mark">?</span>; |
| <span class="kw">let </span>(in_out, received_tag) = in_out.split_at_mut(in_prefix_len + ciphertext_len); |
| <span class="kw">let </span>Tag(calculated_tag) = (key.algorithm.open)( |
| <span class="kw-2">&</span>key.inner, |
| nonce, |
| aad, |
| in_prefix_len, |
| in_out, |
| key.cpu_features, |
| ); |
| <span class="kw">if </span>constant_time::verify_slices_are_equal(calculated_tag.as_ref(), received_tag).is_err() { |
| <span class="comment">// Zero out the plaintext so that it isn't accidentally leaked or used |
| // after verification fails. It would be safest if we could check the |
| // tag before decrypting, but some `open` implementations interleave |
| // authentication with decryption for performance. |
| </span><span class="kw">for </span>b <span class="kw">in </span><span class="kw-2">&mut </span>in_out[..ciphertext_len] { |
| <span class="kw-2">*</span>b = <span class="number">0</span>; |
| } |
| <span class="kw">return </span><span class="prelude-val">Err</span>(error::Unspecified); |
| } |
| <span class="comment">// `ciphertext_len` is also the plaintext length. |
| </span><span class="prelude-val">Ok</span>(<span class="kw-2">&mut </span>in_out[..ciphertext_len]) |
| } |
| |
| open_within( |
| key, |
| nonce, |
| Aad::from(aad.as_ref()), |
| in_out, |
| ciphertext_and_tag, |
| ) |
| } |
| |
| <span class="doccomment">/// An AEAD key for encrypting and signing ("sealing"), bound to a nonce |
| /// sequence. |
| /// |
| /// Intentionally not `Clone` or `Copy` since cloning would allow duplication |
| /// of the nonce sequence. |
| </span><span class="kw">pub struct </span>SealingKey<N: NonceSequence> { |
| key: UnboundKey, |
| nonce_sequence: N, |
| } |
| |
| <span class="kw">impl</span><N: NonceSequence> BoundKey<N> <span class="kw">for </span>SealingKey<N> { |
| <span class="kw">fn </span>new(key: UnboundKey, nonce_sequence: N) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| key, |
| nonce_sequence, |
| } |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">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>.key.algorithm |
| } |
| } |
| |
| <span class="kw">impl</span><N: NonceSequence> core::fmt::Debug <span class="kw">for </span>SealingKey<N> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>core::fmt::Formatter) -> <span class="prelude-ty">Result</span><(), core::fmt::Error> { |
| f.debug_struct(<span class="string">"SealingKey"</span>) |
| .field(<span class="string">"algorithm"</span>, <span class="kw-2">&</span><span class="self">self</span>.algorithm()) |
| .finish() |
| } |
| } |
| |
| <span class="kw">impl</span><N: NonceSequence> SealingKey<N> { |
| <span class="doccomment">/// Deprecated. Renamed to `seal_in_place_append_tag()`. |
| </span><span class="attribute">#[deprecated(note = <span class="string">"Renamed to `seal_in_place_append_tag`."</span>)] |
| #[inline] |
| </span><span class="kw">pub fn </span>seal_in_place<A, InOut>( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| aad: Aad<A>, |
| in_out: <span class="kw-2">&mut </span>InOut, |
| ) -> <span class="prelude-ty">Result</span><(), error::Unspecified> |
| <span class="kw">where |
| </span>A: AsRef<[u8]>, |
| InOut: AsMut<[u8]> + <span class="kw">for</span><<span class="lifetime">'in_out</span>> Extend<<span class="kw-2">&</span><span class="lifetime">'in_out </span>u8>, |
| { |
| <span class="self">self</span>.seal_in_place_append_tag(aad, in_out) |
| } |
| |
| <span class="doccomment">/// Encrypts and signs (“seals”) data in place, appending the tag to the |
| /// resulting ciphertext. |
| /// |
| /// `key.seal_in_place_append_tag(aad, in_out)` is equivalent to: |
| /// |
| /// ```skip |
| /// key.seal_in_place_separate_tag(aad, in_out.as_mut()) |
| /// .map(|tag| in_out.extend(tag.as_ref())) |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>seal_in_place_append_tag<A, InOut>( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| aad: Aad<A>, |
| in_out: <span class="kw-2">&mut </span>InOut, |
| ) -> <span class="prelude-ty">Result</span><(), error::Unspecified> |
| <span class="kw">where |
| </span>A: AsRef<[u8]>, |
| InOut: AsMut<[u8]> + <span class="kw">for</span><<span class="lifetime">'in_out</span>> Extend<<span class="kw-2">&</span><span class="lifetime">'in_out </span>u8>, |
| { |
| <span class="self">self</span>.seal_in_place_separate_tag(aad, in_out.as_mut()) |
| .map(|tag| in_out.extend(tag.as_ref())) |
| } |
| |
| <span class="doccomment">/// Encrypts and signs (“seals”) data in place. |
| /// |
| /// `aad` is the additional authenticated data (AAD), if any. This is |
| /// authenticated but not encrypted. The type `A` could be a byte slice |
| /// `&[u8]`, a byte array `[u8; N]` for some constant `N`, `Vec<u8>`, etc. |
| /// If there is no AAD then use `Aad::empty()`. |
| /// |
| /// The plaintext is given as the input value of `in_out`. `seal_in_place()` |
| /// will overwrite the plaintext with the ciphertext and return the tag. |
| /// For most protocols, the caller must append the tag to the ciphertext. |
| /// The tag will be `self.algorithm.tag_len()` bytes long. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>seal_in_place_separate_tag<A>( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| aad: Aad<A>, |
| in_out: <span class="kw-2">&mut </span>[u8], |
| ) -> <span class="prelude-ty">Result</span><Tag, error::Unspecified> |
| <span class="kw">where |
| </span>A: AsRef<[u8]>, |
| { |
| seal_in_place_separate_tag_( |
| <span class="kw-2">&</span><span class="self">self</span>.key, |
| <span class="self">self</span>.nonce_sequence.advance()<span class="question-mark">?</span>, |
| Aad::from(aad.as_ref()), |
| in_out, |
| ) |
| } |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>seal_in_place_separate_tag_( |
| key: <span class="kw-2">&</span>UnboundKey, |
| nonce: Nonce, |
| aad: Aad<<span class="kw-2">&</span>[u8]>, |
| in_out: <span class="kw-2">&mut </span>[u8], |
| ) -> <span class="prelude-ty">Result</span><Tag, error::Unspecified> { |
| check_per_nonce_max_bytes(key.algorithm, in_out.len())<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>((key.algorithm.seal)( |
| <span class="kw-2">&</span>key.inner, |
| nonce, |
| aad, |
| in_out, |
| key.cpu_features, |
| )) |
| } |
| |
| <span class="doccomment">/// The additionally authenticated data (AAD) for an opening or sealing |
| /// operation. This data is authenticated but is **not** encrypted. |
| /// |
| /// The type `A` could be a byte slice `&[u8]`, a byte array `[u8; N]` |
| /// for some constant `N`, `Vec<u8>`, etc. |
| </span><span class="kw">pub struct </span>Aad<A: AsRef<[u8]>>(A); |
| |
| <span class="kw">impl</span><A: AsRef<[u8]>> Aad<A> { |
| <span class="doccomment">/// Construct the `Aad` from the given bytes. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>from(aad: A) -> <span class="self">Self </span>{ |
| Aad(aad) |
| } |
| } |
| |
| <span class="kw">impl</span><A> AsRef<[u8]> <span class="kw">for </span>Aad<A> |
| <span class="kw">where |
| </span>A: AsRef<[u8]>, |
| { |
| <span class="kw">fn </span>as_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[u8] { |
| <span class="self">self</span>.<span class="number">0</span>.as_ref() |
| } |
| } |
| |
| <span class="kw">impl </span>Aad<[u8; <span class="number">0</span>]> { |
| <span class="doccomment">/// Construct an empty `Aad`. |
| </span><span class="kw">pub fn </span>empty() -> <span class="self">Self </span>{ |
| <span class="self">Self</span>::from([]) |
| } |
| } |
| |
| <span class="doccomment">/// An AEAD key without a designated role or nonce sequence. |
| </span><span class="kw">pub struct </span>UnboundKey { |
| inner: KeyInner, |
| algorithm: <span class="kw-2">&</span><span class="lifetime">'static </span>Algorithm, |
| cpu_features: cpu::Features, |
| } |
| |
| <span class="kw">impl </span>core::fmt::Debug <span class="kw">for </span>UnboundKey { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>core::fmt::Formatter) -> <span class="prelude-ty">Result</span><(), core::fmt::Error> { |
| f.debug_struct(<span class="string">"UnboundKey"</span>) |
| .field(<span class="string">"algorithm"</span>, <span class="kw-2">&</span><span class="self">self</span>.algorithm) |
| .finish() |
| } |
| } |
| |
| <span class="attribute">#[allow(clippy::large_enum_variant, variant_size_differences)] |
| </span><span class="kw">enum </span>KeyInner { |
| AesGcm(aes_gcm::Key), |
| ChaCha20Poly1305(chacha20_poly1305::Key), |
| } |
| |
| <span class="kw">impl </span>UnboundKey { |
| <span class="doccomment">/// Constructs an `UnboundKey`. |
| /// |
| /// Fails if `key_bytes.len() != algorithm.key_len()`. |
| </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="kw">let </span>cpu_features = cpu::features(); |
| <span class="prelude-val">Ok</span>(<span class="self">Self </span>{ |
| inner: (algorithm.init)(key_bytes, cpu_features)<span class="question-mark">?</span>, |
| algorithm, |
| cpu_features, |
| }) |
| } |
| |
| <span class="doccomment">/// The key's AEAD algorithm. |
| </span><span class="attribute">#[inline] |
| </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">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>UnboundKey { |
| <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>; MAX_KEY_LEN]; |
| <span class="kw">let </span>key_bytes = <span class="kw-2">&mut </span>key_bytes[..okm.len().key_len]; |
| <span class="kw">let </span>algorithm = <span class="kw-2">*</span>okm.len(); |
| okm.fill(key_bytes).unwrap(); |
| <span class="self">Self</span>::new(algorithm, key_bytes).unwrap() |
| } |
| } |
| |
| <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="doccomment">/// Immutable keys for use in situations where `OpeningKey`/`SealingKey` and |
| /// `NonceSequence` cannot reasonably be used. |
| /// |
| /// Prefer to use `OpeningKey`/`SealingKey` and `NonceSequence` when practical. |
| </span><span class="kw">pub struct </span>LessSafeKey { |
| key: UnboundKey, |
| } |
| |
| <span class="kw">impl </span>LessSafeKey { |
| <span class="doccomment">/// Constructs a `LessSafeKey` from an `UnboundKey`. |
| </span><span class="kw">pub fn </span>new(key: UnboundKey) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ key } |
| } |
| |
| <span class="doccomment">/// Like [`OpeningKey::open_in_place()`], except it accepts an arbitrary nonce. |
| /// |
| /// `nonce` must be unique for every use of the key to open data. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>open_in_place<<span class="lifetime">'in_out</span>, A>( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| nonce: Nonce, |
| aad: Aad<A>, |
| in_out: <span class="kw-2">&</span><span class="lifetime">'in_out </span><span class="kw-2">mut </span>[u8], |
| ) -> <span class="prelude-ty">Result</span><<span class="kw-2">&</span><span class="lifetime">'in_out </span><span class="kw-2">mut </span>[u8], error::Unspecified> |
| <span class="kw">where |
| </span>A: AsRef<[u8]>, |
| { |
| <span class="self">self</span>.open_within(nonce, aad, in_out, <span class="number">0</span>..) |
| } |
| |
| <span class="doccomment">/// Like [`OpeningKey::open_within()`], except it accepts an arbitrary nonce. |
| /// |
| /// `nonce` must be unique for every use of the key to open data. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>open_within<<span class="lifetime">'in_out</span>, A>( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| nonce: Nonce, |
| aad: Aad<A>, |
| in_out: <span class="kw-2">&</span><span class="lifetime">'in_out </span><span class="kw-2">mut </span>[u8], |
| ciphertext_and_tag: RangeFrom<usize>, |
| ) -> <span class="prelude-ty">Result</span><<span class="kw-2">&</span><span class="lifetime">'in_out </span><span class="kw-2">mut </span>[u8], error::Unspecified> |
| <span class="kw">where |
| </span>A: AsRef<[u8]>, |
| { |
| open_within_(<span class="kw-2">&</span><span class="self">self</span>.key, nonce, aad, in_out, ciphertext_and_tag) |
| } |
| |
| <span class="doccomment">/// Deprecated. Renamed to `seal_in_place_append_tag()`. |
| </span><span class="attribute">#[deprecated(note = <span class="string">"Renamed to `seal_in_place_append_tag`."</span>)] |
| #[inline] |
| </span><span class="kw">pub fn </span>seal_in_place<A, InOut>( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| nonce: Nonce, |
| aad: Aad<A>, |
| in_out: <span class="kw-2">&mut </span>InOut, |
| ) -> <span class="prelude-ty">Result</span><(), error::Unspecified> |
| <span class="kw">where |
| </span>A: AsRef<[u8]>, |
| InOut: AsMut<[u8]> + <span class="kw">for</span><<span class="lifetime">'in_out</span>> Extend<<span class="kw-2">&</span><span class="lifetime">'in_out </span>u8>, |
| { |
| <span class="self">self</span>.seal_in_place_append_tag(nonce, aad, in_out) |
| } |
| |
| <span class="doccomment">/// Like [`SealingKey::seal_in_place_append_tag()`], except it accepts an |
| /// arbitrary nonce. |
| /// |
| /// `nonce` must be unique for every use of the key to seal data. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>seal_in_place_append_tag<A, InOut>( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| nonce: Nonce, |
| aad: Aad<A>, |
| in_out: <span class="kw-2">&mut </span>InOut, |
| ) -> <span class="prelude-ty">Result</span><(), error::Unspecified> |
| <span class="kw">where |
| </span>A: AsRef<[u8]>, |
| InOut: AsMut<[u8]> + <span class="kw">for</span><<span class="lifetime">'in_out</span>> Extend<<span class="kw-2">&</span><span class="lifetime">'in_out </span>u8>, |
| { |
| <span class="self">self</span>.seal_in_place_separate_tag(nonce, aad, in_out.as_mut()) |
| .map(|tag| in_out.extend(tag.as_ref())) |
| } |
| |
| <span class="doccomment">/// Like `SealingKey::seal_in_place_separate_tag()`, except it accepts an |
| /// arbitrary nonce. |
| /// |
| /// `nonce` must be unique for every use of the key to seal data. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>seal_in_place_separate_tag<A>( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| nonce: Nonce, |
| aad: Aad<A>, |
| in_out: <span class="kw-2">&mut </span>[u8], |
| ) -> <span class="prelude-ty">Result</span><Tag, error::Unspecified> |
| <span class="kw">where |
| </span>A: AsRef<[u8]>, |
| { |
| seal_in_place_separate_tag_(<span class="kw-2">&</span><span class="self">self</span>.key, nonce, Aad::from(aad.as_ref()), in_out) |
| } |
| |
| <span class="doccomment">/// The key's AEAD algorithm. |
| </span><span class="attribute">#[inline] |
| </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="kw-2">&</span><span class="self">self</span>.key.algorithm |
| } |
| } |
| |
| <span class="kw">impl </span>core::fmt::Debug <span class="kw">for </span>LessSafeKey { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>core::fmt::Formatter) -> <span class="prelude-ty">Result</span><(), core::fmt::Error> { |
| f.debug_struct(<span class="string">"LessSafeKey"</span>) |
| .field(<span class="string">"algorithm"</span>, <span class="self">self</span>.algorithm()) |
| .finish() |
| } |
| } |
| |
| <span class="doccomment">/// An AEAD 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>, |
| |
| seal: <span class="kw">fn</span>( |
| key: <span class="kw-2">&</span>KeyInner, |
| nonce: Nonce, |
| aad: Aad<<span class="kw-2">&</span>[u8]>, |
| in_out: <span class="kw-2">&mut </span>[u8], |
| cpu_features: cpu::Features, |
| ) -> Tag, |
| open: <span class="kw">fn</span>( |
| key: <span class="kw-2">&</span>KeyInner, |
| nonce: Nonce, |
| aad: Aad<<span class="kw-2">&</span>[u8]>, |
| in_prefix_len: usize, |
| in_out: <span class="kw-2">&mut </span>[u8], |
| cpu_features: cpu::Features, |
| ) -> Tag, |
| |
| key_len: usize, |
| id: AlgorithmID, |
| |
| <span class="doccomment">/// Use `max_input_len!()` to initialize this. |
| </span><span class="comment">// TODO: Make this `usize`. |
| </span>max_input_len: u64, |
| } |
| |
| <span class="kw">const fn </span>max_input_len(block_len: usize, overhead_blocks_per_nonce: usize) -> u64 { |
| <span class="comment">// Each of our AEADs use a 32-bit block counter so the maximum is the |
| // largest input that will not overflow the counter. |
| </span>((<span class="number">1u64 </span><< <span class="number">32</span>) - polyfill::u64_from_usize(overhead_blocks_per_nonce)) |
| * polyfill::u64_from_usize(block_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 length of a tag. |
| /// |
| /// See also `MAX_TAG_LEN`. |
| </span><span class="attribute">#[inline(always)] |
| </span><span class="kw">pub fn </span>tag_len(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| TAG_LEN |
| } |
| |
| <span class="doccomment">/// The length of the nonces. |
| </span><span class="attribute">#[inline(always)] |
| </span><span class="kw">pub fn </span>nonce_len(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| NONCE_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_GCM, |
| AES_256_GCM, |
| CHACHA20_POLY1305, |
| } |
| |
| <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">/// An authentication tag. |
| </span><span class="attribute">#[must_use] |
| #[repr(C)] |
| </span><span class="kw">pub struct </span>Tag([u8; TAG_LEN]); |
| |
| <span class="kw">impl </span>AsRef<[u8]> <span class="kw">for </span>Tag { |
| <span class="kw">fn </span>as_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[u8] { |
| <span class="self">self</span>.<span class="number">0</span>.as_ref() |
| } |
| } |
| |
| <span class="kw">const </span>MAX_KEY_LEN: usize = <span class="number">32</span>; |
| |
| <span class="comment">// All the AEADs we support use 128-bit tags. |
| </span><span class="kw">const </span>TAG_LEN: usize = BLOCK_LEN; |
| |
| <span class="doccomment">/// The maximum length of a tag for the algorithms in this module. |
| </span><span class="kw">pub const </span>MAX_TAG_LEN: usize = TAG_LEN; |
| |
| <span class="kw">fn </span>check_per_nonce_max_bytes(alg: <span class="kw-2">&</span>Algorithm, in_out_len: usize) -> <span class="prelude-ty">Result</span><(), error::Unspecified> { |
| <span class="kw">if </span>polyfill::u64_from_usize(in_out_len) > alg.max_input_len { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(error::Unspecified); |
| } |
| <span class="prelude-val">Ok</span>(()) |
| } |
| |
| <span class="attribute">#[derive(Clone, Copy)] |
| </span><span class="kw">enum </span>Direction { |
| Opening { in_prefix_len: usize }, |
| Sealing, |
| } |
| |
| <span class="kw">mod </span>aes; |
| <span class="kw">mod </span>aes_gcm; |
| <span class="kw">mod </span>block; |
| <span class="kw">mod </span>chacha; |
| <span class="kw">mod </span>chacha20_poly1305; |
| <span class="kw">pub mod </span>chacha20_poly1305_openssh; |
| <span class="kw">mod </span>counter; |
| <span class="kw">mod </span>gcm; |
| <span class="kw">mod </span>iv; |
| <span class="kw">mod </span>nonce; |
| <span class="kw">mod </span>poly1305; |
| <span class="kw">pub mod </span>quic; |
| <span class="kw">mod </span>shift; |
| </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> |
