318 lines
11 KiB
Plaintext
318 lines
11 KiB
Plaintext
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" 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 C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. 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\}
|
|
.el\{\
|
|
. 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.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, 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'.
|
|
.de IX
|
|
..
|
|
.nr rF 0
|
|
.if \n(.g .if rF .nr rF 1
|
|
.if (\n(rF:(\n(.g==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
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. 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
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. 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
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "CA.PL 1ossl"
|
|
.TH CA.PL 1ossl "2024-01-30" "3.2.1" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
CA.pl \- friendlier interface for OpenSSL certificate programs
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
\&\fB\s-1CA\s0.pl\fR
|
|
\&\fB\-?\fR |
|
|
\&\fB\-h\fR |
|
|
\&\fB\-help\fR
|
|
.PP
|
|
\&\fB\s-1CA\s0.pl\fR
|
|
\&\fB\-newcert\fR |
|
|
\&\fB\-newreq\fR |
|
|
\&\fB\-newreq\-nodes\fR |
|
|
\&\fB\-xsign\fR |
|
|
\&\fB\-sign\fR |
|
|
\&\fB\-signCA\fR |
|
|
\&\fB\-signcert\fR |
|
|
\&\fB\-crl\fR |
|
|
\&\fB\-newca\fR
|
|
[\fB\-extra\-\f(BIcmd\fB\fR \fIparameter\fR]
|
|
.PP
|
|
\&\fB\s-1CA\s0.pl\fR \fB\-pkcs12\fR [\fIcertname\fR]
|
|
.PP
|
|
\&\fB\s-1CA\s0.pl\fR \fB\-verify\fR \fIcertfile\fR ...
|
|
.PP
|
|
\&\fB\s-1CA\s0.pl\fR \fB\-revoke\fR \fIcertfile\fR [\fIreason\fR]
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
The \fB\s-1CA\s0.pl\fR script is a perl script that supplies the relevant command line
|
|
arguments to the \fIopenssl\fR\|(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.
|
|
.PP
|
|
The script is intended as a simple front end for the \fIopenssl\fR\|(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 \fIopenssl\fR\|(1) command
|
|
directly.
|
|
.PP
|
|
Most of the filenames mentioned below can be modified by editing the
|
|
\&\fB\s-1CA\s0.pl\fR script.
|
|
.PP
|
|
Under some environments it may not be possible to run the \fB\s-1CA\s0.pl\fR script
|
|
directly (for example Win32) and the default configuration file location may
|
|
be wrong. In this case the command:
|
|
.PP
|
|
.Vb 1
|
|
\& perl \-S CA.pl
|
|
.Ve
|
|
.PP
|
|
can be used and the \fB\s-1OPENSSL_CONF\s0\fR environment variable can be set to point to
|
|
the correct path of the configuration file.
|
|
.SH "OPTIONS"
|
|
.IX Header "OPTIONS"
|
|
.IP "\fB\-?\fR, \fB\-h\fR, \fB\-help\fR" 4
|
|
.IX Item "-?, -h, -help"
|
|
Prints a usage message.
|
|
.IP "\fB\-newcert\fR" 4
|
|
.IX Item "-newcert"
|
|
Creates a new self signed certificate. The private key is written to the file
|
|
\&\fInewkey.pem\fR and the request written to the file \fInewreq.pem\fR.
|
|
Invokes \fIopenssl\-req\fR\|(1).
|
|
.IP "\fB\-newreq\fR" 4
|
|
.IX Item "-newreq"
|
|
Creates a new certificate request. The private key is written to the file
|
|
\&\fInewkey.pem\fR and the request written to the file \fInewreq.pem\fR.
|
|
Executes \fIopenssl\-req\fR\|(1) under the hood.
|
|
.IP "\fB\-newreq\-nodes\fR" 4
|
|
.IX Item "-newreq-nodes"
|
|
Is like \fB\-newreq\fR except that the private key will not be encrypted.
|
|
Uses \fIopenssl\-req\fR\|(1).
|
|
.IP "\fB\-newca\fR" 4
|
|
.IX Item "-newca"
|
|
Creates a new \s-1CA\s0 hierarchy for use with the \fBca\fR program (or the \fB\-signcert\fR
|
|
and \fB\-xsign\fR 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 \fIdemoCA\fR in the current directory.
|
|
Uses \fIopenssl\-req\fR\|(1) and \fIopenssl\-ca\fR\|(1).
|
|
.Sp
|
|
If the \fIdemoCA\fR directory already exists then the \fB\-newca\fR command will not
|
|
overwrite it and will do nothing. This can happen if a previous call using
|
|
the \fB\-newca\fR option terminated abnormally. To get the correct behaviour
|
|
delete the directory if it already exists.
|
|
.IP "\fB\-pkcs12\fR" 4
|
|
.IX 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 \fInewcert.pem\fR and the \s-1CA\s0 certificate to be in the file \fIdemoCA/cacert.pem\fR,
|
|
it creates a file \fInewcert.p12\fR. This command can thus be called after the
|
|
\&\fB\-sign\fR 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 \fIopenssl\-pkcs12\fR\|(1).
|
|
.IP "\fB\-sign\fR, \fB\-signcert\fR, \fB\-xsign\fR" 4
|
|
.IX Item "-sign, -signcert, -xsign"
|
|
Calls the \fIopenssl\-ca\fR\|(1) command to sign a certificate request. It expects the
|
|
request to be in the file \fInewreq.pem\fR. The new certificate is written to the
|
|
file \fInewcert.pem\fR except in the case of the \fB\-xsign\fR option when it is
|
|
written to standard output.
|
|
.IP "\fB\-signCA\fR" 4
|
|
.IX Item "-signCA"
|
|
This option is the same as the \fB\-sign\fR option except it uses the
|
|
configuration file section \fBv3_ca\fR 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 \fIopenssl\-ca\fR\|(1).
|
|
.IP "\fB\-signcert\fR" 4
|
|
.IX Item "-signcert"
|
|
This option is the same as \fB\-sign\fR except it expects a self signed certificate
|
|
to be present in the file \fInewreq.pem\fR.
|
|
Extra params are passed to \fIopenssl\-x509\fR\|(1) and \fIopenssl\-ca\fR\|(1).
|
|
.IP "\fB\-crl\fR" 4
|
|
.IX Item "-crl"
|
|
Generate a \s-1CRL.\s0 Executes \fIopenssl\-ca\fR\|(1).
|
|
.IP "\fB\-revoke\fR \fIcertfile\fR [\fIreason\fR]" 4
|
|
.IX Item "-revoke certfile [reason]"
|
|
Revoke the certificate contained in the specified \fBcertfile\fR. An optional
|
|
reason may be specified, and must be one of: \fBunspecified\fR,
|
|
\&\fBkeyCompromise\fR, \fBCACompromise\fR, \fBaffiliationChanged\fR, \fBsuperseded\fR,
|
|
\&\fBcessationOfOperation\fR, \fBcertificateHold\fR, or \fBremoveFromCRL\fR.
|
|
Leverages \fIopenssl\-ca\fR\|(1).
|
|
.IP "\fB\-verify\fR" 4
|
|
.IX Item "-verify"
|
|
Verifies certificates against the \s-1CA\s0 certificate for \fIdemoCA\fR. If no
|
|
certificates are specified on the command line it tries to verify the file
|
|
\&\fInewcert.pem\fR. Invokes \fIopenssl\-verify\fR\|(1).
|
|
.IP "\fB\-extra\-\f(BIcmd\fB\fR \fIparameter\fR" 4
|
|
.IX Item "-extra-cmd parameter"
|
|
For each option \fBextra\-\f(BIcmd\fB\fR, pass \fIparameter\fR to the \fIopenssl\fR\|(1)
|
|
sub-command with the same name as \fIcmd\fR, if that sub-command is invoked.
|
|
For example, if \fIopenssl\-req\fR\|(1) is invoked, the \fIparameter\fR given with
|
|
\&\fB\-extra\-req\fR will be passed to it.
|
|
For multi-word parameters, either repeat the option or quote the \fIparameters\fR
|
|
so it looks like one word to your shell.
|
|
See the individual command documentation for more information.
|
|
.SH "EXAMPLES"
|
|
.IX Header "EXAMPLES"
|
|
Create a \s-1CA\s0 hierarchy:
|
|
.PP
|
|
.Vb 1
|
|
\& CA.pl \-newca
|
|
.Ve
|
|
.PP
|
|
Complete certificate creation example: create a \s-1CA,\s0 create a request, sign
|
|
the request and finally create a PKCS#12 file containing it.
|
|
.PP
|
|
.Vb 4
|
|
\& CA.pl \-newca
|
|
\& CA.pl \-newreq
|
|
\& CA.pl \-sign
|
|
\& CA.pl \-pkcs12 "My Test Certificate"
|
|
.Ve
|
|
.SH "ENVIRONMENT"
|
|
.IX Header "ENVIRONMENT"
|
|
The environment variable \fB\s-1OPENSSL\s0\fR may be used to specify the name of
|
|
the OpenSSL program. It can be a full pathname, or a relative one.
|
|
.PP
|
|
The environment variable \fB\s-1OPENSSL_CONFIG\s0\fR may be used to specify a
|
|
configuration option and value to the \fBreq\fR and \fBca\fR 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'\fR.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIopenssl\fR\|(1),
|
|
\&\fIopenssl\-x509\fR\|(1),
|
|
\&\fIopenssl\-ca\fR\|(1),
|
|
\&\fIopenssl\-req\fR\|(1),
|
|
\&\fIopenssl\-pkcs12\fR\|(1),
|
|
\&\fIconfig\fR\|(5)
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
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>.
|