pkey: update command line tool examples in light of deprecations.
[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 utility
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<ENGINE>]
16 [B<-text>]
17 [B<-in> I<filename>]
18 [B<-out> I<filename>]
19 [B<-gendelta> I<filename>]
20 [B<-badsig>]
21 [B<-verify>]
22 [B<-noout>]
23 [B<-hash>]
24 [B<-hash_old>]
25 [B<-fingerprint>]
26 [B<-crlnumber>]
27 [B<-issuer>]
28 [B<-lastupdate>]
29 [B<-nextupdate>]
30 {- $OpenSSL::safe::opt_name_synopsis -}
31 {- $OpenSSL::safe::opt_trust_synopsis -}
32
33 =for openssl ifdef hash_old
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>, B<-outform> B<DER>|B<PEM>
48
49 The input and output formats of the CRL; the default is B<PEM>.
50 See L<openssl(1)/Format Options> for details.
51
52 =item B<-key> I<filename>
53
54 The private key to be used to sign the CRL.
55
56 =item B<-keyform> B<DER>|B<PEM>|B<ENGINE>
57
58 The format of the private key file; the default is B<PEM>.
59 See L<openssl(1)/Format Options> for details.
60
61 =item B<-in> I<filename>
62
63 This specifies the input filename to read from or standard input if this
64 option is not specified.
65
66 =item B<-out> I<filename>
67
68 Specifies the output filename to write to or standard output by
69 default.
70
71 =item B<-gendelta> I<filename>
72
73 Output a comparison of the main CRL and the one specified here.
74
75 =item B<-badsig>
76
77 Corrupt the signature before writing it; this can be useful
78 for testing.
79
80 =item B<-text>
81
82 Print out the CRL in text form.
83
84 =item B<-verify>
85
86 Verify the signature in the CRL.
87
88 =item B<-noout>
89
90 Don't output the encoded version of the CRL.
91
92 =item B<-fingerprint>
93
94 Output the fingerprint of the CRL.
95
96 =item B<-crlnumber>
97
98 Output the number of the CRL.
99
100 =item B<-hash>
101
102 Output a hash of the issuer name. This can be use to lookup CRLs in
103 a directory by issuer name.
104
105 =item B<-hash_old>
106
107 Outputs the "hash" of the CRL issuer name using the older algorithm
108 as used by OpenSSL before version 1.0.0.
109
110 =item B<-issuer>
111
112 Output the issuer name.
113
114 =item B<-lastupdate>
115
116 Output the lastUpdate field.
117
118 =item B<-nextupdate>
119
120 Output the nextUpdate field.
121
122 {- $OpenSSL::safe::opt_name_item -}
123
124 {- $OpenSSL::safe::opt_trust_item -}
125
126 =back
127
128 =head1 EXAMPLES
129
130 Convert a CRL file from PEM to DER:
131
132  openssl crl -in crl.pem -outform DER -out crl.der
133
134 Output the text form of a DER encoded certificate:
135
136  openssl crl -in crl.der -inform DER -text -noout
137
138 =head1 BUGS
139
140 Ideally it should be possible to create a CRL using appropriate options
141 and files too.
142
143 =head1 SEE ALSO
144
145 L<openssl(1)>,
146 L<openssl-crl2pkcs7(1)>,
147 L<openssl-ca(1)>,
148 L<openssl-x509(1)>,
149 L<ossl_store-file(7)>
150
151 =head1 COPYRIGHT
152
153 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
154
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
160 =cut