Remove LUT parent class.
[libdcp.git] / src / certificates.cc
index 085e462272130bd2b39c4d2878630a3211ec9c14..0a0393c652bdd6032c98c4a33d9f37a7eda804b6 100644 (file)
@@ -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
 
 */
 
-#include <sstream>
-#include <vector>
-#include <boost/algorithm/string.hpp>
-#include <openssl/x509.h>
-#include <openssl/ssl.h>
-#include <openssl/asn1.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)
        : _certificate (c)
+       , _public_key (0)
 {
        
 }
 
-Certificate::Certificate (string const & filename)
+/** 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.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)) {
@@ -56,13 +64,78 @@ Certificate::Certificate (string const & filename)
        }
 }
 
+/** Load an X509 certificate from a string.
+ *  @param cert String to read from.
+ */
+Certificate::Certificate (string cert)
+       : _certificate (0)
+       , _public_key (0)
+{
+       read_string (cert);
+}
+
+/** Copy constructor.
+ *  @param other Certificate to copy.
+ */
+Certificate::Certificate (Certificate const & other)
+       : _certificate (0)
+       , _public_key (0)
+{
+       read_string (other.certificate (true));
+}
+
+/** Read a certificate from a string.
+ *  @param cert String to read.
+ */
+void
+Certificate::read_string (string cert)
+{
+       BIO* bio = BIO_new_mem_buf (const_cast<char *> (cert.c_str ()), -1);
+       if (!bio) {
+               throw MiscError ("could not create memory BIO");
+       }
+
+       _certificate = PEM_read_bio_X509 (bio, 0, 0, 0);
+       if (!_certificate) {
+               throw MiscError ("could not read X509 certificate from memory BIO");
+       }
+
+       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)
+{
+       if (this == &other) {
+               return *this;
+       }
+
+       X509_free (_certificate);
+       _certificate = 0;
+       RSA_free (_public_key);
+       _public_key = 0;
+       
+       read_string (other.certificate ());
+
+       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 () const
+Certificate::certificate (bool with_begin_end) const
 {
        assert (_certificate);
        
@@ -82,11 +155,18 @@ Certificate::certificate () const
 
        BIO_free (bio);
 
-       boost::replace_all (s, "-----BEGIN CERTIFICATE-----\n", "");
-       boost::replace_all (s, "\n-----END CERTIFICATE-----\n", "");
+       if (!with_begin_end) {
+               boost::replace_all (s, "-----BEGIN CERTIFICATE-----\n", "");
+               boost::replace_all (s, "\n-----END CERTIFICATE-----\n", "");
+       }
+       
        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
 {
@@ -97,10 +177,10 @@ Certificate::issuer () const
 string
 Certificate::asn_to_utf8 (ASN1_STRING* s)
 {
-       unsigned char* buf = new unsigned char[256];
+       unsigned char* buf = 0;
        ASN1_STRING_to_UTF8 (&buf, s);
        string const u (reinterpret_cast<char *> (buf));
-       delete[] buf;
+       OPENSSL_free (buf);
        return u;
 }
 
@@ -139,6 +219,14 @@ Certificate::subject () const
        return name_for_xml (X509_get_subject_name (_certificate));
 }
 
+string
+Certificate::common_name () const
+{
+       assert (_certificate);
+
+       return get_name_part (X509_get_subject_name (_certificate), NID_commonName);
+}
+
 string
 Certificate::serial () const
 {
@@ -180,6 +268,30 @@ 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
+{
+       assert (_certificate);
+
+       if (_public_key) {
+               return _public_key;
+       }
+
+       EVP_PKEY* key = X509_get_pubkey (_certificate);
+       if (!key) {
+               throw MiscError ("could not get public key from certificate");
+       }
+
+       _public_key = EVP_PKEY_get1_RSA (key);
+       if (!_public_key) {
+               throw MiscError (String::compose ("could not get RSA public key (%1)", ERR_error_string (ERR_get_error(), 0)));
+       }
+
+       return _public_key;
+}
+
+/** @return Root certificate */
 shared_ptr<Certificate>
 CertificateChain::root () const
 {
@@ -187,6 +299,7 @@ CertificateChain::root () const
        return _certificates.front ();
 }
 
+/** @return Leaf certificate */
 shared_ptr<Certificate>
 CertificateChain::leaf () const
 {
@@ -194,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
 {
@@ -202,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)
 {