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