Comment fixes.

[libdcp.git] / src / certificates.h

diff --git a/src/certificates.h b/src/certificates.h
index 9caea5a786cd8e8a15e1acde2c8c48922c27079d..aba6d5cfa2b8f1534c44638884f7834bef99df87 100644 (file)
--- a/src/certificates.h
+++ b/src/certificates.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -17,15 +17,19 @@
 
 */
 
+/** @file  src/certificates.h
+ *  @brief Certificate and CertificateChain classes.
+ */
+
 #ifndef LIBDCP_CERTIFICATES_H
 #define LIBDCP_CERTIFICATES_H
 
-#include <string>
-#include <list>
-#include <boost/noncopyable.hpp>
-#include <boost/shared_ptr.hpp>
 #undef X509_NAME
 #include <openssl/x509.h>
+#include <boost/shared_ptr.hpp>
+#include <boost/filesystem.hpp>
+#include <string>
+#include <list>
 
 class certificates;
 
@@ -33,49 +37,79 @@ namespace xmlpp {
        class Element;
 }
 
-namespace libdcp {
+namespace dcp {
 
-class Certificate : public boost::noncopyable
+/** @class Certificate
+ *  @brief A wrapper for an X509 certificate.
+ *
+ *  This class can take a Certificate from a string or an OpenSSL X509 object.
+ */
+class Certificate
 {
 public:
        Certificate ()
                : _certificate (0)
        {}
 
-       Certificate (std::string const &);
+       Certificate (std::string);
        Certificate (X509 *);
+       Certificate (Certificate const &);
        ~Certificate ();
 
-       std::string certificate () const;
+       Certificate& operator= (Certificate const &);
+
+       std::string certificate (bool with_begin_end = false) const;
        std::string issuer () const;
        std::string serial () const;
        std::string subject () const;
+       std::string common_name () const;
+
+       X509* x509 () const {
+               return _certificate;
+       }
+
+       RSA* public_key () const;
 
        std::string thumbprint () const;
 
 private:
+       void read_string (std::string);
+       
        static std::string name_for_xml (X509_NAME *);
        static std::string asn_to_utf8 (ASN1_STRING *);
        static std::string get_name_part (X509_NAME *, int);
 
        X509* _certificate;
+       mutable RSA* _public_key;
 };
 
+/** @class CertificateChain
+ *  @brief A chain of any number of certificates, from root to leaf.
+ */
 class CertificateChain
 {
 public:
        CertificateChain () {}
 
-       void add (boost::shared_ptr<Certificate>);
+       void add (boost::shared_ptr<const Certificate> c);
+       void remove (boost::shared_ptr<const Certificate> c);
+       void remove (int);
+
+       boost::shared_ptr<const Certificate> root () const;
+       boost::shared_ptr<const Certificate> leaf () const;
 
-       boost::shared_ptr<Certificate> root () const;
-       boost::shared_ptr<Certificate> leaf () const;
+       typedef std::list<boost::shared_ptr<const Certificate> > List;
+       
+       List leaf_to_root () const;
+       List root_to_leaf () const;
 
-       std::list<boost::shared_ptr<Certificate> > leaf_to_root () const;
+       bool valid () const;
+       bool attempt_reorder ();
 
 private:
        friend class ::certificates;
-       std::list<boost::shared_ptr<Certificate> > _certificates;
+
+       List _certificates;
 };
 
 }