mirror of
https://gitlab.redox-os.org/CoffeeCode/redox-ssh.git
synced 2025-12-29 04:02:18 +01:00
132 lines
No EOL
8.9 KiB
HTML
132 lines
No EOL
8.9 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 `OpeningKey` struct in crate `ring`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, OpeningKey">
|
||
|
||
<title>ring::aead::chacha20_poly1305_openssh::OpeningKey - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../../normalize.css">
|
||
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
|
||
<link rel="stylesheet" type="text/css" href="../../../main.css">
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc struct">
|
||
<!--[if lte IE 8]>
|
||
<div class="warning">
|
||
This old browser is unsupported and will most likely display funky
|
||
things.
|
||
</div>
|
||
<![endif]-->
|
||
|
||
|
||
|
||
<nav class="sidebar">
|
||
|
||
<p class='location'>Struct OpeningKey</p><div class="block items"><ul><li><a href="#methods">Methods</a></li></ul></div><p class='location'><a href='../../index.html'>ring</a>::<wbr><a href='../index.html'>aead</a>::<wbr><a href='index.html'>chacha20_poly1305_openssh</a></p><script>window.sidebarCurrent = {name: 'OpeningKey', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
|
||
</nav>
|
||
|
||
<nav class="sub">
|
||
<form class="search-form js-only">
|
||
<div class="search-container">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content">
|
||
<h1 class='fqn'><span class='in-band'>Struct <a href='../../index.html'>ring</a>::<wbr><a href='../index.html'>aead</a>::<wbr><a href='index.html'>chacha20_poly1305_openssh</a>::<wbr><a class="struct" href=''>OpeningKey</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/chacha20_poly1305_openssh.rs.html#76-78' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct OpeningKey { /* fields omitted */ }</pre><div class='docblock'><p>A key for opening packets.</p>
|
||
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../../../ring/aead/chacha20_poly1305_openssh/struct.OpeningKey.html" title="struct ring::aead::chacha20_poly1305_openssh::OpeningKey">OpeningKey</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/ring/aead/chacha20_poly1305_openssh.rs.html#80-131' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>fn <a href='#method.new' class='fnname'>new</a>(key_material: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 64]</a>) -> <a class="struct" href="../../../ring/aead/chacha20_poly1305_openssh/struct.OpeningKey.html" title="struct ring::aead::chacha20_poly1305_openssh::OpeningKey">OpeningKey</a></code></span></h4>
|
||
<div class='docblock'><p>Constructs a new <code>OpeningKey</code>.</p>
|
||
</div><h4 id='method.decrypt_packet_length' class="method"><span id='decrypt_packet_length.v' class='invisible'><code>fn <a href='#method.decrypt_packet_length' class='fnname'>decrypt_packet_length</a>(<br> &self, <br> sequence_number: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> encrypted_packet_length: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 4]</a><br>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 4]</a></code></span></h4>
|
||
<div class='docblock'><p>Returns the decrypted, but unauthenticated, packet length.</p>
|
||
|
||
<p>Importantly, the result won't be authenticated until <code>open_in_place</code> is
|
||
called.</p>
|
||
</div><h4 id='method.open_in_place' class="method"><span id='open_in_place.v' class='invisible'><code>fn <a href='#method.open_in_place' class='fnname'>open_in_place</a><'a>(<br> &self, <br> sequence_number: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> ciphertext_in_plaintext_out: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br> tag: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 16]</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <a class="struct" href="../../../ring/error/struct.Unspecified.html" title="struct ring::error::Unspecified">Unspecified</a>></code></span></h4>
|
||
<div class='docblock'><p>Opens (authenticates and decrypts) a packet.</p>
|
||
|
||
<p><code>ciphertext_in_plaintext_out</code> must be of the form
|
||
<code>encrypted_packet_length||ciphertext</code> where <code>ciphertext</code> is the
|
||
encrypted <code>plaintext</code>. When the function succeeds the ciphertext is
|
||
replaced by the plaintext and the result is <code>Ok(plaintext)</code>, where
|
||
<code>plaintext</code> is <code>&ciphertext_in_plaintext_out[PACKET_LENGTH_LEN..]</code>;
|
||
otherwise the contents of <code>ciphertext_in_plaintext_out</code> are unspecified
|
||
and must not be used.</p>
|
||
</div></div></section>
|
||
<section id='search' class="content hidden"></section>
|
||
|
||
<section class="footer"></section>
|
||
|
||
<aside id="help" class="hidden">
|
||
<div>
|
||
<h1 class="hidden">Help</h1>
|
||
|
||
<div class="shortcuts">
|
||
<h2>Keyboard Shortcuts</h2>
|
||
|
||
<dl>
|
||
<dt>?</dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt>S</dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt>⇤</dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt>⇥</dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt>⏎</dt>
|
||
<dd>Go to active search result</dd>
|
||
<dt>+</dt>
|
||
<dd>Collapse/expand all sections</dd>
|
||
</dl>
|
||
</div>
|
||
|
||
<div class="infos">
|
||
<h2>Search Tricks</h2>
|
||
|
||
<p>
|
||
Prefix searches with a type followed by a colon (e.g.
|
||
<code>fn:</code>) to restrict the search to a given type.
|
||
</p>
|
||
|
||
<p>
|
||
Accepted types are: <code>fn</code>, <code>mod</code>,
|
||
<code>struct</code>, <code>enum</code>,
|
||
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
||
and <code>const</code>.
|
||
</p>
|
||
|
||
<p>
|
||
Search functions by type signature (e.g.
|
||
<code>vec -> usize</code> or <code>* -> vec</code>)
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../../../";
|
||
window.currentCrate = "ring";
|
||
</script>
|
||
<script src="../../../jquery.js"></script>
|
||
<script src="../../../main.js"></script>
|
||
<script defer src="../../../search-index.js"></script>
|
||
</body>
|
||
</html> |