| <!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/git/checkouts/incubator-teaclave-crates-c8106113f74feefc/ede1f68/rustls-0.19.1/rustls/src/hash_hs.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>hash_hs.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="../../rustls/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="../../rustls/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> |
| </pre><pre class="rust"><code><span class="attribute">#[cfg(feature = <span class="string">"logging"</span>)] |
| </span><span class="kw">use </span><span class="kw">crate</span>::log::warn; |
| <span class="kw">use </span><span class="kw">crate</span>::msgs::codec::Codec; |
| <span class="kw">use </span><span class="kw">crate</span>::msgs::handshake::HandshakeMessagePayload; |
| <span class="kw">use </span><span class="kw">crate</span>::msgs::message::{Message, MessagePayload}; |
| <span class="kw">use </span>ring::digest; |
| <span class="kw">use </span>std::mem; |
| |
| <span class="doccomment">/// This deals with keeping a running hash of the handshake |
| /// payloads. This is computed by buffering initially. Once |
| /// we know what hash function we need to use we switch to |
| /// incremental hashing. |
| /// |
| /// For client auth, we also need to buffer all the messages. |
| /// This is disabled in cases where client auth is not possible. |
| </span><span class="kw">pub struct </span>HandshakeHash { |
| <span class="doccomment">/// None before we know what hash function we're using |
| </span>alg: <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'static </span>digest::Algorithm>, |
| |
| <span class="doccomment">/// None before we know what hash function we're using |
| </span>ctx: <span class="prelude-ty">Option</span><digest::Context>, |
| |
| <span class="doccomment">/// true if we need to keep all messages |
| </span>client_auth_enabled: bool, |
| |
| <span class="doccomment">/// buffer for pre-hashing stage and client-auth. |
| </span>buffer: Vec<u8>, |
| } |
| |
| <span class="kw">impl </span>HandshakeHash { |
| <span class="kw">pub fn </span>new() -> HandshakeHash { |
| HandshakeHash { |
| alg: <span class="prelude-val">None</span>, |
| ctx: <span class="prelude-val">None</span>, |
| client_auth_enabled: <span class="bool-val">false</span>, |
| buffer: Vec::new(), |
| } |
| } |
| |
| <span class="doccomment">/// We might be doing client auth, so need to keep a full |
| /// log of the handshake. |
| </span><span class="kw">pub fn </span>set_client_auth_enabled(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="macro">debug_assert!</span>(<span class="self">self</span>.ctx.is_none()); <span class="comment">// or we might have already discarded messages |
| </span><span class="self">self</span>.client_auth_enabled = <span class="bool-val">true</span>; |
| } |
| |
| <span class="doccomment">/// We decided not to do client auth after all, so discard |
| /// the transcript. |
| </span><span class="kw">pub fn </span>abandon_client_auth(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="self">self</span>.client_auth_enabled = <span class="bool-val">false</span>; |
| <span class="self">self</span>.buffer.drain(..); |
| } |
| |
| <span class="doccomment">/// We now know what hash function the verify_data will use. |
| </span><span class="kw">pub fn </span>start_hash(<span class="kw-2">&mut </span><span class="self">self</span>, alg: <span class="kw-2">&</span><span class="lifetime">'static </span>digest::Algorithm) -> bool { |
| <span class="kw">match </span><span class="self">self</span>.alg { |
| <span class="prelude-val">None </span>=> {} |
| <span class="prelude-val">Some</span>(started) => { |
| <span class="kw">if </span>started != alg { |
| <span class="comment">// hash type is changing |
| </span><span class="macro">warn!</span>(<span class="string">"altered hash to HandshakeHash::start_hash"</span>); |
| <span class="kw">return </span><span class="bool-val">false</span>; |
| } |
| |
| <span class="kw">return </span><span class="bool-val">true</span>; |
| } |
| } |
| <span class="self">self</span>.alg = <span class="prelude-val">Some</span>(alg); |
| <span class="macro">debug_assert!</span>(<span class="self">self</span>.ctx.is_none()); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>ctx = digest::Context::new(alg); |
| ctx.update(<span class="kw-2">&</span><span class="self">self</span>.buffer); |
| <span class="self">self</span>.ctx = <span class="prelude-val">Some</span>(ctx); |
| |
| <span class="comment">// Discard buffer if we don't need it now. |
| </span><span class="kw">if </span>!<span class="self">self</span>.client_auth_enabled { |
| <span class="self">self</span>.buffer.drain(..); |
| } |
| <span class="bool-val">true |
| </span>} |
| |
| <span class="doccomment">/// Hash/buffer a handshake message. |
| </span><span class="kw">pub fn </span>add_message(<span class="kw-2">&mut </span><span class="self">self</span>, m: <span class="kw-2">&</span>Message) -> <span class="kw-2">&mut </span>HandshakeHash { |
| <span class="kw">match </span>m.payload { |
| MessagePayload::Handshake(<span class="kw-2">ref </span>hs) => { |
| <span class="kw">let </span>buf = hs.get_encoding(); |
| <span class="self">self</span>.update_raw(<span class="kw-2">&</span>buf); |
| } |
| <span class="kw">_ </span>=> {} |
| }; |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Hash or buffer a byte slice. |
| </span><span class="kw">fn </span>update_raw(<span class="kw-2">&mut </span><span class="self">self</span>, buf: <span class="kw-2">&</span>[u8]) -> <span class="kw-2">&mut </span><span class="self">Self </span>{ |
| <span class="kw">if </span><span class="self">self</span>.ctx.is_some() { |
| <span class="self">self</span>.ctx.as_mut().unwrap().update(buf); |
| } |
| |
| <span class="kw">if </span><span class="self">self</span>.ctx.is_none() || <span class="self">self</span>.client_auth_enabled { |
| <span class="self">self</span>.buffer.extend_from_slice(buf); |
| } |
| |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Get the hash value if we were to hash `extra` too, |
| /// using hash function `hash`. |
| </span><span class="kw">pub fn </span>get_hash_given(<span class="kw-2">&</span><span class="self">self</span>, hash: <span class="kw-2">&</span><span class="lifetime">'static </span>digest::Algorithm, extra: <span class="kw-2">&</span>[u8]) -> Vec<u8> { |
| <span class="kw">let </span><span class="kw-2">mut </span>ctx = <span class="kw">if </span><span class="self">self</span>.ctx.is_none() { |
| <span class="kw">let </span><span class="kw-2">mut </span>ctx = digest::Context::new(hash); |
| ctx.update(<span class="kw-2">&</span><span class="self">self</span>.buffer); |
| ctx |
| } <span class="kw">else </span>{ |
| <span class="self">self</span>.ctx.as_ref().unwrap().clone() |
| }; |
| |
| ctx.update(extra); |
| <span class="kw">let </span>hash = ctx.finish(); |
| <span class="kw">let </span><span class="kw-2">mut </span>ret = Vec::new(); |
| ret.extend_from_slice(hash.as_ref()); |
| ret |
| } |
| |
| <span class="doccomment">/// Take the current hash value, and encapsulate it in a |
| /// 'handshake_hash' handshake message. Start this hash |
| /// again, with that message at the front. |
| </span><span class="kw">pub fn </span>rollup_for_hrr(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="kw">let </span>old_hash = <span class="self">self</span>.ctx.take().unwrap().finish(); |
| <span class="kw">let </span>old_handshake_hash_msg = |
| HandshakeMessagePayload::build_handshake_hash(old_hash.as_ref()); |
| |
| <span class="self">self</span>.ctx = <span class="prelude-val">Some</span>(digest::Context::new(<span class="self">self</span>.alg.unwrap())); |
| <span class="self">self</span>.update_raw(<span class="kw-2">&</span>old_handshake_hash_msg.get_encoding()); |
| } |
| |
| <span class="doccomment">/// Get the current hash value. |
| </span><span class="kw">pub fn </span>get_current_hash(<span class="kw-2">&</span><span class="self">self</span>) -> Vec<u8> { |
| <span class="kw">let </span>hash = <span class="self">self |
| </span>.ctx |
| .as_ref() |
| .unwrap() |
| .clone() |
| .finish(); |
| <span class="kw">let </span><span class="kw-2">mut </span>ret = Vec::new(); |
| ret.extend_from_slice(hash.as_ref()); |
| ret |
| } |
| |
| <span class="doccomment">/// Takes this object's buffer containing all handshake messages |
| /// so far. This method only works once; it resets the buffer |
| /// to empty. |
| </span><span class="kw">pub fn </span>take_handshake_buf(<span class="kw-2">&mut </span><span class="self">self</span>) -> Vec<u8> { |
| <span class="macro">debug_assert!</span>(<span class="self">self</span>.client_auth_enabled); |
| mem::replace(<span class="kw-2">&mut </span><span class="self">self</span>.buffer, Vec::new()) |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>test { |
| <span class="kw">use </span><span class="kw">super</span>::HandshakeHash; |
| <span class="kw">use </span>ring::digest; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>hashes_correctly() { |
| <span class="kw">let </span><span class="kw-2">mut </span>hh = HandshakeHash::new(); |
| hh.update_raw(<span class="string">b"hello"</span>); |
| <span class="macro">assert_eq!</span>(hh.buffer.len(), <span class="number">5</span>); |
| hh.start_hash(<span class="kw-2">&</span>digest::SHA256); |
| <span class="macro">assert_eq!</span>(hh.buffer.len(), <span class="number">0</span>); |
| hh.update_raw(<span class="string">b"world"</span>); |
| <span class="kw">let </span>h = hh.get_current_hash(); |
| <span class="macro">assert_eq!</span>(h[<span class="number">0</span>], <span class="number">0x93</span>); |
| <span class="macro">assert_eq!</span>(h[<span class="number">1</span>], <span class="number">0x6a</span>); |
| <span class="macro">assert_eq!</span>(h[<span class="number">2</span>], <span class="number">0x18</span>); |
| <span class="macro">assert_eq!</span>(h[<span class="number">3</span>], <span class="number">0x5c</span>); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>buffers_correctly() { |
| <span class="kw">let </span><span class="kw-2">mut </span>hh = HandshakeHash::new(); |
| hh.set_client_auth_enabled(); |
| hh.update_raw(<span class="string">b"hello"</span>); |
| <span class="macro">assert_eq!</span>(hh.buffer.len(), <span class="number">5</span>); |
| hh.start_hash(<span class="kw-2">&</span>digest::SHA256); |
| <span class="macro">assert_eq!</span>(hh.buffer.len(), <span class="number">5</span>); |
| hh.update_raw(<span class="string">b"world"</span>); |
| <span class="macro">assert_eq!</span>(hh.buffer.len(), <span class="number">10</span>); |
| <span class="kw">let </span>h = hh.get_current_hash(); |
| <span class="macro">assert_eq!</span>(h[<span class="number">0</span>], <span class="number">0x93</span>); |
| <span class="macro">assert_eq!</span>(h[<span class="number">1</span>], <span class="number">0x6a</span>); |
| <span class="macro">assert_eq!</span>(h[<span class="number">2</span>], <span class="number">0x18</span>); |
| <span class="macro">assert_eq!</span>(h[<span class="number">3</span>], <span class="number">0x5c</span>); |
| <span class="kw">let </span>buf = hh.take_handshake_buf(); |
| <span class="macro">assert_eq!</span>(<span class="string">b"helloworld"</span>.to_vec(), buf); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>abandon() { |
| <span class="kw">let </span><span class="kw-2">mut </span>hh = HandshakeHash::new(); |
| hh.set_client_auth_enabled(); |
| hh.update_raw(<span class="string">b"hello"</span>); |
| <span class="macro">assert_eq!</span>(hh.buffer.len(), <span class="number">5</span>); |
| hh.start_hash(<span class="kw-2">&</span>digest::SHA256); |
| <span class="macro">assert_eq!</span>(hh.buffer.len(), <span class="number">5</span>); |
| hh.abandon_client_auth(); |
| <span class="macro">assert_eq!</span>(hh.buffer.len(), <span class="number">0</span>); |
| hh.update_raw(<span class="string">b"world"</span>); |
| <span class="macro">assert_eq!</span>(hh.buffer.len(), <span class="number">0</span>); |
| <span class="kw">let </span>h = hh.get_current_hash(); |
| <span class="macro">assert_eq!</span>(h[<span class="number">0</span>], <span class="number">0x93</span>); |
| <span class="macro">assert_eq!</span>(h[<span class="number">1</span>], <span class="number">0x6a</span>); |
| <span class="macro">assert_eq!</span>(h[<span class="number">2</span>], <span class="number">0x18</span>); |
| <span class="macro">assert_eq!</span>(h[<span class="number">3</span>], <span class="number">0x5c</span>); |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rustls" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
