mirror of
https://gitlab.redox-os.org/CoffeeCode/redox-ssh.git
synced 2025-12-29 00:22:19 +01:00
138 lines
No EOL
6.8 KiB
HTML
138 lines
No EOL
6.8 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 `agree_ephemeral` fn in crate `ring`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, agree_ephemeral">
|
||
|
||
<title>ring::agreement::agree_ephemeral - 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 fn">
|
||
<!--[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'><a href='../index.html'>ring</a>::<wbr><a href='index.html'>agreement</a></p><script>window.sidebarCurrent = {name: 'agree_ephemeral', ty: 'fn', 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'>Function <a href='../index.html'>ring</a>::<wbr><a href='index.html'>agreement</a>::<wbr><a class="fn" href=''>agree_ephemeral</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#175-217' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust fn'>pub fn agree_ephemeral<F, R, E>(<br> my_private_key: <a class="struct" href="../../ring/agreement/struct.EphemeralPrivateKey.html" title="struct ring::agreement::EphemeralPrivateKey">EphemeralPrivateKey</a>, <br> peer_public_key_alg: &<a class="struct" href="../../ring/agreement/struct.Algorithm.html" title="struct ring::agreement::Algorithm">Algorithm</a>, <br> peer_public_key: <a class="struct" href="../../untrusted/struct.Input.html" title="struct untrusted::Input">Input</a>, <br> error_value: E, <br> kdf: F<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><R, E> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/trait.FnOnce.html" title="trait core::ops::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.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.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><R, E>, </span></pre><div class='docblock'><p>Performs a key agreement with an ephemeral private key and the given public
|
||
key.</p>
|
||
|
||
<p><code>my_private_key</code> is the ephemeral private key to use. Since it is moved, it
|
||
will not be usable after calling <code>agree_ephemeral</code>, thus guaranteeing that
|
||
the key is used for only one key agreement.</p>
|
||
|
||
<p><code>peer_public_key_alg</code> is the algorithm/curve for the peer's public key
|
||
point; <code>agree_ephemeral</code> will return <code>Err(error_value)</code> if it does not
|
||
match <code>my_private_key's</code> algorithm/curve.</p>
|
||
|
||
<p><code>peer_public_key</code> is the peer's public key. <code>agree_ephemeral</code> verifies that
|
||
it is encoded in the standard form for the algorithm and that the key is
|
||
<em>valid</em>; see the algorithm's documentation for details on how keys are to
|
||
be encoded and what constitutes a valid key for that algorithm.</p>
|
||
|
||
<p><code>error_value</code> is the value to return if an error occurs before <code>kdf</code> is
|
||
called, e.g. when decoding of the peer's public key fails or when the public
|
||
key is otherwise invalid.</p>
|
||
|
||
<p>After the key agreement is done, <code>agree_ephemeral</code> calls <code>kdf</code> with the raw
|
||
key material from the key agreement operation and then returns what <code>kdf</code>
|
||
returns.</p>
|
||
|
||
<p>C analogs: <code>EC_POINT_oct2point</code> + <code>ECDH_compute_key</code>, <code>X25519</code>.</p>
|
||
</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> |