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.
14 * Copyright (C) 2007-2009 Othmar Gsenger, Erwin Nindl,
15 * Christian Pointner <satp@wirdorange.org>
17 * This file is part of Anytun.
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
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.
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/>.
33 #ifndef ANYTUN_keyDerivation_h_INCLUDED
34 #define ANYTUN_keyDerivation_h_INCLUDED
36 #include "datatypes.h"
38 #include "threadUtils.hpp"
39 #include "syncBuffer.h"
43 #ifndef USE_SSL_CRYPTO
46 #include <openssl/aes.h>
49 #include <boost/archive/text_oarchive.hpp>
50 #include <boost/archive/text_iarchive.hpp>
51 #include <boost/version.hpp>
57 #define LABEL_LEFT_ENC 0x356A192B
58 #define LABEL_RIGHT_ENC 0xDA4B9237
59 #define LABEL_LEFT_SALT 0x77DE68DA
60 #define LABEL_RIGHT_SALT 0x1B645389
61 #define LABEL_LEFT_AUTH 0xAC3478D6
62 #define LABEL_RIGHT_AUTH 0xC1DFD96E
64 typedef enum { KD_INBOUND, KD_OUTBOUND } kd_dir_t;
69 KeyDerivation() : is_initialized_(false), role_(ROLE_LEFT), key_length_(0), master_salt_(0), master_key_(0) {};
70 KeyDerivation(u_int16_t key_length) : is_initialized_(false), role_(ROLE_LEFT), key_length_(key_length), master_salt_(0), master_key_(0) {};
71 virtual ~KeyDerivation() {};
73 void setRole(const role_t role);
75 virtual void init(Buffer key, Buffer salt, std::string passphrase = "") = 0;
76 virtual bool generate(kd_dir_t dir, satp_prf_label_t label, seq_nr_t seq_nr, Buffer& key) = 0;
78 virtual std::string printType() { return "GenericKeyDerivation"; };
80 satp_prf_label_t convertLabel(kd_dir_t dir, satp_prf_label_t label);
83 virtual void updateMasterKey() = 0;
86 void calcMasterKey(std::string passphrase, u_int16_t length);
87 void calcMasterSalt(std::string passphrase, u_int16_t length);
90 KeyDerivation(const KeyDerivation & src);
91 friend class boost::serialization::access;
92 template<class Archive>
93 void serialize(Archive & ar, const unsigned int version)
95 WritersLock lock(mutex_);
103 bool is_initialized_;
105 u_int16_t key_length_;
106 SyncBuffer master_salt_;
107 SyncBuffer master_key_;
112 #if BOOST_VERSION <= 103500
113 BOOST_IS_ABSTRACT(KeyDerivation);
115 BOOST_SERIALIZATION_ASSUME_ABSTRACT(KeyDerivation);
118 //****** NullKeyDerivation ******
120 class NullKeyDerivation : public KeyDerivation
123 NullKeyDerivation() {};
124 ~NullKeyDerivation() {};
126 void init(Buffer key, Buffer salt, std::string passphrase = "") {};
127 bool generate(kd_dir_t dir, satp_prf_label_t label, seq_nr_t seq_nr, Buffer& key);
129 std::string printType() { return "NullKeyDerivation"; };
132 void updateMasterKey() {};
134 friend class boost::serialization::access;
135 template<class Archive>
136 void serialize(Archive & ar, const unsigned int version)
138 ar & boost::serialization::base_object<KeyDerivation>(*this);
144 //****** AesIcmKeyDerivation ******
146 class AesIcmKeyDerivation : public KeyDerivation
149 AesIcmKeyDerivation();
150 AesIcmKeyDerivation(u_int16_t key_length);
151 ~AesIcmKeyDerivation();
153 static const u_int16_t DEFAULT_KEY_LENGTH = 128;
154 static const u_int16_t CTR_LENGTH = 16;
155 static const u_int16_t SALT_LENGTH = 14;
157 void init(Buffer key, Buffer salt, std::string passphrase = "");
158 bool generate(kd_dir_t dir, satp_prf_label_t label, seq_nr_t seq_nr, Buffer& key);
160 std::string printType();
163 void updateMasterKey();
165 bool calcCtr(kd_dir_t dir, satp_prf_label_t label, seq_nr_t seq_nr);
167 friend class boost::serialization::access;
168 template<class Archive>
169 void serialize(Archive & ar, const unsigned int version)
171 ar & boost::serialization::base_object<KeyDerivation>(*this);
174 #ifndef USE_SSL_CRYPTO
175 gcry_cipher_hd_t handle_[2];
178 u_int8_t ecount_buf_[2][AES_BLOCK_SIZE];
182 #pragma pack(push, 1)
184 union ATTR_PACKED key_derivation_aesctr_ctr_union {
185 u_int8_t buf_[CTR_LENGTH];
187 u_int8_t buf_[SALT_LENGTH];
191 u_int8_t fill_[SALT_LENGTH - sizeof(satp_prf_label_t) - sizeof(seq_nr_t)];
192 satp_prf_label_t label_;