Update DTLSv1_listen documentation
[openssl.git] / doc / apps / crl.pod
1 =pod
2
3 =head1 NAME
4
5 crl - CRL utility
6
7 =head1 SYNOPSIS
8
9 B<openssl> B<crl>
10 [B<-help>]
11 [B<-inform PEM|DER>]
12 [B<-outform PEM|DER>]
13 [B<-text>]
14 [B<-in filename>]
15 [B<-out filename>]
16 [B<-nameopt option>]
17 [B<-noout>]
18 [B<-hash>]
19 [B<-issuer>]
20 [B<-lastupdate>]
21 [B<-nextupdate>]
22 [B<-CAfile file>]
23 [B<-CApath dir>]
24
25 =head1 DESCRIPTION
26
27 The B<crl> command processes CRL files in DER or PEM format.
28
29 =head1 COMMAND OPTIONS
30
31 =over 4
32
33 =item B<-help>
34
35 Print out a usage message.
36
37 =item B<-inform DER|PEM>
38
39 This specifies the input format. B<DER> format is DER encoded CRL
40 structure. B<PEM> (the default) is a base64 encoded version of
41 the DER form with header and footer lines.
42
43 =item B<-outform DER|PEM>
44
45 This specifies the output format, the options have the same meaning as the 
46 B<-inform> option.
47
48 =item B<-in filename>
49
50 This specifies the input filename to read from or standard input if this
51 option is not specified.
52
53 =item B<-out filename>
54
55 specifies the output filename to write to or standard output by
56 default.
57
58 =item B<-text>
59
60 print out the CRL in text form.
61
62 =item B<-nameopt option>
63
64 option which determines how the subject or issuer names are displayed. See
65 the description of B<-nameopt> in L<x509(1)>.
66
67 =item B<-noout>
68
69 don't output the encoded version of the CRL.
70
71 =item B<-hash>
72
73 output a hash of the issuer name. This can be use to lookup CRLs in
74 a directory by issuer name.
75
76 =item B<-hash_old>
77
78 outputs the "hash" of the CRL issuer name using the older algorithm
79 as used by OpenSSL versions before 1.0.0.
80
81 =item B<-issuer>
82
83 output the issuer name.
84
85 =item B<-lastupdate>
86
87 output the lastUpdate field.
88
89 =item B<-nextupdate>
90
91 output the nextUpdate field.
92
93 =item B<-CAfile file>
94
95 verify the signature on a CRL by looking up the issuing certificate in
96 B<file>
97
98 =item B<-CApath dir>
99
100 verify the signature on a CRL by looking up the issuing certificate in
101 B<dir>. This directory must be a standard certificate directory: that
102 is a hash of each subject name (using B<x509 -hash>) should be linked
103 to each certificate.
104
105 =back
106
107 =head1 NOTES
108
109 The PEM CRL format uses the header and footer lines:
110
111  -----BEGIN X509 CRL-----
112  -----END X509 CRL-----
113
114 =head1 EXAMPLES
115
116 Convert a CRL file from PEM to DER:
117
118  openssl crl -in crl.pem -outform DER -out crl.der
119
120 Output the text form of a DER encoded certificate:
121
122  openssl crl -in crl.der -text -noout
123
124 =head1 BUGS
125
126 Ideally it should be possible to create a CRL using appropriate options
127 and files too.
128
129 =head1 SEE ALSO
130
131 L<crl2pkcs7(1)>, L<ca(1)>, L<x509(1)>
132
133 =cut