openssl-list.pod.in 5.9 KB

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