Try to fix comparison of encrypted sound assets.
[libdcp.git] / src / encrypted_kdm.cc
index 4d41a0664d927bd981e3ff16e2f2a035b59c9c8c..8ed0c3159c7ec8c955af77a430c5befdde93c4df 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2016 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 "encrypted_kdm.h"
 #include "util.h"
-#include "signer.h"
+#include "certificate_chain.h"
 #include <libcxml/cxml.h>
 #include <libxml++/document.h>
 #include <libxml++/nodes/element.h>
 #include <libxml/parser.h>
 #include <boost/date_time/posix_time/posix_time.hpp>
+#include <boost/foreach.hpp>
 
 using std::list;
+using std::vector;
 using std::string;
 using std::map;
 using std::pair;
 using boost::shared_ptr;
+using boost::optional;
 using namespace dcp;
 
 namespace dcp {
 
-/** Namespace for classes used to hold our data; they are internal to this .cc file */ 
+/** Namespace for classes used to hold our data; they are internal to this .cc file */
 namespace data {
 
 class Signer
 {
 public:
        Signer () {}
-       
+
        Signer (shared_ptr<const cxml::Node> node)
                : x509_issuer_name (node->string_child ("X509IssuerName"))
                , x509_serial_number (node->string_child ("X509SerialNumber"))
        {
-               
+
        }
 
        void as_xml (xmlpp::Element* node) const
@@ -55,7 +58,7 @@ public:
                node->add_child("X509IssuerName", "ds")->add_child_text (x509_issuer_name);
                node->add_child("X509SerialNumber", "ds")->add_child_text (x509_serial_number);
        }
-       
+
        string x509_issuer_name;
        string x509_serial_number;
 };
@@ -64,7 +67,7 @@ class X509Data
 {
 public:
        X509Data () {}
-       
+
        X509Data (boost::shared_ptr<const cxml::Node> node)
                : x509_issuer_serial (Signer (node->node_child ("X509IssuerSerial")))
                , x509_certificate (node->string_child ("X509Certificate"))
@@ -77,16 +80,16 @@ public:
                x509_issuer_serial.as_xml (node->add_child ("X509IssuerSerial", "ds"));
                node->add_child("X509Certificate", "ds")->add_child_text (x509_certificate);
        }
-       
+
        Signer x509_issuer_serial;
        std::string x509_certificate;
 };
-       
+
 class Reference
 {
 public:
        Reference () {}
-       
+
        Reference (string u)
                : uri (u)
        {}
@@ -97,14 +100,14 @@ public:
        {
 
        }
-       
+
        void as_xml (xmlpp::Element* node) const
        {
                node->set_attribute ("URI", uri);
                node->add_child("DigestMethod", "ds")->set_attribute ("Algorithm", "http://www.w3.org/2001/04/xmlenc#sha256");
                node->add_child("DigestValue", "ds")->add_child_text (digest_value);
        }
-       
+
        string uri;
        string digest_value;
 };
@@ -140,16 +143,16 @@ public:
                node->add_child ("SignatureMethod", "ds")->set_attribute (
                        "Algorithm", "http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"
                        );
-               
+
                authenticated_public.as_xml (node->add_child ("Reference", "ds"));
                authenticated_private.as_xml (node->add_child ("Reference", "ds"));
        }
-               
+
 private:
        Reference authenticated_public;
        Reference authenticated_private;
 };
