xref: /freebsd/crypto/openssl/doc/man1/openssl-list.pod.in (revision e7be843b4a162e68651d3911f0357ed464915629)
1=pod
2{- OpenSSL::safe::output_do_not_edit_headers(); -}
3
4=head1 NAME
5
6openssl-list - list algorithms and features
7
8=head1 SYNOPSIS
9
10B<openssl list>
11[B<-help>]
12[B<-verbose>]
13[B<-select> I<name>]
14[B<-1>]
15[B<-all-algorithms>]
16[B<-commands>]
17[B<-standard-commands>]
18[B<-digest-algorithms>]
19{- output_off() if $disabled{"deprecated-3.0"}; ""
20-}[B<-digest-commands>]
21{- output_on() if $disabled{"deprecated-3.0"}; ""
22-}[B<-kdf-algorithms>]
23[B<-mac-algorithms>]
24[B<-random-instances>]
25[B<-random-generators>]
26[B<-cipher-algorithms>]
27{- output_off() if $disabled{"deprecated-3.0"}; ""
28-}[B<-cipher-commands>]
29{- output_on() if $disabled{"deprecated-3.0"}; ""
30-}[B<-encoders>]
31[B<-decoders>]
32[B<-key-managers>]
33[B<-skey-managers>]
34[B<-key-exchange-algorithms>]
35[B<-kem-algorithms>]
36[B<-tls-groups>]
37[B<-all-tls-groups>]
38[B<-tls1_2>]
39[B<-tls1_3>]
40[B<-signature-algorithms>]
41[B<-tls-signature-algorithms>]
42[B<-asymcipher-algorithms>]
43[B<-public-key-algorithms>]
44[B<-public-key-methods>]
45[B<-store-loaders>]
46[B<-providers>]
47{- output_off() if $disabled{"deprecated-3.0"}; ""
48-}[B<-engines>]
49{- output_on() if $disabled{"deprecated-3.0"}; ""
50-}[B<-disabled>]
51[B<-objects>]
52[B<-options> I<command>]
53{- $OpenSSL::safe::opt_provider_synopsis -}
54
55=head1 DESCRIPTION
56
57This command is used to generate list of algorithms or disabled
58features.
59
60=head1 OPTIONS
61
62=over 4
63
64=item B<-help>
65
66Display a usage message.
67
68=item B<-verbose>
69
70Displays extra information.
71The options below where verbosity applies say a bit more about what that means.
72
73=item B<-select> I<name>
74
75Only list algorithms that match this name.
76
77=item B<-1>
78
79List the commands, digest-commands, or cipher-commands in a single column.
80If used, this option must be given first.
81
82=item B<-all-algorithms>
83
84Display lists of all algorithms.  These include:
85
86=over 4
87
88=item Asymmetric ciphers
89
90=item Decoders
91
92=item Digests
93
94=item Encoders
95
96=item Key derivation algorithms (KDF)
97
98=item Key encapsulation methods (KEM)
99
100=item Key exchange algorithms (KEX)
101
102=item Key managers
103
104=item Symmetric key managers
105
106=item Message authentication code algorithms (MAC)
107
108=item Random number generators (RNG, DRBG)
109
110=item Signature algorithms
111
112=item Store loaders
113
114=item Symmetric ciphers
115
116=back
117
118=item B<-commands>
119
120Display a list of standard commands.
121
122=item B<-standard-commands>
123
124List of standard commands.
125
126=item B<-digest-commands>
127
128This option is deprecated. Use B<digest-algorithms> instead.
129
130Display a list of message digest commands, which are typically used
131as input to the L<openssl-dgst(1)> or L<openssl-speed(1)> commands.
132
133=item B<-cipher-commands>
134
135This option is deprecated. Use B<cipher-algorithms> instead.
136
137Display a list of cipher commands, which are typically used as input
138to the L<openssl-enc(1)> or L<openssl-speed(1)> commands.
139
140=item B<-cipher-algorithms>, B<-digest-algorithms>, B<-kdf-algorithms>,
141B<-mac-algorithms>,
142
143Display a list of symmetric cipher, digest, kdf and mac algorithms.
144See L</Display of algorithm names> for a description of how names are
145displayed.
146
147In verbose mode, the algorithms provided by a provider will get additional
148information on what parameters each implementation supports.
149
150=item B<-random-instances>
151
152List the primary, public and private random number generator details.
153
154=item B<-random-generators>
155
156Display a list of random number generators.
157See L</Display of algorithm names> for a description of how names are
158displayed.
159
160=item B<-encoders>
161
162Display a list of encoders.
163See L</Display of algorithm names> for a description of how names are
164displayed.
165
166In verbose mode, the algorithms provided by a provider will get additional
167information on what parameters each implementation supports.
168
169=item B<-decoders>
170
171Display a list of decoders.
172See L</Display of algorithm names> for a description of how names are
173displayed.
174
175In verbose mode, the algorithms provided by a provider will get additional
176information on what parameters each implementation supports.
177
178=item B<-public-key-algorithms>
179
180Display a list of public key algorithms, with each algorithm as
181a block of multiple lines, all but the first are indented.
182The options B<key-exchange-algorithms>, B<kem-algorithms>,
183B<signature-algorithms>, and B<asymcipher-algorithms> will display similar info.
184
185=item B<-public-key-methods>
186
187Display a list of public key methods.
188
189=item B<-key-managers>
190
191Display a list of key managers.
192
193=item B<-skey-managers>
194
195Display a list of symmetric key managers.
196
197=item B<-key-exchange-algorithms>
198
199Display a list of key exchange algorithms.
200
201=item B<-kem-algorithms>
202
203Display a list of key encapsulation algorithms.
204
205=item B<-tls-groups>
206
207Display a list of the IANA names of all available (implemented) TLS groups.
208By default the listed groups are those compatible with TLS 1.3.
209
210=item B<-all-tls-groups>
211
212Display a list of the names of all available (implemented) TLS groups,
213including any aliases.
214Some groups are known under multiple names, for example, B<secp256r1> is also
215known as B<P-256>.
216By default the listed groups are those compatible with TLS 1.3.
217
218=item B<-tls1_2>
219
220When listing TLS groups, list those compatible with TLS 1.2
221
222=item B<-tls1_3>
223
224When listing TLS groups, output those compatible with TLS 1.3.
225TLS 1.3 is the current default protocol version, but the default version is
226subject to change, so best to specify the version explicitly.
227
228=item B<-signature-algorithms>
229
230Display a list of signature algorithms.
231
232=item B<-tls-signature-algorithms>
233
234Display the list of signature algorithms available for TLS handshakes
235made available by all currently active providers.
236The output format is colon delimited in a form directly usable in
237L<SSL_CONF_cmd(3)> specifying SignatureAlgorithms.
238
239=item B<-asymcipher-algorithms>
240
241Display a list of asymmetric cipher algorithms.
242
243=item B<-store-loaders>
244
245Display a list of store loaders.
246
247=item B<-providers>
248
249Display a list of all loaded providers with their names, version and status.
250
251In verbose mode, the full version and all provider parameters will additionally
252be displayed.
253
254
255=item B<-engines>
256
257This option is deprecated.
258
259Display a list of loaded engines.
260
261=item B<-disabled>
262
263Display a list of disabled features, those that were compiled out
264of the installation.
265
266=item B<-objects>
267
268Display a list of built in objects, i.e. OIDs with names.  They're listed in the
269format described in L<config(5)/ASN1 Object Configuration Module>.
270
271=item B<-options> I<command>
272
273Output a two-column list of the options accepted by the specified I<command>.
274The first is the option name, and the second is a one-character indication
275of what type of parameter it takes, if any.
276This is an internal option, used for checking that the documentation
277is complete.
278
279{- $OpenSSL::safe::opt_provider_item -}
280
281=back
282
283=head2 Display of algorithm names
284
285Algorithm names may be displayed in one of two manners:
286
287=over 4
288
289=item Legacy implementations
290
291Legacy implementations will simply display the main name of the
292algorithm on a line of its own, or in the form C<<foo > bar>> to show
293that C<foo> is an alias for the main name, C<bar>
294
295=item Provided implementations
296
297Implementations from a provider are displayed like this if the
298implementation is labeled with a single name:
299
300 foo @ bar
301
302or like this if it's labeled with multiple names:
303
304 { foo1, foo2 } @bar
305
306In both cases, C<bar> is the name of the provider.
307
308=back
309
310=head1 HISTORY
311
312The B<-engines>, B<-digest-commands>, and B<-cipher-commands> options
313were deprecated in OpenSSL 3.0.
314
315The B<-skey-managers> option was added in OpenSSL 3.5.
316
317=head1 COPYRIGHT
318
319Copyright 2016-2025 The OpenSSL Project Authors. All Rights Reserved.
320
321Licensed under the Apache License 2.0 (the "License").  You may not use
322this file except in compliance with the License.  You can obtain a copy
323in the file LICENSE in the source distribution or at
324L<https://www.openssl.org/source/license.html>.
325
326=cut
327