src/key.h

   1 /*
   2     Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     libdcp is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 /** @file  src/key.h
  21  *  @brief Key class.
  22  */
  23
  24 #ifndef LIBDCP_KEY_H
  25 #define LIBDCP_KEY_H
  26
  27 #include <stdint.h>
  28 #include <string>
  29
  30 namespace dcp {
  31
  32 /** @class Key
  33  *  @brief A key for decrypting/encrypting assets.
  34  */
  35 class Key
  36 {
  37 public:
  38         /** Create a new, random key */
  39         Key ();
  40
  41         /** Create a Key from a raw key value */
  42         explicit Key (uint8_t const *);
  43
  44         /** Create a Key from a hex key value */
  45         explicit Key (std::string);
  46
  47         Key (Key const &);
  48         ~Key ();
  49
  50         Key& operator= (Key const &);
  51
  52         /** @return Raw key value */
  53         uint8_t const * value () const {
  54                 return _value;
  55         }
  56
  57         /** @return Key value as a hexadecimal string */
  58         std::string hex () const;
  59
  60 private:
  61         /** Raw key value */
  62         uint8_t* _value;
  63 };
  64
  65 extern bool operator== (Key const & a, Key const & b);
  66 extern bool operator!= (Key const & a, Key const & b);
  67
  68 }
  69
  70 #endif