Files
GopherGate/target/doc/ring/aead/index.html
2026-02-26 12:00:21 -05:00

9 lines
7.3 KiB
HTML

<!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)."><title>ring::aead - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="ring" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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]--><rustdoc-topbar><h2><a href="#">Module aead</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../ring/index.html">ring</a><span class="version">0.17.14</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module aead</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#statics" title="Statics">Statics</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate ring</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">ring</a></div><h1>Module <span>aead</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/ring/aead.rs.html#15-186">Source</a> </span></div><details class="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="https://eprint.iacr.org/2000/025.pdf">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="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="chacha20_poly1305_openssh/index.html" title="mod ring::aead::chacha20_poly1305_openssh">chacha20_<wbr>poly1305_<wbr>openssh</a></dt><dd>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.</dd><dt><a class="mod" href="quic/index.html" title="mod ring::aead::quic">quic</a></dt><dd>QUIC Header Protection.</dd></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Aad.html" title="struct ring::aead::Aad">Aad</a></dt><dd>The additionally authenticated data (AAD) for an opening or sealing
operation. This data is authenticated but is <strong>not</strong> encrypted.</dd><dt><a class="struct" href="struct.Algorithm.html" title="struct ring::aead::Algorithm">Algorithm</a></dt><dd>An AEAD Algorithm.</dd><dt><a class="struct" href="struct.LessSafeKey.html" title="struct ring::aead::LessSafeKey">Less<wbr>Safe<wbr>Key</a></dt><dd>Immutable keys for use in situations where <code>OpeningKey</code>/<code>SealingKey</code> and
<code>NonceSequence</code> cannot reasonably be used.</dd><dt><a class="struct" href="struct.Nonce.html" title="struct ring::aead::Nonce">Nonce</a></dt><dd>A nonce for a single AEAD opening or sealing operation.</dd><dt><a class="struct" href="struct.OpeningKey.html" title="struct ring::aead::OpeningKey">Opening<wbr>Key</a></dt><dd>An AEAD key for authenticating and decrypting (“opening”), bound to a nonce
sequence.</dd><dt><a class="struct" href="struct.SealingKey.html" title="struct ring::aead::SealingKey">Sealing<wbr>Key</a></dt><dd>An AEAD key for encrypting and signing (“sealing”), bound to a nonce
sequence.</dd><dt><a class="struct" href="struct.Tag.html" title="struct ring::aead::Tag">Tag</a></dt><dd>A possibly valid authentication tag.</dd><dt><a class="struct" href="struct.UnboundKey.html" title="struct ring::aead::UnboundKey">Unbound<wbr>Key</a></dt><dd>An AEAD key without a designated role or nonce sequence.</dd></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.MAX_TAG_LEN.html" title="constant ring::aead::MAX_TAG_LEN">MAX_<wbr>TAG_<wbr>LEN</a></dt><dd>The maximum length of a tag for the algorithms in this module.</dd><dt><a class="constant" href="constant.NONCE_LEN.html" title="constant ring::aead::NONCE_LEN">NONCE_<wbr>LEN</a></dt><dd>All the AEADs we support use 96-bit nonces.</dd></dl><h2 id="statics" class="section-header">Statics<a href="#statics" class="anchor">§</a></h2><dl class="item-table"><dt><a class="static" href="static.AES_128_GCM.html" title="static ring::aead::AES_128_GCM">AES_<wbr>128_<wbr>GCM</a></dt><dd>AES-128 in GCM mode with 128-bit tags and 96 bit nonces.</dd><dt><a class="static" href="static.AES_256_GCM.html" title="static ring::aead::AES_256_GCM">AES_<wbr>256_<wbr>GCM</a></dt><dd>AES-256 in GCM mode with 128-bit tags and 96 bit nonces.</dd><dt><a class="static" href="static.CHACHA20_POLY1305.html" title="static ring::aead::CHACHA20_POLY1305">CHACH<wbr>A20_<wbr>POLY1305</a></dt><dd>ChaCha20-Poly1305 as described in <a href="https://tools.ietf.org/html/rfc8439">RFC 8439</a>.</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.BoundKey.html" title="trait ring::aead::BoundKey">Bound<wbr>Key</a></dt><dd>An AEAD key bound to a nonce sequence.</dd><dt><a class="trait" href="trait.NonceSequence.html" title="trait ring::aead::NonceSequence">Nonce<wbr>Sequence</a></dt><dd>A sequences of unique nonces.</dd></dl></section></div></main></body></html>