Add some explicit declarations to constructors.
[libdcp.git] / src / encrypted_kdm.cc
index 5b596b80baac7864f9b10762e31508bacb35db81..c6ba444faaacfb3fceb5f2b8999a14a3f7522b95 100644 (file)
@@ -1,20 +1,20 @@
 /*
-    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
+    This file is part of libdcp.
+
+    libdcp is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    libdcp is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
+    along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "encrypted_kdm.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 {
@@ -43,7 +46,7 @@ class Signer
 public:
        Signer () {}
 
-       Signer (shared_ptr<const cxml::Node> node)
+       explicit Signer (shared_ptr<const cxml::Node> node)
                : x509_issuer_name (node->string_child ("X509IssuerName"))
                , x509_serial_number (node->string_child ("X509SerialNumber"))
        {
@@ -65,7 +68,7 @@ class X509Data
 public:
        X509Data () {}
 
-       X509Data (boost::shared_ptr<const cxml::Node> node)
+       explicit X509Data (boost::shared_ptr<const cxml::Node> node)
                : x509_issuer_serial (Signer (node->node_child ("X509IssuerSerial")))
                , x509_certificate (node->string_child ("X509Certificate"))
        {
@@ -87,11 +90,11 @@ class Reference
 public:
        Reference () {}
 
-       Reference (string u)
+       explicit Reference (string u)
                : uri (u)
        {}
 
-       Reference (shared_ptr<const cxml::Node> node)
+       explicit Reference (shared_ptr<const cxml::Node> node)
                : uri (node->string_attribute ("URI"))
                , digest_value (node->string_child ("DigestValue"))
        {
@@ -117,7 +120,7 @@ public:
                , authenticated_private ("#ID_AuthenticatedPrivate")
        {}
 
-       SignedInfo (shared_ptr<const cxml::Node> node)
+       explicit SignedInfo (shared_ptr<const cxml::Node> node)
        {
                list<shared_ptr<cxml::Node> > references = node->node_children ("Reference");
                for (list<shared_ptr<cxml::Node> >::const_iterator i = references.begin(); i != references.end(); ++i) {
@@ -155,7 +158,7 @@ class Signature
 public:
        Signature () {}
 
-       Signature (shared_ptr<const cxml::Node> node)
+       explicit Signature (shared_ptr<const cxml::Node> node)
                : signed_info (node->node_child ("SignedInfo"))
                , signature_value (node->string_child ("SignatureValue"))
        {
@@ -186,7 +189,7 @@ class AuthenticatedPrivate
 public:
        AuthenticatedPrivate () {}
 
-       AuthenticatedPrivate (shared_ptr<const cxml::Node> node)
+       explicit AuthenticatedPrivate (shared_ptr<const cxml::Node> node)
        {
                list<shared_ptr<cxml::Node> > encrypted_key_nodes = node->node_children ("EncryptedKey");
                for (list<shared_ptr<cxml::Node> >::const_iterator i = encrypted_key_nodes.begin(); i != encrypted_key_nodes.end(); ++i) {
@@ -200,9 +203,13 @@ 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);
@@ -217,9 +224,9 @@ class TypedKeyId
 public:
        TypedKeyId () {}
 
-       TypedKeyId (shared_ptr<const cxml::Node> node)
+       explicit 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;
@@ -244,7 +256,7 @@ class KeyIdList
 public:
        KeyIdList () {}
 
-       KeyIdList (shared_ptr<const cxml::Node> node)
+       explicit KeyIdList (shared_ptr<const cxml::Node> node)
        {
                list<shared_ptr<cxml::Node> > typed_key_id_nodes = node->node_children ("TypedKeyId");
                for (list<shared_ptr<cxml::Node> >::const_iterator i = typed_key_id_nodes.begin(); i != typed_key_id_nodes.end(); ++i) {
@@ -267,12 +279,13 @@ class AuthorizedDeviceInfo
 public:
        AuthorizedDeviceInfo () {}
 
-       AuthorizedDeviceInfo (shared_ptr<const cxml::Node> node)
-               : device_list_identifier (node->string_child ("DeviceListIdentifier").substr (9))
+       explicit AuthorizedDeviceInfo (shared_ptr<const cxml::Node> node)
+               : device_list_identifier (remove_urn_uuid (node->string_child ("DeviceListIdentifier")))
                , device_list_description (node->optional_string_child ("DeviceListDescription"))
-               , certificate_thumbprint (node->node_child("DeviceList")->string_child ("CertificateThumbprint"))
        {
-
+               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
@@ -282,13 +295,15 @@ public:
                        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;
        boost::optional<string> device_list_description;
-       string certificate_thumbprint;
+       std::list<string> certificate_thumbprints;
 };
 
 class X509IssuerSerial
@@ -296,7 +311,7 @@ class X509IssuerSerial
 public:
        X509IssuerSerial () {}
 
-       X509IssuerSerial (shared_ptr<const cxml::Node> node)
+       explicit X509IssuerSerial (shared_ptr<const cxml::Node> node)
                : x509_issuer_name (node->string_child ("X509IssuerName"))
                , x509_serial_number (node->string_child ("X509SerialNumber"))
        {
@@ -318,7 +333,7 @@ class Recipient
 public:
        Recipient () {}
 
-       Recipient (shared_ptr<const cxml::Node> node)
+       explicit Recipient (shared_ptr<const cxml::Node> node)
                : x509_issuer_serial (node->node_child ("X509IssuerSerial"))
                , x509_subject_name (node->string_child ("X509SubjectName"))
        {
@@ -340,9 +355,9 @@ class KDMRequiredExtensions
 public:
        KDMRequiredExtensions () {}
 
-       KDMRequiredExtensions (shared_ptr<const cxml::Node> node)
+       explicit 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"))
@@ -358,10 +373,10 @@ public:
 
                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"));
@@ -387,7 +402,7 @@ class RequiredExtensions
 public:
        RequiredExtensions () {}
 
-       RequiredExtensions (shared_ptr<const cxml::Node> node)
+       explicit RequiredExtensions (shared_ptr<const cxml::Node> node)
                : kdm_required_extensions (node->node_child ("KDMRequiredExtensions"))
        {
 
@@ -406,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"))
+       explicit AuthenticatedPublic (shared_ptr<const cxml::Node> node)
+               : 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"))
@@ -425,7 +442,9 @@ public:
 
                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"));
@@ -435,7 +454,7 @@ public:
        }
 
        string message_id;
-       string annotation_text;
+       optional<string> annotation_text;
        string issue_date;
        Signer signer;
        RequiredExtensions required_extensions;
@@ -452,7 +471,7 @@ public:
 
        }
 
-       EncryptedKDMData (shared_ptr<const cxml::Node> node)
+       explicit EncryptedKDMData (shared_ptr<const cxml::Node> node)
                : authenticated_public (node->node_child ("AuthenticatedPublic"))
                , authenticated_private (node->node_child ("AuthenticatedPrivate"))
                , signature (node->node_child ("Signature"))
@@ -496,9 +515,11 @@ EncryptedKDM::EncryptedKDM (string s)
 EncryptedKDM::EncryptedKDM (
        shared_ptr<const CertificateChain> signer,
        Certificate recipient,
+       vector<Certificate> trusted_devices,
        string device_list_description,
        string cpl_id,
        string content_title_text,
+       optional<string> annotation_text,
        LocalTime not_valid_before,
        LocalTime not_valid_after,
        Formulation formulation,
@@ -512,6 +533,7 @@ EncryptedKDM::EncryptedKDM (
        data::AuthenticatedPublic& aup = _data->authenticated_public;
        aup.signer.x509_issuer_name = signer->leaf().issuer ();
        aup.signer.x509_serial_number = signer->leaf().serial ();
+       aup.annotation_text = annotation_text;
 
        data::KDMRequiredExtensions& kre = _data->authenticated_public.required_extensions.kdm_required_extensions;
        kre.recipient.x509_issuer_serial.x509_issuer_name = recipient.issuer ();
@@ -534,10 +556,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) {
@@ -595,11 +624,6 @@ EncryptedKDM::as_xml (boost::filesystem::path path) const
 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");
 }
 
@@ -608,3 +632,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();
+}