1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>Heimdal crypto library: RAND crypto functions</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css">
8 <a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a>
10 <!-- end of header marker -->
11 <!-- Generated by Doxygen 1.5.6 -->
12 <div class="navigation" id="top">
15 <li><a href="index.html"><span>Main Page</span></a></li>
16 <li><a href="modules.html"><span>Modules</span></a></li>
17 <li><a href="examples.html"><span>Examples</span></a></li>
21 <div class="contents">
22 <h1>RAND crypto functions</h1><table border="0" cellpadding="0" cellspacing="0">
24 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
25 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#g700cd34f79c820f427f95c243befe085">RAND_seed</a> (const void *indata, size_t size)</td></tr>
27 <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#g957a044ad71e3c915ff7acc564be84a4">RAND_bytes</a> (void *outdata, size_t size)</td></tr>
29 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#gd797e371751dedbcce4e975c3cad1947">RAND_cleanup</a> (void)</td></tr>
31 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#g08927181178dc6329264982f2fb1b39b">RAND_add</a> (const void *indata, size_t size, double entropi)</td></tr>
33 <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#g93d10a9ba8647408a3b5306c2cd423f2">RAND_pseudo_bytes</a> (void *outdata, size_t size)</td></tr>
35 <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#g38d21605e6e777451769a8ee7087933b">RAND_status</a> (void)</td></tr>
37 <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#g292ae50ca725d0c529dc077467b40254">RAND_set_rand_method</a> (const RAND_METHOD *meth)</td></tr>
39 <tr><td class="memItemLeft" nowrap align="right" valign="top">const RAND_METHOD * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#g8a8cac7a3262c4527e08f57f07c4c586">RAND_get_rand_method</a> (void)</td></tr>
41 <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#g6a4f2c2cf723ef63522d4b33c79d5f0f">RAND_set_rand_engine</a> (ENGINE *engine)</td></tr>
43 <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#g9ca9fe0e799e41e8e745a88e3a60ccfd">RAND_load_file</a> (const char *filename, size_t size)</td></tr>
45 <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#gb9638d698e0a8ab94a31322693588eba">RAND_write_file</a> (const char *filename)</td></tr>
47 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__rand.html#g77b2d2555388b5d75a4bab3843fc8f02">RAND_file_name</a> (char *filename, size_t size)</td></tr>
50 <hr><a name="_details"></a><h2>Detailed Description</h2>
51 See the <a class="el" href="page_rand.html">RAND - random number</a> for description and examples. <hr><h2>Function Documentation</h2>
52 <a class="anchor" name="g08927181178dc6329264982f2fb1b39b"></a><!-- doxytag: member="rand.c::RAND_add" ref="g08927181178dc6329264982f2fb1b39b" args="(const void *indata, size_t size, double entropi)" -->
54 <div class="memproto">
55 <table class="memname">
57 <td class="memname">void RAND_add </td>
59 <td class="paramtype">const void * </td>
60 <td class="paramname"> <em>indata</em>, </td>
63 <td class="paramkey"></td>
65 <td class="paramtype">size_t </td>
66 <td class="paramname"> <em>size</em>, </td>
69 <td class="paramkey"></td>
71 <td class="paramtype">double </td>
72 <td class="paramname"> <em>entropi</em></td><td> </td>
77 <td></td><td></td><td></td>
84 Seed that random number generator. Secret material can securely be feed into the function, they will never be returned.<p>
85 <dl compact><dt><b>Parameters:</b></dt><dd>
86 <table border="0" cellspacing="2" cellpadding="0">
87 <tr><td valign="top"></td><td valign="top"><em>indata</em> </td><td>the input data. </td></tr>
88 <tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>size of in data. </td></tr>
89 <tr><td valign="top"></td><td valign="top"><em>entropi</em> </td><td>entropi in data. </td></tr>
95 <a class="anchor" name="g957a044ad71e3c915ff7acc564be84a4"></a><!-- doxytag: member="rand.c::RAND_bytes" ref="g957a044ad71e3c915ff7acc564be84a4" args="(void *outdata, size_t size)" -->
97 <div class="memproto">
98 <table class="memname">
100 <td class="memname">int RAND_bytes </td>
102 <td class="paramtype">void * </td>
103 <td class="paramname"> <em>outdata</em>, </td>
106 <td class="paramkey"></td>
108 <td class="paramtype">size_t </td>
109 <td class="paramname"> <em>size</em></td><td> </td>
114 <td></td><td></td><td></td>
121 Get a random block from the random generator, can be used for key material.<p>
122 <dl compact><dt><b>Parameters:</b></dt><dd>
123 <table border="0" cellspacing="2" cellpadding="0">
124 <tr><td valign="top"></td><td valign="top"><em>outdata</em> </td><td>random data </td></tr>
125 <tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>length random data</td></tr>
128 <dl class="return" compact><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure. </dd></dl>
132 <a class="anchor" name="gd797e371751dedbcce4e975c3cad1947"></a><!-- doxytag: member="rand.c::RAND_cleanup" ref="gd797e371751dedbcce4e975c3cad1947" args="(void)" -->
133 <div class="memitem">
134 <div class="memproto">
135 <table class="memname">
137 <td class="memname">void RAND_cleanup </td>
139 <td class="paramtype">void </td>
140 <td class="paramname"> </td>
141 <td> ) </td>
149 Reset and free memory used by the random generator.
152 <a class="anchor" name="g77b2d2555388b5d75a4bab3843fc8f02"></a><!-- doxytag: member="rand.c::RAND_file_name" ref="g77b2d2555388b5d75a4bab3843fc8f02" args="(char *filename, size_t size)" -->
153 <div class="memitem">
154 <div class="memproto">
155 <table class="memname">
157 <td class="memname">const char* RAND_file_name </td>
159 <td class="paramtype">char * </td>
160 <td class="paramname"> <em>filename</em>, </td>
163 <td class="paramkey"></td>
165 <td class="paramtype">size_t </td>
166 <td class="paramname"> <em>size</em></td><td> </td>
171 <td></td><td></td><td></td>
178 Return the default random state filename for a user to use for <a class="el" href="group__hcrypto__rand.html#g9ca9fe0e799e41e8e745a88e3a60ccfd">RAND_load_file()</a>, and <a class="el" href="group__hcrypto__rand.html#gb9638d698e0a8ab94a31322693588eba">RAND_write_file()</a>.<p>
179 <dl compact><dt><b>Parameters:</b></dt><dd>
180 <table border="0" cellspacing="2" cellpadding="0">
181 <tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>buffer to hold file name. </td></tr>
182 <tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>size of buffer filename.</td></tr>
185 <dl class="return" compact><dt><b>Returns:</b></dt><dd>the buffer filename or NULL on failure. </dd></dl>
189 <a class="anchor" name="g8a8cac7a3262c4527e08f57f07c4c586"></a><!-- doxytag: member="rand.c::RAND_get_rand_method" ref="g8a8cac7a3262c4527e08f57f07c4c586" args="(void)" -->
190 <div class="memitem">
191 <div class="memproto">
192 <table class="memname">
194 <td class="memname">const RAND_METHOD* RAND_get_rand_method </td>
196 <td class="paramtype">void </td>
197 <td class="paramname"> </td>
198 <td> ) </td>
206 Get the default random method.
209 <a class="anchor" name="g9ca9fe0e799e41e8e745a88e3a60ccfd"></a><!-- doxytag: member="rand.c::RAND_load_file" ref="g9ca9fe0e799e41e8e745a88e3a60ccfd" args="(const char *filename, size_t size)" -->
210 <div class="memitem">
211 <div class="memproto">
212 <table class="memname">
214 <td class="memname">int RAND_load_file </td>
216 <td class="paramtype">const char * </td>
217 <td class="paramname"> <em>filename</em>, </td>
220 <td class="paramkey"></td>
222 <td class="paramtype">size_t </td>
223 <td class="paramname"> <em>size</em></td><td> </td>
228 <td></td><td></td><td></td>
235 Load a a file and feed it into <a class="el" href="group__hcrypto__rand.html#g700cd34f79c820f427f95c243befe085">RAND_seed()</a>.<p>
236 <dl compact><dt><b>Parameters:</b></dt><dd>
237 <table border="0" cellspacing="2" cellpadding="0">
238 <tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>name of file to read. </td></tr>
239 <tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>minimum size to read. </td></tr>
245 <a class="anchor" name="g93d10a9ba8647408a3b5306c2cd423f2"></a><!-- doxytag: member="rand.c::RAND_pseudo_bytes" ref="g93d10a9ba8647408a3b5306c2cd423f2" args="(void *outdata, size_t size)" -->
246 <div class="memitem">
247 <div class="memproto">
248 <table class="memname">
250 <td class="memname">int RAND_pseudo_bytes </td>
252 <td class="paramtype">void * </td>
253 <td class="paramname"> <em>outdata</em>, </td>
256 <td class="paramkey"></td>
258 <td class="paramtype">size_t </td>
259 <td class="paramname"> <em>size</em></td><td> </td>
264 <td></td><td></td><td></td>
271 Get a random block from the random generator, should NOT be used for key material.<p>
272 <dl compact><dt><b>Parameters:</b></dt><dd>
273 <table border="0" cellspacing="2" cellpadding="0">
274 <tr><td valign="top"></td><td valign="top"><em>outdata</em> </td><td>random data </td></tr>
275 <tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>length random data</td></tr>
278 <dl class="return" compact><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure. </dd></dl>
282 <a class="anchor" name="g700cd34f79c820f427f95c243befe085"></a><!-- doxytag: member="rand.c::RAND_seed" ref="g700cd34f79c820f427f95c243befe085" args="(const void *indata, size_t size)" -->
283 <div class="memitem">
284 <div class="memproto">
285 <table class="memname">
287 <td class="memname">void RAND_seed </td>
289 <td class="paramtype">const void * </td>
290 <td class="paramname"> <em>indata</em>, </td>
293 <td class="paramkey"></td>
295 <td class="paramtype">size_t </td>
296 <td class="paramname"> <em>size</em></td><td> </td>
301 <td></td><td></td><td></td>
308 Seed that random number generator. Secret material can securely be feed into the function, they will never be returned.<p>
309 <dl compact><dt><b>Parameters:</b></dt><dd>
310 <table border="0" cellspacing="2" cellpadding="0">
311 <tr><td valign="top"></td><td valign="top"><em>indata</em> </td><td>seed data </td></tr>
312 <tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>length seed data </td></tr>
318 <a class="anchor" name="g6a4f2c2cf723ef63522d4b33c79d5f0f"></a><!-- doxytag: member="rand.c::RAND_set_rand_engine" ref="g6a4f2c2cf723ef63522d4b33c79d5f0f" args="(ENGINE *engine)" -->
319 <div class="memitem">
320 <div class="memproto">
321 <table class="memname">
323 <td class="memname">int RAND_set_rand_engine </td>
325 <td class="paramtype">ENGINE * </td>
326 <td class="paramname"> <em>engine</em> </td>
327 <td> ) </td>
335 Set the default random method from engine.<p>
336 <dl compact><dt><b>Parameters:</b></dt><dd>
337 <table border="0" cellspacing="2" cellpadding="0">
338 <tr><td valign="top"></td><td valign="top"><em>engine</em> </td><td>use engine, if NULL is passed it, old method and engine is cleared.</td></tr>
341 <dl class="return" compact><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure. </dd></dl>
345 <a class="anchor" name="g292ae50ca725d0c529dc077467b40254"></a><!-- doxytag: member="rand.c::RAND_set_rand_method" ref="g292ae50ca725d0c529dc077467b40254" args="(const RAND_METHOD *meth)" -->
346 <div class="memitem">
347 <div class="memproto">
348 <table class="memname">
350 <td class="memname">int RAND_set_rand_method </td>
352 <td class="paramtype">const RAND_METHOD * </td>
353 <td class="paramname"> <em>meth</em> </td>
354 <td> ) </td>
362 Set the default random method.<p>
363 <dl compact><dt><b>Parameters:</b></dt><dd>
364 <table border="0" cellspacing="2" cellpadding="0">
365 <tr><td valign="top"></td><td valign="top"><em>meth</em> </td><td>set the new default method.</td></tr>
368 <dl class="return" compact><dt><b>Returns:</b></dt><dd>1 on success. </dd></dl>
372 <a class="anchor" name="g38d21605e6e777451769a8ee7087933b"></a><!-- doxytag: member="rand.c::RAND_status" ref="g38d21605e6e777451769a8ee7087933b" args="(void)" -->
373 <div class="memitem">
374 <div class="memproto">
375 <table class="memname">
377 <td class="memname">int RAND_status </td>
379 <td class="paramtype">void </td>
380 <td class="paramname"> </td>
381 <td> ) </td>
389 Return status of the random generator<p>
390 <dl class="return" compact><dt><b>Returns:</b></dt><dd>1 if the random generator can deliver random data. </dd></dl>
394 <a class="anchor" name="gb9638d698e0a8ab94a31322693588eba"></a><!-- doxytag: member="rand.c::RAND_write_file" ref="gb9638d698e0a8ab94a31322693588eba" args="(const char *filename)" -->
395 <div class="memitem">
396 <div class="memproto">
397 <table class="memname">
399 <td class="memname">int RAND_write_file </td>
401 <td class="paramtype">const char * </td>
402 <td class="paramname"> <em>filename</em> </td>
403 <td> ) </td>
411 Write of random numbers to a file to store for later initiation with <a class="el" href="group__hcrypto__rand.html#g9ca9fe0e799e41e8e745a88e3a60ccfd">RAND_load_file()</a>.<p>
412 <dl compact><dt><b>Parameters:</b></dt><dd>
413 <table border="0" cellspacing="2" cellpadding="0">
414 <tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>name of file to write.</td></tr>
417 <dl class="return" compact><dt><b>Returns:</b></dt><dd>1 on success and non-one on failure. </dd></dl>
422 <hr size="1"><address style="text-align: right;"><small>
423 Generated on Wed Jan 11 14:07:38 2012 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.5.6</small></address>