Document change of -verify behavior in crl and req apps
[openssl.git] / doc / man1 / openssl-crl.pod.in
1 =pod
2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
3
4 =head1 NAME
5
6 openssl-crl - CRL command
7
8 =head1 SYNOPSIS
9
10 B<openssl> B<crl>
11 [B<-help>]
12 [B<-inform> B<DER>|B<PEM>]
13 [B<-outform> B<DER>|B<PEM>]
14 [B<-key> I<filename>]
15 [B<-keyform> B<DER>|B<PEM>|B<P12>]
16 [B<-dateopt>]
17 [B<-text>]
18 [B<-in> I<filename>]
19 [B<-out> I<filename>]
20 [B<-gendelta> I<filename>]
21 [B<-badsig>]
22 [B<-verify>]
23 [B<-noout>]
24 [B<-hash>]
25 [B<-hash_old>]
26 [B<-fingerprint>]
27 [B<-crlnumber>]
28 [B<-issuer>]
29 [B<-lastupdate>]
30 [B<-nextupdate>]
31 {- $OpenSSL::safe::opt_name_synopsis -}
32 {- $OpenSSL::safe::opt_trust_synopsis -}
33 {- $OpenSSL::safe::opt_provider_synopsis -}
34
35 =head1 DESCRIPTION
36
37 This command processes CRL files in DER or PEM format.
38
39 =head1 OPTIONS
40
41 =over 4
42
43 =item B<-help>
44
45 Print out a usage message.
46
47 =item B<-inform> B<DER>|B<PEM>
48
49 The CRL input format; unspecified by default.
50 See L<openssl-format-options(1)> for details.
51
52 =item B<-outform> B<DER>|B<PEM>
53
54 The CRL output format; the default is B<PEM>.
55 See L<openssl-format-options(1)> for details.
56
57 =item B<-key> I<filename>
58
59 The private key to be used to sign the CRL.
60
61 =item B<-keyform> B<DER>|B<PEM>|B<P12>
62
63 The format of the private key file; unspecified by default.
64 See L<openssl-format-options(1)> for details.
65
66 =item B<-in> I<filename>
67
68 This specifies the input filename to read from or standard input if this
69 option is not specified.
70
71 =item B<-out> I<filename>
72
73 Specifies the output filename to write to or standard output by
74 default.
75
76 =item B<-gendelta> I<filename>
77
78 Output a comparison of the main CRL and the one specified here.
79
80 =item B<-badsig>
81
82 Corrupt the signature before writing it; this can be useful
83 for testing.
84
85 =item B<-dateopt>
86
87 Specify the date output format. Values are: rfc_822 and iso_8601.
88 Defaults to rfc_822.
89
90 =item B<-text>
91
92 Print out the CRL in text form.
93
94 =item B<-verify>
95
96 Verify the signature in the CRL. If the verification fails,
97 the program will immediately exit, i.e. further option processing
98 (e.g. B<-gendelta>) is skipped.
99
100 =item B<-noout>
101
102 Don't output the encoded version of the CRL.
103
104 =item B<-fingerprint>
105
106 Output the fingerprint of the CRL.
107
108 =item B<-crlnumber>
109
110 Output the number of the CRL.
111
112 =item B<-hash>
113
114 Output a hash of the issuer name. This can be use to lookup CRLs in
115 a directory by issuer name.
116
117 =item B<-hash_old>
118
119 Outputs the "hash" of the CRL issuer name using the older algorithm
120 as used by OpenSSL before version 1.0.0.
121
122 =item B<-issuer>
123
124 Output the issuer name.
125
126 =item B<-lastupdate>
127
128 Output the lastUpdate field.
129
130 =item B<-nextupdate>
131
132 Output the nextUpdate field.
133
134 {- $OpenSSL::safe::opt_name_item -}
135
136 {- $OpenSSL::safe::opt_trust_item -}
137
138 {- $OpenSSL::safe::opt_provider_item -}
139
140 =back
141
142 =head1 EXAMPLES
143
144 Convert a CRL file from PEM to DER:
145
146  openssl crl -in crl.pem -outform DER -out crl.der
147
148 Output the text form of a DER encoded certificate:
149
150  openssl crl -in crl.der -text -noout
151
152 =head1 BUGS
153
154 Ideally it should be possible to create a CRL using appropriate options
155 and files too.
156
157 =head1 SEE ALSO
158
159 L<openssl(1)>,
160 L<openssl-crl2pkcs7(1)>,
161 L<openssl-ca(1)>,
162 L<openssl-x509(1)>,
163 L<ossl_store-file(7)>
164
165 =head1 HISTORY
166
167 Since OpenSSL 3.3, the B<-verify> option will exit with 1 on failure.
168
169 =head1 COPYRIGHT
170
171 Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
172
173 Licensed under the Apache License 2.0 (the "License").  You may not use
174 this file except in compliance with the License.  You can obtain a copy
175 in the file LICENSE in the source distribution or at
176 L<https://www.openssl.org/source/license.html>.
177
178 =cut