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_lock (index_t sai);
 215 extern void ipsec_sa_clear (index_t sai);
 216 extern void ipsec_sa_set_crypto_alg (ipsec_sa_t * sa,
 217                                      ipsec_crypto_alg_t crypto_alg);
 218 extern void ipsec_sa_set_integ_alg (ipsec_sa_t * sa,
 219                                     ipsec_integ_alg_t integ_alg);
 220
 221 typedef walk_rc_t (*ipsec_sa_walk_cb_t) (ipsec_sa_t * sa, void *ctx);
 222 extern void ipsec_sa_walk (ipsec_sa_walk_cb_t cd, void *ctx);
 223
 224 extern u8 *format_ipsec_crypto_alg (u8 * s, va_list * args);
 225 extern u8 *format_ipsec_integ_alg (u8 * s, va_list * args);
 226 extern u8 *format_ipsec_sa (u8 * s, va_list * args);
 227 extern u8 *format_ipsec_key (u8 * s, va_list * args);
 228 extern uword unformat_ipsec_crypto_alg (unformat_input_t * input,
 229                                         va_list * args);
 230 extern uword unformat_ipsec_integ_alg (unformat_input_t * input,
 231                                        va_list * args);
 232 extern uword unformat_ipsec_key (unformat_input_t * input, va_list * args);
 233
 234 /*
 235  * Anti Replay definitions
 236  */
 237
 238 #define IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE (64)
 239 #define IPSEC_SA_ANTI_REPLAY_WINDOW_MAX_INDEX (IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE-1)
 240
 241 /*
 242  * sequence number less than the lower bound are outside of the window
 243  * From RFC4303 Appendix A:
 244  *  Bl = Tl - W + 1
 245  */
 246 #define IPSEC_SA_ANTI_REPLAY_WINDOW_LOWER_BOUND(_tl) (_tl - IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE + 1)
 247
 248 /*
 249  * Anti replay check.
 250  *  inputs need to be in host byte order.
 251  */
 252 always_inline int
 253 ipsec_sa_anti_replay_check (ipsec_sa_t * sa, u32 seq)
 254 {
 255   u32 diff, tl, th;
 256
 257   if ((sa->flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY) == 0)
 258     return 0;
 259
 260   if (!ipsec_sa_is_set_USE_ESN (sa))
 261     {
 262       if (PREDICT_TRUE (seq > sa->last_seq))
 263         return 0;
 264
 265       diff = sa->last_seq - seq;
 266
 267       if (IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE > diff)
 268         return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 269       else
 270         return 1;
 271
 272       return 0;
 273     }
 274
 275   tl = sa->last_seq;
 276   th = sa->last_seq_hi;
 277   diff = tl - seq;
 278
 279   if (PREDICT_TRUE (tl >= (IPSEC_SA_ANTI_REPLAY_WINDOW_MAX_INDEX)))
 280     {
 281       /*
 282        * the last sequence number VPP recieved is more than one
 283        * window size greater than zero.
 284        * Case A from RFC4303 Appendix A.
 285        */
 286       if (seq < IPSEC_SA_ANTI_REPLAY_WINDOW_LOWER_BOUND (tl))
 287         {
 288           /*
 289            * the received sequence number is lower than the lower bound
 290            * of the window, this could mean either a replay packet or that
 291            * the high sequence number has wrapped. if it decrypts corrently
 292            * then it's the latter.
 293            */
 294           sa->seq_hi = th + 1;
 295           return 0;
 296         }
 297       else
 298         {
 299           /*
 300            * the recieved sequence number greater than the low
 301            * end of the window.
 302            */
 303           sa->seq_hi = th;
 304           if (seq <= tl)
 305             /*
 306              * The recieved seq number is within bounds of the window
 307              * check if it's a duplicate
 308              */
 309             return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 310           else
 311             /*
 312              * The received sequence number is greater than the window
 313              * upper bound. this packet will move the window along, assuming
 314              * it decrypts correctly.
 315              */
 316             return 0;
 317         }
 318     }
 319   else
 320     {
 321       /*
 322        * the last sequence number VPP recieved is within one window
 323        * size of zero, i.e. 0 < TL < WINDOW_SIZE, the lower bound is thus a
 324        * large sequence number.
 325        * Note that the check below uses unsiged integer arthimetic, so the
 326        * RHS will be a larger number.
 327        * Case B from RFC4303 Appendix A.
 328        */
 329       if (seq < IPSEC_SA_ANTI_REPLAY_WINDOW_LOWER_BOUND (tl))
 330         {
 331           /*
 332            * the sequence number is less than the lower bound.
 333            */
 334           if (seq <= tl)
 335             {
 336               /*
 337                * the packet is within the window upper bound.
 338                * check for duplicates.
 339                */
 340               sa->seq_hi = th;
 341               return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 342             }
 343           else
 344             {
 345               /*
 346                * the packet is less the window lower bound or greater than
 347                * the higher bound, depending on how you look at it...
 348                * We're assuming, given that the last sequence number received,
 349                * TL < WINDOW_SIZE, that a largeer seq num is more likely to be
 350                * a packet that moves the window forward, than a packet that has
 351                * wrapped the high sequence again. If it were the latter then
 352                * we've lost close to 2^32 packets.
 353                */
 354               sa->seq_hi = th;
 355               return 0;
 356             }
 357         }
 358       else
 359         {
 360           /*
 361            * the packet seq number is between the lower bound (a large nubmer)
 362            * and MAX_SEQ_NUM. This is in the window since the window upper bound
 363            * tl > 0.
 364            * However, since TL is the other side of 0 to the received
 365            * packet, the SA has moved on to a higher sequence number.
 366            */
 367           sa->seq_hi = th - 1;
 368           return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 369         }
 370     }
 371
 372   return 0;
 373 }
 374
 375 /*
 376  * Anti replay window advance
 377  *  inputs need to be in host byte order.
 378  */
 379 always_inline void
 380 ipsec_sa_anti_replay_advance (ipsec_sa_t * sa, u32 seq)
 381 {
 382   u32 pos;
 383   if (PREDICT_TRUE (sa->flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY) == 0)
 384     return;
 385
 386   if (PREDICT_TRUE (sa->flags & IPSEC_SA_FLAG_USE_ESN))
 387     {
 388       int wrap = sa->seq_hi - sa->last_seq_hi;
 389
 390       if (wrap == 0 && seq > sa->last_seq)
 391         {
 392           pos = seq - sa->last_seq;
 393           if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
 394             sa->replay_window = ((sa->replay_window) << pos) | 1;
 395           else
 396             sa->replay_window = 1;
 397           sa->last_seq = seq;
 398         }
 399       else if (wrap > 0)
 400         {
 401           pos = ~seq + sa->last_seq + 1;
 402           if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
 403             sa->replay_window = ((sa->replay_window) << pos) | 1;
 404           else
 405             sa->replay_window = 1;
 406           sa->last_seq = seq;
 407           sa->last_seq_hi = sa->seq_hi;
 408         }
 409       else if (wrap < 0)
 410         {
 411           pos = ~seq + sa->last_seq + 1;
 412           sa->replay_window |= (1ULL << pos);
 413         }
 414       else
 415         {
 416           pos = sa->last_seq - seq;
 417           sa->replay_window |= (1ULL << pos);
 418         }
 419     }
 420   else
 421     {
 422       if (seq > sa->last_seq)
 423         {
 424           pos = seq - sa->last_seq;
 425           if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
 426             sa->replay_window = ((sa->replay_window) << pos) | 1;
 427           else
 428             sa->replay_window = 1;
 429           sa->last_seq = seq;
 430         }
 431       else
 432         {
 433           pos = sa->last_seq - seq;
 434           sa->replay_window |= (1ULL << pos);
 435         }
 436     }
 437 }
 438
 439 #endif /* __IPSEC_SPD_SA_H__ */
 440
 441 /*
 442  * fd.io coding-style-patch-verification: ON
 443  *
 444  * Local Variables:
 445  * eval: (c-set-style "gnu")
 446  * End:
 447  */