mirror of
https://gitlab.redox-os.org/CoffeeCode/redox-ssh.git
synced 2025-12-28 20:42:18 +01:00
130 lines
No EOL
7.9 KiB
HTML
130 lines
No EOL
7.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 `EphemeralPrivateKey` struct in crate `ring`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, EphemeralPrivateKey">
|
||
|
||
<title>ring::agreement::EphemeralPrivateKey - 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 EphemeralPrivateKey</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'>agreement</a></p><script>window.sidebarCurrent = {name: 'EphemeralPrivateKey', 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'>agreement</a>::<wbr><a class="struct" href=''>EphemeralPrivateKey</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/agreement.rs.html#102-105' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct EphemeralPrivateKey { /* fields omitted */ }</pre><div class='docblock'><p>An ephemeral private key for use (only) with <code>agree_ephemeral</code>. The
|
||
signature of <code>agree_ephemeral</code> ensures that an <code>EphemeralPrivateKey</code> can be
|
||
used for at most one key agreement.</p>
|
||
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl<'a> <a class="struct" href="../../ring/agreement/struct.EphemeralPrivateKey.html" title="struct ring::agreement::EphemeralPrivateKey">EphemeralPrivateKey</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ring/agreement.rs.html#107-148' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.generate' class="method"><span id='generate.v' class='invisible'><code>fn <a href='#method.generate' class='fnname'>generate</a>(<br> alg: &'static <a class="struct" href="../../ring/agreement/struct.Algorithm.html" title="struct ring::agreement::Algorithm">Algorithm</a>, <br> rng: &<a class="trait" href="../../ring/rand/trait.SecureRandom.html" title="trait ring::rand::SecureRandom">SecureRandom</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="struct" href="../../ring/agreement/struct.EphemeralPrivateKey.html" title="struct ring::agreement::EphemeralPrivateKey">EphemeralPrivateKey</a>, <a class="struct" href="../../ring/error/struct.Unspecified.html" title="struct ring::error::Unspecified">Unspecified</a>></code></span></h4>
|
||
<div class='docblock'><p>Generate a new ephemeral private key for the given algorithm.</p>
|
||
|
||
<p>C analog: <code>EC_KEY_new_by_curve_name</code> + <code>EC_KEY_generate_key</code>.</p>
|
||
</div><h4 id='method.algorithm' class="method"><span id='algorithm.v' class='invisible'><code>fn <a href='#method.algorithm' class='fnname'>algorithm</a>(&self) -> &'static <a class="struct" href="../../ring/agreement/struct.Algorithm.html" title="struct ring::agreement::Algorithm">Algorithm</a></code></span></h4>
|
||
<div class='docblock'><p>The key exchange algorithm.</p>
|
||
</div><h4 id='method.public_key_len' class="method"><span id='public_key_len.v' class='invisible'><code>fn <a href='#method.public_key_len' class='fnname'>public_key_len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></h4>
|
||
<div class='docblock'><p>The size in bytes of the encoded public key.</p>
|
||
</div><h4 id='method.compute_public_key' class="method"><span id='compute_public_key.v' class='invisible'><code>fn <a href='#method.compute_public_key' class='fnname'>compute_public_key</a>(&self, out: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&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>) -> <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.tuple.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>Computes the public key from the private key's value and fills <code>out</code>
|
||
with the public point encoded in the standard form for the algorithm.</p>
|
||
|
||
<p><code>out.len()</code> must be equal to the value returned by <code>public_key_len</code>.</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> |