Doxygen comments for X509_Certificate, from InSiTo

1 files changed, 123 insertions, 12 deletions

diff --git a/src/cert/x509/x509cert.h b/src/cert/x509/x509cert.h
index c8dc2c435..f5bd99167 100644
--- a/src/cert/x509/x509cert.h
+++ b/src/cert/x509/x509cert.h
@@ -14,39 +14,148 @@
 
 namespace Botan {
 
-/*************************************************
-* X.509 Certificate                              *
-*************************************************/
+/**
+* This class represents X.509 Certificate
+*/
 class BOTAN_DLL X509_Certificate : public X509_Object
    {
    public:
+     /**
+     * Get the public key associated with this certificate.
+     * @return the subject public key of this certificate
+     */
       Public_Key* subject_public_key() const;
 
+      /**
+      * Get the issuer certificate DN.
+      * @return the issuer DN of this certificate
+      */
       X509_DN issuer_dn() const;
+
+      /**
+      * Get the subject certificate DN.
+      * @return the subject DN of this certificate
+      */
       X509_DN subject_dn() const;
-      std::vector<std::string> subject_info(const std::string&) const;
-      std::vector<std::string> issuer_info(const std::string&) const;
 
+      /**
+      * Get a value for a specific subject_info parameter name.
+      * @param name the name of the paramter to look up. Possible names are
+      * "X509.Certificate.version", "X509.Certificate.serial",
+      * "X509.Certificate.start", "X509.Certificate.end",
+      * "X509.Certificate.v2.key_id", "X509.Certificate.public_key",
+      * "X509v3.BasicConstraints.path_constraint",
+      * "X509v3.BasicConstraints.is_ca", "X509v3.ExtendedKeyUsage",
+      * "X509v3.CertificatePolicies", "X509v3.SubjectKeyIdentifier" or
+      * "X509.Certificate.serial".
+      * @return the value(s) of the specified parameter
+      */
+      std::vector<std::string> subject_info(const std::string& name) const;
+
+      /**
+      * Get a value for a specific subject_info parameter name.
+      * @param name the name of the paramter to look up. Possible names are
+      * "X509.Certificate.v2.key_id" or "X509v3.AuthorityKeyIdentifier".
+      * @return the value(s) of the specified parameter
+      */
+      std::vector<std::string> issuer_info(const std::string& name) const;
+
+      /**
+      * Get the notBefore of the certificate.
+      * @return the notBefore of the certificate
+      */
       std::string start_time() const;
+
+      /**
+      * Get the notAfter of the certificate.
+      * @return the notAfter of the certificate
+      */
       std::string end_time() const;
 
+      /**
+      * Get the X509 version of this certificate object.
+      * @return the X509 version
+      */
       u32bit x509_version() const;
+
+      /**
+      * Get the serial number of this certificate.
+      * @return the certificates serial number
+      */
       MemoryVector<byte> serial_number() const;
 
+      /**
+      * Get the DER encoded AuthorityKeyIdentifier of this certificate.
+      * @return the DER encoded AuthorityKeyIdentifier
+      */
       MemoryVector<byte> authority_key_id() const;
+
+      /**
+      * Get the DER encoded SubjectKeyIdentifier of this certificate.
+      * @return the DER encoded SubjectKeyIdentifier
+      */
       MemoryVector<byte> subject_key_id() const;
+
+      /**
+      * Check whether this certificate is self signed.
+      * @return true if this certificate is self signed
+      */
       bool is_self_signed() const { return self_signed; }
+
+      /**
+      * Check whether this certificate is a CA certificate.
+      * @return true if this certificate is a CA certificate
+      */
       bool is_CA_cert() const;
 
+      /**
+      * Get the path limit as defined in the BasicConstraints extension of
+      * this certificate.
+      * @return the path limit
+      */
       u32bit path_limit() const;
+
+      /**
+      * Get the key constraints as defined in the KeyUsage extension of this
+      * certificate.
+      * @return the key constraints
+      */
       Key_Constraints constraints() const;
+
+      /**
+      * Get the key constraints as defined in the ExtendedKeyUsage
+      * extension of this
+      * certificate.
+      * @return the key constraints
+      */
       std::vector<std::string> ex_constraints() const;
-      std::vector<std::string> policies() const;
 
-      bool operator==(const X509_Certificate&) const;
+      /**
+      * Get the policies as defined in the CertificatePolicies extension
+      * of this certificate.
+      * @return the certificate policies
+      */
+      std::vector<std::string> policies() const;
 
-      X509_Certificate(DataSource&);
-      X509_Certificate(const std::string&);
+      /**
+      * Check to certificates for equality.
+      * @return true both certificates are (binary) equal
+      */
+      bool operator==(const X509_Certificate& other) const;
+
+      /**
+      * Create a certificate from a data source providing the DER or
+      * PEM encoded certificate.
+      * @param source the data source
+      */
+      X509_Certificate(DataSource& source);
+
+      /**
+      * Create a certificate from a file containing the DER or PEM
+      * encoded certificate.
+      * @param filename the name of the certificate file
+      */
+      X509_Certificate(const std::string& filename);
    private:
       void force_decode();
       friend class X509_CA;
@@ -56,9 +165,11 @@ class BOTAN_DLL X509_Certificate : public X509_Object
       bool self_signed;
    };
 
-/*************************************************
-* X.509 Certificate Comparison                   *
-*************************************************/
+/**
+* Check two certificates for inequality
+* @return true if the arguments represent different certificates,
+* false if they are binary identical
+*/
 BOTAN_DLL bool operator!=(const X509_Certificate&, const X509_Certificate&);
 
 /*************************************************