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