| 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_PKEY-SLH-DSA 7SSL" |
| 58 |
.TH EVP_PKEY-SLH-DSA 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_PKEY\-SLH\-DSA, EVP_KEYMGMT\-SLH\-DSA, |
| 65 |
EVP_PKEY\-SLH\-DSA\-SHA2\-128s, EVP_PKEY\-SLH\-DSA\-SHA2\-128f, |
| 66 |
EVP_PKEY\-SLH\-DSA\-SHA2\-192s, EVP_PKEY\-SLH\-DSA\-SHA2\-192f, |
| 67 |
EVP_PKEY\-SLH\-DSA\-SHA2\-256s, EVP_PKEY\-SLH\-DSA\-SHA2\-256f, |
| 68 |
EVP_PKEY\-SLH\-DSA\-SHAKE\-128s, EVP_PKEY\-SLH\-DSA\-SHAKE\-128f, |
| 69 |
EVP_PKEY\-SLH\-DSA\-SHAKE\-192s, EVP_PKEY\-SLH\-DSA\-SHAKE\-192f, |
| 70 |
EVP_PKEY\-SLH\-DSA\-SHAKE\-256s, EVP_PKEY\-SLH\-DSA\-SHAKE\-256f |
| 71 |
\&\- EVP_PKEY SLH\-DSA keytype and algorithm support |
| 72 |
.SH DESCRIPTION |
| 73 |
.IX Header "DESCRIPTION" |
| 74 |
The \fBSLH\-DSA\-SHA2\-128s\fR, \fBEVP_PKEY\-SLH\-DSA\-SHA2\-128f\fR, |
| 75 |
\&\fBSLH\-DSA\-SHA2\-192s\fR, \fBEVP_PKEY\-SLH\-DSA\-SHA2\-192f\fR, |
| 76 |
\&\fBSLH\-DSA\-SHA2\-256s\fR, \fBEVP_PKEY\-SLH\-DSA\-SHA2\-256f\fR, |
| 77 |
\&\fBSLH\-DSA\-SHAKE\-128s\fR, \fBEVP_PKEY\-SLH\-DSA\-SHAKE\-128f\fR, |
| 78 |
\&\fBSLH\-DSA\-SHAKE\-192s\fR, \fBEVP_PKEY\-SLH\-DSA\-SHAKE\-192f\fR, |
| 79 |
\&\fBSLH\-DSA\-SHAKE\-256s\fR and \fBEVP_PKEY\-SLH\-DSA\-SHAKE\-256f\fR key types are |
| 80 |
implemented in OpenSSL's default and FIPS providers. These implementations |
| 81 |
support the associated key, containing the public key \fIpub\fR and the |
| 82 |
private key \fIpriv\fR. |
| 83 |
.PP |
| 84 |
SLH-DSA (Stateless Hash-based Digital Signature Standard) uses small keys, |
| 85 |
but has relatively large signatures and is relatively slow performing all |
| 86 |
operations compared to \fBML-DSA\fR. It does however have proven security proofs, |
| 87 |
since it relies only on hash functions. |
| 88 |
.PP |
| 89 |
Each of the different key types has an associated security parameter \fBn\fR. |
| 90 |
This value is one of 16, 24 or 32 for key types \fBSLH\-DSA*128*\fR, \fBSLH\-DSA*192*\fR |
| 91 |
and \fBSLH\-DSA*256*\fR, respectively. |
| 92 |
.PP |
| 93 |
Both the public and private key components contain 2 elements of size \fBn\fR. |
| 94 |
Key generation generates the private key elements and one of the public key |
| 95 |
elements randomly, and the final public key element is computed from these values. |
| 96 |
.PP |
| 97 |
The public key has relatively small sizes of 32, 48 or 64 bytes, |
| 98 |
corresponding to the algorithm names of 128, 192 and 256 respectively. |
| 99 |
.PP |
| 100 |
The algorithms ending with \fBs\fR produce smaller signatures, but are much slower |
| 101 |
than the faster \fBf\fR variants. |
| 102 |
.PP |
| 103 |
The signature sizes for the \fBs\fR algorithm variants are 7856, 16224 and 29792 |
| 104 |
which correspond to the algorithm names of 128s, 192s and 256s respectively. |
| 105 |
The signature sizes for the \fBf\fR algorithm variants are 17088, 35664 and 49856 |
| 106 |
which correspond to the algorithm names containing 128f, 192f and 256f respectively. |
| 107 |
.PP |
| 108 |
Internally there are 7 hash related functions that are used for each algorithm. |
| 109 |
For algorithms containing \fBSHAKE\fR in their name \fBSHAKE\-256\fR is used for all |
| 110 |
functions. |
| 111 |
For the <SHA2\-128> algorithms the functions use <MGF1\-SHA\-256>, <HMAC\-SHA\-256> |
| 112 |
and <SHA\-256>. |
| 113 |
The remaining <SHA2> algorithms use <MGF1\-SHA\-512>, <HMAC\-SHA\-512>, <SHA\-256> and |
| 114 |
<SHA\-512>. |
| 115 |
See FIPS 205 Section 11.1 and 11.2 for more information. |
| 116 |
.SS "Keygen Parameters" |
| 117 |
.IX Subsection "Keygen Parameters" |
| 118 |
.IP """seed"" (\fBOSSL_PKEY_PARAM_SLH_DSA_SEED\fR) <octet string>" 4 |
| 119 |
.IX Item """seed"" (OSSL_PKEY_PARAM_SLH_DSA_SEED) <octet string>" |
| 120 |
Supplies values to use for the private seed, private prf and |
| 121 |
public seed instead of generating random values. This is used for testing |
| 122 |
purposes only. The length of the value supplied must be 3 * \fBn\fR. |
| 123 |
.IP """properties"" (\fBOSSL_PKEY_PARAM_PROPERTIES\fR) <utf8_string>" 4 |
| 124 |
.IX Item """properties"" (OSSL_PKEY_PARAM_PROPERTIES) <utf8_string>" |
| 125 |
Sets properties to be used when fetching algorithm implementations used for |
| 126 |
SLH-DSA hashing operations. |
| 127 |
.PP |
| 128 |
Use \fBEVP_PKEY_CTX_set_params()\fR after calling \fBEVP_PKEY_keygen_init()\fR. |
| 129 |
.SS "Common SLH-DSA parameters" |
| 130 |
.IX Subsection "Common SLH-DSA parameters" |
| 131 |
In addition to the common parameters that all keytypes should support (see |
| 132 |
"Common Information Parameters" in \fBprovider\-keymgmt\fR\|(7)), the implementation of |
| 133 |
these key types support the following. |
| 134 |
.PP |
| 135 |
The following parameters are gettable using \fBEVP_PKEY_get_octet_string_param()\fR, |
| 136 |
and settable when using \fBEVP_PKEY_fromdata()\fR. |
| 137 |
.IP """pub"" (\fBOSSL_PKEY_PARAM_PUB_KEY\fR) <octet string>" 4 |
| 138 |
.IX Item """pub"" (OSSL_PKEY_PARAM_PUB_KEY) <octet string>" |
| 139 |
The public key has a size of 2 * \fBn\fR bytes. |
| 140 |
i.e. It consists of the concatenation of PK.seed and PK.root |
| 141 |
as defined by FIPS 205 Figure 16. |
| 142 |
.IP """priv"" (\fBOSSL_PKEY_PARAM_PRIV_KEY\fR) <octet string>" 4 |
| 143 |
.IX Item """priv"" (OSSL_PKEY_PARAM_PRIV_KEY) <octet string>" |
| 144 |
The private key has a size of 4 * \fBn\fR bytes, which includes the public key components. |
| 145 |
i.e. It consists of the concatenation of SK.seed, SK.prf, PK.seed and PF.root |
| 146 |
as defined by FIPS 205 Figure 15. |
| 147 |
.IP """mandatory-digest"" (\fBOSSL_PKEY_PARAM_MANDATORY_DIGEST\fR) <UTF8 string>" 4 |
| 148 |
.IX Item """mandatory-digest"" (OSSL_PKEY_PARAM_MANDATORY_DIGEST) <UTF8 string>" |
| 149 |
The empty string, signifying that no digest may be specified. |
| 150 |
.SH "CONFORMING TO" |
| 151 |
.IX Header "CONFORMING TO" |
| 152 |
.IP "FIPS 205" 4 |
| 153 |
.IX Item "FIPS 205" |
| 154 |
.SH EXAMPLES |
| 155 |
.IX Header "EXAMPLES" |
| 156 |
An \fBEVP_PKEY\fR context can be obtained by calling: |
| 157 |
.PP |
| 158 |
.Vb 2 |
| 159 |
\& EVP_PKEY_CTX *pctx = |
| 160 |
\& EVP_PKEY_CTX_new_from_name(NULL, "SLH\-DSA\-SHA2\-128f", NULL); |
| 161 |
.Ve |
| 162 |
.PP |
| 163 |
An \fBSLH-DSA\fR key can be generated like this: |
| 164 |
.PP |
| 165 |
.Vb 1 |
| 166 |
\& pkey = EVP_PKEY_Q_keygen(NULL, NULL, "SLH\-DSA\-SHA2\-128f"); |
| 167 |
.Ve |
| 168 |
.PP |
| 169 |
The key pair components can be extracted from a key by calling: |
| 170 |
.PP |
| 171 |
.Vb 2 |
| 172 |
\& uint8_t priv[64], pub[32]; |
| 173 |
\& size_t priv_len, pub_len; |
| 174 |
\& |
| 175 |
\& EVP_PKEY_get_octet_string_param(pkey, OSSL_PKEY_PARAM_PRIV_KEY, |
| 176 |
\& priv, sizeof(priv), &priv_len); |
| 177 |
\& EVP_PKEY_get_octet_string_param(pkey, OSSL_PKEY_PARAM_PUB_KEY, |
| 178 |
\& pub, sizeof(pub), &pub_len)); |
| 179 |
.Ve |
| 180 |
.PP |
| 181 |
Similar code can be used for the other key types such as "SLH\-DSA\-SHAKE\-256f". |
| 182 |
.SH "SEE ALSO" |
| 183 |
.IX Header "SEE ALSO" |
| 184 |
\&\fBEVP_KEYMGMT\fR\|(3), \fBEVP_PKEY\fR\|(3), \fBprovider\-keymgmt\fR\|(7), |
| 185 |
\&\fBEVP_SIGNATURE\-SLH\-DSA\fR\|(7) |
| 186 |
.SH HISTORY |
| 187 |
.IX Header "HISTORY" |
| 188 |
This functionality was added in OpenSSL 3.5. |
| 189 |
.SH COPYRIGHT |
| 190 |
.IX Header "COPYRIGHT" |
| 191 |
Copyright 2024\-2025 The OpenSSL Project Authors. All Rights Reserved. |
| 192 |
.PP |
| 193 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 194 |
this file except in compliance with the License. You can obtain a copy |
| 195 |
in the file LICENSE in the source distribution or at |
| 196 |
<https://www.openssl.org/source/license.html>. |