DRBG: add locking api
[openssl.git] / include / internal / rand.h
1 /*
2  * Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #ifndef HEADER_DRBG_RAND_H
11 # define HEADER_DRBG_RAND_H
12
13 /* In CTR mode, use derivation function ctr_df */
14 #define RAND_DRBG_FLAG_CTR_USE_DF            0x2
15
16 /*
17  * Default security strength (in the sense of [NIST SP 800-90Ar1])
18  * of the default OpenSSL DRBG, and the corresponding NID.
19  *
20  * Currently supported values: 128, 192, 256
21  *
22  * TODO(DRBG): would be nice to have the strength configurable
23  */
24 # define RAND_DRBG_STRENGTH             128
25 # define RAND_DRBG_NID                  NID_aes_128_ctr
26
27 /*
28  * Object lifetime functions.
29  */
30 RAND_DRBG *RAND_DRBG_new(int type, unsigned int flags, RAND_DRBG *parent);
31 int RAND_DRBG_set(RAND_DRBG *drbg, int type, unsigned int flags);
32 int RAND_DRBG_instantiate(RAND_DRBG *drbg,
33                           const unsigned char *pers, size_t perslen);
34 int RAND_DRBG_uninstantiate(RAND_DRBG *drbg);
35 void RAND_DRBG_free(RAND_DRBG *drbg);
36
37 /*
38  * Object "use" functions.
39  */
40 int RAND_DRBG_reseed(RAND_DRBG *drbg,
41                      const unsigned char *adin, size_t adinlen);
42 int RAND_DRBG_generate(RAND_DRBG *drbg, unsigned char *out, size_t outlen,
43                        int prediction_resistance,
44                        const unsigned char *adin, size_t adinlen);
45 int RAND_DRBG_bytes(RAND_DRBG *drbg, unsigned char *out, size_t outlen);
46
47 int RAND_DRBG_set_reseed_interval(RAND_DRBG *drbg, unsigned int interval);
48 int RAND_DRBG_set_reseed_time_interval(RAND_DRBG *drbg, time_t interval);
49
50 int RAND_DRBG_lock(RAND_DRBG *drbg);
51 int RAND_DRBG_unlock(RAND_DRBG *drbg);
52 int RAND_DRBG_enable_locking(RAND_DRBG *drbg);
53
54 RAND_DRBG *RAND_DRBG_get0_master(void);
55 RAND_DRBG *RAND_DRBG_get0_public(void);
56 RAND_DRBG *RAND_DRBG_get0_private(void);
57
58 /*
59  * EXDATA
60  */
61 #define RAND_DRBG_get_ex_new_index(l, p, newf, dupf, freef) \
62     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DRBG, l, p, newf, dupf, freef)
63 int RAND_DRBG_set_ex_data(RAND_DRBG *dctx, int idx, void *arg);
64 void *RAND_DRBG_get_ex_data(const RAND_DRBG *dctx, int idx);
65
66 /*
67  * Callback functions.  See comments in drbg_lib.c
68  */
69 typedef size_t (*RAND_DRBG_get_entropy_fn)(RAND_DRBG *ctx,
70                                            unsigned char **pout,
71                                            int entropy, size_t min_len,
72                                            size_t max_len);
73 typedef void (*RAND_DRBG_cleanup_entropy_fn)(RAND_DRBG *ctx,
74                                              unsigned char *out, size_t outlen);
75 typedef size_t (*RAND_DRBG_get_nonce_fn)(RAND_DRBG *ctx, unsigned char **pout,
76                                          int entropy, size_t min_len,
77                                          size_t max_len);
78 typedef void (*RAND_DRBG_cleanup_nonce_fn)(RAND_DRBG *ctx,
79                                            unsigned char *out, size_t outlen);
80
81 int RAND_DRBG_set_callbacks(RAND_DRBG *dctx,
82                             RAND_DRBG_get_entropy_fn get_entropy,
83                             RAND_DRBG_cleanup_entropy_fn cleanup_entropy,
84                             RAND_DRBG_get_nonce_fn get_nonce,
85                             RAND_DRBG_cleanup_nonce_fn cleanup_nonce);
86
87 /*
88  * RAND_POOL functions
89  */
90 RAND_POOL *RAND_POOL_new(int entropy_requested, size_t min_len, size_t max_len);
91 void RAND_POOL_free(RAND_POOL *pool);
92
93 const unsigned char *RAND_POOL_buffer(RAND_POOL *pool);
94 unsigned char *RAND_POOL_detach(RAND_POOL *pool);
95
96 size_t RAND_POOL_entropy(RAND_POOL *pool);
97 size_t RAND_POOL_length(RAND_POOL *pool);
98
99 size_t RAND_POOL_entropy_available(RAND_POOL *pool);
100 size_t RAND_POOL_entropy_needed(RAND_POOL *pool);
101 size_t RAND_POOL_bytes_needed(RAND_POOL *pool, unsigned int entropy_per_byte);
102 size_t RAND_POOL_bytes_remaining(RAND_POOL *pool);
103
104 size_t RAND_POOL_add(RAND_POOL *pool,
105                      const unsigned char *buffer, size_t len, size_t entropy);
106 unsigned char *RAND_POOL_add_begin(RAND_POOL *pool, size_t len);
107 size_t RAND_POOL_add_end(RAND_POOL *pool, size_t len, size_t entropy);
108
109
110 /*
111  * Add random bytes to the pool to acquire requested amount of entropy
112  *
113  * This function is platform specific and tries to acquire the requested
114  * amount of entropy by polling platform specific entropy sources.
115  *
116  * If the function succeeds in acquiring at least |entropy_requested| bits
117  * of entropy, the total entropy count is returned. If it fails, it returns
118  * an entropy count of 0.
119  */
120 size_t RAND_POOL_acquire_entropy(RAND_POOL *pool);
121 #endif