Update docs.
This commit is contained in:
parent
0396479dec
commit
cc5ba6a7b6
@ -20,11 +20,22 @@ B<openssl> B<ocsp>
|
|||||||
[B<-respin file>]
|
[B<-respin file>]
|
||||||
[B<-nonce>]
|
[B<-nonce>]
|
||||||
[B<-no_nonce>]
|
[B<-no_nonce>]
|
||||||
|
[B<-url responder_url>]
|
||||||
[B<-host host:n>]
|
[B<-host host:n>]
|
||||||
[B<-path>]
|
[B<-path>]
|
||||||
[B<-CApath file>]
|
[B<-CApath file>]
|
||||||
[B<-CAfile file>]
|
[B<-CAfile file>]
|
||||||
|
[B<-VAfile file>]
|
||||||
|
[B<-verify_certs file>]
|
||||||
[B<-noverify>]
|
[B<-noverify>]
|
||||||
|
[B<-trust_other>]
|
||||||
|
[B<-no_intern>]
|
||||||
|
[B<-no_sig_verify>]
|
||||||
|
[B<-no_cert_verify>]
|
||||||
|
[B<-no_chain>]
|
||||||
|
[B<-no_cert_checks>]
|
||||||
|
[B<-validity_period nsec>]
|
||||||
|
[B<-status_age nsec>]
|
||||||
|
|
||||||
=head1 DESCRIPTION
|
=head1 DESCRIPTION
|
||||||
|
|
||||||
@ -94,6 +105,10 @@ read OCSP request or response file from B<file>. These option are ignored
|
|||||||
if OCSP request or response creation is implied by other options (for example
|
if OCSP request or response creation is implied by other options (for example
|
||||||
with B<serial>, B<cert> and B<host> options).
|
with B<serial>, B<cert> and B<host> options).
|
||||||
|
|
||||||
|
=item B<-url responder_url>
|
||||||
|
|
||||||
|
specify the responder URL. Both HTTP and HTTPS (SSL/TLS) URLs can be specified.
|
||||||
|
|
||||||
=item B<-host hostname:port>, B<-path pathname>
|
=item B<-host hostname:port>, B<-path pathname>
|
||||||
|
|
||||||
if the B<host> option is present then the OCSP request is sent to the host
|
if the B<host> option is present then the OCSP request is sent to the host
|
||||||
@ -105,9 +120,74 @@ or "/" by default.
|
|||||||
file or pathname containing trusted CA certificates. These are used to verify
|
file or pathname containing trusted CA certificates. These are used to verify
|
||||||
the signature on the OCSP response.
|
the signature on the OCSP response.
|
||||||
|
|
||||||
|
=item B<-verify_certs file>
|
||||||
|
|
||||||
|
file containing additional certificates to search when attempting to locate
|
||||||
|
the OCSP response signing certificate. Some responders omit the actual signer's
|
||||||
|
certificate from the reponse: this option can be used to supply the neccesary
|
||||||
|
certificate in such cases.
|
||||||
|
|
||||||
|
=item B<-trust_other>
|
||||||
|
|
||||||
|
the certificates specified by the B<-verify_certs> option should be explicitly
|
||||||
|
trusted and no additional checks will be performed on them. This is useful
|
||||||
|
when the complete reponder certificate chain is not available or trusting a
|
||||||
|
root CA is not appropriate.
|
||||||
|
|
||||||
|
=item B<-VAfile file>
|
||||||
|
|
||||||
|
file containing explicitly trusted responder certificates. Equivalent to the
|
||||||
|
B<-verify_certs> and B<-trust_other> options.
|
||||||
|
|
||||||
=item B<-noverify>
|
=item B<-noverify>
|
||||||
|
|
||||||
don't attempt to verify the OCSP response signature or the nonce values.
|
don't attempt to verify the OCSP response signature or the nonce values. This
|
||||||
|
option will normally only be used for debugging since it disables all verification
|
||||||
|
of the responders certificate.
|
||||||
|
|
||||||
|
=item B<-no_intern>
|
||||||
|
|
||||||
|
ignore certificates contained in the OCSP response when searching for the
|
||||||
|
signers certificate. With this option the signers certificate must be specified
|
||||||
|
with either the B<-verify_certs> or B<-VAfile> options.
|
||||||
|
|
||||||
|
=item B<-no_sig_verify>
|
||||||
|
|
||||||
|
don't check the signature on the OCSP response. Since this option tolerates invalid
|
||||||
|
signatures on OCSP respondes it will normally only be used for testing purposes.
|
||||||
|
|
||||||
|
=item B<-no_cert_verify>
|
||||||
|
|
||||||
|
don't verify the OCSP reponse signers certificate at all. Since this option allows
|
||||||
|
the OCSP response to be signed by any certificate it should only be used for
|
||||||
|
testing purposes.
|
||||||
|
|
||||||
|
=item B<-no_chain>
|
||||||
|
|
||||||
|
do not use certificates in the response as additional untrusted CA
|
||||||
|
certificates.
|
||||||
|
|
||||||
|
=item B<-no_cert_checks>
|
||||||
|
|
||||||
|
don't perform any additional checks on the OCSP response signers certificate.
|
||||||
|
That is do not make any checks to see if the signers certificate is authorised
|
||||||
|
to provide the neccessary status information: as a result this option should
|
||||||
|
only be used for testing purposes.
|
||||||
|
|
||||||
|
=item B<-validity_period nsec>, B<-status_age age>
|
||||||
|
|
||||||
|
these options specify the range of times, in seconds, which will be tolerated
|
||||||
|
in an OCSP response. Each certificate status response includes a B<notBefore> time and
|
||||||
|
an optional B<notAfter> time. The current time should fall between these two values, but
|
||||||
|
the interval between the two times may be only a few seconds. In practice the OCSP
|
||||||
|
responder and clients clocks may not be precisely synchronised and so such a check
|
||||||
|
may fail. To avoid this the B<-validity_period> option can be used to specify an
|
||||||
|
acceptable error range in seconds, the default value is 5 minutes.
|
||||||
|
|
||||||
|
If the B<notAfter> time is omitted from a response then this means that new status
|
||||||
|
information is immediately available. In this case the age of the B<notBefore> field
|
||||||
|
is checked to see it is not older than B<age> seconds old. By default this additional
|
||||||
|
check is not performed.
|
||||||
|
|
||||||
=back
|
=back
|
||||||
|
|
||||||
@ -146,20 +226,18 @@ authorised directly by the CA it is issuing revocation information about
|
|||||||
|
|
||||||
If the OCSP responder is a "global responder" which can give details about
|
If the OCSP responder is a "global responder" which can give details about
|
||||||
multiple CAs and has its own separate certificate chain then its root
|
multiple CAs and has its own separate certificate chain then its root
|
||||||
CA must be trusted for OCSP signing. For example:
|
CA can be trusted for OCSP signing. For example:
|
||||||
|
|
||||||
openssl x509 -in ocspCA.pem -addtrust OCSPSigning -out trustedCA.pem
|
openssl x509 -in ocspCA.pem -addtrust OCSPSigning -out trustedCA.pem
|
||||||
|
|
||||||
|
Alternatively the responder certificate itself can be explicitly trusted
|
||||||
|
with the B<-VAfile> option.
|
||||||
|
|
||||||
=head1 NOTES
|
=head1 NOTES
|
||||||
|
|
||||||
The B<-host> and B<-path> options specify the relevant parts of the OCSP
|
As noted, most of the verify options are for testing or debugging purposes.
|
||||||
URI. For example the OCSP responder URL:
|
Normally only the B<-CApath>, B<-CAfile> and (if the responder is a 'global
|
||||||
|
VA') B<-VAfile> options need to be used.
|
||||||
http://ocsp.myhost.com/ocsp/request
|
|
||||||
|
|
||||||
corresponds to the the options:
|
|
||||||
|
|
||||||
-host ocsp.myhost.com:80 -path /ocsp/request
|
|
||||||
|
|
||||||
=head1 EXAMPLES
|
=head1 EXAMPLES
|
||||||
|
|
||||||
@ -171,18 +249,9 @@ Send a query an OCSP responder with URL http://ocsp.myhost.com/ save the
|
|||||||
response to a file and print it out in text form
|
response to a file and print it out in text form
|
||||||
|
|
||||||
openssl ocsp -issuer issuer.pem -cert c1.pem -cert c2.pem \
|
openssl ocsp -issuer issuer.pem -cert c1.pem -cert c2.pem \
|
||||||
-host ocsp.myhost.com:80 -resp_text -respout resp.der
|
-url http://ocsp.myhost.com/ -resp_text -respout resp.der
|
||||||
|
|
||||||
Read in an OCSP response and print out text form:
|
Read in an OCSP response and print out text form:
|
||||||
|
|
||||||
openssl ocsp -respin resp.der -text
|
openssl ocsp -respin resp.der -text
|
||||||
|
|
||||||
=head1 BUGS
|
|
||||||
|
|
||||||
This utility is incomplete. It currently does not completely check the OCSP
|
|
||||||
response's: it does not check the validity dates for example.
|
|
||||||
|
|
||||||
The B<host> and B<path> options may well go away and be replaced by a B<url>
|
|
||||||
option or an option to determine the URI based on certificate extensions.
|
|
||||||
|
|
||||||
SSL OCSP responders using https URLs cannot currently be queried.
|
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
|
|
||||||
=head1 NAME
|
=head1 NAME
|
||||||
|
|
||||||
req - PKCS#10 certificate and certificate generating utility.
|
req - PKCS#10 certificate request and certificate generating utility.
|
||||||
|
|
||||||
=head1 SYNOPSIS
|
=head1 SYNOPSIS
|
||||||
|
|
||||||
@ -31,6 +31,7 @@ B<openssl> B<req>
|
|||||||
[B<-subj arg>]
|
[B<-subj arg>]
|
||||||
[B<-x509>]
|
[B<-x509>]
|
||||||
[B<-days n>]
|
[B<-days n>]
|
||||||
|
[B<-set_serial n>]
|
||||||
[B<-asn1-kludge>]
|
[B<-asn1-kludge>]
|
||||||
[B<-newhdr>]
|
[B<-newhdr>]
|
||||||
[B<-extensions section>]
|
[B<-extensions section>]
|
||||||
@ -167,13 +168,21 @@ when processing a request.
|
|||||||
this option outputs a self signed certificate instead of a certificate
|
this option outputs a self signed certificate instead of a certificate
|
||||||
request. This is typically used to generate a test certificate or
|
request. This is typically used to generate a test certificate or
|
||||||
a self signed root CA. The extensions added to the certificate
|
a self signed root CA. The extensions added to the certificate
|
||||||
(if any) are specified in the configuration file.
|
(if any) are specified in the configuration file. Unless specified
|
||||||
|
using the B<set_serial> option B<0> will be used for the serial
|
||||||
|
number.
|
||||||
|
|
||||||
=item B<-days n>
|
=item B<-days n>
|
||||||
|
|
||||||
when the B<-x509> option is being used this specifies the number of
|
when the B<-x509> option is being used this specifies the number of
|
||||||
days to certify the certificate for. The default is 30 days.
|
days to certify the certificate for. The default is 30 days.
|
||||||
|
|
||||||
|
=item B<-set_serial n>
|
||||||
|
|
||||||
|
serial number to use when outputting a self signed certifcate. This
|
||||||
|
may be specified as a decimal value or a hex value if preceded by B<0x>.
|
||||||
|
It is possible to use negative serial numbers but this is not recommended.
|
||||||
|
|
||||||
=item B<-extensions section>
|
=item B<-extensions section>
|
||||||
|
|
||||||
=item B<-reqexts section>
|
=item B<-reqexts section>
|
||||||
|
@ -36,6 +36,7 @@ B<openssl> B<x509>
|
|||||||
[B<-addreject arg>]
|
[B<-addreject arg>]
|
||||||
[B<-setalias arg>]
|
[B<-setalias arg>]
|
||||||
[B<-days arg>]
|
[B<-days arg>]
|
||||||
|
[B<-set_serial n>]
|
||||||
[B<-signkey filename>]
|
[B<-signkey filename>]
|
||||||
[B<-x509toreq>]
|
[B<-x509toreq>]
|
||||||
[B<-req>]
|
[B<-req>]
|
||||||
@ -293,6 +294,16 @@ is used to pass the required private key.
|
|||||||
by default a certificate is expected on input. With this option a
|
by default a certificate is expected on input. With this option a
|
||||||
certificate request is expected instead.
|
certificate request is expected instead.
|
||||||
|
|
||||||
|
=item B<-set_serial n>
|
||||||
|
|
||||||
|
specifies the serial number to use. This option can be used with either
|
||||||
|
the B<-signkey> or B<-CA> options. If used in conjunction with the B<-CA>
|
||||||
|
option the serial number file (as specified by the B<-CAserial> or
|
||||||
|
B<-CAcreateserial> options) is not used.
|
||||||
|
|
||||||
|
The serial number can be decimal or hex (if preceded by B<0x>). Negative
|
||||||
|
serial numbers can also be specified but their use is not recommended.
|
||||||
|
|
||||||
=item B<-CA filename>
|
=item B<-CA filename>
|
||||||
|
|
||||||
specifies the CA certificate to be used for signing. When this option is
|
specifies the CA certificate to be used for signing. When this option is
|
||||||
|
Loading…
x
Reference in New Issue
Block a user