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_N_PROTOCOLS (IPSEC_PROTOCOL_ESP+1)
  75
  76 #define IPSEC_KEY_MAX_LEN 128
  77 typedef struct ipsec_key_t_
  78 {
  79   u8 len;
  80   u8 data[IPSEC_KEY_MAX_LEN];
  81 } ipsec_key_t;
  82
  83 /*
  84  * Enable extended sequence numbers
  85  * Enable Anti-replay
  86  * IPsec tunnel mode if non-zero, else transport mode
  87  * IPsec tunnel mode is IPv6 if non-zero,
  88  * else IPv4 tunnel only valid if is_tunnel is non-zero
  89  * enable UDP encapsulation for NAT traversal
  90  */
  91 #define foreach_ipsec_sa_flags                            \
  92   _ (0, NONE, "none")                                     \
  93   _ (1, USE_ESN, "esn")                                   \
  94   _ (2, USE_ANTI_REPLAY, "anti-replay")                   \
  95   _ (4, IS_TUNNEL, "tunnel")                              \
  96   _ (8, IS_TUNNEL_V6, "tunnel-v6")                        \
  97   _ (16, UDP_ENCAP, "udp-encap")                          \
  98   _ (32, IS_GRE, "GRE")                                   \
  99   _ (64, IS_INBOUND, "inboud")                            \
 100   _ (128, IS_AEAD, "aead")                                \
 101
 102 typedef enum ipsec_sad_flags_t_
 103 {
 104 #define _(v, f, s) IPSEC_SA_FLAG_##f = v,
 105   foreach_ipsec_sa_flags
 106 #undef _
 107 } __clib_packed ipsec_sa_flags_t;
 108
 109 STATIC_ASSERT (sizeof (ipsec_sa_flags_t) == 1, "IPSEC SA flags > 1 byte");
 110
 111 typedef struct
 112 {
 113   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 114
 115   /* flags */
 116   ipsec_sa_flags_t flags;
 117
 118   u8 crypto_iv_size;
 119   u8 crypto_block_size;
 120   u8 integ_icv_size;
 121   u32 spi;
 122   u32 seq;
 123   u32 seq_hi;
 124   u32 last_seq;
 125   u32 last_seq_hi;
 126   u64 replay_window;
 127
 128   vnet_crypto_op_id_t crypto_enc_op_id;
 129   vnet_crypto_op_id_t crypto_dec_op_id;
 130   vnet_crypto_op_id_t integ_op_id;
 131
 132   dpo_id_t dpo[IPSEC_N_PROTOCOLS];
 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
 145   fib_node_t node;
 146   u32 id;
 147   u32 stat_index;
 148   ipsec_protocol_t protocol;
 149
 150   ipsec_crypto_alg_t crypto_alg;
 151   ipsec_key_t crypto_key;
 152
 153   ipsec_integ_alg_t integ_alg;
 154   ipsec_key_t integ_key;
 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   u32 salt;
 164
 165   /* runtime */
 166 } ipsec_sa_t;
 167
 168 STATIC_ASSERT_OFFSET_OF (ipsec_sa_t, cacheline1, CLIB_CACHE_LINE_BYTES);
 169
 170 #define _(a,v,s)                                                        \
 171   always_inline int                                                     \
 172   ipsec_sa_is_set_##v (const ipsec_sa_t *sa) {                          \
 173     return (sa->flags & IPSEC_SA_FLAG_##v);                             \
 174   }
 175 foreach_ipsec_sa_flags
 176 #undef _
 177 #define _(a,v,s)                                                        \
 178   always_inline int                                                     \
 179   ipsec_sa_set_##v (ipsec_sa_t *sa) {                                   \
 180     return (sa->flags |= IPSEC_SA_FLAG_##v);                            \
 181   }
 182   foreach_ipsec_sa_flags
 183 #undef _
 184 /**
 185  * @brief
 186  * SA packet & bytes counters
 187  */
 188 extern vlib_combined_counter_main_t ipsec_sa_counters;
 189
 190 extern void ipsec_mk_key (ipsec_key_t * key, const u8 * data, u8 len);
 191
 192 extern int ipsec_sa_add (u32 id,
 193                          u32 spi,
 194                          ipsec_protocol_t proto,
 195                          ipsec_crypto_alg_t crypto_alg,
 196                          const ipsec_key_t * ck,
 197                          ipsec_integ_alg_t integ_alg,
 198                          const ipsec_key_t * ik,
 199                          ipsec_sa_flags_t flags,
 200                          u32 tx_table_id,
 201                          u32 salt,
 202                          const ip46_address_t * tunnel_src_addr,
 203                          const ip46_address_t * tunnel_dst_addr,
 204                          u32 * sa_index);
 205 extern u32 ipsec_sa_del (u32 id);
 206 extern void ipsec_sa_stack (ipsec_sa_t * sa);
 207 extern void ipsec_sa_set_crypto_alg (ipsec_sa_t * sa,
 208                                      ipsec_crypto_alg_t crypto_alg);
 209 extern void ipsec_sa_set_integ_alg (ipsec_sa_t * sa,
 210                                     ipsec_integ_alg_t integ_alg);
 211
 212 extern u8 ipsec_is_sa_used (u32 sa_index);
 213 extern int ipsec_set_sa_key (u32 id,
 214                              const ipsec_key_t * ck, const ipsec_key_t * ik);
 215 extern u32 ipsec_get_sa_index_by_sa_id (u32 sa_id);
 216
 217 typedef walk_rc_t (*ipsec_sa_walk_cb_t) (ipsec_sa_t * sa, void *ctx);
 218 extern void ipsec_sa_walk (ipsec_sa_walk_cb_t cd, void *ctx);
 219
 220 extern u8 *format_ipsec_crypto_alg (u8 * s, va_list * args);
 221 extern u8 *format_ipsec_integ_alg (u8 * s, va_list * args);
 222 extern u8 *format_ipsec_sa (u8 * s, va_list * args);
 223 extern u8 *format_ipsec_key (u8 * s, va_list * args);
 224 extern uword unformat_ipsec_crypto_alg (unformat_input_t * input,
 225                                         va_list * args);
 226 extern uword unformat_ipsec_integ_alg (unformat_input_t * input,
 227                                        va_list * args);
 228 extern uword unformat_ipsec_key (unformat_input_t * input, va_list * args);
 229
 230 always_inline int
 231 ipsec_sa_anti_replay_check (ipsec_sa_t * sa, u32 * seqp)
 232 {
 233   u32 seq, diff, tl, th;
 234   if ((sa->flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY) == 0)
 235     return 0;
 236
 237   seq = clib_net_to_host_u32 (*seqp);
 238
 239   if ((sa->flags & IPSEC_SA_FLAG_USE_ESN) == 0)
 240     {
 241
 242       if (PREDICT_TRUE (seq > sa->last_seq))
 243         return 0;
 244
 245       diff = sa->last_seq - seq;
 246
 247       if (IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE > diff)
 248         return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 249       else
 250         return 1;
 251
 252       return 0;
 253     }
 254
 255   tl = sa->last_seq;
 256   th = sa->last_seq_hi;
 257   diff = tl - seq;
 258
 259   if (PREDICT_TRUE (tl >= (IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE - 1)))
 260     {
 261       if (seq >= (tl - IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE + 1))
 262         {
 263           sa->seq_hi = th;
 264           if (seq <= tl)
 265             return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 266           else
 267             return 0;
 268         }
 269       else
 270         {
 271           sa->seq_hi = th + 1;
 272           return 0;
 273         }
 274     }
 275   else
 276     {
 277       if (seq >= (tl - IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE + 1))
 278         {
 279           sa->seq_hi = th - 1;
 280           return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 281         }
 282       else
 283         {
 284           sa->seq_hi = th;
 285           if (seq <= tl)
 286             return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 287           else
 288             return 0;
 289         }
 290     }
 291
 292   return 0;
 293 }
 294
 295 always_inline void
 296 ipsec_sa_anti_replay_advance (ipsec_sa_t * sa, u32 * seqp)
 297 {
 298   u32 pos, seq;
 299   if (PREDICT_TRUE (sa->flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY) == 0)
 300     return;
 301
 302   seq = clib_host_to_net_u32 (*seqp);
 303   if (PREDICT_TRUE (sa->flags & IPSEC_SA_FLAG_USE_ESN))
 304     {
 305       int wrap = sa->seq_hi - sa->last_seq_hi;
 306
 307       if (wrap == 0 && seq > sa->last_seq)
 308         {
 309           pos = seq - sa->last_seq;
 310           if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
 311             sa->replay_window = ((sa->replay_window) << pos) | 1;
 312           else
 313             sa->replay_window = 1;
 314           sa->last_seq = seq;
 315         }
 316       else if (wrap > 0)
 317         {
 318           pos = ~seq + sa->last_seq + 1;
 319           if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
 320             sa->replay_window = ((sa->replay_window) << pos) | 1;
 321           else
 322             sa->replay_window = 1;
 323           sa->last_seq = seq;
 324           sa->last_seq_hi = sa->seq_hi;
 325         }
 326       else if (wrap < 0)
 327         {
 328           pos = ~seq + sa->last_seq + 1;
 329           sa->replay_window |= (1ULL << pos);
 330         }
 331       else
 332         {
 333           pos = sa->last_seq - seq;
 334           sa->replay_window |= (1ULL << pos);
 335         }
 336     }
 337   else
 338     {
 339       if (seq > sa->last_seq)
 340         {
 341           pos = seq - sa->last_seq;
 342           if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
 343             sa->replay_window = ((sa->replay_window) << pos) | 1;
 344           else
 345             sa->replay_window = 1;
 346           sa->last_seq = seq;
 347         }
 348       else
 349         {
 350           pos = sa->last_seq - seq;
 351           sa->replay_window |= (1ULL << pos);
 352         }
 353     }
 354 }
 355
 356 #endif /* __IPSEC_SPD_SA_H__ */
 357
 358 /*
 359  * fd.io coding-style-patch-verification: ON
 360  *
 361  * Local Variables:
 362  * eval: (c-set-style "gnu")
 363  * End:
 364  */