$NetBSD: openssl-CA.pl.1,v 1.2 2024/09/08 13:08:38 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

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

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . 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 ========================================================================

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" \fBCA.pl \fB-? | \fB-h | \fB-help

\fBCA.pl \fB-newcert | \fB-newreq | \fB-newreq-nodes | \fB-xsign | \fB-sign | \fB-signCA | \fB-signcert | \fB-crl | \fB-newca [-extra-\f(BIcmd parameter]

\fBCA.pl -pkcs12 [certname]

\fBCA.pl -verify certfile ...

\fBCA.pl -revoke certfile [reason]

Header "DESCRIPTION" The CA.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 \fBCA.pl script.

Under some environments it may not be possible to run the CA.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 OPENSSL_CONF environment variable can be set to point to the correct path of the configuration file.

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 \fInewkey.pem and the request written to the file newreq.pem. Invokes openssl-req\|(1). 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. Item "-newreq-nodes" Is like -newreq except that the private key will not be encrypted. Uses openssl-req\|(1). Item "-newca" Creates a new CA hierarchy for use with the ca program (or the -signcert and -xsign options). The user is prompted to enter the filename of the CA certificates (which should also contain the private key) or by hitting ENTER details of the CA 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. Item "-pkcs12" Create a PKCS#12 file containing the user certificate, private key and CA certificate. It expects the user certificate and private key to be in the file newcert.pem and the CA 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 "friendly name" for the certificate (which is typically displayed in the browser list box), otherwise the name "My Certificate" is used. Delegates work to openssl-pkcs12\|(1). 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. 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 CA certificate. This is useful when creating intermediate CA from a root CA. Extra params are passed to openssl-ca\|(1). 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). Item "-crl" Generate a CRL. Executes openssl-ca\|(1). 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). Item "-verify" Verifies certificates against the CA certificate for demoCA. If no certificates are specified on the command line it tries to verify the file \fInewcert.pem. Invokes openssl-verify\|(1). 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. Header "EXAMPLES" Create a CA hierarchy:

.Vb 1 CA.pl -newca .Ve

Complete certificate creation example: create a CA, 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

Header "ENVIRONMENT" The environment variable OPENSSL may be used to specify the name of the OpenSSL program. It can be a full pathname, or a relative one.

The environment variable OPENSSL_CONFIG 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'.

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

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.