doc/man1/openssl-list.pod.in

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