include/openssl/rand.h

   1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   2  * All rights reserved.
   3  *
   4  * This package is an SSL implementation written
   5  * by Eric Young (eay@cryptsoft.com).
   6  * The implementation was written so as to conform with Netscapes SSL.
   7  *
   8  * This library is free for commercial and non-commercial use as long as
   9  * the following conditions are aheared to.  The following conditions
  10  * apply to all code found in this distribution, be it the RC4, RSA,
  11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  12  * included with this distribution is covered by the same copyright terms
  13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  14  *
  15  * Copyright remains Eric Young's, and as such any Copyright notices in
  16  * the code are not to be removed.
  17  * If this package is used in a product, Eric Young should be given attribution
  18  * as the author of the parts of the library used.
  19  * This can be in the form of a textual message at program startup or
  20  * in documentation (online or textual) provided with the package.
  21  *
  22  * Redistribution and use in source and binary forms, with or without
  23  * modification, are permitted provided that the following conditions
  24  * are met:
  25  * 1. Redistributions of source code must retain the copyright
  26  *    notice, this list of conditions and the following disclaimer.
  27  * 2. Redistributions in binary form must reproduce the above copyright
  28  *    notice, this list of conditions and the following disclaimer in the
  29  *    documentation and/or other materials provided with the distribution.
  30  * 3. All advertising materials mentioning features or use of this software
  31  *    must display the following acknowledgement:
  32  *    "This product includes cryptographic software written by
  33  *     Eric Young (eay@cryptsoft.com)"
  34  *    The word 'cryptographic' can be left out if the rouines from the library
  35  *    being used are not cryptographic related :-).
  36  * 4. If you include any Windows specific code (or a derivative thereof) from
  37  *    the apps directory (application code) you must include an acknowledgement:
  38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50  * SUCH DAMAGE.
  51  *
  52  * The licence and distribution terms for any publically available version or
  53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  54  * copied and put under another distribution licence
  55  * [including the GNU Public Licence.]
  56  */
  57
  58 #ifndef HEADER_RAND_H
  59 # define HEADER_RAND_H
  60
  61 # include <stdlib.h>
  62 # include <openssl/ossl_typ.h>
  63 # include <openssl/e_os2.h>
  64
  65 # if defined(OPENSSL_SYS_WINDOWS)
  66 #  include <windows.h>
  67 # endif
  68
  69 #ifdef  __cplusplus
  70 extern "C" {
  71 #endif
  72
  73 /* Already defined in ossl_typ.h */
  74 /* typedef struct rand_meth_st RAND_METHOD; */
  75
  76 struct rand_meth_st {
  77     int (*seed) (const void *buf, int num);
  78     int (*bytes) (unsigned char *buf, int num);
  79     void (*cleanup) (void);
  80     int (*add) (const void *buf, int num, double entropy);
  81     int (*pseudorand) (unsigned char *buf, int num);
  82     int (*status) (void);
  83 };
  84
  85 # ifdef BN_DEBUG
  86 extern int rand_predictable;
  87 # endif
  88
  89 int RAND_set_rand_method(const RAND_METHOD *meth);
  90 const RAND_METHOD *RAND_get_rand_method(void);
  91 # ifndef OPENSSL_NO_ENGINE
  92 int RAND_set_rand_engine(ENGINE *engine);
  93 # endif
  94 RAND_METHOD *RAND_OpenSSL(void);
  95 #if OPENSSL_API_COMPAT < 0x10100000L
  96 # define RAND_cleanup()
  97 #endif
  98 int RAND_bytes(unsigned char *buf, int num);
  99 DEPRECATEDIN_1_1_0(int RAND_pseudo_bytes(unsigned char *buf, int num))
 100 void RAND_seed(const void *buf, int num);
 101 #if defined(__ANDROID__) && defined(__NDK_FPABI__)
 102 __NDK_FPABI__   /* __attribute__((pcs("aapcs"))) on ARM */
 103 #endif
 104 void RAND_add(const void *buf, int num, double entropy);
 105 int RAND_load_file(const char *file, long max_bytes);
 106 int RAND_write_file(const char *file);
 107 const char *RAND_file_name(char *file, size_t num);
 108 int RAND_status(void);
 109 # ifndef OPENSSL_NO_EGD
 110 int RAND_query_egd_bytes(const char *path, unsigned char *buf, int bytes);
 111 int RAND_egd(const char *path);
 112 int RAND_egd_bytes(const char *path, int bytes);
 113 # endif
 114 int RAND_poll(void);
 115
 116 # if defined(OPENSSL_SYS_WINDOWS) || defined(OPENSSL_SYS_WIN32)
 117
 118 void RAND_screen(void);
 119 int RAND_event(UINT, WPARAM, LPARAM);
 120
 121 # endif
 122
 123 /* BEGIN ERROR CODES */
 124 /*
 125  * The following lines are auto generated by the script mkerr.pl. Any changes
 126  * made after this point may be overwritten when the script is next run.
 127  */
 128 void ERR_load_RAND_strings(void);
 129
 130 /* Error codes for the RAND functions. */
 131
 132 /* Function codes. */
 133 # define RAND_F_FIPS_RAND                                 102
 134 # define RAND_F_FIPS_RAND_SET_DT                          103
 135 # define RAND_F_FIPS_SET_PRNG_SEED                        104
 136 # define RAND_F_FIPS_SET_TEST_MODE                        105
 137 # define RAND_F_FIPS_X931_SET_DT                          106
 138 # define RAND_F_RAND_BYTES                                100
 139 # define RAND_F_RAND_GET_RAND_METHOD                      101
 140
 141 /* Reason codes. */
 142 # define RAND_R_NOT_IN_TEST_MODE                          101
 143 # define RAND_R_NO_KEY_SET                                102
 144 # define RAND_R_PRNG_ERROR                                103
 145 # define RAND_R_PRNG_KEYED                                104
 146 # define RAND_R_PRNG_NOT_SEEDED                           100
 147 # define RAND_R_PRNG_SEED_MUST_NOT_MATCH_KEY              105
 148 # define RAND_R_PRNG_STUCK                                106
 149
 150 #ifdef  __cplusplus
 151 }
 152 #endif
 153 #endif