From: Carl Hetherington Date: Thu, 19 Jan 2023 21:03:21 +0000 (+0100) Subject: Warn/error on making KDMs using recipient certs whose validity periods X-Git-Tag: v2.16.43~12 X-Git-Url: https://git.carlh.net/gitweb/?p=dcpomatic.git;a=commitdiff_plain;h=788ef2cf5daf510651cc4f5eb7940d7bd0c44b76 Warn/error on making KDMs using recipient certs whose validity periods lie outside those of the KDMs (#2423). --- diff --git a/src/lib/kdm_cli.cc b/src/lib/kdm_cli.cc index a76155a2c..dc74e7161 100644 --- a/src/lib/kdm_cli.cc +++ b/src/lib/kdm_cli.cc @@ -240,14 +240,28 @@ from_film ( auto cpl = cpls.front().cpl_file; + std::vector period_checks; + try { list kdms; for (auto i: screens) { - auto p = kdm_for_screen (film, cpl, i, valid_from, valid_to, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio); + auto p = kdm_for_screen(film, cpl, i, valid_from, valid_to, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio, period_checks); if (p) { kdms.push_back (p); } } + + + if (find(period_checks.begin(), period_checks.end(), KDMCertificatePeriod::KDM_OUTSIDE_CERTIFICATE) != period_checks.end()) { + throw KDMCLIError( + "Some KDMs would have validity periods which are completely outside the recipient certificate periods. Such KDMs are very unlikely to work, so will not be created." + ); + } + + if (find(period_checks.begin(), period_checks.end(), KDMCertificatePeriod::KDM_OVERLAPS_CERTIFICATE) != period_checks.end()) { + out("For some of these KDMs the recipient certificate's validity period will not cover the whole of the KDM validity period. This might cause problems with the KDMs."); + } + write_files (kdms, zip, output, container_name_format, filename_format, verbose, out); if (email) { send_emails ({kdms}, container_name_format, filename_format, film->dcp_name(), {}); diff --git a/src/lib/kdm_util.cc b/src/lib/kdm_util.cc new file mode 100644 index 000000000..bf112ce11 --- /dev/null +++ b/src/lib/kdm_util.cc @@ -0,0 +1,60 @@ +/* + Copyright (C) 2023 Carl Hetherington + + This file is part of DCP-o-matic. + + DCP-o-matic 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. + + DCP-o-matic 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 DCP-o-matic. If not, see . + +*/ + + +#include "kdm_util.h" +#include "screen.h" +#include +#include + +#include "i18n.h" + + +using std::list; +using std::pair; +using std::shared_ptr; +using std::string; +using boost::optional; + + +KDMCertificatePeriod +check_kdm_and_certificate_validity_periods(dcp::Certificate const& recipient, dcp::LocalTime kdm_from, dcp::LocalTime kdm_to) +{ + auto overlaps = [](dcp::LocalTime from_a, dcp::LocalTime to_a, dcp::LocalTime from_b, dcp::LocalTime to_b) { + return std::max(from_a, from_b) < std::min(to_a, to_b); + }; + + auto contains = [](dcp::LocalTime bigger_from, dcp::LocalTime bigger_to, dcp::LocalTime smaller_from, dcp::LocalTime smaller_to) { + return bigger_from <= smaller_from && bigger_to >= smaller_to; + }; + + if (contains(recipient.not_before(), recipient.not_after(), kdm_from, kdm_to)) { + return KDMCertificatePeriod::KDM_WITHIN_CERTIFICATE; + } + + if (overlaps(recipient.not_before(), recipient.not_after(), kdm_from, kdm_to)) { + /* The KDM overlaps the certificate validity: maybe not the end of the world */ + return KDMCertificatePeriod::KDM_OVERLAPS_CERTIFICATE; + } else { + /* The KDM validity is totally outside the certificate validity: bad news */ + return KDMCertificatePeriod::KDM_OUTSIDE_CERTIFICATE; + } +} + diff --git a/src/lib/kdm_util.h b/src/lib/kdm_util.h new file mode 100644 index 000000000..4baa0c611 --- /dev/null +++ b/src/lib/kdm_util.h @@ -0,0 +1,53 @@ +/* + Copyright (C) 2023 Carl Hetherington + + This file is part of DCP-o-matic. + + DCP-o-matic 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. + + DCP-o-matic 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 DCP-o-matic. If not, see . + +*/ + + +#ifndef DCPOMATIC_KDM_UTIL_H +#define DCPOMATIC_KDM_UTIL_H + + +#include +#include + + +namespace dcp { + class Certificate; +} + + +enum class KDMCertificatePeriod { + KDM_WITHIN_CERTIFICATE, + KDM_OVERLAPS_CERTIFICATE, + KDM_OUTSIDE_CERTIFICATE +}; + + +/** @param recipient Some KDM recipient certificate. + * @param kdm_from Proposed KDM start time. + * @param kdm_to Proposed KDM end time. + * @return Relationship between certificate and KDM validity periods. + */ + +KDMCertificatePeriod +check_kdm_and_certificate_validity_periods(dcp::Certificate const& recipient, dcp::LocalTime kdm_from, dcp::LocalTime kdm_to); + + +#endif + diff --git a/src/lib/screen.cc b/src/lib/screen.cc index 2c821eceb..453a833d7 100644 --- a/src/lib/screen.cc +++ b/src/lib/screen.cc @@ -19,10 +19,11 @@ */ -#include "screen.h" -#include "kdm_with_metadata.h" -#include "film.h" #include "cinema.h" +#include "film.h" +#include "kdm_util.h" +#include "kdm_with_metadata.h" +#include "screen.h" #include #include #include @@ -80,7 +81,8 @@ kdm_for_screen ( boost::posix_time::ptime valid_to, dcp::Formulation formulation, bool disable_forensic_marking_picture, - optional disable_forensic_marking_audio + optional disable_forensic_marking_audio, + vector& period_checks ) { if (!screen->recipient) { @@ -91,6 +93,8 @@ kdm_for_screen ( dcp::LocalTime const begin(valid_from, dcp::UTCOffset(cinema ? cinema->utc_offset_hour() : 0, cinema ? cinema->utc_offset_minute() : 0)); dcp::LocalTime const end (valid_to, dcp::UTCOffset(cinema ? cinema->utc_offset_hour() : 0, cinema ? cinema->utc_offset_minute() : 0)); + period_checks.push_back(check_kdm_and_certificate_validity_periods(screen->recipient.get(), begin, end)); + auto const kdm = film->make_kdm ( screen->recipient.get(), screen->trusted_device_thumbprints(), diff --git a/src/lib/screen.h b/src/lib/screen.h index 84cecb80b..7cbeb1d15 100644 --- a/src/lib/screen.h +++ b/src/lib/screen.h @@ -25,6 +25,7 @@ #include "kdm_with_metadata.h" #include "kdm_recipient.h" +#include "kdm_util.h" #include "trusted_device.h" #include #include @@ -81,7 +82,8 @@ kdm_for_screen ( boost::posix_time::ptime valid_to, dcp::Formulation formulation, bool disable_forensic_marking_picture, - boost::optional disable_forensic_marking_audio + boost::optional disable_forensic_marking_audio, + std::vector& period_checks ); diff --git a/src/lib/wscript b/src/lib/wscript index ad0bcf0df..f8c2d5dc2 100644 --- a/src/lib/wscript +++ b/src/lib/wscript @@ -140,6 +140,7 @@ sources = """ kdm_cli.cc kdm_recipient.cc kdm_with_metadata.cc + kdm_util.cc log.cc log_entry.cc make_dcp.cc diff --git a/src/tools/dcpomatic_kdm.cc b/src/tools/dcpomatic_kdm.cc index c1239ff29..9d6fa2e8f 100644 --- a/src/tools/dcpomatic_kdm.cc +++ b/src/tools/dcpomatic_kdm.cc @@ -46,6 +46,7 @@ #include "lib/exceptions.h" #include "lib/file_log.h" #include "lib/job_manager.h" +#include "lib/kdm_util.h" #include "lib/kdm_with_metadata.h" #include "lib/screen.h" #include "lib/send_kdm_email_job.h" @@ -367,6 +368,8 @@ private: throw InvalidSignerError (); } + vector period_checks; + for (auto i: _screens->screens()) { if (!i->recipient) { @@ -376,6 +379,8 @@ private: dcp::LocalTime begin(_timing->from(), dcp::UTCOffset(i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute())); dcp::LocalTime end(_timing->until(), dcp::UTCOffset(i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute())); + period_checks.push_back(check_kdm_and_certificate_validity_periods(*i->recipient, begin, end)); + /* Make an empty KDM */ dcp::DecryptedKDM kdm ( begin, @@ -411,6 +416,21 @@ private: return; } + if (find(period_checks.begin(), period_checks.end(), KDMCertificatePeriod::KDM_OUTSIDE_CERTIFICATE) != period_checks.end()) { + error_dialog( + this, + _("Some KDMs would have validity periods which are completely outside the recipient certificate periods. Such KDMs are very unlikely to work, so will not be created.") + ); + return; + } + + if (find(period_checks.begin(), period_checks.end(), KDMCertificatePeriod::KDM_OVERLAPS_CERTIFICATE) != period_checks.end()) { + message_dialog( + this, + _("For some of these KDMs the recipient certificate's validity period will not cover the whole of the KDM validity period. This might cause problems with the KDMs.") + ); + } + auto result = _output->make ( kdms, title, bind (&DOMFrame::confirm_overwrite, this, _1) ); diff --git a/src/wx/kdm_dialog.cc b/src/wx/kdm_dialog.cc index 79f78b232..2687d1261 100644 --- a/src/wx/kdm_dialog.cc +++ b/src/wx/kdm_dialog.cc @@ -33,6 +33,7 @@ #include "lib/film.h" #include "lib/job_manager.h" #include "lib/kdm_with_metadata.h" +#include "lib/kdm_util.h" #include "lib/screen.h" #include #include @@ -171,12 +172,30 @@ KDMDialog::make_clicked () for_audio = _output->forensic_mark_audio_up_to(); } + vector period_checks; + for (auto i: _screens->screens()) { - auto p = kdm_for_screen (film, _cpl->cpl(), i, _timing->from(), _timing->until(), _output->formulation(), !_output->forensic_mark_video(), for_audio); + auto p = kdm_for_screen(film, _cpl->cpl(), i, _timing->from(), _timing->until(), _output->formulation(), !_output->forensic_mark_video(), for_audio, period_checks); if (p) { kdms.push_back (p); } } + + if (find(period_checks.begin(), period_checks.end(), KDMCertificatePeriod::KDM_OUTSIDE_CERTIFICATE) != period_checks.end()) { + error_dialog( + this, + _("Some KDMs would have validity periods which are completely outside the recipient certificate periods. Such KDMs are very unlikely to work, so will not be created.") + ); + return; + } + + if (find(period_checks.begin(), period_checks.end(), KDMCertificatePeriod::KDM_OVERLAPS_CERTIFICATE) != period_checks.end()) { + message_dialog( + this, + _("For some of these KDMs the recipient certificate's validity period will not cover the whole of the KDM validity period. This might cause problems with the KDMs.") + ); + } + } catch (dcp::BadKDMDateError& e) { if (e.starts_too_early()) { error_dialog (this, _("The KDM start period is before (or close to) the start of the signing certificate's validity period. Use a later start time for this KDM.")); diff --git a/test/kdm_naming_test.cc b/test/kdm_naming_test.cc index dda30f688..994217a14 100644 --- a/test/kdm_naming_test.cc +++ b/test/kdm_naming_test.cc @@ -98,6 +98,8 @@ BOOST_AUTO_TEST_CASE (single_kdm_naming_test) auto const from_string = from.date() + " " + from.time_of_day(true, false); auto const until_string = until.date() + " " + until.time_of_day(true, false); + std::vector period_checks; + auto cpl = cpls.front().cpl_file; auto kdm = kdm_for_screen ( film, @@ -107,7 +109,8 @@ BOOST_AUTO_TEST_CASE (single_kdm_naming_test) boost::posix_time::time_from_string(until_string), dcp::Formulation::MODIFIED_TRANSITIONAL_1, false, - optional() + optional(), + period_checks ); write_files ( @@ -162,6 +165,7 @@ BOOST_AUTO_TEST_CASE (directory_kdm_naming_test, * boost::unit_test::depends_on( auto const cpl = cpls.front().cpl_file; auto const cpl_id = cpls.front().cpl_id; + std::vector period_checks; list kdms; for (auto i: screens) { auto kdm = kdm_for_screen ( @@ -172,7 +176,8 @@ BOOST_AUTO_TEST_CASE (directory_kdm_naming_test, * boost::unit_test::depends_on( boost::posix_time::time_from_string(until_string), dcp::Formulation::MODIFIED_TRANSITIONAL_1, false, - optional() + optional(), + period_checks ); kdms.push_back (kdm); diff --git a/test/kdm_util_test.cc b/test/kdm_util_test.cc new file mode 100644 index 000000000..27b98230d --- /dev/null +++ b/test/kdm_util_test.cc @@ -0,0 +1,85 @@ +/* + Copyright (C) 2023 Carl Hetherington + + This file is part of DCP-o-matic. + + DCP-o-matic 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. + + DCP-o-matic 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 DCP-o-matic. If not, see . + +*/ + + +#include "lib/kdm_util.h" +#include +#include +#include + + +BOOST_AUTO_TEST_CASE(check_kdm_and_certificate_validity_periods_good) +{ + auto const result = check_kdm_and_certificate_validity_periods( + dcp::Certificate(dcp::file_to_string("test/data/cert.pem")), + dcp::LocalTime("2023-01-03T10:30:00"), + dcp::LocalTime("2050-10-20T14:00:00") + ); + + BOOST_CHECK(result == KDMCertificatePeriod::KDM_WITHIN_CERTIFICATE); +} + + +BOOST_AUTO_TEST_CASE(check_kdm_and_certificate_validity_periods_overlap_start) +{ + auto const result = check_kdm_and_certificate_validity_periods( + dcp::Certificate(dcp::file_to_string("test/data/cert.pem")), + dcp::LocalTime("2011-01-03T10:30:00"), + dcp::LocalTime("2050-10-20T14:00:00") + ); + + BOOST_CHECK(result == KDMCertificatePeriod::KDM_OVERLAPS_CERTIFICATE); +} + + +BOOST_AUTO_TEST_CASE(check_kdm_and_certificate_validity_periods_overlap_end) +{ + auto const result = check_kdm_and_certificate_validity_periods( + dcp::Certificate(dcp::file_to_string("test/data/cert.pem")), + dcp::LocalTime("2033-01-03T10:30:00"), + dcp::LocalTime("2095-10-20T14:00:00") + ); + + BOOST_CHECK(result == KDMCertificatePeriod::KDM_OVERLAPS_CERTIFICATE); +} + + +BOOST_AUTO_TEST_CASE(check_kdm_and_certificate_validity_periods_overlap_start_and_end) +{ + auto const result = check_kdm_and_certificate_validity_periods( + dcp::Certificate(dcp::file_to_string("test/data/cert.pem")), + dcp::LocalTime("2011-01-03T10:30:00"), + dcp::LocalTime("2095-10-20T14:00:00") + ); + + BOOST_CHECK(result == KDMCertificatePeriod::KDM_OVERLAPS_CERTIFICATE); +} + + +BOOST_AUTO_TEST_CASE(check_kdm_and_certificate_validity_periods_outside) +{ + auto const result = check_kdm_and_certificate_validity_periods( + dcp::Certificate(dcp::file_to_string("test/data/cert.pem")), + dcp::LocalTime("2011-01-03T10:30:00"), + dcp::LocalTime("2012-10-20T14:00:00") + ); + + BOOST_CHECK(result == KDMCertificatePeriod::KDM_OUTSIDE_CERTIFICATE); +} diff --git a/test/wscript b/test/wscript index 5807d94ea..5e06ed5e2 100644 --- a/test/wscript +++ b/test/wscript @@ -108,6 +108,7 @@ def build(bld): job_manager_test.cc kdm_cli_test.cc kdm_naming_test.cc + kdm_util_test.cc low_bitrate_test.cc markers_test.cc no_use_video_test.cc