Document more error codes.

[openssl.git] / doc / apps / ocsp.pod

diff --git a/doc/apps/ocsp.pod b/doc/apps/ocsp.pod
index 139b7c2384a6954ff816282f099e35f9022866d4..af2e12e418bf43944e8419212e5cb99fe4099615 100644 (file)
--- a/doc/apps/ocsp.pod
+++ b/doc/apps/ocsp.pod
@@ -11,6 +11,10 @@ B<openssl> B<ocsp>
 [B<-issuer file>]
 [B<-cert file>]
 [B<-serial n>]
 [B<-issuer file>]
 [B<-cert file>]
 [B<-serial n>]

+[B<-signer file>]
+[B<-signkey file>]
+[B<-sign_other file>]
+[B<-no_certs>]

 [B<-req_text>]
 [B<-resp_text>]
 [B<-text>]
 [B<-req_text>]
 [B<-resp_text>]
 [B<-text>]


@@ -20,35 +24,45 @@ B<openssl> B<ocsp>
 [B<-respin file>]
 [B<-nonce>]
 [B<-no_nonce>]
 [B<-respin file>]
 [B<-nonce>]
 [B<-no_nonce>]

-[B<-url responder_url>]
+[B<-url URL>]

 [B<-host host:n>]
 [B<-path>]
 [B<-host host:n>]
 [B<-path>]

-[B<-CApath file>]
+[B<-CApath dir>]

 [B<-CAfile file>]
 [B<-VAfile file>]
 [B<-CAfile file>]
 [B<-VAfile file>]

-[B<-verify_certs file>]
+[B<-validity_period n>]
+[B<-status_age n>]

 [B<-noverify>]
 [B<-noverify>]

+[B<-verify_other file>]

 [B<-trust_other>]
 [B<-no_intern>]
 [B<-trust_other>]
 [B<-no_intern>]

-[B<-no_sig_verify>]
+[B<-no_signature_verify>]

 [B<-no_cert_verify>]
 [B<-no_chain>]
 [B<-no_cert_checks>]
 [B<-no_cert_verify>]
 [B<-no_chain>]
 [B<-no_cert_checks>]

-[B<-validity_period nsec>]
-[B<-status_age nsec>]
+[B<-port num>]
+[B<-index file>]
+[B<-CA file>]
+[B<-rsigner file>]
+[B<-rkey file>]
+[B<-rother file>]
+[B<-resp_no_certs>]
+[B<-nmin n>]
+[B<-ndays n>]
+[B<-resp_key_id>]
+[B<-nrequest n>]
+[B<-md5|-sha1|...>]

 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION
 

-B<WARNING: this documentation is preliminary and subject to change.>
-

 The Online Certificate Status Protocol (OCSP) enables applications to
 determine the (revocation) state of an identified certificate (RFC 2560).
 
 The B<ocsp> command performs many common OCSP tasks. It can be used
 to print out requests and responses, create requests and send queries
 The Online Certificate Status Protocol (OCSP) enables applications to
 determine the (revocation) state of an identified certificate (RFC 2560).
 
 The B<ocsp> command performs many common OCSP tasks. It can be used
 to print out requests and responses, create requests and send queries

-to an OCSP responder.
+to an OCSP responder and behave like a mini OCSP server itself.

 
 

-=head1 OPTIONS
+=head1 OCSP CLIENT OPTIONS

 
 =over 4
 
 
 =over 4
 


@@ -60,7 +74,7 @@ specify output filename, default is standard output.
 
 This specifies the current issuer certificate. This option can be used
 multiple times. The certificate specified in B<filename> must be in
 
 This specifies the current issuer certificate. This option can be used
 multiple times. The certificate specified in B<filename> must be in

-PEM format.
+PEM format. This option B<MUST> come before any B<-cert> options.

 
 =item B<-cert filename>
 
 
 =item B<-cert filename>
 


@@ -83,6 +97,10 @@ the B<signkey> option is not present then the private key is read
 from the same file as the certificate. If neither option is specified then
 the OCSP request is not signed.
 
 from the same file as the certificate. If neither option is specified then
 the OCSP request is not signed.
 

