Debian Codegraph @

upstream/debian-unstable/man7/EVP_RAND-CRNG-TEST.7ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "EVP_RAND-CRNG-TEST 7SSL"
58 .TH EVP_RAND-CRNG-TEST 7SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 EVP_RAND\-CRNG\-TEST \- The FIPS health testing EVP_RAND filter
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 This \fBEVP_RAND\fR object acts as a filter between the entropy source
68 and its users. It performs CRNG health tests as defined in
69 SP 800\-90B <https://csrc.nist.gov/pubs/sp/800/90/b/final> Section 4 "Health
70 Tests". Most requests are forwarded to the entropy source, either via
71 its parent reference or via the provider entropy upcalls.
72 .SS Identity
73 .IX Subsection "Identity"
74 "CRNG-TEST" is the name for this implementation; it can be used with the
75 \&\fBEVP_RAND_fetch()\fR function.
76 .SS "Supported parameters"
77 .IX Subsection "Supported parameters"
78 If a parent EVP_RAND is specified on context creation, the parent's
79 parameters are supported because the request is forwarded to the parent
80 seed source for processing.
81 .PP
82 If no parent EVP_RAND is specified on context creation, the following parameters
83 are supported:
84 .IP """state"" (\fBOSSL_RAND_PARAM_STATE\fR) <integer>" 4
85 .IX Item """state"" (OSSL_RAND_PARAM_STATE) <integer>"
86 .PD 0
87 .IP """strength"" (\fBOSSL_RAND_PARAM_STRENGTH\fR) <unsigned integer>" 4
88 .IX Item """strength"" (OSSL_RAND_PARAM_STRENGTH) <unsigned integer>"
89 .IP """max_request"" (\fBOSSL_RAND_PARAM_MAX_REQUEST\fR) <unsigned integer>" 4
90 .IX Item """max_request"" (OSSL_RAND_PARAM_MAX_REQUEST) <unsigned integer>"
91 .PD
92 These parameters work as described in "PARAMETERS" in \fBEVP_RAND\fR\|(3).
93 .IP """fips-indicator"" (\fBOSSL_DRBG_PARAM_FIPS_APPROVED_INDICATOR\fR) <integer>" 4
94 .IX Item """fips-indicator"" (OSSL_DRBG_PARAM_FIPS_APPROVED_INDICATOR) <integer>"
95 This parameter works as described in "PARAMETERS" in \fBprovider\-rand\fR\|(7).
96 .SH NOTES
97 .IX Header "NOTES"
98 This EVP_RAND is only implemented by the OpenSSL FIPS provider.
99 .PP
100 A context for a health test filter can be obtained by calling:
101 .PP
102 .Vb 3
103 \& EVP_RAND *parent = ...;
104 \& EVP_RAND *rand = EVP_RAND_fetch(NULL, "CRNG\-TEST", NULL);
105 \& EVP_RAND_CTX *rctx = EVP_RAND_CTX_new(rand, parent);
106 .Ve
107 .SH "SEE ALSO"
108 .IX Header "SEE ALSO"
109 \&\fBEVP_RAND\fR\|(3), \fBOSSL_PROVIDER\-FIPS\fR\|(7)
110 .SH HISTORY
111 .IX Header "HISTORY"
112 This functionality was added in OpenSSL 3.4.
113 .SH COPYRIGHT
114 .IX Header "COPYRIGHT"
115 Copyright 2024 The OpenSSL Project Authors. All Rights Reserved.
116 .PP
117 Licensed under the Apache License 2.0 (the "License"). You may not use
118 this file except in compliance with the License. You can obtain a copy
119 in the file LICENSE in the source distribution or at
120 <https://www.openssl.org/source/license.html>.