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