<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>Crypto++: AutoSeededX917RNG< BLOCK_CIPHER > Class Template Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.1 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div> <div class="contents"> <h1>AutoSeededX917RNG< BLOCK_CIPHER > Class Template Reference</h1><!-- doxytag: class="AutoSeededX917RNG" --><!-- doxytag: inherits="RandomNumberGenerator,NotCopyable" --> <p>RNG from ANSI X9.17 Appendix C, seeded using an OS provided RNG. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="osrng_8h_source.html">osrng.h</a>></code></p> <div class="dynheader"> Inheritance diagram for AutoSeededX917RNG< BLOCK_CIPHER >:</div> <div class="dynsection"> <div class="center"> <img src="class_auto_seeded_x917_r_n_g.gif" usemap="#AutoSeededX917RNG< BLOCK_CIPHER >_map" alt=""/> <map id="AutoSeededX917RNG< BLOCK_CIPHER >_map" name="AutoSeededX917RNG< BLOCK_CIPHER >_map"> <area href="class_random_number_generator.html" alt="RandomNumberGenerator" shape="rect" coords="0,112,255,136"/> <area href="class_not_copyable.html" alt="NotCopyable" shape="rect" coords="265,112,520,136"/> <area href="class_algorithm.html" alt="Algorithm" shape="rect" coords="0,56,255,80"/> <area href="class_clonable.html" alt="Clonable" shape="rect" coords="0,0,255,24"/> </map> </div> </div> <p><a href="class_auto_seeded_x917_r_n_g-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a569086bfb40b4be6377b0ec977d01219"></a><!-- doxytag: member="AutoSeededX917RNG::AutoSeededX917RNG" ref="a569086bfb40b4be6377b0ec977d01219" args="(bool blocking=false)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_auto_seeded_x917_r_n_g.html#a569086bfb40b4be6377b0ec977d01219">AutoSeededX917RNG</a> (bool blocking=false)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">use blocking to choose seeding with <a class="el" href="class_blocking_rng.html" title="encapsulate /dev/random, or /dev/srandom on OpenBSD">BlockingRng</a> or <a class="el" href="class_nonblocking_rng.html" title="encapsulate CryptoAPI's CryptGenRandom or /dev/urandom">NonblockingRng</a>. the parameter is ignored if only one of these is available <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa36420ffc4fb2acf9bc693d65da2e1c6"></a><!-- doxytag: member="AutoSeededX917RNG::Reseed" ref="aa36420ffc4fb2acf9bc693d65da2e1c6" args="(bool blocking=false, const byte *additionalEntropy=NULL, size_t length=0)" --> void </td><td class="memItemRight" valign="bottom"><b>Reseed</b> (bool blocking=false, const byte *additionalEntropy=NULL, size_t length=0)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ff4b2fb3e774fa8adb800bb3a21d0b8"></a><!-- doxytag: member="AutoSeededX917RNG::Reseed" ref="a9ff4b2fb3e774fa8adb800bb3a21d0b8" args="(const byte *key, size_t keylength, const byte *seed, const byte *timeVector)" --> void </td><td class="memItemRight" valign="bottom"><b>Reseed</b> (const byte *key, size_t keylength, const byte *seed, const byte *timeVector)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1afd993309faa21d6384657f1e299414"></a><!-- doxytag: member="AutoSeededX917RNG::CanIncorporateEntropy" ref="a1afd993309faa21d6384657f1e299414" args="() const " --> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_auto_seeded_x917_r_n_g.html#a1afd993309faa21d6384657f1e299414">CanIncorporateEntropy</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">returns true if IncorporateEntropy is implemented <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a657ec405854e19eb52fe0f9a6bddc289"></a><!-- doxytag: member="AutoSeededX917RNG::IncorporateEntropy" ref="a657ec405854e19eb52fe0f9a6bddc289" args="(const byte *input, size_t length)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_auto_seeded_x917_r_n_g.html#a657ec405854e19eb52fe0f9a6bddc289">IncorporateEntropy</a> (const byte *input, size_t length)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">update RNG state with additional unpredictable values <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78075a7f80e8e62981342c438ae8e5b8"></a><!-- doxytag: member="AutoSeededX917RNG::GenerateIntoBufferedTransformation" ref="a78075a7f80e8e62981342c438ae8e5b8" args="(BufferedTransformation &target, const std::string &channel, lword length)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_auto_seeded_x917_r_n_g.html#a78075a7f80e8e62981342c438ae8e5b8">GenerateIntoBufferedTransformation</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &target, const std::string &channel, lword length)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">generate random bytes as input to a <a class="el" href="class_buffered_transformation.html" title="interface for buffered transformations">BufferedTransformation</a> <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada0f7c437b0c8e6ba94ebcd75bff4bda"></a><!-- doxytag: member="AutoSeededX917RNG::GenerateByte" ref="ada0f7c437b0c8e6ba94ebcd75bff4bda" args="()" --> virtual byte </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#ada0f7c437b0c8e6ba94ebcd75bff4bda">GenerateByte</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">generate new random byte and return it <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#ace592244cfbd6c18398ea6c75857532e">GenerateBit</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">generate new random bit and return it <a href="#ace592244cfbd6c18398ea6c75857532e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac06c9f5e66f35d643e4192f231b8a4cd"></a><!-- doxytag: member="AutoSeededX917RNG::GenerateWord32" ref="ac06c9f5e66f35d643e4192f231b8a4cd" args="(word32 a=0, word32 b=0xffffffffL)" --> virtual word32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#ac06c9f5e66f35d643e4192f231b8a4cd">GenerateWord32</a> (word32 a=0, word32 b=0xffffffffL)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">generate a random 32 bit word in the range min to max, inclusive <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a497145546d24e6d4abaf10b7e0f1ba17"></a><!-- doxytag: member="AutoSeededX917RNG::GenerateBlock" ref="a497145546d24e6d4abaf10b7e0f1ba17" args="(byte *output, size_t size)" --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#a497145546d24e6d4abaf10b7e0f1ba17">GenerateBlock</a> (byte *output, size_t size)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">generate random array of bytes <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a44f70ad8fed869a4ee55f50ef8e6e699"></a><!-- doxytag: member="AutoSeededX917RNG::DiscardBytes" ref="a44f70ad8fed869a4ee55f50ef8e6e699" args="(size_t n)" --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#a44f70ad8fed869a4ee55f50ef8e6e699">DiscardBytes</a> (size_t n)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">generate and discard n bytes <br/></td></tr> <tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a9ef5090c556d086e7aa240acf7a131b4"></a><!-- doxytag: member="AutoSeededX917RNG::Shuffle" ref="a9ef5090c556d086e7aa240acf7a131b4" args="(IT begin, IT end)" --> template<class IT > </td></tr> <tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#a9ef5090c556d086e7aa240acf7a131b4">Shuffle</a> (IT begin, IT end)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">randomly shuffle the specified array, resulting permutation is uniformly distributed <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acd21c6715add4884fa043eaf51655039"></a><!-- doxytag: member="AutoSeededX917RNG::AlgorithmName" ref="acd21c6715add4884fa043eaf51655039" args="() const " --> virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm.html#acd21c6715add4884fa043eaf51655039">AlgorithmName</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">returns name of this algorithm, not universally implemented yet <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24b43349a71e1f98508eeb10b31a0a62"></a><!-- doxytag: member="AutoSeededX917RNG::Clone" ref="a24b43349a71e1f98508eeb10b31a0a62" args="() const " --> virtual <a class="el" href="class_clonable.html">Clonable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_clonable.html#a24b43349a71e1f98508eeb10b31a0a62">Clone</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">this is not implemented by most classes yet <br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <h3>template<class BLOCK_CIPHER><br/> class AutoSeededX917RNG< BLOCK_CIPHER ></h3> <p>RNG from ANSI X9.17 Appendix C, seeded using an OS provided RNG. </p> <p>Definition at line <a class="el" href="osrng_8h_source.html#l00095">95</a> of file <a class="el" href="osrng_8h_source.html">osrng.h</a>.</p> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ace592244cfbd6c18398ea6c75857532e"></a><!-- doxytag: member="AutoSeededX917RNG::GenerateBit" ref="ace592244cfbd6c18398ea6c75857532e" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int RandomNumberGenerator::GenerateBit </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual, inherited]</code></td> </tr> </table> </div> <div class="memdoc"> <p>generate new random bit and return it </p> <p>Default implementation is to call <a class="el" href="class_random_number_generator.html#ada0f7c437b0c8e6ba94ebcd75bff4bda" title="generate new random byte and return it">GenerateByte()</a> and return its lowest bit. </p> <p>Reimplemented in <a class="el" href="class_public_blum_blum_shub.html#a6871d5e2ba162f32574d6b43e2473286">PublicBlumBlumShub</a>.</p> <p>Definition at line <a class="el" href="cryptlib_8cpp_source.html#l00229">229</a> of file <a class="el" href="cryptlib_8cpp_source.html">cryptlib.cpp</a>.</p> <p>References <a class="el" href="cryptlib_8cpp_source.html#l00234">RandomNumberGenerator::GenerateByte()</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="osrng_8h_source.html">osrng.h</a></li> </ul> </div> <hr size="1"/><address style="text-align: right;"><small>Generated on 9 Dec 2009 for Crypto++ by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> </body> </html>