<!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++: osrng.h File 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="#nested-classes">Classes</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">osrng.h File Reference</div> </div> </div><!--header--> <div class="contents"> <p>Classes for access to the operating system's random number generators. <a href="#details">More...</a></p> <p><a href="osrng_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Classes</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_s___r_n_g___err.html">OS_RNG_Err</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_exception.html" title="Base class for all exceptions thrown by the library. ">Exception</a> thrown when an operating system error is encountered. <a href="class_o_s___r_n_g___err.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_microsoft_crypto_provider.html">MicrosoftCryptoProvider</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nonblocking_rng.html">NonblockingRng</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Wrapper class for /dev/random and /dev/srandom. <a href="class_nonblocking_rng.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_blocking_rng.html">BlockingRng</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Wrapper class for /dev/random and /dev/srandom. <a href="class_blocking_rng.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_auto_seeded_random_pool.html">AutoSeededRandomPool</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Automatically Seeded Randomness Pool. <a href="class_auto_seeded_random_pool.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_auto_seeded_x917_r_n_g.html">AutoSeededX917RNG< BLOCK_CIPHER ></a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Automatically Seeded X9.17 RNG. <a href="class_auto_seeded_x917_r_n_g.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_default_auto_seeded_r_n_g.html">DefaultAutoSeededRNG</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A typedef providing a default generator. <a href="class_default_auto_seeded_r_n_g.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:a8469ca3f35c72e1b80f61432f7739b91"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="osrng_8h.html#a8469ca3f35c72e1b80f61432f7739b91">OS_GenerateRandomBlock</a> (bool blocking, byte *output, size_t size)</td></tr> <tr class="memdesc:a8469ca3f35c72e1b80f61432f7739b91"><td class="mdescLeft"> </td><td class="mdescRight">OS_GenerateRandomBlock. <a href="#a8469ca3f35c72e1b80f61432f7739b91">More...</a><br /></td></tr> <tr class="separator:a8469ca3f35c72e1b80f61432f7739b91"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Classes for access to the operating system's random number generators. </p> <p class="definition">Definition in file <a class="el" href="osrng_8h_source.html">osrng.h</a>.</p> </div><h2 class="groupheader">Function Documentation</h2> <a id="a8469ca3f35c72e1b80f61432f7739b91"></a> <h2 class="memtitle"><span class="permalink"><a href="#a8469ca3f35c72e1b80f61432f7739b91">◆ </a></span>OS_GenerateRandomBlock()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void OS_GenerateRandomBlock </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"><em>blocking</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">byte * </td> <td class="paramname"><em>output</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>size</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>OS_GenerateRandomBlock. </p> <p>Generate random array of bytes </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">blocking</td><td>specifies whther a bobcking or non-blocking generator should be used </td></tr> <tr><td class="paramname">output</td><td>the byte buffer </td></tr> <tr><td class="paramname">size</td><td>the length of the buffer, in bytes</td></tr> </table> </dd> </dl> <p><a class="el" href="osrng_8h.html#a8469ca3f35c72e1b80f61432f7739b91" title="OS_GenerateRandomBlock. ">OS_GenerateRandomBlock()</a> uses the underlying operating system's random number generator. On Windows, CryptGenRandom() is called using <a class="el" href="class_nonblocking_rng.html" title="Wrapper class for /dev/random and /dev/srandom. ">NonblockingRng</a>.</p> <p>On Unix and compatibles, /dev/urandom is called if blocking is false using <a class="el" href="class_nonblocking_rng.html" title="Wrapper class for /dev/random and /dev/srandom. ">NonblockingRng</a>. If blocking is true, then either /dev/randomd or /dev/srandom is used by way of <a class="el" href="class_blocking_rng.html" title="Wrapper class for /dev/random and /dev/srandom. ">BlockingRng</a>, if available. </p> <p class="definition">Definition at line <a class="el" href="osrng_8cpp_source.html#l00234">234</a> of file <a class="el" href="osrng_8cpp_source.html">osrng.cpp</a>.</p> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Sun Sep 16 2018 07:58:11 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>