src/keyDerivation.h

   1 /*
   2  *  anytun
   3  *
   4  *  The secure anycast tunneling protocol (satp) defines a protocol used
   5  *  for communication between any combination of unicast and anycast
   6  *  tunnel endpoints.  It has less protocol overhead than IPSec in Tunnel
   7  *  mode and allows tunneling of every ETHER TYPE protocol (e.g.
   8  *  ethernet, ip, arp ...). satp directly includes cryptography and
   9  *  message authentication based on the methodes used by SRTP.  It is
  10  *  intended to deliver a generic, scaleable and secure solution for
  11  *  tunneling and relaying of packets of any protocol.
  12  *
  13  *
  14  *  Copyright (C) 2007-2008 Othmar Gsenger, Erwin Nindl,
  15  *                          Christian Pointner <satp@wirdorange.org>
  16  *
  17  *  This file is part of Anytun.
  18  *
  19  *  Anytun is free software: you can redistribute it and/or modify
  20  *  it under the terms of the GNU General Public License version 3 as
  21  *  published by the Free Software Foundation.
  22  *
  23  *  Anytun is distributed in the hope that it will be useful,
  24  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  *  GNU General Public License for more details.
  27  *
  28  *  You should have received a copy of the GNU General Public License
  29  *  along with anytun.  If not, see <http://www.gnu.org/licenses/>.
  30  */
  31
  32 #ifndef _KEYDERIVATION_H_
  33 #define _KEYDERIVATION_H_
  34
  35 #include "datatypes.h"
  36 #include "buffer.h"
  37 #include "threadUtils.hpp"
  38 #include "syncBuffer.h"
  39
  40 #ifndef NOCRYPT
  41 #ifndef USE_SSL_CRYPTO
  42 #include <gcrypt.h>
  43 #else
  44 #include <openssl/aes.h>
  45 #endif
  46 #endif
  47 #include <boost/archive/text_oarchive.hpp>
  48 #include <boost/archive/text_iarchive.hpp>
  49
  50
  51 typedef enum {
  52   LABEL_SATP_ENCRYPTION  = 0x00,
  53   LABEL_SATP_MSG_AUTH    = 0x01,
  54   LABEL_SATP_SALT        = 0x02,
  55 } satp_prf_label;
  56
  57 typedef enum {
  58   KD_INBOUND = 0,
  59   KD_OUTBOUND = 1
  60 } kd_dir;
  61
  62 class KeyDerivation
  63 {
  64 public:
  65   KeyDerivation() : ld_kdr_(0), key_length_(0), master_salt_(0), master_key_(0) {};
  66   KeyDerivation(u_int16_t key_length) : ld_kdr_(0), key_length_(key_length), master_salt_(0), master_key_(0) {};
  67   virtual ~KeyDerivation() {};
  68
  69   void setLogKDRate(const int8_t ld_rate);
  70
  71   virtual void init(Buffer key, Buffer salt) = 0;
  72   virtual bool generate(kd_dir dir, satp_prf_label label, seq_nr_t seq_nr, Buffer& key) = 0;
  73
  74   virtual std::string printType() { return "GenericKeyDerivation"; };
  75
  76 protected:
  77   virtual void updateMasterKey() = 0;
  78
  79         KeyDerivation(const KeyDerivation & src);
  80         friend class boost::serialization::access;
  81         template<class Archive>
  82         void serialize(Archive & ar, const unsigned int version)
  83         {
  84                 WritersLock lock(mutex_);
  85     ar & ld_kdr_;
  86     ar & key_length_;
  87     ar & master_salt_;
  88     ar & master_key_;
  89     updateMasterKey();
  90         }
  91
  92   int8_t ld_kdr_;             // ld(key_derivation_rate)
  93   u_int16_t key_length_;
  94   SyncBuffer master_salt_;
  95   SyncBuffer master_key_;
  96
  97   SharedMutex mutex_;
  98 };
  99
 100 BOOST_IS_ABSTRACT(KeyDerivation)
 101
 102 //****** NullKeyDerivation ******
 103
 104 class NullKeyDerivation : public KeyDerivation
 105 {
 106 public:
 107   NullKeyDerivation() {};
 108   ~NullKeyDerivation() {};
 109
 110   void init(Buffer key, Buffer salt) {};
 111   bool generate(kd_dir dir, satp_prf_label label, seq_nr_t seq_nr, Buffer& key);
 112
 113   std::string printType() { return "NullKeyDerivation"; };
 114
 115 private:
 116   void updateMasterKey() {};
 117
 118         friend class boost::serialization::access;
 119         template<class Archive>
 120         void serialize(Archive & ar, const unsigned int version)
 121         {
 122     ar & boost::serialization::base_object<KeyDerivation>(*this);
 123         }
 124
 125 };
 126
 127 #ifndef NOCRYPT
 128 //****** AesIcmKeyDerivation ******
 129
 130 class AesIcmKeyDerivation : public KeyDerivation
 131 {
 132 public:
 133   AesIcmKeyDerivation();
 134   AesIcmKeyDerivation(u_int16_t key_length);
 135   ~AesIcmKeyDerivation();
 136
 137   static const u_int16_t DEFAULT_KEY_LENGTH = 128;
 138   static const u_int16_t CTR_LENGTH = 16;
 139   static const u_int16_t SALT_LENGTH = 14;
 140
 141   void init(Buffer key, Buffer salt);
 142   bool generate(kd_dir dir, satp_prf_label label, seq_nr_t seq_nr, Buffer& key);
 143
 144   std::string printType();
 145
 146 private:
 147   void updateMasterKey();
 148
 149   bool calcCtr(kd_dir dir, seq_nr_t* r, satp_prf_label label, seq_nr_t seq_nr);
 150
 151         friend class boost::serialization::access;
 152         template<class Archive>
 153         void serialize(Archive & ar, const unsigned int version)
 154         {
 155     ar & boost::serialization::base_object<KeyDerivation>(*this);
 156         }
 157
 158 #ifndef USE_SSL_CRYPTO
 159   gcry_cipher_hd_t handle_;
 160 #else
 161   AES_KEY aes_key_;
 162   u_int8_t ecount_buf_[AES_BLOCK_SIZE];
 163 #endif
 164
 165   union __attribute__((__packed__)) key_derivation_aesctr_ctr_union {
 166     u_int8_t buf_[CTR_LENGTH];
 167     struct __attribute__ ((__packed__)) {
 168       u_int8_t buf_[SALT_LENGTH];
 169       u_int16_t zero_;
 170     } salt_;
 171 #ifndef ANYTUN_02_COMPAT
 172     struct __attribute__((__packed__)) {
 173       u_int8_t fill_[SALT_LENGTH - sizeof(u_int8_t) - sizeof(seq_nr_t)];
 174       u_int8_t label_;
 175       seq_nr_t r_;
 176       u_int16_t zero_;
 177     } params_;
 178 #else
 179     struct __attribute__((__packed__)) {
 180       u_int8_t fill_[SALT_LENGTH - sizeof(u_int8_t) - 2 - sizeof(seq_nr_t)];
 181       u_int8_t label_;
 182       u_int8_t r_fill_[2];
 183       seq_nr_t r_;
 184       u_int16_t zero_;
 185     } params_;
 186 #endif
 187   } ctr_;
 188 };
 189
 190 #endif
 191
 192 #endif
 193