606382dd211c2dadd2a85a03b53f80b801ca68e9
[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 #include <stdlib.h>
63 #include <openssl/ossl_typ.h>
64 #include <openssl/e_os2.h>
65
66 #if defined(OPENSSL_SYS_WINDOWS)
67 #include <windows.h>
68 #endif
69
70 #ifdef  __cplusplus
71 extern "C" {
72 #endif
73
74 typedef struct rand_meth_st
75         {
76         void (*seed)(const void *buf, int num);
77         int (*bytes)(unsigned char *buf, int num);
78         void (*cleanup)(void);
79         void (*add)(const void *buf, int num, double entropy);
80         int (*pseudorand)(unsigned char *buf, int num);
81         int (*status)(void);
82         } RAND_METHOD;
83
84 #ifdef BN_DEBUG
85 extern int rand_predictable;
86 #endif
87
88 int RAND_set_rand_method(const RAND_METHOD *meth);
89 const RAND_METHOD *RAND_get_rand_method(void);
90 #ifndef OPENSSL_NO_ENGINE
91 int RAND_set_rand_engine(ENGINE *engine);
92 #endif
93 RAND_METHOD *RAND_SSLeay(void);
94 void RAND_cleanup(void );
95 int  RAND_bytes(unsigned char *buf,int num);
96 int  RAND_pseudo_bytes(unsigned char *buf,int num);
97 void RAND_seed(const void *buf,int num);
98 void RAND_add(const void *buf,int num,double entropy);
99 int  RAND_load_file(const char *file,long max_bytes);
100 int  RAND_write_file(const char *file);
101 const char *RAND_file_name(char *file,size_t num);
102 int RAND_status(void);
103 int RAND_query_egd_bytes(const char *path, unsigned char *buf, int bytes);
104 int RAND_egd(const char *path);
105 int RAND_egd_bytes(const char *path,int bytes);
106 int RAND_poll(void);
107
108 #if defined(OPENSSL_SYS_WINDOWS) || defined(OPENSSL_SYS_WIN32)
109
110 void RAND_screen(void);
111 int RAND_event(UINT, WPARAM, LPARAM);
112
113 #endif
114
115 /* BEGIN ERROR CODES */
116 /* The following lines are auto generated by the script mkerr.pl. Any changes
117  * made after this point may be overwritten when the script is next run.
118  */
119 void ERR_load_RAND_strings(void);
120
121 /* Error codes for the RAND functions. */
122
123 /* Function codes. */
124 #define RAND_F_RAND_GET_RAND_METHOD                      101
125 #define RAND_F_SSLEAY_RAND_BYTES                         100
126
127 /* Reason codes. */
128 #define RAND_R_PRNG_NOT_SEEDED                           100
129
130 #ifdef  __cplusplus
131 }
132 #endif
133 #endif