X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fencrypted_kdm.h;h=5b60378cd1e3657ceace2f2854eb2e38318c1632;hb=3956d410a1fce4fe3b02cd7c52d9717e29371f3b;hp=8d13a25ae19a201f6a284bb727600bdd90da9aa8;hpb=7702e5d643440e75369078863b34f8a574ee4143;p=libdcp.git

diff --git a/src/encrypted_kdm.h b/src/encrypted_kdm.h
index 8d13a25a..5b60378c 100644
--- a/src/encrypted_kdm.h
+++ b/src/encrypted_kdm.h
@@ -1,24 +1,47 @@
 /*
-    Copyright (C) 2013-2014 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/>.
+
+    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.
 */
 
+/** @file  src/encrypted_kdm.h
+ *  @brief EncryptedKDM class.
+ */
+
+#ifndef LIBDCP_ENCRYPTED_KDM_H
+#define LIBDCP_ENCRYPTED_KDM_H
+
 #include "local_time.h"
+#include "types.h"
 #include <boost/filesystem.hpp>
+#include <boost/optional.hpp>
 #include <boost/date_time/local_time/local_time.hpp>
 
 namespace cxml {
@@ -31,39 +54,70 @@ namespace data {
 	class EncryptedKDMData;
 }
 
-class Signer;	
+class CertificateChain;
 class Certificate;
 
+/** @class EncryptedKDM
+ *  @brief An encrypted KDM.
+ *
+ *  This is a KDM whose keys are encrypted using the target projector's private key.
+ *  An EncryptedKDM object can be initialised from a KDM XML file, or created from
+ *  a DecryptedKDM (using DecryptedKDM::encrypt).
+ */
 class EncryptedKDM
 {
 public:
-	/** Read a KDM from an XML file */
-	EncryptedKDM (boost::filesystem::path file);
+	explicit EncryptedKDM (std::string);
+	EncryptedKDM (EncryptedKDM const & kdm);
+	EncryptedKDM & operator= (EncryptedKDM const &);
+	~EncryptedKDM ();
+
+	/** Write this KDM as XML to a file.
+	 *  @param file File to write to.
+	 */
+	void as_xml (boost::filesystem::path file) const;
+
+	/** @return This KDM as XML */
+	std::string as_xml () const;
+
+	/** @return The base64-encoded and encrypted keys that this KDM delivers.
+	 *  Note that the returned `keys' contain more than just the asset decryption
+	 *  keys (also key id, CPL id etc.)
+	 */
+	std::list<std::string> keys () const;
+
+	boost::optional<std::string> annotation_text () const;
+	std::string content_title_text () const;
+	std::string issue_date () const;
+	std::string cpl_id () const;
+	LocalTime not_valid_before() const;
+	LocalTime not_valid_after() const;
+
+private:
+
+	friend class DecryptedKDM;
 
 	/** Construct an EncryptedKDM from a set of details */
 	EncryptedKDM (
-		boost::shared_ptr<const Signer> signer,
-		boost::shared_ptr<const Certificate> recipient,
+		boost::shared_ptr<const CertificateChain> signer,
+		Certificate recipient,
+		std::vector<Certificate> trusted_devices,
 		std::string device_list_description,
 		std::string cpl_id,
 		std::string cpl_content_title_text,
-		LocalTime _not_valid_before,
-		LocalTime _not_valid_after,
+		boost::optional<std::string> annotation_text,
+		LocalTime not_valid_before,
+		LocalTime not_valid_after,
+		Formulation formulation,
 		std::list<std::pair<std::string, std::string> > key_ids,
 		std::list<std::string> keys
 		);
 
-	EncryptedKDM (EncryptedKDM const & kdm);
-	EncryptedKDM & operator= (EncryptedKDM const &);
-	~EncryptedKDM ();
-
-	void as_xml (boost::filesystem::path) const;
-	std::string as_xml () const;
-
-	std::list<std::string> keys () const;
-	
-private:
 	data::EncryptedKDMData* _data;
 };
 
+extern bool operator== (EncryptedKDM const & a, EncryptedKDM const & b);
+
 }
+
+#endif