+=item B<-sign_other filename>
+
+Additional certificates to include in the signed request.
+

 =item B<-nonce>, B<-no_nonce>
 
 Add an OCSP nonce extension to a request or disable OCSP nonce addition.
 =item B<-nonce>, B<-no_nonce>
 
 Add an OCSP nonce extension to a request or disable OCSP nonce addition.


@@ -93,7 +111,7 @@ a nonce is automatically added specifying B<no_nonce> overrides this.
 
 =item B<-req_text>, B<-resp_text>, B<-text>
 
 
 =item B<-req_text>, B<-resp_text>, B<-text>
 

-print out the text form of the OCSP request, reponse or both respectively.
+print out the text form of the OCSP request, response or both respectively.

 
 =item B<-reqout file>, B<-respout file>
 
 
 =item B<-reqout file>, B<-respout file>
 


@@ -120,24 +138,24 @@ or "/" by default.
 file or pathname containing trusted CA certificates. These are used to verify
 the signature on the OCSP response.
 
 file or pathname containing trusted CA certificates. These are used to verify
 the signature on the OCSP response.
 

-=item B<-verify_certs file>
+=item B<-verify_other file>

 
 file containing additional certificates to search when attempting to locate
 the OCSP response signing certificate. Some responders omit the actual signer's
 
 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 from the response: this option can be used to supply the necessary

 certificate in such cases.
 
 =item B<-trust_other>
 
 certificate in such cases.
 
 =item B<-trust_other>
 

-the certificates specified by the B<-verify_certs> option should be explicitly
+the certificates specified by the B<-verify_other> option should be explicitly

 trusted and no additional checks will be performed on them. This is useful
 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
+when the complete responder 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
 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.
+B<-verify_other> and B<-trust_other> options.

 
 =item B<-noverify>
 
 
 =item B<-noverify>
 


@@ -149,16 +167,16 @@ of the responders certificate.
 
 ignore certificates contained in the OCSP response when searching for the
 signers certificate. With this option the signers certificate must be specified
 
 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.
+with either the B<-verify_other> or B<-VAfile> options.

 
 

-=item B<-no_sig_verify>
+=item B<-no_signature_verify>

 
 don't check the signature on the OCSP response. Since this option tolerates invalid
 
 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.
+signatures on OCSP responses it will normally only be used for testing purposes.

 
 =item B<-no_cert_verify>
 
 
 =item B<-no_cert_verify>
 

-don't verify the OCSP reponse signers certificate at all. Since this option allows
+don't verify the OCSP response 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.
 
 the OCSP response to be signed by any certificate it should only be used for
 testing purposes.
 


@@ -171,7 +189,7 @@ certificates.
 
 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
 
 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
+to provide the necessary status information: as a result this option should

 only be used for testing purposes.
 
 =item B<-validity_period nsec>, B<-status_age age>
 only be used for testing purposes.
 
 =item B<-validity_period nsec>, B<-status_age age>


@@ -189,6 +207,70 @@ information is immediately available. In this case the age of the B<notBefore> f
 is checked to see it is not older than B<age> seconds old. By default this additional
 check is not performed.
 
 is checked to see it is not older than B<age> seconds old. By default this additional
 check is not performed.
 

+=item B<-md5|-sha1|-sha256|-ripemod160|...>
+
+this option sets digest algorithm to use for certificate identification
+in the OCSP request. By default SHA-1 is used. 
+
+=back
+
+=head1 OCSP SERVER OPTIONS
+
+=over 4
+
+=item B<-index indexfile>
+
+B<indexfile> is a text index file in B<ca> format containing certificate revocation
+information.
+
+If the B<index> option is specified the B<ocsp> utility is in responder mode, otherwise
+it is in client mode. The request(s) the responder processes can be either specified on
+the command line (using B<issuer> and B<serial> options), supplied in a file (using the
+B<respin> option) or via external OCSP clients (if B<port> or B<url> is specified).
+
+If the B<index> option is present then the B<CA> and B<rsigner> options must also be
+present.
+
+=item B<-CA file>
+
+CA certificate corresponding to the revocation information in B<indexfile>.
+
+=item B<-rsigner file>
+
+The certificate to sign OCSP responses with.
+
+=item B<-rother file>
+
+Additional certificates to include in the OCSP response.
+
+=item B<-resp_no_certs>
+
+Don't include any certificates in the OCSP response.
+
+=item B<-resp_key_id>
+
+Identify the signer certificate using the key ID, default is to use the subject name.
+
+=item B<-rkey file>
+
+The private key to sign OCSP responses with: if not present the file specified in the
+B<rsigner> option is used.
+
+=item B<-port portnum>
+
+Port to listen for OCSP requests on. The port may also be specified using the B<url>
+option.
+
+=item B<-nrequest number>
+
+The OCSP server will exit after receiving B<number> requests, default unlimited. 
+
+=item B<-nmin minutes>, B<-ndays days>
+
+Number of minutes or days when fresh revocation information is available: used in the
+B<nextUpdate> field. If neither option is present then the B<nextUpdate> field is 
+omitted meaning fresh revocation information is immediately available.
+

 =back
 
 =head1 OCSP Response verification.
 =back
 
 =head1 OCSP Response verification.


