diff options
Diffstat (limited to 'doc/doxyout/hcrypto/html/group__hcrypto__rand.html')
| -rw-r--r-- | doc/doxyout/hcrypto/html/group__hcrypto__rand.html | 428 |
1 files changed, 0 insertions, 428 deletions
diff --git a/doc/doxyout/hcrypto/html/group__hcrypto__rand.html b/doc/doxyout/hcrypto/html/group__hcrypto__rand.html deleted file mode 100644 index 8b6525a5c9c3..000000000000 --- a/doc/doxyout/hcrypto/html/group__hcrypto__rand.html +++ /dev/null @@ -1,428 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> -<title>RAND crypto functions</title> -<link href="doxygen.css" rel="stylesheet" type="text/css"> -<link href="tabs.css" rel="stylesheet" type="text/css"> -</head><body> -<p> -<a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a> -</p> -<!-- end of header marker --> -<!-- Generated by Doxygen 1.9.1 --> -<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="#func-members">Functions</a> </div> - <div class="headertitle"> -<div class="title">RAND crypto functions</div> </div> -</div><!--header--> -<div class="contents"> -<table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> -Functions</h2></td></tr> -<tr class="memitem:ga700cd34f79c820f427f95c243befe085"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#ga700cd34f79c820f427f95c243befe085">RAND_seed</a> (const void *indata, size_t size)</td></tr> -<tr class="separator:ga700cd34f79c820f427f95c243befe085"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga957a044ad71e3c915ff7acc564be84a4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#ga957a044ad71e3c915ff7acc564be84a4">RAND_bytes</a> (void *outdata, size_t size)</td></tr> -<tr class="separator:ga957a044ad71e3c915ff7acc564be84a4"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gad797e371751dedbcce4e975c3cad1947"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#gad797e371751dedbcce4e975c3cad1947">RAND_cleanup</a> (void)</td></tr> -<tr class="separator:gad797e371751dedbcce4e975c3cad1947"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga08927181178dc6329264982f2fb1b39b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#ga08927181178dc6329264982f2fb1b39b">RAND_add</a> (const void *indata, size_t size, double entropi)</td></tr> -<tr class="separator:ga08927181178dc6329264982f2fb1b39b"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga93d10a9ba8647408a3b5306c2cd423f2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#ga93d10a9ba8647408a3b5306c2cd423f2">RAND_pseudo_bytes</a> (void *outdata, size_t size)</td></tr> -<tr class="separator:ga93d10a9ba8647408a3b5306c2cd423f2"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga38d21605e6e777451769a8ee7087933b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#ga38d21605e6e777451769a8ee7087933b">RAND_status</a> (void)</td></tr> -<tr class="separator:ga38d21605e6e777451769a8ee7087933b"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga292ae50ca725d0c529dc077467b40254"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#ga292ae50ca725d0c529dc077467b40254">RAND_set_rand_method</a> (const RAND_METHOD *meth)</td></tr> -<tr class="separator:ga292ae50ca725d0c529dc077467b40254"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga8a8cac7a3262c4527e08f57f07c4c586"><td class="memItemLeft" align="right" valign="top">const RAND_METHOD * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#ga8a8cac7a3262c4527e08f57f07c4c586">RAND_get_rand_method</a> (void)</td></tr> -<tr class="separator:ga8a8cac7a3262c4527e08f57f07c4c586"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga6a4f2c2cf723ef63522d4b33c79d5f0f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#ga6a4f2c2cf723ef63522d4b33c79d5f0f">RAND_set_rand_engine</a> (ENGINE *engine)</td></tr> -<tr class="separator:ga6a4f2c2cf723ef63522d4b33c79d5f0f"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga9ca9fe0e799e41e8e745a88e3a60ccfd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#ga9ca9fe0e799e41e8e745a88e3a60ccfd">RAND_load_file</a> (const char *filename, size_t size)</td></tr> -<tr class="separator:ga9ca9fe0e799e41e8e745a88e3a60ccfd"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gab9638d698e0a8ab94a31322693588eba"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#gab9638d698e0a8ab94a31322693588eba">RAND_write_file</a> (const char *filename)</td></tr> -<tr class="separator:gab9638d698e0a8ab94a31322693588eba"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga77b2d2555388b5d75a4bab3843fc8f02"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#ga77b2d2555388b5d75a4bab3843fc8f02">RAND_file_name</a> (char *filename, size_t size)</td></tr> -<tr class="separator:ga77b2d2555388b5d75a4bab3843fc8f02"><td class="memSeparator" colspan="2"> </td></tr> -</table> -<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<p>See the <a class="el" href="page_rand.html">RAND - random number</a> for description and examples. </p> -<h2 class="groupheader">Function Documentation</h2> -<a id="ga08927181178dc6329264982f2fb1b39b"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga08927181178dc6329264982f2fb1b39b">◆ </a></span>RAND_add()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void RAND_add </td> - <td>(</td> - <td class="paramtype">const void * </td> - <td class="paramname"><em>indata</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 class="paramkey"></td> - <td></td> - <td class="paramtype">double </td> - <td class="paramname"><em>entropi</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Seed that random number generator. Secret material can securely be feed into the function, they will never be returned.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">indata</td><td>the input data. </td></tr> - <tr><td class="paramname">size</td><td>size of in data. </td></tr> - <tr><td class="paramname">entropi</td><td>entropi in data. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a id="ga957a044ad71e3c915ff7acc564be84a4"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga957a044ad71e3c915ff7acc564be84a4">◆ </a></span>RAND_bytes()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int RAND_bytes </td> - <td>(</td> - <td class="paramtype">void * </td> - <td class="paramname"><em>outdata</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>Get a random block from the random generator, can be used for key material.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">outdata</td><td>random data </td></tr> - <tr><td class="paramname">size</td><td>length random data</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl> - -</div> -</div> -<a id="gad797e371751dedbcce4e975c3cad1947"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gad797e371751dedbcce4e975c3cad1947">◆ </a></span>RAND_cleanup()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void RAND_cleanup </td> - <td>(</td> - <td class="paramtype">void </td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Reset and free memory used by the random generator. </p> - -</div> -</div> -<a id="ga77b2d2555388b5d75a4bab3843fc8f02"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga77b2d2555388b5d75a4bab3843fc8f02">◆ </a></span>RAND_file_name()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">const char* RAND_file_name </td> - <td>(</td> - <td class="paramtype">char * </td> - <td class="paramname"><em>filename</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>Return the default random state filename for a user to use for <a class="el" href="group__hcrypto__rand.html#ga9ca9fe0e799e41e8e745a88e3a60ccfd">RAND_load_file()</a>, and <a class="el" href="group__hcrypto__rand.html#gab9638d698e0a8ab94a31322693588eba">RAND_write_file()</a>.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">filename</td><td>buffer to hold file name. </td></tr> - <tr><td class="paramname">size</td><td>size of buffer filename.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>the buffer filename or NULL on failure. </dd></dl> - -</div> -</div> -<a id="ga8a8cac7a3262c4527e08f57f07c4c586"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga8a8cac7a3262c4527e08f57f07c4c586">◆ </a></span>RAND_get_rand_method()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">const RAND_METHOD* RAND_get_rand_method </td> - <td>(</td> - <td class="paramtype">void </td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Get the default random method.</p> -<dl class="section return"><dt>Returns</dt><dd>Returns a RAND_METHOD </dd></dl> - -</div> -</div> -<a id="ga9ca9fe0e799e41e8e745a88e3a60ccfd"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga9ca9fe0e799e41e8e745a88e3a60ccfd">◆ </a></span>RAND_load_file()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int RAND_load_file </td> - <td>(</td> - <td class="paramtype">const char * </td> - <td class="paramname"><em>filename</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>Load a a file and feed it into <a class="el" href="group__hcrypto__rand.html#ga700cd34f79c820f427f95c243befe085">RAND_seed()</a>.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">filename</td><td>name of file to read. </td></tr> - <tr><td class="paramname">size</td><td>minimum size to read.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Returns the number of seed bytes loaded (0 indicates failure) </dd></dl> - -</div> -</div> -<a id="ga93d10a9ba8647408a3b5306c2cd423f2"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga93d10a9ba8647408a3b5306c2cd423f2">◆ </a></span>RAND_pseudo_bytes()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int RAND_pseudo_bytes </td> - <td>(</td> - <td class="paramtype">void * </td> - <td class="paramname"><em>outdata</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>Get a random block from the random generator, should NOT be used for key material.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">outdata</td><td>random data </td></tr> - <tr><td class="paramname">size</td><td>length random data</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl> - -</div> -</div> -<a id="ga700cd34f79c820f427f95c243befe085"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga700cd34f79c820f427f95c243befe085">◆ </a></span>RAND_seed()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void RAND_seed </td> - <td>(</td> - <td class="paramtype">const void * </td> - <td class="paramname"><em>indata</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>Seed that random number generator. Secret material can securely be feed into the function, they will never be returned.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">indata</td><td>seed data </td></tr> - <tr><td class="paramname">size</td><td>length seed data </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a id="ga6a4f2c2cf723ef63522d4b33c79d5f0f"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga6a4f2c2cf723ef63522d4b33c79d5f0f">◆ </a></span>RAND_set_rand_engine()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int RAND_set_rand_engine </td> - <td>(</td> - <td class="paramtype">ENGINE * </td> - <td class="paramname"><em>engine</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Set the default random method from engine.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">engine</td><td>use engine, if NULL is passed it, old method and engine is cleared.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>1 on success, 0 on failure. </dd></dl> - -</div> -</div> -<a id="ga292ae50ca725d0c529dc077467b40254"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga292ae50ca725d0c529dc077467b40254">◆ </a></span>RAND_set_rand_method()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int RAND_set_rand_method </td> - <td>(</td> - <td class="paramtype">const RAND_METHOD * </td> - <td class="paramname"><em>meth</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Set the default random method.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">meth</td><td>set the new default method.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>1 on success. </dd></dl> - -</div> -</div> -<a id="ga38d21605e6e777451769a8ee7087933b"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga38d21605e6e777451769a8ee7087933b">◆ </a></span>RAND_status()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int RAND_status </td> - <td>(</td> - <td class="paramtype">void </td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Return status of the random generator</p> -<dl class="section return"><dt>Returns</dt><dd>1 if the random generator can deliver random data. </dd></dl> - -</div> -</div> -<a id="gab9638d698e0a8ab94a31322693588eba"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gab9638d698e0a8ab94a31322693588eba">◆ </a></span>RAND_write_file()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int RAND_write_file </td> - <td>(</td> - <td class="paramtype">const char * </td> - <td class="paramname"><em>filename</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Write of random numbers to a file to store for later initiation with <a class="el" href="group__hcrypto__rand.html#ga9ca9fe0e799e41e8e745a88e3a60ccfd">RAND_load_file()</a>.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">filename</td><td>name of file to write.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>1 on success and non-one on failure. </dd></dl> - -</div> -</div> -</div><!-- contents --> -<hr size="1"><address style="text-align: right;"><small> -Generated on Tue Nov 15 2022 14:04:26 for Heimdal crypto library by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.9.1</small></address> -</body> -</html> |