src/vnet/ipsec/ipsec_sa.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 __IPSEC_SPD_SA_H__
  16 #define __IPSEC_SPD_SA_H__
  17
  18 #include <vlib/vlib.h>
  19 #include <vnet/crypto/crypto.h>
  20 #include <vnet/ip/ip.h>
  21 #include <vnet/fib/fib_node.h>
  22
  23 #define foreach_ipsec_crypto_alg    \
  24   _ (0, NONE, "none")               \
  25   _ (1, AES_CBC_128, "aes-cbc-128") \
  26   _ (2, AES_CBC_192, "aes-cbc-192") \
  27   _ (3, AES_CBC_256, "aes-cbc-256") \
  28   _ (4, AES_CTR_128, "aes-ctr-128") \
  29   _ (5, AES_CTR_192, "aes-ctr-192") \
  30   _ (6, AES_CTR_256, "aes-ctr-256") \
  31   _ (7, AES_GCM_128, "aes-gcm-128") \
  32   _ (8, AES_GCM_192, "aes-gcm-192") \
  33   _ (9, AES_GCM_256, "aes-gcm-256") \
  34   _ (10, DES_CBC, "des-cbc")        \
  35   _ (11, 3DES_CBC, "3des-cbc")
  36
  37 typedef enum
  38 {
  39 #define _(v, f, s) IPSEC_CRYPTO_ALG_##f = v,
  40   foreach_ipsec_crypto_alg
  41 #undef _
  42     IPSEC_CRYPTO_N_ALG,
  43 } ipsec_crypto_alg_t;
  44
  45 #define IPSEC_CRYPTO_ALG_IS_GCM(_alg)                     \
  46   (((_alg == IPSEC_CRYPTO_ALG_AES_GCM_128) ||             \
  47     (_alg == IPSEC_CRYPTO_ALG_AES_GCM_192) ||             \
  48     (_alg == IPSEC_CRYPTO_ALG_AES_GCM_256)))
  49
  50 #define foreach_ipsec_integ_alg                                            \
  51   _ (0, NONE, "none")                                                      \
  52   _ (1, MD5_96, "md5-96")           /* RFC2403 */                          \
  53   _ (2, SHA1_96, "sha1-96")         /* RFC2404 */                          \
  54   _ (3, SHA_256_96, "sha-256-96")   /* draft-ietf-ipsec-ciph-sha-256-00 */ \
  55   _ (4, SHA_256_128, "sha-256-128") /* RFC4868 */                          \
  56   _ (5, SHA_384_192, "sha-384-192") /* RFC4868 */                          \
  57   _ (6, SHA_512_256, "sha-512-256")     /* RFC4868 */
  58
  59 typedef enum
  60 {
  61 #define _(v, f, s) IPSEC_INTEG_ALG_##f = v,
  62   foreach_ipsec_integ_alg
  63 #undef _
  64     IPSEC_INTEG_N_ALG,
  65 } ipsec_integ_alg_t;
  66
  67 typedef enum
  68 {
  69   IPSEC_PROTOCOL_AH = 0,
  70   IPSEC_PROTOCOL_ESP = 1
  71 } ipsec_protocol_t;
  72
  73 #define IPSEC_KEY_MAX_LEN 128
  74 typedef struct ipsec_key_t_
  75 {
  76   u8 len;
  77   u8 data[IPSEC_KEY_MAX_LEN];
  78 } ipsec_key_t;
  79
  80 /*
  81  * Enable extended sequence numbers
  82  * Enable Anti-replay
  83  * IPsec tunnel mode if non-zero, else transport mode
  84  * IPsec tunnel mode is IPv6 if non-zero,
  85  * else IPv4 tunnel only valid if is_tunnel is non-zero
  86  * enable UDP encapsulation for NAT traversal
  87  */
  88 #define foreach_ipsec_sa_flags                            \
  89   _ (0, NONE, "none")                                     \
  90   _ (1, USE_ESN, "esn")                                   \
  91   _ (2, USE_ANTI_REPLAY, "anti-replay")                   \
  92   _ (4, IS_TUNNEL, "tunnel")                              \
  93   _ (8, IS_TUNNEL_V6, "tunnel-v6")                        \
  94   _ (16, UDP_ENCAP, "udp-encap")                          \
  95   _ (32, IS_PROTECT, "Protect")                           \
  96   _ (64, IS_INBOUND, "inbound")                           \
  97   _ (128, IS_AEAD, "aead")                                \
  98
  99 typedef enum ipsec_sad_flags_t_
 100 {
 101 #define _(v, f, s) IPSEC_SA_FLAG_##f = v,
 102   foreach_ipsec_sa_flags
 103 #undef _
 104 } __clib_packed ipsec_sa_flags_t;
 105
 106 STATIC_ASSERT (sizeof (ipsec_sa_flags_t) == 1, "IPSEC SA flags > 1 byte");
 107
 108 typedef struct
 109 {
 110   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 111
 112   /* flags */
 113   ipsec_sa_flags_t flags;
 114
 115   u8 crypto_iv_size;
 116   u8 crypto_block_size;
 117   u8 integ_icv_size;
 118   u32 encrypt_thread_index;
 119   u32 decrypt_thread_index;
 120   u32 spi;
 121   u32 seq;
 122   u32 seq_hi;
 123   u32 last_seq;
 124   u32 last_seq_hi;
 125   u64 replay_window;
 126   dpo_id_t dpo;
 127
 128   vnet_crypto_key_index_t crypto_key_index;
 129   vnet_crypto_key_index_t integ_key_index;
 130   vnet_crypto_op_id_t crypto_enc_op_id:16;
 131   vnet_crypto_op_id_t crypto_dec_op_id:16;
 132   vnet_crypto_op_id_t integ_op_id:16;
 133
 134   /* data accessed by dataplane code should be above this comment */
 135     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 136
 137   union
 138   {
 139     ip4_header_t ip4_hdr;
 140     ip6_header_t ip6_hdr;
 141   };
 142   udp_header_t udp_hdr;
 143
 144   fib_node_t node;
 145   u32 id;
 146   u32 stat_index;
 147   ipsec_protocol_t protocol;
 148
 149   ipsec_crypto_alg_t crypto_alg;
 150   ipsec_key_t crypto_key;
 151   vnet_crypto_alg_t crypto_calg;
 152
 153   ipsec_integ_alg_t integ_alg;
 154   ipsec_key_t integ_key;
 155   vnet_crypto_alg_t integ_calg;
 156
 157   ip46_address_t tunnel_src_addr;
 158   ip46_address_t tunnel_dst_addr;
 159
 160   fib_node_index_t fib_entry_index;
 161   u32 sibling;
 162
 163   u32 tx_fib_index;
 164
 165   /* Salt used in GCM modes - stored in network byte order */
 166   u32 salt;
 167   u64 gcm_iv_counter;
 168 } ipsec_sa_t;
 169
 170 STATIC_ASSERT_OFFSET_OF (ipsec_sa_t, cacheline1, CLIB_CACHE_LINE_BYTES);
 171
 172 #define _(a,v,s)                                                        \
 173   always_inline int                                                     \
 174   ipsec_sa_is_set_##v (const ipsec_sa_t *sa) {                          \
 175     return (sa->flags & IPSEC_SA_FLAG_##v);                             \
 176   }
 177 foreach_ipsec_sa_flags
 178 #undef _
 179 #define _(a,v,s)                                                        \
 180   always_inline int                                                     \
 181   ipsec_sa_set_##v (ipsec_sa_t *sa) {                                   \
 182     return (sa->flags |= IPSEC_SA_FLAG_##v);                            \
 183   }
 184   foreach_ipsec_sa_flags
 185 #undef _
 186 #define _(a,v,s)                                                        \
 187   always_inline int                                                     \
 188   ipsec_sa_unset_##v (ipsec_sa_t *sa) {                                 \
 189     return (sa->flags &= ~IPSEC_SA_FLAG_##v);                           \
 190   }
 191   foreach_ipsec_sa_flags
 192 #undef _
 193 /**
 194  * @brief
 195  * SA packet & bytes counters
 196  */
 197 extern vlib_combined_counter_main_t ipsec_sa_counters;
 198
 199 extern void ipsec_mk_key (ipsec_key_t * key, const u8 * data, u8 len);
 200
 201 extern int ipsec_sa_add_and_lock (u32 id,
 202                                   u32 spi,
 203                                   ipsec_protocol_t proto,
 204                                   ipsec_crypto_alg_t crypto_alg,
 205                                   const ipsec_key_t * ck,
 206                                   ipsec_integ_alg_t integ_alg,
 207                                   const ipsec_key_t * ik,
 208                                   ipsec_sa_flags_t flags,
 209                                   u32 tx_table_id,
 210                                   u32 salt,
 211                                   const ip46_address_t * tunnel_src_addr,
 212                                   const ip46_address_t * tunnel_dst_addr,
 213                                   u32 * sa_index, u16 dst_port);
 214 extern index_t ipsec_sa_find_and_lock (u32 id);
 215 extern int ipsec_sa_unlock_id (u32 id);
 216 extern void ipsec_sa_unlock (index_t sai);
 217 extern void ipsec_sa_lock (index_t sai);
 218 extern void ipsec_sa_clear (index_t sai);
 219 extern void ipsec_sa_set_crypto_alg (ipsec_sa_t * sa,
 220                                      ipsec_crypto_alg_t crypto_alg);
 221 extern void ipsec_sa_set_integ_alg (ipsec_sa_t * sa,
 222                                     ipsec_integ_alg_t integ_alg);
 223
 224 typedef walk_rc_t (*ipsec_sa_walk_cb_t) (ipsec_sa_t * sa, void *ctx);
 225 extern void ipsec_sa_walk (ipsec_sa_walk_cb_t cd, void *ctx);
 226
 227 extern u8 *format_ipsec_crypto_alg (u8 * s, va_list * args);
 228 extern u8 *format_ipsec_integ_alg (u8 * s, va_list * args);
 229 extern u8 *format_ipsec_sa (u8 * s, va_list * args);
 230 extern u8 *format_ipsec_key (u8 * s, va_list * args);
 231 extern uword unformat_ipsec_crypto_alg (unformat_input_t * input,
 232                                         va_list * args);
 233 extern uword unformat_ipsec_integ_alg (unformat_input_t * input,
 234                                        va_list * args);
 235 extern uword unformat_ipsec_key (unformat_input_t * input, va_list * args);
 236
 237 #define IPSEC_UDP_PORT_NONE ((u16)~0)
 238
 239 /*
 240  * Anti Replay definitions
 241  */
 242
 243 #define IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE (64)
 244 #define IPSEC_SA_ANTI_REPLAY_WINDOW_MAX_INDEX (IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE-1)
 245
 246 /*
 247  * sequence number less than the lower bound are outside of the window
 248  * From RFC4303 Appendix A:
 249  *  Bl = Tl - W + 1
 250  */
 251 #define IPSEC_SA_ANTI_REPLAY_WINDOW_LOWER_BOUND(_tl) (_tl - IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE + 1)
 252
 253 /*
 254  * Anti replay check.
 255  *  inputs need to be in host byte order.
 256  */
 257 always_inline int
 258 ipsec_sa_anti_replay_check (ipsec_sa_t * sa, u32 seq)
 259 {
 260   u32 diff, tl, th;
 261
 262   if ((sa->flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY) == 0)
 263     return 0;
 264
 265   if (!ipsec_sa_is_set_USE_ESN (sa))
 266     {
 267       if (PREDICT_TRUE (seq > sa->last_seq))
 268         return 0;
 269
 270       diff = sa->last_seq - seq;
 271
 272       if (IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE > diff)
 273         return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 274       else
 275         return 1;
 276
 277       return 0;
 278     }
 279
 280   tl = sa->last_seq;
 281   th = sa->last_seq_hi;
 282   diff = tl - seq;
 283
 284   if (PREDICT_TRUE (tl >= (IPSEC_SA_ANTI_REPLAY_WINDOW_MAX_INDEX)))
 285     {
 286       /*
 287        * the last sequence number VPP recieved is more than one
 288        * window size greater than zero.
 289        * Case A from RFC4303 Appendix A.
 290        */
 291       if (seq < IPSEC_SA_ANTI_REPLAY_WINDOW_LOWER_BOUND (tl))
 292         {
 293           /*
 294            * the received sequence number is lower than the lower bound
 295            * of the window, this could mean either a replay packet or that
 296            * the high sequence number has wrapped. if it decrypts corrently
 297            * then it's the latter.
 298            */
 299           sa->seq_hi = th + 1;
 300           return 0;
 301         }
 302       else
 303         {
 304           /*
 305            * the recieved sequence number greater than the low
 306            * end of the window.
 307            */
 308           sa->seq_hi = th;
 309           if (seq <= tl)
 310             /*
 311              * The recieved seq number is within bounds of the window
 312              * check if it's a duplicate
 313              */
 314             return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 315           else
 316             /*
 317              * The received sequence number is greater than the window
 318              * upper bound. this packet will move the window along, assuming
 319              * it decrypts correctly.
 320              */
 321             return 0;
 322         }
 323     }
 324   else
 325     {
 326       /*
 327        * the last sequence number VPP recieved is within one window
 328        * size of zero, i.e. 0 < TL < WINDOW_SIZE, the lower bound is thus a
 329        * large sequence number.
 330        * Note that the check below uses unsiged integer arthimetic, so the
 331        * RHS will be a larger number.
 332        * Case B from RFC4303 Appendix A.
 333        */
 334       if (seq < IPSEC_SA_ANTI_REPLAY_WINDOW_LOWER_BOUND (tl))
 335         {
 336           /*
 337            * the sequence number is less than the lower bound.
 338            */
 339           if (seq <= tl)
 340             {
 341               /*
 342                * the packet is within the window upper bound.
 343                * check for duplicates.
 344                */
 345               sa->seq_hi = th;
 346               return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 347             }
 348           else
 349             {
 350               /*
 351                * the packet is less the window lower bound or greater than
 352                * the higher bound, depending on how you look at it...
 353                * We're assuming, given that the last sequence number received,
 354                * TL < WINDOW_SIZE, that a largeer seq num is more likely to be
 355                * a packet that moves the window forward, than a packet that has
 356                * wrapped the high sequence again. If it were the latter then
 357                * we've lost close to 2^32 packets.
 358                */
 359               sa->seq_hi = th;
 360               return 0;
 361             }
 362         }
 363       else
 364         {
 365           /*
 366            * the packet seq number is between the lower bound (a large nubmer)
 367            * and MAX_SEQ_NUM. This is in the window since the window upper bound
 368            * tl > 0.
 369            * However, since TL is the other side of 0 to the received
 370            * packet, the SA has moved on to a higher sequence number.
 371            */
 372           sa->seq_hi = th - 1;
 373           return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 374         }
 375     }
 376
 377   return 0;
 378 }
 379
 380 /*
 381  * Anti replay window advance
 382  *  inputs need to be in host byte order.
 383  */
 384 always_inline void
 385 ipsec_sa_anti_replay_advance (ipsec_sa_t * sa, u32 seq)
 386 {
 387   u32 pos;
 388   if (PREDICT_TRUE (sa->flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY) == 0)
 389     return;
 390
 391   if (PREDICT_TRUE (sa->flags & IPSEC_SA_FLAG_USE_ESN))
 392     {
 393       int wrap = sa->seq_hi - sa->last_seq_hi;
 394
 395       if (wrap == 0 && seq > sa->last_seq)
 396         {
 397           pos = seq - sa->last_seq;
 398           if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
 399             sa->replay_window = ((sa->replay_window) << pos) | 1;
 400           else
 401             sa->replay_window = 1;
 402           sa->last_seq = seq;
 403         }
 404       else if (wrap > 0)
 405         {
 406           pos = ~seq + sa->last_seq + 1;
 407           if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
 408             sa->replay_window = ((sa->replay_window) << pos) | 1;
 409           else
 410             sa->replay_window = 1;
 411           sa->last_seq = seq;
 412           sa->last_seq_hi = sa->seq_hi;
 413         }
 414       else if (wrap < 0)
 415         {
 416           pos = ~seq + sa->last_seq + 1;
 417           sa->replay_window |= (1ULL << pos);
 418         }
 419       else
 420         {
 421           pos = sa->last_seq - seq;
 422           sa->replay_window |= (1ULL << pos);
 423         }
 424     }
 425   else
 426     {
 427       if (seq > sa->last_seq)
 428         {
 429           pos = seq - sa->last_seq;
 430           if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
 431             sa->replay_window = ((sa->replay_window) << pos) | 1;
 432           else
 433             sa->replay_window = 1;
 434           sa->last_seq = seq;
 435         }
 436       else
 437         {
 438           pos = sa->last_seq - seq;
 439           sa->replay_window |= (1ULL << pos);
 440         }
 441     }
 442 }
 443
 444
 445 /*
 446  * Makes choice for thread_id should be assigned.
 447  *  if input ~0, gets random worker_id based on unix_time_now_nsec
 448 */
 449 always_inline u32
 450 ipsec_sa_assign_thread (u32 thread_id)
 451 {
 452   return ((thread_id) ? thread_id
 453           : (unix_time_now_nsec () % vlib_num_workers ()) + 1);
 454 }
 455
 456 #endif /* __IPSEC_SPD_SA_H__ */
 457
 458 /*
 459  * fd.io coding-style-patch-verification: ON
 460  *
 461  * Local Variables:
 462  * eval: (c-set-style "gnu")
 463  * End:
 464  */