1 files changed, 53 insertions, 3 deletions

diff --git a/src/lib/cert/x509/ocsp.h b/src/lib/cert/x509/ocsp.h
index af0f81403..fe1796984 100644
--- a/src/lib/cert/x509/ocsp.h
+++ b/src/lib/cert/x509/ocsp.h
@@ -17,41 +17,91 @@ class Certificate_Store;
 
 namespace OCSP {
 
+/**
+* An OCSP request.
+*/
 class BOTAN_DLL Request
    {
    public:
+      /**
+      * Create an OCSP request.
+      * @param issuer_cert issuer certificate
+      * @param subject_cert subject certificate
+      */
       Request(const X509_Certificate& issuer_cert,
               const X509_Certificate& subject_cert) :
          m_issuer(issuer_cert),
          m_subject(subject_cert)
          {}
 
+      /**
+      * @return BER-encoded OCSP request
+      */
       std::vector<byte> BER_encode() const;
 
+      /**
+      * @return Base64-encoded OCSP request
+      */
       std::string base64_encode() const;
 
+      /**
+      * @return issuer certificate
+      */
       const X509_Certificate& issuer() const { return m_issuer; }
 
+      /**
+      * @return subject certificate
+      */
       const X509_Certificate& subject() const { return m_subject; }
    private:
       X509_Certificate m_issuer, m_subject;
    };
 
+/**
+* An OCSP response.
+*/
 class BOTAN_DLL Response
    {
    public:
+      /**
+      * Creates an empty OCSP response.
+      */
       Response() {}
 
+      /**
+      * Creates an OCSP response.
+      * @param trusted_roots trusted roots for the OCSP response
+      * @param response_bits response bits received
+      */
       Response(const Certificate_Store& trusted_roots,
-               const std::vector<byte>& response);
-
+               const std::vector<byte>& response_bits);
+
+      /**
+       * Searches the OCSP response for issuer and subject certificate.
+       * @param issuer issuer certificate
+       * @param subject subject certificate
+       * @return OCSP status code, possible values:
+       *         CERT_IS_REVOKED,
+       *         OCSP_NOT_YET_VALID,
+       *         OCSP_HAS_EXPIRED,
+       *         OCSP_RESPONSE_GOOD,
+       *         OCSP_BAD_STATUS,
+       *         OCSP_CERT_NOT_LISTED
+       */
       Certificate_Status_Code status_for(const X509_Certificate& issuer,
-                                               const X509_Certificate& subject) const;
+                                         const X509_Certificate& subject) const;
 
    private:
       std::vector<SingleResponse> m_responses;
    };
 
+/**
+* Makes an online OCSP request via HTTP and returns the OCSP response.
+* @param issuer issuer certificate
+* @param subject subject certificate
+* @param trusted_roots trusted roots for the OCSP response
+* @return OCSP response
+*/
 BOTAN_DLL Response online_check(const X509_Certificate& issuer,
                                 const X509_Certificate& subject,
                                 const Certificate_Store* trusted_roots);