bb50d6ada9565380746eb097658be1c9d9f87af6
[libdcp.git] / src / decrypted_kdm.h
1 /*
2     Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 /** @file  src/decrypted_kdm.h
21  *  @brief DecryptedKDM class.
22  */
23
24 #include "key.h"
25 #include "local_time.h"
26 #include "decrypted_kdm_key.h"
27 #include <boost/filesystem.hpp>
28
29 namespace dcp {
30
31 class DecryptedKDMKey;
32 class EncryptedKDM;
33 class Signer;
34 class Certificate;
35 class CPL;
36
37 /** @class DecryptedKDM
38  *  @brief A decrypted KDM.
39  *
40  *  This is a KDM that has either been decrypted by a target private key, or one which
41  *  has been created (by some other means) ready for encryption later.
42  *
43  *  A DecryptedKDM object can be created either from an EncryptedKDM and private key file,
44  *  or from the details of the MXFs that the KDM should protect.
45  */
46 class DecryptedKDM
47 {
48 public:
49         /** @param kdm Encrypted KDM.
50          *  @param private_key Private key file name.
51          */
52         DecryptedKDM (EncryptedKDM const & kdm, boost::filesystem::path private_key);
53
54         /** Construct a DecryptedKDM.
55          *  @param cpl CPL that the keys are for.
56          *  @param not_valid_before Start time for the KDM.
57          *  @param not_valid_after End time for the KDM.
58          */
59         DecryptedKDM (
60                 boost::shared_ptr<const CPL> cpl,
61                 LocalTime not_valid_before,
62                 LocalTime not_valid_after,
63                 std::string annotation_text,
64                 std::string content_title_text,
65                 std::string issue_date
66                 );
67
68         /** Add a key to this KDM.
69          *  @param type Key type (MDIK, MDAK etc.)
70          *  @param id Key id.
71          *  @param key the key itself (which has been used to encrypt a MXF).
72          */
73         void add_key (std::string type, std::string id, Key key);
74
75         /** Encrypt this KDM's keys and sign the whole KDM.
76          *  @param signer Signer.
77          *  @param recipient Certificate of the projector/server which should receive this KDM's keys.
78          *  @return Encrypted KDM.
79          */
80         EncryptedKDM encrypt (boost::shared_ptr<const Signer> signer, boost::shared_ptr<const Certificate> recipient) const;
81
82         /** @return This KDM's (decrypted) keys, which could be used to decrypt MXFs. */
83         std::list<DecryptedKDMKey> keys () const {
84                 return _keys;
85         }
86
87 private:
88         LocalTime _not_valid_before;
89         LocalTime _not_valid_after;
90         std::string _annotation_text;
91         std::string _content_title_text;
92         std::string _issue_date;
93         std::list<DecryptedKDMKey> _keys;
94 };
95
96 }