Remove LUT parent class.

[libdcp.git] / src / certificates.cc

diff --git a/src/certificates.cc b/src/certificates.cc
index 818d5f7252810840ad8521a896ca71b4a333ae01..0a0393c652bdd6032c98c4a33d9f37a7eda804b6 100644 (file)
--- a/src/certificates.cc
+++ b/src/certificates.cc
@@ -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,25 +17,27 @@
 
 */
 
-#include <sstream>
-#include <vector>
-#include <boost/algorithm/string.hpp>
-#include <openssl/x509.h>
-#include <openssl/ssl.h>
-#include <openssl/asn1.h>
-#include <openssl/err.h>
-#include <libxml++/nodes/element.h>
+/** @file  src/certificates.cc
+ *  @brief Certificate and CertificateChain classes.
+ */
+
 #include "KM_util.h"
 #include "certificates.h"
 #include "compose.hpp"
 #include "exceptions.h"
+#include "util.h"
+#include <libxml++/nodes/element.h>
+#include <openssl/x509.h>
+#include <openssl/ssl.h>
+#include <openssl/asn1.h>
+#include <openssl/err.h>
+#include <boost/algorithm/string.hpp>
+#include <cerrno>
 
 using std::list;
 using std::string;
-using std::stringstream;
-using std::vector;
 using boost::shared_ptr;
-using namespace libdcp;
+using namespace dcp;
 
 /** @param c X509 certificate, which this object will take ownership of */
 Certificate::Certificate (X509* c)
@@ -45,13 +47,16 @@ Certificate::Certificate (X509* c)
        
 }
 
+/** Load an X509 certificate from a file.
+ *  @param filename File to load.
+ */
 Certificate::Certificate (boost::filesystem::path filename)
        : _certificate (0)
        , _public_key (0)
 {
-       FILE* f = fopen (filename.string().c_str(), "r");
+       FILE* f = fopen_boost (filename, "r");
        if (!f) {
-               throw FileError ("could not open file", filename);
+               throw FileError ("could not open file", filename, errno);
        }
        
        if (!PEM_read_X509 (f, &_certificate, 0, 0)) {
@@ -59,6 +64,9 @@ Certificate::Certificate (boost::filesystem::path filename)
        }
 }
 
+/** Load an X509 certificate from a string.
+ *  @param cert String to read from.
+ */
 Certificate::Certificate (string cert)
        : _certificate (0)
        , _public_key (0)
@@ -66,6 +74,9 @@ Certificate::Certificate (string cert)
        read_string (cert);
 }
 
+/** Copy constructor.
+ *  @param other Certificate to copy.
+ */
 Certificate::Certificate (Certificate const & other)
        : _certificate (0)
        , _public_key (0)
@@ -73,6 +84,9 @@ Certificate::Certificate (Certificate const & other)
        read_string (other.certificate (true));
 }
 
+/** Read a certificate from a string.
+ *  @param cert String to read.
+ */
 void
 Certificate::read_string (string cert)
 {
@@ -89,12 +103,16 @@ Certificate::read_string (string cert)
        BIO_free (bio);
 }
 
+/** Destructor */
 Certificate::~Certificate ()
 {
        X509_free (_certificate);
        RSA_free (_public_key);
 }
 
+/** operator= for Certificate.
+ *  @param other Certificate to read from.
+ */
 Certificate &
 Certificate::operator= (Certificate const & other)
 {
@@ -112,6 +130,10 @@ Certificate::operator= (Certificate const & other)
        return *this;
 }
 
+/** Return the certificate as a string.
+ *  @param with_begin_end true to include the -----BEGIN CERTIFICATE--- / -----END CERTIFICATE----- markers.
+ *  @return Certificate string.
+ */
 string
 Certificate::certificate (bool with_begin_end) const
 {
@@ -141,6 +163,10 @@ Certificate::certificate (bool with_begin_end) const
        return s;
 }
 
+/** @return Certificate's issuer, in the form
+ *  dnqualifier=&lt;dnQualififer&gt;,CN=&lt;commonName&gt;,OU=&lt;organizationalUnitName&gt,O=&lt;organizationName&gt;
+ *  and with + signs escaped to \+
+ */
 string
 Certificate::issuer () const
 {
@@ -242,6 +268,7 @@ Certificate::thumbprint () const
        return Kumu::base64encode (digest, 20, digest_base64, 64);
 }
 
+/** @return RSA public key from this Certificate.  Caller must not free the returned value. */
 RSA *
 Certificate::public_key () const
 {
@@ -264,6 +291,7 @@ Certificate::public_key () const
        return _public_key;
 }
 
+/** @return Root certificate */
 shared_ptr<Certificate>
 CertificateChain::root () const
 {
@@ -271,6 +299,7 @@ CertificateChain::root () const
        return _certificates.front ();
 }
 
+/** @return Leaf certificate */
 shared_ptr<Certificate>
 CertificateChain::leaf () const
 {
@@ -278,6 +307,7 @@ CertificateChain::leaf () const
        return _certificates.back ();
 }
 
+/** @return Certificates in order from leaf to root */
 list<shared_ptr<Certificate> >
 CertificateChain::leaf_to_root () const
 {
@@ -286,6 +316,9 @@ CertificateChain::leaf_to_root () const
        return c;
 }
 
+/** Add a certificate to the end of the chain.
+ *  @param c Certificate to add.
+ */
 void
 CertificateChain::add (shared_ptr<Certificate> c)
 {