OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
c845eb3e1f76e51dbe2d22f3712ac4520d181f7d
google-apis-rs/ring/aead/chacha20_poly1305_openssh/index.html
Sebastian Thiel 37ba635de2 Update documentation
2021-04-02 00:20:57 +08:00

22 lines
6.1 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `chacha20_poly1305_openssh` mod in crate `ring`."><meta name="keywords" content="rust, rustlang, rust-lang, chacha20_poly1305_openssh"><title>ring::aead::chacha20_poly1305_openssh - 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">&#9776;</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 chacha20_poly1305_openssh</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#constants">Constants</a></li></ul></div><p class="location"><a href="../../index.html">ring</a>::<wbr><a href="../index.html">aead</a></p><div id="sidebar-vars" data-name="chacha20_poly1305_openssh" 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 href="../index.html">aead</a>::<wbr><a class="mod" href="">chacha20_poly1305_openssh</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">&#x2212;</span>]</a></span><a class="srclink" href="../../../src/ring/aead/chacha20_poly1305_openssh.rs.html#15-189" title="goto source code">[src]</a></span></h1><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><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<table><tr class="module-item"><td><a class="struct" href="struct.OpeningKey.html" title="ring::aead::chacha20_poly1305_openssh::OpeningKey struct">OpeningKey</a></td><td class="docblock-short"><p>A key for opening packets.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SealingKey.html" title="ring::aead::chacha20_poly1305_openssh::SealingKey struct">SealingKey</a></td><td class="docblock-short"><p>A key for sealing packets.</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.KEY_LEN.html" title="ring::aead::chacha20_poly1305_openssh::KEY_LEN constant">KEY_LEN</a></td><td class="docblock-short"><p>The length of key.</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.PACKET_LENGTH_LEN.html" title="ring::aead::chacha20_poly1305_openssh::PACKET_LENGTH_LEN constant">PACKET_LENGTH_LEN</a></td><td class="docblock-short"><p>The length in bytes of the <code>packet_length</code> field in a SSH packet.</p>
</td></tr><tr class="module-item"><td><a class="constant" href="constant.TAG_LEN.html" title="ring::aead::chacha20_poly1305_openssh::TAG_LEN constant">TAG_LEN</a></td><td class="docblock-short"><p>The length in bytes of an authentication tag.</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>
Reference in New Issue View Git Blame Copy Permalink