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