src/key.h

   1 /*
   2     Copyright (C) 2013 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/key.h
  21  *  @brief Class to hold a key for encrypting MXFs.
  22  */
  23
  24 #ifndef LIBDCP_KEY_H
  25 #define LIBDCP_KEY_H
  26
  27 #include <stdint.h>
  28
  29 namespace dcp {
  30
  31 /** @class Key
  32  *  @brief A key for encrypting MXFs.
  33  */
  34 class Key
  35 {
  36 public:
  37         /** Create a new, random key */
  38         Key ();
  39
  40         /** Create a Key from a raw key value */
  41         Key (uint8_t const *);
  42
  43         /** Create a Key from a hex key value */
  44         Key (std::string);
  45
  46         Key (Key const &);
  47         ~Key ();
  48
  49         Key& operator= (Key const &);
  50
  51         /** @return Raw key value */
  52         uint8_t const * value () const {
  53                 return _value;
  54         }
  55
  56         /** @return Key value as a hexadecimal string */
  57         std::string hex () const;
  58
  59 private:
  60         /** Raw key value */
  61         uint8_t* _value;
  62 };
  63
  64 extern bool operator== (Key const & a, Key const & b);
  65 extern bool operator!= (Key const & a, Key const & b);
  66
  67 }
  68
  69 #endif