Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)

Standard preamble:
========================================================================
..

..

.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "CA.PL 1" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
CA.pl - friendlier interface for OpenSSL certificate programs Header "SYNOPSIS" \fB\s-1CA\s0.pl \fB-? | \fB-h | \fB-help

\fB\s-1CA\s0.pl \fB-newcert | \fB-newreq | \fB-newreq-nodes | \fB-xsign | \fB-sign | \fB-signCA | \fB-signcert | \fB-crl | \fB-newca [-extra-cmd extra-params]

\fB\s-1CA\s0.pl -pkcs12 [-extra-pkcs12 extra-params] [certname]

\fB\s-1CA\s0.pl -verify [-extra-verify extra-params] certfile...

\fB\s-1CA\s0.pl -revoke [-extra-ca extra-params] certfile [reason]

Header "DESCRIPTION" The \s-1CA\s0.pl script is a perl script that supplies the relevant command line arguments to the openssl command for some common certificate operations. It is intended to simplify the process of certificate creation and management by the use of some simple options. Header "OPTIONS" Item "?, -h, -help" Prints a usage message. Item "-newcert" Creates a new self signed certificate. The private key is written to the file \*(L"newkey.pem\*(R" and the request written to the file \*(L"newreq.pem\*(R". This argument invokes openssl req command. Item "-newreq" Creates a new certificate request. The private key is written to the file \*(L"newkey.pem\*(R" and the request written to the file \*(L"newreq.pem\*(R". Executes openssl req command below the hood. Item "-newreq-nodes" Is like -newreq except that the private key will not be encrypted. Uses openssl req command. Item "-newca" Creates a new \s-1CA\s0 hierarchy for use with the ca program (or the -signcert and -xsign options). The user is prompted to enter the filename of the \s-1CA\s0 certificates (which should also contain the private key) or by hitting \s-1ENTER\s0 details of the \s-1CA\s0 will be prompted for. The relevant files and directories are created in a directory called \*(L"demoCA\*(R" in the current directory. \fBopenssl req and openssl ca commands are get invoked. Item "-pkcs12" Create a PKCS#12 file containing the user certificate, private key and \s-1CA\s0 certificate. It expects the user certificate and private key to be in the file \*(L"newcert.pem\*(R" and the \s-1CA\s0 certificate to be in the file demoCA/cacert.pem, it creates a file \*(L"newcert.p12\*(R". This command can thus be called after the \fB-sign option. The PKCS#12 file can be imported directly into a browser. If there is an additional argument on the command line it will be used as the \*(L"friendly name\*(R" for the certificate (which is typically displayed in the browser list box), otherwise the name \*(L"My Certificate\*(R" is used. Delegates work to openssl pkcs12 command. Item "-sign, -signcert, -xsign" Calls the ca program to sign a certificate request. It expects the request to be in the file \*(L"newreq.pem\*(R". The new certificate is written to the file \*(L"newcert.pem\*(R" except in the case of the -xsign option when it is written to standard output. Leverages openssl ca command. Item "-signCA" This option is the same as the -signreq option except it uses the configuration file section v3_ca and so makes the signed request a valid \s-1CA\s0 certificate. This is useful when creating intermediate \s-1CA\s0 from a root \s-1CA.\s0 Extra params are passed on to openssl ca command. Item "-signcert" This option is the same as -sign except it expects a self signed certificate to be present in the file \*(L"newreq.pem\*(R". Extra params are passed on to openssl x509 and openssl ca commands. Item "-crl" Generate a \s-1CRL.\s0 Executes openssl ca command. Item "-revoke certfile [reason]" Revoke the certificate contained in the specified certfile. An optional reason may be specified, and must be one of: unspecified, \fBkeyCompromise, CACompromise, affiliationChanged, superseded, \fBcessationOfOperation, certificateHold, or removeFromCRL. Leverages openssl ca command. Item "-verify" Verifies certificates against the \s-1CA\s0 certificate for \*(L"demoCA\*(R". If no certificates are specified on the command line it tries to verify the file \*(L"newcert.pem\*(R". Invokes openssl verify command. Item "-extra-req | -extra-ca | -extra-pkcs12 | -extra-x509 | -extra-verify <extra-params>" The purpose of these parameters is to allow optional parameters to be supplied to openssl that this command executes. The -extra-cmd are specific to the option being used and the openssl command getting invoked. For example when this command invokes openssl req extra parameters can be passed on with the -extra-req parameter. The \fBopenssl commands being invoked per option are documented below. Users should consult openssl command documentation for more information. Header "EXAMPLES" Create a \s-1CA\s0 hierarchy:

.Vb 1 CA.pl -newca .Ve

Complete certificate creation example: create a \s-1CA,\s0 create a request, sign the request and finally create a PKCS#12 file containing it.

.Vb 4 CA.pl -newca CA.pl -newreq CA.pl -signreq CA.pl -pkcs12 "My Test Certificate" .Ve

Header "DSA CERTIFICATES" Although the \s-1CA\s0.pl creates \s-1RSA\s0 CAs and requests it is still possible to use it with \s-1DSA\s0 certificates and requests using the req\|(1) command directly. The following example shows the steps that would typically be taken.

Create some \s-1DSA\s0 parameters:

.Vb 1 openssl dsaparam -out dsap.pem 1024 .Ve

Create a \s-1DSA CA\s0 certificate and private key:

.Vb 1 openssl req -x509 -newkey dsa:dsap.pem -keyout cacert.pem -out cacert.pem .Ve

Create the \s-1CA\s0 directories and files:

.Vb 1 CA.pl -newca .Ve

enter cacert.pem when prompted for the \s-1CA\s0 file name.

Create a \s-1DSA\s0 certificate request and private key (a different set of parameters can optionally be created first):

.Vb 1 openssl req -out newreq.pem -newkey dsa:dsap.pem .Ve

Sign the request:

.Vb 1 CA.pl -signreq .Ve

Header "NOTES" Most of the filenames mentioned can be modified by editing the \s-1CA\s0.pl script.

If the demoCA directory already exists then the -newca command will not overwrite it and will do nothing. This can happen if a previous call using the -newca option terminated abnormally. To get the correct behaviour delete the demoCA directory if it already exists.

Under some environments it may not be possible to run the \s-1CA\s0.pl script directly (for example Win32) and the default configuration file location may be wrong. In this case the command:

.Vb 1 perl -S CA.pl .Ve

can be used and the \s-1OPENSSL_CONF\s0 environment variable changed to point to the correct path of the configuration file.

The script is intended as a simple front end for the openssl program for use by a beginner. Its behaviour isn't always what is wanted. For more control over the behaviour of the certificate commands call the openssl command directly.

Header "SEE ALSO" \fBx509\|(1), ca\|(1), req\|(1), pkcs12\|(1), \fBconfig\|(5) Header "COPYRIGHT" Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.