a691e14359e156887644a889102626d2e0aafbb3
[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 "des.h"
54
55 #ifdef OPENSSL_FIPS
56
57 #ifdef  __cplusplus
58 extern "C" {
59 #endif
60
61 int FIPS_x931_set_key(const unsigned char *key, int keylen);
62 int FIPS_x931_seed(const void *buf, int num);
63 int FIPS_x931_bytes(unsigned char *out, int outlen);
64
65 int FIPS_x931_test_mode(void);
66 void FIPS_x931_reset(void);
67 int FIPS_x931_set_dt(unsigned char *dt);
68
69 int FIPS_x931_status(void);
70
71 const RAND_METHOD *FIPS_x931_method(void);
72
73 typedef struct drbg_ctx_st DRBG_CTX;
74
75 /* Flag for CTR mode only: use derivation function ctr_df */
76 #define DRBG_FLAG_CTR_USE_DF            0x1
77 /* PRNG is in test state */
78 #define DRBG_FLAG_TEST                  0x2
79
80 DRBG_CTX *FIPS_drbg_new(int type, unsigned int flags);
81 int FIPS_drbg_init(DRBG_CTX *dctx, int type, unsigned int flags);
82 int FIPS_drbg_instantiate(DRBG_CTX *dctx,
83                                 const unsigned char *pers, size_t perslen);
84 int FIPS_drbg_reseed(DRBG_CTX *dctx, const unsigned char *adin, size_t adinlen);
85 int FIPS_drbg_generate(DRBG_CTX *dctx, unsigned char *out, size_t outlen,
86                         int strength, int prediction_resistance,
87                         const unsigned char *adin, size_t adinlen);
88
89 int FIPS_drbg_uninstantiate(DRBG_CTX *dctx);
90 void FIPS_drbg_free(DRBG_CTX *dctx);
91
92 int FIPS_drbg_set_callbacks(DRBG_CTX *dctx,
93         size_t (*get_entropy)(DRBG_CTX *ctx, unsigned char **pout,
94                                 int entropy, size_t min_len, size_t max_len),
95         void (*cleanup_entropy)(DRBG_CTX *ctx, unsigned char *out, size_t olen),
96         size_t (*get_nonce)(DRBG_CTX *ctx, unsigned char **pout,
97                                 int entropy, size_t min_len, size_t max_len),
98         void (*cleanup_nonce)(DRBG_CTX *ctx, unsigned char *out, size_t olen));
99
100 int FIPS_drbg_set_rand_callbacks(DRBG_CTX *dctx,
101         size_t (*get_adin)(DRBG_CTX *ctx, unsigned char **pout),
102         void (*cleanup_adin)(DRBG_CTX *ctx, unsigned char *out, size_t olen),
103         int (*rand_seed_cb)(DRBG_CTX *ctx, const void *buf, int num),
104         int (*rand_add_cb)(DRBG_CTX *ctx,
105                                 const void *buf, int num, double entropy));
106
107 void *FIPS_drbg_get_app_data(DRBG_CTX *ctx);
108 void FIPS_drbg_set_app_data(DRBG_CTX *ctx, void *app_data);
109 size_t FIPS_drbg_get_blocklength(DRBG_CTX *dctx);
110 int FIPS_drbg_get_strength(DRBG_CTX *dctx);
111
112 DRBG_CTX *FIPS_get_default_drbg(void);
113 const RAND_METHOD *FIPS_drbg_method(void);
114
115
116 #ifdef  __cplusplus
117 }
118 #endif
119 #endif
120 #endif