Add an Apple privacy info file for OpenSSL
[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 This option is implicitly enabled if any of B<-CApath>, B<-CAfile>
101 or B<-CAstore> is specified.
102
103 =item B<-noout>
104
105 Don't output the encoded version of the CRL.
106
107 =item B<-fingerprint>
108
109 Output the fingerprint of the CRL.
110
111 =item B<-crlnumber>
112
113 Output the number of the CRL.
114
115 =item B<-hash>
116
117 Output a hash of the issuer name. This can be use to lookup CRLs in
118 a directory by issuer name.
119
120 =item B<-hash_old>
121
122 Outputs the "hash" of the CRL issuer name using the older algorithm
123 as used by OpenSSL before version 1.0.0.
124
125 =item B<-issuer>
126
127 Output the issuer name.
128
129 =item B<-lastupdate>
130
131 Output the lastUpdate field.
132
133 =item B<-nextupdate>
134
135 Output the nextUpdate field.
136
137 {- $OpenSSL::safe::opt_name_item -}
138
139 {- $OpenSSL::safe::opt_trust_item -}
140
141 {- $OpenSSL::safe::opt_provider_item -}
142
143 =back
144
145 =head1 EXAMPLES
146
147 Convert a CRL file from PEM to DER:
148
149  openssl crl -in crl.pem -outform DER -out crl.der
150
151 Output the text form of a DER encoded certificate:
152
153  openssl crl -in crl.der -text -noout
154
155 =head1 BUGS
156
157 Ideally it should be possible to create a CRL using appropriate options
158 and files too.
159
160 =head1 SEE ALSO
161
162 L<openssl(1)>,
163 L<openssl-crl2pkcs7(1)>,
164 L<openssl-ca(1)>,
165 L<openssl-x509(1)>,
166 L<ossl_store-file(7)>
167
168 =head1 HISTORY
169
170 Since OpenSSL 3.3, the B<-verify> option will exit with 1 on failure.
171
172 =head1 COPYRIGHT
173
174 Copyright 2000-2024 The OpenSSL Project Authors. All Rights Reserved.
175
176 Licensed under the Apache License 2.0 (the "License").  You may not use
177 this file except in compliance with the License.  You can obtain a copy
178 in the file LICENSE in the source distribution or at
179 L<https://www.openssl.org/source/license.html>.
180
181 =cut