| <!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="An AEAD key for authenticating and decrypting (“opening”), bound to a nonce sequence."><meta name="keywords" content="rust, rustlang, rust-lang, OpeningKey"><title>OpeningKey in ring::aead - Rust</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="sidebar-items.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 struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../ring/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><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><h2 class="location"><a href="#">OpeningKey</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.open_in_place">open_in_place</a></li><li><a href="#method.open_within">open_within</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-BoundKey%3CN%3E-for-OpeningKey%3CN%3E">BoundKey<N></a></li><li><a href="#impl-Debug-for-OpeningKey%3CN%3E">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-OpeningKey%3CN%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-OpeningKey%3CN%3E">Send</a></li><li><a href="#impl-Sync-for-OpeningKey%3CN%3E">Sync</a></li><li><a href="#impl-Unpin-for-OpeningKey%3CN%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-OpeningKey%3CN%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-OpeningKey%3CN%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-OpeningKey%3CN%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-OpeningKey%3CN%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-OpeningKey%3CN%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-OpeningKey%3CN%3E">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-OpeningKey%3CN%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-OpeningKey%3CN%3E">TryInto<U></a></li></ul></section><h2><a href="index.html">In ring::aead</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1 class="fqn">Struct <a href="../index.html">ring</a>::<wbr><a href="index.html">aead</a>::<wbr><a class="struct" href="#">OpeningKey</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/ring/aead.rs.html#68-71">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct OpeningKey<N: <a class="trait" href="trait.NonceSequence.html" title="trait ring::aead::NonceSequence">NonceSequence</a>> { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An AEAD key for authenticating and decrypting (“opening”), bound to a nonce |
| sequence.</p> |
| <p>Intentionally not <code>Clone</code> or <code>Copy</code> since cloning would allow duplication |
| of the nonce sequence.</p> |
| </div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-OpeningKey%3CN%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/ring/aead.rs.html#95-180">source</a><a href="#impl-OpeningKey%3CN%3E" class="anchor"></a><h3 class="code-header">impl<N: <a class="trait" href="trait.NonceSequence.html" title="trait ring::aead::NonceSequence">NonceSequence</a>> <a class="struct" href="struct.OpeningKey.html" title="struct ring::aead::OpeningKey">OpeningKey</a><N></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.open_in_place" class="method has-srclink"><a class="srclink rightside" href="../../src/ring/aead.rs.html#108-117">source</a><h4 class="code-header">pub fn <a href="#method.open_in_place" class="fnname">open_in_place</a><'in_out, A>(<br> &mut self,<br> aad: <a class="struct" href="struct.Aad.html" title="struct ring::aead::Aad">Aad</a><A>,<br> in_out: &'in_out mut [u8]<br>) -> Result<&'in_out mut [u8], <a class="struct" href="../error/struct.Unspecified.html" title="struct ring::error::Unspecified">Unspecified</a>><span class="where fmt-newline">where<br> A: AsRef<[u8]>,</span></h4></section></summary><div class="docblock"><p>Authenticates and decrypts (“opens”) data in place.</p> |
| <p><code>aad</code> is the additional authenticated data (AAD), if any.</p> |
| <p>On input, <code>in_out</code> must be the ciphertext followed by the tag. When |
| <code>open_in_place()</code> returns <code>Ok(plaintext)</code>, the input ciphertext |
| has been overwritten by the plaintext; <code>plaintext</code> will refer to the |
| plaintext without the tag.</p> |
| <p>When <code>open_in_place()</code> returns <code>Err(..)</code>, <code>in_out</code> may have been |
| overwritten in an unspecified way.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.open_within" class="method has-srclink"><a class="srclink rightside" href="../../src/ring/aead.rs.html#163-179">source</a><h4 class="code-header">pub fn <a href="#method.open_within" class="fnname">open_within</a><'in_out, A>(<br> &mut self,<br> aad: <a class="struct" href="struct.Aad.html" title="struct ring::aead::Aad">Aad</a><A>,<br> in_out: &'in_out mut [u8],<br> ciphertext_and_tag: RangeFrom<usize><br>) -> Result<&'in_out mut [u8], <a class="struct" href="../error/struct.Unspecified.html" title="struct ring::error::Unspecified">Unspecified</a>><span class="where fmt-newline">where<br> A: AsRef<[u8]>,</span></h4></section></summary><div class="docblock"><p>Authenticates and decrypts (“opens”) data in place, with a shift.</p> |
| <p><code>aad</code> is the additional authenticated data (AAD), if any.</p> |
| <p>On input, <code>in_out[ciphertext_and_tag]</code> must be the ciphertext followed |
| by the tag. When <code>open_within()</code> returns <code>Ok(plaintext)</code>, the plaintext |
| will be at <code>in_out[0..plaintext.len()]</code>. In other words, the following |
| two code fragments are equivalent for valid values of |
| <code>ciphertext_and_tag</code>, except <code>open_within</code> will often be more efficient:</p> |
| <div class="example-wrap"><pre class="language-skip"><code>let plaintext = key.open_within(aad, in_out, cipertext_and_tag)?;</code></pre></div><div class="example-wrap"><pre class="language-skip"><code>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])?;</code></pre></div> |
| <p>Similarly, <code>key.open_within(aad, in_out, 0..)</code> is equivalent to |
| <code>key.open_in_place(aad, in_out)</code>.</p> |
| <p>When <code>open_in_place()</code> returns <code>Err(..)</code>, <code>in_out</code> may have been |
| overwritten in an unspecified way.</p> |
| <p>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:</p> |
| <div class="example-wrap"><pre class="language-ascii-art"><code> 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”</code></pre></div> |
| <p>This reassembly be accomplished with three calls to <code>open_within()</code>.</p> |
| </div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-BoundKey%3CN%3E-for-OpeningKey%3CN%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/ring/aead.rs.html#73-85">source</a><a href="#impl-BoundKey%3CN%3E-for-OpeningKey%3CN%3E" class="anchor"></a><h3 class="code-header">impl<N: <a class="trait" href="trait.NonceSequence.html" title="trait ring::aead::NonceSequence">NonceSequence</a>> <a class="trait" href="trait.BoundKey.html" title="trait ring::aead::BoundKey">BoundKey</a><N> for <a class="struct" href="struct.OpeningKey.html" title="struct ring::aead::OpeningKey">OpeningKey</a><N></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/ring/aead.rs.html#74-79">source</a><a href="#method.new" class="anchor"></a><h4 class="code-header">fn <a href="trait.BoundKey.html#tymethod.new" class="fnname">new</a>(key: <a class="struct" href="struct.UnboundKey.html" title="struct ring::aead::UnboundKey">UnboundKey</a>, nonce_sequence: N) -> Self</h4></section></summary><div class='docblock'>Constructs a new key from the given <code>UnboundKey</code> and <code>NonceSequence</code>.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.algorithm" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/ring/aead.rs.html#82-84">source</a><a href="#method.algorithm" class="anchor"></a><h4 class="code-header">fn <a href="trait.BoundKey.html#tymethod.algorithm" class="fnname">algorithm</a>(&self) -> &'static <a class="struct" href="struct.Algorithm.html" title="struct ring::aead::Algorithm">Algorithm</a></h4></section></summary><div class='docblock'>The key’s AEAD algorithm.</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-OpeningKey%3CN%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/ring/aead.rs.html#87-93">source</a><a href="#impl-Debug-for-OpeningKey%3CN%3E" class="anchor"></a><h3 class="code-header">impl<N: <a class="trait" href="trait.NonceSequence.html" title="trait ring::aead::NonceSequence">NonceSequence</a>> Debug for <a class="struct" href="struct.OpeningKey.html" title="struct ring::aead::OpeningKey">OpeningKey</a><N></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/ring/aead.rs.html#88-92">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&self, f: &mut Formatter<'_>) -> Result<(), Error></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-OpeningKey%3CN%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-OpeningKey%3CN%3E" class="anchor"></a><h3 class="code-header">impl<N> RefUnwindSafe for <a class="struct" href="struct.OpeningKey.html" title="struct ring::aead::OpeningKey">OpeningKey</a><N><span class="where fmt-newline">where<br> N: RefUnwindSafe,</span></h3></section><section id="impl-Send-for-OpeningKey%3CN%3E" class="impl has-srclink"><a href="#impl-Send-for-OpeningKey%3CN%3E" class="anchor"></a><h3 class="code-header">impl<N> Send for <a class="struct" href="struct.OpeningKey.html" title="struct ring::aead::OpeningKey">OpeningKey</a><N><span class="where fmt-newline">where<br> N: Send,</span></h3></section><section id="impl-Sync-for-OpeningKey%3CN%3E" class="impl has-srclink"><a href="#impl-Sync-for-OpeningKey%3CN%3E" class="anchor"></a><h3 class="code-header">impl<N> Sync for <a class="struct" href="struct.OpeningKey.html" title="struct ring::aead::OpeningKey">OpeningKey</a><N><span class="where fmt-newline">where<br> N: Sync,</span></h3></section><section id="impl-Unpin-for-OpeningKey%3CN%3E" class="impl has-srclink"><a href="#impl-Unpin-for-OpeningKey%3CN%3E" class="anchor"></a><h3 class="code-header">impl<N> Unpin for <a class="struct" href="struct.OpeningKey.html" title="struct ring::aead::OpeningKey">OpeningKey</a><N><span class="where fmt-newline">where<br> N: Unpin,</span></h3></section><section id="impl-UnwindSafe-for-OpeningKey%3CN%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-OpeningKey%3CN%3E" class="anchor"></a><h3 class="code-header">impl<N> UnwindSafe for <a class="struct" href="struct.OpeningKey.html" title="struct ring::aead::OpeningKey">OpeningKey</a><N><span class="where fmt-newline">where<br> N: UnwindSafe,</span></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-OpeningKey%3CN%3E" class="impl has-srclink"><a href="#impl-Any-for-OpeningKey%3CN%3E" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-OpeningKey%3CN%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-OpeningKey%3CN%3E" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-OpeningKey%3CN%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-OpeningKey%3CN%3E" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-OpeningKey%3CN%3E" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-OpeningKey%3CN%3E" class="anchor"></a><h3 class="code-header">impl<T> From<T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-OpeningKey%3CN%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-OpeningKey%3CN%3E" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code>[From]<T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-OpeningKey%3CN%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-OpeningKey%3CN%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-OpeningKey%3CN%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-OpeningKey%3CN%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></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> |
