rand.h revision 296341
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
71extern "C" {
72#endif
73
74# if defined(OPENSSL_FIPS)
75#  define FIPS_RAND_SIZE_T size_t
76# endif
77
78/* Already defined in ossl_typ.h */
79/* typedef struct rand_meth_st RAND_METHOD; */
80
81struct rand_meth_st {
82    void (*seed) (const void *buf, int num);
83    int (*bytes) (unsigned char *buf, int num);
84    void (*cleanup) (void);
85    void (*add) (const void *buf, int num, double entropy);
86    int (*pseudorand) (unsigned char *buf, int num);
87    int (*status) (void);
88};
89
90# ifdef BN_DEBUG
91extern int rand_predictable;
92# endif
93
94int RAND_set_rand_method(const RAND_METHOD *meth);
95const RAND_METHOD *RAND_get_rand_method(void);
96# ifndef OPENSSL_NO_ENGINE
97int RAND_set_rand_engine(ENGINE *engine);
98# endif
99RAND_METHOD *RAND_SSLeay(void);
100void RAND_cleanup(void);
101int RAND_bytes(unsigned char *buf, int num);
102int RAND_pseudo_bytes(unsigned char *buf, int num);
103void RAND_seed(const void *buf, int num);
104void RAND_add(const void *buf, int num, double entropy);
105int RAND_load_file(const char *file, long max_bytes);
106int RAND_write_file(const char *file);
107const char *RAND_file_name(char *file, size_t num);
108int RAND_status(void);
109int RAND_query_egd_bytes(const char *path, unsigned char *buf, int bytes);
110int RAND_egd(const char *path);
111int RAND_egd_bytes(const char *path, int bytes);
112int RAND_poll(void);
113
114# if defined(OPENSSL_SYS_WINDOWS) || defined(OPENSSL_SYS_WIN32)
115
116void RAND_screen(void);
117int RAND_event(UINT, WPARAM, LPARAM);
118
119# endif
120
121# ifdef OPENSSL_FIPS
122void RAND_set_fips_drbg_type(int type, int flags);
123int RAND_init_fips(void);
124# endif
125
126/* BEGIN ERROR CODES */
127/*
128 * The following lines are auto generated by the script mkerr.pl. Any changes
129 * made after this point may be overwritten when the script is next run.
130 */
131void ERR_load_RAND_strings(void);
132
133/* Error codes for the RAND functions. */
134
135/* Function codes. */
136# define RAND_F_RAND_GET_RAND_METHOD                      101
137# define RAND_F_RAND_INIT_FIPS                            102
138# define RAND_F_SSLEAY_RAND_BYTES                         100
139
140/* Reason codes. */
141# define RAND_R_DUAL_EC_DRBG_DISABLED                     104
142# define RAND_R_ERROR_INITIALISING_DRBG                   102
143# define RAND_R_ERROR_INSTANTIATING_DRBG                  103
144# define RAND_R_NO_FIPS_RANDOM_METHOD_SET                 101
145# define RAND_R_PRNG_NOT_SEEDED                           100
146
147#ifdef  __cplusplus
148}
149#endif
150#endif
151