Forward-port raw_convert precision parameter from v0.

[libdcp.git] / src / decrypted_kdm.h

diff --git a/src/decrypted_kdm.h b/src/decrypted_kdm.h
index 0bed341df844c34f446c4112d196ab254b3ce8b0..bb50d6ada9565380746eb097658be1c9d9f87af6 100644 (file)
--- a/src/decrypted_kdm.h
+++ b/src/decrypted_kdm.h
@@ -17,6 +17,10 @@
 
 */
 
+/** @file  src/decrypted_kdm.h
+ *  @brief DecryptedKDM class.
+ */
+
 #include "key.h"
 #include "local_time.h"
 #include "decrypted_kdm_key.h"
@@ -30,6 +34,15 @@ 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:
@@ -38,6 +51,11 @@ public:
         */
        DecryptedKDM (EncryptedKDM const & kdm, boost::filesystem::path private_key);
 
+       /** Construct a DecryptedKDM.
+        *  @param cpl CPL that the keys are for.
+        *  @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,
                LocalTime not_valid_before,
@@ -47,9 +65,21 @@ public:
                std::string issue_date
                );
 
+       /** Add a key to this KDM.
+        *  @param type Key type (MDIK, MDAK etc.)
+        *  @param id Key id.
+        *  @param key the key itself (which has been used to encrypt a MXF).
+        */
        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.
+        *  @return Encrypted KDM.
+        */
+       EncryptedKDM encrypt (boost::shared_ptr<const Signer> signer, boost::shared_ptr<const Certificate> recipient) const;
+
+       /** @return This KDM's (decrypted) keys, which could be used to decrypt MXFs. */
        std::list<DecryptedKDMKey> keys () const {
                return _keys;
        }