diff options
46 files changed, 760 insertions, 756 deletions
diff --git a/doc/man1/CA.pl.pod b/doc/man1/CA.pl.pod index a7f3970cb0..6949ec6228 100644 --- a/doc/man1/CA.pl.pod +++ b/doc/man1/CA.pl.pod @@ -42,28 +42,28 @@ by the use of some simple options. =item B<?>, B<-h>, B<-help> -prints a usage message. +Prints a usage message. =item B<-newcert> -creates a new self signed certificate. The private key is written to the file +Creates a new self signed certificate. The private key is written to the file "newkey.pem" and the request written to the file "newreq.pem". This argument invokes B<openssl req> command. =item B<-newreq> -creates a new certificate request. The private key is written to the file +Creates a new certificate request. The private key is written to the file "newkey.pem" and the request written to the file "newreq.pem". Executes B<openssl req> command below the hood. =item B<-newreq-nodes> -is like B<-newreq> except that the private key will not be encrypted. +Is like B<-newreq> except that the private key will not be encrypted. Uses B<openssl req> command. =item B<-newca> -creates a new CA hierarchy for use with the B<ca> program (or the B<-signcert> +Creates a new CA hierarchy for use with the B<ca> program (or the B<-signcert> and B<-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 @@ -72,7 +72,7 @@ B<openssl req> and B<openssl ca> commands are get invoked. =item B<-pkcs12> -create a PKCS#12 file containing the user certificate, private key and CA +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 @@ -84,31 +84,31 @@ Delegates work to B<openssl pkcs12> command. =item B<-sign>, B<-signcert>, B<-xsign> -calls the B<ca> program to sign a certificate request. It expects the request +Calls the B<ca> program 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 B<-xsign> option when it is written to standard output. Leverages B<openssl ca> command. =item B<-signCA> -this option is the same as the B<-signreq> option except it uses the configuration -file section B<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 on to B<openssl ca> command. +This option is the same as the B<-signreq> option except it uses the +configuration file section B<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 on to B<openssl ca> command. =item B<-signcert> -this option is the same as B<-sign> except it expects a self signed certificate +This option is the same as B<-sign> except it expects a self signed certificate to be present in the file "newreq.pem". Extra params are passed on to B<openssl x509> and B<openssl ca> commands. =item B<-crl> -generate a CRL. Executes B<openssl ca> command. +Generate a CRL. Executes B<openssl ca> command. =item B<-revoke certfile [reason]> -revoke the certificate contained in the specified B<certfile>. An optional +Revoke the certificate contained in the specified B<certfile>. An optional reason may be specified, and must be one of: B<unspecified>, B<keyCompromise>, B<CACompromise>, B<affiliationChanged>, B<superseded>, B<cessationOfOperation>, B<certificateHold>, or B<removeFromCRL>. @@ -116,9 +116,9 @@ Leverages B<openssl ca> command. =item B<-verify> -verifies certificates against the CA certificate for "demoCA". If no certificates -are specified on the command line it tries to verify the file "newcert.pem". -Invokes B<openssl verify> command. +Verifies certificates against the CA certificate for "demoCA". If no +certificates are specified on the command line it tries to verify the file +"newcert.pem". Invokes B<openssl verify> command. =item B<-extra-req> | B<-extra-ca> | B<-extra-pkcs12> | B<-extra-x509> | B<-extra-verify> <extra-params> @@ -204,7 +204,7 @@ L<config(5)> =head1 COPYRIGHT -Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved. Licensed under the OpenSSL license (the "License"). You may not use this file except in compliance with the License. You can obtain a copy diff --git a/doc/man1/asn1parse.pod b/doc/man1/asn1parse.pod index ee09a83cf7..602754e54d 100644 --- a/doc/man1/asn1parse.pod +++ b/doc/man1/asn1parse.pod @@ -39,56 +39,56 @@ Print out a usage message. =item B<-inform> B<DER|PEM> -the input format. B<DER> is binary format and B<PEM> (the default) is base64 +The input format. B<DER> is binary format and B<PEM> (the default) is base64 encoded. =item B<-in filename> -the input file, default is standard input +The input file, default is standard input. =item B<-out filename> -output file to place the DER encoded data into. If this +Output file to place the DER encoded data into. If this option is not present then no data will be output. This is most useful when combined with the B<-strparse> option. =item B<-noout> -don't output the parsed version of the input file. +Don't output the parsed version of the input file. =item B<-offset number> -starting offset to begin parsing, default is start of file. +Starting offset to begin parsing, default is start of file. =item B<-length number> -number of bytes to parse, default is until end of file. +Number of bytes to parse, default is until end of file. =item B<-i> -indents the output according to the "depth" of the structures. +Indents the output according to the "depth" of the structures. =item B<-oid filename> -a file containing additional OBJECT IDENTIFIERs (OIDs). The format of this +A file containing additional OBJECT IDENTIFIERs (OIDs). The format of this file is described in the NOTES section below. =item B<-dump> -dump unknown data in hex format. +Dump unknown data in hex format. =item B<-dlimit num> -like B<-dump>, but only the first B<num> bytes are output. +Like B<-dump>, but only the first B<num> bytes are output. =item B<-strparse offset> -parse the contents octets of the ASN.1 object starting at B<offset>. This +Parse the contents octets of the ASN.1 object starting at B<offset>. This option can be used multiple times to "drill down" into a nested structure. =item B<-genstr string>, B<-genconf file> -generate encoded data based on B<string>, B<file> or both using +Generate encoded data based on B<string>, B<file> or both using L<ASN1_generate_nconf(3)> format. If B<file> only is present then the string is obtained from the default section using the name B<asn1>. The encoded data is passed through the ASN1 parser and printed out as @@ -105,7 +105,7 @@ END marker in a PEM file. =item B<-item name> -attempt to decode and print the data as B<ASN1_ITEM name>. This can be used to +Attempt to decode and print the data as B<ASN1_ITEM name>. This can be used to print out the fields of any supported ASN.1 structure if the type is known. =back @@ -204,7 +204,7 @@ L<ASN1_generate_nconf(3)> =head1 COPYRIGHT -Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved. Licensed under the OpenSSL license (the "License"). You may not use this file except in compliance with the License. You can obtain a copy diff --git a/doc/man1/ca.pod b/doc/man1/ca.pod index c09db826ec..f2c003b880 100644 --- a/doc/man1/ca.pod +++ b/doc/man1/ca.pod @@ -72,73 +72,73 @@ Print out a usage message. =item B<-verbose> -this prints extra details about the operations being performed. +This prints extra details about the operations being performed. =item B<-config filename> -specifies the configuration file to use. +Specifies the configuration file to use. Optional; for a description of the default value, see L<openssl(1)/COMMAND SUMMARY>. =item B<-name section> -specifies the configuration file section to use (overrides +Specifies the configuration file section to use (overrides B<default_ca> in the B<ca> section). =item B<-in filename> -an input filename containing a single certificate request to be +An input filename containing a single certificate request to be signed by the CA. =item B<-ss_cert filename> -a single self-signed certificate to be signed by the CA. +A single self-signed certificate to be signed by the CA. =item B<-spkac filename> -a file containing a single Netscape signed public key and challenge +A file containing a single Netscape signed public key and challenge and additional field values to be signed by the CA. See the B<SPKAC FORMAT> section for information on the required input and output format. =item B<-infiles> -if present this should be the last option, all subsequent arguments +If present this should be the last option, all subsequent arguments are taken as the names of files containing certificate requests. =item B<-out filename> -the output file to output certificates to. The default is standard +The output file to output certificates to. The default is standard output. The certificate details will also be printed out to this file in PEM format (except that B<-spkac> outputs DER format). =item B<-outdir directory> -the directory to output certificates to. The certificate will be +The directory to output certificates to. The certificate will be written to a filename consisting of the serial number in hex with ".pem" appended. =item B<-cert> -the CA certificate file. +The CA certificate file. =item B<-keyfile filename> -the private key to sign requests with. +The private key to sign requests with. =item B<-keyform PEM|DER> -the format of the data in the private key file. +The format of the data in the private key file. The default is PEM. =item B<-key password> -the password used to encrypt the private key. Since on some +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. =item B<-selfsign> -indicates the issued certificates are to be signed with the key +Indicates the issued certificates are to be signed with the key the certificate requests were signed with (given with B<-keyfile>). Certificate requests signed with a different key are ignored. If B<-spkac>, B<-ss_cert> or B<-gencrl> are given, B<-selfsign> is @@ -152,43 +152,43 @@ self-signed certificate. =item B<-passin arg> -the key password source. For more information about the format of B<arg> +The key password source. For more information about the format of B<arg> see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>. =item B<-notext> -don't output the text form of a certificate to the output file. +Don't output the text form of a certificate to the output file. =item B<-startdate date> -this allows the start date to be explicitly set. The format of the +This allows the start date to be explicitly set. The format of the date is YYMMDDHHMMSSZ (the same as an ASN1 UTCTime structure). =item B<-enddate date> -this allows the expiry date to be explicitly set. The format of the +This allows the expiry date to be explicitly set. The format of the date is YYMMDDHHMMSSZ (the same as an ASN1 UTCTime structure). =item B<-days arg> -the number of days to certify the certificate for. +The number of days to certify the certificate for. =item B<-md alg> -the message digest to use. +The message digest to use. Any digest supported by the OpenSSL B<dgst> command can be used. This option also applies to CRLs. =item B<-policy arg> -this option defines the CA "policy" to use. This is a section in +This option defines the CA "policy" to use. This is a section in the configuration file which decides which fields should be mandatory or match the CA certificate. Check out the B<POLICY FORMAT> section for more information. =item B<-msie_hack> -this is a legacy option to make B<ca> work with very old versions of +This is a legacy option to make B<ca> work with very old versions of the IE certificate enrollment control "certenr3". It used UniversalStrings for almost everything. Since the old control has various security bugs its use is strongly discouraged. The newer control "Xenroll" does not @@ -213,12 +213,12 @@ used in the configuration file to enable this behaviour. =item B<-batch> -this sets the batch mode. In this mode no questions will be asked +This sets the batch mode. In this mode no questions will be asked and all certificates will be certified automatically. =item B<-extensions section> -the section of the configuration file containing certificate extensions +The section of the configuration file containing certificate extensions to be added when a certificate is issued (defaults to B<x509_extensions> unless the B<-extfile> option is used). If no extension section is present then, a V1 certificate is created. If the extension section @@ -228,33 +228,33 @@ extension section format. =item B<-extfile file> -an additional configuration file to read certificate extensions from +An additional configuration file to read certificate extensions from (using the default section unless the B<-extensions> option is also used). =item B<-engine id> -specifying an engine (by its unique B<id> string) will cause B<ca> +Specifying an engine (by its unique B<id> string) will cause B<ca> to attempt to obtain a functional reference to the specified engine, thus initialising it if needed. The engine will then be set as the default for all available algorithms. =item B<-subj arg> -supersedes subject name given in the request. +Supersedes subject name given in the request. The arg must be formatted as I</type0=value0/type1=value1/type2=...>, characters may be escaped by \ (backslash), no spaces are skipped. =item B<-utf8> -this option causes field values to be interpreted as UTF8 strings, by +This option causes field values to be interpreted as UTF8 strings, by default they are interpreted as ASCII. This means that the field values, whether prompted from a terminal or obtained from a configuration file, must be valid UTF8 strings. =item B<-create_serial> -if reading serial from the text file as specified in the configuration +If reading serial from the text file as specified in the configuration fails, specifying this option creates a new random serial to be used as next serial number. @@ -275,28 +275,28 @@ If -multi-rdn is not used then the UID value is I<123456+CN=John Doe>. =item B<-gencrl> -this option generates a CRL based on information in the index file. +This option generates a CRL based on information in the index file. =item B<-crldays num> -the number of days before the next CRL is due. That is the days from +The number of days before the next CRL is due. That is the days from now to place in the CRL nextUpdate field. =item B<-crlhours num> -the number of hours before the next CRL is due. +The number of hours before the next CRL is due. =item B<-revoke filename> -a filename containing a certificate to revoke. +A filename containing a certificate to revoke. =item B<-valid filename> -a filename containing a certificate to add a Valid certificate entry. +A filename containing a certificate to add a Valid certificate entry. =item B<-status serial> -displays the revocation status of the certificate with the specified +Displays the revocation status of the certificate with the specified serial number and exits. =item B<-updatedb> @@ -305,7 +305,7 @@ Updates the database index to purge expired certificates. =item B<-crl_reason reason> -revocation reason, where B<reason> is one of: B<unspecified>, B<keyCompromise>, +Revocation reason, where B<reason> is one of: B<unspecified>, B<keyCompromise>, B<CACompromise>, B<affiliationChanged>, B<superseded>, B<cessationOfOperation>, B<certificateHold> or B<removeFromCRL>. The matching of B<reason> is case insensitive. Setting any revocation reason will make the CRL v2. @@ -332,7 +332,7 @@ B<CACompromise>. =item B<-crlexts section> -the section of the configuration file containing CRL extensions to +The section of the configuration file containing CRL extensions to include. If no CRL extension section is present then a V1 CRL is created, if the CRL extension section is present (even if it is empty) then a V2 CRL is created. The CRL extensions specified are @@ -383,58 +383,58 @@ and long names are the same when this option is used. =item B<new_certs_dir> -the same as the B<-outdir> command line option. It specifies +The same as the B<-outdir> command line option. It specifies the directory where new certificates will be placed. Mandatory. =item B<certificate> -the same as B<-cert>. It gives the file containing the CA +The same as B<-cert>. It gives the file containing the CA certificate. Mandatory. =item B<private_key> -same as the B<-keyfile> option. The file containing the +Same as the B<-keyfile> option. The file containing the CA private key. Mandatory. =item B<RANDFILE> -a file used to read and write random number seed information, or +A file used to read and write random number seed information, or an EGD socket (see L<RAND_egd(3)>). =item B<default_days> -the same as the B<-days> option. The number of days to certify +The same as the B<-days> option. The number of days to certify a certificate for. =item B<default_startdate> -the same as the B<-startdate> option. The start date to certify +The same as the B<-startdate> option. The start date to certify a certificate for. If not set the current time is used. =item B<default_enddate> -the same as the B<-enddate> option. Either this option or +The same as the B<-enddate> option. Either this option or B<default_days> (or the command line equivalents) must be present. =item B<default_crl_hours default_crl_days> -the same as the B<-crlhours> and the B<-crldays> options. These +The same as the B<-crlhours> and the B<-crldays> options. These will only be used if neither command line option is present. At least one of these must be present to generate a CRL. =item B<default_md> -the same as the B<-md> option. Mandatory. +The same as the B<-md> option. Mandatory. =item B<database> -the text database file to use. Mandatory. This file must be present +The text database file to use. Mandatory. This file must be present though initially it will be empty. =item B<unique_subject> -if the value B<yes> is given, the valid certificate entries in the +If the value B<yes> is given, the valid certificate entries in the database must have unique subjects. if the value B<no> is given, several valid certificate entries may have the exact same subject. The default value is B<yes>, to be compatible with older (pre 0.9.8) @@ -444,45 +444,45 @@ the B<-selfsign> command line option. =item B<serial> -a text file containing the next serial number to use in hex. Mandatory. +A text file containing the next serial number to use in hex. Mandatory. This file must be present and contain a valid serial number. =item B<crlnumber> -a text file containing the next CRL number to use in hex. The crl number +A text file containing the next CRL number to use in hex. The crl number will be inserted in the CRLs only if this file exists. If this file is present, it must contain a valid CRL number. =item B<x509_extensions> -the same as B<-extensions>. +The same as B<-extensions>. =item B<crl_extensions> -the same as B<-crlexts>. +The same as B<-crlexts>. =item B<preserve> -the same as B<-preserveDN> +The same as B<-preserveDN> =item B<email_in_dn> -the same as B<-noemailDN>. If you want the EMAIL field to be removed +The same as B<-noemailDN>. If you want the EMAIL field to be removed from the DN of the certificate simply set this to 'no'. If not present the default is to allow for the EMAIL filed in the certificate's DN. =item B<msie_hack> -the same as B<-msie_hack> +The same as B<-msie_hack> =item B<policy> -the same as B<-policy>. Mandatory. See the B<POLICY FORMAT> section +The same as B<-policy>. Mandatory. See the B<POLICY FORMAT> section for more information. =item B<name_opt>, B<cert_opt> -these options allow the format used to display the certificate details +These options allow the format used to display the certificate details when asking the user to confirm signing. All the options supported by the B<x509> utilities B<-nameopt> and B<-certopt> switches can be used here, except the B<no_signame> and B<no_sigdump> are permanently set @@ -499,7 +499,7 @@ multicharacter string types and does not display extensions. =item B<copy_extensions> -determines how extensions in certificate requests should be handled. +Determines how extensions in certificate requests should be handled. If set to B<none> or this option is not present then extensions are ignored and not copied to the certificate. If set to B<copy> then any extensions present in the request that are not already present are copied @@ -709,7 +709,7 @@ L<config(5)>, L<x509v3_config(5)> =head1 COPYRIGHT -Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved. Licensed under the OpenSSL license (the "License"). You may not use this file except in compliance with the License. You can obtain a copy diff --git a/doc/man1/ciphers.pod b/doc/man1/ciphers.pod index 6fea82433c..4774a546f5 100644 --- a/doc/man1/ciphers.pod +++ b/doc/man1/ciphers.pod @@ -63,7 +63,7 @@ When combined with B<-s> includes cipher suites which require SRP. =item B<-v> -Verbose output: For each ciphersuite, list details as provided by +Verbose output: For each cipher suite, list details as provided by L<SSL_CIPHER_description(3)>. =item B<-V> @@ -97,12 +97,12 @@ TLSv1.1 were negotiated. =item B<-stdname> -precede each ciphersuite by its standard name: only available is OpenSSL +Precede each cipher suite by its standard name: only available is OpenSSL is built with tracing enabled (B<enable-ssl-trace> argument to Configure). =item B<cipherlist> -a cipher list to convert to a cipher preference list. If it is not included +A cipher list to convert to a cipher preference list. If it is not included then the default cipher list will be used. The format is described below. =back @@ -168,7 +168,7 @@ When used, this must be the first cipherstring specified. The ciphers included in B<ALL>, but not enabled by default. Currently this includes all RC4 and anonymous ciphers. Note that this rule does not cover B<eNULL>, which is not included by B<ALL> (use B<COMPLEMENTOFALL> if -necessary). Note that RC4 based ciphersuites are not built into OpenSSL by +necessary). Note that RC4 based cipher suites are not built into OpenSSL by default (see the enable-weak-ssl-ciphers option to Configure). =item B<ALL> |