|
|
|
|
|
<!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 `rand_jitter` crate."><meta name="keywords" content="rust, rustlang, rust-lang, rand_jitter"><title>rand_jitter - 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[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_jitter/index.html'><div class='logo-container'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk.png' alt='logo'></div></a><p class='location'>Crate rand_jitter</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all rand_jitter's items</p></a><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'rand_jitter', ty: 'mod', relpath: '../'};</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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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='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_jitter/lib.rs.html#15-717' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>rand_jitter</a></span></h1><div class='docblock'><p>Non-physical true random number generator based on timing jitter.</p>
|
|
|
|
|
|
<p>This is a true random number generator, as opposed to pseudo-random
|
|
|
|
|
|
generators. Random numbers generated by <code>JitterRng</code> can be seen as fresh
|
|
|
|
|
|
entropy. A consequence is that it is orders of magnitude slower than <code>OsRng</code>
|
|
|
|
|
|
and PRNGs (about 10<sup>3</sup>..10<sup>6</sup> slower).</p>
|
|
|
|
|
|
<p>There are very few situations where using this RNG is appropriate. Only very
|
|
|
|
|
|
few applications require true entropy. A normal PRNG can be statistically
|
|
|
|
|
|
indistinguishable, and a cryptographic PRNG should also be as impossible to
|
|
|
|
|
|
predict.</p>
|
|
|
|
|
|
<p>Use of <code>JitterRng</code> is recommended for initializing cryptographic PRNGs when
|
|
|
|
|
|
<code>OsRng</code> is not available.</p>
|
|
|
|
|
|
<p><code>JitterRng</code> can be used without the standard library, but not conveniently,
|
|
|
|
|
|
you must provide a high-precision timer and carefully have to follow the
|
|
|
|
|
|
instructions of [<code>JitterRng::new_with_timer</code>].</p>
|
|
|
|
|
|
<p>This implementation is based on <a href="http://www.chronox.de/jent.html">Jitterentropy</a> version 2.1.0.</p>
|
|
|
|
|
|
<p>Note: There is no accurate timer available on WASM platforms, to help
|
|
|
|
|
|
prevent fingerprinting or timing side-channel attacks. Therefore
|
|
|
|
|
|
[<code>JitterRng::new()</code>] is not available on WASM. It is also unavailable
|
|
|
|
|
|
with disabled <code>std</code> feature.</p>
|
|
|
|
|
|
</div><h2 id='reexports' class='section-header'><a href="#reexports">Re-exports</a></h2>
|
|
|
|
|
|
<table><tr><td><code>pub extern crate <a class="mod" href="../rand_core/index.html" title="mod rand_core">rand_core</a>;</code></td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|
|
|
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.JitterRng.html" title='rand_jitter::JitterRng struct'>JitterRng</a></td><td class='docblock-short'><p>A true random number generator based on jitter in the CPU execution time,
|
|
|
|
|
|
and jitter in memory access time.</p>
|
|
|
|
|
|
</td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
|
|
|
|
|
<table><tr class='module-item'><td><a class="enum" href="enum.TimerError.html" title='rand_jitter::TimerError enum'>TimerError</a></td><td class='docblock-short'><p>An error that can occur when <a href="crate::JitterRng::test_timer"><code>JitterRng::test_timer</code></a> fails.</p>
|
|
|
|
|
|
</td></tr></table></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_jitter";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
