Warn/error on making KDMs using recipient certs whose validity periods

lie outside those of the KDMs (#2423).

6 files changed, 140 insertions, 6 deletions

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<KDMCertificatePeriod> period_checks;
+
 	try {
 		list<KDMWithMetadataPtr> 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 <cth@carlh.net>
+
+    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 <http://www.gnu.org/licenses/>.
+
+*/
+
+
+#include "kdm_util.h"
+#include "screen.h"
+#include <dcp/certificate.h>
+#include <boost/optional.hpp>
+
+#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 <cth@carlh.net>
+
+    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 <http://www.gnu.org/licenses/>.
+
+*/
+
+
+#ifndef DCPOMATIC_KDM_UTIL_H
+#define DCPOMATIC_KDM_UTIL_H
+
+
+#include <utility>
+#include <dcp/local_time.h>
+
+
+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 <libxml++/libxml++.h>
 #include <boost/algorithm/string.hpp>
 #include <boost/date_time/posix_time/posix_time.hpp>
@@ -80,7 +81,8 @@ kdm_for_screen (
 	boost::posix_time::ptime valid_to,
 	dcp::Formulation formulation,
 	bool disable_forensic_marking_picture,
-	optional<int> disable_forensic_marking_audio
+	optional<int> disable_forensic_marking_audio,
+	vector<KDMCertificatePeriod>& 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 <dcp/certificate.h>
 #include <libcxml/cxml.h>
@@ -81,7 +82,8 @@ kdm_for_screen (
 	boost::posix_time::ptime valid_to,
 	dcp::Formulation formulation,
 	bool disable_forensic_marking_picture,
-	boost::optional<int> disable_forensic_marking_audio
+	boost::optional<int> disable_forensic_marking_audio,
+	std::vector<KDMCertificatePeriod>& 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