secure/usr.bin/openssl/man/CA.pl.1

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "CA.PL 1"
 136 .TH CA.PL 1 "2020-03-31" "1.1.1f" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 CA.pl \- friendlier interface for OpenSSL certificate programs
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 \&\fB\s-1CA\s0.pl\fR
 146 \&\fB\-?\fR |
 147 \&\fB\-h\fR |
 148 \&\fB\-help\fR
 149 .PP
 150 \&\fB\s-1CA\s0.pl\fR
 151 \&\fB\-newcert\fR |
 152 \&\fB\-newreq\fR |
 153 \&\fB\-newreq\-nodes\fR |
 154 \&\fB\-xsign\fR |
 155 \&\fB\-sign\fR |
 156 \&\fB\-signCA\fR |
 157 \&\fB\-signcert\fR |
 158 \&\fB\-crl\fR |
 159 \&\fB\-newca\fR
 160 [\fB\-extra\-cmd\fR extra\-params]
 161 .PP
 162 \&\fB\s-1CA\s0.pl\fR \fB\-pkcs12\fR [\fB\-extra\-pkcs12\fR extra\-params] [\fBcertname\fR]
 163 .PP
 164 \&\fB\s-1CA\s0.pl\fR \fB\-verify\fR [\fB\-extra\-verify\fR extra\-params] \fBcertfile\fR...
 165 .PP
 166 \&\fB\s-1CA\s0.pl\fR \fB\-revoke\fR [\fB\-extra\-ca\fR extra\-params] \fBcertfile\fR [\fBreason\fR]
 167 .SH "DESCRIPTION"
 168 .IX Header "DESCRIPTION"
 169 The \fB\s-1CA\s0.pl\fR script is a perl script that supplies the relevant command line
 170 arguments to the \fBopenssl\fR command for some common certificate operations.
 171 It is intended to simplify the process of certificate creation and management
 172 by the use of some simple options.
 173 .SH "OPTIONS"
 174 .IX Header "OPTIONS"
 175 .IP "\fB?\fR, \fB\-h\fR, \fB\-help\fR" 4
 176 .IX Item "?, -h, -help"
 177 Prints a usage message.
 178 .IP "\fB\-newcert\fR" 4
 179 .IX Item "-newcert"
 180 Creates a new self signed certificate. The private key is written to the file
 181 \&\*(L"newkey.pem\*(R" and the request written to the file \*(L"newreq.pem\*(R".
 182 This argument invokes \fBopenssl req\fR command.
 183 .IP "\fB\-newreq\fR" 4
 184 .IX Item "-newreq"
 185 Creates a new certificate request. The private key is written to the file
 186 \&\*(L"newkey.pem\*(R" and the request written to the file \*(L"newreq.pem\*(R".
 187 Executes \fBopenssl req\fR command below the hood.
 188 .IP "\fB\-newreq\-nodes\fR" 4
 189 .IX Item "-newreq-nodes"
 190 Is like \fB\-newreq\fR except that the private key will not be encrypted.
 191 Uses \fBopenssl req\fR command.
 192 .IP "\fB\-newca\fR" 4
 193 .IX Item "-newca"
 194 Creates a new \s-1CA\s0 hierarchy for use with the \fBca\fR program (or the \fB\-signcert\fR
 195 and \fB\-xsign\fR options). The user is prompted to enter the filename of the \s-1CA\s0
 196 certificates (which should also contain the private key) or by hitting \s-1ENTER\s0
 197 details of the \s-1CA\s0 will be prompted for. The relevant files and directories
 198 are created in a directory called \*(L"demoCA\*(R" in the current directory.
 199 \&\fBopenssl req\fR and \fBopenssl ca\fR commands are get invoked.
 200 .IP "\fB\-pkcs12\fR" 4
 201 .IX Item "-pkcs12"
 202 Create a PKCS#12 file containing the user certificate, private key and \s-1CA\s0
 203 certificate. It expects the user certificate and private key to be in the
 204 file \*(L"newcert.pem\*(R" and the \s-1CA\s0 certificate to be in the file demoCA/cacert.pem,
 205 it creates a file \*(L"newcert.p12\*(R". This command can thus be called after the
 206 \&\fB\-sign\fR option. The PKCS#12 file can be imported directly into a browser.
 207 If there is an additional argument on the command line it will be used as the
 208 \&\*(L"friendly name\*(R" for the certificate (which is typically displayed in the browser
 209 list box), otherwise the name \*(L"My Certificate\*(R" is used.
 210 Delegates work to \fBopenssl pkcs12\fR command.
 211 .IP "\fB\-sign\fR, \fB\-signcert\fR, \fB\-xsign\fR" 4
 212 .IX Item "-sign, -signcert, -xsign"
 213 Calls the \fBca\fR program to sign a certificate request. It expects the request
 214 to be in the file \*(L"newreq.pem\*(R". The new certificate is written to the file
 215 \&\*(L"newcert.pem\*(R" except in the case of the \fB\-xsign\fR option when it is written
 216 to standard output. Leverages \fBopenssl ca\fR command.
 217 .IP "\fB\-signCA\fR" 4
 218 .IX Item "-signCA"
 219 This option is the same as the \fB\-signreq\fR option except it uses the
 220 configuration file section \fBv3_ca\fR and so makes the signed request a
 221 valid \s-1CA\s0 certificate. This is useful when creating intermediate \s-1CA\s0 from
 222 a root \s-1CA.\s0  Extra params are passed on to \fBopenssl ca\fR command.
 223 .IP "\fB\-signcert\fR" 4
 224 .IX Item "-signcert"
 225 This option is the same as \fB\-sign\fR except it expects a self signed certificate
 226 to be present in the file \*(L"newreq.pem\*(R".
 227 Extra params are passed on to \fBopenssl x509\fR and \fBopenssl ca\fR commands.
 228 .IP "\fB\-crl\fR" 4
 229 .IX Item "-crl"
 230 Generate a \s-1CRL.\s0 Executes \fBopenssl ca\fR command.
 231 .IP "\fB\-revoke certfile [reason]\fR" 4
 232 .IX Item "-revoke certfile [reason]"
 233 Revoke the certificate contained in the specified \fBcertfile\fR. An optional
 234 reason may be specified, and must be one of: \fBunspecified\fR,
 235 \&\fBkeyCompromise\fR, \fBCACompromise\fR, \fBaffiliationChanged\fR, \fBsuperseded\fR,
 236 \&\fBcessationOfOperation\fR, \fBcertificateHold\fR, or \fBremoveFromCRL\fR.
 237 Leverages \fBopenssl ca\fR command.
 238 .IP "\fB\-verify\fR" 4
 239 .IX Item "-verify"
 240 Verifies certificates against the \s-1CA\s0 certificate for \*(L"demoCA\*(R". If no
 241 certificates are specified on the command line it tries to verify the file
 242 \&\*(L"newcert.pem\*(R".  Invokes \fBopenssl verify\fR command.
 243 .IP "\fB\-extra\-req\fR | \fB\-extra\-ca\fR | \fB\-extra\-pkcs12\fR | \fB\-extra\-x509\fR | \fB\-extra\-verify\fR <extra\-params>" 4
 244 .IX Item "-extra-req | -extra-ca | -extra-pkcs12 | -extra-x509 | -extra-verify <extra-params>"
 245 The purpose of these parameters is to allow optional parameters to be supplied
 246 to \fBopenssl\fR that this command executes. The \fB\-extra\-cmd\fR are specific to the
 247 option being used and the \fBopenssl\fR command getting invoked. For example
 248 when this command invokes \fBopenssl req\fR extra parameters can be passed on
 249 with the \fB\-extra\-req\fR parameter. The
 250 \&\fBopenssl\fR commands being invoked per option are documented below.
 251 Users should consult \fBopenssl\fR command documentation for more information.
 252 .SH "EXAMPLES"
 253 .IX Header "EXAMPLES"
 254 Create a \s-1CA\s0 hierarchy:
 255 .PP
 256 .Vb 1
 257 \& CA.pl \-newca
 258 .Ve
 259 .PP
 260 Complete certificate creation example: create a \s-1CA,\s0 create a request, sign
 261 the request and finally create a PKCS#12 file containing it.
 262 .PP
 263 .Vb 4
 264 \& CA.pl \-newca
 265 \& CA.pl \-newreq
 266 \& CA.pl \-signreq
 267 \& CA.pl \-pkcs12 "My Test Certificate"
 268 .Ve
 269 .SH "DSA CERTIFICATES"
 270 .IX Header "DSA CERTIFICATES"
 271 Although the \fB\s-1CA\s0.pl\fR creates \s-1RSA\s0 CAs and requests it is still possible to
 272 use it with \s-1DSA\s0 certificates and requests using the \fBreq\fR\|(1) command
 273 directly. The following example shows the steps that would typically be taken.
 274 .PP
 275 Create some \s-1DSA\s0 parameters:
 276 .PP
 277 .Vb 1
 278 \& openssl dsaparam \-out dsap.pem 1024
 279 .Ve
 280 .PP
 281 Create a \s-1DSA CA\s0 certificate and private key:
 282 .PP
 283 .Vb 1
 284 \& openssl req \-x509 \-newkey dsa:dsap.pem \-keyout cacert.pem \-out cacert.pem
 285 .Ve
 286 .PP
 287 Create the \s-1CA\s0 directories and files:
 288 .PP
 289 .Vb 1
 290 \& CA.pl \-newca
 291 .Ve
 292 .PP
 293 enter cacert.pem when prompted for the \s-1CA\s0 file name.
 294 .PP
 295 Create a \s-1DSA\s0 certificate request and private key (a different set of parameters
 296 can optionally be created first):
 297 .PP
 298 .Vb 1
 299 \& openssl req \-out newreq.pem \-newkey dsa:dsap.pem
 300 .Ve
 301 .PP
 302 Sign the request:
 303 .PP
 304 .Vb 1
 305 \& CA.pl \-signreq
 306 .Ve
 307 .SH "NOTES"
 308 .IX Header "NOTES"
 309 Most of the filenames mentioned can be modified by editing the \fB\s-1CA\s0.pl\fR script.
 310 .PP
 311 If the demoCA directory already exists then the \fB\-newca\fR command will not
 312 overwrite it and will do nothing. This can happen if a previous call using
 313 the \fB\-newca\fR option terminated abnormally. To get the correct behaviour
 314 delete the demoCA directory if it already exists.
 315 .PP
 316 Under some environments it may not be possible to run the \fB\s-1CA\s0.pl\fR script
 317 directly (for example Win32) and the default configuration file location may
 318 be wrong. In this case the command:
 319 .PP
 320 .Vb 1
 321 \& perl \-S CA.pl
 322 .Ve
 323 .PP
 324 can be used and the \fB\s-1OPENSSL_CONF\s0\fR environment variable changed to point to
 325 the correct path of the configuration file.
 326 .PP
 327 The script is intended as a simple front end for the \fBopenssl\fR program for use
 328 by a beginner. Its behaviour isn't always what is wanted. For more control over the
 329 behaviour of the certificate commands call the \fBopenssl\fR command directly.
 330 .SH "SEE ALSO"
 331 .IX Header "SEE ALSO"
 332 \&\fBx509\fR\|(1), \fBca\fR\|(1), \fBreq\fR\|(1), \fBpkcs12\fR\|(1),
 333 \&\fBconfig\fR\|(5)
 334 .SH "COPYRIGHT"
 335 .IX Header "COPYRIGHT"
 336 Copyright 2000\-2017 The OpenSSL Project Authors. All Rights Reserved.
 337 .PP
 338 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 339 this file except in compliance with the License.  You can obtain a copy
 340 in the file \s-1LICENSE\s0 in the source distribution or at
 341 <https://www.openssl.org/source/license.html>.