@@ -196,7 +278,7 @@ check is not performed.
 OCSP Response follows the rules specified in RFC2560.
 
 Initially the OCSP responder certificate is located and the signature on
 OCSP Response follows the rules specified in RFC2560.
 
 Initially the OCSP responder certificate is located and the signature on

-the OCSP request checked using the reponder certificate's public key.
+the OCSP request checked using the responder certificate's public key.

 
 Then a normal certificate verify is performed on the OCSP responder certificate
 building up a certificate chain in the process. The locations of the trusted
 
 Then a normal certificate verify is performed on the OCSP responder certificate
 building up a certificate chain in the process. The locations of the trusted


@@ -239,13 +321,24 @@ As noted, most of the verify options are for testing or debugging purposes.
 Normally only the B<-CApath>, B<-CAfile> and (if the responder is a 'global
 VA') B<-VAfile> options need to be used.
 
 Normally only the B<-CApath>, B<-CAfile> and (if the responder is a 'global
 VA') B<-VAfile> options need to be used.
 

+The OCSP server is only useful for test and demonstration purposes: it is
+not really usable as a full OCSP responder. It contains only a very
+simple HTTP request handling and can only handle the POST form of OCSP
+queries. It also handles requests serially meaning it cannot respond to
+new requests until it has processed the current one. The text index file
+format of revocation is also inefficient for large quantities of revocation
+data.
+
+It is possible to run the B<ocsp> application in responder mode via a CGI
+script using the B<respin> and B<respout> options.
+

 =head1 EXAMPLES
 
 Create an OCSP request and write it to a file:
 
  openssl ocsp -issuer issuer.pem -cert c1.pem -cert c2.pem -reqout req.der
 
 =head1 EXAMPLES
 
 Create an OCSP request and write it to a file:
 
  openssl ocsp -issuer issuer.pem -cert c1.pem -cert c2.pem -reqout req.der
 

-Send a query an OCSP responder with URL http://ocsp.myhost.com/ save the 
+Send a query to an OCSP responder with URL http://ocsp.myhost.com/ save the 

 response to a file and print it out in text form
 
  openssl ocsp -issuer issuer.pem -cert c1.pem -cert c2.pem \
 response to a file and print it out in text form
 
  openssl ocsp -issuer issuer.pem -cert c1.pem -cert c2.pem \


@@ -255,3 +348,24 @@ Read in an OCSP response and print out text form:
 
  openssl ocsp -respin resp.der -text
 
 
  openssl ocsp -respin resp.der -text
 

+OCSP server on port 8888 using a standard B<ca> configuration, and a separate
+responder certificate. All requests and responses are printed to a file.
+
+ openssl ocsp -index demoCA/index.txt -port 8888 -rsigner rcert.pem -CA demoCA/cacert.pem
+       -text -out log.txt
+
+As above but exit after processing one request:
+
+ openssl ocsp -index demoCA/index.txt -port 8888 -rsigner rcert.pem -CA demoCA/cacert.pem
+     -nrequest 1
+
+Query status information using internally generated request:
+
+ openssl ocsp -index demoCA/index.txt -rsigner rcert.pem -CA demoCA/cacert.pem
+     -issuer demoCA/cacert.pem -serial 1
+
+Query status information using request read from a file, write response to a
+second file.
+
+ openssl ocsp -index demoCA/index.txt -rsigner rcert.pem -CA demoCA/cacert.pem
+     -reqin req.der -respout resp.der