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 IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE (64)
  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 } 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 foreach_ipsec_integ_alg                                            \
  52   _ (0, NONE, "none")                                                      \
  53   _ (1, MD5_96, "md5-96")           /* RFC2403 */                          \
  54   _ (2, SHA1_96, "sha1-96")         /* RFC2404 */                          \
  55   _ (3, SHA_256_96, "sha-256-96")   /* draft-ietf-ipsec-ciph-sha-256-00 */ \
  56   _ (4, SHA_256_128, "sha-256-128") /* RFC4868 */                          \
  57   _ (5, SHA_384_192, "sha-384-192") /* RFC4868 */                          \
  58   _ (6, SHA_512_256, "sha-512-256")     /* RFC4868 */
  59
  60 typedef enum
  61 {
  62 #define _(v, f, s) IPSEC_INTEG_ALG_##f = v,
  63   foreach_ipsec_integ_alg
  64 #undef _
  65     IPSEC_INTEG_N_ALG,
  66 } ipsec_integ_alg_t;
  67
  68 typedef enum
  69 {
  70   IPSEC_PROTOCOL_AH = 0,
  71   IPSEC_PROTOCOL_ESP = 1
  72 } ipsec_protocol_t;
  73
  74 #define IPSEC_KEY_MAX_LEN 128
  75 typedef struct ipsec_key_t_
  76 {
  77   u8 len;
  78   u8 data[IPSEC_KEY_MAX_LEN];
  79 } ipsec_key_t;
  80
  81 /*
  82  * Enable extended sequence numbers
  83  * Enable Anti-replay
  84  * IPsec tunnel mode if non-zero, else transport mode
  85  * IPsec tunnel mode is IPv6 if non-zero,
  86  * else IPv4 tunnel only valid if is_tunnel is non-zero
  87  * enable UDP encapsulation for NAT traversal
  88  */
  89 #define foreach_ipsec_sa_flags                            \
  90   _ (0, NONE, "none")                                     \
  91   _ (1, USE_ESN, "esn")                                   \
  92   _ (2, USE_ANTI_REPLAY, "anti-replay")                   \
  93   _ (4, IS_TUNNEL, "tunnel")                              \
  94   _ (8, IS_TUNNEL_V6, "tunnel-v6")                        \
  95   _ (16, UDP_ENCAP, "udp-encap")                          \
  96   _ (32, IS_PROTECT, "Protect")                           \
  97   _ (64, IS_INBOUND, "inboud")                            \
  98   _ (128, IS_AEAD, "aead")                                \
  99
 100 typedef enum ipsec_sad_flags_t_
 101 {
 102 #define _(v, f, s) IPSEC_SA_FLAG_##f = v,
 103   foreach_ipsec_sa_flags
 104 #undef _
 105 } __clib_packed ipsec_sa_flags_t;
 106
 107 STATIC_ASSERT (sizeof (ipsec_sa_flags_t) == 1, "IPSEC SA flags > 1 byte");
 108
 109 typedef struct
 110 {
 111   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 112
 113   /* flags */
 114   ipsec_sa_flags_t flags;
 115
 116   u8 crypto_iv_size;
 117   u8 crypto_block_size;
 118   u8 integ_icv_size;
 119   u32 spi;
 120   u32 seq;
 121   u32 seq_hi;
 122   u32 last_seq;
 123   u32 last_seq_hi;
 124   u64 replay_window;
 125   dpo_id_t dpo;
 126
 127   vnet_crypto_key_index_t crypto_key_index;
 128   vnet_crypto_key_index_t integ_key_index;
 129   vnet_crypto_op_id_t crypto_enc_op_id:16;
 130   vnet_crypto_op_id_t crypto_dec_op_id:16;
 131   vnet_crypto_op_id_t integ_op_id:16;
 132
 133   /* data accessed by dataplane code should be above this comment */
 134     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 135
 136   union
 137   {
 138     ip4_header_t ip4_hdr;
 139     ip6_header_t ip6_hdr;
 140   };
 141   udp_header_t udp_hdr;
 142
 143   fib_node_t node;
 144   u32 id;
 145   u32 stat_index;
 146   ipsec_protocol_t protocol;
 147
 148   ipsec_crypto_alg_t crypto_alg;
 149   ipsec_key_t crypto_key;
 150   vnet_crypto_alg_t crypto_calg;
 151
 152   ipsec_integ_alg_t integ_alg;
 153   ipsec_key_t integ_key;
 154   vnet_crypto_alg_t integ_calg;
 155
 156   ip46_address_t tunnel_src_addr;
 157   ip46_address_t tunnel_dst_addr;
 158
 159   fib_node_index_t fib_entry_index;
 160   u32 sibling;
 161
 162   u32 tx_fib_index;
 163
 164   /* Salt used in GCM modes - stored in network byte order */
 165   u32 salt;
 166   u64 gcm_iv_counter;
 167 } ipsec_sa_t;
 168
 169 STATIC_ASSERT_OFFSET_OF (ipsec_sa_t, cacheline1, CLIB_CACHE_LINE_BYTES);
 170
 171 #define _(a,v,s)                                                        \
 172   always_inline int                                                     \
 173   ipsec_sa_is_set_##v (const ipsec_sa_t *sa) {                          \
 174     return (sa->flags & IPSEC_SA_FLAG_##v);                             \
 175   }
 176 foreach_ipsec_sa_flags
 177 #undef _
 178 #define _(a,v,s)                                                        \
 179   always_inline int                                                     \
 180   ipsec_sa_set_##v (ipsec_sa_t *sa) {                                   \
 181     return (sa->flags |= IPSEC_SA_FLAG_##v);                            \
 182   }
 183   foreach_ipsec_sa_flags
 184 #undef _
 185 #define _(a,v,s)                                                        \
 186   always_inline int                                                     \
 187   ipsec_sa_unset_##v (ipsec_sa_t *sa) {                                 \
 188     return (sa->flags &= ~IPSEC_SA_FLAG_##v);                           \
 189   }
 190   foreach_ipsec_sa_flags
 191 #undef _
 192 /**
 193  * @brief
 194  * SA packet & bytes counters
 195  */
 196 extern vlib_combined_counter_main_t ipsec_sa_counters;
 197
 198 extern void ipsec_mk_key (ipsec_key_t * key, const u8 * data, u8 len);
 199
 200 extern int ipsec_sa_add_and_lock (u32 id,
 201                                   u32 spi,
 202                                   ipsec_protocol_t proto,
 203                                   ipsec_crypto_alg_t crypto_alg,
 204                                   const ipsec_key_t * ck,
 205                                   ipsec_integ_alg_t integ_alg,
 206                                   const ipsec_key_t * ik,
 207                                   ipsec_sa_flags_t flags,
 208                                   u32 tx_table_id,
 209                                   u32 salt,
 210                                   const ip46_address_t * tunnel_src_addr,
 211                                   const ip46_address_t * tunnel_dst_addr,
 212                                   u32 * sa_index);
 213 extern index_t ipsec_sa_find_and_lock (u32 id);
 214 extern int ipsec_sa_unlock_id (u32 id);
 215 extern void ipsec_sa_unlock (index_t sai);
 216 extern void ipsec_sa_clear (index_t sai);
 217 extern void ipsec_sa_set_crypto_alg (ipsec_sa_t * sa,
 218                                      ipsec_crypto_alg_t crypto_alg);
 219 extern void ipsec_sa_set_integ_alg (ipsec_sa_t * sa,
 220                                     ipsec_integ_alg_t integ_alg);
 221
 222 typedef walk_rc_t (*ipsec_sa_walk_cb_t) (ipsec_sa_t * sa, void *ctx);
 223 extern void ipsec_sa_walk (ipsec_sa_walk_cb_t cd, void *ctx);
 224
 225 extern u8 *format_ipsec_crypto_alg (u8 * s, va_list * args);
 226 extern u8 *format_ipsec_integ_alg (u8 * s, va_list * args);
 227 extern u8 *format_ipsec_sa (u8 * s, va_list * args);
 228 extern u8 *format_ipsec_key (u8 * s, va_list * args);
 229 extern uword unformat_ipsec_crypto_alg (unformat_input_t * input,
 230                                         va_list * args);
 231 extern uword unformat_ipsec_integ_alg (unformat_input_t * input,
 232                                        va_list * args);
 233 extern uword unformat_ipsec_key (unformat_input_t * input, va_list * args);
 234
 235 always_inline int
 236 ipsec_sa_anti_replay_check (ipsec_sa_t * sa, u32 * seqp)
 237 {
 238   u32 seq, diff, tl, th;
 239   if ((sa->flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY) == 0)
 240     return 0;
 241
 242   seq = clib_net_to_host_u32 (*seqp);
 243
 244   if ((sa->flags & IPSEC_SA_FLAG_USE_ESN) == 0)
 245     {
 246
 247       if (PREDICT_TRUE (seq > sa->last_seq))
 248         return 0;
 249
 250       diff = sa->last_seq - seq;
 251
 252       if (IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE > diff)
 253         return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 254       else
 255         return 1;
 256
 257       return 0;
 258     }
 259
 260   tl = sa->last_seq;
 261   th = sa->last_seq_hi;
 262   diff = tl - seq;
 263
 264   if (PREDICT_TRUE (tl >= (IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE - 1)))
 265     {
 266       if (seq >= (tl - IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE + 1))
 267         {
 268           sa->seq_hi = th;
 269           if (seq <= tl)
 270             return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 271           else
 272             return 0;
 273         }
 274       else
 275         {
 276           sa->seq_hi = th + 1;
 277           return 0;
 278         }
 279     }
 280   else
 281     {
 282       if (seq >= (tl - IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE + 1))
 283         {
 284           sa->seq_hi = th - 1;
 285           return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 286         }
 287       else
 288         {
 289           sa->seq_hi = th;
 290           if (seq <= tl)
 291             return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 292           else
 293             return 0;
 294         }
 295     }
 296
 297   return 0;
 298 }
 299
 300 always_inline void
 301 ipsec_sa_anti_replay_advance (ipsec_sa_t * sa, u32 seqp)
 302 {
 303   u32 pos, seq;
 304   if (PREDICT_TRUE (sa->flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY) == 0)
 305     return;
 306
 307   seq = clib_host_to_net_u32 (seqp);
 308   if (PREDICT_TRUE (sa->flags & IPSEC_SA_FLAG_USE_ESN))
 309     {
 310       int wrap = sa->seq_hi - sa->last_seq_hi;
 311
 312       if (wrap == 0 && seq > sa->last_seq)
 313         {
 314           pos = seq - sa->last_seq;
 315           if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
 316             sa->replay_window = ((sa->replay_window) << pos) | 1;
 317           else
 318             sa->replay_window = 1;
 319           sa->last_seq = seq;
 320         }
 321       else if (wrap > 0)
 322         {
 323           pos = ~seq + sa->last_seq + 1;
 324           if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
 325             sa->replay_window = ((sa->replay_window) << pos) | 1;
 326           else
 327             sa->replay_window = 1;
 328           sa->last_seq = seq;
 329           sa->last_seq_hi = sa->seq_hi;
 330         }
 331       else if (wrap < 0)
 332         {
 333           pos = ~seq + sa->last_seq + 1;
 334           sa->replay_window |= (1ULL << pos);
 335         }
 336       else
 337         {
 338           pos = sa->last_seq - seq;
 339           sa->replay_window |= (1ULL << pos);
 340         }
 341     }
 342   else
 343     {
 344       if (seq > sa->last_seq)
 345         {
 346           pos = seq - sa->last_seq;
 347           if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
 348             sa->replay_window = ((sa->replay_window) << pos) | 1;
 349           else
 350             sa->replay_window = 1;
 351           sa->last_seq = seq;
 352         }
 353       else
 354         {
 355           pos = sa->last_seq - seq;
 356           sa->replay_window |= (1ULL << pos);
 357         }
 358     }
 359 }
 360
 361 #endif /* __IPSEC_SPD_SA_H__ */
 362
 363 /*
 364  * fd.io coding-style-patch-verification: ON
 365  *
 366  * Local Variables:
 367  * eval: (c-set-style "gnu")
 368  * End:
 369  */