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