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

11 lines
5.5 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="The chacha20-poly1305@openssh.com AEAD-ish construct."><title>ring::aead::chacha20_poly1305_openssh - 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 chacha20_poly1305_openssh</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 chacha20_<wbr>poly1305_<wbr>openssh</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#constants" title="Constants">Constants</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In ring::<wbr>aead</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>::<wbr><a href="../index.html">aead</a></div><h1>Module <span>chacha20_<wbr>poly1305_<wbr>openssh</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/chacha20_poly1305_openssh.rs.html#15-212">Source</a> </span></div><details class="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="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.OpeningKey.html" title="struct ring::aead::chacha20_poly1305_openssh::OpeningKey">Opening<wbr>Key</a></dt><dd>A key for opening packets.</dd><dt><a class="struct" href="struct.SealingKey.html" title="struct ring::aead::chacha20_poly1305_openssh::SealingKey">Sealing<wbr>Key</a></dt><dd>A key for sealing packets.</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.KEY_LEN.html" title="constant ring::aead::chacha20_poly1305_openssh::KEY_LEN">KEY_LEN</a></dt><dd>The length of key.</dd><dt><a class="constant" href="constant.PACKET_LENGTH_LEN.html" title="constant ring::aead::chacha20_poly1305_openssh::PACKET_LENGTH_LEN">PACKET_<wbr>LENGTH_<wbr>LEN</a></dt><dd>The length in bytes of the <code>packet_length</code> field in a SSH packet.</dd><dt><a class="constant" href="constant.TAG_LEN.html" title="constant ring::aead::chacha20_poly1305_openssh::TAG_LEN">TAG_LEN</a></dt><dd>The length in bytes of an authentication tag.</dd></dl></section></div></main></body></html>