| <!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="The chacha20-poly1305@openssh.com AEAD-ish construct."><meta name="keywords" content="rust, rustlang, rust-lang, chacha20_poly1305_openssh"><title>ring::aead::chacha20_poly1305_openssh - 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">☰</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 chacha20_poly1305_openssh</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#constants">Constants</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 href="../index.html">aead</a>::<wbr><a class="mod" href="#">chacha20_poly1305_openssh</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/chacha20_poly1305_openssh.rs.html#15-189">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><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> |
| <p>This should only be used by SSH implementations. It has a similar, but |
| different API from <code>ring::aead</code> because the construct cannot use the same |
| API as <code>ring::aead</code> due to the way the construct handles the encrypted |
| packet length.</p> |
| <p>The concatenation of a and b is denoted <code>a||b</code>. <code>K_1</code> and <code>K_2</code> are defined |
| in the <a href="http://cvsweb.openbsd.org/cgi-bin/cvsweb/src/usr.bin/ssh/PROTOCOL.chacha20poly1305?annotate=HEAD">chacha20-poly1305@openssh.com</a> specification. <code>packet_length</code>, |
| <code>padding_length</code>, <code>payload</code>, and <code>random padding</code> are defined in |
| <a href="https://tools.ietf.org/html/rfc4253">RFC 4253</a>. The term <code>plaintext</code> is used as a shorthand for |
| <code>padding_length||payload||random padding</code>.</p> |
| </div></details><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.OpeningKey.html" title="ring::aead::chacha20_poly1305_openssh::OpeningKey struct">OpeningKey</a></div><div class="item-right docblock-short">A key for opening packets.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SealingKey.html" title="ring::aead::chacha20_poly1305_openssh::SealingKey struct">SealingKey</a></div><div class="item-right docblock-short">A key for sealing packets.</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.KEY_LEN.html" title="ring::aead::chacha20_poly1305_openssh::KEY_LEN constant">KEY_LEN</a></div><div class="item-right docblock-short">The length of key.</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.PACKET_LENGTH_LEN.html" title="ring::aead::chacha20_poly1305_openssh::PACKET_LENGTH_LEN constant">PACKET_LENGTH_LEN</a></div><div class="item-right docblock-short">The length in bytes of the <code>packet_length</code> field in a SSH packet.</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.TAG_LEN.html" title="ring::aead::chacha20_poly1305_openssh::TAG_LEN constant">TAG_LEN</a></div><div class="item-right docblock-short">The length in bytes of an authentication tag.</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> |
