doc/man1/openssl-list.pod

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