X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fencrypted_kdm.cc;h=23052f8a2c438bd358acb3e0b8f63628a68c5b30;hb=201b6fdf572c04424d870ac4d07d1d1a8725b24c;hp=0e10a528c7ca22ce8f5012958eab1c5bbdab5d5f;hpb=a545db4651e56eff854e2ed797f849b17bf108c9;p=libdcp.git diff --git a/src/encrypted_kdm.cc b/src/encrypted_kdm.cc index 0e10a528..23052f8a 100644 --- a/src/encrypted_kdm.cc +++ b/src/encrypted_kdm.cc @@ -1,31 +1,49 @@ /* - Copyright (C) 2013-2016 Carl Hetherington + Copyright (C) 2013-2018 Carl Hetherington - 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 . + + In addition, as a special exception, the copyright holders give + permission to link the code of portions of this program with the + OpenSSL library under certain conditions as described in each + individual source file, and distribute linked combinations + including the two. + + You must obey the GNU General Public License in all respects + for all of the code used other than OpenSSL. If you modify + file(s) with this exception, you may extend this exception to your + version of the file(s), but you are not obligated to do so. If you + do not wish to do so, delete this exception statement from your + version. If you delete this exception statement from all source + files in the program, then also delete it here. */ #include "encrypted_kdm.h" #include "util.h" #include "certificate_chain.h" +#include "exceptions.h" +#include "compose.hpp" #include #include #include #include +#include #include #include +#include using std::list; using std::vector; @@ -34,6 +52,7 @@ using std::map; using std::pair; using boost::shared_ptr; using boost::optional; +using boost::starts_with; using namespace dcp; namespace dcp { @@ -46,7 +65,7 @@ class Signer public: Signer () {} - Signer (shared_ptr node) + explicit Signer (shared_ptr node) : x509_issuer_name (node->string_child ("X509IssuerName")) , x509_serial_number (node->string_child ("X509SerialNumber")) { @@ -68,7 +87,7 @@ class X509Data public: X509Data () {} - X509Data (boost::shared_ptr node) + explicit X509Data (boost::shared_ptr node) : x509_issuer_serial (Signer (node->node_child ("X509IssuerSerial"))) , x509_certificate (node->string_child ("X509Certificate")) { @@ -90,11 +109,11 @@ class Reference public: Reference () {} - Reference (string u) + explicit Reference (string u) : uri (u) {} - Reference (shared_ptr node) + explicit Reference (shared_ptr node) : uri (node->string_attribute ("URI")) , digest_value (node->string_child ("DigestValue")) { @@ -120,7 +139,7 @@ public: , authenticated_private ("#ID_AuthenticatedPrivate") {} - SignedInfo (shared_ptr node) + explicit SignedInfo (shared_ptr node) { list > references = node->node_children ("Reference"); for (list >::const_iterator i = references.begin(); i != references.end(); ++i) { @@ -158,7 +177,7 @@ class Signature public: Signature () {} - Signature (shared_ptr node) + explicit Signature (shared_ptr node) : signed_info (node->node_child ("SignedInfo")) , signature_value (node->string_child ("SignatureValue")) { @@ -189,7 +208,7 @@ class AuthenticatedPrivate public: AuthenticatedPrivate () {} - AuthenticatedPrivate (shared_ptr node) + explicit AuthenticatedPrivate (shared_ptr node) { list > encrypted_key_nodes = node->node_children ("EncryptedKey"); for (list >::const_iterator i = encrypted_key_nodes.begin(); i != encrypted_key_nodes.end(); ++i) { @@ -224,7 +243,7 @@ class TypedKeyId public: TypedKeyId () {} - TypedKeyId (shared_ptr node) + explicit TypedKeyId (shared_ptr node) : key_type (node->string_child ("KeyType")) , key_id (remove_urn_uuid (node->string_child ("KeyId"))) { @@ -244,6 +263,8 @@ public: /* 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"); + } else { + type->set_attribute ("scope", "http://www.smpte-ra.org/430-1/2006/KDM#kdm-key-type"); } } @@ -256,7 +277,7 @@ class KeyIdList public: KeyIdList () {} - KeyIdList (shared_ptr node) + explicit KeyIdList (shared_ptr node) { list > typed_key_id_nodes = node->node_children ("TypedKeyId"); for (list >::const_iterator i = typed_key_id_nodes.begin(); i != typed_key_id_nodes.end(); ++i) { @@ -279,7 +300,7 @@ class AuthorizedDeviceInfo public: AuthorizedDeviceInfo () {} - AuthorizedDeviceInfo (shared_ptr node) + explicit AuthorizedDeviceInfo (shared_ptr node) : device_list_identifier (remove_urn_uuid (node->string_child ("DeviceListIdentifier"))) , device_list_description (node->optional_string_child ("DeviceListDescription")) { @@ -311,7 +332,7 @@ class X509IssuerSerial public: X509IssuerSerial () {} - X509IssuerSerial (shared_ptr node) + explicit X509IssuerSerial (shared_ptr node) : x509_issuer_name (node->string_child ("X509IssuerName")) , x509_serial_number (node->string_child ("X509SerialNumber")) { @@ -333,7 +354,7 @@ class Recipient public: Recipient () {} - Recipient (shared_ptr node) + explicit Recipient (shared_ptr node) : x509_issuer_serial (node->node_child ("X509IssuerSerial")) , x509_subject_name (node->string_child ("X509SubjectName")) { @@ -355,7 +376,7 @@ class KDMRequiredExtensions public: KDMRequiredExtensions () {} - KDMRequiredExtensions (shared_ptr node) + explicit KDMRequiredExtensions (shared_ptr node) : recipient (node->node_child ("Recipient")) , composition_playlist_id (remove_urn_uuid (node->string_child ("CompositionPlaylistId"))) , content_title_text (node->string_child ("ContentTitleText")) @@ -364,7 +385,25 @@ public: , authorized_device_info (node->node_child ("AuthorizedDeviceInfo")) , key_id_list (node->node_child ("KeyIdList")) { - + disable_forensic_marking_picture = false; + disable_forensic_marking_audio = optional(); + if (node->optional_node_child("ForensicMarkFlagList")) { + BOOST_FOREACH (cxml::ConstNodePtr i, node->node_child("ForensicMarkFlagList")->node_children("ForensicMarkFlag")) { + if (i->content() == picture_disable) { + disable_forensic_marking_picture = true; + } else if (starts_with(i->content(), audio_disable)) { + disable_forensic_marking_audio = 0; + string const above = audio_disable + "-above-channel-"; + if (starts_with(i->content(), above)) { + string above_number = i->content().substr(above.length()); + if (above_number == "") { + throw KDMFormatError("Badly-formatted ForensicMarkFlag"); + } + disable_forensic_marking_audio = atoi(above_number.c_str()); + } + } + } + } } void as_xml (xmlpp::Element* node) const @@ -379,12 +418,24 @@ public: } 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")); + if (authorized_device_info) { + 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"); + if (disable_forensic_marking_picture || disable_forensic_marking_audio) { + xmlpp::Element* forensic_mark_flag_list = node->add_child ("ForensicMarkFlagList"); + if (disable_forensic_marking_picture) { + forensic_mark_flag_list->add_child("ForensicMarkFlag")->add_child_text(picture_disable); + } + if (disable_forensic_marking_audio) { + string mrkflg = audio_disable; + if (*disable_forensic_marking_audio > 0) { + mrkflg += String::compose ("-above-channel-%1", *disable_forensic_marking_audio); + } + forensic_mark_flag_list->add_child("ForensicMarkFlag")->add_child_text (mrkflg); + } + } } Recipient recipient; @@ -393,16 +444,25 @@ public: string content_title_text; LocalTime not_valid_before; LocalTime not_valid_after; - AuthorizedDeviceInfo authorized_device_info; + bool disable_forensic_marking_picture; + optional disable_forensic_marking_audio; + boost::optional authorized_device_info; KeyIdList key_id_list; + +private: + static const string picture_disable; + static const string audio_disable; }; +const string KDMRequiredExtensions::picture_disable = "http://www.smpte-ra.org/430-1/2006/KDM#mrkflg-picture-disable"; +const string KDMRequiredExtensions::audio_disable = "http://www.smpte-ra.org/430-1/2006/KDM#mrkflg-audio-disable"; + class RequiredExtensions { public: RequiredExtensions () {} - RequiredExtensions (shared_ptr node) + explicit RequiredExtensions (shared_ptr node) : kdm_required_extensions (node->node_child ("KDMRequiredExtensions")) { @@ -426,7 +486,7 @@ public: , issue_date (LocalTime().as_string ()) {} - AuthenticatedPublic (shared_ptr node) + explicit AuthenticatedPublic (shared_ptr node) : message_id (remove_urn_uuid (node->string_child ("MessageId"))) , annotation_text (node->optional_string_child ("AnnotationText")) , issue_date (node->string_child ("IssueDate")) @@ -471,7 +531,7 @@ public: } - EncryptedKDMData (shared_ptr node) + explicit EncryptedKDMData (shared_ptr node) : authenticated_public (node->node_child ("AuthenticatedPublic")) , authenticated_private (node->node_child ("AuthenticatedPrivate")) , signature (node->node_child ("Signature")) @@ -507,22 +567,28 @@ public: EncryptedKDM::EncryptedKDM (string s) { - shared_ptr doc (new cxml::Document ("DCinemaSecurityMessage")); - doc->read_string (s); - _data = new data::EncryptedKDMData (doc); + try { + shared_ptr doc (new cxml::Document ("DCinemaSecurityMessage")); + doc->read_string (s); + _data = new data::EncryptedKDMData (doc); + } catch (xmlpp::parse_error& e) { + throw KDMFormatError (e.what ()); + } } +/** @param trusted_devices Trusted device thumbprints */ EncryptedKDM::EncryptedKDM ( shared_ptr signer, Certificate recipient, - vector trusted_devices, - string device_list_description, + vector trusted_devices, string cpl_id, string content_title_text, optional annotation_text, LocalTime not_valid_before, LocalTime not_valid_after, Formulation formulation, + bool disable_forensic_marking_picture, + optional disable_forensic_marking_audio, list > key_ids, list keys ) @@ -530,6 +596,15 @@ EncryptedKDM::EncryptedKDM ( { /* Fill our XML-ish description in with the juicy bits that the caller has given */ + /* Our ideas, based on http://isdcf.com/papers/ISDCF-Doc5-kdm-certs.pdf, about the KDM types are: + * + * Type Trusted-device thumb ContentAuthenticator + * MODIFIED_TRANSITIONAL_1 assume-trust No + * MULTIPLE_MODIFIED_TRANSITIONAL_1 as specified No + * DCI_ANY assume-trust Yes + * DCI_SPECIFIC as specified Yes + */ + data::AuthenticatedPublic& aup = _data->authenticated_public; aup.signer.x509_issuer_name = signer->leaf().issuer (); aup.signer.x509_serial_number = signer->leaf().serial (); @@ -539,7 +614,6 @@ EncryptedKDM::EncryptedKDM ( kre.recipient.x509_issuer_serial.x509_issuer_name = recipient.issuer (); kre.recipient.x509_issuer_serial.x509_serial_number = recipient.serial (); kre.recipient.x509_subject_name = recipient.subject (); - 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->leaf().thumbprint (); @@ -547,25 +621,41 @@ EncryptedKDM::EncryptedKDM ( 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.subject_common_name (); - if (n.find (".") != string::npos) { - n = n.substr (n.find (".") + 1); - } - kre.authorized_device_info.device_list_description = n; - - if (formulation == MODIFIED_TRANSITIONAL_1 || formulation == DCI_ANY) { - /* Use the "assume trust" thumbprint */ - kre.authorized_device_info.certificate_thumbprints.push_back ("2jmj7l5rSw0yVb/vlWAYkK/YBwk="); - } else if (formulation == DCI_SPECIFIC) { - /* 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 ()); + kre.disable_forensic_marking_picture = disable_forensic_marking_picture; + kre.disable_forensic_marking_audio = disable_forensic_marking_audio; + + if (formulation != MODIFIED_TRANSITIONAL_TEST) { + kre.authorized_device_info = data::AuthorizedDeviceInfo (); + kre.authorized_device_info->device_list_identifier = make_uuid (); + string n = recipient.subject_common_name (); + if (n.find (".") != string::npos) { + n = n.substr (n.find (".") + 1); + } + kre.authorized_device_info->device_list_description = n; + + if (formulation == MODIFIED_TRANSITIONAL_1 || formulation == DCI_ANY) { + /* Use the "assume trust" thumbprint */ + kre.authorized_device_info->certificate_thumbprints.push_back ("2jmj7l5rSw0yVb/vlWAYkK/YBwk="); + } else if (formulation == MULTIPLE_MODIFIED_TRANSITIONAL_1 || formulation == DCI_SPECIFIC) { + if (trusted_devices.empty ()) { + /* Fall back on the "assume trust" thumbprint so we + can generate "modified-transitional-1" KDMs + together with "multiple-modified-transitional-1" + KDMs in one go, and similarly for "dci-any" etc. + */ + kre.authorized_device_info->certificate_thumbprints.push_back ("2jmj7l5rSw0yVb/vlWAYkK/YBwk="); + } else { + /* 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()). + Waimea uses only the trusted devices here, too. + */ + BOOST_FOREACH (string i, trusted_devices) { + kre.authorized_device_info->certificate_thumbprints.push_back (i); + } + } } } @@ -633,6 +723,12 @@ EncryptedKDM::keys () const return _data->authenticated_private.encrypted_key; } +string +EncryptedKDM::id () const +{ + return _data->authenticated_public.message_id; +} + optional EncryptedKDM::annotation_text () const { @@ -657,6 +753,24 @@ EncryptedKDM::issue_date () const return _data->authenticated_public.issue_date; } +LocalTime +EncryptedKDM::not_valid_before () const +{ + return _data->authenticated_public.required_extensions.kdm_required_extensions.not_valid_before; +} + +LocalTime +EncryptedKDM::not_valid_after () const +{ + return _data->authenticated_public.required_extensions.kdm_required_extensions.not_valid_after; +} + +string +EncryptedKDM::recipient_x509_subject_name () const +{ + return _data->authenticated_public.required_extensions.kdm_required_extensions.recipient.x509_subject_name; +} + bool dcp::operator== (EncryptedKDM const & a, EncryptedKDM const & b) {