2a2f996b651d1d949833b4d38960ec3c65980ec5
[openssl.git] / fips / rand / fips_rand.h
1 /* ====================================================================
2  * Copyright (c) 2003 The OpenSSL Project.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer. 
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in
13  *    the documentation and/or other materials provided with the
14  *    distribution.
15  *
16  * 3. All advertising materials mentioning features or use of this
17  *    software must display the following acknowledgment:
18  *    "This product includes software developed by the OpenSSL Project
19  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
20  *
21  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
22  *    endorse or promote products derived from this software without
23  *    prior written permission. For written permission, please contact
24  *    openssl-core@openssl.org.
25  *
26  * 5. Products derived from this software may not be called "OpenSSL"
27  *    nor may "OpenSSL" appear in their names without prior written
28  *    permission of the OpenSSL Project.
29  *
30  * 6. Redistributions of any form whatsoever must retain the following
31  *    acknowledgment:
32  *    "This product includes software developed by the OpenSSL Project
33  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
34  *
35  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
36  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
38  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
41  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
43  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
44  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
45  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
46  * OF THE POSSIBILITY OF SUCH DAMAGE.
47  *
48  */
49
50 #ifndef HEADER_FIPS_RAND_H
51 #define HEADER_FIPS_RAND_H
52
53 #include <openssl/aes.h>
54 #include <openssl/evp.h>
55 #include <openssl/hmac.h>
56
57 #ifdef OPENSSL_FIPS
58
59 #ifdef  __cplusplus
60 extern "C" {
61 #endif
62
63 int FIPS_x931_set_key(const unsigned char *key, int keylen);
64 int FIPS_x931_seed(const void *buf, int num);
65 int FIPS_x931_bytes(unsigned char *out, int outlen);
66
67 int FIPS_x931_test_mode(void);
68 void FIPS_x931_reset(void);
69 int FIPS_x931_set_dt(unsigned char *dt);
70
71 int FIPS_x931_status(void);
72
73 const RAND_METHOD *FIPS_x931_method(void);
74
75 typedef struct drbg_ctx_st DRBG_CTX;
76
77 /* Flag for CTR mode only: use derivation function ctr_df */
78 #define DRBG_FLAG_CTR_USE_DF            0x1
79 /* PRNG is in test state */
80 #define DRBG_FLAG_TEST                  0x2
81
82 DRBG_CTX *FIPS_drbg_new(int type, unsigned int flags);
83 int FIPS_drbg_init(DRBG_CTX *dctx, int type, unsigned int flags);
84 int FIPS_drbg_instantiate(DRBG_CTX *dctx,
85                                 const unsigned char *pers, size_t perslen);
86 int FIPS_drbg_reseed(DRBG_CTX *dctx, const unsigned char *adin, size_t adinlen);
87 int FIPS_drbg_generate(DRBG_CTX *dctx, unsigned char *out, size_t outlen,
88                         int strength, int prediction_resistance,
89                         const unsigned char *adin, size_t adinlen);
90
91 int FIPS_drbg_uninstantiate(DRBG_CTX *dctx);
92 void FIPS_drbg_free(DRBG_CTX *dctx);
93
94 int FIPS_drbg_set_callbacks(DRBG_CTX *dctx,
95         size_t (*get_entropy)(DRBG_CTX *ctx, unsigned char **pout,
96                                 int entropy, size_t min_len, size_t max_len),
97         void (*cleanup_entropy)(DRBG_CTX *ctx, unsigned char *out, size_t olen),
98         size_t entropy_blocklen,
99         size_t (*get_nonce)(DRBG_CTX *ctx, unsigned char **pout,
100                                 int entropy, size_t min_len, size_t max_len),
101         void (*cleanup_nonce)(DRBG_CTX *ctx, unsigned char *out, size_t olen));
102
103 int FIPS_drbg_set_rand_callbacks(DRBG_CTX *dctx,
104         size_t (*get_adin)(DRBG_CTX *ctx, unsigned char **pout),
105         void (*cleanup_adin)(DRBG_CTX *ctx, unsigned char *out, size_t olen),
106         int (*rand_seed_cb)(DRBG_CTX *ctx, const void *buf, int num),
107         int (*rand_add_cb)(DRBG_CTX *ctx,
108                                 const void *buf, int num, double entropy));
109
110 void *FIPS_drbg_get_app_data(DRBG_CTX *ctx);
111 void FIPS_drbg_set_app_data(DRBG_CTX *ctx, void *app_data);
112 size_t FIPS_drbg_get_blocklength(DRBG_CTX *dctx);
113 int FIPS_drbg_get_strength(DRBG_CTX *dctx);
114 void FIPS_drbg_set_check_interval(DRBG_CTX *dctx, int interval);
115
116 DRBG_CTX *FIPS_get_default_drbg(void);
117 const RAND_METHOD *FIPS_drbg_method(void);
118
119
120 int FIPS_rand_set_method(const RAND_METHOD *meth);
121 const RAND_METHOD *FIPS_rand_get_method(void);
122
123 void FIPS_rand_set_bits(int nbits);
124
125 int FIPS_rand_strength(void);
126
127 #ifdef  __cplusplus
128 }
129 #endif
130 #endif
131 #endif