More tests.

[libdcp.git] / src / decrypted_kdm.h

diff --git a/src/decrypted_kdm.h b/src/decrypted_kdm.h
index 0bed341df844c34f446c4112d196ab254b3ce8b0..91b2f7d3d25a2ebe8d116cdf1ede49e4b6f38170 100644 (file)
--- a/src/decrypted_kdm.h
+++ b/src/decrypted_kdm.h
@@ -17,9 +17,18 @@
 
 */
 
+#ifndef LIBDCP_DECRYPTED_KDM_H
+#define LIBDCP_DECRYPTED_KDM_H
+
+/** @file  src/decrypted_kdm.h
+ *  @brief DecryptedKDM class.
+ */
+
 #include "key.h"
 #include "local_time.h"
 #include "decrypted_kdm_key.h"
+#include "types.h"
+#include "certificates.h"
 #include <boost/filesystem.hpp>
 
 namespace dcp {
@@ -27,19 +36,34 @@ namespace dcp {
 class DecryptedKDMKey;
 class EncryptedKDM;
 class Signer;
-class Certificate;
 class CPL;
 
+/** @class DecryptedKDM
+ *  @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.
+ *
+ *  A DecryptedKDM object can be created either from an EncryptedKDM and private key file,
+ *  or from the details of the MXFs that the KDM should protect.
+ */
 class DecryptedKDM
 {
 public:
        /** @param kdm Encrypted KDM.
-        *  @param private_key Private key file name.
+        *  @param private_key Private key as a PEM-format string.
         */
-       DecryptedKDM (EncryptedKDM const & kdm, boost::filesystem::path private_key);
+       DecryptedKDM (EncryptedKDM const & kdm, std::string private_key);
 
+       /** Construct a DecryptedKDM.
+        *  @param cpl CPL that the keys are for.
+        *  @param key Key that was used to encrypt the MXFs.
+        *  @param not_valid_before Start time for the KDM.
+        *  @param not_valid_after End time for the KDM.
+        */
        DecryptedKDM (
                boost::shared_ptr<const CPL> cpl,
+               Key key,
                LocalTime not_valid_before,
                LocalTime not_valid_after,
                std::string annotation_text,
@@ -47,9 +71,15 @@ public:
                std::string issue_date
                );
 
-       void add_key (std::string type, std::string id, Key key);
-       EncryptedKDM encrypt (boost::shared_ptr<const Signer>, boost::shared_ptr<const Certificate>) const;
+       /** Encrypt this KDM's keys and sign the whole KDM.
+        *  @param signer Signer.
+        *  @param recipient Certificate of the projector/server which should receive this KDM's keys.
+        *  @param formulation Formulation to use for the encrypted KDM.
+        *  @return Encrypted KDM.
+        */
+       EncryptedKDM encrypt (boost::shared_ptr<const Signer> signer, Certificate recipient, Formulation formulation) const;
 
+       /** @return This KDM's (decrypted) keys, which could be used to decrypt MXFs. */
        std::list<DecryptedKDMKey> keys () const {
                return _keys;
        }
@@ -64,3 +94,5 @@ private:
 };
 
 }
+
+#endif