| <!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/ticketer.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>ticketer.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> |
| <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> |
| </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::rand; |
| <span class="kw">use </span><span class="kw">crate</span>::server::ProducesTickets; |
| |
| <span class="kw">use </span>ring::aead; |
| <span class="kw">use </span>std::mem; |
| <span class="kw">use </span>std::sync::{Arc, Mutex}; |
| <span class="kw">use </span>std::time; |
| |
| <span class="doccomment">/// The timebase for expiring and rolling tickets and ticketing |
| /// keys. This is UNIX wall time in seconds. |
| </span><span class="kw">pub fn </span>timebase() -> u64 { |
| time::SystemTime::now() |
| .duration_since(time::UNIX_EPOCH) |
| .unwrap() |
| .as_secs() |
| } |
| |
| <span class="doccomment">/// This is a `ProducesTickets` implementation which uses |
| /// any *ring* `aead::Algorithm` to encrypt and authentication |
| /// the ticket payload. It does not enforce any lifetime |
| /// constraint. |
| </span><span class="kw">pub struct </span>AEADTicketer { |
| alg: <span class="kw-2">&</span><span class="lifetime">'static </span>aead::Algorithm, |
| key: aead::LessSafeKey, |
| lifetime: u32, |
| } |
| |
| <span class="kw">impl </span>AEADTicketer { |
| <span class="doccomment">/// Make a new `AEADTicketer` using the given `alg`, `key` material |
| /// and advertised `lifetime_seconds`. Note that `lifetime_seconds` |
| /// does not affect the lifetime of the key. `key` must be the |
| /// right length for `alg` or this will panic. |
| </span><span class="kw">pub fn </span>new_custom( |
| alg: <span class="kw-2">&</span><span class="lifetime">'static </span>aead::Algorithm, |
| key: <span class="kw-2">&</span>[u8], |
| lifetime_seconds: u32, |
| ) -> AEADTicketer { |
| <span class="kw">let </span>key = aead::UnboundKey::new(alg, key).unwrap(); |
| AEADTicketer { |
| alg, |
| key: aead::LessSafeKey::new(key), |
| lifetime: lifetime_seconds, |
| } |
| } |
| |
| <span class="doccomment">/// Make a ticketer with recommended configuration and a random key. |
| </span><span class="kw">pub fn </span>new() -> AEADTicketer { |
| <span class="kw">let </span><span class="kw-2">mut </span>key = [<span class="number">0u8</span>; <span class="number">32</span>]; |
| rand::fill_random(<span class="kw-2">&mut </span>key); |
| AEADTicketer::new_custom(<span class="kw-2">&</span>aead::CHACHA20_POLY1305, <span class="kw-2">&</span>key, <span class="number">60 </span>* <span class="number">60 </span>* <span class="number">12</span>) |
| } |
| } |
| |
| <span class="kw">impl </span>ProducesTickets <span class="kw">for </span>AEADTicketer { |
| <span class="kw">fn </span>enabled(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="bool-val">true |
| </span>} |
| <span class="kw">fn </span>get_lifetime(<span class="kw-2">&</span><span class="self">self</span>) -> u32 { |
| <span class="self">self</span>.lifetime |
| } |
| |
| <span class="doccomment">/// Encrypt `message` and return the ciphertext. |
| </span><span class="kw">fn </span>encrypt(<span class="kw-2">&</span><span class="self">self</span>, message: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Option</span><Vec<u8>> { |
| <span class="comment">// Random nonce, because a counter is a privacy leak. |
| </span><span class="kw">let </span><span class="kw-2">mut </span>nonce_buf = [<span class="number">0u8</span>; <span class="number">12</span>]; |
| rand::fill_random(<span class="kw-2">&mut </span>nonce_buf); |
| <span class="kw">let </span>nonce = ring::aead::Nonce::assume_unique_for_key(nonce_buf); |
| <span class="kw">let </span>aad = ring::aead::Aad::empty(); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>ciphertext = |
| Vec::with_capacity(nonce_buf.len() + message.len() + <span class="self">self</span>.key.algorithm().tag_len()); |
| ciphertext.extend(<span class="kw-2">&</span>nonce_buf); |
| ciphertext.extend(message); |
| <span class="self">self</span>.key |
| .seal_in_place_separate_tag(nonce, aad, <span class="kw-2">&mut </span>ciphertext[nonce_buf.len()..]) |
| .map(|tag| { |
| ciphertext.extend(tag.as_ref()); |
| ciphertext |
| }) |
| .ok() |
| } |
| |
| <span class="doccomment">/// Decrypt `ciphertext` and recover the original message. |
| </span><span class="kw">fn </span>decrypt(<span class="kw-2">&</span><span class="self">self</span>, ciphertext: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Option</span><Vec<u8>> { |
| <span class="kw">let </span>nonce_len = <span class="self">self</span>.alg.nonce_len(); |
| <span class="kw">let </span>tag_len = <span class="self">self</span>.alg.tag_len(); |
| |
| <span class="kw">if </span>ciphertext.len() < nonce_len + tag_len { |
| <span class="kw">return </span><span class="prelude-val">None</span>; |
| } |
| |
| <span class="kw">let </span>nonce = |
| ring::aead::Nonce::try_assume_unique_for_key(<span class="kw-2">&</span>ciphertext[<span class="number">0</span>..nonce_len]).unwrap(); |
| <span class="kw">let </span>aad = ring::aead::Aad::empty(); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>out = Vec::new(); |
| out.extend_from_slice(<span class="kw-2">&</span>ciphertext[nonce_len..]); |
| |
| <span class="kw">let </span>plain_len = <span class="kw">match </span><span class="self">self |
| </span>.key |
| .open_in_place(nonce, aad, <span class="kw-2">&mut </span>out) |
| { |
| <span class="prelude-val">Ok</span>(plaintext) => plaintext.len(), |
| <span class="prelude-val">Err</span>(..) => { |
| <span class="kw">return </span><span class="prelude-val">None</span>; |
| } |
| }; |
| |
| out.truncate(plain_len); |
| <span class="prelude-val">Some</span>(out) |
| } |
| } |
| |
| <span class="kw">struct </span>TicketSwitcherState { |
| current: Box<<span class="kw">dyn </span>ProducesTickets>, |
| previous: <span class="prelude-ty">Option</span><Box<<span class="kw">dyn </span>ProducesTickets>>, |
| next_switch_time: u64, |
| } |
| |
| <span class="doccomment">/// A ticketer that has a 'current' sub-ticketer and a single |
| /// 'previous' ticketer. It creates a new ticketer every so |
| /// often, demoting the current ticketer. |
| </span><span class="kw">pub struct </span>TicketSwitcher { |
| generator: <span class="kw">fn</span>() -> Box<<span class="kw">dyn </span>ProducesTickets>, |
| lifetime: u32, |
| state: Mutex<TicketSwitcherState>, |
| } |
| |
| <span class="kw">impl </span>TicketSwitcher { |
| <span class="doccomment">/// `lifetime` is in seconds, and is how long the current ticketer |
| /// is used to generate new tickets. Tickets are accepted for no |
| /// longer than twice this duration. `generator` produces a new |
| /// `ProducesTickets` implementation. |
| </span><span class="kw">pub fn </span>new(lifetime: u32, generator: <span class="kw">fn</span>() -> Box<<span class="kw">dyn </span>ProducesTickets>) -> TicketSwitcher { |
| TicketSwitcher { |
| generator, |
| lifetime, |
| state: Mutex::new(TicketSwitcherState { |
| current: generator(), |
| previous: <span class="prelude-val">None</span>, |
| next_switch_time: timebase() + u64::from(lifetime), |
| }), |
| } |
| } |
| |
| <span class="doccomment">/// If it's time, demote the `current` ticketer to `previous` (so it |
| /// does no new encryptions but can do decryptions) and make a fresh |
| /// `current` ticketer. |
| /// |
| /// Calling this regularly will ensure timely key erasure. Otherwise, |
| /// key erasure will be delayed until the next encrypt/decrypt call. |
| </span><span class="kw">pub fn </span>maybe_roll(<span class="kw-2">&</span><span class="self">self</span>) { |
| <span class="kw">let </span><span class="kw-2">mut </span>state = <span class="self">self</span>.state.lock().unwrap(); |
| <span class="kw">let </span>now = timebase(); |
| |
| <span class="kw">if </span>now > state.next_switch_time { |
| state.previous = <span class="prelude-val">Some</span>(mem::replace(<span class="kw-2">&mut </span>state.current, (<span class="self">self</span>.generator)())); |
| state.next_switch_time = now + u64::from(<span class="self">self</span>.lifetime); |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>ProducesTickets <span class="kw">for </span>TicketSwitcher { |
| <span class="kw">fn </span>get_lifetime(<span class="kw-2">&</span><span class="self">self</span>) -> u32 { |
| <span class="self">self</span>.lifetime * <span class="number">2 |
| </span>} |
| |
| <span class="kw">fn </span>enabled(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="bool-val">true |
| </span>} |
| |
| <span class="kw">fn </span>encrypt(<span class="kw-2">&</span><span class="self">self</span>, message: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Option</span><Vec<u8>> { |
| <span class="self">self</span>.maybe_roll(); |
| |
| <span class="self">self</span>.state |
| .lock() |
| .unwrap() |
| .current |
| .encrypt(message) |
| } |
| |
| <span class="kw">fn </span>decrypt(<span class="kw-2">&</span><span class="self">self</span>, ciphertext: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Option</span><Vec<u8>> { |
| <span class="self">self</span>.maybe_roll(); |
| |
| <span class="kw">let </span>state = <span class="self">self</span>.state.lock().unwrap(); |
| <span class="kw">let </span>rc = state.current.decrypt(ciphertext); |
| |
| <span class="kw">if </span>rc.is_none() && state.previous.is_some() { |
| state |
| .previous |
| .as_ref() |
| .unwrap() |
| .decrypt(ciphertext) |
| } <span class="kw">else </span>{ |
| rc |
| } |
| } |
| } |
| |
| <span class="doccomment">/// A concrete, safe ticket creation mechanism. |
| </span><span class="kw">pub struct </span>Ticketer {} |
| |
| <span class="kw">fn </span>generate_inner() -> Box<<span class="kw">dyn </span>ProducesTickets> { |
| Box::new(AEADTicketer::new()) |
| } |
| |
| <span class="kw">impl </span>Ticketer { |
| <span class="doccomment">/// Make the recommended Ticketer. This produces tickets |
| /// with a 12 hour life and randomly generated keys. |
| /// |
| /// The encryption mechanism used in Chacha20Poly1305. |
| </span><span class="kw">pub fn </span>new() -> Arc<<span class="kw">dyn </span>ProducesTickets> { |
| Arc::new(TicketSwitcher::new(<span class="number">6 </span>* <span class="number">60 </span>* <span class="number">60</span>, generate_inner)) |
| } |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>basic_pairwise_test() { |
| <span class="kw">let </span>t = Ticketer::new(); |
| <span class="macro">assert_eq!</span>(<span class="bool-val">true</span>, t.enabled()); |
| <span class="kw">let </span>cipher = t.encrypt(<span class="string">b"hello world"</span>).unwrap(); |
| <span class="kw">let </span>plain = t.decrypt(<span class="kw-2">&</span>cipher).unwrap(); |
| <span class="macro">assert_eq!</span>(plain, <span class="string">b"hello world"</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> |
