2 * Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (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
11 * Licensed under the Apache License 2.0 (the "License");
12 * you may not use this file except in compliance with the License.
13 * You may obtain a copy of the License at
14 * https://www.openssl.org/source/license.html
15 * or in the file LICENSE in the source distribution.
18 #ifndef HEADER_RAND_INT_H
19 # define HEADER_RAND_INT_H
21 # include <openssl/rand.h>
23 /* forward declaration */
24 typedef struct rand_pool_st RAND_POOL;
26 void rand_cleanup_int(void);
27 void rand_drbg_cleanup_int(void);
28 void drbg_delete_thread_state(void);
31 /* Hardware-based seeding functions. */
32 size_t rand_acquire_entropy_from_tsc(RAND_POOL *pool);
33 size_t rand_acquire_entropy_from_cpu(RAND_POOL *pool);
35 /* DRBG entropy callbacks. */
36 size_t rand_drbg_get_entropy(RAND_DRBG *drbg,
38 int entropy, size_t min_len, size_t max_len,
39 int prediction_resistance);
40 void rand_drbg_cleanup_entropy(RAND_DRBG *drbg,
41 unsigned char *out, size_t outlen);
42 size_t rand_drbg_get_nonce(RAND_DRBG *drbg,
44 int entropy, size_t min_len, size_t max_len);
45 void rand_drbg_cleanup_nonce(RAND_DRBG *drbg,
46 unsigned char *out, size_t outlen);
48 size_t rand_drbg_get_additional_data(RAND_POOL *pool, unsigned char **pout);
50 void rand_drbg_cleanup_additional_data(RAND_POOL *pool, unsigned char *out);
52 /* CRNG test entropy filter callbacks. */
53 size_t rand_crngt_get_entropy(RAND_DRBG *drbg,
55 int entropy, size_t min_len, size_t max_len,
56 int prediction_resistance);
57 void rand_crngt_cleanup_entropy(RAND_DRBG *drbg,
58 unsigned char *out, size_t outlen);
63 RAND_POOL *rand_pool_new(int entropy_requested, size_t min_len, size_t max_len);
64 RAND_POOL *rand_pool_attach(const unsigned char *buffer, size_t len,
66 void rand_pool_free(RAND_POOL *pool);
68 const unsigned char *rand_pool_buffer(RAND_POOL *pool);
69 unsigned char *rand_pool_detach(RAND_POOL *pool);
70 void rand_pool_reattach(RAND_POOL *pool, unsigned char *buffer);
72 size_t rand_pool_entropy(RAND_POOL *pool);
73 size_t rand_pool_length(RAND_POOL *pool);
75 size_t rand_pool_entropy_available(RAND_POOL *pool);
76 size_t rand_pool_entropy_needed(RAND_POOL *pool);
77 /* |entropy_factor| expresses how many bits of data contain 1 bit of entropy */
78 size_t rand_pool_bytes_needed(RAND_POOL *pool, unsigned int entropy_factor);
79 size_t rand_pool_bytes_remaining(RAND_POOL *pool);
81 int rand_pool_add(RAND_POOL *pool,
82 const unsigned char *buffer, size_t len, size_t entropy);
83 unsigned char *rand_pool_add_begin(RAND_POOL *pool, size_t len);
84 int rand_pool_add_end(RAND_POOL *pool, size_t len, size_t entropy);
88 * Add random bytes to the pool to acquire requested amount of entropy
90 * This function is platform specific and tries to acquire the requested
91 * amount of entropy by polling platform specific entropy sources.
93 * If the function succeeds in acquiring at least |entropy_requested| bits
94 * of entropy, the total entropy count is returned. If it fails, it returns
95 * an entropy count of 0.
97 size_t rand_pool_acquire_entropy(RAND_POOL *pool);
100 * Add some application specific nonce data
102 * This function is platform specific and adds some application specific
103 * data to the nonce used for instantiating the drbg.
105 * This data currently consists of the process and thread id, and a high
106 * resolution timestamp. The data does not include an atomic counter,
107 * because that is added by the calling function rand_drbg_get_nonce().
109 * Returns 1 on success and 0 on failure.
111 int rand_pool_add_nonce_data(RAND_POOL *pool);
115 * Add some platform specific additional data
117 * This function is platform specific and adds some random noise to the
118 * additional data used for generating random bytes and for reseeding
121 * Returns 1 on success and 0 on failure.
123 int rand_pool_add_additional_data(RAND_POOL *pool);
126 * Initialise the random pool reseeding sources.
128 * Returns 1 on success and 0 on failure.
130 int rand_pool_init(void);
133 * Finalise the random pool reseeding sources.
135 void rand_pool_cleanup(void);
138 * Control the random pool use of open file descriptors.
140 void rand_pool_keep_random_devices_open(int keep);