src/vnet/ipsec/esp.h

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 #ifndef __ESP_H__
  16 #define __ESP_H__
  17
  18 #include <vnet/ip/ip.h>
  19 #include <vnet/ipsec/ipsec.h>
  20
  21 #include <openssl/hmac.h>
  22 #include <openssl/rand.h>
  23 #include <openssl/evp.h>
  24
  25 typedef struct
  26 {
  27   u32 spi;
  28   u32 seq;
  29   u8 data[0];
  30 } esp_header_t;
  31
  32 typedef struct
  33 {
  34   u8 pad_length;
  35   u8 next_header;
  36 } esp_footer_t;
  37
  38 /* *INDENT-OFF* */
  39 typedef CLIB_PACKED (struct {
  40   ip4_header_t ip4;
  41   esp_header_t esp;
  42 }) ip4_and_esp_header_t;
  43 /* *INDENT-ON* */
  44
  45 /* *INDENT-OFF* */
  46 typedef CLIB_PACKED (struct {
  47   ip6_header_t ip6;
  48   esp_header_t esp;
  49 }) ip6_and_esp_header_t;
  50 /* *INDENT-ON* */
  51
  52 typedef struct
  53 {
  54   const EVP_CIPHER *type;
  55 } ipsec_proto_main_crypto_alg_t;
  56
  57 typedef struct
  58 {
  59   const EVP_MD *md;
  60   u8 trunc_size;
  61 } ipsec_proto_main_integ_alg_t;
  62
  63 typedef struct
  64 {
  65   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  66 #if OPENSSL_VERSION_NUMBER >= 0x10100000L
  67   EVP_CIPHER_CTX *encrypt_ctx;
  68 #else
  69   EVP_CIPHER_CTX encrypt_ctx;
  70 #endif
  71     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
  72 #if OPENSSL_VERSION_NUMBER >= 0x10100000L
  73   EVP_CIPHER_CTX *decrypt_ctx;
  74 #else
  75   EVP_CIPHER_CTX decrypt_ctx;
  76 #endif
  77     CLIB_CACHE_LINE_ALIGN_MARK (cacheline2);
  78 #if OPENSSL_VERSION_NUMBER >= 0x10100000L
  79   HMAC_CTX *hmac_ctx;
  80 #else
  81   HMAC_CTX hmac_ctx;
  82 #endif
  83   ipsec_crypto_alg_t last_encrypt_alg;
  84   ipsec_crypto_alg_t last_decrypt_alg;
  85   ipsec_integ_alg_t last_integ_alg;
  86 } ipsec_proto_main_per_thread_data_t;
  87
  88 typedef struct
  89 {
  90   ipsec_proto_main_crypto_alg_t *ipsec_proto_main_crypto_algs;
  91   ipsec_proto_main_integ_alg_t *ipsec_proto_main_integ_algs;
  92   ipsec_proto_main_per_thread_data_t *per_thread_data;
  93 } ipsec_proto_main_t;
  94
  95 extern ipsec_proto_main_t ipsec_proto_main;
  96
  97 #define ESP_WINDOW_SIZE         (64)
  98 #define ESP_SEQ_MAX             (4294967295UL)
  99
 100 u8 *format_esp_header (u8 * s, va_list * args);
 101
 102 always_inline int
 103 esp_replay_check (ipsec_sa_t * sa, u32 seq)
 104 {
 105   u32 diff;
 106
 107   if (PREDICT_TRUE (seq > sa->last_seq))
 108     return 0;
 109
 110   diff = sa->last_seq - seq;
 111
 112   if (ESP_WINDOW_SIZE > diff)
 113     return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 114   else
 115     return 1;
 116
 117   return 0;
 118 }
 119
 120 always_inline int
 121 esp_replay_check_esn (ipsec_sa_t * sa, u32 seq)
 122 {
 123   u32 tl = sa->last_seq;
 124   u32 th = sa->last_seq_hi;
 125   u32 diff = tl - seq;
 126
 127   if (PREDICT_TRUE (tl >= (ESP_WINDOW_SIZE - 1)))
 128     {
 129       if (seq >= (tl - ESP_WINDOW_SIZE + 1))
 130         {
 131           sa->seq_hi = th;
 132           if (seq <= tl)
 133             return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 134           else
 135             return 0;
 136         }
 137       else
 138         {
 139           sa->seq_hi = th + 1;
 140           return 0;
 141         }
 142     }
 143   else
 144     {
 145       if (seq >= (tl - ESP_WINDOW_SIZE + 1))
 146         {
 147           sa->seq_hi = th - 1;
 148           return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 149         }
 150       else
 151         {
 152           sa->seq_hi = th;
 153           if (seq <= tl)
 154             return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 155           else
 156             return 0;
 157         }
 158     }
 159
 160   return 0;
 161 }
 162
 163 /* TODO seq increment should be atomic to be accessed by multiple workers */
 164 always_inline void
 165 esp_replay_advance (ipsec_sa_t * sa, u32 seq)
 166 {
 167   u32 pos;
 168
 169   if (seq > sa->last_seq)
 170     {
 171       pos = seq - sa->last_seq;
 172       if (pos < ESP_WINDOW_SIZE)
 173         sa->replay_window = ((sa->replay_window) << pos) | 1;
 174       else
 175         sa->replay_window = 1;
 176       sa->last_seq = seq;
 177     }
 178   else
 179     {
 180       pos = sa->last_seq - seq;
 181       sa->replay_window |= (1ULL << pos);
 182     }
 183 }
 184
 185 always_inline void
 186 esp_replay_advance_esn (ipsec_sa_t * sa, u32 seq)
 187 {
 188   int wrap = sa->seq_hi - sa->last_seq_hi;
 189   u32 pos;
 190
 191   if (wrap == 0 && seq > sa->last_seq)
 192     {
 193       pos = seq - sa->last_seq;
 194       if (pos < ESP_WINDOW_SIZE)
 195         sa->replay_window = ((sa->replay_window) << pos) | 1;
 196       else
 197         sa->replay_window = 1;
 198       sa->last_seq = seq;
 199     }
 200   else if (wrap > 0)
 201     {
 202       pos = ~seq + sa->last_seq + 1;
 203       if (pos < ESP_WINDOW_SIZE)
 204         sa->replay_window = ((sa->replay_window) << pos) | 1;
 205       else
 206         sa->replay_window = 1;
 207       sa->last_seq = seq;
 208       sa->last_seq_hi = sa->seq_hi;
 209     }
 210   else if (wrap < 0)
 211     {
 212       pos = ~seq + sa->last_seq + 1;
 213       sa->replay_window |= (1ULL << pos);
 214     }
 215   else
 216     {
 217       pos = sa->last_seq - seq;
 218       sa->replay_window |= (1ULL << pos);
 219     }
 220 }
 221
 222 always_inline int
 223 esp_seq_advance (ipsec_sa_t * sa)
 224 {
 225   if (PREDICT_TRUE (sa->use_esn))
 226     {
 227       if (PREDICT_FALSE (sa->seq == ESP_SEQ_MAX))
 228         {
 229           if (PREDICT_FALSE
 230               (sa->use_anti_replay && sa->seq_hi == ESP_SEQ_MAX))
 231             return 1;
 232           sa->seq_hi++;
 233         }
 234       sa->seq++;
 235     }
 236   else
 237     {
 238       if (PREDICT_FALSE (sa->use_anti_replay && sa->seq == ESP_SEQ_MAX))
 239         return 1;
 240       sa->seq++;
 241     }
 242
 243   return 0;
 244 }
 245
 246 always_inline void
 247 ipsec_proto_init ()
 248 {
 249   ipsec_proto_main_t *em = &ipsec_proto_main;
 250   vlib_thread_main_t *tm = vlib_get_thread_main ();
 251
 252   memset (em, 0, sizeof (em[0]));
 253
 254   vec_validate (em->ipsec_proto_main_crypto_algs, IPSEC_CRYPTO_N_ALG - 1);
 255   em->ipsec_proto_main_crypto_algs[IPSEC_CRYPTO_ALG_AES_CBC_128].type =
 256     EVP_aes_128_cbc ();
 257   em->ipsec_proto_main_crypto_algs[IPSEC_CRYPTO_ALG_AES_CBC_192].type =
 258     EVP_aes_192_cbc ();
 259   em->ipsec_proto_main_crypto_algs[IPSEC_CRYPTO_ALG_AES_CBC_256].type =
 260     EVP_aes_256_cbc ();
 261
 262   vec_validate (em->ipsec_proto_main_integ_algs, IPSEC_INTEG_N_ALG - 1);
 263   ipsec_proto_main_integ_alg_t *i;
 264
 265   i = &em->ipsec_proto_main_integ_algs[IPSEC_INTEG_ALG_SHA1_96];
 266   i->md = EVP_sha1 ();
 267   i->trunc_size = 12;
 268
 269   i = &em->ipsec_proto_main_integ_algs[IPSEC_INTEG_ALG_SHA_256_96];
 270   i->md = EVP_sha256 ();
 271   i->trunc_size = 12;
 272
 273   i = &em->ipsec_proto_main_integ_algs[IPSEC_INTEG_ALG_SHA_256_128];
 274   i->md = EVP_sha256 ();
 275   i->trunc_size = 16;
 276
 277   i = &em->ipsec_proto_main_integ_algs[IPSEC_INTEG_ALG_SHA_384_192];
 278   i->md = EVP_sha384 ();
 279   i->trunc_size = 24;
 280
 281   i = &em->ipsec_proto_main_integ_algs[IPSEC_INTEG_ALG_SHA_512_256];
 282   i->md = EVP_sha512 ();
 283   i->trunc_size = 32;
 284
 285   vec_validate_aligned (em->per_thread_data, tm->n_vlib_mains - 1,
 286                         CLIB_CACHE_LINE_BYTES);
 287   int thread_id;
 288
 289   for (thread_id = 0; thread_id < tm->n_vlib_mains - 1; thread_id++)
 290     {
 291 #if OPENSSL_VERSION_NUMBER >= 0x10100000L
 292       em->per_thread_data[thread_id].encrypt_ctx = EVP_CIPHER_CTX_new ();
 293       em->per_thread_data[thread_id].decrypt_ctx = EVP_CIPHER_CTX_new ();
 294       em->per_thread_data[thread_id].hmac_ctx = HMAC_CTX_new ();
 295 #else
 296       EVP_CIPHER_CTX_init (&(em->per_thread_data[thread_id].encrypt_ctx));
 297       EVP_CIPHER_CTX_init (&(em->per_thread_data[thread_id].decrypt_ctx));
 298       HMAC_CTX_init (&(em->per_thread_data[thread_id].hmac_ctx));
 299 #endif
 300     }
 301 }
 302
 303 always_inline unsigned int
 304 hmac_calc (ipsec_integ_alg_t alg,
 305            u8 * key,
 306            int key_len,
 307            u8 * data, int data_len, u8 * signature, u8 use_esn, u32 seq_hi)
 308 {
 309   ipsec_proto_main_t *em = &ipsec_proto_main;
 310   u32 thread_index = vlib_get_thread_index ();
 311 #if OPENSSL_VERSION_NUMBER >= 0x10100000L
 312   HMAC_CTX *ctx = em->per_thread_data[thread_index].hmac_ctx;
 313 #else
 314   HMAC_CTX *ctx = &(em->per_thread_data[thread_index].hmac_ctx);
 315 #endif
 316   const EVP_MD *md = NULL;
 317   unsigned int len;
 318
 319   ASSERT (alg < IPSEC_INTEG_N_ALG);
 320
 321   if (PREDICT_FALSE (em->ipsec_proto_main_integ_algs[alg].md == 0))
 322     return 0;
 323
 324   if (PREDICT_FALSE (alg != em->per_thread_data[thread_index].last_integ_alg))
 325     {
 326       md = em->ipsec_proto_main_integ_algs[alg].md;
 327       em->per_thread_data[thread_index].last_integ_alg = alg;
 328     }
 329
 330   HMAC_Init_ex (ctx, key, key_len, md, NULL);
 331
 332   HMAC_Update (ctx, data, data_len);
 333
 334   if (PREDICT_TRUE (use_esn))
 335     HMAC_Update (ctx, (u8 *) & seq_hi, sizeof (seq_hi));
 336   HMAC_Final (ctx, signature, &len);
 337
 338   return em->ipsec_proto_main_integ_algs[alg].trunc_size;
 339 }
 340
 341 #endif /* __ESP_H__ */
 342
 343 /*
 344  * fd.io coding-style-patch-verification: ON
 345  *
 346  * Local Variables:
 347  * eval: (c-set-style "gnu")
 348  * End:
 349  */