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<-key-exchange-algorithms>] 34[B<-kem-algorithms>] 35[B<-signature-algorithms>] 36[B<-asymcipher-algorithms>] 37[B<-public-key-algorithms>] 38[B<-public-key-methods>] 39[B<-store-loaders>] 40[B<-providers>] 41{- output_off() if $disabled{"deprecated-3.0"}; "" 42-}[B<-engines>] 43{- output_on() if $disabled{"deprecated-3.0"}; "" 44-}[B<-disabled>] 45[B<-objects>] 46[B<-options> I<command>] 47{- $OpenSSL::safe::opt_provider_synopsis -} 48 49=head1 DESCRIPTION 50 51This command is used to generate list of algorithms or disabled 52features. 53 54=head1 OPTIONS 55 56=over 4 57 58=item B<-help> 59 60Display a usage message. 61 62=item B<-verbose> 63 64Displays extra information. 65The options below where verbosity applies say a bit more about what that means. 66 67=item B<-select> I<name> 68 69Only list algorithms that match this name. 70 71=item B<-1> 72 73List the commands, digest-commands, or cipher-commands in a single column. 74If used, this option must be given first. 75 76=item B<-all-algorithms> 77 78Display lists of all algorithms. These include: 79 80=over 4 81 82=item Asymmetric ciphers 83 84=item Decoders 85 86=item Digests 87 88=item Encoders 89 90=item Key derivation algorithms (KDF) 91 92=item Key encapsulation methods (KEM) 93 94=item Key exchange algorithms (KEX) 95 96=item Key managers 97 98=item Message authentication code algorithms (MAC) 99 100=item Random number generators (RNG, DRBG) 101 102=item Signature algorithms 103 104=item Store loaders 105 106=item Symmetric ciphers 107 108=back 109 110=item B<-commands> 111 112Display a list of standard commands. 113 114=item B<-standard-commands> 115 116List of standard commands. 117 118=item B<-digest-commands> 119 120This option is deprecated. Use B<digest-algorithms> instead. 121 122Display a list of message digest commands, which are typically used 123as input to the L<openssl-dgst(1)> or L<openssl-speed(1)> commands. 124 125=item B<-cipher-commands> 126 127This option is deprecated. Use B<cipher-algorithms> instead. 128 129Display a list of cipher commands, which are typically used as input 130to the L<openssl-enc(1)> or L<openssl-speed(1)> commands. 131 132=item B<-cipher-algorithms>, B<-digest-algorithms>, B<-kdf-algorithms>, 133B<-mac-algorithms>, 134 135Display a list of symmetric cipher, digest, kdf and mac algorithms. 136See L</Display of algorithm names> for a description of how names are 137displayed. 138 139In verbose mode, the algorithms provided by a provider will get additional 140information on what parameters each implementation supports. 141 142=item B<-random-instances> 143 144List the primary, public and private random number generator details. 145 146=item B<-random-generators> 147 148Display a list of random number generators. 149See L</Display of algorithm names> for a description of how names are 150displayed. 151 152=item B<-encoders> 153 154Display a list of encoders. 155See L</Display of algorithm names> for a description of how names are 156displayed. 157 158In verbose mode, the algorithms provided by a provider will get additional 159information on what parameters each implementation supports. 160 161=item B<-decoders> 162 163Display a list of decoders. 164See L</Display of algorithm names> for a description of how names are 165displayed. 166 167In verbose mode, the algorithms provided by a provider will get additional 168information on what parameters each implementation supports. 169 170=item B<-public-key-algorithms> 171 172Display a list of public key algorithms, with each algorithm as 173a block of multiple lines, all but the first are indented. 174The options B<key-exchange-algorithms>, B<kem-algorithms>, 175B<signature-algorithms>, and B<asymcipher-algorithms> will display similar info. 176 177=item B<-public-key-methods> 178 179Display a list of public key methods. 180 181=item B<-key-managers> 182 183Display a list of key managers. 184 185=item B<-key-exchange-algorithms> 186 187Display a list of key exchange algorithms. 188 189=item B<-kem-algorithms> 190 191Display a list of key encapsulation algorithms. 192 193=item B<-signature-algorithms> 194 195Display a list of signature algorithms. 196 197=item B<-asymcipher-algorithms> 198 199Display a list of asymmetric cipher algorithms. 200 201=item B<-store-loaders> 202 203Display a list of store loaders. 204 205=item B<-providers> 206 207Display a list of all loaded providers with their names, version and status. 208 209In verbose mode, the full version and all provider parameters will additionally 210be displayed. 211 212 213=item B<-engines> 214 215This option is deprecated. 216 217Display a list of loaded engines. 218 219=item B<-disabled> 220 221Display a list of disabled features, those that were compiled out 222of the installation. 223 224=item B<-objects> 225 226Display a list of built in objects, i.e. OIDs with names. They're listed in the 227format described in L<config(5)/ASN1 Object Configuration Module>. 228 229=item B<-options> I<command> 230 231Output a two-column list of the options accepted by the specified I<command>. 232The first is the option name, and the second is a one-character indication 233of what type of parameter it takes, if any. 234This is an internal option, used for checking that the documentation 235is complete. 236 237{- $OpenSSL::safe::opt_provider_item -} 238 239=back 240 241=head2 Display of algorithm names 242 243Algorithm names may be displayed in one of two manners: 244 245=over 4 246 247=item Legacy implementations 248 249Legacy implementations will simply display the main name of the 250algorithm on a line of its own, or in the form C<<foo > bar>> to show 251that C<foo> is an alias for the main name, C<bar> 252 253=item Provided implementations 254 255Implementations from a provider are displayed like this if the 256implementation is labeled with a single name: 257 258 foo @ bar 259 260or like this if it's labeled with multiple names: 261 262 { foo1, foo2 } @bar 263 264In both cases, C<bar> is the name of the provider. 265 266=back 267 268=head1 HISTORY 269 270The B<-engines>, B<-digest-commands>, and B<-cipher-commands> options 271were deprecated in OpenSSL 3.0. 272 273=head1 COPYRIGHT 274 275Copyright 2016-2021 The OpenSSL Project Authors. All Rights Reserved. 276 277Licensed under the Apache License 2.0 (the "License"). You may not use 278this file except in compliance with the License. You can obtain a copy 279in the file LICENSE in the source distribution or at 280L<https://www.openssl.org/source/license.html>. 281 282=cut 283
