19 lines
5.1 KiB
HTML
19 lines
5.1 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="Performs a key agreement with an ephemeral private key and the given public key."><title>agree_ephemeral in ring::agreement - 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 fn"><!--[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="#">agree_ephemeral</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"><div id="rustdoc-modnav"><h2><a href="index.html">In ring::<wbr>agreement</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">agreement</a></div><h1>Function <span class="fn">agree_<wbr>ephemeral</span> <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/agreement.rs.html#253-263">Source</a> </span></div><pre class="rust item-decl"><code>pub fn agree_ephemeral<B: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]>, R>(
|
||
my_private_key: <a class="struct" href="struct.EphemeralPrivateKey.html" title="struct ring::agreement::EphemeralPrivateKey">EphemeralPrivateKey</a>,
|
||
peer_public_key: &<a class="struct" href="struct.UnparsedPublicKey.html" title="struct ring::agreement::UnparsedPublicKey">UnparsedPublicKey</a><B>,
|
||
kdf: impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]) -> R,
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><R, <a class="struct" href="../error/struct.Unspecified.html" title="struct ring::error::Unspecified">Unspecified</a>></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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</code> is the peer’s public key. <code>agree_ephemeral</code> will return
|
||
<code>Err(error_value)</code> if it does not match <code>my_private_key's</code> algorithm/curve.
|
||
<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>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>
|
||
</div></details></section></div></main></body></html> |