-       
+
 class Signature
 {
 public:
@@ -169,7 +172,7 @@ public:
        {
                signed_info.as_xml (node->add_child ("SignedInfo", "ds"));
                node->add_child("SignatureValue", "ds")->add_child_text (signature_value);
-               
+
                xmlpp::Element* key_info_node = node->add_child ("KeyInfo", "ds");
                for (std::list<X509Data>::const_iterator i = x509_data.begin(); i != x509_data.end(); ++i) {
                        i->as_xml (key_info_node->add_child ("X509Data", "ds"));
@@ -185,7 +188,7 @@ class AuthenticatedPrivate
 {
 public:
        AuthenticatedPrivate () {}
-       
+
        AuthenticatedPrivate (shared_ptr<const cxml::Node> node)
        {
                list<shared_ptr<cxml::Node> > encrypted_key_nodes = node->node_children ("EncryptedKey");
@@ -200,15 +203,19 @@ public:
 
                for (list<string>::const_iterator i = encrypted_key.begin(); i != encrypted_key.end(); ++i) {
                        xmlpp::Element* encrypted_key = node->add_child ("EncryptedKey", "enc");
+                       /* XXX: hack for testing with Dolby */
+                       encrypted_key->set_namespace_declaration ("http://www.w3.org/2001/04/xmlenc#", "enc");
                        xmlpp::Element* encryption_method = encrypted_key->add_child ("EncryptionMethod", "enc");
                        encryption_method->set_attribute ("Algorithm", "http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p");
                        xmlpp::Element* digest_method = encryption_method->add_child ("DigestMethod", "ds");
+                       /* XXX: hack for testing with Dolby */
+                       digest_method->set_namespace_declaration ("http://www.w3.org/2000/09/xmldsig#", "ds");
                        digest_method->set_attribute ("Algorithm", "http://www.w3.org/2000/09/xmldsig#sha1");
                        xmlpp::Element* cipher_data = encrypted_key->add_child ("CipherData", "enc");
                        cipher_data->add_child("CipherValue", "enc")->add_child_text (*i);
                }
        }
-       
+
        list<string> encrypted_key;
 };
 
@@ -216,10 +223,10 @@ class TypedKeyId
 {
 public:
        TypedKeyId () {}
-       
+
        TypedKeyId (shared_ptr<const cxml::Node> node)
                : key_type (node->string_child ("KeyType"))
-               , key_id (node->string_child ("KeyId").substr (9))
+               , key_id (remove_urn_uuid (node->string_child ("KeyId")))
        {
 
        }
@@ -231,8 +238,13 @@ public:
 
        void as_xml (xmlpp::Element* node) const
        {
-               node->add_child("KeyType")->add_child_text (key_type);
+               xmlpp::Element* type = node->add_child("KeyType");
+               type->add_child_text (key_type);
                node->add_child("KeyId")->add_child_text ("urn:uuid:" + key_id);
+               /* XXX: this feels like a bit of a hack */
+               if (key_type == "MDEK") {
+                       type->set_attribute ("scope", "http://www.dolby.com/cp850/2012/KDM#kdm-key-type");
+               }
        }
 
        string key_type;
@@ -243,7 +255,7 @@ class KeyIdList
 {
 public:
        KeyIdList () {}
-       
+
        KeyIdList (shared_ptr<const cxml::Node> node)
        {
                list<shared_ptr<cxml::Node> > typed_key_id_nodes = node->node_children ("TypedKeyId");
@@ -266,34 +278,39 @@ class AuthorizedDeviceInfo
 {
 public:
        AuthorizedDeviceInfo () {}
-       
+
        AuthorizedDeviceInfo (shared_ptr<const cxml::Node> node)
-               : device_list_identifier (node->string_child ("DeviceListIdentifier").substr (9))
-               , device_list_description (node->string_child ("DeviceListDescription"))
-               , certificate_thumbprint (node->node_child("DeviceList")->string_child ("CertificateThumbprint"))
+               : device_list_identifier (remove_urn_uuid (node->string_child ("DeviceListIdentifier")))
+               , device_list_description (node->optional_string_child ("DeviceListDescription"))
        {
-
+               BOOST_FOREACH (cxml::ConstNodePtr i, node->node_child("DeviceList")->node_children("CertificateThumbprint")) {
+                       certificate_thumbprints.push_back (i->content ());
+               }
        }
 
        void as_xml (xmlpp::Element* node) const
        {
                node->add_child ("DeviceListIdentifier")->add_child_text ("urn:uuid:" + device_list_identifier);
-               node->add_child ("DeviceListDescription")->add_child_text (device_list_description);
+               if (device_list_description) {
+                       node->add_child ("DeviceListDescription")->add_child_text (device_list_description.get());
+               }
                xmlpp::Element* device_list = node->add_child ("DeviceList");
-               device_list->add_child("CertificateThumbprint")->add_child_text (certificate_thumbprint);
+               BOOST_FOREACH (string i, certificate_thumbprints) {
+                       device_list->add_child("CertificateThumbprint")->add_child_text (i);
+               }
        }
 
        /** DeviceListIdentifier without the urn:uuid: prefix */
        string device_list_identifier;
-       string device_list_description;
-       string certificate_thumbprint;
+       boost::optional<string> device_list_description;
+       std::list<string> certificate_thumbprints;
 };
 
 class X509IssuerSerial
 {
 public:
        X509IssuerSerial () {}
-       
+
        X509IssuerSerial (shared_ptr<const cxml::Node> node)
                : x509_issuer_name (node->string_child ("X509IssuerName"))
                , x509_serial_number (node->string_child ("X509SerialNumber"))
@@ -315,7 +332,7 @@ class Recipient
 {
 public:
        Recipient () {}
-       
+
        Recipient (shared_ptr<const cxml::Node> node)
                : x509_issuer_serial (node->node_child ("X509IssuerSerial"))
                , x509_subject_name (node->string_child ("X509SubjectName"))
@@ -328,7 +345,7 @@ public:
                x509_issuer_serial.as_xml (node->add_child ("X509IssuerSerial"));
                node->add_child("X509SubjectName")->add_child_text (x509_subject_name);
        }
-       
+
        X509IssuerSerial x509_issuer_serial;
        string x509_subject_name;
 };
@@ -337,10 +354,10 @@ class KDMRequiredExtensions
 {
 public:
        KDMRequiredExtensions () {}
-       
+
        KDMRequiredExtensions (shared_ptr<const cxml::Node> node)
                : recipient (node->node_child ("Recipient"))
-               , composition_playlist_id (node->string_child ("CompositionPlaylistId").substr (9))
+               , composition_playlist_id (remove_urn_uuid (node->string_child ("CompositionPlaylistId")))
                , content_title_text (node->string_child ("ContentTitleText"))
                , not_valid_before (node->string_child ("ContentKeysNotValidBefore"))
                , not_valid_after (node->string_child ("ContentKeysNotValidAfter"))
@@ -353,23 +370,23 @@ public:
        void as_xml (xmlpp::Element* node) const
        {
                node->set_attribute ("xmlns", "http://www.smpte-ra.org/schemas/430-1/2006/KDM");
-               
+
                recipient.as_xml (node->add_child ("Recipient"));
                node->add_child("CompositionPlaylistId")->add_child_text ("urn:uuid:" + composition_playlist_id);
+               node->add_child("ContentTitleText")->add_child_text (content_title_text);
                if (content_authenticator) {
                        node->add_child("ContentAuthenticator")->add_child_text (content_authenticator.get ());
                }
-               node->add_child("ContentTitleText")->add_child_text (content_title_text);
                node->add_child("ContentKeysNotValidBefore")->add_child_text (not_valid_before.as_string ());
                node->add_child("ContentKeysNotValidAfter")->add_child_text (not_valid_after.as_string ());
                authorized_device_info.as_xml (node->add_child ("AuthorizedDeviceInfo"));
                key_id_list.as_xml (node->add_child ("KeyIdList"));
-               
+
                xmlpp::Element* forensic_mark_flag_list = node->add_child ("ForensicMarkFlagList");
                forensic_mark_flag_list->add_child("ForensicMarkFlag")->add_child_text ("http://www.smpte-ra.org/430-1/2006/KDM#mrkflg-picture-disable");
                forensic_mark_flag_list->add_child("ForensicMarkFlag")->add_child_text ("http://www.smpte-ra.org/430-1/2006/KDM#mrkflg-audio-disable");
        }
-       
+
        Recipient recipient;
        string composition_playlist_id;
        boost::optional<string> content_authenticator;
@@ -384,7 +401,7 @@ class RequiredExtensions
 {
 public:
        RequiredExtensions () {}
-       
+
        RequiredExtensions (shared_ptr<const cxml::Node> node)
                : kdm_required_extensions (node->node_child ("KDMRequiredExtensions"))
        {
@@ -395,7 +412,7 @@ public:
        {
                kdm_required_extensions.as_xml (node->add_child ("KDMRequiredExtensions"));
        }
-       
+
        KDMRequiredExtensions kdm_required_extensions;
 };
 
@@ -404,12 +421,14 @@ class AuthenticatedPublic
 public:
        AuthenticatedPublic ()
                : message_id (make_uuid ())
+                 /* XXX: hack for Dolby to see if there must be a not-empty annotation text */
+               , annotation_text ("none")
                , issue_date (LocalTime().as_string ())
        {}
-       
+
        AuthenticatedPublic (shared_ptr<const cxml::Node> node)
-               : message_id (node->string_child ("MessageId").substr (9))
-               , annotation_text (node->string_child ("AnnotationText"))
+               : message_id (remove_urn_uuid (node->string_child ("MessageId")))
+               , annotation_text (node->optional_string_child ("AnnotationText"))
                , issue_date (node->string_child ("IssueDate"))
                , signer (node->node_child ("Signer"))
                , required_extensions (node->node_child ("RequiredExtensions"))
@@ -420,10 +439,12 @@ public:
        void as_xml (xmlpp::Element* node, map<string, xmlpp::Attribute *>& references) const
        {
                references["ID_AuthenticatedPublic"] = node->set_attribute ("Id", "ID_AuthenticatedPublic");
-               
+
                node->add_child("MessageId")->add_child_text ("urn:uuid:" + message_id);
                node->add_child("MessageType")->add_child_text ("http://www.smpte-ra.org/430-1/2006/KDM#kdm-key-type");
-               node->add_child("AnnotationText")->add_child_text (annotation_text);
+               if (annotation_text) {
+                       node->add_child("AnnotationText")->add_child_text (annotation_text.get ());
+               }
                node->add_child("IssueDate")->add_child_text (issue_date);
 
                signer.as_xml (node->add_child ("Signer"));
@@ -433,7 +454,7 @@ public:
        }
 
        string message_id;
-       string annotation_text;
+       optional<string> annotation_text;
        string issue_date;
        Signer signer;
        RequiredExtensions required_extensions;
@@ -449,13 +470,13 @@ public:
        {
 
        }
-       
+
        EncryptedKDMData (shared_ptr<const cxml::Node> node)
                : authenticated_public (node->node_child ("AuthenticatedPublic"))
                , authenticated_private (node->node_child ("AuthenticatedPrivate"))
                , signature (node->node_child ("Signature"))
        {
-               
+
        }
 
        shared_ptr<xmlpp::Document> as_xml () const
@@ -492,8 +513,9 @@ EncryptedKDM::EncryptedKDM (string s)
 }
 
 EncryptedKDM::EncryptedKDM (
-       shared_ptr<const Signer> signer,
+       shared_ptr<const CertificateChain> signer,
        Certificate recipient,
+       vector<Certificate> trusted_devices,
        string device_list_description,
        string cpl_id,
        string content_title_text,
@@ -506,10 +528,10 @@ EncryptedKDM::EncryptedKDM (
        : _data (new data::EncryptedKDMData)
 {
        /* Fill our XML-ish description in with the juicy bits that the caller has given */
-       
+
        data::AuthenticatedPublic& aup = _data->authenticated_public;
-       aup.signer.x509_issuer_name = signer->certificates().leaf().issuer ();
-       aup.signer.x509_serial_number = signer->certificates().leaf().serial ();
+       aup.signer.x509_issuer_name = signer->leaf().issuer ();
+       aup.signer.x509_serial_number = signer->leaf().serial ();
 
        data::KDMRequiredExtensions& kre = _data->authenticated_public.required_extensions.kdm_required_extensions;
        kre.recipient.x509_issuer_serial.x509_issuer_name = recipient.issuer ();
@@ -518,13 +540,13 @@ EncryptedKDM::EncryptedKDM (
        kre.authorized_device_info.device_list_description = device_list_description;
        kre.composition_playlist_id = cpl_id;
        if (formulation == DCI_ANY || formulation == DCI_SPECIFIC) {
-               kre.content_authenticator = signer->certificates().leaf().thumbprint ();
+               kre.content_authenticator = signer->leaf().thumbprint ();
        }
        kre.content_title_text = content_title_text;
        kre.not_valid_before = not_valid_before;
        kre.not_valid_after = not_valid_after;
        kre.authorized_device_info.device_list_identifier = make_uuid ();
-       string n = recipient.common_name ();
+       string n = recipient.subject_common_name ();
        if (n.find (".") != string::npos) {
                n = n.substr (n.find (".") + 1);
        }
@@ -532,10 +554,17 @@ EncryptedKDM::EncryptedKDM (
 
        if (formulation == MODIFIED_TRANSITIONAL_1 || formulation == DCI_ANY) {
                /* Use the "assume trust" thumbprint */
-               kre.authorized_device_info.certificate_thumbprint = "2jmj7l5rSw0yVb/vlWAYkK/YBwk=";
+               kre.authorized_device_info.certificate_thumbprints.push_back ("2jmj7l5rSw0yVb/vlWAYkK/YBwk=");
        } else if (formulation == DCI_SPECIFIC) {
-               /* Use the recipient thumbprint */
-               kre.authorized_device_info.certificate_thumbprint = recipient.thumbprint ();
+               /* As I read the standard we should use the recipient
+                  /and/ other trusted device thumbprints here.  MJD
+                  reports that this doesn't work with his setup;
+                  a working KDM does not include the recipient's
+                  thumbprint (recipient.thumbprint()).
+               */
+               BOOST_FOREACH (Certificate const & i, trusted_devices) {
+                       kre.authorized_device_info.certificate_thumbprints.push_back (i.thumbprint ());
+               }
        }
 
        for (list<pair<string, string> >::const_iterator i = key_ids.begin(); i != key_ids.end(); ++i) {
@@ -589,15 +618,10 @@ EncryptedKDM::as_xml (boost::filesystem::path path) const
        fwrite (x.c_str(), 1, x.length(), f);
        fclose (f);
 }
-       
+
 string
 EncryptedKDM::as_xml () const
 {
-       xmlpp::Document document;
-       xmlpp::Element* root = document.create_root_node ("DCinemaSecurityMessage", "http://www.smpte-ra.org/schemas/430-3/2006/ETM");
-       root->set_namespace_declaration ("http://www.w3.org/2000/09/xmldsig#", "ds");
-       root->set_namespace_declaration ("http://www.w3.org/2001/04/xmlenc#", "enc");
-
        return _data->as_xml()->write_to_string ("UTF-8");
 }
 
@@ -606,3 +630,34 @@ EncryptedKDM::keys () const
 {
        return _data->authenticated_private.encrypted_key;
 }
+
+optional<string>
+EncryptedKDM::annotation_text () const
+{
+       return _data->authenticated_public.annotation_text;
+}
+
+string
+EncryptedKDM::content_title_text () const
+{
+       return _data->authenticated_public.required_extensions.kdm_required_extensions.content_title_text;
+}
+
+string
+EncryptedKDM::cpl_id () const
+{
+       return _data->authenticated_public.required_extensions.kdm_required_extensions.composition_playlist_id;
+}
+
+string
+EncryptedKDM::issue_date () const
+{
+       return _data->authenticated_public.issue_date;
+}
+
+bool
+dcp::operator== (EncryptedKDM const & a, EncryptedKDM const & b)
+{
+       /* Not exactly efficient... */
+       return a.as_xml() == b.as_xml();
+}