Tidying.
[libdcp.git] / src / decrypted_kdm.h
index 56529b5df563709c34c33cd70dac1417561d4ed4..7bc9a217f2973f8361833d242064fe9dcf35c0ba 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2017 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of libdcp.
 
     files in the program, then also delete it here.
 */
 
-#ifndef LIBDCP_DECRYPTED_KDM_H
-#define LIBDCP_DECRYPTED_KDM_H
 
 /** @file  src/decrypted_kdm.h
- *  @brief DecryptedKDM class.
+ *  @brief DecryptedKDM class
  */
 
+
+#ifndef LIBDCP_DECRYPTED_KDM_H
+#define LIBDCP_DECRYPTED_KDM_H
+
+
 #include "key.h"
 #include "local_time.h"
 #include "decrypted_kdm_key.h"
 #include <boost/filesystem.hpp>
 #include <boost/optional.hpp>
 
+
 class decrypted_kdm_test;
 
+
 namespace dcp {
 
+
 class DecryptedKDMKey;
 class EncryptedKDM;
 class CertificateChain;
 class CPL;
 class ReelMXF;
 
+
 /** @class DecryptedKDM
- *  @brief A decrypted KDM.
+ *  @brief A decrypted KDM
  *
  *  This is a KDM that has either been decrypted by a target private key, or one which
  *  has been created (by some other means) ready for encryption later.
@@ -92,7 +99,7 @@ public:
         */
        DecryptedKDM (
                std::string cpl_id,
-               std::map<boost::shared_ptr<const ReelMXF>, Key> keys,
+               std::map<std::shared_ptr<const ReelMXF>, Key> keys,
                LocalTime not_valid_before,
                LocalTime not_valid_after,
                std::string annotation_text,
@@ -109,7 +116,7 @@ public:
         *  @param not_valid_after End time for the KDM.
         */
        DecryptedKDM (
-               boost::shared_ptr<const CPL> cpl,
+               std::shared_ptr<const CPL> cpl,
                Key key,
                LocalTime not_valid_before,
                LocalTime not_valid_after,
@@ -121,23 +128,34 @@ public:
        /** Encrypt this KDM's keys and sign the whole KDM.
         *  @param signer Chain to sign with.
         *  @param recipient Certificate of the projector/server which should receive this KDM's keys.
-        *  @param trusted_devices Extra trusted devices which should be written to the KDM (recipient will be written
+        *  @param trusted_devices Thumbprints of extra trusted devices which should be written to the KDM (recipient will be written
         *  as a trusted device automatically and does not need to be included in this list).
         *  @param formulation Formulation to use for the encrypted KDM.
+        *  @param disable_forensic_marking_picture true to disable forensic marking of picture.
+        *  @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio.  If set to 0,
+        *  disable all forensic marking; if set above 0, disable forensic marking above that channel.
         *  @return Encrypted KDM.
         */
        EncryptedKDM encrypt (
-               boost::shared_ptr<const CertificateChain> signer,
+               std::shared_ptr<const CertificateChain> signer,
                Certificate recipient,
-               std::vector<Certificate> trusted_devices,
-               Formulation formulation
+               std::vector<std::string> trusted_devices,
+               Formulation formulation,
+               bool disable_forensic_marking_picture,
+               boost::optional<int> disable_forensic_marking_audio
                ) const;
 
+       /** @param type (MDIK, MDAK etc.)
+        *  @param key_id Key ID
+        *  @param key The actual symmetric key
+        *  @param cpl_id ID of CPL that the key is for
+        */
        void add_key (boost::optional<std::string> type, std::string key_id, Key key, std::string cpl_id, Standard standard);
+
        void add_key (DecryptedKDMKey key);
 
        /** @return This KDM's (decrypted) keys, which could be used to decrypt assets. */
-       std::list<DecryptedKDMKey> keys () const {
+       std::vector<DecryptedKDMKey> keys () const {
                return _keys;
        }
 
@@ -165,9 +183,11 @@ private:
        boost::optional<std::string> _annotation_text;
        std::string _content_title_text;
        std::string _issue_date;
-       std::list<DecryptedKDMKey> _keys;
+       std::vector<DecryptedKDMKey> _keys;
 };
 
+
 }
 
+
 #endif