openssl-list.1ossl 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381
  1. .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
  2. .\"
  3. .\" Standard preamble:
  4. .\" ========================================================================
  5. .de Sp \" Vertical space (when we can't use .PP)
  6. .if t .sp .5v
  7. .if n .sp
  8. ..
  9. .de Vb \" Begin verbatim text
  10. .ft CW
  11. .nf
  12. .ne \\$1
  13. ..
  14. .de Ve \" End verbatim text
  15. .ft R
  16. .fi
  17. ..
  18. .\" Set up some character translations and predefined strings. \*(-- will
  19. .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20. .\" double quote, and \*(R" will give a right double quote. \*(C+ will
  21. .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
  22. .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
  23. .\" nothing in troff, for use with C<>.
  24. .tr \(*W-
  25. .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26. .ie n \{\
  27. . ds -- \(*W-
  28. . ds PI pi
  29. . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30. . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
  31. . ds L" ""
  32. . ds R" ""
  33. . ds C` ""
  34. . ds C' ""
  35. 'br\}
  36. .el\{\
  37. . ds -- \|\(em\|
  38. . ds PI \(*p
  39. . ds L" ``
  40. . ds R" ''
  41. . ds C`
  42. . ds C'
  43. 'br\}
  44. .\"
  45. .\" Escape single quotes in literal strings from groff's Unicode transform.
  46. .ie \n(.g .ds Aq \(aq
  47. .el .ds Aq '
  48. .\"
  49. .\" If the F register is >0, we'll generate index entries on stderr for
  50. .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51. .\" entries marked with X<> in POD. Of course, you'll have to process the
  52. .\" output yourself in some meaningful fashion.
  53. .\"
  54. .\" Avoid warning from groff about undefined register 'F'.
  55. .de IX
  56. ..
  57. .nr rF 0
  58. .if \n(.g .if rF .nr rF 1
  59. .if (\n(rF:(\n(.g==0)) \{\
  60. . if \nF \{\
  61. . de IX
  62. . tm Index:\\$1\t\\n%\t"\\$2"
  63. ..
  64. . if !\nF==2 \{\
  65. . nr % 0
  66. . nr F 2
  67. . \}
  68. . \}
  69. .\}
  70. .rr rF
  71. .\"
  72. .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73. .\" Fear. Run. Save yourself. No user-serviceable parts.
  74. . \" fudge factors for nroff and troff
  75. .if n \{\
  76. . ds #H 0
  77. . ds #V .8m
  78. . ds #F .3m
  79. . ds #[ \f1
  80. . ds #] \fP
  81. .\}
  82. .if t \{\
  83. . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84. . ds #V .6m
  85. . ds #F 0
  86. . ds #[ \&
  87. . ds #] \&
  88. .\}
  89. . \" simple accents for nroff and troff
  90. .if n \{\
  91. . ds ' \&
  92. . ds ` \&
  93. . ds ^ \&
  94. . ds , \&
  95. . ds ~ ~
  96. . ds /
  97. .\}
  98. .if t \{\
  99. . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  100. . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  101. . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  102. . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  103. . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  104. . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  105. .\}
  106. . \" troff and (daisy-wheel) nroff accents
  107. .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  108. .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
  109. .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
  110. .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
  111. .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
  112. .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
  113. .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
  114. .ds ae a\h'-(\w'a'u*4/10)'e
  115. .ds Ae A\h'-(\w'A'u*4/10)'E
  116. . \" corrections for vroff
  117. .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
  118. .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
  119. . \" for low resolution devices (crt and lpr)
  120. .if \n(.H>23 .if \n(.V>19 \
  121. \{\
  122. . ds : e
  123. . ds 8 ss
  124. . ds o a
  125. . ds d- d\h'-1'\(ga
  126. . ds D- D\h'-1'\(hy
  127. . ds th \o'bp'
  128. . ds Th \o'LP'
  129. . ds ae ae
  130. . ds Ae AE
  131. .\}
  132. .rm #[ #] #H #V #F C
  133. .\" ========================================================================
  134. .\"
  135. .IX Title "OPENSSL-LIST 1ossl"
  136. .TH OPENSSL-LIST 1ossl "2025-06-29" "3.3.2" "OpenSSL"
  137. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  138. .\" way too many mistakes in technical documents.
  139. .if n .ad l
  140. .nh
  141. .SH "NAME"
  142. openssl\-list \- list algorithms and features
  143. .SH "SYNOPSIS"
  144. .IX Header "SYNOPSIS"
  145. \&\fBopenssl list\fR
  146. [\fB\-help\fR]
  147. [\fB\-verbose\fR]
  148. [\fB\-select\fR \fIname\fR]
  149. [\fB\-1\fR]
  150. [\fB\-all\-algorithms\fR]
  151. [\fB\-commands\fR]
  152. [\fB\-standard\-commands\fR]
  153. [\fB\-digest\-algorithms\fR]
  154. [\fB\-digest\-commands\fR]
  155. [\fB\-kdf\-algorithms\fR]
  156. [\fB\-mac\-algorithms\fR]
  157. [\fB\-random\-instances\fR]
  158. [\fB\-random\-generators\fR]
  159. [\fB\-cipher\-algorithms\fR]
  160. [\fB\-cipher\-commands\fR]
  161. [\fB\-encoders\fR]
  162. [\fB\-decoders\fR]
  163. [\fB\-key\-managers\fR]
  164. [\fB\-key\-exchange\-algorithms\fR]
  165. [\fB\-kem\-algorithms\fR]
  166. [\fB\-signature\-algorithms\fR]
  167. [\fB\-asymcipher\-algorithms\fR]
  168. [\fB\-public\-key\-algorithms\fR]
  169. [\fB\-public\-key\-methods\fR]
  170. [\fB\-store\-loaders\fR]
  171. [\fB\-providers\fR]
  172. [\fB\-engines\fR]
  173. [\fB\-disabled\fR]
  174. [\fB\-objects\fR]
  175. [\fB\-options\fR \fIcommand\fR]
  176. [\fB\-provider\fR \fIname\fR]
  177. [\fB\-provider\-path\fR \fIpath\fR]
  178. [\fB\-propquery\fR \fIpropq\fR]
  179. .SH "DESCRIPTION"
  180. .IX Header "DESCRIPTION"
  181. This command is used to generate list of algorithms or disabled
  182. features.
  183. .SH "OPTIONS"
  184. .IX Header "OPTIONS"
  185. .IP "\fB\-help\fR" 4
  186. .IX Item "-help"
  187. Display a usage message.
  188. .IP "\fB\-verbose\fR" 4
  189. .IX Item "-verbose"
  190. Displays extra information.
  191. The options below where verbosity applies say a bit more about what that means.
  192. .IP "\fB\-select\fR \fIname\fR" 4
  193. .IX Item "-select name"
  194. Only list algorithms that match this name.
  195. .IP "\fB\-1\fR" 4
  196. .IX Item "-1"
  197. List the commands, digest-commands, or cipher-commands in a single column.
  198. If used, this option must be given first.
  199. .IP "\fB\-all\-algorithms\fR" 4
  200. .IX Item "-all-algorithms"
  201. Display lists of all algorithms. These include:
  202. .RS 4
  203. .IP "Asymmetric ciphers" 4
  204. .IX Item "Asymmetric ciphers"
  205. .PD 0
  206. .IP "Decoders" 4
  207. .IX Item "Decoders"
  208. .IP "Digests" 4
  209. .IX Item "Digests"
  210. .IP "Encoders" 4
  211. .IX Item "Encoders"
  212. .IP "Key derivation algorithms (\s-1KDF\s0)" 4
  213. .IX Item "Key derivation algorithms (KDF)"
  214. .IP "Key encapsulation methods (\s-1KEM\s0)" 4
  215. .IX Item "Key encapsulation methods (KEM)"
  216. .IP "Key exchange algorithms (\s-1KEX\s0)" 4
  217. .IX Item "Key exchange algorithms (KEX)"
  218. .IP "Key managers" 4
  219. .IX Item "Key managers"
  220. .IP "Message authentication code algorithms (\s-1MAC\s0)" 4
  221. .IX Item "Message authentication code algorithms (MAC)"
  222. .IP "Random number generators (\s-1RNG, DRBG\s0)" 4
  223. .IX Item "Random number generators (RNG, DRBG)"
  224. .IP "Signature algorithms" 4
  225. .IX Item "Signature algorithms"
  226. .IP "Store loaders" 4
  227. .IX Item "Store loaders"
  228. .IP "Symmetric ciphers" 4
  229. .IX Item "Symmetric ciphers"
  230. .RE
  231. .RS 4
  232. .RE
  233. .IP "\fB\-commands\fR" 4
  234. .IX Item "-commands"
  235. .PD
  236. Display a list of standard commands.
  237. .IP "\fB\-standard\-commands\fR" 4
  238. .IX Item "-standard-commands"
  239. List of standard commands.
  240. .IP "\fB\-digest\-commands\fR" 4
  241. .IX Item "-digest-commands"
  242. This option is deprecated. Use \fBdigest-algorithms\fR instead.
  243. .Sp
  244. Display a list of message digest commands, which are typically used
  245. as input to the \fBopenssl\-dgst\fR\|(1) or \fBopenssl\-speed\fR\|(1) commands.
  246. .IP "\fB\-cipher\-commands\fR" 4
  247. .IX Item "-cipher-commands"
  248. This option is deprecated. Use \fBcipher-algorithms\fR instead.
  249. .Sp
  250. Display a list of cipher commands, which are typically used as input
  251. to the \fBopenssl\-enc\fR\|(1) or \fBopenssl\-speed\fR\|(1) commands.
  252. .IP "\fB\-cipher\-algorithms\fR, \fB\-digest\-algorithms\fR, \fB\-kdf\-algorithms\fR, \fB\-mac\-algorithms\fR," 4
  253. .IX Item "-cipher-algorithms, -digest-algorithms, -kdf-algorithms, -mac-algorithms,"
  254. Display a list of symmetric cipher, digest, kdf and mac algorithms.
  255. See \*(L"Display of algorithm names\*(R" for a description of how names are
  256. displayed.
  257. .Sp
  258. In verbose mode, the algorithms provided by a provider will get additional
  259. information on what parameters each implementation supports.
  260. .IP "\fB\-random\-instances\fR" 4
  261. .IX Item "-random-instances"
  262. List the primary, public and private random number generator details.
  263. .IP "\fB\-random\-generators\fR" 4
  264. .IX Item "-random-generators"
  265. Display a list of random number generators.
  266. See \*(L"Display of algorithm names\*(R" for a description of how names are
  267. displayed.
  268. .IP "\fB\-encoders\fR" 4
  269. .IX Item "-encoders"
  270. Display a list of encoders.
  271. See \*(L"Display of algorithm names\*(R" for a description of how names are
  272. displayed.
  273. .Sp
  274. In verbose mode, the algorithms provided by a provider will get additional
  275. information on what parameters each implementation supports.
  276. .IP "\fB\-decoders\fR" 4
  277. .IX Item "-decoders"
  278. Display a list of decoders.
  279. See \*(L"Display of algorithm names\*(R" for a description of how names are
  280. displayed.
  281. .Sp
  282. In verbose mode, the algorithms provided by a provider will get additional
  283. information on what parameters each implementation supports.
  284. .IP "\fB\-public\-key\-algorithms\fR" 4
  285. .IX Item "-public-key-algorithms"
  286. Display a list of public key algorithms, with each algorithm as
  287. a block of multiple lines, all but the first are indented.
  288. The options \fBkey-exchange-algorithms\fR, \fBkem-algorithms\fR,
  289. \&\fBsignature-algorithms\fR, and \fBasymcipher-algorithms\fR will display similar info.
  290. .IP "\fB\-public\-key\-methods\fR" 4
  291. .IX Item "-public-key-methods"
  292. Display a list of public key methods.
  293. .IP "\fB\-key\-managers\fR" 4
  294. .IX Item "-key-managers"
  295. Display a list of key managers.
  296. .IP "\fB\-key\-exchange\-algorithms\fR" 4
  297. .IX Item "-key-exchange-algorithms"
  298. Display a list of key exchange algorithms.
  299. .IP "\fB\-kem\-algorithms\fR" 4
  300. .IX Item "-kem-algorithms"
  301. Display a list of key encapsulation algorithms.
  302. .IP "\fB\-signature\-algorithms\fR" 4
  303. .IX Item "-signature-algorithms"
  304. Display a list of signature algorithms.
  305. .IP "\fB\-asymcipher\-algorithms\fR" 4
  306. .IX Item "-asymcipher-algorithms"
  307. Display a list of asymmetric cipher algorithms.
  308. .IP "\fB\-store\-loaders\fR" 4
  309. .IX Item "-store-loaders"
  310. Display a list of store loaders.
  311. .IP "\fB\-providers\fR" 4
  312. .IX Item "-providers"
  313. Display a list of all loaded providers with their names, version and status.
  314. .Sp
  315. In verbose mode, the full version and all provider parameters will additionally
  316. be displayed.
  317. .IP "\fB\-engines\fR" 4
  318. .IX Item "-engines"
  319. This option is deprecated.
  320. .Sp
  321. Display a list of loaded engines.
  322. .IP "\fB\-disabled\fR" 4
  323. .IX Item "-disabled"
  324. Display a list of disabled features, those that were compiled out
  325. of the installation.
  326. .IP "\fB\-objects\fR" 4
  327. .IX Item "-objects"
  328. Display a list of built in objects, i.e. OIDs with names. They're listed in the
  329. format described in \*(L"\s-1ASN1\s0 Object Configuration Module\*(R" in \fBconfig\fR\|(5).
  330. .IP "\fB\-options\fR \fIcommand\fR" 4
  331. .IX Item "-options command"
  332. Output a two-column list of the options accepted by the specified \fIcommand\fR.
  333. The first is the option name, and the second is a one-character indication
  334. of what type of parameter it takes, if any.
  335. This is an internal option, used for checking that the documentation
  336. is complete.
  337. .IP "\fB\-provider\fR \fIname\fR" 4
  338. .IX Item "-provider name"
  339. .PD 0
  340. .IP "\fB\-provider\-path\fR \fIpath\fR" 4
  341. .IX Item "-provider-path path"
  342. .IP "\fB\-propquery\fR \fIpropq\fR" 4
  343. .IX Item "-propquery propq"
  344. .PD
  345. See \*(L"Provider Options\*(R" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7).
  346. .SS "Display of algorithm names"
  347. .IX Subsection "Display of algorithm names"
  348. Algorithm names may be displayed in one of two manners:
  349. .IP "Legacy implementations" 4
  350. .IX Item "Legacy implementations"
  351. Legacy implementations will simply display the main name of the
  352. algorithm on a line of its own, or in the form \f(CW\*(C`<foo \*(C'\fR bar>> to show
  353. that \f(CW\*(C`foo\*(C'\fR is an alias for the main name, \f(CW\*(C`bar\*(C'\fR
  354. .IP "Provided implementations" 4
  355. .IX Item "Provided implementations"
  356. Implementations from a provider are displayed like this if the
  357. implementation is labeled with a single name:
  358. .Sp
  359. .Vb 1
  360. \& foo @ bar
  361. .Ve
  362. .Sp
  363. or like this if it's labeled with multiple names:
  364. .Sp
  365. .Vb 1
  366. \& { foo1, foo2 } @bar
  367. .Ve
  368. .Sp
  369. In both cases, \f(CW\*(C`bar\*(C'\fR is the name of the provider.
  370. .SH "HISTORY"
  371. .IX Header "HISTORY"
  372. The \fB\-engines\fR, \fB\-digest\-commands\fR, and \fB\-cipher\-commands\fR options
  373. were deprecated in OpenSSL 3.0.
  374. .SH "COPYRIGHT"
  375. .IX Header "COPYRIGHT"
  376. Copyright 2016\-2021 The OpenSSL Project Authors. All Rights Reserved.
  377. .PP
  378. Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
  379. this file except in compliance with the License. You can obtain a copy
  380. in the file \s-1LICENSE\s0 in the source distribution or at
  381. <https://www.openssl.org/source/license.html>.