<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.14"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Crypto++: X917RNG Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">Crypto++  <span id="projectnumber">7.0</span> </div> <div id="projectbrief">Free C++ class library of cryptographic schemes</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.14 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',false,false,'search.php','Search'); }); /* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="class_x917_r_n_g-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">X917RNG Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>ANSI X9.17 RNG. <a href="class_x917_r_n_g.html#details">More...</a></p> <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for X917RNG:</div> <div id="dynsection-0-summary" class="dynsummary" style="display:block;"> </div> <div id="dynsection-0-content" class="dyncontent" style="display:none;"> <div class="center"> <img src="class_x917_r_n_g.png" usemap="#X917RNG_map" alt=""/> <map id="X917RNG_map" name="X917RNG_map"> <area href="class_random_number_generator.html" title="Interface for random number generators. " alt="RandomNumberGenerator" shape="rect" coords="0,112,158,136"/> <area href="class_not_copyable.html" title="Ensures an object is not copyable. " alt="NotCopyable" shape="rect" coords="168,112,326,136"/> <area href="class_algorithm.html" title="Interface for all crypto algorithms. " alt="Algorithm" shape="rect" coords="0,56,158,80"/> <area href="class_clonable.html" title="Interface for cloning objects. " alt="Clonable" shape="rect" coords="0,0,158,24"/> </map> </div></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a8bda7e471e98f94c3dd076a7fdbe5d1c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x917_r_n_g.html#a8bda7e471e98f94c3dd076a7fdbe5d1c">X917RNG</a> (<a class="el" href="class_block_transformation.html">BlockTransformation</a> *cipher, const byte *seed, const byte *deterministicTimeVector=NULL)</td></tr> <tr class="memdesc:a8bda7e471e98f94c3dd076a7fdbe5d1c"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="class_x917_r_n_g.html" title="ANSI X9.17 RNG. ">X917RNG</a>. <a href="#a8bda7e471e98f94c3dd076a7fdbe5d1c">More...</a><br /></td></tr> <tr class="separator:a8bda7e471e98f94c3dd076a7fdbe5d1c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5b84223763a1f90ddc55e87769df7bf9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x917_r_n_g.html#a5b84223763a1f90ddc55e87769df7bf9">GenerateIntoBufferedTransformation</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &target, const std::string &channel, lword size)</td></tr> <tr class="memdesc:a5b84223763a1f90ddc55e87769df7bf9"><td class="mdescLeft"> </td><td class="mdescRight">Generate random bytes into a <a class="el" href="class_buffered_transformation.html" title="Interface for buffered transformations. ">BufferedTransformation</a>. <a href="#a5b84223763a1f90ddc55e87769df7bf9">More...</a><br /></td></tr> <tr class="separator:a5b84223763a1f90ddc55e87769df7bf9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_class_random_number_generator"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_random_number_generator')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_random_number_generator.html">RandomNumberGenerator</a></td></tr> <tr class="memitem:a6feb4f0afedb62a495b7a9ae311fa1cb inherit pub_methods_class_random_number_generator"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#a6feb4f0afedb62a495b7a9ae311fa1cb">IncorporateEntropy</a> (const byte *input, size_t length)</td></tr> <tr class="memdesc:a6feb4f0afedb62a495b7a9ae311fa1cb inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Update RNG state with additional unpredictable values. <a href="class_random_number_generator.html#a6feb4f0afedb62a495b7a9ae311fa1cb">More...</a><br /></td></tr> <tr class="separator:a6feb4f0afedb62a495b7a9ae311fa1cb inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a859bf69f7fae074201745eadf765ae44 inherit pub_methods_class_random_number_generator"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#a859bf69f7fae074201745eadf765ae44">CanIncorporateEntropy</a> () const</td></tr> <tr class="memdesc:a859bf69f7fae074201745eadf765ae44 inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Determines if a generator can accept additional entropy. <a href="class_random_number_generator.html#a859bf69f7fae074201745eadf765ae44">More...</a><br /></td></tr> <tr class="separator:a859bf69f7fae074201745eadf765ae44 inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ada0f7c437b0c8e6ba94ebcd75bff4bda inherit pub_methods_class_random_number_generator"><td class="memItemLeft" align="right" valign="top">virtual byte </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#ada0f7c437b0c8e6ba94ebcd75bff4bda">GenerateByte</a> ()</td></tr> <tr class="memdesc:ada0f7c437b0c8e6ba94ebcd75bff4bda inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Generate new random byte and return it. <a href="class_random_number_generator.html#ada0f7c437b0c8e6ba94ebcd75bff4bda">More...</a><br /></td></tr> <tr class="separator:ada0f7c437b0c8e6ba94ebcd75bff4bda inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ace592244cfbd6c18398ea6c75857532e inherit pub_methods_class_random_number_generator"><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 class="memdesc:ace592244cfbd6c18398ea6c75857532e inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Generate new random bit and return it. <a href="class_random_number_generator.html#ace592244cfbd6c18398ea6c75857532e">More...</a><br /></td></tr> <tr class="separator:ace592244cfbd6c18398ea6c75857532e inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a96a3eec202b6251f5c94136ab7edbde1 inherit pub_methods_class_random_number_generator"><td class="memItemLeft" align="right" valign="top">virtual word32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#a96a3eec202b6251f5c94136ab7edbde1">GenerateWord32</a> (word32 min=0, word32 max=0xffffffffUL)</td></tr> <tr class="memdesc:a96a3eec202b6251f5c94136ab7edbde1 inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Generate a random 32 bit word in the range min to max, inclusive. <a href="class_random_number_generator.html#a96a3eec202b6251f5c94136ab7edbde1">More...</a><br /></td></tr> <tr class="separator:a96a3eec202b6251f5c94136ab7edbde1 inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a497145546d24e6d4abaf10b7e0f1ba17 inherit pub_methods_class_random_number_generator"><td class="memItemLeft" align="right" valign="top">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 class="memdesc:a497145546d24e6d4abaf10b7e0f1ba17 inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Generate random array of bytes. <a href="class_random_number_generator.html#a497145546d24e6d4abaf10b7e0f1ba17">More...</a><br /></td></tr> <tr class="separator:a497145546d24e6d4abaf10b7e0f1ba17 inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a44f70ad8fed869a4ee55f50ef8e6e699 inherit pub_methods_class_random_number_generator"><td class="memItemLeft" align="right" valign="top">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 class="memdesc:a44f70ad8fed869a4ee55f50ef8e6e699 inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Generate and discard n bytes. <a href="class_random_number_generator.html#a44f70ad8fed869a4ee55f50ef8e6e699">More...</a><br /></td></tr> <tr class="separator:a44f70ad8fed869a4ee55f50ef8e6e699 inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aff937f93b0b1e17e7905494ef060fce2 inherit pub_methods_class_random_number_generator"><td class="memTemplParams" colspan="2">template<class IT > </td></tr> <tr class="memitem:aff937f93b0b1e17e7905494ef060fce2 inherit pub_methods_class_random_number_generator"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#aff937f93b0b1e17e7905494ef060fce2">Shuffle</a> (IT begin, IT end)</td></tr> <tr class="memdesc:aff937f93b0b1e17e7905494ef060fce2 inherit pub_methods_class_random_number_generator"><td class="mdescLeft"> </td><td class="mdescRight">Randomly shuffle the specified array. <a href="class_random_number_generator.html#aff937f93b0b1e17e7905494ef060fce2">More...</a><br /></td></tr> <tr class="separator:aff937f93b0b1e17e7905494ef060fce2 inherit pub_methods_class_random_number_generator"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_class_algorithm"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_algorithm')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_algorithm.html">Algorithm</a></td></tr> <tr class="memitem:a1c77f5117ca2cd881baf26a364cfc606 inherit pub_methods_class_algorithm"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm.html#a1c77f5117ca2cd881baf26a364cfc606">Algorithm</a> (bool checkSelfTestStatus=true)</td></tr> <tr class="memdesc:a1c77f5117ca2cd881baf26a364cfc606 inherit pub_methods_class_algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Interface for all crypto algorithms. <a href="class_algorithm.html#a1c77f5117ca2cd881baf26a364cfc606">More...</a><br /></td></tr> <tr class="separator:a1c77f5117ca2cd881baf26a364cfc606 inherit pub_methods_class_algorithm"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4f31510a192d1121856efe8ad0a9b844 inherit pub_methods_class_algorithm"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm.html#a4f31510a192d1121856efe8ad0a9b844">AlgorithmName</a> () const</td></tr> <tr class="memdesc:a4f31510a192d1121856efe8ad0a9b844 inherit pub_methods_class_algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Provides the name of this algorithm. <a href="class_algorithm.html#a4f31510a192d1121856efe8ad0a9b844">More...</a><br /></td></tr> <tr class="separator:a4f31510a192d1121856efe8ad0a9b844 inherit pub_methods_class_algorithm"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_class_clonable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_clonable')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_clonable.html">Clonable</a></td></tr> <tr class="memitem:ad0016ba2d505c23aa85aad49e6c19bb7 inherit pub_methods_class_clonable"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_clonable.html">Clonable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_clonable.html#ad0016ba2d505c23aa85aad49e6c19bb7">Clone</a> () const</td></tr> <tr class="memdesc:ad0016ba2d505c23aa85aad49e6c19bb7 inherit pub_methods_class_clonable"><td class="mdescLeft"> </td><td class="mdescRight">Copies this object. <a href="class_clonable.html#ad0016ba2d505c23aa85aad49e6c19bb7">More...</a><br /></td></tr> <tr class="separator:ad0016ba2d505c23aa85aad49e6c19bb7 inherit pub_methods_class_clonable"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>ANSI X9.17 RNG. </p> <p><a class="el" href="class_x917_r_n_g.html" title="ANSI X9.17 RNG. ">X917RNG</a> is from ANSI X9.17 Appendix C, and it uses a 64-bit block cipher, like TripleDES. If you use a 128-bit block cipher, like <a class="el" href="class_a_e_s.html" title="AES block cipher (Rijndael) ">AES</a>, then you are effectively using an ANSI X9.31 generator. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="class_auto_seeded_x917_r_n_g.html" title="Automatically Seeded X9.17 RNG. ">AutoSeededX917RNG</a>, <a class="el" href="class_default_auto_seeded_r_n_g.html" title="A typedef providing a default generator. ">DefaultAutoSeededRNG</a> </dd></dl> <p class="definition">Definition at line <a class="el" href="rng_8h_source.html#l00047">47</a> of file <a class="el" href="rng_8h_source.html">rng.h</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="a8bda7e471e98f94c3dd076a7fdbe5d1c"></a> <h2 class="memtitle"><span class="permalink"><a href="#a8bda7e471e98f94c3dd076a7fdbe5d1c">◆ </a></span>X917RNG()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">X917RNG::X917RNG </td> <td>(</td> <td class="paramtype"><a class="el" href="class_block_transformation.html">BlockTransformation</a> * </td> <td class="paramname"><em>cipher</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const byte * </td> <td class="paramname"><em>seed</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const byte * </td> <td class="paramname"><em>deterministicTimeVector</em> = <code>NULL</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Construct a <a class="el" href="class_x917_r_n_g.html" title="ANSI X9.17 RNG. ">X917RNG</a>. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">cipher</td><td>the block cipher to use for the generator </td></tr> <tr><td class="paramname">seed</td><td>a byte buffer to use as a seed </td></tr> <tr><td class="paramname">deterministicTimeVector</td><td>additional entropy</td></tr> </table> </dd> </dl> <p><code>cipher</code> will be deleted by the destructor. <code>seed</code> must be at least <a class="el" href="namespace_name.html#aa93e40d0259a59959d270e6c82a9f1eb" title="int, in bytes ">BlockSize()</a> in length. <code>deterministicTimeVector = 0</code> means obtain time vector from the system.</p> <p>When constructing a <a class="el" href="class_x917_r_n_g.html" title="ANSI X9.17 RNG. ">X917RNG</a>, the generator must be keyed or an access violation will occur because the time vector is encrypted using the block cipher. To key the generator during constructions, perform the following: </p><pre> <a class="el" href="class_sec_byte_block.html" title="SecBlock<byte> typedef. ">SecByteBlock</a> key(AES::DEFAULT_KEYLENGTH), seed(AES::BLOCKSIZE); OS_GenerateRandomBlock(false, key, key.size()); OS_GenerateRandomBlock(false, seed, seed.size()); <a class="el" href="class_x917_r_n_g.html" title="ANSI X9.17 RNG. ">X917RNG</a> prng(new AES::Encryption(key, AES::DEFAULT_KEYLENGTH), seed, NULLPTR);</pre> <dl class="section see"><dt>See also</dt><dd><a class="el" href="class_auto_seeded_x917_r_n_g.html" title="Automatically Seeded X9.17 RNG. ">AutoSeededX917RNG</a> </dd></dl> <p class="definition">Definition at line <a class="el" href="rng_8cpp_source.html#l00061">61</a> of file <a class="el" href="rng_8cpp_source.html">rng.cpp</a>.</p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a id="a5b84223763a1f90ddc55e87769df7bf9"></a> <h2 class="memtitle"><span class="permalink"><a href="#a5b84223763a1f90ddc55e87769df7bf9">◆ </a></span>GenerateIntoBufferedTransformation()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void X917RNG::GenerateIntoBufferedTransformation </td> <td>(</td> <td class="paramtype"><a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> & </td> <td class="paramname"><em>target</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>channel</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">lword </td> <td class="paramname"><em>length</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Generate random bytes into a <a class="el" href="class_buffered_transformation.html" title="Interface for buffered transformations. ">BufferedTransformation</a>. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">target</td><td>the <a class="el" href="class_buffered_transformation.html" title="Interface for buffered transformations. ">BufferedTransformation</a> object which receives the bytes </td></tr> <tr><td class="paramname">channel</td><td>the channel on which the bytes should be pumped </td></tr> <tr><td class="paramname">length</td><td>the number of bytes to generate</td></tr> </table> </dd> </dl> <p>The default implementation calls <a class="el" href="class_random_number_generator.html#a497145546d24e6d4abaf10b7e0f1ba17" title="Generate random array of bytes. ">GenerateBlock()</a> and pumps the result into the DEFAULT_CHANNEL of the target.</p> <p>All generated values are uniformly distributed over the range specified within the the constraints of a particular generator. </p><dl class="section note"><dt>Note</dt><dd>A derived generator <em>must</em> override either <a class="el" href="class_random_number_generator.html#a497145546d24e6d4abaf10b7e0f1ba17" title="Generate random array of bytes. ">GenerateBlock()</a> or <a class="el" href="class_x917_r_n_g.html#a5b84223763a1f90ddc55e87769df7bf9" title="Generate random bytes into a BufferedTransformation. ">GenerateIntoBufferedTransformation()</a>. They can override both, or have one call the other. </dd></dl> <p>Reimplemented from <a class="el" href="class_random_number_generator.html#a5cc474006e2c7383ec20cc4d0c2abbaf">RandomNumberGenerator</a>.</p> <p class="definition">Definition at line <a class="el" href="rng_8cpp_source.html#l00095">95</a> of file <a class="el" href="rng_8cpp_source.html">rng.cpp</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="rng_8h_source.html">rng.h</a></li> <li><a class="el" href="rng_8cpp_source.html">rng.cpp</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Sun Sep 16 2018 07:59:07 for Crypto++ by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.14 </small></address> </body> </html>