Debian Codegraph @

upstream/debian-unstable/man7/OSSL_PROVIDER-base.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 "OSSL_PROVIDER-BASE 7SSL"
58 .TH OSSL_PROVIDER-BASE 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 OSSL_PROVIDER\-base \- OpenSSL base provider
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 The OpenSSL base provider supplies the encoding for OpenSSL's
68 asymmetric cryptography.
69 .SS Properties
70 .IX Subsection "Properties"
71 The implementations in this provider specifically have this property
72 defined:
73 .IP """provider=base""" 4
74 .IX Item """provider=base"""
75 .PP
76 It may be used in a property query string with fetching functions.
77 .PP
78 It isn't mandatory to query for this property, except to make sure to get
79 implementations of this provider and none other.
80 .IP """type=parameters""" 4
81 .IX Item """type=parameters"""
82 .PD 0
83 .IP """type=private""" 4
84 .IX Item """type=private"""
85 .IP """type=public""" 4
86 .IX Item """type=public"""
87 .PD
88 .PP
89 These may be used in a property query string with fetching functions to select
90 which data are to be encoded. Either the private key material, the public
91 key material or the domain parameters can be selected.
92 .IP """format=der""" 4
93 .IX Item """format=der"""
94 .PD 0
95 .IP """format=pem""" 4
96 .IX Item """format=pem"""
97 .IP """format=text""" 4
98 .IX Item """format=text"""
99 .PD
100 .PP
101 These may be used in a property query string with fetching functions to select
102 the encoding output format. Either the DER, PEM and plaintext are
103 currently permitted.
104 .SH "OPERATIONS AND ALGORITHMS"
105 .IX Header "OPERATIONS AND ALGORITHMS"
106 The OpenSSL base provider supports these operations and algorithms:
107 .SS "Random Number Generation"
108 .IX Subsection "Random Number Generation"
109 .IP "SEED-SRC, see \fBEVP_RAND\-SEED\-SRC\fR\|(7)" 4
110 .IX Item "SEED-SRC, see EVP_RAND-SEED-SRC"
111 .PD 0
112 .IP "JITTER, see \fBEVP_RAND\-JITTER\fR\|(7)" 4
113 .IX Item "JITTER, see EVP_RAND-JITTER"
114 .PD
115 .PP
116 In addition to this provider, the "SEED-SRC" and "JITTER" algorithms
117 are also available in the default provider.
118 .SS "Asymmetric Key Encoder"
119 .IX Subsection "Asymmetric Key Encoder"
120 .IP RSA 4
121 .IX Item "RSA"
122 .PD 0
123 .IP RSA-PSS 4
124 .IX Item "RSA-PSS"
125 .IP DH 4
126 .IX Item "DH"
127 .IP DHX 4
128 .IX Item "DHX"
129 .IP DSA 4
130 .IX Item "DSA"
131 .IP EC 4
132 .IX Item "EC"
133 .IP ED25519 4
134 .IX Item "ED25519"
135 .IP ED448 4
136 .IX Item "ED448"
137 .IP X25519 4
138 .IX Item "X25519"
139 .IP X448 4
140 .IX Item "X448"
141 .IP SM2 4
142 .IX Item "SM2"
143 .IP ML\-DSA\-44 4
144 .IX Item "ML-DSA-44"
145 .IP ML\-DSA\-65 4
146 .IX Item "ML-DSA-65"
147 .IP ML\-DSA\-87 4
148 .IX Item "ML-DSA-87"
149 .IP ML\-KEM\-512 4
150 .IX Item "ML-KEM-512"
151 .IP ML\-KEM\-768 4
152 .IX Item "ML-KEM-768"
153 .IP ML\-KEM\-1024 4
154 .IX Item "ML-KEM-1024"
155 .IP SLH\-DSA\-SHA2\-128s 4
156 .IX Item "SLH-DSA-SHA2-128s"
157 .IP SLH\-DSA\-SHA2\-128f 4
158 .IX Item "SLH-DSA-SHA2-128f"
159 .IP SLH\-DSA\-SHA2\-192s 4
160 .IX Item "SLH-DSA-SHA2-192s"
161 .IP SLH\-DSA\-SHA2\-192f 4
162 .IX Item "SLH-DSA-SHA2-192f"
163 .IP SLH\-DSA\-SHA2\-256s 4
164 .IX Item "SLH-DSA-SHA2-256s"
165 .IP SLH\-DSA\-SHA2\-256f 4
166 .IX Item "SLH-DSA-SHA2-256f"
167 .IP SLH\-DSA\-SHAKE\-128s 4
168 .IX Item "SLH-DSA-SHAKE-128s"
169 .IP SLH\-DSA\-SHAKE\-128f 4
170 .IX Item "SLH-DSA-SHAKE-128f"
171 .IP SLH\-DSA\-SHAKE\-192s 4
172 .IX Item "SLH-DSA-SHAKE-192s"
173 .IP SLH\-DSA\-SHAKE\-192f 4
174 .IX Item "SLH-DSA-SHAKE-192f"
175 .IP SLH\-DSA\-SHAKE\-256s 4
176 .IX Item "SLH-DSA-SHAKE-256s"
177 .IP SLH\-DSA\-SHAKE\-256f 4
178 .IX Item "SLH-DSA-SHAKE-256f"
179 .PD
180 .PP
181 In addition to this provider, all of these encoding algorithms are also
182 available in the default provider. Some of these algorithms may be used in
183 combination with the FIPS provider.
184 .SS "Asymmetric Key Decoder"
185 .IX Subsection "Asymmetric Key Decoder"
186 .IP RSA 4
187 .IX Item "RSA"
188 .PD 0
189 .IP RSA-PSS 4
190 .IX Item "RSA-PSS"
191 .IP DH 4
192 .IX Item "DH"
193 .IP DHX 4
194 .IX Item "DHX"
195 .IP DSA 4
196 .IX Item "DSA"
197 .IP EC 4
198 .IX Item "EC"
199 .IP ED25519 4
200 .IX Item "ED25519"
201 .IP ED448 4
202 .IX Item "ED448"
203 .IP X25519 4
204 .IX Item "X25519"
205 .IP X448 4
206 .IX Item "X448"
207 .IP SM2 4
208 .IX Item "SM2"
209 .IP DER 4
210 .IX Item "DER"
211 .IP ML\-DSA\-44 4
212 .IX Item "ML-DSA-44"
213 .IP ML\-DSA\-65 4
214 .IX Item "ML-DSA-65"
215 .IP ML\-DSA\-87 4
216 .IX Item "ML-DSA-87"
217 .IP ML\-KEM\-512 4
218 .IX Item "ML-KEM-512"
219 .IP ML\-KEM\-768 4
220 .IX Item "ML-KEM-768"
221 .IP ML\-KEM\-1024 4
222 .IX Item "ML-KEM-1024"
223 .IP SLH\-DSA\-SHA2\-128s 4
224 .IX Item "SLH-DSA-SHA2-128s"
225 .IP SLH\-DSA\-SHA2\-128f 4
226 .IX Item "SLH-DSA-SHA2-128f"
227 .IP SLH\-DSA\-SHA2\-192s 4
228 .IX Item "SLH-DSA-SHA2-192s"
229 .IP SLH\-DSA\-SHA2\-192f 4
230 .IX Item "SLH-DSA-SHA2-192f"
231 .IP SLH\-DSA\-SHA2\-256s 4
232 .IX Item "SLH-DSA-SHA2-256s"
233 .IP SLH\-DSA\-SHA2\-256f 4
234 .IX Item "SLH-DSA-SHA2-256f"
235 .IP SLH\-DSA\-SHAKE\-128s 4
236 .IX Item "SLH-DSA-SHAKE-128s"
237 .IP SLH\-DSA\-SHAKE\-128f 4
238 .IX Item "SLH-DSA-SHAKE-128f"
239 .IP SLH\-DSA\-SHAKE\-192s 4
240 .IX Item "SLH-DSA-SHAKE-192s"
241 .IP SLH\-DSA\-SHAKE\-192f 4
242 .IX Item "SLH-DSA-SHAKE-192f"
243 .IP SLH\-DSA\-SHAKE\-256s 4
244 .IX Item "SLH-DSA-SHAKE-256s"
245 .IP SLH\-DSA\-SHAKE\-256f 4
246 .IX Item "SLH-DSA-SHAKE-256f"
247 .PD
248 .PP
249 In addition to this provider, all of these decoding algorithms are also
250 available in the default provider. Some of these algorithms may be used in
251 combination with the FIPS provider.
252 .SS Stores
253 .IX Subsection "Stores"
254 .IP file 4
255 .IX Item "file"
256 .PD 0
257 .IP "org.openssl.winstore, see \fBOSSL_STORE\-winstore\fR\|(7)" 4
258 .IX Item "org.openssl.winstore, see OSSL_STORE-winstore"
259 .PD
260 .PP
261 In addition to this provider, all of these store algorithms are also
262 available in the default provider.
263 .SH "SEE ALSO"
264 .IX Header "SEE ALSO"
265 \&\fBOSSL_PROVIDER\-default\fR\|(7), \fBopenssl\-core.h\fR\|(7),
266 \&\fBopenssl\-core_dispatch.h\fR\|(7), \fBprovider\fR\|(7)
267 .SH HISTORY
268 .IX Header "HISTORY"
269 This functionality was added in OpenSSL 3.0.
270 .PP
271 Support for \fBML-DSA\fR and <ML\-KEM> was added in OpenSSL 3.5.
272 .SH COPYRIGHT
273 .IX Header "COPYRIGHT"
274 Copyright 2020\-2025 The OpenSSL Project Authors. All Rights Reserved.
275 .PP
276 Licensed under the Apache License 2.0 (the "License"). You may not use
277 this file except in compliance with the License. You can obtain a copy
278 in the file LICENSE in the source distribution or at
279 <https://www.openssl.org/source/license.html>.