Add some tests for KDM forensic marks.
[libdcp.git] / test / kdm_test.cc
1 /*
2     Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
3
4     This file is part of libdcp.
5
6     libdcp is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     libdcp is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #include "encrypted_kdm.h"
21 #include "decrypted_kdm.h"
22 #include "certificate_chain.h"
23 #include "util.h"
24 #include "test.h"
25 #include <libcxml/cxml.h>
26 #include <libxml++/libxml++.h>
27 #include <boost/test/unit_test.hpp>
28 #include <boost/foreach.hpp>
29
30 using std::list;
31 using std::string;
32 using std::vector;
33 using boost::shared_ptr;
34
35 /** Check reading and decryption of a KDM */
36 BOOST_AUTO_TEST_CASE (kdm_test)
37 {
38         dcp::DecryptedKDM kdm (
39                 dcp::EncryptedKDM (
40                         dcp::file_to_string ("test/data/kdm_TONEPLATES-SMPTE-ENC_.smpte-430-2.ROOT.NOT_FOR_PRODUCTION_20130706_20230702_CAR_OV_t1_8971c838.xml")
41                         ),
42                 dcp::file_to_string ("test/data/private.key")
43                 );
44
45         list<dcp::DecryptedKDMKey> keys = kdm.keys ();
46
47         BOOST_CHECK_EQUAL (keys.size(), 2);
48
49         BOOST_CHECK_EQUAL (keys.front().cpl_id(), "eece17de-77e8-4a55-9347-b6bab5724b9f");
50         BOOST_CHECK_EQUAL (keys.front().id(), "4ac4f922-8239-4831-b23b-31426d0542c4");
51         BOOST_CHECK_EQUAL (keys.front().key().hex(), "8a2729c3e5b65c45d78305462104c3fb");
52
53         BOOST_CHECK_EQUAL (keys.back().cpl_id(), "eece17de-77e8-4a55-9347-b6bab5724b9f");
54         BOOST_CHECK_EQUAL (keys.back().id(), "73baf5de-e195-4542-ab28-8a465f7d4079");
55         BOOST_CHECK_EQUAL (keys.back().key().hex(), "5327fb7ec2e807bd57059615bf8a169d");
56 }
57
58 /** Check that we can read in a KDM and then write it back out again the same */
59 BOOST_AUTO_TEST_CASE (kdm_passthrough_test)
60 {
61         dcp::EncryptedKDM kdm (
62                 dcp::file_to_string ("test/data/kdm_TONEPLATES-SMPTE-ENC_.smpte-430-2.ROOT.NOT_FOR_PRODUCTION_20130706_20230702_CAR_OV_t1_8971c838.xml")
63                 );
64
65         shared_ptr<xmlpp::DomParser> parser (new xmlpp::DomParser ());
66         parser->parse_memory (kdm.as_xml ());
67         parser->get_document()->write_to_file_formatted ("build/kdm.xml", "UTF-8");
68         int const r = system (
69                 "xmldiff -c test/data/kdm_TONEPLATES-SMPTE-ENC_.smpte-430-2.ROOT.NOT_FOR_PRODUCTION_20130706_20230702_CAR_OV_t1_8971c838.xml build/kdm.xml"
70                 );
71
72 #ifdef LIBDCP_WINDOWS
73         BOOST_CHECK_EQUAL (r, 0);
74 #else
75         BOOST_CHECK_EQUAL (WEXITSTATUS (r), 0);
76 #endif
77 }
78
79 /** Test some of the utility methods of DecryptedKDM */
80 BOOST_AUTO_TEST_CASE (decrypted_kdm_test)
81 {
82         uint8_t* data = new uint8_t[16];
83         uint8_t* p = data;
84         dcp::DecryptedKDM::put_uuid (&p, "8971c838-d0c3-405d-bc57-43afa9d91242");
85
86         BOOST_CHECK_EQUAL (data[0], 0x89);
87         BOOST_CHECK_EQUAL (data[1], 0x71);
88         BOOST_CHECK_EQUAL (data[2], 0xc8);
89         BOOST_CHECK_EQUAL (data[3], 0x38);
90         BOOST_CHECK_EQUAL (data[4], 0xd0);
91         BOOST_CHECK_EQUAL (data[5], 0xc3);
92         BOOST_CHECK_EQUAL (data[6], 0x40);
93         BOOST_CHECK_EQUAL (data[7], 0x5d);
94         BOOST_CHECK_EQUAL (data[8], 0xbc);
95         BOOST_CHECK_EQUAL (data[9], 0x57);
96         BOOST_CHECK_EQUAL (data[10], 0x43);
97         BOOST_CHECK_EQUAL (data[11], 0xaf);
98         BOOST_CHECK_EQUAL (data[12], 0xa9);
99         BOOST_CHECK_EQUAL (data[13], 0xd9);
100         BOOST_CHECK_EQUAL (data[14], 0x12);
101         BOOST_CHECK_EQUAL (data[15], 0x42);
102
103         p = data;
104         BOOST_CHECK_EQUAL (dcp::DecryptedKDM::get_uuid (&p), "8971c838-d0c3-405d-bc57-43afa9d91242");
105
106         delete[] data;
107 }
108
109 /** Check that <KeyType> tags have the scope attribute.
110  *  Wolfgang Woehl believes this is compulsory and I am more-or-less inclined to agree.
111  */
112 BOOST_AUTO_TEST_CASE (kdm_key_type_scope)
113 {
114         dcp::EncryptedKDM kdm (
115                 dcp::file_to_string ("test/data/kdm_TONEPLATES-SMPTE-ENC_.smpte-430-2.ROOT.NOT_FOR_PRODUCTION_20130706_20230702_CAR_OV_t1_8971c838.xml")
116                 );
117
118         cxml::Document doc;
119         doc.read_string (kdm.as_xml ());
120
121         list<cxml::NodePtr> typed_key_ids = doc.node_child("AuthenticatedPublic")->
122                 node_child("RequiredExtensions")->
123                 node_child("KDMRequiredExtensions")->
124                 node_child("KeyIdList")->
125                 node_children("TypedKeyId");
126
127         BOOST_FOREACH (cxml::NodePtr i, typed_key_ids) {
128                 BOOST_FOREACH (cxml::NodePtr j, i->node_children("KeyType")) {
129                         BOOST_CHECK (j->string_attribute("scope") == "http://www.smpte-ra.org/430-1/2006/KDM#kdm-key-type");
130                 }
131         }
132 }
133
134 static cxml::ConstNodePtr
135 kdm_forensic_test (cxml::Document& doc, int picture, int audio)
136 {
137         dcp::DecryptedKDM decrypted (
138                 dcp::EncryptedKDM (
139                         dcp::file_to_string ("test/data/kdm_TONEPLATES-SMPTE-ENC_.smpte-430-2.ROOT.NOT_FOR_PRODUCTION_20130706_20230702_CAR_OV_t1_8971c838.xml")
140                         ),
141                 dcp::file_to_string ("test/data/private.key")
142                 );
143
144         shared_ptr<dcp::CertificateChain> signer(new dcp::CertificateChain(dcp::file_to_string("test/data/certificate_chain")));
145         signer->set_key(dcp::file_to_string("test/data/private.key"));
146
147         dcp::EncryptedKDM kdm = decrypted.encrypt (
148                 signer, signer->leaf(), vector<dcp::Certificate>(), dcp::MODIFIED_TRANSITIONAL_1, picture, audio
149                 );
150
151         doc.read_string (kdm.as_xml ());
152
153         return doc.node_child("AuthenticatedPublic")->
154                 node_child("RequiredExtensions")->
155                 node_child("KDMRequiredExtensions")->
156                 optional_node_child("ForensicMarkFlagList");
157 }
158
159 /** Check ForensicMarkFlagList handling: disable picture and all audio */
160 BOOST_AUTO_TEST_CASE (kdm_forensic_test1)
161 {
162         cxml::Document doc;
163         cxml::ConstNodePtr forensic = kdm_forensic_test(doc, -1, -1);
164         BOOST_REQUIRE (forensic);
165         list<cxml::NodePtr> flags = forensic->node_children("ForensicMarkFlag");
166         BOOST_REQUIRE_EQUAL (flags.size(), 2);
167         BOOST_CHECK_EQUAL (flags.front()->content(), "http://www.smpte-ra.org/430-1/2006/KDM#mrkflg-picture-disable");
168         BOOST_CHECK_EQUAL (flags.back()->content(), "http://www.smpte-ra.org/430-1/2006/KDM#mrkflg-audio-disable");
169 }
170
171 /** Check ForensicMarkFlagList handling: disable picture but not audio */
172 BOOST_AUTO_TEST_CASE (kdm_forensic_test2)
173 {
174         cxml::Document doc;
175         cxml::ConstNodePtr forensic = kdm_forensic_test(doc, -1, 0);
176         BOOST_REQUIRE (forensic);
177         list<cxml::NodePtr> flags = forensic->node_children("ForensicMarkFlag");
178         BOOST_REQUIRE_EQUAL (flags.size(), 1);
179         BOOST_CHECK_EQUAL (flags.front()->content(), "http://www.smpte-ra.org/430-1/2006/KDM#mrkflg-picture-disable");
180 }
181
182 /** Check ForensicMarkFlagList handling: disable audio but not picture */
183 BOOST_AUTO_TEST_CASE (kdm_forensic_test3)
184 {
185         cxml::Document doc;
186         cxml::ConstNodePtr forensic = kdm_forensic_test(doc, 0, -1);
187         BOOST_REQUIRE (forensic);
188         list<cxml::NodePtr> flags = forensic->node_children("ForensicMarkFlag");
189         BOOST_REQUIRE_EQUAL (flags.size(), 1);
190         BOOST_CHECK_EQUAL (flags.front()->content(), "http://www.smpte-ra.org/430-1/2006/KDM#mrkflg-audio-disable");
191 }
192
193 /** Check ForensicMarkFlagList handling: disable picture and audio above channel 3 */
194 BOOST_AUTO_TEST_CASE (kdm_forensic_test4)
195 {
196         cxml::Document doc;
197         cxml::ConstNodePtr forensic = kdm_forensic_test(doc, -1, 3);
198         BOOST_REQUIRE (forensic);
199         list<cxml::NodePtr> flags = forensic->node_children("ForensicMarkFlag");
200         BOOST_REQUIRE_EQUAL (flags.size(), 2);
201         BOOST_CHECK_EQUAL (flags.front()->content(), "http://www.smpte-ra.org/430-1/2006/KDM#mrkflg-picture-disable");
202         BOOST_CHECK_EQUAL (flags.back()->content(), "http://www.smpte-ra.org/430-1/2006/KDM#mrkflg-audio-disable-above-channel-3");
203 }
204
205 /** Check ForensicMarkFlagList handling: disable neither */
206 BOOST_AUTO_TEST_CASE (kdm_forensic_test5)
207 {
208         cxml::Document doc;
209         cxml::ConstNodePtr forensic = kdm_forensic_test(doc, 0, 0);
210         BOOST_CHECK (!forensic);
211 }