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_key_index_t crypto_key_index;
 129   vnet_crypto_key_index_t integ_key_index;
 130   vnet_crypto_op_id_t crypto_enc_op_id:16;
 131   vnet_crypto_op_id_t crypto_dec_op_id:16;
 132   vnet_crypto_op_id_t integ_op_id:16;
 133
 134   dpo_id_t dpo[IPSEC_N_PROTOCOLS];
 135
 136   /* data accessed by dataplane code should be above this comment */
 137     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 138
 139   union
 140   {
 141     ip4_header_t ip4_hdr;
 142     ip6_header_t ip6_hdr;
 143   };
 144   udp_header_t udp_hdr;
 145
 146
 147   fib_node_t node;
 148   u32 id;
 149   u32 stat_index;
 150   ipsec_protocol_t protocol;
 151
 152   ipsec_crypto_alg_t crypto_alg;
 153   ipsec_key_t crypto_key;
 154   vnet_crypto_alg_t crypto_calg;
 155
 156   ipsec_integ_alg_t integ_alg;
 157   ipsec_key_t integ_key;
 158   vnet_crypto_alg_t integ_calg;
 159
 160   ip46_address_t tunnel_src_addr;
 161   ip46_address_t tunnel_dst_addr;
 162
 163   fib_node_index_t fib_entry_index;
 164   u32 sibling;
 165
 166   u32 tx_fib_index;
 167
 168   /* Salt used in GCM modes - stored in network byte order */
 169   u32 salt;
 170   u64 gcm_iv_counter;
 171 } ipsec_sa_t;
 172
 173 STATIC_ASSERT_OFFSET_OF (ipsec_sa_t, cacheline1, CLIB_CACHE_LINE_BYTES);
 174
 175 #define _(a,v,s)                                                        \
 176   always_inline int                                                     \
 177   ipsec_sa_is_set_##v (const ipsec_sa_t *sa) {                          \
 178     return (sa->flags & IPSEC_SA_FLAG_##v);                             \
 179   }
 180 foreach_ipsec_sa_flags
 181 #undef _
 182 #define _(a,v,s)                                                        \
 183   always_inline int                                                     \
 184   ipsec_sa_set_##v (ipsec_sa_t *sa) {                                   \
 185     return (sa->flags |= IPSEC_SA_FLAG_##v);                            \
 186   }
 187   foreach_ipsec_sa_flags
 188 #undef _
 189 /**
 190  * @brief
 191  * SA packet & bytes counters
 192  */
 193 extern vlib_combined_counter_main_t ipsec_sa_counters;
 194
 195 extern void ipsec_mk_key (ipsec_key_t * key, const u8 * data, u8 len);
 196
 197 extern int ipsec_sa_add (u32 id,
 198                          u32 spi,
 199                          ipsec_protocol_t proto,
 200                          ipsec_crypto_alg_t crypto_alg,
 201                          const ipsec_key_t * ck,
 202                          ipsec_integ_alg_t integ_alg,
 203                          const ipsec_key_t * ik,
 204                          ipsec_sa_flags_t flags,
 205                          u32 tx_table_id,
 206                          u32 salt,
 207                          const ip46_address_t * tunnel_src_addr,
 208                          const ip46_address_t * tunnel_dst_addr,
 209                          u32 * sa_index);
 210 extern u32 ipsec_sa_del (u32 id);
 211 extern void ipsec_sa_set_crypto_alg (ipsec_sa_t * sa,
 212                                      ipsec_crypto_alg_t crypto_alg);
 213 extern void ipsec_sa_set_integ_alg (ipsec_sa_t * sa,
 214                                     ipsec_integ_alg_t integ_alg);
 215
 216 extern u8 ipsec_is_sa_used (u32 sa_index);
 217 extern int ipsec_set_sa_key (u32 id,
 218                              const ipsec_key_t * ck, const ipsec_key_t * ik);
 219 extern u32 ipsec_get_sa_index_by_sa_id (u32 sa_id);
 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 always_inline int
 235 ipsec_sa_anti_replay_check (ipsec_sa_t * sa, u32 * seqp)
 236 {
 237   u32 seq, diff, tl, th;
 238   if ((sa->flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY) == 0)
 239     return 0;
 240
 241   seq = clib_net_to_host_u32 (*seqp);
 242
 243   if ((sa->flags & IPSEC_SA_FLAG_USE_ESN) == 0)
 244     {
 245
 246       if (PREDICT_TRUE (seq > sa->last_seq))
 247         return 0;
 248
 249       diff = sa->last_seq - seq;
 250
 251       if (IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE > diff)
 252         return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 253       else
 254         return 1;
 255
 256       return 0;
 257     }
 258
 259   tl = sa->last_seq;
 260   th = sa->last_seq_hi;
 261   diff = tl - seq;
 262
 263   if (PREDICT_TRUE (tl >= (IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE - 1)))
 264     {
 265       if (seq >= (tl - IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE + 1))
 266         {
 267           sa->seq_hi = th;
 268           if (seq <= tl)
 269             return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 270           else
 271             return 0;
 272         }
 273       else
 274         {
 275           sa->seq_hi = th + 1;
 276           return 0;
 277         }
 278     }
 279   else
 280     {
 281       if (seq >= (tl - IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE + 1))
 282         {
 283           sa->seq_hi = th - 1;
 284           return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 285         }
 286       else
 287         {
 288           sa->seq_hi = th;
 289           if (seq <= tl)
 290             return (sa->replay_window & (1ULL << diff)) ? 1 : 0;
 291           else
 292             return 0;
 293         }
 294     }
 295
 296   return 0;
 297 }
 298
 299 always_inline void
 300 ipsec_sa_anti_replay_advance (ipsec_sa_t * sa, u32 seqp)
 301 {
 302   u32 pos, seq;
 303   if (PREDICT_TRUE (sa->flags & IPSEC_SA_FLAG_USE_ANTI_REPLAY) == 0)
 304     return;
 305
 306   seq = clib_host_to_net_u32 (seqp);
 307   if (PREDICT_TRUE (sa->flags & IPSEC_SA_FLAG_USE_ESN))
 308     {
 309       int wrap = sa->seq_hi - sa->last_seq_hi;
 310
 311       if (wrap == 0 && seq > sa->last_seq)
 312         {
 313           pos = seq - sa->last_seq;
 314           if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
 315             sa->replay_window = ((sa->replay_window) << pos) | 1;
 316           else
 317             sa->replay_window = 1;
 318           sa->last_seq = seq;
 319         }
 320       else if (wrap > 0)
 321         {
 322           pos = ~seq + sa->last_seq + 1;
 323           if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
 324             sa->replay_window = ((sa->replay_window) << pos) | 1;
 325           else
 326             sa->replay_window = 1;
 327           sa->last_seq = seq;
 328           sa->last_seq_hi = sa->seq_hi;
 329         }
 330       else if (wrap < 0)
 331         {
 332           pos = ~seq + sa->last_seq + 1;
 333           sa->replay_window |= (1ULL << pos);
 334         }
 335       else
 336         {
 337           pos = sa->last_seq - seq;
 338           sa->replay_window |= (1ULL << pos);
 339         }
 340     }
 341   else
 342     {
 343       if (seq > sa->last_seq)
 344         {
 345           pos = seq - sa->last_seq;
 346           if (pos < IPSEC_SA_ANTI_REPLAY_WINDOW_SIZE)
 347             sa->replay_window = ((sa->replay_window) << pos) | 1;
 348           else
 349             sa->replay_window = 1;
 350           sa->last_seq = seq;
 351         }
 352       else
 353         {
 354           pos = sa->last_seq - seq;
 355           sa->replay_window |= (1ULL << pos);
 356         }
 357     }
 358 }
 359
 360 #endif /* __IPSEC_SPD_SA_H__ */
 361
 362 /*
 363  * fd.io coding-style-patch-verification: ON
 364  *
 365  * Local Variables:
 366  * eval: (c-set-style "gnu")
 367  * End:
 368  */