mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-06 03:58:39 +00:00
45 lines
21 KiB
HTML
45 lines
21 KiB
HTML
<!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="API documentation for the Rust `Hc128Rng` struct in crate `rand`."><meta name="keywords" content="rust, rustlang, rust-lang, Hc128Rng"><title>rand::prng::hc128::Hc128Rng - Rust</title><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script src="../../../storage.js"></script><link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico"></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../../rand/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk.png' alt='logo' width='100'></a><p class='location'>Struct Hc128Rng</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-RngCore">RngCore</a><a href="#impl-SeedableRng">SeedableRng</a><a href="#impl-CryptoRng">CryptoRng</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../../index.html'>rand</a>::<wbr><a href='../index.html'>prng</a>::<wbr><a href='index.html'>hc128</a></p><script>window.sidebarCurrent = {name: 'Hc128Rng', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='../../index.html'>rand</a>::<wbr><a href='../index.html'>prng</a>::<wbr><a href='index.html'>hc128</a>::<wbr><a class="struct" href=''>Hc128Rng</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../../src/rand/prng/hc128.rs.html#72' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct Hc128Rng(_);</pre></div><div class='docblock'><p>A cryptographically secure random number generator that uses the HC-128
|
||
algorithm.</p>
|
||
<p>HC-128 is a stream cipher designed by Hongjun Wu<sup id="fnref1"><a href="#fn1">1</a></sup>, that we use as an
|
||
RNG. It is selected as one of the "stream ciphers suitable for widespread
|
||
adoption" by eSTREAM<sup id="fnref2"><a href="#fn2">2</a></sup>.</p>
|
||
<p>HC-128 is an array based RNG. In this it is similar to RC-4 and ISAAC before
|
||
it, but those have never been proven cryptographically secure (or have even
|
||
been significantly compromised, as in the case of RC-4<sup id="fnref3"><a href="#fn3">3</a></sup>).</p>
|
||
<p>Because HC-128 works with simple indexing into a large array and with a few
|
||
operations that parallelize well, it has very good performance. The size of
|
||
the array it needs, 4kb, can however be a disadvantage.</p>
|
||
<p>This implementation is not based on the version of HC-128 submitted to the
|
||
eSTREAM contest, but on a later version by the author with a few small
|
||
improvements from December 15, 2009<sup id="fnref4"><a href="#fn4">4</a></sup>.</p>
|
||
<p>HC-128 has no known weaknesses that are easier to exploit than doing a
|
||
brute-force search of 2<sup>128</sup>. A very comprehensive analysis of the
|
||
current state of known attacks / weaknesses of HC-128 is given in <em>Some
|
||
Results On Analysis And Implementation Of HC-128 Stream Cipher</em><sup id="fnref5"><a href="#fn5">5</a></sup>.</p>
|
||
<p>The average cycle length is expected to be
|
||
2<sup>1024*32+10-1</sup> = 2<sup>32777</sup>.
|
||
We support seeding with a 256-bit array, which matches the 128-bit key
|
||
concatenated with a 128-bit IV from the stream cipher.</p>
|
||
<p>This implementation uses an output buffer of sixteen <code>u32</code> words, and uses
|
||
<a href="../../../rand_core/block/struct.BlockRng.html"><code>BlockRng</code></a> to implement the <a href="../../trait.RngCore.html"><code>RngCore</code></a> methods.</p>
|
||
<h2 id="references" class="section-header"><a href="#references">References</a></h2><div class="footnotes"><hr><ol><li id="fn1">
|
||
<p>Hongjun Wu (2008). <a href="http://www.ecrypt.eu.org/stream/p3ciphers/hc/hc128_p3.pdf">"The Stream Cipher HC-128"</a>.
|
||
<em>The eSTREAM Finalists</em>, LNCS 4986, pp. 39–47, Springer-Verlag. <a href="#fnref1" rev="footnote">↩</a></p></li><li id="fn2">
|
||
<p><a href="http://www.ecrypt.eu.org/stream/">eSTREAM: the ECRYPT Stream Cipher Project</a> <a href="#fnref2" rev="footnote">↩</a></p></li><li id="fn3">
|
||
<p>Internet Engineering Task Force (February 2015),
|
||
<a href="https://tools.ietf.org/html/rfc7465">"Prohibiting RC4 Cipher Suites"</a>. <a href="#fnref3" rev="footnote">↩</a></p></li><li id="fn4">
|
||
<p>Hongjun Wu, <a href="https://www.ntu.edu.sg/home/wuhj/research/hc/index.html">Stream Ciphers HC-128 and HC-256</a> <a href="#fnref4" rev="footnote">↩</a></p></li><li id="fn5">
|
||
<p>Shashwat Raizada (January 2015),<a href="http://library.isical.ac.in:8080/jspui/bitstream/123456789/6636/1/TH431.pdf">"Some Results On Analysis And
|
||
Implementation Of HC-128 Stream Cipher"</a>. <a href="#fnref5" rev="footnote">↩</a></p></li></ol></div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../../rand/prng/hc128/struct.Hc128Rng.html" title="struct rand::prng::hc128::Hc128Rng">Hc128Rng</a></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/prng/hc128.rs.html#71' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../../../rand/prng/hc128/struct.Hc128Rng.html" title="struct rand::prng::hc128::Hc128Rng">Hc128Rng</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/prng/hc128.rs.html#71' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130-132' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../../rand/prng/hc128/struct.Hc128Rng.html" title="struct rand::prng::hc128::Hc128Rng">Hc128Rng</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/prng/hc128.rs.html#71' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/prng/hc128.rs.html#71' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></div><h3 id='impl-RngCore' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../../rand/trait.RngCore.html" title="trait rand::RngCore">RngCore</a> for <a class="struct" href="../../../rand/prng/hc128/struct.Hc128Rng.html" title="struct rand::prng::hc128::Hc128Rng">Hc128Rng</a></code><a href='#impl-RngCore' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/prng/hc128.rs.html#74-92' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.next_u32' class="method"><span id='next_u32.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../rand/trait.RngCore.html#tymethod.next_u32' class='fnname'>next_u32</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/prng/hc128.rs.html#76-78' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Return the next random <code>u32</code>. <a href="../../../rand/trait.RngCore.html#tymethod.next_u32">Read more</a></p>
|
||
</div><h4 id='method.next_u64' class="method"><span id='next_u64.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../rand/trait.RngCore.html#tymethod.next_u64' class='fnname'>next_u64</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/prng/hc128.rs.html#81-83' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Return the next random <code>u64</code>. <a href="../../../rand/trait.RngCore.html#tymethod.next_u64">Read more</a></p>
|
||
</div><h4 id='method.fill_bytes' class="method"><span id='fill_bytes.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../rand/trait.RngCore.html#tymethod.fill_bytes' class='fnname'>fill_bytes</a>(&mut self, dest: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/prng/hc128.rs.html#85-87' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Fill <code>dest</code> with random data. <a href="../../../rand/trait.RngCore.html#tymethod.fill_bytes">Read more</a></p>
|
||
</div><h4 id='method.try_fill_bytes' class="method"><span id='try_fill_bytes.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../rand/trait.RngCore.html#tymethod.try_fill_bytes' class='fnname'>try_fill_bytes</a>(&mut self, dest: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../../../rand/struct.Error.html" title="struct rand::Error">Error</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/prng/hc128.rs.html#89-91' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Fill <code>dest</code> entirely with random data. <a href="../../../rand/trait.RngCore.html#tymethod.try_fill_bytes">Read more</a></p>
|
||
</div></div><h3 id='impl-SeedableRng' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../../rand/trait.SeedableRng.html" title="trait rand::SeedableRng">SeedableRng</a> for <a class="struct" href="../../../rand/prng/hc128/struct.Hc128Rng.html" title="struct rand::prng::hc128::Hc128Rng">Hc128Rng</a></code><a href='#impl-SeedableRng' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/prng/hc128.rs.html#94-104' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Seed' class="type"><span id='Seed.t' class='invisible'><code>type <a href='../../../rand/trait.SeedableRng.html#associatedtype.Seed' class="type">Seed</a> = <<a class="struct" href="../../../rand/prng/hc128/struct.Hc128Core.html" title="struct rand::prng::hc128::Hc128Core">Hc128Core</a> as <a class="trait" href="../../../rand/trait.SeedableRng.html" title="trait rand::SeedableRng">SeedableRng</a>>::<a class="type" href="../../../rand/trait.SeedableRng.html#associatedtype.Seed" title="type rand::SeedableRng::Seed">Seed</a></code></span></h4>
|
||
<div class='docblock'><p>Seed type, which is restricted to types mutably-dereferencable as <code>u8</code> arrays (we recommend <code>[u8; N]</code> for some <code>N</code>). <a href="../../../rand/trait.SeedableRng.html#associatedtype.Seed">Read more</a></p>
|
||
</div><h4 id='method.from_seed' class="method"><span id='from_seed.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../rand/trait.SeedableRng.html#tymethod.from_seed' class='fnname'>from_seed</a>(seed: Self::<a class="type" href="../../../rand/trait.SeedableRng.html#associatedtype.Seed" title="type rand::SeedableRng::Seed">Seed</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/prng/hc128.rs.html#97-99' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a new PRNG using the given seed. <a href="../../../rand/trait.SeedableRng.html#tymethod.from_seed">Read more</a></p>
|
||
</div><h4 id='method.from_rng' class="method"><span id='from_rng.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../rand/trait.SeedableRng.html#method.from_rng' class='fnname'>from_rng</a><R: <a class="trait" href="../../../rand/trait.RngCore.html" title="trait rand::RngCore">RngCore</a>>(rng: R) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="../../../rand/struct.Error.html" title="struct rand::Error">Error</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/prng/hc128.rs.html#101-103' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a new PRNG seeded from another <code>Rng</code>. <a href="../../../rand/trait.SeedableRng.html#method.from_rng">Read more</a></p>
|
||
</div><h4 id='method.seed_from_u64' class="method"><span id='seed_from_u64.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../rand/trait.SeedableRng.html#method.seed_from_u64' class='fnname'>seed_from_u64</a>(state: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand_core/lib.rs.html#315-338' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a new PRNG using a <code>u64</code> seed. <a href="../../../rand/trait.SeedableRng.html#method.seed_from_u64">Read more</a></p>
|
||
</div></div><h3 id='impl-CryptoRng' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../../rand/trait.CryptoRng.html" title="trait rand::CryptoRng">CryptoRng</a> for <a class="struct" href="../../../rand/prng/hc128/struct.Hc128Rng.html" title="struct rand::prng::hc128::Hc128Rng">Hc128Rng</a></code><a href='#impl-CryptoRng' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/rand/prng/hc128.rs.html#106' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'></div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../../rand/prng/hc128/struct.Hc128Rng.html" title="struct rand::prng::hc128::Hc128Rng">Hc128Rng</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../../rand/prng/hc128/struct.Hc128Rng.html" title="struct rand::prng::hc128::Hc128Rng">Hc128Rng</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "rand";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html> |