1/*
2 * Copyright 1995-2021 The OpenSSL Project Authors. All Rights Reserved.
3 *
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
8 */
9
10#ifndef OPENSSL_RAND_H
11# define OPENSSL_RAND_H
12# pragma once
13
14# include <openssl/macros.h>
15# ifndef OPENSSL_NO_DEPRECATED_3_0
16# define HEADER_RAND_H
17# endif
18
19# include <stdlib.h>
20# include <openssl/types.h>
21# include <openssl/e_os2.h>
22# include <openssl/randerr.h>
23# include <openssl/evp.h>
24
25#ifdef __cplusplus
26extern "C" {
27#endif
28
29/*
30 * Default security strength (in the sense of [NIST SP 800-90Ar1])
31 *
32 * NIST SP 800-90Ar1 supports the strength of the DRBG being smaller than that
33 * of the cipher by collecting less entropy. The current DRBG implementation
34 * does not take RAND_DRBG_STRENGTH into account and sets the strength of the
35 * DRBG to that of the cipher.
36 */
37# define RAND_DRBG_STRENGTH 256
38
39# ifndef OPENSSL_NO_DEPRECATED_3_0
40struct rand_meth_st {
41 int (*seed) (const void *buf, int num);
42 int (*bytes) (unsigned char *buf, int num);
43 void (*cleanup) (void);
44 int (*add) (const void *buf, int num, double randomness);
45 int (*pseudorand) (unsigned char *buf, int num);
46 int (*status) (void);
47};
48
49OSSL_DEPRECATEDIN_3_0 int RAND_set_rand_method(const RAND_METHOD *meth);
50OSSL_DEPRECATEDIN_3_0 const RAND_METHOD *RAND_get_rand_method(void);
51# ifndef OPENSSL_NO_ENGINE
52OSSL_DEPRECATEDIN_3_0 int RAND_set_rand_engine(ENGINE *engine);
53# endif
54
55OSSL_DEPRECATEDIN_3_0 RAND_METHOD *RAND_OpenSSL(void);
56# endif /* OPENSSL_NO_DEPRECATED_3_0 */
57
58# ifndef OPENSSL_NO_DEPRECATED_1_1_0
59# define RAND_cleanup() while(0) continue
60# endif
61int RAND_bytes(unsigned char *buf, int num);
62int RAND_priv_bytes(unsigned char *buf, int num);
63
64/*
65 * Equivalent of RAND_priv_bytes() but additionally taking an OSSL_LIB_CTX and
66 * a strength.
67 */
68int RAND_priv_bytes_ex(OSSL_LIB_CTX *ctx, unsigned char *buf, size_t num,
69 unsigned int strength);
70
71/*
72 * Equivalent of RAND_bytes() but additionally taking an OSSL_LIB_CTX and
73 * a strength.
74 */
75int RAND_bytes_ex(OSSL_LIB_CTX *ctx, unsigned char *buf, size_t num,
76 unsigned int strength);
77
78# ifndef OPENSSL_NO_DEPRECATED_1_1_0
79OSSL_DEPRECATEDIN_1_1_0 int RAND_pseudo_bytes(unsigned char *buf, int num);
80# endif
81
82EVP_RAND_CTX *RAND_get0_primary(OSSL_LIB_CTX *ctx);
83EVP_RAND_CTX *RAND_get0_public(OSSL_LIB_CTX *ctx);
84EVP_RAND_CTX *RAND_get0_private(OSSL_LIB_CTX *ctx);
85
86int RAND_set_DRBG_type(OSSL_LIB_CTX *ctx, const char *drbg, const char *propq,
87 const char *cipher, const char *digest);
88int RAND_set_seed_source_type(OSSL_LIB_CTX *ctx, const char *seed,
89 const char *propq);
90
91void RAND_seed(const void *buf, int num);
92void RAND_keep_random_devices_open(int keep);
93
94# if defined(__ANDROID__) && defined(__NDK_FPABI__)
95__NDK_FPABI__ /* __attribute__((pcs("aapcs"))) on ARM */
96# endif
97void RAND_add(const void *buf, int num, double randomness);
98int RAND_load_file(const char *file, long max_bytes);
99int RAND_write_file(const char *file);
100const char *RAND_file_name(char *file, size_t num);
101int RAND_status(void);
102
103# ifndef OPENSSL_NO_EGD
104int RAND_query_egd_bytes(const char *path, unsigned char *buf, int bytes);
105int RAND_egd(const char *path);
106int RAND_egd_bytes(const char *path, int bytes);
107# endif
108
109int RAND_poll(void);
110
111# if defined(_WIN32) && (defined(BASETYPES) || defined(_WINDEF_H))
112/* application has to include <windows.h> in order to use these */
113# ifndef OPENSSL_NO_DEPRECATED_1_1_0
114OSSL_DEPRECATEDIN_1_1_0 void RAND_screen(void);
115OSSL_DEPRECATEDIN_1_1_0 int RAND_event(UINT, WPARAM, LPARAM);
116# endif
117# endif
118
119#ifdef __cplusplus
120}
121#endif
122
123#endif
124