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