mpvrc/src/openssl/derive.rs.html
2025-02-05 00:14:38 +00:00

435 lines
No EOL
20 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="Source of the Rust file `/home/runner/.cargo/registry/src/index.crates.io-6f17d22bba15001f/openssl-0.10.70/src/derive.rs`."><title>derive.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../../static.files/src-script-56102188.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">openssl/</div>derive.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers">
<a href="#1" id="1">1</a>
<a href="#2" id="2">2</a>
<a href="#3" id="3">3</a>
<a href="#4" id="4">4</a>
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
<a href="#8" id="8">8</a>
<a href="#9" id="9">9</a>
<a href="#10" id="10">10</a>
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
<a href="#14" id="14">14</a>
<a href="#15" id="15">15</a>
<a href="#16" id="16">16</a>
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
<a href="#20" id="20">20</a>
<a href="#21" id="21">21</a>
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
<a href="#26" id="26">26</a>
<a href="#27" id="27">27</a>
<a href="#28" id="28">28</a>
<a href="#29" id="29">29</a>
<a href="#30" id="30">30</a>
<a href="#31" id="31">31</a>
<a href="#32" id="32">32</a>
<a href="#33" id="33">33</a>
<a href="#34" id="34">34</a>
<a href="#35" id="35">35</a>
<a href="#36" id="36">36</a>
<a href="#37" id="37">37</a>
<a href="#38" id="38">38</a>
<a href="#39" id="39">39</a>
<a href="#40" id="40">40</a>
<a href="#41" id="41">41</a>
<a href="#42" id="42">42</a>
<a href="#43" id="43">43</a>
<a href="#44" id="44">44</a>
<a href="#45" id="45">45</a>
<a href="#46" id="46">46</a>
<a href="#47" id="47">47</a>
<a href="#48" id="48">48</a>
<a href="#49" id="49">49</a>
<a href="#50" id="50">50</a>
<a href="#51" id="51">51</a>
<a href="#52" id="52">52</a>
<a href="#53" id="53">53</a>
<a href="#54" id="54">54</a>
<a href="#55" id="55">55</a>
<a href="#56" id="56">56</a>
<a href="#57" id="57">57</a>
<a href="#58" id="58">58</a>
<a href="#59" id="59">59</a>
<a href="#60" id="60">60</a>
<a href="#61" id="61">61</a>
<a href="#62" id="62">62</a>
<a href="#63" id="63">63</a>
<a href="#64" id="64">64</a>
<a href="#65" id="65">65</a>
<a href="#66" id="66">66</a>
<a href="#67" id="67">67</a>
<a href="#68" id="68">68</a>
<a href="#69" id="69">69</a>
<a href="#70" id="70">70</a>
<a href="#71" id="71">71</a>
<a href="#72" id="72">72</a>
<a href="#73" id="73">73</a>
<a href="#74" id="74">74</a>
<a href="#75" id="75">75</a>
<a href="#76" id="76">76</a>
<a href="#77" id="77">77</a>
<a href="#78" id="78">78</a>
<a href="#79" id="79">79</a>
<a href="#80" id="80">80</a>
<a href="#81" id="81">81</a>
<a href="#82" id="82">82</a>
<a href="#83" id="83">83</a>
<a href="#84" id="84">84</a>
<a href="#85" id="85">85</a>
<a href="#86" id="86">86</a>
<a href="#87" id="87">87</a>
<a href="#88" id="88">88</a>
<a href="#89" id="89">89</a>
<a href="#90" id="90">90</a>
<a href="#91" id="91">91</a>
<a href="#92" id="92">92</a>
<a href="#93" id="93">93</a>
<a href="#94" id="94">94</a>
<a href="#95" id="95">95</a>
<a href="#96" id="96">96</a>
<a href="#97" id="97">97</a>
<a href="#98" id="98">98</a>
<a href="#99" id="99">99</a>
<a href="#100" id="100">100</a>
<a href="#101" id="101">101</a>
<a href="#102" id="102">102</a>
<a href="#103" id="103">103</a>
<a href="#104" id="104">104</a>
<a href="#105" id="105">105</a>
<a href="#106" id="106">106</a>
<a href="#107" id="107">107</a>
<a href="#108" id="108">108</a>
<a href="#109" id="109">109</a>
<a href="#110" id="110">110</a>
<a href="#111" id="111">111</a>
<a href="#112" id="112">112</a>
<a href="#113" id="113">113</a>
<a href="#114" id="114">114</a>
<a href="#115" id="115">115</a>
<a href="#116" id="116">116</a>
<a href="#117" id="117">117</a>
<a href="#118" id="118">118</a>
<a href="#119" id="119">119</a>
<a href="#120" id="120">120</a>
<a href="#121" id="121">121</a>
<a href="#122" id="122">122</a>
<a href="#123" id="123">123</a>
<a href="#124" id="124">124</a>
<a href="#125" id="125">125</a>
<a href="#126" id="126">126</a>
<a href="#127" id="127">127</a>
<a href="#128" id="128">128</a>
<a href="#129" id="129">129</a>
<a href="#130" id="130">130</a>
<a href="#131" id="131">131</a>
<a href="#132" id="132">132</a>
<a href="#133" id="133">133</a>
<a href="#134" id="134">134</a>
<a href="#135" id="135">135</a>
<a href="#136" id="136">136</a>
<a href="#137" id="137">137</a>
<a href="#138" id="138">138</a>
<a href="#139" id="139">139</a>
<a href="#140" id="140">140</a>
<a href="#141" id="141">141</a>
<a href="#142" id="142">142</a>
<a href="#143" id="143">143</a>
<a href="#144" id="144">144</a>
<a href="#145" id="145">145</a>
<a href="#146" id="146">146</a>
<a href="#147" id="147">147</a>
<a href="#148" id="148">148</a>
<a href="#149" id="149">149</a>
<a href="#150" id="150">150</a>
<a href="#151" id="151">151</a>
<a href="#152" id="152">152</a>
<a href="#153" id="153">153</a>
<a href="#154" id="154">154</a>
<a href="#155" id="155">155</a>
<a href="#156" id="156">156</a>
<a href="#157" id="157">157</a>
<a href="#158" id="158">158</a>
<a href="#159" id="159">159</a>
<a href="#160" id="160">160</a>
<a href="#161" id="161">161</a>
<a href="#162" id="162">162</a>
<a href="#163" id="163">163</a>
<a href="#164" id="164">164</a>
<a href="#165" id="165">165</a>
<a href="#166" id="166">166</a>
<a href="#167" id="167">167</a>
<a href="#168" id="168">168</a>
<a href="#169" id="169">169</a>
<a href="#170" id="170">170</a>
<a href="#171" id="171">171</a>
<a href="#172" id="172">172</a>
<a href="#173" id="173">173</a>
<a href="#174" id="174">174</a>
<a href="#175" id="175">175</a>
<a href="#176" id="176">176</a>
<a href="#177" id="177">177</a>
<a href="#178" id="178">178</a>
<a href="#179" id="179">179</a>
<a href="#180" id="180">180</a>
<a href="#181" id="181">181</a>
<a href="#182" id="182">182</a>
<a href="#183" id="183">183</a>
<a href="#184" id="184">184</a>
<a href="#185" id="185">185</a>
<a href="#186" id="186">186</a>
<a href="#187" id="187">187</a>
<a href="#188" id="188">188</a>
<a href="#189" id="189">189</a>
<a href="#190" id="190">190</a>
<a href="#191" id="191">191</a>
<a href="#192" id="192">192</a>
<a href="#193" id="193">193</a>
<a href="#194" id="194">194</a>
<a href="#195" id="195">195</a>
<a href="#196" id="196">196</a>
<a href="#197" id="197">197</a>
<a href="#198" id="198">198</a>
<a href="#199" id="199">199</a>
<a href="#200" id="200">200</a>
<a href="#201" id="201">201</a>
<a href="#202" id="202">202</a>
<a href="#203" id="203">203</a>
<a href="#204" id="204">204</a>
<a href="#205" id="205">205</a>
<a href="#206" id="206">206</a>
<a href="#207" id="207">207</a>
<a href="#208" id="208">208</a>
<a href="#209" id="209">209</a>
<a href="#210" id="210">210</a>
<a href="#211" id="211">211</a>
<a href="#212" id="212">212</a>
<a href="#213" id="213">213</a>
<a href="#214" id="214">214</a>
<a href="#215" id="215">215</a>
<a href="#216" id="216">216</a>
<a href="#217" id="217">217</a></pre></div><pre class="rust"><code><span class="doccomment">//! Shared secret derivation.
//!
//! # Example
//!
//! The following example implements [ECDH] using `NIST P-384` keys:
//!
//! ```
//! # fn main() -&gt; Result&lt;(), Box&lt;dyn std::error::Error&gt;&gt; {
//! # use std::convert::TryInto;
//! use openssl::bn::BigNumContext;
//! use openssl::pkey::PKey;
//! use openssl::derive::Deriver;
//! use openssl::ec::{EcGroup, EcKey, EcPoint, PointConversionForm};
//! use openssl::nid::Nid;
//!
//! let group = EcGroup::from_curve_name(Nid::SECP384R1)?;
//!
//! let first: PKey&lt;_&gt; = EcKey::generate(&amp;group)?.try_into()?;
//!
//! // second party generates an ephemeral key and derives
//! // a shared secret using first party's public key
//! let shared_key = EcKey::generate(&amp;group)?;
//! // shared_public is sent to first party
//! let mut ctx = BigNumContext::new()?;
//! let shared_public = shared_key.public_key().to_bytes(
//! &amp;group,
//! PointConversionForm::COMPRESSED,
//! &amp;mut ctx,
//! )?;
//!
//! let shared_key: PKey&lt;_&gt; = shared_key.try_into()?;
//! let mut deriver = Deriver::new(&amp;shared_key)?;
//! deriver.set_peer(&amp;first)?;
//! // secret can be used e.g. as a symmetric encryption key
//! let secret = deriver.derive_to_vec()?;
//! # drop(deriver);
//!
//! // first party derives the same shared secret using
//! // shared_public
//! let point = EcPoint::from_bytes(&amp;group, &amp;shared_public, &amp;mut ctx)?;
//! let recipient_key: PKey&lt;_&gt; = EcKey::from_public_key(&amp;group, &amp;point)?.try_into()?;
//! let mut deriver = Deriver::new(&amp;first)?;
//! deriver.set_peer(&amp;recipient_key)?;
//! let first_secret = deriver.derive_to_vec()?;
//!
//! assert_eq!(secret, first_secret);
//! # Ok(()) }
//! ```
//!
//! [ECDH]: https://wiki.openssl.org/index.php/Elliptic_Curve_Diffie_Hellman
</span><span class="kw">use </span>foreign_types::ForeignTypeRef;
<span class="kw">use </span>std::marker::PhantomData;
<span class="kw">use </span>std::ptr;
<span class="kw">use </span><span class="kw">crate</span>::error::ErrorStack;
<span class="kw">use </span><span class="kw">crate</span>::pkey::{HasPrivate, HasPublic, PKeyRef};
<span class="kw">use crate</span>::{cvt, cvt_p};
<span class="kw">use </span>openssl_macros::corresponds;
<span class="doccomment">/// A type used to derive a shared secret between two keys.
</span><span class="kw">pub struct </span>Deriver&lt;<span class="lifetime">'a</span>&gt;(<span class="kw-2">*mut </span>ffi::EVP_PKEY_CTX, PhantomData&lt;<span class="kw-2">&amp;</span><span class="lifetime">'a </span>()&gt;);
<span class="kw">unsafe impl </span>Sync <span class="kw">for </span>Deriver&lt;<span class="lifetime">'_</span>&gt; {}
<span class="kw">unsafe impl </span>Send <span class="kw">for </span>Deriver&lt;<span class="lifetime">'_</span>&gt; {}
<span class="attr">#[allow(clippy::len_without_is_empty)]
</span><span class="kw">impl</span>&lt;<span class="lifetime">'a</span>&gt; Deriver&lt;<span class="lifetime">'a</span>&gt; {
<span class="doccomment">/// Creates a new `Deriver` using the provided private key.
///
/// This corresponds to [`EVP_PKEY_derive_init`].
///
/// [`EVP_PKEY_derive_init`]: https://www.openssl.org/docs/manmaster/crypto/EVP_PKEY_derive_init.html
</span><span class="kw">pub fn </span>new&lt;T&gt;(key: <span class="kw-2">&amp;</span><span class="lifetime">'a </span>PKeyRef&lt;T&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;Deriver&lt;<span class="lifetime">'a</span>&gt;, ErrorStack&gt;
<span class="kw">where
</span>T: HasPrivate,
{
<span class="kw">unsafe </span>{
cvt_p(ffi::EVP_PKEY_CTX_new(key.as_ptr(), ptr::null_mut()))
.map(|p| Deriver(p, PhantomData))
.and_then(|ctx| cvt(ffi::EVP_PKEY_derive_init(ctx.<span class="number">0</span>)).map(|<span class="kw">_</span>| ctx))
}
}
<span class="doccomment">/// Sets the peer key used for secret derivation.
</span><span class="attr">#[corresponds(EVP_PKEY_derive_set_peer)]
</span><span class="kw">pub fn </span>set_peer&lt;T&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, key: <span class="kw-2">&amp;</span><span class="lifetime">'a </span>PKeyRef&lt;T&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;(), ErrorStack&gt;
<span class="kw">where
</span>T: HasPublic,
{
<span class="kw">unsafe </span>{ cvt(ffi::EVP_PKEY_derive_set_peer(<span class="self">self</span>.<span class="number">0</span>, key.as_ptr())).map(|<span class="kw">_</span>| ()) }
}
<span class="doccomment">/// Sets the peer key used for secret derivation along with optionally validating the peer public key.
///
/// Requires OpenSSL 3.0.0 or newer.
</span><span class="attr">#[corresponds(EVP_PKEY_derive_set_peer_ex)]
#[cfg(ossl300)]
</span><span class="kw">pub fn </span>set_peer_ex&lt;T&gt;(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
key: <span class="kw-2">&amp;</span><span class="lifetime">'a </span>PKeyRef&lt;T&gt;,
validate_peer: bool,
) -&gt; <span class="prelude-ty">Result</span>&lt;(), ErrorStack&gt;
<span class="kw">where
</span>T: HasPublic,
{
<span class="kw">unsafe </span>{
cvt(ffi::EVP_PKEY_derive_set_peer_ex(
<span class="self">self</span>.<span class="number">0</span>,
key.as_ptr(),
validate_peer <span class="kw">as </span>i32,
))
.map(|<span class="kw">_</span>| ())
}
}
<span class="doccomment">/// Returns the size of the shared secret.
///
/// It can be used to size the buffer passed to [`Deriver::derive`].
///
/// This corresponds to [`EVP_PKEY_derive`].
///
/// [`Deriver::derive`]: #method.derive
/// [`EVP_PKEY_derive`]: https://www.openssl.org/docs/manmaster/crypto/EVP_PKEY_derive_init.html
</span><span class="kw">pub fn </span>len(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;usize, ErrorStack&gt; {
<span class="kw">unsafe </span>{
<span class="kw">let </span><span class="kw-2">mut </span>len = <span class="number">0</span>;
cvt(ffi::EVP_PKEY_derive(<span class="self">self</span>.<span class="number">0</span>, ptr::null_mut(), <span class="kw-2">&amp;mut </span>len)).map(|<span class="kw">_</span>| len)
}
}
<span class="doccomment">/// Derives a shared secret between the two keys, writing it into the buffer.
///
/// Returns the number of bytes written.
///
/// This corresponds to [`EVP_PKEY_derive`].
///
/// [`EVP_PKEY_derive`]: https://www.openssl.org/docs/manmaster/crypto/EVP_PKEY_derive_init.html
</span><span class="kw">pub fn </span>derive(<span class="kw-2">&amp;mut </span><span class="self">self</span>, buf: <span class="kw-2">&amp;mut </span>[u8]) -&gt; <span class="prelude-ty">Result</span>&lt;usize, ErrorStack&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>len = buf.len();
<span class="kw">unsafe </span>{
cvt(ffi::EVP_PKEY_derive(
<span class="self">self</span>.<span class="number">0</span>,
buf.as_mut_ptr() <span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">_</span>,
<span class="kw-2">&amp;mut </span>len,
))
.map(|<span class="kw">_</span>| len)
}
}
<span class="doccomment">/// A convenience function which derives a shared secret and returns it in a new buffer.
///
/// This simply wraps [`Deriver::len`] and [`Deriver::derive`].
///
/// [`Deriver::len`]: #method.len
/// [`Deriver::derive`]: #method.derive
</span><span class="kw">pub fn </span>derive_to_vec(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;Vec&lt;u8&gt;, ErrorStack&gt; {
<span class="kw">let </span>len = <span class="self">self</span>.len()<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>buf = <span class="macro">vec!</span>[<span class="number">0</span>; len];
<span class="kw">let </span>len = <span class="self">self</span>.derive(<span class="kw-2">&amp;mut </span>buf)<span class="question-mark">?</span>;
buf.truncate(len);
<span class="prelude-val">Ok</span>(buf)
}
}
<span class="kw">impl </span>Drop <span class="kw">for </span>Deriver&lt;<span class="lifetime">'_</span>&gt; {
<span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="kw">unsafe </span>{
ffi::EVP_PKEY_CTX_free(<span class="self">self</span>.<span class="number">0</span>);
}
}
}
<span class="attr">#[cfg(test)]
</span><span class="kw">mod </span>test {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="kw">use </span><span class="kw">crate</span>::ec::{EcGroup, EcKey};
<span class="kw">use </span><span class="kw">crate</span>::nid::Nid;
<span class="kw">use </span><span class="kw">crate</span>::pkey::PKey;
<span class="attr">#[test]
</span><span class="kw">fn </span>derive_without_peer() {
<span class="kw">let </span>group = EcGroup::from_curve_name(Nid::X9_62_PRIME256V1).unwrap();
<span class="kw">let </span>ec_key = EcKey::generate(<span class="kw-2">&amp;</span>group).unwrap();
<span class="kw">let </span>pkey = PKey::from_ec_key(ec_key).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>deriver = Deriver::new(<span class="kw-2">&amp;</span>pkey).unwrap();
deriver.derive_to_vec().unwrap_err();
}
<span class="attr">#[test]
</span><span class="kw">fn </span>test_ec_key_derive() {
<span class="kw">let </span>group = EcGroup::from_curve_name(Nid::X9_62_PRIME256V1).unwrap();
<span class="kw">let </span>ec_key = EcKey::generate(<span class="kw-2">&amp;</span>group).unwrap();
<span class="kw">let </span>ec_key2 = EcKey::generate(<span class="kw-2">&amp;</span>group).unwrap();
<span class="kw">let </span>pkey = PKey::from_ec_key(ec_key).unwrap();
<span class="kw">let </span>pkey2 = PKey::from_ec_key(ec_key2).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>deriver = Deriver::new(<span class="kw-2">&amp;</span>pkey).unwrap();
deriver.set_peer(<span class="kw-2">&amp;</span>pkey2).unwrap();
<span class="kw">let </span>shared = deriver.derive_to_vec().unwrap();
<span class="macro">assert!</span>(!shared.is_empty());
}
<span class="attr">#[test]
#[cfg(ossl300)]
</span><span class="kw">fn </span>test_ec_key_derive_ex() {
<span class="kw">let </span>group = EcGroup::from_curve_name(Nid::X9_62_PRIME256V1).unwrap();
<span class="kw">let </span>ec_key = EcKey::generate(<span class="kw-2">&amp;</span>group).unwrap();
<span class="kw">let </span>ec_key2 = EcKey::generate(<span class="kw-2">&amp;</span>group).unwrap();
<span class="kw">let </span>pkey = PKey::from_ec_key(ec_key).unwrap();
<span class="kw">let </span>pkey2 = PKey::from_ec_key(ec_key2).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>deriver = Deriver::new(<span class="kw-2">&amp;</span>pkey).unwrap();
deriver.set_peer_ex(<span class="kw-2">&amp;</span>pkey2, <span class="bool-val">true</span>).unwrap();
<span class="kw">let </span>shared = deriver.derive_to_vec().unwrap();
<span class="macro">assert!</span>(!shared.is_empty());
}
}
</code></pre></div></section></main></body></html>