Command docs: diverse small fixes
[openssl.git] / doc / man1 / CA.pl.pod
1 =pod
2
3 =head1 NAME
4
5 CA.pl - friendlier interface for OpenSSL certificate programs
6
7 =head1 SYNOPSIS
8
9 B<CA.pl>
10 B<-?> |
11 B<-h> |
12 B<-help>
13
14 B<CA.pl>
15 B<-newcert> |
16 B<-newreq> |
17 B<-newreq-nodes> |
18 B<-xsign> |
19 B<-sign> |
20 B<-signCA> |
21 B<-signcert> |
22 B<-crl> |
23 B<-newca>
24 [B<-extra-cmd> I<extra-params>]
25
26 B<CA.pl> B<-pkcs12> [B<-extra-pkcs12> I<extra-params>] [I<certname>]
27
28 B<CA.pl> B<-verify> [B<-extra-verify> I<extra-params>] I<certfile> ...
29
30 B<CA.pl> B<-revoke> [B<-extra-ca> I<extra-params>] I<certfile> [I<reason>]
31
32 =head1 DESCRIPTION
33
34 The B<CA.pl> script is a perl script that supplies the relevant command line
35 arguments to the L<openssl(1)> command for some common certificate operations.
36 It is intended to simplify the process of certificate creation and management
37 by the use of some simple options.
38
39 =head1 OPTIONS
40
41 =over 4
42
43 =item B<?>, B<-h>, B<-help>
44
45 Prints a usage message.
46
47 =item B<-newcert>
48
49 Creates a new self signed certificate. The private key is written to the file
50 F<newkey.pem> and the request written to the file F<newreq.pem>.
51 This argument invokes L<openssl-req(1)> command.
52
53 =item B<-newreq>
54
55 Creates a new certificate request. The private key is written to the file
56 F<newkey.pem> and the request written to the file F<newreq.pem>.
57 Executes L<openssl-req(1)> command below the hood.
58
59 =item B<-newreq-nodes>
60
61 Is like B<-newreq> except that the private key will not be encrypted.
62 Uses L<openssl-req(1)> command.
63
64 =item B<-newca>
65
66 Creates a new CA hierarchy for use with the B<ca> program (or the B<-signcert>
67 and B<-xsign> options). The user is prompted to enter the filename of the CA
68 certificates (which should also contain the private key) or by hitting ENTER
69 details of the CA will be prompted for. The relevant files and directories
70 are created in a directory called F<demoCA> in the current directory.
71 L<openssl-req(1)> and L<openssl-ca(1)> commands are get invoked.
72
73 =item B<-pkcs12>
74
75 Create a PKCS#12 file containing the user certificate, private key and CA
76 certificate. It expects the user certificate and private key to be in the
77 file F<newcert.pem> and the CA certificate to be in the file F<demoCA/cacert.pem>,
78 it creates a file F<newcert.p12>. This command can thus be called after the
79 B<-sign> option. The PKCS#12 file can be imported directly into a browser.
80 If there is an additional argument on the command line it will be used as the
81 "friendly name" for the certificate (which is typically displayed in the browser
82 list box), otherwise the name "My Certificate" is used.
83 Delegates work to L<openssl-pkcs12(1)> command.
84
85 =item B<-sign>, B<-signcert>, B<-xsign>
86
87 Calls the L<openssl-ca(1)> command to sign a certificate request. It expects the
88 request to be in the file F<newreq.pem>. The new certificate is written to the
89 file F<newcert.pem> except in the case of the B<-xsign> option when it is
90 written to standard output. Leverages L<openssl-ca(1)> command.
91
92 =item B<-signCA>
93
94 This option is the same as the B<-signreq> option except it uses the
95 configuration file section B<v3_ca> and so makes the signed request a
96 valid CA certificate. This is useful when creating intermediate CA from
97 a root CA.  Extra params are passed on to L<openssl-ca(1)> command.
98
99 =item B<-signcert>
100
101 This option is the same as B<-sign> except it expects a self signed certificate
102 to be present in the file F<newreq.pem>.
103 Extra params are passed on to L<openssl-x509(1)> and L<openssl-ca(1)> commands.
104
105 =item B<-crl>
106
107 Generate a CRL. Executes L<openssl-ca(1)> command.
108
109 =item B<-revoke> I<certfile> [I<reason>]
110
111 Revoke the certificate contained in the specified B<certfile>. An optional
112 reason may be specified, and must be one of: B<unspecified>,
113 B<keyCompromise>, B<CACompromise>, B<affiliationChanged>, B<superseded>,
114 B<cessationOfOperation>, B<certificateHold>, or B<removeFromCRL>.
115 Leverages L<openssl-ca(1)> command.
116
117 =item B<-verify>
118
119 Verifies certificates against the CA certificate for F<demoCA>. If no
120 certificates are specified on the command line it tries to verify the file
121 F<newcert.pem>.  Invokes L<openssl-verify(1)> command.
122
123 =item B<-extra-req> | B<-extra-ca> | B<-extra-pkcs12> | B<-extra-x509> | B<-extra-verify> I<extra-params>
124
125 For each option B<extra-I<cmd>>, pass I<extra-params> to the L<openssl(1)>
126 sub-command with the same name as I<cmd>, if that sub-command is invoked.
127 For example, if L<openssl-req(1)> is invoked, the I<extra-params> given with
128 B<-extra-req> will be passed to it.
129 Users should consult L<openssl(1)> command documentation for more information.
130
131 =back
132
133 =head1 EXAMPLES
134
135 Create a CA hierarchy:
136
137  CA.pl -newca
138
139 Complete certificate creation example: create a CA, create a request, sign
140 the request and finally create a PKCS#12 file containing it.
141
142  CA.pl -newca
143  CA.pl -newreq
144  CA.pl -signreq
145  CA.pl -pkcs12 "My Test Certificate"
146
147 =head1 DSA CERTIFICATES
148
149 Although the B<CA.pl> creates RSA CAs and requests it is still possible to
150 use it with DSA certificates and requests using the L<req(1)> command
151 directly. The following example shows the steps that would typically be taken.
152
153 Create some DSA parameters:
154
155  openssl dsaparam -out dsap.pem 1024
156
157 Create a DSA CA certificate and private key:
158
159  openssl req -x509 -newkey dsa:dsap.pem -keyout cacert.pem -out cacert.pem
160
161 Create the CA directories and files:
162
163  CA.pl -newca
164
165 enter a filename (for example, F<cacert.pem>) when prompted for the CA file
166 name.
167
168 Create a DSA certificate request and private key (a different set of parameters
169 can optionally be created first):
170
171  openssl req -out newreq.pem -newkey dsa:dsap.pem
172
173 Sign the request:
174
175  CA.pl -signreq
176
177 =head1 NOTES
178
179 Most of the filenames mentioned can be modified by editing the B<CA.pl> script.
180
181 If the demoCA directory already exists then the B<-newca> command will not
182 overwrite it and will do nothing. This can happen if a previous call using
183 the B<-newca> option terminated abnormally. To get the correct behaviour
184 delete the demoCA directory if it already exists.
185
186 Under some environments it may not be possible to run the B<CA.pl> script
187 directly (for example Win32) and the default configuration file location may
188 be wrong. In this case the command:
189
190  perl -S CA.pl
191
192 can be used and the B<OPENSSL_CONF> environment variable changed to point to
193 the correct path of the configuration file.
194
195 The script is intended as a simple front end for the L<openssl(1)> program for
196 use by a beginner. Its behaviour isn't always what is wanted. For more control
197 over the behaviour of the certificate commands call the L<openssl(1)> command
198 directly.
199
200 =head1 SEE ALSO
201
202 L<openssl(1)>,
203 L<openssl-x509(1)>,
204 L<openssl-ca(1)>,
205 L<openssl-req(1)>,
206 L<openssl-pkcs12(1)>,
207 L<config(5)>
208
209 =head1 COPYRIGHT
210
211 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
212
213 Licensed under the Apache License 2.0 (the "License").  You may not use
214 this file except in compliance with the License.  You can obtain a copy
215 in the file LICENSE in the source distribution or at
216 L<https://www.openssl.org/source/license.html>.
217
218 =cut