mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
35 lines
8.3 KiB
HTML
35 lines
8.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="API documentation for the Rust `aead` mod in crate `ring`."><meta name="keywords" content="rust, rustlang, rust-lang, aead"><title>ring::aead - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../ring/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module aead</p><div class="sidebar-elems"><div class="block items"><ul><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></div><p class="location"><a href="../index.html">ring</a></p><div id="sidebar-vars" data-name="aead" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">ring</a>::<wbr><a class="mod" href="">aead</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/ring/aead.rs.html#15-679" title="goto source code">[src]</a></span></h1><div class="docblock"><p>Authenticated Encryption with Associated Data (AEAD).</p>
|
||
<p>See <a href="http://www-cse.ucsd.edu/%7Emihir/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><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2>
|
||
<table><tr class="module-item"><td><a class="mod" href="chacha20_poly1305_openssh/index.html" title="ring::aead::chacha20_poly1305_openssh mod">chacha20_poly1305_openssh</a></td><td class="docblock-short"><p>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.</p>
|
||
</td></tr><tr class="module-item"><td><a class="mod" href="quic/index.html" title="ring::aead::quic mod">quic</a></td><td class="docblock-short"><p>QUIC Header Protection.</p>
|
||
</td></tr></table><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
||
<table><tr class="module-item"><td><a class="struct" href="struct.Aad.html" title="ring::aead::Aad struct">Aad</a></td><td class="docblock-short"><p>The additionally authenticated data (AAD) for an opening or sealing
|
||
operation. This data is authenticated but is <strong>not</strong> encrypted.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Algorithm.html" title="ring::aead::Algorithm struct">Algorithm</a></td><td class="docblock-short"><p>An AEAD Algorithm.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.LessSafeKey.html" title="ring::aead::LessSafeKey struct">LessSafeKey</a></td><td class="docblock-short"><p>Immutable keys for use in situations where <code>OpeningKey</code>/<code>SealingKey</code> and
|
||
<code>NonceSequence</code> cannot reasonably be used.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Nonce.html" title="ring::aead::Nonce struct">Nonce</a></td><td class="docblock-short"><p>A nonce for a single AEAD opening or sealing operation.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OpeningKey.html" title="ring::aead::OpeningKey struct">OpeningKey</a></td><td class="docblock-short"><p>An AEAD key for authenticating and decrypting ("opening"), bound to a nonce
|
||
sequence.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SealingKey.html" title="ring::aead::SealingKey struct">SealingKey</a></td><td class="docblock-short"><p>An AEAD key for encrypting and signing ("sealing"), bound to a nonce
|
||
sequence.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Tag.html" title="ring::aead::Tag struct">Tag</a></td><td class="docblock-short"><p>An authentication tag.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UnboundKey.html" title="ring::aead::UnboundKey struct">UnboundKey</a></td><td class="docblock-short"><p>An AEAD key without a designated role or nonce sequence.</p>
|
||
</td></tr></table><h2 id="constants" class="section-header"><a href="#constants">Constants</a></h2>
|
||
<table><tr class="module-item"><td><a class="constant" href="constant.MAX_TAG_LEN.html" title="ring::aead::MAX_TAG_LEN constant">MAX_TAG_LEN</a></td><td class="docblock-short"><p>The maximum length of a tag for the algorithms in this module.</p>
|
||
</td></tr><tr class="module-item"><td><a class="constant" href="constant.NONCE_LEN.html" title="ring::aead::NONCE_LEN constant">NONCE_LEN</a></td><td class="docblock-short"><p>All the AEADs we support use 96-bit nonces.</p>
|
||
</td></tr></table><h2 id="statics" class="section-header"><a href="#statics">Statics</a></h2>
|
||
<table><tr class="module-item"><td><a class="static" href="static.AES_128_GCM.html" title="ring::aead::AES_128_GCM static">AES_128_GCM</a></td><td class="docblock-short"><p>AES-128 in GCM mode with 128-bit tags and 96 bit nonces.</p>
|
||
</td></tr><tr class="module-item"><td><a class="static" href="static.AES_256_GCM.html" title="ring::aead::AES_256_GCM static">AES_256_GCM</a></td><td class="docblock-short"><p>AES-256 in GCM mode with 128-bit tags and 96 bit nonces.</p>
|
||
</td></tr><tr class="module-item"><td><a class="static" href="static.CHACHA20_POLY1305.html" title="ring::aead::CHACHA20_POLY1305 static">CHACHA20_POLY1305</a></td><td class="docblock-short"><p>ChaCha20-Poly1305 as described in <a href="https://tools.ietf.org/html/rfc7539">RFC 7539</a>.</p>
|
||
</td></tr></table><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2>
|
||
<table><tr class="module-item"><td><a class="trait" href="trait.BoundKey.html" title="ring::aead::BoundKey trait">BoundKey</a></td><td class="docblock-short"><p>An AEAD key bound to a nonce sequence.</p>
|
||
</td></tr><tr class="module-item"><td><a class="trait" href="trait.NonceSequence.html" title="ring::aead::NonceSequence trait">NonceSequence</a></td><td class="docblock-short"><p>A sequences of unique nonces.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="ring"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |