Rename a couple of Certificate methods and add accessors for organization and organiz...
[libdcp.git] / src / certificates.cc
index 6d9c449dab371f2995a46ca2a64d23b5c59a6a21..e5acdd253a4f0f26d3c7b5b3b252f049352be179 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 "dcp_assert.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>
+#include <algorithm>
 
 using std::list;
 using std::string;
-using std::stringstream;
-using std::vector;
-using boost::shared_ptr;
-using namespace libdcp;
+using std::ostream;
+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 (boost::filesystem::path filename)
-       : _certificate (0)
-{
-       FILE* f = fopen (filename.c_str(), "r");
-       if (!f) {
-               throw FileError ("could not open file", filename);
-       }
-       
-       if (!PEM_read_X509 (f, &_certificate, 0, 0)) {
-               throw MiscError ("could not read X509 certificate");
-       }
 }
 
+/** 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)
 {
@@ -82,34 +88,47 @@ 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)
 {
        if (this == &other) {
                return *this;
        }
-       
+
        X509_free (_certificate);
-       read_string (other.certificate ());
+       _certificate = 0;
+       RSA_free (_public_key);
+       _public_key = 0;
+
+       read_string (other.certificate (true));
 
        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
 {
-       assert (_certificate);
-       
+       DCP_ASSERT (_certificate);
+
        BIO* bio = BIO_new (BIO_s_mem ());
        if (!bio) {
                throw MiscError ("could not create memory BIO");
        }
-       
+
        PEM_write_bio_X509 (bio, _certificate);
 
        string s;
@@ -125,14 +144,18 @@ Certificate::certificate (bool with_begin_end) const
                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
 {
-       assert (_certificate);
+       DCP_ASSERT (_certificate);
        return name_for_xml (X509_get_issuer_name (_certificate));
 }
 
@@ -151,48 +174,78 @@ Certificate::get_name_part (X509_NAME* n, int nid)
 {
        int p = -1;
        p = X509_NAME_get_index_by_NID (n, nid, p);
-       assert (p != -1);
+       DCP_ASSERT (p != -1);
        return asn_to_utf8 (X509_NAME_ENTRY_get_data (X509_NAME_get_entry (n, p)));
 }
-       
 
 string
-Certificate::name_for_xml (X509_NAME * n)
-{
-       assert (n);
-
-       string s = String::compose (
-               "dnQualifier=%1,CN=%2,OU=%3,O=%4",
-               get_name_part (n, NID_dnQualifier),
-               get_name_part (n, NID_commonName),
-               get_name_part (n, NID_organizationalUnitName),
-               get_name_part (n, NID_organizationName)
-               );
-       
-       boost::replace_all (s, "+", "\\+");
+Certificate::name_for_xml (X509_NAME* name)
+{
+       assert (name);
+
+       BIO* bio = BIO_new (BIO_s_mem ());
+       if (!bio) {
+               throw MiscError ("could not create memory BIO");
+       }
+
+       X509_NAME_print_ex (bio, name, 0, XN_FLAG_RFC2253);
+       int n = BIO_pending (bio);
+       char* result = new char[n + 1];
+       n = BIO_read (bio, result, n);
+       result[n] = '\0';
+
+       BIO_free (bio);
+
+       string s = result;
+       delete[] result;
+
        return s;
 }
 
 string
 Certificate::subject () const
 {
-       assert (_certificate);
+       DCP_ASSERT (_certificate);
 
        return name_for_xml (X509_get_subject_name (_certificate));
 }
 
+string
+Certificate::subject_common_name () const
+{
+       DCP_ASSERT (_certificate);
+
+       return get_name_part (X509_get_subject_name (_certificate), NID_commonName);
+}
+
+string
+Certificate::subject_organization_name () const
+{
+       DCP_ASSERT (_certificate);
+
+       return get_name_part (X509_get_subject_name (_certificate), NID_organizationName);
+}
+
+string
+Certificate::subject_organizational_unit_name () const
+{
+       DCP_ASSERT (_certificate);
+
+       return get_name_part (X509_get_subject_name (_certificate), NID_organizationalUnitName);
+}
+
 string
 Certificate::serial () const
 {
-       assert (_certificate);
+       DCP_ASSERT (_certificate);
 
        ASN1_INTEGER* s = X509_get_serialNumber (_certificate);
-       assert (s);
-       
+       DCP_ASSERT (s);
+
        BIGNUM* b = ASN1_INTEGER_to_BN (s, 0);
        char* c = BN_bn2dec (b);
        BN_free (b);
-       
+
        string st (c);
        OPENSSL_free (c);
 
@@ -202,13 +255,13 @@ Certificate::serial () const
 string
 Certificate::thumbprint () const
 {
-       assert (_certificate);
-       
+       DCP_ASSERT (_certificate);
+
        uint8_t buffer[8192];
        uint8_t* p = buffer;
        i2d_X509_CINF (_certificate->cert_info, &p);
-       int const length = p - buffer;
-       if (length > 8192) {
+       unsigned int const length = p - buffer;
+       if (length > sizeof (buffer)) {
                throw MiscError ("buffer too small to generate thumbprint");
        }
 
@@ -222,30 +275,180 @@ Certificate::thumbprint () const
        return Kumu::base64encode (digest, 20, digest_base64, 64);
 }
 
-shared_ptr<Certificate>
+/** @return RSA public key from this Certificate.  Caller must not free the returned value. */
+RSA *
+Certificate::public_key () const
+{
+       DCP_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;
+}
+
+bool
+dcp::operator== (Certificate const & a, Certificate const & b)
+{
+       return a.certificate() == b.certificate();
+}
+
+bool
+dcp::operator< (Certificate const & a, Certificate const & b)
+{
+       return a.certificate() < b.certificate();
+}
+
+ostream&
+dcp::operator<< (ostream& s, Certificate const & c)
+{
+       s << c.certificate();
+       return s;
+}
+
+/** @return Root certificate */
+Certificate
 CertificateChain::root () const
 {
-       assert (!_certificates.empty());
+       DCP_ASSERT (!_certificates.empty());
        return _certificates.front ();
 }
 
-shared_ptr<Certificate>
+/** @return Leaf certificate */
+Certificate
 CertificateChain::leaf () const
 {
-       assert (_certificates.size() >= 2);
+       DCP_ASSERT (_certificates.size() >= 2);
        return _certificates.back ();
 }
 
-list<shared_ptr<Certificate> >
+/** @return Certificates in order from root to leaf */
+CertificateChain::List
+CertificateChain::root_to_leaf () const
+{
+       return _certificates;
+}
+
+/** @return Certificates in order from leaf to root */
+CertificateChain::List
 CertificateChain::leaf_to_root () const
 {
-       list<shared_ptr<Certificate> > c = _certificates;
+       List c = _certificates;
        c.reverse ();
        return c;
 }
 
+/** Add a certificate to the end of the chain.
+ *  @param c Certificate to add.
+ */
 void
-CertificateChain::add (shared_ptr<Certificate> c)
+CertificateChain::add (Certificate c)
 {
        _certificates.push_back (c);
 }
+
+/** Remove a certificate from the chain.
+ *  @param c Certificate to remove.
+ */
+void
+CertificateChain::remove (Certificate c)
+{
+       _certificates.remove (c);
+}
+
+/** Remove the i'th certificate in the list, as listed
+ *  from root to leaf.
+ */
+void
+CertificateChain::remove (int i)
+{
+       List::iterator j = _certificates.begin ();
+        while (j != _certificates.end () && i > 0) {
+               --i;
+               ++j;
+       }
+
+       if (j != _certificates.end ()) {
+               _certificates.erase (j);
+       }
+}
+
+/** Check to see if the chain is valid (i.e. root signs the intermediate, intermediate
+ *  signs the leaf and so on).
+ *  @return true if it's ok, false if not.
+ */
+bool
+CertificateChain::valid () const
+{
+       X509_STORE* store = X509_STORE_new ();
+       if (!store) {
+               return false;
+       }
+
+       for (List::const_iterator i = _certificates.begin(); i != _certificates.end(); ++i) {
+
+               List::const_iterator j = i;
+               ++j;
+               if (j ==  _certificates.end ()) {
+                       break;
+               }
+
+               if (!X509_STORE_add_cert (store, i->x509 ())) {
+                       X509_STORE_free (store);
+                       return false;
+               }
+
+               X509_STORE_CTX* ctx = X509_STORE_CTX_new ();
+               if (!ctx) {
+                       X509_STORE_free (store);
+                       return false;
+               }
+
+               X509_STORE_set_flags (store, 0);
+               if (!X509_STORE_CTX_init (ctx, store, j->x509 (), 0)) {
+                       X509_STORE_CTX_free (ctx);
+                       X509_STORE_free (store);
+                       return false;
+               }
+
+               int v = X509_verify_cert (ctx);
+               X509_STORE_CTX_free (ctx);
+
+               if (v == 0) {
+                       X509_STORE_free (store);
+                       return false;
+               }
+       }
+
+       X509_STORE_free (store);
+       return true;
+}
+
+/** @return true if the chain is now in order from root to leaf,
+ *  false if no correct order was found.
+ */
+bool
+CertificateChain::attempt_reorder ()
+{
+       List original = _certificates;
+       _certificates.sort ();
+       do {
+               if (valid ()) {
+                       return true;
+               }
+       } while (std::next_permutation (_certificates.begin(), _certificates.end ()));
+
+       _certificates = original;
+       return false;
+}