Automatically generated by Pod::Man 4.14 (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" CA.PL 1 "2023-08-01" "3.0.10" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes way too many mistakes in technical documents. "NAME"
CA.pl - friendlier interface for OpenSSL certificate programs
"SYNOPSIS"
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-\f(BIcmd parameter]
\fB\s-1CA\s0.pl -pkcs12 [certname]
\fB\s-1CA\s0.pl -verify certfile ...
\fB\s-1CA\s0.pl -revoke certfile [reason]
"DESCRIPTION"
Header "DESCRIPTION" The
\s-1CA\s0.pl script is a perl script that supplies the relevant command line
arguments to the
openssl\|(1) 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.
The script is intended as a simple front end for the openssl\|(1) 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\|(1) command
directly.
Most of the filenames mentioned below can be modified by editing the
\fB\s-1CA\s0.pl script.
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 can be set to point to
the correct path of the configuration file.
"OPTIONS"
Header "OPTIONS" "-?, -h, -help" 4
Item "-?, -h, -help" Prints a usage message.
"-newcert" 4
Item "-newcert" Creates a new self signed certificate. The private key is written to the file
\fInewkey.pem and the request written to the file
newreq.pem.
Invokes
openssl-req\|(1).
"-newreq" 4
Item "-newreq" Creates a new certificate request. The private key is written to the file
\fInewkey.pem and the request written to the file
newreq.pem.
Executes
openssl-req\|(1) under the hood.
"-newreq-nodes" 4
Item "-newreq-nodes" Is like
-newreq except that the private key will not be encrypted.
Uses
openssl-req\|(1).
"-newca" 4
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
demoCA in the current directory.
Uses
openssl-req\|(1) and
openssl-ca\|(1).
.Sp
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 directory if it already exists.
"-pkcs12" 4
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
newcert.pem and the \s-1CA\s0 certificate to be in the file
demoCA/cacert.pem,
it creates a file
newcert.p12. 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\|(1).
"-sign, -signcert, -xsign" 4
Item "-sign, -signcert, -xsign" Calls the
openssl-ca\|(1) command to sign a certificate request. It expects the
request to be in the file
newreq.pem. The new certificate is written to the
file
newcert.pem except in the case of the
-xsign option when it is
written to standard output.
"-signCA" 4
Item "-signCA" This option is the same as the
-sign 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 to
openssl-ca\|(1).
"-signcert" 4
Item "-signcert" This option is the same as
-sign except it expects a self signed certificate
to be present in the file
newreq.pem.
Extra params are passed to
openssl-x509\|(1) and
openssl-ca\|(1).
"-crl" 4
Item "-crl" Generate a \s-1CRL.\s0 Executes
openssl-ca\|(1).
"-revoke certfile [reason]" 4
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\|(1).
"-verify" 4
Item "-verify" Verifies certificates against the \s-1CA\s0 certificate for
demoCA. If no
certificates are specified on the command line it tries to verify the file
\fInewcert.pem. Invokes
openssl-verify\|(1).
"-extra-\f(BIcmd parameter" 4
Item "-extra-cmd parameter" For each option
extra-\f(BIcmd, pass parameter to the openssl\|(1)
sub-command with the same name as cmd, if that sub-command is invoked.
For example, if openssl-req\|(1) is invoked, the parameter given with
\fB-extra-req will be passed to it.
For multi-word parameters, either repeat the option or quote the
parameters
so it looks like one word to your shell.
See the individual command documentation for more information.
"EXAMPLES"
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 -sign
CA.pl -pkcs12 "My Test Certificate"
.Ve
"ENVIRONMENT"
Header "ENVIRONMENT" The environment variable
\s-1OPENSSL\s0 may be used to specify the name of
the OpenSSL program. It can be a full pathname, or a relative one.
The environment variable \s-1OPENSSL_CONFIG\s0 may be used to specify a
configuration option and value to the req and ca commands invoked by
this script. It's value should be the option and pathname, as in
\f(CW\*(C`-config /path/to/conf-file\*(C'.
"SEE ALSO"
Header "SEE ALSO" \fBopenssl\|(1),
\fBopenssl-x509\|(1),
\fBopenssl-ca\|(1),
\fBopenssl-req\|(1),
\fBopenssl-pkcs12\|(1),
\fBconfig\|(5)
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (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>.