| <!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/rustls-0.19.1/src/keylog.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>keylog.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> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::env; |
| <span class="kw">use </span>std::fs::{File, OpenOptions}; |
| <span class="kw">use </span>std::io; |
| <span class="kw">use </span>std::io::Write; |
| <span class="kw">use </span>std::path::Path; |
| <span class="kw">use </span>std::sync::Mutex; |
| |
| <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="doccomment">/// This trait represents the ability to do something useful |
| /// with key material, such as logging it to a file for debugging. |
| /// |
| /// Naturally, secrets passed over the interface are *extremely* |
| /// sensitive and can break the security of past, present and |
| /// future sessions. |
| /// |
| /// You'll likely want some interior mutability in your |
| /// implementation to make this useful. |
| /// |
| /// See `KeyLogFile` that implements the standard `SSLKEYLOGFILE` |
| /// environment variable behaviour. |
| </span><span class="kw">pub trait </span>KeyLog: Send + Sync { |
| <span class="doccomment">/// Log the given `secret`. `client_random` is provided for |
| /// session identification. `label` describes precisely what |
| /// `secret` means: |
| /// |
| /// - `CLIENT_RANDOM`: `secret` is the master secret for a TLSv1.2 session. |
| /// - `CLIENT_EARLY_TRAFFIC_SECRET`: `secret` encrypts early data |
| /// transmitted by a client |
| /// - `SERVER_HANDSHAKE_TRAFFIC_SECRET`: `secret` encrypts |
| /// handshake messages from the server during a TLSv1.3 handshake. |
| /// - `CLIENT_HANDSHAKE_TRAFFIC_SECRET`: `secret` encrypts |
| /// handshake messages from the client during a TLSv1.3 handshake. |
| /// - `SERVER_TRAFFIC_SECRET_0`: `secret` encrypts post-handshake data |
| /// from the server in a TLSv1.3 session. |
| /// - `CLIENT_TRAFFIC_SECRET_0`: `secret` encrypts post-handshake data |
| /// from the client in a TLSv1.3 session. |
| /// - `EXPORTER_SECRET`: `secret` is the post-handshake exporter secret |
| /// in a TLSv1.3 session. |
| /// |
| /// These strings are selected to match the NSS key log format: |
| /// https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/Key_Log_Format |
| </span><span class="kw">fn </span>log(<span class="kw-2">&</span><span class="self">self</span>, label: <span class="kw-2">&</span>str, client_random: <span class="kw-2">&</span>[u8], secret: <span class="kw-2">&</span>[u8]); |
| |
| <span class="doccomment">/// Indicates whether the secret with label `label` will be logged. |
| /// |
| /// If `will_log` returns true then `log` will be called with the secret. |
| /// Otherwise, `log` will not be called for the secret. This is a |
| /// performance optimization. |
| </span><span class="kw">fn </span>will_log(<span class="kw-2">&</span><span class="self">self</span>, _label: <span class="kw-2">&</span>str) -> bool { |
| <span class="bool-val">true |
| </span>} |
| } |
| |
| <span class="doccomment">/// KeyLog that does exactly nothing. |
| </span><span class="kw">pub struct </span>NoKeyLog; |
| |
| <span class="kw">impl </span>KeyLog <span class="kw">for </span>NoKeyLog { |
| <span class="kw">fn </span>log(<span class="kw-2">&</span><span class="self">self</span>, <span class="kw">_</span>: <span class="kw-2">&</span>str, <span class="kw">_</span>: <span class="kw-2">&</span>[u8], <span class="kw">_</span>: <span class="kw-2">&</span>[u8]) {} |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>will_log(<span class="kw-2">&</span><span class="self">self</span>, _label: <span class="kw-2">&</span>str) -> bool { |
| <span class="bool-val">false |
| </span>} |
| } |
| |
| <span class="comment">// Internal mutable state for KeyLogFile |
| </span><span class="kw">struct </span>KeyLogFileInner { |
| file: <span class="prelude-ty">Option</span><File>, |
| buf: Vec<u8>, |
| } |
| |
| <span class="kw">impl </span>KeyLogFileInner { |
| <span class="kw">fn </span>new(var: <span class="prelude-ty">Result</span><String, env::VarError>) -> <span class="self">Self </span>{ |
| <span class="kw">let </span>path = <span class="kw">match </span>var { |
| <span class="prelude-val">Ok</span>(<span class="kw-2">ref </span>s) => Path::new(s), |
| <span class="prelude-val">Err</span>(env::VarError::NotUnicode(<span class="kw-2">ref </span>s)) => Path::new(s), |
| <span class="prelude-val">Err</span>(env::VarError::NotPresent) => { |
| <span class="kw">return </span>KeyLogFileInner { |
| file: <span class="prelude-val">None</span>, |
| buf: Vec::new(), |
| }; |
| } |
| }; |
| |
| <span class="attribute">#[cfg_attr(not(feature = <span class="string">"logging"</span>), allow(unused_variables))] |
| </span><span class="kw">let </span>file = <span class="kw">match </span>OpenOptions::new() |
| .append(<span class="bool-val">true</span>) |
| .create(<span class="bool-val">true</span>) |
| .open(path) |
| { |
| <span class="prelude-val">Ok</span>(f) => <span class="prelude-val">Some</span>(f), |
| <span class="prelude-val">Err</span>(e) => { |
| <span class="macro">warn!</span>(<span class="string">"unable to create key log file {:?}: {}"</span>, path, e); |
| <span class="prelude-val">None |
| </span>} |
| }; |
| |
| KeyLogFileInner { |
| file, |
| buf: Vec::new(), |
| } |
| } |
| |
| <span class="kw">fn </span>try_write(<span class="kw-2">&mut </span><span class="self">self</span>, label: <span class="kw-2">&</span>str, client_random: <span class="kw-2">&</span>[u8], secret: <span class="kw-2">&</span>[u8]) -> io::Result<()> { |
| <span class="kw">let </span><span class="kw-2">mut </span>file = <span class="kw">match </span><span class="self">self</span>.file { |
| <span class="prelude-val">None </span>=> { |
| <span class="kw">return </span><span class="prelude-val">Ok</span>(()); |
| } |
| <span class="prelude-val">Some</span>(<span class="kw-2">ref </span>f) => f, |
| }; |
| |
| <span class="self">self</span>.buf.truncate(<span class="number">0</span>); |
| <span class="macro">write!</span>(<span class="self">self</span>.buf, <span class="string">"{} "</span>, label)<span class="question-mark">?</span>; |
| <span class="kw">for </span>b <span class="kw">in </span>client_random.iter() { |
| <span class="macro">write!</span>(<span class="self">self</span>.buf, <span class="string">"{:02x}"</span>, b)<span class="question-mark">?</span>; |
| } |
| <span class="macro">write!</span>(<span class="self">self</span>.buf, <span class="string">" "</span>)<span class="question-mark">?</span>; |
| <span class="kw">for </span>b <span class="kw">in </span>secret.iter() { |
| <span class="macro">write!</span>(<span class="self">self</span>.buf, <span class="string">"{:02x}"</span>, b)<span class="question-mark">?</span>; |
| } |
| <span class="macro">writeln!</span>(<span class="self">self</span>.buf)<span class="question-mark">?</span>; |
| file.write_all(<span class="kw-2">&</span><span class="self">self</span>.buf) |
| } |
| } |
| |
| <span class="doccomment">/// `KeyLog` implementation that opens a file whose name is |
| /// given by the `SSLKEYLOGFILE` environment variable, and writes |
| /// keys into it. |
| /// |
| /// If `SSLKEYLOGFILE` is not set, this does nothing. |
| /// |
| /// If such a file cannot be opened, or cannot be written then |
| /// this does nothing but logs errors at warning-level. |
| </span><span class="kw">pub struct </span>KeyLogFile(Mutex<KeyLogFileInner>); |
| |
| <span class="kw">impl </span>KeyLogFile { |
| <span class="doccomment">/// Makes a new `KeyLogFile`. The environment variable is |
| /// inspected and the named file is opened during this call. |
| </span><span class="kw">pub fn </span>new() -> <span class="self">Self </span>{ |
| <span class="kw">let </span>var = env::var(<span class="string">"SSLKEYLOGFILE"</span>); |
| KeyLogFile(Mutex::new(KeyLogFileInner::new(var))) |
| } |
| } |
| |
| <span class="kw">impl </span>KeyLog <span class="kw">for </span>KeyLogFile { |
| <span class="kw">fn </span>log(<span class="kw-2">&</span><span class="self">self</span>, label: <span class="kw-2">&</span>str, client_random: <span class="kw-2">&</span>[u8], secret: <span class="kw-2">&</span>[u8]) { |
| <span class="attribute">#[cfg_attr(not(feature = <span class="string">"logging"</span>), allow(unused_variables))] |
| </span><span class="kw">match </span><span class="self">self |
| </span>.<span class="number">0 |
| </span>.lock() |
| .unwrap() |
| .try_write(label, client_random, secret) |
| { |
| <span class="prelude-val">Ok</span>(()) => {} |
| <span class="prelude-val">Err</span>(e) => { |
| <span class="macro">warn!</span>(<span class="string">"error writing to key log file: {}"</span>, e); |
| } |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(all(test, target_os = <span class="string">"linux"</span>))] |
| </span><span class="kw">mod </span>test { |
| <span class="kw">use super</span>::<span class="kw-2">*</span>; |
| |
| <span class="kw">fn </span>init() { |
| <span class="kw">let _ </span>= env_logger::builder() |
| .is_test(<span class="bool-val">true</span>) |
| .try_init(); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_env_var_is_not_unicode() { |
| init(); |
| <span class="kw">let </span><span class="kw-2">mut </span>inner = KeyLogFileInner::new(<span class="prelude-val">Err</span>(env::VarError::NotUnicode( |
| <span class="string">"/tmp/keylogfileinnertest"</span>.into(), |
| ))); |
| <span class="macro">assert!</span>( |
| inner |
| .try_write(<span class="string">"label"</span>, <span class="string">b"random"</span>, <span class="string">b"secret"</span>) |
| .is_ok() |
| ); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_env_var_is_not_set() { |
| init(); |
| <span class="kw">let </span><span class="kw-2">mut </span>inner = KeyLogFileInner::new(<span class="prelude-val">Err</span>(env::VarError::NotPresent)); |
| <span class="macro">assert!</span>( |
| inner |
| .try_write(<span class="string">"label"</span>, <span class="string">b"random"</span>, <span class="string">b"secret"</span>) |
| .is_ok() |
| ); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_env_var_cannot_be_opened() { |
| init(); |
| <span class="kw">let </span><span class="kw-2">mut </span>inner = KeyLogFileInner::new(<span class="prelude-val">Ok</span>(<span class="string">"/dev/does-not-exist"</span>.into())); |
| <span class="macro">assert!</span>( |
| inner |
| .try_write(<span class="string">"label"</span>, <span class="string">b"random"</span>, <span class="string">b"secret"</span>) |
| .is_ok() |
| ); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_env_var_cannot_be_written() { |
| init(); |
| <span class="kw">let </span><span class="kw-2">mut </span>inner = KeyLogFileInner::new(<span class="prelude-val">Ok</span>(<span class="string">"/dev/full"</span>.into())); |
| <span class="macro">assert!</span>( |
| inner |
| .try_write(<span class="string">"label"</span>, <span class="string">b"random"</span>, <span class="string">b"secret"</span>) |
| .is_err() |
| ); |
| } |
| } |
| </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> |
