| <!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 `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/openssl-0.10.54/src/envelope.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>envelope.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../openssl/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../openssl/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! Envelope encryption. |
| //! |
| //! # Example |
| //! |
| //! ```rust |
| //! use openssl::rsa::Rsa; |
| //! use openssl::envelope::Seal; |
| //! use openssl::pkey::PKey; |
| //! use openssl::symm::Cipher; |
| //! |
| //! let rsa = Rsa::generate(2048).unwrap(); |
| //! let key = PKey::from_rsa(rsa).unwrap(); |
| //! |
| //! let cipher = Cipher::aes_256_cbc(); |
| //! let mut seal = Seal::new(cipher, &[key]).unwrap(); |
| //! |
| //! let secret = b"My secret message"; |
| //! let mut encrypted = vec![0; secret.len() + cipher.block_size()]; |
| //! |
| //! let mut enc_len = seal.update(secret, &mut encrypted).unwrap(); |
| //! enc_len += seal.finalize(&mut encrypted[enc_len..]).unwrap(); |
| //! encrypted.truncate(enc_len); |
| //! ``` |
| </span><span class="kw">use </span><span class="kw">crate</span>::cipher::CipherRef; |
| <span class="kw">use </span><span class="kw">crate</span>::cipher_ctx::CipherCtx; |
| <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, PKey, PKeyRef}; |
| <span class="kw">use </span><span class="kw">crate</span>::symm::Cipher; |
| <span class="kw">use </span>foreign_types::ForeignTypeRef; |
| |
| <span class="doccomment">/// Represents an EVP_Seal context. |
| </span><span class="kw">pub struct </span>Seal { |
| ctx: CipherCtx, |
| iv: <span class="prelude-ty">Option</span><Vec<u8>>, |
| enc_keys: Vec<Vec<u8>>, |
| } |
| |
| <span class="kw">impl </span>Seal { |
| <span class="doccomment">/// Creates a new `Seal`. |
| </span><span class="kw">pub fn </span>new<T>(cipher: Cipher, pub_keys: <span class="kw-2">&</span>[PKey<T>]) -> <span class="prelude-ty">Result</span><Seal, ErrorStack> |
| <span class="kw">where |
| </span>T: HasPublic, |
| { |
| <span class="kw">let </span><span class="kw-2">mut </span>iv = cipher.iv_len().map(|len| <span class="macro">vec!</span>[<span class="number">0</span>; len]); |
| <span class="kw">let </span><span class="kw-2">mut </span>enc_keys = <span class="macro">vec!</span>[<span class="macro">vec!</span>[]; pub_keys.len()]; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>ctx = CipherCtx::new()<span class="question-mark">?</span>; |
| ctx.seal_init( |
| <span class="prelude-val">Some</span>(<span class="kw">unsafe </span>{ CipherRef::from_ptr(cipher.as_ptr() <span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">_</span>) }), |
| pub_keys, |
| <span class="kw-2">&mut </span>enc_keys, |
| iv.as_deref_mut(), |
| )<span class="question-mark">?</span>; |
| |
| <span class="prelude-val">Ok</span>(Seal { ctx, iv, enc_keys }) |
| } |
| |
| <span class="doccomment">/// Returns the initialization vector, if the cipher uses one. |
| </span><span class="attribute">#[allow(clippy::option_as_ref_deref)] |
| </span><span class="kw">pub fn </span>iv(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>[u8]> { |
| <span class="self">self</span>.iv.as_ref().map(|v| <span class="kw-2">&**</span>v) |
| } |
| |
| <span class="doccomment">/// Returns the encrypted keys. |
| </span><span class="kw">pub fn </span>encrypted_keys(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[Vec<u8>] { |
| <span class="kw-2">&</span><span class="self">self</span>.enc_keys |
| } |
| |
| <span class="doccomment">/// Feeds data from `input` through the cipher, writing encrypted bytes into `output`. |
| /// |
| /// The number of bytes written to `output` is returned. Note that this may |
| /// not be equal to the length of `input`. |
| /// |
| /// # Panics |
| /// |
| /// Panics if `output.len() < input.len() + block_size` where `block_size` is |
| /// the block size of the cipher (see `Cipher::block_size`), or if |
| /// `output.len() > c_int::max_value()`. |
| </span><span class="kw">pub fn </span>update(<span class="kw-2">&mut </span><span class="self">self</span>, input: <span class="kw-2">&</span>[u8], output: <span class="kw-2">&mut </span>[u8]) -> <span class="prelude-ty">Result</span><usize, ErrorStack> { |
| <span class="self">self</span>.ctx.cipher_update(input, <span class="prelude-val">Some</span>(output)) |
| } |
| |
| <span class="doccomment">/// Finishes the encryption process, writing any remaining data to `output`. |
| /// |
| /// The number of bytes written to `output` is returned. |
| /// |
| /// `update` should not be called after this method. |
| /// |
| /// # Panics |
| /// |
| /// Panics if `output` is less than the cipher's block size. |
| </span><span class="kw">pub fn </span>finalize(<span class="kw-2">&mut </span><span class="self">self</span>, output: <span class="kw-2">&mut </span>[u8]) -> <span class="prelude-ty">Result</span><usize, ErrorStack> { |
| <span class="self">self</span>.ctx.cipher_final(output) |
| } |
| } |
| |
| <span class="doccomment">/// Represents an EVP_Open context. |
| </span><span class="kw">pub struct </span>Open { |
| ctx: CipherCtx, |
| } |
| |
| <span class="kw">impl </span>Open { |
| <span class="doccomment">/// Creates a new `Open`. |
| </span><span class="kw">pub fn </span>new<T>( |
| cipher: Cipher, |
| priv_key: <span class="kw-2">&</span>PKeyRef<T>, |
| iv: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>[u8]>, |
| encrypted_key: <span class="kw-2">&</span>[u8], |
| ) -> <span class="prelude-ty">Result</span><Open, ErrorStack> |
| <span class="kw">where |
| </span>T: HasPrivate, |
| { |
| <span class="kw">let </span><span class="kw-2">mut </span>ctx = CipherCtx::new()<span class="question-mark">?</span>; |
| ctx.open_init( |
| <span class="prelude-val">Some</span>(<span class="kw">unsafe </span>{ CipherRef::from_ptr(cipher.as_ptr() <span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">_</span>) }), |
| encrypted_key, |
| iv, |
| <span class="prelude-val">Some</span>(priv_key), |
| )<span class="question-mark">?</span>; |
| |
| <span class="prelude-val">Ok</span>(Open { ctx }) |
| } |
| |
| <span class="doccomment">/// Feeds data from `input` through the cipher, writing decrypted bytes into `output`. |
| /// |
| /// The number of bytes written to `output` is returned. Note that this may |
| /// not be equal to the length of `input`. |
| /// |
| /// # Panics |
| /// |
| /// Panics if `output.len() < input.len() + block_size` where |
| /// `block_size` is the block size of the cipher (see `Cipher::block_size`), |
| /// or if `output.len() > c_int::max_value()`. |
| </span><span class="kw">pub fn </span>update(<span class="kw-2">&mut </span><span class="self">self</span>, input: <span class="kw-2">&</span>[u8], output: <span class="kw-2">&mut </span>[u8]) -> <span class="prelude-ty">Result</span><usize, ErrorStack> { |
| <span class="self">self</span>.ctx.cipher_update(input, <span class="prelude-val">Some</span>(output)) |
| } |
| |
| <span class="doccomment">/// Finishes the decryption process, writing any remaining data to `output`. |
| /// |
| /// The number of bytes written to `output` is returned. |
| /// |
| /// `update` should not be called after this method. |
| /// |
| /// # Panics |
| /// |
| /// Panics if `output` is less than the cipher's block size. |
| </span><span class="kw">pub fn </span>finalize(<span class="kw-2">&mut </span><span class="self">self</span>, output: <span class="kw-2">&mut </span>[u8]) -> <span class="prelude-ty">Result</span><usize, ErrorStack> { |
| <span class="self">self</span>.ctx.cipher_final(output) |
| } |
| } |
| |
| <span class="attribute">#[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>::pkey::PKey; |
| <span class="kw">use </span><span class="kw">crate</span>::symm::Cipher; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>public_encrypt_private_decrypt() { |
| <span class="kw">let </span>private_pem = <span class="macro">include_bytes!</span>(<span class="string">"../test/rsa.pem"</span>); |
| <span class="kw">let </span>public_pem = <span class="macro">include_bytes!</span>(<span class="string">"../test/rsa.pem.pub"</span>); |
| <span class="kw">let </span>private_key = PKey::private_key_from_pem(private_pem).unwrap(); |
| <span class="kw">let </span>public_key = PKey::public_key_from_pem(public_pem).unwrap(); |
| <span class="kw">let </span>cipher = Cipher::aes_256_cbc(); |
| <span class="kw">let </span>secret = <span class="string">b"My secret message"</span>; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>seal = Seal::new(cipher, <span class="kw-2">&</span>[public_key]).unwrap(); |
| <span class="kw">let </span><span class="kw-2">mut </span>encrypted = <span class="macro">vec!</span>[<span class="number">0</span>; secret.len() + cipher.block_size()]; |
| <span class="kw">let </span><span class="kw-2">mut </span>enc_len = seal.update(secret, <span class="kw-2">&mut </span>encrypted).unwrap(); |
| enc_len += seal.finalize(<span class="kw-2">&mut </span>encrypted[enc_len..]).unwrap(); |
| <span class="kw">let </span>iv = seal.iv(); |
| <span class="kw">let </span>encrypted_key = <span class="kw-2">&</span>seal.encrypted_keys()[<span class="number">0</span>]; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>open = Open::new(cipher, <span class="kw-2">&</span>private_key, iv, encrypted_key).unwrap(); |
| <span class="kw">let </span><span class="kw-2">mut </span>decrypted = <span class="macro">vec!</span>[<span class="number">0</span>; enc_len + cipher.block_size()]; |
| <span class="kw">let </span><span class="kw-2">mut </span>dec_len = open.update(<span class="kw-2">&</span>encrypted[..enc_len], <span class="kw-2">&mut </span>decrypted).unwrap(); |
| dec_len += open.finalize(<span class="kw-2">&mut </span>decrypted[dec_len..]).unwrap(); |
| |
| <span class="macro">assert_eq!</span>(<span class="kw-2">&</span>secret[..], <span class="kw-2">&</span>decrypted[..dec_len]); |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="openssl" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |