summaryrefslogtreecommitdiff
path: root/src/encrypted_kdm.h
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2014-03-19 22:03:18 +0000
committerCarl Hetherington <cth@carlh.net>2014-03-19 22:03:18 +0000
commit5e5750712fb6686cb4a192b3b232be96ad879b49 (patch)
tree68d29b6f44ce230ed89d0136c14cb182040196ae /src/encrypted_kdm.h
parent7702e5d643440e75369078863b34f8a574ee4143 (diff)
A few comments and some tidying.
Diffstat (limited to 'src/encrypted_kdm.h')
-rw-r--r--src/encrypted_kdm.h47
1 files changed, 36 insertions, 11 deletions
diff --git a/src/encrypted_kdm.h b/src/encrypted_kdm.h
index 8d13a25a..0aa36a15 100644
--- a/src/encrypted_kdm.h
+++ b/src/encrypted_kdm.h
@@ -17,6 +17,10 @@
*/
+/** @file src/encrypted_kdm.h
+ * @brief EncryptedKDM class.
+ */
+
#include "local_time.h"
#include <boost/filesystem.hpp>
#include <boost/date_time/local_time/local_time.hpp>
@@ -34,12 +38,43 @@ namespace data {
class Signer;
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 */
+ /** Read a KDM from an XML file.
+ * @param file XML file to read.
+ */
EncryptedKDM (boost::filesystem::path file);
+ 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;
+
+private:
+
+ friend class DecryptedKDM;
+
/** Construct an EncryptedKDM from a set of details */
EncryptedKDM (
boost::shared_ptr<const Signer> signer,
@@ -52,17 +87,7 @@ public:
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;
};