src/cipher.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 methods 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-2014 Markus Grüneis, 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 as published by
  21  *  the Free Software Foundation, either version 3 of the License, or
  22  *  any later version.
  23  *
  24  *  Anytun is distributed in the hope that it will be useful,
  25  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  *  GNU General Public License for more details.
  28  *
  29  *  You should have received a copy of the GNU General Public License
  30  *  along with Anytun.  If not, see <http://www.gnu.org/licenses/>.
  31  *
  32  *  In addition, as a special exception, the copyright holders give
  33  *  permission to link the code of portions of this program with the
  34  *  OpenSSL library under certain conditions as described in each
  35  *  individual source file, and distribute linked combinations
  36  *  including the two.
  37  *  You must obey the GNU General Public License in all respects
  38  *  for all of the code used other than OpenSSL.  If you modify
  39  *  file(s) with this exception, you may extend this exception to your
  40  *  version of the file(s), but you are not obligated to do so.  If you
  41  *  do not wish to do so, delete this exception statement from your
  42  *  version.  If you delete this exception statement from all source
  43  *  files in the program, then also delete it here.
  44  */
  45
  46 #ifndef ANYTUN_cipher_h_INCLUDED
  47 #define ANYTUN_cipher_h_INCLUDED
  48
  49 #include "datatypes.h"
  50 #include "buffer.h"
  51 #include "encryptedPacket.h"
  52 #include "plainPacket.h"
  53 #include "keyDerivation.h"
  54
  55 #ifndef NO_CRYPT
  56
  57 #if defined(USE_SSL_CRYPTO)
  58 #include <openssl/aes.h>
  59 #elif defined(USE_NETTLE)
  60 #include <nettle/aes.h>
  61 #else  // USE_GCRYPT is the default
  62 #include <gcrypt.h>
  63 #endif
  64
  65 #endif
  66
  67 class Cipher
  68 {
  69 public:
  70   Cipher() : dir_(KD_INBOUND) {};
  71   Cipher(kd_dir_t d) : dir_(d) {};
  72   virtual ~Cipher() {};
  73
  74   void encrypt(KeyDerivation& kd, PlainPacket& in, EncryptedPacket& out, seq_nr_t seq_nr, sender_id_t sender_id, mux_t mux);
  75   void decrypt(KeyDerivation& kd, EncryptedPacket& in, PlainPacket& out);
  76
  77 protected:
  78   virtual uint32_t cipher(KeyDerivation& kd, uint8_t* in, uint32_t ilen, uint8_t* out, uint32_t olen, seq_nr_t seq_nr, sender_id_t sender_id, mux_t mux) = 0;
  79   virtual uint32_t decipher(KeyDerivation& kd, uint8_t* in, uint32_t ilen, uint8_t* out, uint32_t olen, seq_nr_t seq_nr, sender_id_t sender_id, mux_t mux) = 0;
  80
  81   kd_dir_t dir_;
  82 };
  83
  84 //****** NullCipher ******
  85
  86 class NullCipher : public Cipher
  87 {
  88 protected:
  89   uint32_t cipher(KeyDerivation& kd, uint8_t* in, uint32_t ilen, uint8_t* out, uint32_t olen, seq_nr_t seq_nr, sender_id_t sender_id, mux_t mux);
  90   uint32_t decipher(KeyDerivation& kd, uint8_t* in, uint32_t ilen, uint8_t* out, uint32_t olen, seq_nr_t seq_nr, sender_id_t sender_id, mux_t mux);
  91 };
  92
  93 #ifndef NO_CRYPT
  94 //****** AesIcmCipher ******
  95
  96 class AesIcmCipher : public Cipher
  97 {
  98 public:
  99   AesIcmCipher(kd_dir_t d);
 100   AesIcmCipher(kd_dir_t d, uint16_t key_length);
 101   ~AesIcmCipher();
 102
 103   static const uint16_t DEFAULT_KEY_LENGTH = 128;
 104   static const uint16_t CTR_LENGTH = 16;
 105   static const uint16_t SALT_LENGTH = 14;
 106
 107 protected:
 108   uint32_t cipher(KeyDerivation& kd, uint8_t* in, uint32_t ilen, uint8_t* out, uint32_t olen, seq_nr_t seq_nr, sender_id_t sender_id, mux_t mux);
 109   uint32_t decipher(KeyDerivation& kd, uint8_t* in, uint32_t ilen, uint8_t* out, uint32_t olen, seq_nr_t seq_nr, sender_id_t sender_id, mux_t mux);
 110
 111 private:
 112   void init(uint16_t key_length = DEFAULT_KEY_LENGTH);
 113
 114   void calcCtr(KeyDerivation& kd, seq_nr_t seq_nr, sender_id_t sender_id, mux_t mux);
 115   void calc(KeyDerivation& kd, uint8_t* in, uint32_t ilen, uint8_t* out, uint32_t olen, seq_nr_t seq_nr, sender_id_t sender_id, mux_t mux);
 116
 117 #if defined(USE_SSL_CRYPTO)
 118   AES_KEY aes_key_;
 119   uint8_t ecount_buf_[AES_BLOCK_SIZE];
 120 #elif defined(USE_NETTLE)
 121   struct aes_ctx ctx_;
 122 #else  // USE_GCRYPT is the default
 123   gcry_cipher_hd_t handle_;
 124 #endif
 125
 126   Buffer key_;
 127   Buffer salt_;
 128
 129 #ifdef _MSC_VER
 130 #pragma pack(push, 1)
 131 #endif
 132   union ATTR_PACKED cipher_aesctr_ctr_union {
 133     uint8_t buf_[CTR_LENGTH];
 134     struct ATTR_PACKED {
 135       uint8_t buf_[SALT_LENGTH];
 136       uint16_t zero_;
 137     } salt_;
 138     struct ATTR_PACKED {
 139       uint8_t fill_[SALT_LENGTH - sizeof(mux_t) - sizeof(sender_id_t) - 2*sizeof(uint8_t) - sizeof(seq_nr_t)];
 140       mux_t mux_;
 141       sender_id_t sender_id_;
 142       uint8_t empty_[2];
 143       seq_nr_t seq_nr_;
 144       uint16_t zero_;
 145     } params_;
 146   } ctr_;
 147 #ifdef _MSC_VER
 148 #pragma pack(pop)
 149 #endif
 150 };
 151 #endif
 152
 153 #endif