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