Debian Codegraph @

upstream/debian-unstable/man7/EVP_KDF-HMAC-DRBG.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_KDF-HMAC-DRBG 7SSL"
58 .TH EVP_KDF-HMAC-DRBG 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_KDF\-HMAC\-DRBG
65 \&\- The HMAC DRBG DETERMINISTIC EVP_KDF implementation
66 .SH DESCRIPTION
67 .IX Header "DESCRIPTION"
68 Support for a deterministic HMAC DRBG using the \fBEVP_KDF\fR API. This is similar
69 to \fBEVP_RAND\-HMAC\-DRBG\fR\|(7), but uses fixed values for its entropy and nonce
70 values. This is used to generate deterministic nonce value required by ECDSA
71 and DSA (as defined in RFC 6979).
72 .SS Identity
73 .IX Subsection "Identity"
74 "HMAC-DRBG-KDF" is the name for this implementation; it can be used
75 with the \fBEVP_KDF_fetch()\fR function.
76 .SS "Supported parameters"
77 .IX Subsection "Supported parameters"
78 The supported parameters are:
79 .IP """digest"" (\fBOSSL_DRBG_PARAM_DIGEST\fR) <UTF8 string>" 4
80 .IX Item """digest"" (OSSL_DRBG_PARAM_DIGEST) <UTF8 string>"
81 .PD 0
82 .IP """properties"" (\fBOSSL_DRBG_PARAM_PROPERTIES\fR) <UTF8 string>" 4
83 .IX Item """properties"" (OSSL_DRBG_PARAM_PROPERTIES) <UTF8 string>"
84 .PD
85 These parameters work as described in "PARAMETERS" in \fBEVP_KDF\fR\|(3).
86 .IP """entropy"" (\fBOSSL_KDF_PARAM_HMACDRBG_ENTROPY\fR) <octet string>" 4
87 .IX Item """entropy"" (OSSL_KDF_PARAM_HMACDRBG_ENTROPY) <octet string>"
88 Sets the entropy bytes supplied to the HMAC-DRBG.
89 .IP """nonce"" (\fBOSSL_KDF_PARAM_HMACDRBG_NONCE\fR) <octet string>" 4
90 .IX Item """nonce"" (OSSL_KDF_PARAM_HMACDRBG_NONCE) <octet string>"
91 Sets the nonce bytes supplied to the HMAC-DRBG.
92 .SH NOTES
93 .IX Header "NOTES"
94 A context for KDF HMAC DRBG can be obtained by calling:
95 .PP
96 .Vb 2
97 \& EVP_KDF *kdf = EVP_KDF_fetch(NULL, "HMAC\-DRBG\-KDF", NULL);
98 \& EVP_KDF_CTX *kdf_ctx = EVP_KDF_CTX_new(kdf, NULL);
99 .Ve
100 .SH "CONFORMING TO"
101 .IX Header "CONFORMING TO"
102 RFC 6979
103 .SH "SEE ALSO"
104 .IX Header "SEE ALSO"
105 \&\fBEVP_KDF\fR\|(3),
106 "PARAMETERS" in \fBEVP_KDF\fR\|(3)
107 .SH HISTORY
108 .IX Header "HISTORY"
109 The EVP_KDF\-HMAC\-DRBG functionality was added in OpenSSL 3.2.
110 .SH COPYRIGHT
111 .IX Header "COPYRIGHT"
112 Copyright 2022\-2023 The OpenSSL Project Authors. All Rights Reserved.
113 .PP
114 Licensed under the Apache License 2.0 (the "License"). You may not use
115 this file except in compliance with the License. You can obtain a copy
116 in the file LICENSE in the source distribution or at
117 <https://www.openssl.org/source/license.html>.