Google Git
Sign in
apache / incubator-teaclave-website / refs/heads/asf-site / . / api-docs / crates-app / src / openssl / md_ctx.rs.html
blob: eed4df42ea67dc39f5607fa53784bf0defacc9d2 [file] [log] [blame]
<!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/md_ctx.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>md_ctx.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>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
<span id="469">469</span>
<span id="470">470</span>
<span id="471">471</span>
<span id="472">472</span>
<span id="473">473</span>
<span id="474">474</span>
<span id="475">475</span>
<span id="476">476</span>
<span id="477">477</span>
<span id="478">478</span>
<span id="479">479</span>
<span id="480">480</span>
<span id="481">481</span>
<span id="482">482</span>
<span id="483">483</span>
<span id="484">484</span>
<span id="485">485</span>
<span id="486">486</span>
<span id="487">487</span>
<span id="488">488</span>
<span id="489">489</span>
<span id="490">490</span>
<span id="491">491</span>
<span id="492">492</span>
<span id="493">493</span>
<span id="494">494</span>
<span id="495">495</span>
<span id="496">496</span>
<span id="497">497</span>
<span id="498">498</span>
<span id="499">499</span>
<span id="500">500</span>
<span id="501">501</span>
<span id="502">502</span>
<span id="503">503</span>
<span id="504">504</span>
<span id="505">505</span>
<span id="506">506</span>
<span id="507">507</span>
<span id="508">508</span>
<span id="509">509</span>
<span id="510">510</span>
<span id="511">511</span>
<span id="512">512</span>
<span id="513">513</span>
<span id="514">514</span>
<span id="515">515</span>
<span id="516">516</span>
<span id="517">517</span>
<span id="518">518</span>
<span id="519">519</span>
<span id="520">520</span>
<span id="521">521</span>
<span id="522">522</span>
<span id="523">523</span>
<span id="524">524</span>
<span id="525">525</span>
<span id="526">526</span>
<span id="527">527</span>
<span id="528">528</span>
<span id="529">529</span>
<span id="530">530</span>
<span id="531">531</span>
<span id="532">532</span>
<span id="533">533</span>
<span id="534">534</span>
<span id="535">535</span>
<span id="536">536</span>
<span id="537">537</span>
<span id="538">538</span>
<span id="539">539</span>
<span id="540">540</span>
</pre><pre class="rust"><code><span class="doccomment">//! The message digest context.
//!
//! # Examples
//!
//! Compute the SHA256 checksum of data
//!
//! ```
//! use openssl::md::Md;
//! use openssl::md_ctx::MdCtx;
//!
//! let mut ctx = MdCtx::new().unwrap();
//! ctx.digest_init(Md::sha256()).unwrap();
//! ctx.digest_update(b&quot;Some Crypto Text&quot;).unwrap();
//! let mut digest = [0; 32];
//! ctx.digest_final(&amp;mut digest).unwrap();
//!
//! assert_eq!(
//! digest,
//! *b&quot;\x60\x78\x56\x38\x8a\xca\x5c\x51\x83\xc4\xd1\x4d\xc8\xf9\xcc\xf2\
//! \xa5\x21\xb3\x10\x93\x72\xfa\xd6\x7c\x55\xf5\xc9\xe3\xd1\x83\x19&quot;,
//! );
//! ```
//!
//! Sign and verify data with RSA and SHA256
//!
//! ```
//! use openssl::md::Md;
//! use openssl::md_ctx::MdCtx;
//! use openssl::pkey::PKey;
//! use openssl::rsa::Rsa;
//!
//! // Generate a random RSA key.
//! let key = Rsa::generate(4096).unwrap();
//! let key = PKey::from_rsa(key).unwrap();
//!
//! let text = b&quot;Some Crypto Text&quot;;
//!
//! // Create the signature.
//! let mut ctx = MdCtx::new().unwrap();
//! ctx.digest_sign_init(Some(Md::sha256()), &amp;key).unwrap();
//! ctx.digest_sign_update(text).unwrap();
//! let mut signature = vec![];
//! ctx.digest_sign_final_to_vec(&amp;mut signature).unwrap();
//!
//! // Verify the signature.
//! let mut ctx = MdCtx::new().unwrap();
//! ctx.digest_verify_init(Some(Md::sha256()), &amp;key).unwrap();
//! ctx.digest_verify_update(text).unwrap();
//! let valid = ctx.digest_verify_final(&amp;signature).unwrap();
//! assert!(valid);
//! ```
//!
</span><span class="attribute">#![cfg_attr(
not(boringssl),
doc = <span class="string">r#&quot;\
Compute and verify an HMAC-SHA256
```
use openssl::md::Md;
use openssl::md_ctx::MdCtx;
use openssl::memcmp;
use openssl::pkey::PKey;
// Create a key with the HMAC secret.
let key = PKey::hmac(b&quot;my secret&quot;).unwrap();
let text = b&quot;Some Crypto Text&quot;;
// Compute the HMAC.
let mut ctx = MdCtx::new().unwrap();
ctx.digest_sign_init(Some(Md::sha256()), &amp;key).unwrap();
ctx.digest_sign_update(text).unwrap();
let mut hmac = vec![];
ctx.digest_sign_final_to_vec(&amp;mut hmac).unwrap();
// Verify the HMAC. You can&#39;t use MdCtx to do this; instead use a constant time equality check.
# let target = hmac.clone();
let valid = memcmp::eq(&amp;hmac, &amp;target);
assert!(valid);
```&quot;#
</span>)]
</span><span class="kw">use </span><span class="kw">crate</span>::error::ErrorStack;
<span class="kw">use </span><span class="kw">crate</span>::md::MdRef;
<span class="kw">use </span><span class="kw">crate</span>::pkey::{HasPrivate, HasPublic, PKeyRef};
<span class="kw">use </span><span class="kw">crate</span>::pkey_ctx::PkeyCtxRef;
<span class="kw">use crate</span>::{cvt, cvt_n, cvt_p};
<span class="kw">use </span>cfg_if::cfg_if;
<span class="kw">use </span>foreign_types::{ForeignType, ForeignTypeRef};
<span class="kw">use </span>openssl_macros::corresponds;
<span class="kw">use </span>std::convert::TryFrom;
<span class="kw">use </span>std::ptr;
<span class="macro">cfg_if! </span>{
<span class="kw">if </span><span class="attribute">#[cfg(ossl110)] </span>{
<span class="kw">use </span>ffi::{EVP_MD_CTX_free, EVP_MD_CTX_new};
} <span class="kw">else </span>{
<span class="kw">use </span>ffi::{EVP_MD_CTX_create <span class="kw">as </span>EVP_MD_CTX_new, EVP_MD_CTX_destroy <span class="kw">as </span>EVP_MD_CTX_free};
}
}
<span class="macro">foreign_type_and_impl_send_sync! </span>{
<span class="kw">type </span>CType = ffi::EVP_MD_CTX;
<span class="kw">fn </span>drop = EVP_MD_CTX_free;
<span class="kw">pub struct </span>MdCtx;
<span class="doccomment">/// A reference to an [`MdCtx`].
</span><span class="kw">pub struct </span>MdCtxRef;
}
<span class="kw">impl </span>MdCtx {
<span class="doccomment">/// Creates a new context.
</span><span class="attribute">#[corresponds(EVP_MD_CTX_new)]
#[inline]
</span><span class="kw">pub fn </span>new() -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, ErrorStack&gt; {
ffi::init();
<span class="kw">unsafe </span>{
<span class="kw">let </span>ptr = cvt_p(EVP_MD_CTX_new())<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(MdCtx::from_ptr(ptr))
}
}
}
<span class="kw">impl </span>MdCtxRef {
<span class="doccomment">/// Initializes the context to compute the digest of data.
</span><span class="attribute">#[corresponds(EVP_DigestInit_ex)]
#[inline]
</span><span class="kw">pub fn </span>digest_init(<span class="kw-2">&amp;mut </span><span class="self">self</span>, digest: <span class="kw-2">&amp;</span>MdRef) -&gt; <span class="prelude-ty">Result</span>&lt;(), ErrorStack&gt; {
<span class="kw">unsafe </span>{
cvt(ffi::EVP_DigestInit_ex(
<span class="self">self</span>.as_ptr(),
digest.as_ptr(),
ptr::null_mut(),
))<span class="question-mark">?</span>;
}
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// Initializes the context to compute the signature of data.
///
/// A reference to the context&#39;s inner `PkeyCtx` is returned, allowing signature settings to be configured.
</span><span class="attribute">#[corresponds(EVP_DigestSignInit)]
#[inline]
</span><span class="kw">pub fn </span>digest_sign_init&lt;<span class="lifetime">&#39;a</span>, T&gt;(
<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span><span class="self">self</span>,
digest: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>MdRef&gt;,
pkey: <span class="kw-2">&amp;</span>PKeyRef&lt;T&gt;,
) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>PkeyCtxRef&lt;T&gt;, ErrorStack&gt;
<span class="kw">where
</span>T: HasPrivate,
{
<span class="kw">unsafe </span>{
<span class="kw">let </span><span class="kw-2">mut </span>p = ptr::null_mut();
cvt(ffi::EVP_DigestSignInit(
<span class="self">self</span>.as_ptr(),
<span class="kw-2">&amp;mut </span>p,
digest.map_or(ptr::null(), |p| p.as_ptr()),
ptr::null_mut(),
pkey.as_ptr(),
))<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(PkeyCtxRef::from_ptr_mut(p))
}
}
<span class="doccomment">/// Initializes the context to verify the signature of data.
///
/// A reference to the context&#39;s inner `PkeyCtx` is returned, allowing signature settings to be configured.
</span><span class="attribute">#[corresponds(EVP_DigestVerifyInit)]
#[inline]
</span><span class="kw">pub fn </span>digest_verify_init&lt;<span class="lifetime">&#39;a</span>, T&gt;(
<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span><span class="self">self</span>,
digest: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>MdRef&gt;,
pkey: <span class="kw-2">&amp;</span>PKeyRef&lt;T&gt;,
) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>PkeyCtxRef&lt;T&gt;, ErrorStack&gt;
<span class="kw">where
</span>T: HasPublic,
{
<span class="kw">unsafe </span>{
<span class="kw">let </span><span class="kw-2">mut </span>p = ptr::null_mut();
cvt(ffi::EVP_DigestVerifyInit(
<span class="self">self</span>.as_ptr(),
<span class="kw-2">&amp;mut </span>p,
digest.map_or(ptr::null(), |p| p.as_ptr()),
ptr::null_mut(),
pkey.as_ptr(),
))<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(PkeyCtxRef::from_ptr_mut(p))
}
}
<span class="doccomment">/// Updates the context with more data.
</span><span class="attribute">#[corresponds(EVP_DigestUpdate)]
#[inline]
</span><span class="kw">pub fn </span>digest_update(<span class="kw-2">&amp;mut </span><span class="self">self</span>, data: <span class="kw-2">&amp;</span>[u8]) -&gt; <span class="prelude-ty">Result</span>&lt;(), ErrorStack&gt; {
<span class="kw">unsafe </span>{
cvt(ffi::EVP_DigestUpdate(
<span class="self">self</span>.as_ptr(),
data.as_ptr() <span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_</span>,
data.len(),
))<span class="question-mark">?</span>;
}
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// Updates the context with more data.
</span><span class="attribute">#[corresponds(EVP_DigestSignUpdate)]
#[inline]
</span><span class="kw">pub fn </span>digest_sign_update(<span class="kw-2">&amp;mut </span><span class="self">self</span>, data: <span class="kw-2">&amp;</span>[u8]) -&gt; <span class="prelude-ty">Result</span>&lt;(), ErrorStack&gt; {
<span class="kw">unsafe </span>{
cvt(ffi::EVP_DigestSignUpdate(
<span class="self">self</span>.as_ptr(),
data.as_ptr() <span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_</span>,
data.len(),
))<span class="question-mark">?</span>;
}
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// Updates the context with more data.
</span><span class="attribute">#[corresponds(EVP_DigestVerifyUpdate)]
#[inline]
</span><span class="kw">pub fn </span>digest_verify_update(<span class="kw-2">&amp;mut </span><span class="self">self</span>, data: <span class="kw-2">&amp;</span>[u8]) -&gt; <span class="prelude-ty">Result</span>&lt;(), ErrorStack&gt; {
<span class="kw">unsafe </span>{
cvt(ffi::EVP_DigestVerifyUpdate(
<span class="self">self</span>.as_ptr(),
data.as_ptr() <span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_</span>,
data.len(),
))<span class="question-mark">?</span>;
}
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// Copies the computed digest into the buffer, returning the number of bytes written.
</span><span class="attribute">#[corresponds(EVP_DigestFinal)]
#[inline]
</span><span class="kw">pub fn </span>digest_final(<span class="kw-2">&amp;mut </span><span class="self">self</span>, out: <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 = u32::try_from(out.len()).unwrap_or(u32::MAX);
<span class="kw">unsafe </span>{
cvt(ffi::EVP_DigestFinal(
<span class="self">self</span>.as_ptr(),
out.as_mut_ptr(),
<span class="kw-2">&amp;mut </span>len,
))<span class="question-mark">?</span>;
}
<span class="prelude-val">Ok</span>(len <span class="kw">as </span>usize)
}
<span class="doccomment">/// Copies the computed digest into the buffer.
///
/// Requires OpenSSL 1.1.1 or newer.
</span><span class="attribute">#[corresponds(EVP_DigestFinalXOF)]
#[inline]
#[cfg(ossl111)]
</span><span class="kw">pub fn </span>digest_final_xof(<span class="kw-2">&amp;mut </span><span class="self">self</span>, out: <span class="kw-2">&amp;mut </span>[u8]) -&gt; <span class="prelude-ty">Result</span>&lt;(), ErrorStack&gt; {
<span class="kw">unsafe </span>{
cvt(ffi::EVP_DigestFinalXOF(
<span class="self">self</span>.as_ptr(),
out.as_mut_ptr(),
out.len(),
))<span class="question-mark">?</span>;
}
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// Signs the computed digest.
///
/// If `out` is set to `None`, an upper bound on the number of bytes required for the output buffer will be
/// returned.
</span><span class="attribute">#[corresponds(EVP_DigestSignFinal)]
#[inline]
</span><span class="kw">pub fn </span>digest_sign_final(<span class="kw-2">&amp;mut </span><span class="self">self</span>, out: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;mut </span>[u8]&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;usize, ErrorStack&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>len = out.as_ref().map_or(<span class="number">0</span>, |b| b.len());
<span class="kw">unsafe </span>{
cvt(ffi::EVP_DigestSignFinal(
<span class="self">self</span>.as_ptr(),
out.map_or(ptr::null_mut(), |b| b.as_mut_ptr()),
<span class="kw-2">&amp;mut </span>len,
))<span class="question-mark">?</span>;
}
<span class="prelude-val">Ok</span>(len)
}
<span class="doccomment">/// Like [`Self::digest_sign_final`] but appends the signature to a [`Vec`].
</span><span class="kw">pub fn </span>digest_sign_final_to_vec(<span class="kw-2">&amp;mut </span><span class="self">self</span>, out: <span class="kw-2">&amp;mut </span>Vec&lt;u8&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;usize, ErrorStack&gt; {
<span class="kw">let </span>base = out.len();
<span class="kw">let </span>len = <span class="self">self</span>.digest_sign_final(<span class="prelude-val">None</span>)<span class="question-mark">?</span>;
out.resize(base + len, <span class="number">0</span>);
<span class="kw">let </span>len = <span class="self">self</span>.digest_sign_final(<span class="prelude-val">Some</span>(<span class="kw-2">&amp;mut </span>out[base..]))<span class="question-mark">?</span>;
out.truncate(base + len);
<span class="prelude-val">Ok</span>(len)
}
<span class="doccomment">/// Verifies the provided signature.
///
/// Returns `Ok(true)` if the signature is valid, `Ok(false)` if the signature is invalid, and `Err` if an error
/// occurred.
</span><span class="attribute">#[corresponds(EVP_DigestVerifyFinal)]
#[inline]
</span><span class="kw">pub fn </span>digest_verify_final(<span class="kw-2">&amp;mut </span><span class="self">self</span>, signature: <span class="kw-2">&amp;</span>[u8]) -&gt; <span class="prelude-ty">Result</span>&lt;bool, ErrorStack&gt; {
<span class="kw">unsafe </span>{
<span class="kw">let </span>r = cvt_n(ffi::EVP_DigestVerifyFinal(
<span class="self">self</span>.as_ptr(),
signature.as_ptr() <span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">_</span>,
signature.len(),
))<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(r == <span class="number">1</span>)
}
}
<span class="doccomment">/// Computes the signature of the data in `from`.
///
/// If `to` is set to `None`, an upper bound on the number of bytes required for the output buffer will be
/// returned.
///
/// Requires OpenSSL 1.1.1 or newer.
</span><span class="attribute">#[corresponds(EVP_DigestSign)]
#[cfg(ossl111)]
#[inline]
</span><span class="kw">pub fn </span>digest_sign(<span class="kw-2">&amp;mut </span><span class="self">self</span>, from: <span class="kw-2">&amp;</span>[u8], to: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;mut </span>[u8]&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;usize, ErrorStack&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>len = to.as_ref().map_or(<span class="number">0</span>, |b| b.len());
<span class="kw">unsafe </span>{
cvt(ffi::EVP_DigestSign(
<span class="self">self</span>.as_ptr(),
to.map_or(ptr::null_mut(), |b| b.as_mut_ptr()),
<span class="kw-2">&amp;mut </span>len,
from.as_ptr(),
from.len(),
))<span class="question-mark">?</span>;
}
<span class="prelude-val">Ok</span>(len)
}
<span class="doccomment">/// Like [`Self::digest_sign`] but appends the signature to a [`Vec`].
</span><span class="attribute">#[cfg(ossl111)]
</span><span class="kw">pub fn </span>digest_sign_to_vec(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
from: <span class="kw-2">&amp;</span>[u8],
to: <span class="kw-2">&amp;mut </span>Vec&lt;u8&gt;,
) -&gt; <span class="prelude-ty">Result</span>&lt;usize, ErrorStack&gt; {
<span class="kw">let </span>base = to.len();
<span class="kw">let </span>len = <span class="self">self</span>.digest_sign(from, <span class="prelude-val">None</span>)<span class="question-mark">?</span>;
to.resize(base + len, <span class="number">0</span>);
<span class="kw">let </span>len = <span class="self">self</span>.digest_sign(from, <span class="prelude-val">Some</span>(<span class="kw-2">&amp;mut </span>to[base..]))<span class="question-mark">?</span>;
to.truncate(base + len);
<span class="prelude-val">Ok</span>(len)
}
<span class="doccomment">/// Verifies the signature of the data in `data`.
///
/// Returns `Ok(true)` if the signature is valid, `Ok(false)` if the signature is invalid, and `Err` if an error
/// occurred.
///
/// Requires OpenSSL 1.1.1 or newer.
</span><span class="attribute">#[corresponds(EVP_DigestVerify)]
#[cfg(ossl111)]
#[inline]
</span><span class="kw">pub fn </span>digest_verify(<span class="kw-2">&amp;mut </span><span class="self">self</span>, data: <span class="kw-2">&amp;</span>[u8], signature: <span class="kw-2">&amp;</span>[u8]) -&gt; <span class="prelude-ty">Result</span>&lt;bool, ErrorStack&gt; {
<span class="kw">unsafe </span>{
<span class="kw">let </span>r = cvt(ffi::EVP_DigestVerify(
<span class="self">self</span>.as_ptr(),
signature.as_ptr(),
signature.len(),
data.as_ptr(),
data.len(),
))<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(r == <span class="number">1</span>)
}
}
<span class="doccomment">/// Returns the size of the message digest, i.e. the size of the hash
</span><span class="attribute">#[corresponds(EVP_MD_CTX_size)]
#[inline]
</span><span class="kw">pub fn </span>size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="kw">unsafe </span>{ ffi::EVP_MD_CTX_size(<span class="self">self</span>.as_ptr()) <span class="kw">as </span>usize }
}
<span class="doccomment">/// Resets the underlying EVP_MD_CTX instance
</span><span class="attribute">#[corresponds(EVP_MD_CTX_reset)]
#[cfg(ossl111)]
#[inline]
</span><span class="kw">pub fn </span>reset(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;(), ErrorStack&gt; {
<span class="kw">unsafe </span>{
<span class="kw">let _ </span>= cvt(ffi::EVP_MD_CTX_reset(<span class="self">self</span>.as_ptr()))<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(())
}
}
}
<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>::md::Md;
<span class="kw">use </span><span class="kw">crate</span>::pkey::PKey;
<span class="kw">use </span><span class="kw">crate</span>::rsa::Rsa;
<span class="attribute">#[test]
</span><span class="kw">fn </span>verify_fail() {
<span class="kw">let </span>key1 = Rsa::generate(<span class="number">4096</span>).unwrap();
<span class="kw">let </span>key1 = PKey::from_rsa(key1).unwrap();
<span class="kw">let </span>md = Md::sha256();
<span class="kw">let </span>data = <span class="string">b&quot;Some Crypto Text&quot;</span>;
<span class="kw">let </span><span class="kw-2">mut </span>ctx = MdCtx::new().unwrap();
ctx.digest_sign_init(<span class="prelude-val">Some</span>(md), <span class="kw-2">&amp;</span>key1).unwrap();
ctx.digest_sign_update(data).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>signature = <span class="macro">vec!</span>[];
ctx.digest_sign_final_to_vec(<span class="kw-2">&amp;mut </span>signature).unwrap();
<span class="kw">let </span>bad_data = <span class="string">b&quot;Some Crypto text&quot;</span>;
ctx.digest_verify_init(<span class="prelude-val">Some</span>(md), <span class="kw-2">&amp;</span>key1).unwrap();
ctx.digest_verify_update(bad_data).unwrap();
<span class="kw">let </span>valid = ctx.digest_verify_final(<span class="kw-2">&amp;</span>signature).unwrap();
<span class="macro">assert!</span>(!valid);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>verify_success() {
<span class="kw">let </span>key1 = Rsa::generate(<span class="number">2048</span>).unwrap();
<span class="kw">let </span>key1 = PKey::from_rsa(key1).unwrap();
<span class="kw">let </span>md = Md::sha256();
<span class="kw">let </span>data = <span class="string">b&quot;Some Crypto Text&quot;</span>;
<span class="kw">let </span><span class="kw-2">mut </span>ctx = MdCtx::new().unwrap();
ctx.digest_sign_init(<span class="prelude-val">Some</span>(md), <span class="kw-2">&amp;</span>key1).unwrap();
ctx.digest_sign_update(data).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>signature = <span class="macro">vec!</span>[];
ctx.digest_sign_final_to_vec(<span class="kw-2">&amp;mut </span>signature).unwrap();
<span class="kw">let </span>good_data = <span class="string">b&quot;Some Crypto Text&quot;</span>;
ctx.digest_verify_init(<span class="prelude-val">Some</span>(md), <span class="kw-2">&amp;</span>key1).unwrap();
ctx.digest_verify_update(good_data).unwrap();
<span class="kw">let </span>valid = ctx.digest_verify_final(<span class="kw-2">&amp;</span>signature).unwrap();
<span class="macro">assert!</span>(valid);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>verify_with_public_success() {
<span class="kw">let </span>rsa = Rsa::generate(<span class="number">2048</span>).unwrap();
<span class="kw">let </span>key1 = PKey::from_rsa(rsa.clone()).unwrap();
<span class="kw">let </span>md = Md::sha256();
<span class="kw">let </span>data = <span class="string">b&quot;Some Crypto Text&quot;</span>;
<span class="kw">let </span><span class="kw-2">mut </span>ctx = MdCtx::new().unwrap();
ctx.digest_sign_init(<span class="prelude-val">Some</span>(md), <span class="kw-2">&amp;</span>key1).unwrap();
ctx.digest_sign_update(data).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>signature = <span class="macro">vec!</span>[];
ctx.digest_sign_final_to_vec(<span class="kw-2">&amp;mut </span>signature).unwrap();
<span class="kw">let </span>good_data = <span class="string">b&quot;Some Crypto Text&quot;</span>;
<span class="comment">// try to verify using only public components of the key
</span><span class="kw">let </span>n = rsa.n().to_owned().unwrap();
<span class="kw">let </span>e = rsa.e().to_owned().unwrap();
<span class="kw">let </span>rsa = Rsa::from_public_components(n, e).unwrap();
<span class="kw">let </span>key1 = PKey::from_rsa(rsa).unwrap();
ctx.digest_verify_init(<span class="prelude-val">Some</span>(md), <span class="kw-2">&amp;</span>key1).unwrap();
ctx.digest_verify_update(good_data).unwrap();
<span class="kw">let </span>valid = ctx.digest_verify_final(<span class="kw-2">&amp;</span>signature).unwrap();
<span class="macro">assert!</span>(valid);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>verify_md_ctx_size() {
<span class="kw">let </span><span class="kw-2">mut </span>ctx = MdCtx::new().unwrap();
ctx.digest_init(Md::sha224()).unwrap();
<span class="macro">assert_eq!</span>(Md::sha224().size(), ctx.size());
<span class="macro">assert_eq!</span>(Md::sha224().size(), <span class="number">28</span>);
<span class="kw">let </span><span class="kw-2">mut </span>ctx = MdCtx::new().unwrap();
ctx.digest_init(Md::sha256()).unwrap();
<span class="macro">assert_eq!</span>(Md::sha256().size(), ctx.size());
<span class="macro">assert_eq!</span>(Md::sha256().size(), <span class="number">32</span>);
<span class="kw">let </span><span class="kw-2">mut </span>ctx = MdCtx::new().unwrap();
ctx.digest_init(Md::sha384()).unwrap();
<span class="macro">assert_eq!</span>(Md::sha384().size(), ctx.size());
<span class="macro">assert_eq!</span>(Md::sha384().size(), <span class="number">48</span>);
<span class="kw">let </span><span class="kw-2">mut </span>ctx = MdCtx::new().unwrap();
ctx.digest_init(Md::sha512()).unwrap();
<span class="macro">assert_eq!</span>(Md::sha512().size(), ctx.size());
<span class="macro">assert_eq!</span>(Md::sha512().size(), <span class="number">64</span>);
}
<span class="attribute">#[test]
#[cfg(ossl111)]
</span><span class="kw">fn </span>verify_md_ctx_reset() {
<span class="kw">let </span>hello_expected =
hex::decode(<span class="string">&quot;185f8db32271fe25f561a6fc938b2e264306ec304eda518007d1764826381969&quot;</span>)
.unwrap();
<span class="kw">let </span>world_expected =
hex::decode(<span class="string">&quot;78ae647dc5544d227130a0682a51e30bc7777fbb6d8a8f17007463a3ecd1d524&quot;</span>)
.unwrap();
<span class="comment">// Calculate SHA-256 digest of &quot;Hello&quot;
</span><span class="kw">let </span><span class="kw-2">mut </span>ctx = MdCtx::new().unwrap();
ctx.digest_init(Md::sha256()).unwrap();
ctx.digest_update(<span class="string">b&quot;Hello&quot;</span>).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>result = <span class="macro">vec!</span>[<span class="number">0</span>; <span class="number">32</span>];
<span class="kw">let </span>result_len = ctx.digest_final(result.as_mut_slice()).unwrap();
<span class="macro">assert_eq!</span>(result_len, result.len());
<span class="comment">// Validate result of &quot;Hello&quot;
</span><span class="macro">assert_eq!</span>(result, hello_expected);
<span class="comment">// Create new context
</span><span class="kw">let </span><span class="kw-2">mut </span>ctx = MdCtx::new().unwrap();
<span class="comment">// Initialize and update to &quot;Hello&quot;
</span>ctx.digest_init(Md::sha256()).unwrap();
ctx.digest_update(<span class="string">b&quot;Hello&quot;</span>).unwrap();
<span class="comment">// Now reset, init to SHA-256 and use &quot;World&quot;
</span>ctx.reset().unwrap();
ctx.digest_init(Md::sha256()).unwrap();
ctx.digest_update(<span class="string">b&quot;World&quot;</span>).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>reset_result = <span class="macro">vec!</span>[<span class="number">0</span>; <span class="number">32</span>];
<span class="kw">let </span>result_len = ctx.digest_final(reset_result.as_mut_slice()).unwrap();
<span class="macro">assert_eq!</span>(result_len, reset_result.len());
<span class="comment">// Validate result of digest of &quot;World&quot;
</span><span class="macro">assert_eq!</span>(reset_result, world_expected);
}
}
</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>