Files
GopherGate/target/doc/openssl/derive/index.html
2026-02-26 12:00:21 -05:00

40 lines
6.7 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="Shared secret derivation."><title>openssl::derive - 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="openssl" 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 mod"><!--[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="#">Module derive</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../openssl/index.html">openssl</a><span class="version">0.10.75</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module derive</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li></ul><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate openssl</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">openssl</a></div><h1>Module <span>derive</span>&nbsp;<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/openssl/derive.rs.html#1-211">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Shared secret derivation.</p>
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
<p>The following example implements <a href="https://wiki.openssl.org/index.php/Elliptic_Curve_Diffie_Hellman">ECDH</a> using <code>NIST P-384</code> keys:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>openssl::bn::BigNumContext;
<span class="kw">use </span>openssl::pkey::PKey;
<span class="kw">use </span>openssl::derive::Deriver;
<span class="kw">use </span>openssl::ec::{EcGroup, EcKey, EcPoint, PointConversionForm};
<span class="kw">use </span>openssl::nid::Nid;
<span class="kw">let </span>group = EcGroup::from_curve_name(Nid::SECP384R1)<span class="question-mark">?</span>;
<span class="kw">let </span>first: PKey&lt;<span class="kw">_</span>&gt; = EcKey::generate(<span class="kw-2">&amp;</span>group)<span class="question-mark">?</span>.try_into()<span class="question-mark">?</span>;
<span class="comment">// second party generates an ephemeral key and derives
// a shared secret using first party's public key
</span><span class="kw">let </span>shared_key = EcKey::generate(<span class="kw-2">&amp;</span>group)<span class="question-mark">?</span>;
<span class="comment">// shared_public is sent to first party
</span><span class="kw">let </span><span class="kw-2">mut </span>ctx = BigNumContext::new()<span class="question-mark">?</span>;
<span class="kw">let </span>shared_public = shared_key.public_key().to_bytes(
<span class="kw-2">&amp;</span>group,
PointConversionForm::COMPRESSED,
<span class="kw-2">&amp;mut </span>ctx,
)<span class="question-mark">?</span>;
<span class="kw">let </span>shared_key: PKey&lt;<span class="kw">_</span>&gt; = shared_key.try_into()<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>deriver = Deriver::new(<span class="kw-2">&amp;</span>shared_key)<span class="question-mark">?</span>;
deriver.set_peer(<span class="kw-2">&amp;</span>first)<span class="question-mark">?</span>;
<span class="comment">// secret can be used e.g. as a symmetric encryption key
</span><span class="kw">let </span>secret = deriver.derive_to_vec()<span class="question-mark">?</span>;
<span class="comment">// first party derives the same shared secret using
// shared_public
</span><span class="kw">let </span>point = EcPoint::from_bytes(<span class="kw-2">&amp;</span>group, <span class="kw-2">&amp;</span>shared_public, <span class="kw-2">&amp;mut </span>ctx)<span class="question-mark">?</span>;
<span class="kw">let </span>recipient_key: PKey&lt;<span class="kw">_</span>&gt; = EcKey::from_public_key(<span class="kw-2">&amp;</span>group, <span class="kw-2">&amp;</span>point)<span class="question-mark">?</span>.try_into()<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>deriver = Deriver::new(<span class="kw-2">&amp;</span>first)<span class="question-mark">?</span>;
deriver.set_peer(<span class="kw-2">&amp;</span>recipient_key)<span class="question-mark">?</span>;
<span class="kw">let </span>first_secret = deriver.derive_to_vec()<span class="question-mark">?</span>;
<span class="macro">assert_eq!</span>(secret, first_secret);</code></pre></div></div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Deriver.html" title="struct openssl::derive::Deriver">Deriver</a></dt><dd>A type used to derive a shared secret between two keys.</dd></dl></section></div></main></body></html>