blob: 5e05eb78b31519d7d6100388cd92812b46ee2af8 [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/sunhe/incubator-teaclave/third_party/rust-sgx-sdk/sgx_rand/src/reseeding.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>reseeding.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="../../sgx_rand/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="../../sgx_rand/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>
</pre><pre class="rust"><code><span class="comment">// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// &quot;License&quot;); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License..
</span><span class="doccomment">//! A wrapper around another RNG that reseeds it after it
//! generates a certain number of random bytes.
</span><span class="kw">use </span>std::default::Default;
<span class="kw">use crate</span>::{Rng, SeedableRng};
<span class="doccomment">/// How many bytes of entropy the underling RNG is allowed to generate
/// before it is reseeded
</span><span class="kw">const </span>DEFAULT_GENERATION_THRESHOLD: u64 = <span class="number">32 </span>* <span class="number">1024</span>;
<span class="doccomment">/// A wrapper around any RNG which reseeds the underlying RNG after it
/// has generated a certain number of random bytes.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>ReseedingRng&lt;R, Rsdr&gt; {
rng: R,
generation_threshold: u64,
bytes_generated: u64,
<span class="doccomment">/// Controls the behaviour when reseeding the RNG.
</span><span class="kw">pub </span>reseeder: Rsdr,
}
<span class="kw">impl</span>&lt;R: Rng, Rsdr: Reseeder&lt;R&gt;&gt; ReseedingRng&lt;R, Rsdr&gt; {
<span class="doccomment">/// Create a new `ReseedingRng` with the given parameters.
///
/// # Arguments
///
/// * `rng`: the random number generator to use.
/// * `generation_threshold`: the number of bytes of entropy at which to reseed the RNG.
/// * `reseeder`: the reseeding object to use.
</span><span class="kw">pub fn </span>new(rng: R, generation_threshold: u64, reseeder: Rsdr) -&gt; ReseedingRng&lt;R, Rsdr&gt; {
ReseedingRng {
rng,
generation_threshold,
bytes_generated: <span class="number">0</span>,
reseeder,
}
}
<span class="doccomment">/// Reseed the internal RNG if the number of bytes that have been
/// generated exceed the threshold.
</span><span class="kw">pub fn </span>reseed_if_necessary(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="kw">if </span><span class="self">self</span>.bytes_generated &gt;= <span class="self">self</span>.generation_threshold {
<span class="self">self</span>.reseeder.reseed(<span class="kw-2">&amp;mut </span><span class="self">self</span>.rng);
<span class="self">self</span>.bytes_generated = <span class="number">0</span>;
}
}
}
<span class="kw">impl</span>&lt;R: Rng, Rsdr: Reseeder&lt;R&gt;&gt; Rng <span class="kw">for </span>ReseedingRng&lt;R, Rsdr&gt; {
<span class="kw">fn </span>next_u32(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; u32 {
<span class="self">self</span>.reseed_if_necessary();
<span class="self">self</span>.bytes_generated += <span class="number">4</span>;
<span class="self">self</span>.rng.next_u32()
}
<span class="kw">fn </span>next_u64(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; u64 {
<span class="self">self</span>.reseed_if_necessary();
<span class="self">self</span>.bytes_generated += <span class="number">8</span>;
<span class="self">self</span>.rng.next_u64()
}
<span class="kw">fn </span>fill_bytes(<span class="kw-2">&amp;mut </span><span class="self">self</span>, dest: <span class="kw-2">&amp;mut </span>[u8]) {
<span class="self">self</span>.reseed_if_necessary();
<span class="self">self</span>.bytes_generated += dest.len() <span class="kw">as </span>u64;
<span class="self">self</span>.rng.fill_bytes(dest)
}
}
<span class="kw">impl</span>&lt;S, R: SeedableRng&lt;S&gt;, Rsdr: Reseeder&lt;R&gt; + Default&gt; SeedableRng&lt;(Rsdr, S)&gt;
<span class="kw">for </span>ReseedingRng&lt;R, Rsdr&gt;
{
<span class="kw">fn </span>reseed(<span class="kw-2">&amp;mut </span><span class="self">self</span>, (rsdr, seed): (Rsdr, S)) {
<span class="self">self</span>.rng.reseed(seed);
<span class="self">self</span>.reseeder = rsdr;
<span class="self">self</span>.bytes_generated = <span class="number">0</span>;
}
<span class="doccomment">/// Create a new `ReseedingRng` from the given reseeder and
/// seed. This uses a default value for `generation_threshold`.
</span><span class="kw">fn </span>from_seed((rsdr, seed): (Rsdr, S)) -&gt; ReseedingRng&lt;R, Rsdr&gt; {
ReseedingRng {
rng: SeedableRng::from_seed(seed),
generation_threshold: DEFAULT_GENERATION_THRESHOLD,
bytes_generated: <span class="number">0</span>,
reseeder: rsdr,
}
}
}
<span class="attribute">#[allow(clippy::needless_doctest_main)]
</span><span class="doccomment">/// Something that can be used to reseed an RNG via `ReseedingRng`.
///
/// # Example
///
/// ```rust
/// use sgx_rand::{Rng, SeedableRng, StdRng};
/// use sgx_rand::reseeding::{Reseeder, ReseedingRng};
///
/// struct TickTockReseeder { tick: bool }
/// impl Reseeder&lt;StdRng&gt; for TickTockReseeder {
/// fn reseed(&amp;mut self, rng: &amp;mut StdRng) {
/// let val = if self.tick {0} else {1};
/// rng.reseed(&amp;[val]);
/// self.tick = !self.tick;
/// }
/// }
/// fn main() {
/// let rsdr = TickTockReseeder { tick: true };
///
/// let inner = StdRng::new().unwrap();
/// let mut rng = ReseedingRng::new(inner, 10, rsdr);
///
/// // this will repeat, because it gets reseeded very regularly.
/// let s: String = rng.gen_ascii_chars().take(100).collect();
/// println!(&quot;{}&quot;, s);
/// }
///
/// ```
</span><span class="kw">pub trait </span>Reseeder&lt;R&gt; {
<span class="doccomment">/// Reseed the given RNG.
</span><span class="kw">fn </span>reseed(<span class="kw-2">&amp;mut </span><span class="self">self</span>, rng: <span class="kw-2">&amp;mut </span>R);
}
<span class="doccomment">/// Reseed an RNG using a `Default` instance. This reseeds by
/// replacing the RNG with the result of a `Default::default` call.
</span><span class="attribute">#[derive(Clone, Copy, Debug)]
</span><span class="kw">pub struct </span>ReseedWithDefault;
<span class="kw">impl</span>&lt;R: Rng + Default&gt; Reseeder&lt;R&gt; <span class="kw">for </span>ReseedWithDefault {
<span class="kw">fn </span>reseed(<span class="kw-2">&amp;mut </span><span class="self">self</span>, rng: <span class="kw-2">&amp;mut </span>R) {
<span class="kw-2">*</span>rng = Default::default();
}
}
<span class="kw">impl </span>Default <span class="kw">for </span>ReseedWithDefault {
<span class="kw">fn </span>default() -&gt; ReseedWithDefault {
ReseedWithDefault
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="sgx_rand" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>