blob: 71642dbd799baf1ddd6f94df4624cd7cf2332b84 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Authenticated Encryption with Associated Data (AEAD)."><meta name="keywords" content="rust, rustlang, rust-lang, aead"><title>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="../../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 mod"><!--[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">&#9776;</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="#">Module aead</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#constants">Constants</a></li><li><a href="#statics">Statics</a></li><li><a href="#traits">Traits</a></li></ul></section></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">Module <a href="../index.html">ring</a>::<wbr><a class="mod" href="#">aead</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#15-679">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Authenticated Encryption with Associated Data (AEAD).</p>
<p>See <a href="http://www-cse.ucsd.edu/~mihir/papers/oem.html">Authenticated encryption: relations among notions and analysis of the
generic composition paradigm</a> for an introduction to the concept of
AEADs.</p>
</div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="chacha20_poly1305_openssh/index.html" title="ring::aead::chacha20_poly1305_openssh mod">chacha20_poly1305_openssh</a></div><div class="item-right docblock-short">The <a href="http://cvsweb.openbsd.org/cgi-bin/cvsweb/src/usr.bin/ssh/PROTOCOL.chacha20poly1305?annotate=HEAD">chacha20-poly1305@openssh.com</a> AEAD-ish construct.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="quic/index.html" title="ring::aead::quic mod">quic</a></div><div class="item-right docblock-short">QUIC Header Protection.</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Aad.html" title="ring::aead::Aad struct">Aad</a></div><div class="item-right docblock-short">The additionally authenticated data (AAD) for an opening or sealing
operation. This data is authenticated but is <strong>not</strong> encrypted.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Algorithm.html" title="ring::aead::Algorithm struct">Algorithm</a></div><div class="item-right docblock-short">An AEAD Algorithm.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.LessSafeKey.html" title="ring::aead::LessSafeKey struct">LessSafeKey</a></div><div class="item-right docblock-short">Immutable keys for use in situations where <code>OpeningKey</code>/<code>SealingKey</code> and
<code>NonceSequence</code> cannot reasonably be used.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Nonce.html" title="ring::aead::Nonce struct">Nonce</a></div><div class="item-right docblock-short">A nonce for a single AEAD opening or sealing operation.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OpeningKey.html" title="ring::aead::OpeningKey struct">OpeningKey</a></div><div class="item-right docblock-short">An AEAD key for authenticating and decrypting (“opening”), bound to a nonce
sequence.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SealingKey.html" title="ring::aead::SealingKey struct">SealingKey</a></div><div class="item-right docblock-short">An AEAD key for encrypting and signing (“sealing”), bound to a nonce
sequence.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Tag.html" title="ring::aead::Tag struct">Tag</a></div><div class="item-right docblock-short">An authentication tag.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UnboundKey.html" title="ring::aead::UnboundKey struct">UnboundKey</a></div><div class="item-right docblock-short">An AEAD key without a designated role or nonce sequence.</div></div></div><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.MAX_TAG_LEN.html" title="ring::aead::MAX_TAG_LEN constant">MAX_TAG_LEN</a></div><div class="item-right docblock-short">The maximum length of a tag for the algorithms in this module.</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.NONCE_LEN.html" title="ring::aead::NONCE_LEN constant">NONCE_LEN</a></div><div class="item-right docblock-short">All the AEADs we support use 96-bit nonces.</div></div></div><h2 id="statics" class="small-section-header"><a href="#statics">Statics</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="static" href="static.AES_128_GCM.html" title="ring::aead::AES_128_GCM static">AES_128_GCM</a></div><div class="item-right docblock-short">AES-128 in GCM mode with 128-bit tags and 96 bit nonces.</div></div><div class="item-row"><div class="item-left module-item"><a class="static" href="static.AES_256_GCM.html" title="ring::aead::AES_256_GCM static">AES_256_GCM</a></div><div class="item-right docblock-short">AES-256 in GCM mode with 128-bit tags and 96 bit nonces.</div></div><div class="item-row"><div class="item-left module-item"><a class="static" href="static.CHACHA20_POLY1305.html" title="ring::aead::CHACHA20_POLY1305 static">CHACHA20_POLY1305</a></div><div class="item-right docblock-short">ChaCha20-Poly1305 as described in <a href="https://tools.ietf.org/html/rfc7539">RFC 7539</a>.</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.BoundKey.html" title="ring::aead::BoundKey trait">BoundKey</a></div><div class="item-right docblock-short">An AEAD key bound to a nonce sequence.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.NonceSequence.html" title="ring::aead::NonceSequence trait">NonceSequence</a></div><div class="item-right docblock-short">A sequences of unique nonces.</div></div></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>