Allow for higher granularity of entropy estimates by using 'double'
[openssl.git] / crypto / rand / rand.h
1 /* crypto/rand/rand.h */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  * 
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  * 
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from 
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  * 
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * 
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58
59 #ifndef HEADER_RAND_H
60 #define HEADER_RAND_H
61
62 #ifdef  __cplusplus
63 extern "C" {
64 #endif
65
66 typedef struct rand_meth_st
67         {
68         void (*seed)(const void *buf, int num);
69         int (*bytes)(unsigned char *buf, int num);
70         void (*cleanup)(void);
71         void (*add)(const void *buf, int num, double entropy);
72         int (*pseudorand)(unsigned char *buf, int num);
73         } RAND_METHOD;
74
75 void RAND_set_rand_method(RAND_METHOD *meth);
76 RAND_METHOD *RAND_get_rand_method(void );
77 RAND_METHOD *RAND_SSLeay(void);
78 void RAND_cleanup(void );
79 int  RAND_bytes(unsigned char *buf,int num);
80 int  RAND_pseudo_bytes(unsigned char *buf,int num);
81 void RAND_seed(const void *buf,int num);
82 void RAND_add(const void *buf,int num,double entropy);
83 int  RAND_load_file(const char *file,long max_bytes);
84 int  RAND_write_file(const char *file);
85 const char *RAND_file_name(char *file,int num);
86 #ifdef WINDOWS
87 void RAND_screen(void);
88 #endif
89 void    ERR_load_RAND_strings(void);
90
91 /* BEGIN ERROR CODES */
92 /* The following lines are auto generated by the script mkerr.pl. Any changes
93  * made after this point may be overwritten when the script is next run.
94  */
95
96 /* Error codes for the RAND functions. */
97
98 /* Function codes. */
99 #define RAND_F_SSLEAY_RAND_BYTES                         100
100
101 /* Reason codes. */
102 #define RAND_R_PRNG_NOT_SEEDED                           100
103
104 #ifdef  __cplusplus
105 }
106 #endif
107 #endif
108