diff options
Diffstat (limited to 'secure/usr.bin/openssl/man/ca.1')
| -rw-r--r-- | secure/usr.bin/openssl/man/ca.1 | 184 |
1 files changed, 94 insertions, 90 deletions
diff --git a/secure/usr.bin/openssl/man/ca.1 b/secure/usr.bin/openssl/man/ca.1 index c6bc46d..ab85a0c 100644 --- a/secure/usr.bin/openssl/man/ca.1 +++ b/secure/usr.bin/openssl/man/ca.1 @@ -1,8 +1,7 @@ -.\" Automatically generated by Pod::Man version 1.15 -.\" Wed Feb 19 16:49:31 2003 +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 .\" .\" Standard preamble: -.\" ====================================================================== +.\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp @@ -15,12 +14,6 @@ .if t .sp .5v .if n .sp .. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. .de Vb \" Begin verbatim text .ft CW .nf @@ -28,15 +21,14 @@ .. .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. | will give a -.\" real vertical bar. \*(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<> +.\" real vertical bar. \*(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-|\(bv\*(Tr .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ @@ -56,10 +48,10 @@ . ds R" '' 'br\} .\" -.\" If the F register is turned on, we'll generate index entries on stderr -.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and -.\" index entries marked with X<> in POD. Of course, you'll have to process -.\" the output yourself in some meaningful fashion. +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" @@ -68,14 +60,13 @@ . rr F .\} .\" -.\" For nroff, turn off justification. Always turn off hyphenation; it -.\" makes way too many mistakes in technical documents. +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. -.bd B 3 . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 @@ -135,13 +126,12 @@ . ds Ae AE .\} .rm #[ #] #H #V #F C -.\" ====================================================================== +.\" ======================================================================== .\" .IX Title "CA 1" -.TH CA 1 "0.9.7a" "2003-02-19" "OpenSSL" -.UC +.TH CA 1 "2005-02-25" "0.9.7d" "OpenSSL" .SH "NAME" -ca \- sample minimal \s-1CA\s0 application +ca \- sample minimal CA application .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBopenssl\fR \fBca\fR @@ -191,120 +181,120 @@ and their status. The options descriptions will be divided into each purpose. .SH "CA OPTIONS" .IX Header "CA OPTIONS" -.Ip "\fB\-config filename\fR" 4 +.IP "\fB\-config filename\fR" 4 .IX Item "-config filename" specifies the configuration file to use. -.Ip "\fB\-name section\fR" 4 +.IP "\fB\-name section\fR" 4 .IX Item "-name section" specifies the configuration file section to use (overrides \&\fBdefault_ca\fR in the \fBca\fR section). -.Ip "\fB\-in filename\fR" 4 +.IP "\fB\-in filename\fR" 4 .IX Item "-in filename" an input filename containing a single certificate request to be signed by the \s-1CA\s0. -.Ip "\fB\-ss_cert filename\fR" 4 +.IP "\fB\-ss_cert filename\fR" 4 .IX Item "-ss_cert filename" a single self signed certificate to be signed by the \s-1CA\s0. -.Ip "\fB\-spkac filename\fR" 4 +.IP "\fB\-spkac filename\fR" 4 .IX Item "-spkac filename" a file containing a single Netscape signed public key and challenge and additional field values to be signed by the \s-1CA\s0. See the \fB\s-1SPKAC\s0 \s-1FORMAT\s0\fR section for information on the required format. -.Ip "\fB\-infiles\fR" 4 +.IP "\fB\-infiles\fR" 4 .IX Item "-infiles" if present this should be the last option, all subsequent arguments are assumed to the the names of files containing certificate requests. -.Ip "\fB\-out filename\fR" 4 +.IP "\fB\-out filename\fR" 4 .IX Item "-out filename" the output file to output certificates to. The default is standard output. The certificate details will also be printed out to this file. -.Ip "\fB\-outdir directory\fR" 4 +.IP "\fB\-outdir directory\fR" 4 .IX Item "-outdir directory" the directory to output certificates to. The certificate will be written to a filename consisting of the serial number in hex with \&\*(L".pem\*(R" appended. -.Ip "\fB\-cert\fR" 4 +.IP "\fB\-cert\fR" 4 .IX Item "-cert" the \s-1CA\s0 certificate file. -.Ip "\fB\-keyfile filename\fR" 4 +.IP "\fB\-keyfile filename\fR" 4 .IX Item "-keyfile filename" the private key to sign requests with. -.Ip "\fB\-key password\fR" 4 +.IP "\fB\-key password\fR" 4 .IX Item "-key password" the password used to encrypt the private key. Since on some systems the command line arguments are visible (e.g. Unix with the 'ps' utility) this option should be used with caution. -.Ip "\fB\-passin arg\fR" 4 +.IP "\fB\-passin arg\fR" 4 .IX Item "-passin arg" the key password source. For more information about the format of \fBarg\fR -see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in openssl(1). -.Ip "\fB\-verbose\fR" 4 +see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1). +.IP "\fB\-verbose\fR" 4 .IX Item "-verbose" this prints extra details about the operations being performed. -.Ip "\fB\-notext\fR" 4 +.IP "\fB\-notext\fR" 4 .IX Item "-notext" don't output the text form of a certificate to the output file. -.Ip "\fB\-startdate date\fR" 4 +.IP "\fB\-startdate date\fR" 4 .IX Item "-startdate date" this allows the start date to be explicitly set. The format of the date is \s-1YYMMDDHHMMSSZ\s0 (the same as an \s-1ASN1\s0 UTCTime structure). -.Ip "\fB\-enddate date\fR" 4 +.IP "\fB\-enddate date\fR" 4 .IX Item "-enddate date" this allows the expiry date to be explicitly set. The format of the date is \s-1YYMMDDHHMMSSZ\s0 (the same as an \s-1ASN1\s0 UTCTime structure). -.Ip "\fB\-days arg\fR" 4 +.IP "\fB\-days arg\fR" 4 .IX Item "-days arg" the number of days to certify the certificate for. -.Ip "\fB\-md alg\fR" 4 +.IP "\fB\-md alg\fR" 4 .IX Item "-md alg" the message digest to use. Possible values include md5, sha1 and mdc2. This option also applies to CRLs. -.Ip "\fB\-policy arg\fR" 4 +.IP "\fB\-policy arg\fR" 4 .IX Item "-policy arg" this option defines the \s-1CA\s0 \*(L"policy\*(R" to use. This is a section in the configuration file which decides which fields should be mandatory or match the \s-1CA\s0 certificate. Check out the \fB\s-1POLICY\s0 \s-1FORMAT\s0\fR section for more information. -.Ip "\fB\-msie_hack\fR" 4 +.IP "\fB\-msie_hack\fR" 4 .IX Item "-msie_hack" this is a legacy option to make \fBca\fR work with very old versions of the \s-1IE\s0 certificate enrollment control \*(L"certenr3\*(R". It used UniversalStrings for almost everything. Since the old control has various security bugs its use is strongly discouraged. The newer control \*(L"Xenroll\*(R" does not need this option. -.Ip "\fB\-preserveDN\fR" 4 +.IP "\fB\-preserveDN\fR" 4 .IX Item "-preserveDN" Normally the \s-1DN\s0 order of a certificate is the same as the order of the fields in the relevant policy section. When this option is set the order is the same as the request. This is largely for compatibility with the older \s-1IE\s0 enrollment control which would only accept certificates if their DNs match the order of the request. This is not needed for Xenroll. -.Ip "\fB\-noemailDN\fR" 4 +.IP "\fB\-noemailDN\fR" 4 .IX Item "-noemailDN" The \s-1DN\s0 of a certificate can contain the \s-1EMAIL\s0 field if present in the -request \s-1DN\s0, however it is good policy just having the e-mail set into +request \s-1DN\s0, however it is good policy just having the e\-mail set into the altName extension of the certificate. When this option is set the \&\s-1EMAIL\s0 field is removed from the certificate' subject and set only in the, eventually present, extensions. The \fBemail_in_dn\fR keyword can be used in the configuration file to enable this behaviour. -.Ip "\fB\-batch\fR" 4 +.IP "\fB\-batch\fR" 4 .IX Item "-batch" this sets the batch mode. In this mode no questions will be asked and all certificates will be certified automatically. -.Ip "\fB\-extensions section\fR" 4 +.IP "\fB\-extensions section\fR" 4 .IX Item "-extensions section" the section of the configuration file containing certificate extensions to be added when a certificate is issued (defaults to \fBx509_extensions\fR unless the \fB\-extfile\fR option is used). If no extension section is present then, a V1 certificate is created. If the extension section is present (even if it is empty), then a V3 certificate is created. -.Ip "\fB\-extfile file\fR" 4 +.IP "\fB\-extfile file\fR" 4 .IX Item "-extfile file" an additional configuration file to read certificate extensions from (using the default section unless the \fB\-extensions\fR option is also used). -.Ip "\fB\-engine id\fR" 4 +.IP "\fB\-engine id\fR" 4 .IX Item "-engine id" specifying an engine (by it's unique \fBid\fR string) will cause \fBreq\fR to attempt to obtain a functional reference to the specified engine, @@ -312,20 +302,20 @@ thus initialising it if needed. The engine will then be set as the default for all available algorithms. .SH "CRL OPTIONS" .IX Header "CRL OPTIONS" -.Ip "\fB\-gencrl\fR" 4 +.IP "\fB\-gencrl\fR" 4 .IX Item "-gencrl" this option generates a \s-1CRL\s0 based on information in the index file. -.Ip "\fB\-crldays num\fR" 4 +.IP "\fB\-crldays num\fR" 4 .IX Item "-crldays num" the number of days before the next \s-1CRL\s0 is due. That is the days from now to place in the \s-1CRL\s0 nextUpdate field. -.Ip "\fB\-crlhours num\fR" 4 +.IP "\fB\-crlhours num\fR" 4 .IX Item "-crlhours num" the number of hours before the next \s-1CRL\s0 is due. -.Ip "\fB\-revoke filename\fR" 4 +.IP "\fB\-revoke filename\fR" 4 .IX Item "-revoke filename" a filename containing a certificate to revoke. -.Ip "\fB\-crl_reason reason\fR" 4 +.IP "\fB\-crl_reason reason\fR" 4 .IX Item "-crl_reason reason" revocation reason, where \fBreason\fR is one of: \fBunspecified\fR, \fBkeyCompromise\fR, \&\fBCACompromise\fR, \fBaffiliationChanged\fR, \fBsuperseded\fR, \fBcessationOfOperation\fR, @@ -334,26 +324,26 @@ insensitive. Setting any revocation reason will make the \s-1CRL\s0 v2. .Sp In practive \fBremoveFromCRL\fR is not particularly useful because it is only used in delta CRLs which are not currently implemented. -.Ip "\fB\-crl_hold instruction\fR" 4 +.IP "\fB\-crl_hold instruction\fR" 4 .IX Item "-crl_hold instruction" This sets the \s-1CRL\s0 revocation reason code to \fBcertificateHold\fR and the hold instruction to \fBinstruction\fR which must be an \s-1OID\s0. Although any \s-1OID\s0 can be used only \fBholdInstructionNone\fR (the use of which is discouraged by \s-1RFC2459\s0) \&\fBholdInstructionCallIssuer\fR or \fBholdInstructionReject\fR will normally be used. -.Ip "\fB\-crl_compromise time\fR" 4 +.IP "\fB\-crl_compromise time\fR" 4 .IX Item "-crl_compromise time" This sets the revocation reason to \fBkeyCompromise\fR and the compromise time to \&\fBtime\fR. \fBtime\fR should be in GeneralizedTime format that is \fB\s-1YYYYMMDDHHMMSSZ\s0\fR. -.Ip "\fB\-crl_CA_compromise time\fR" 4 +.IP "\fB\-crl_CA_compromise time\fR" 4 .IX Item "-crl_CA_compromise time" This is the same as \fBcrl_compromise\fR except the revocation reason is set to \&\fBCACompromise\fR. -.Ip "\fB\-subj arg\fR" 4 +.IP "\fB\-subj arg\fR" 4 .IX Item "-subj arg" supersedes subject name given in the request. The arg must be formatted as \fI/type0=value0/type1=value1/type2=...\fR, characters may be escaped by \e (backslash), no spaces are skipped. -.Ip "\fB\-crlexts section\fR" 4 +.IP "\fB\-crlexts section\fR" 4 .IX Item "-crlexts section" the section of the configuration file containing \s-1CRL\s0 extensions to include. If no \s-1CRL\s0 extension section is present then a V1 \s-1CRL\s0 is @@ -382,85 +372,85 @@ and the command line the command line value is used. Where an option is described as mandatory then it must be present in the configuration file or the command line equivalent (if any) used. -.Ip "\fBoid_file\fR" 4 +.IP "\fBoid_file\fR" 4 .IX Item "oid_file" This specifies a file containing additional \fB\s-1OBJECT\s0 \s-1IDENTIFIERS\s0\fR. Each line of the file should consist of the numerical form of the object identifier followed by white space then the short name followed by white space and finally the long name. -.Ip "\fBoid_section\fR" 4 +.IP "\fBoid_section\fR" 4 .IX Item "oid_section" This specifies a section in the configuration file containing extra object identifiers. Each line should consist of the short name of the object identifier followed by \fB=\fR and the numerical form. The short and long names are the same when this option is used. -.Ip "\fBnew_certs_dir\fR" 4 +.IP "\fBnew_certs_dir\fR" 4 .IX Item "new_certs_dir" the same as the \fB\-outdir\fR command line option. It specifies the directory where new certificates will be placed. Mandatory. -.Ip "\fBcertificate\fR" 4 +.IP "\fBcertificate\fR" 4 .IX Item "certificate" the same as \fB\-cert\fR. It gives the file containing the \s-1CA\s0 certificate. Mandatory. -.Ip "\fBprivate_key\fR" 4 +.IP "\fBprivate_key\fR" 4 .IX Item "private_key" same as the \fB\-keyfile\fR option. The file containing the \&\s-1CA\s0 private key. Mandatory. -.Ip "\fB\s-1RANDFILE\s0\fR" 4 +.IP "\fB\s-1RANDFILE\s0\fR" 4 .IX Item "RANDFILE" a file used to read and write random number seed information, or -an \s-1EGD\s0 socket (see RAND_egd(3)). -.Ip "\fBdefault_days\fR" 4 +an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)). +.IP "\fBdefault_days\fR" 4 .IX Item "default_days" the same as the \fB\-days\fR option. The number of days to certify a certificate for. -.Ip "\fBdefault_startdate\fR" 4 +.IP "\fBdefault_startdate\fR" 4 .IX Item "default_startdate" the same as the \fB\-startdate\fR option. The start date to certify a certificate for. If not set the current time is used. -.Ip "\fBdefault_enddate\fR" 4 +.IP "\fBdefault_enddate\fR" 4 .IX Item "default_enddate" the same as the \fB\-enddate\fR option. Either this option or \&\fBdefault_days\fR (or the command line equivalents) must be present. -.Ip "\fBdefault_crl_hours default_crl_days\fR" 4 +.IP "\fBdefault_crl_hours default_crl_days\fR" 4 .IX Item "default_crl_hours default_crl_days" the same as the \fB\-crlhours\fR and the \fB\-crldays\fR options. These will only be used if neither command line option is present. At least one of these must be present to generate a \s-1CRL\s0. -.Ip "\fBdefault_md\fR" 4 +.IP "\fBdefault_md\fR" 4 .IX Item "default_md" the same as the \fB\-md\fR option. The message digest to use. Mandatory. -.Ip "\fBdatabase\fR" 4 +.IP "\fBdatabase\fR" 4 .IX Item "database" the text database file to use. Mandatory. This file must be present though initially it will be empty. -.Ip "\fBserialfile\fR" 4 -.IX Item "serialfile" +.IP "\fBserial\fR" 4 +.IX Item "serial" a text file containing the next serial number to use in hex. Mandatory. This file must be present and contain a valid serial number. -.Ip "\fBx509_extensions\fR" 4 +.IP "\fBx509_extensions\fR" 4 .IX Item "x509_extensions" the same as \fB\-extensions\fR. -.Ip "\fBcrl_extensions\fR" 4 +.IP "\fBcrl_extensions\fR" 4 .IX Item "crl_extensions" the same as \fB\-crlexts\fR. -.Ip "\fBpreserve\fR" 4 +.IP "\fBpreserve\fR" 4 .IX Item "preserve" the same as \fB\-preserveDN\fR -.Ip "\fBemail_in_dn\fR" 4 +.IP "\fBemail_in_dn\fR" 4 .IX Item "email_in_dn" the same as \fB\-noemailDN\fR. If you want the \s-1EMAIL\s0 field to be removed from the \s-1DN\s0 of the certificate simply set this to 'no'. If not present the default is to allow for the \s-1EMAIL\s0 filed in the certificate's \s-1DN\s0. -.Ip "\fBmsie_hack\fR" 4 +.IP "\fBmsie_hack\fR" 4 .IX Item "msie_hack" the same as \fB\-msie_hack\fR -.Ip "\fBpolicy\fR" 4 +.IP "\fBpolicy\fR" 4 .IX Item "policy" the same as \fB\-policy\fR. Mandatory. See the \fB\s-1POLICY\s0 \s-1FORMAT\s0\fR section for more information. -.Ip "\fBnameopt\fR, \fBcertopt\fR" 4 +.IP "\fBnameopt\fR, \fBcertopt\fR" 4 .IX Item "nameopt, certopt" these options allow the format used to display the certificate details when asking the user to confirm signing. All the options supported by @@ -469,14 +459,14 @@ here, except the \fBno_signame\fR and \fBno_sigdump\fR are permanently set and cannot be disabled (this is because the certificate signature cannot be displayed because the certificate has not been signed at this point). .Sp -For convenience the values \fBdefault_ca\fR are accepted by both to produce +For convenience the values \fBca_default\fR are accepted by both to produce a reasonable output. .Sp If neither option is present the format used in earlier versions of OpenSSL is used. Use of the old format is \fBstrongly\fR discouraged because it only displays fields mentioned in the \fBpolicy\fR section, mishandles multicharacter string types and does not display extensions. -.Ip "\fBcopy_extensions\fR" 4 +.IP "\fBcopy_extensions\fR" 4 .IX Item "copy_extensions" determines how extensions in certificate requests should be handled. If set to \fBnone\fR or this option is not present then extensions are @@ -529,26 +519,31 @@ Sign a certificate request: .Vb 1 \& openssl ca -in req.pem -out newcert.pem .Ve +.PP Sign a certificate request, using \s-1CA\s0 extensions: .PP .Vb 1 \& openssl ca -in req.pem -extensions v3_ca -out newcert.pem .Ve +.PP Generate a \s-1CRL\s0 .PP .Vb 1 \& openssl ca -gencrl -out crl.pem .Ve +.PP Sign several requests: .PP .Vb 1 \& openssl ca -infiles req1.pem req2.pem req3.pem .Ve +.PP Certify a Netscape \s-1SPKAC:\s0 .PP .Vb 1 \& openssl ca -spkac spkac.txt .Ve +.PP A sample \s-1SPKAC\s0 file (the \s-1SPKAC\s0 line has been truncated for clarity): .PP .Vb 5 @@ -558,40 +553,48 @@ A sample \s-1SPKAC\s0 file (the \s-1SPKAC\s0 line has been truncated for clarity \& 0.OU=OpenSSL Group \& 1.OU=Another Group .Ve +.PP A sample configuration file with the relevant sections for \fBca\fR: .PP .Vb 2 \& [ ca ] \& default_ca = CA_default # The default ca section .Ve +.PP .Vb 1 \& [ CA_default ] .Ve +.PP .Vb 3 \& dir = ./demoCA # top dir \& database = $dir/index.txt # index file. \& new_certs_dir = $dir/newcerts # new certs dir .Ve +.PP .Vb 4 \& certificate = $dir/cacert.pem # The CA cert \& serial = $dir/serial # serial no file \& private_key = $dir/private/cakey.pem# CA private key \& RANDFILE = $dir/private/.rand # random number file .Ve +.PP .Vb 3 \& default_days = 365 # how long to certify for \& default_crl_days= 30 # how long before next CRL \& default_md = md5 # md to use .Ve +.PP .Vb 2 \& policy = policy_any # default policy \& email_in_dn = no # Don't add the email into cert DN .Ve +.PP .Vb 3 -\& nameopt = default_ca # Subject name display option -\& certopt = default_ca # Certificate display option +\& nameopt = ca_default # Subject name display option +\& certopt = ca_default # Certificate display option \& copy_extensions = none # Don't copy extensions from request .Ve +.PP .Vb 7 \& [ policy_any ] \& countryName = supplied @@ -694,8 +697,9 @@ For example if the \s-1CA\s0 certificate has: .Vb 1 \& basicConstraints = CA:TRUE, pathlen:0 .Ve +.PP then even if a certificate is issued with \s-1CA:TRUE\s0 it will not be valid. .SH "SEE ALSO" .IX Header "SEE ALSO" -req(1), spkac(1), x509(1), CA.pl(1), -config(5) +\&\fIreq\fR\|(1), \fIspkac\fR\|(1), \fIx509\fR\|(1), \s-1\fICA\s0.pl\fR\|(1), +\&\fIconfig\fR\|(5) |
