openssl-crl.1ossl 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227
  1. .\" -*- mode: troff; coding: utf-8 -*-
  2. .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
  3. .\"
  4. .\" Standard preamble:
  5. .\" ========================================================================
  6. .de Sp \" Vertical space (when we can't use .PP)
  7. .if t .sp .5v
  8. .if n .sp
  9. ..
  10. .de Vb \" Begin verbatim text
  11. .ft CW
  12. .nf
  13. .ne \\$1
  14. ..
  15. .de Ve \" End verbatim text
  16. .ft R
  17. .fi
  18. ..
  19. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
  20. .ie n \{\
  21. . ds C` ""
  22. . ds C' ""
  23. 'br\}
  24. .el\{\
  25. . ds C`
  26. . ds C'
  27. 'br\}
  28. .\"
  29. .\" Escape single quotes in literal strings from groff's Unicode transform.
  30. .ie \n(.g .ds Aq \(aq
  31. .el .ds Aq '
  32. .\"
  33. .\" If the F register is >0, we'll generate index entries on stderr for
  34. .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  35. .\" entries marked with X<> in POD. Of course, you'll have to process the
  36. .\" output yourself in some meaningful fashion.
  37. .\"
  38. .\" Avoid warning from groff about undefined register 'F'.
  39. .de IX
  40. ..
  41. .nr rF 0
  42. .if \n(.g .if rF .nr rF 1
  43. .if (\n(rF:(\n(.g==0)) \{\
  44. . if \nF \{\
  45. . de IX
  46. . tm Index:\\$1\t\\n%\t"\\$2"
  47. ..
  48. . if !\nF==2 \{\
  49. . nr % 0
  50. . nr F 2
  51. . \}
  52. . \}
  53. .\}
  54. .rr rF
  55. .\" ========================================================================
  56. .\"
  57. .IX Title "OPENSSL-CRL 1ossl"
  58. .TH OPENSSL-CRL 1ossl 2025-01-17 3.4.0 OpenSSL
  59. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  60. .\" way too many mistakes in technical documents.
  61. .if n .ad l
  62. .nh
  63. .SH NAME
  64. openssl\-crl \- CRL command
  65. .SH SYNOPSIS
  66. .IX Header "SYNOPSIS"
  67. \&\fBopenssl\fR \fBcrl\fR
  68. [\fB\-help\fR]
  69. [\fB\-inform\fR \fBDER\fR|\fBPEM\fR]
  70. [\fB\-outform\fR \fBDER\fR|\fBPEM\fR]
  71. [\fB\-key\fR \fIfilename\fR]
  72. [\fB\-keyform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR]
  73. [\fB\-dateopt\fR]
  74. [\fB\-text\fR]
  75. [\fB\-in\fR \fIfilename\fR]
  76. [\fB\-out\fR \fIfilename\fR]
  77. [\fB\-gendelta\fR \fIfilename\fR]
  78. [\fB\-badsig\fR]
  79. [\fB\-verify\fR]
  80. [\fB\-noout\fR]
  81. [\fB\-hash\fR]
  82. [\fB\-hash_old\fR]
  83. [\fB\-fingerprint\fR]
  84. [\fB\-crlnumber\fR]
  85. [\fB\-issuer\fR]
  86. [\fB\-lastupdate\fR]
  87. [\fB\-nextupdate\fR]
  88. [\fB\-nameopt\fR \fIoption\fR]
  89. [\fB\-CAfile\fR \fIfile\fR]
  90. [\fB\-no\-CAfile\fR]
  91. [\fB\-CApath\fR \fIdir\fR]
  92. [\fB\-no\-CApath\fR]
  93. [\fB\-CAstore\fR \fIuri\fR]
  94. [\fB\-no\-CAstore\fR]
  95. [\fB\-provider\fR \fIname\fR]
  96. [\fB\-provider\-path\fR \fIpath\fR]
  97. [\fB\-propquery\fR \fIpropq\fR]
  98. .SH DESCRIPTION
  99. .IX Header "DESCRIPTION"
  100. This command processes CRL files in DER or PEM format.
  101. .SH OPTIONS
  102. .IX Header "OPTIONS"
  103. .IP \fB\-help\fR 4
  104. .IX Item "-help"
  105. Print out a usage message.
  106. .IP "\fB\-inform\fR \fBDER\fR|\fBPEM\fR" 4
  107. .IX Item "-inform DER|PEM"
  108. The CRL input format; unspecified by default.
  109. See \fBopenssl\-format\-options\fR\|(1) for details.
  110. .IP "\fB\-outform\fR \fBDER\fR|\fBPEM\fR" 4
  111. .IX Item "-outform DER|PEM"
  112. The CRL output format; the default is \fBPEM\fR.
  113. See \fBopenssl\-format\-options\fR\|(1) for details.
  114. .IP "\fB\-key\fR \fIfilename\fR" 4
  115. .IX Item "-key filename"
  116. The private key to be used to sign the CRL.
  117. .IP "\fB\-keyform\fR \fBDER\fR|\fBPEM\fR|\fBP12\fR" 4
  118. .IX Item "-keyform DER|PEM|P12"
  119. The format of the private key file; unspecified by default.
  120. See \fBopenssl\-format\-options\fR\|(1) for details.
  121. .IP "\fB\-in\fR \fIfilename\fR" 4
  122. .IX Item "-in filename"
  123. This specifies the input filename to read from or standard input if this
  124. option is not specified.
  125. .IP "\fB\-out\fR \fIfilename\fR" 4
  126. .IX Item "-out filename"
  127. Specifies the output filename to write to or standard output by
  128. default.
  129. .IP "\fB\-gendelta\fR \fIfilename\fR" 4
  130. .IX Item "-gendelta filename"
  131. Output a comparison of the main CRL and the one specified here.
  132. .IP \fB\-badsig\fR 4
  133. .IX Item "-badsig"
  134. Corrupt the signature before writing it; this can be useful
  135. for testing.
  136. .IP \fB\-dateopt\fR 4
  137. .IX Item "-dateopt"
  138. Specify the date output format. Values are: rfc_822 and iso_8601.
  139. Defaults to rfc_822.
  140. .IP \fB\-text\fR 4
  141. .IX Item "-text"
  142. Print out the CRL in text form.
  143. .IP \fB\-verify\fR 4
  144. .IX Item "-verify"
  145. Verify the signature in the CRL. If the verification fails,
  146. the program will immediately exit, i.e. further option processing
  147. (e.g. \fB\-gendelta\fR) is skipped.
  148. .Sp
  149. This option is implicitly enabled if any of \fB\-CApath\fR, \fB\-CAfile\fR
  150. or \fB\-CAstore\fR is specified.
  151. .IP \fB\-noout\fR 4
  152. .IX Item "-noout"
  153. Don't output the encoded version of the CRL.
  154. .IP \fB\-fingerprint\fR 4
  155. .IX Item "-fingerprint"
  156. Output the fingerprint of the CRL.
  157. .IP \fB\-crlnumber\fR 4
  158. .IX Item "-crlnumber"
  159. Output the number of the CRL.
  160. .IP \fB\-hash\fR 4
  161. .IX Item "-hash"
  162. Output a hash of the issuer name. This can be use to lookup CRLs in
  163. a directory by issuer name.
  164. .IP \fB\-hash_old\fR 4
  165. .IX Item "-hash_old"
  166. Outputs the "hash" of the CRL issuer name using the older algorithm
  167. as used by OpenSSL before version 1.0.0.
  168. .IP \fB\-issuer\fR 4
  169. .IX Item "-issuer"
  170. Output the issuer name.
  171. .IP \fB\-lastupdate\fR 4
  172. .IX Item "-lastupdate"
  173. Output the lastUpdate field.
  174. .IP \fB\-nextupdate\fR 4
  175. .IX Item "-nextupdate"
  176. Output the nextUpdate field.
  177. .IP "\fB\-nameopt\fR \fIoption\fR" 4
  178. .IX Item "-nameopt option"
  179. This specifies how the subject or issuer names are displayed.
  180. See \fBopenssl\-namedisplay\-options\fR\|(1) for details.
  181. .IP "\fB\-CAfile\fR \fIfile\fR, \fB\-no\-CAfile\fR, \fB\-CApath\fR \fIdir\fR, \fB\-no\-CApath\fR, \fB\-CAstore\fR \fIuri\fR, \fB\-no\-CAstore\fR" 4
  182. .IX Item "-CAfile file, -no-CAfile, -CApath dir, -no-CApath, -CAstore uri, -no-CAstore"
  183. See "Trusted Certificate Options" in \fBopenssl\-verification\-options\fR\|(1) for details.
  184. .IP "\fB\-provider\fR \fIname\fR" 4
  185. .IX Item "-provider name"
  186. .PD 0
  187. .IP "\fB\-provider\-path\fR \fIpath\fR" 4
  188. .IX Item "-provider-path path"
  189. .IP "\fB\-propquery\fR \fIpropq\fR" 4
  190. .IX Item "-propquery propq"
  191. .PD
  192. See "Provider Options" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7).
  193. .SH EXAMPLES
  194. .IX Header "EXAMPLES"
  195. Convert a CRL file from PEM to DER:
  196. .PP
  197. .Vb 1
  198. \& openssl crl \-in crl.pem \-outform DER \-out crl.der
  199. .Ve
  200. .PP
  201. Output the text form of a DER encoded certificate:
  202. .PP
  203. .Vb 1
  204. \& openssl crl \-in crl.der \-text \-noout
  205. .Ve
  206. .SH BUGS
  207. .IX Header "BUGS"
  208. Ideally it should be possible to create a CRL using appropriate options
  209. and files too.
  210. .SH "SEE ALSO"
  211. .IX Header "SEE ALSO"
  212. \&\fBopenssl\fR\|(1),
  213. \&\fBopenssl\-crl2pkcs7\fR\|(1),
  214. \&\fBopenssl\-ca\fR\|(1),
  215. \&\fBopenssl\-x509\fR\|(1),
  216. \&\fBossl_store\-file\fR\|(7)
  217. .SH HISTORY
  218. .IX Header "HISTORY"
  219. Since OpenSSL 3.3, the \fB\-verify\fR option will exit with 1 on failure.
  220. .SH COPYRIGHT
  221. .IX Header "COPYRIGHT"
  222. Copyright 2000\-2024 The OpenSSL Project Authors. All Rights Reserved.
  223. .PP
  224. Licensed under the Apache License 2.0 (the "License"). You may not use
  225. this file except in compliance with the License. You can obtain a copy
  226. in the file LICENSE in the source distribution or at
  227. <https://www.openssl.org/source/license.html>.