src/vnet/ipsec/ipsec.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_H__
  16 #define __IPSEC_H__
  17
  18 #include <vnet/ip/ip.h>
  19 #include <vnet/crypto/crypto.h>
  20 #include <vnet/feature/feature.h>
  21
  22 #include <vppinfra/types.h>
  23 #include <vppinfra/cache.h>
  24
  25 #include <vnet/ipsec/ipsec_spd.h>
  26 #include <vnet/ipsec/ipsec_spd_policy.h>
  27 #include <vnet/ipsec/ipsec_sa.h>
  28
  29 #include <vppinfra/bihash_8_16.h>
  30
  31 #include <vppinfra/bihash_24_16.h>
  32
  33 typedef clib_error_t *(*add_del_sa_sess_cb_t) (u32 sa_index, u8 is_add);
  34 typedef clib_error_t *(*check_support_cb_t) (ipsec_sa_t * sa);
  35 typedef clib_error_t *(*enable_disable_cb_t) (int is_enable);
  36
  37 typedef struct
  38 {
  39   u64 key[2]; // 16 bytes
  40   u64 value;
  41   i32 bucket_lock;
  42   u32 un_used;
  43 } ipsec4_hash_kv_16_8_t;
  44
  45 typedef union
  46 {
  47   struct
  48   {
  49     ip4_address_t ip4_addr[2];
  50     u16 port[2];
  51     u8 proto;
  52     u8 pad[3];
  53   };
  54   ipsec4_hash_kv_16_8_t kv_16_8;
  55 } ipsec4_spd_5tuple_t;
  56
  57 typedef union
  58 {
  59   struct
  60   {
  61     ip4_address_t ip4_src_addr;
  62     ip4_address_t ip4_dest_addr;
  63     ipsec_spd_policy_type_t policy_type;
  64     u8 pad[4];
  65   }; // 16 bytes total
  66   ipsec4_hash_kv_16_8_t kv_16_8;
  67 } ipsec4_inbound_spd_tuple_t;
  68
  69 typedef struct
  70 {
  71   u8 *name;
  72   /* add/del callback */
  73   add_del_sa_sess_cb_t add_del_sa_sess_cb;
  74   /* check support function */
  75   check_support_cb_t check_support_cb;
  76   u32 ah4_encrypt_node_index;
  77   u32 ah4_decrypt_node_index;
  78   u32 ah4_encrypt_next_index;
  79   u32 ah4_decrypt_next_index;
  80   u32 ah6_encrypt_node_index;
  81   u32 ah6_decrypt_node_index;
  82   u32 ah6_encrypt_next_index;
  83   u32 ah6_decrypt_next_index;
  84 } ipsec_ah_backend_t;
  85
  86 typedef struct
  87 {
  88   u8 *name;
  89   /* add/del callback */
  90   add_del_sa_sess_cb_t add_del_sa_sess_cb;
  91   /* check support function */
  92   check_support_cb_t check_support_cb;
  93   /* enable or disable function */
  94   enable_disable_cb_t enable_disable_cb;
  95   u32 esp4_encrypt_node_index;
  96   u32 esp4_decrypt_node_index;
  97   u32 esp4_encrypt_next_index;
  98   u32 esp4_decrypt_next_index;
  99   u32 esp6_encrypt_node_index;
 100   u32 esp6_decrypt_node_index;
 101   u32 esp6_encrypt_next_index;
 102   u32 esp6_decrypt_next_index;
 103   u32 esp4_decrypt_tun_node_index;
 104   u32 esp4_decrypt_tun_next_index;
 105   u32 esp4_encrypt_tun_node_index;
 106   u32 esp6_decrypt_tun_node_index;
 107   u32 esp6_decrypt_tun_next_index;
 108   u32 esp6_encrypt_tun_node_index;
 109   u32 esp_mpls_encrypt_tun_node_index;
 110 } ipsec_esp_backend_t;
 111
 112 typedef struct
 113 {
 114   vnet_crypto_op_id_t enc_op_id;
 115   vnet_crypto_op_id_t dec_op_id;
 116   vnet_crypto_alg_t alg;
 117   u8 iv_size;
 118   u8 block_align;
 119   u8 icv_size;
 120 } ipsec_main_crypto_alg_t;
 121
 122 typedef struct
 123 {
 124   vnet_crypto_op_id_t op_id;
 125   vnet_crypto_alg_t alg;
 126   u8 icv_size;
 127 } ipsec_main_integ_alg_t;
 128
 129 typedef struct
 130 {
 131   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 132   vnet_crypto_op_t *crypto_ops;
 133   vnet_crypto_op_t *integ_ops;
 134   vnet_crypto_op_t *chained_crypto_ops;
 135   vnet_crypto_op_t *chained_integ_ops;
 136   vnet_crypto_op_chunk_t *chunks;
 137   vnet_crypto_async_frame_t **async_frames;
 138 } ipsec_per_thread_data_t;
 139
 140 typedef struct
 141 {
 142   /* pool of tunnel instances */
 143   ipsec_spd_t *spds;
 144   /* pool of policies */
 145   ipsec_policy_t *policies;
 146
 147   /* hash tables of UDP port registrations */
 148   uword *udp_port_registrations;
 149
 150   uword *tunnel_index_by_key;
 151
 152   /* next_header protocol registration */
 153   u16 *next_header_registrations;
 154
 155   /* convenience */
 156   vlib_main_t *vlib_main;
 157   vnet_main_t *vnet_main;
 158
 159   /* hashes */
 160   uword *spd_index_by_spd_id;
 161   uword *spd_index_by_sw_if_index;
 162   uword *sa_index_by_sa_id;
 163   uword *ipsec4_if_pool_index_by_key;
 164   uword *ipsec6_if_pool_index_by_key;
 165   uword *ipsec_if_real_dev_by_show_dev;
 166   uword *ipsec_if_by_sw_if_index;
 167
 168   ipsec4_hash_kv_16_8_t *ipsec4_out_spd_hash_tbl;
 169   ipsec4_hash_kv_16_8_t *ipsec4_in_spd_hash_tbl;
 170   clib_bihash_8_16_t tun4_protect_by_key;
 171   clib_bihash_24_16_t tun6_protect_by_key;
 172
 173   /* node indices */
 174   u32 error_drop_node_index;
 175   u32 esp4_encrypt_node_index;
 176   u32 esp4_decrypt_node_index;
 177   u32 esp4_decrypt_tun_node_index;
 178   u32 esp4_encrypt_tun_node_index;
 179   u32 ah4_encrypt_node_index;
 180   u32 ah4_decrypt_node_index;
 181   u32 esp6_encrypt_node_index;
 182   u32 esp6_decrypt_node_index;
 183   u32 esp6_decrypt_tun_node_index;
 184   u32 esp6_encrypt_tun_node_index;
 185   u32 esp_mpls_encrypt_tun_node_index;
 186   u32 ah6_encrypt_node_index;
 187   u32 ah6_decrypt_node_index;
 188   /* next node indices */
 189   u32 esp4_encrypt_next_index;
 190   u32 esp4_decrypt_next_index;
 191   u32 esp4_decrypt_tun_next_index;
 192   u32 ah4_encrypt_next_index;
 193   u32 ah4_decrypt_next_index;
 194   u32 esp6_encrypt_next_index;
 195   u32 esp6_decrypt_next_index;
 196   u32 esp6_decrypt_tun_next_index;
 197   u32 ah6_encrypt_next_index;
 198   u32 ah6_decrypt_next_index;
 199
 200   /* pool of ah backends */
 201   ipsec_ah_backend_t *ah_backends;
 202   /* pool of esp backends */
 203   ipsec_esp_backend_t *esp_backends;
 204   /* index of current ah backend */
 205   u32 ah_current_backend;
 206   /* index of current esp backend */
 207   u32 esp_current_backend;
 208   /* index of default ah backend */
 209   u32 ah_default_backend;
 210   /* index of default esp backend */
 211   u32 esp_default_backend;
 212
 213   /* crypto alg data */
 214   ipsec_main_crypto_alg_t *crypto_algs;
 215
 216   /* crypto integ data */
 217   ipsec_main_integ_alg_t *integ_algs;
 218
 219   /* per-thread data */
 220   ipsec_per_thread_data_t *ptd;
 221
 222   /** Worker handoff */
 223   u32 ah4_enc_fq_index;
 224   u32 ah4_dec_fq_index;
 225   u32 ah6_enc_fq_index;
 226   u32 ah6_dec_fq_index;
 227
 228   u32 esp4_enc_fq_index;
 229   u32 esp4_dec_fq_index;
 230   u32 esp6_enc_fq_index;
 231   u32 esp6_dec_fq_index;
 232   u32 esp4_enc_tun_fq_index;
 233   u32 esp6_enc_tun_fq_index;
 234   u32 esp_mpls_enc_tun_fq_index;
 235   u32 esp4_dec_tun_fq_index;
 236   u32 esp6_dec_tun_fq_index;
 237
 238   /* Number of buckets for flow cache */
 239   u32 ipsec4_out_spd_hash_num_buckets;
 240   u32 ipsec4_out_spd_flow_cache_entries;
 241   u32 epoch_count;
 242   u8 output_flow_cache_flag;
 243
 244   u32 ipsec4_in_spd_hash_num_buckets;
 245   u32 ipsec4_in_spd_flow_cache_entries;
 246   u32 input_epoch_count;
 247   u8 input_flow_cache_flag;
 248
 249   u8 async_mode;
 250   u16 msg_id_base;
 251 } ipsec_main_t;
 252
 253 typedef enum ipsec_format_flags_t_
 254 {
 255   IPSEC_FORMAT_BRIEF = 0,
 256   IPSEC_FORMAT_DETAIL = (1 << 0),
 257   IPSEC_FORMAT_INSECURE = (1 << 1),
 258 } ipsec_format_flags_t;
 259
 260 extern ipsec_main_t ipsec_main;
 261
 262 clib_error_t *ipsec_add_del_sa_sess_cb (ipsec_main_t * im, u32 sa_index,
 263                                         u8 is_add);
 264
 265 clib_error_t *ipsec_check_support_cb (ipsec_main_t * im, ipsec_sa_t * sa);
 266
 267 extern vlib_node_registration_t ipsec4_tun_input_node;
 268 extern vlib_node_registration_t ipsec6_tun_input_node;
 269
 270 /*
 271  * functions
 272  */
 273
 274 /*
 275  *  inline functions
 276  */
 277
 278 static_always_inline u32
 279 get_next_output_feature_node_index (vlib_buffer_t * b,
 280                                     vlib_node_runtime_t * nr)
 281 {
 282   u32 next;
 283   vlib_main_t *vm = vlib_get_main ();
 284   vlib_node_t *node = vlib_get_node (vm, nr->node_index);
 285
 286   vnet_feature_next (&next, b);
 287   return node->next_nodes[next];
 288 }
 289
 290 static_always_inline u64
 291 ipsec4_hash_16_8 (ipsec4_hash_kv_16_8_t *v)
 292 {
 293 #ifdef clib_crc32c_uses_intrinsics
 294   return clib_crc32c ((u8 *) v->key, 16);
 295 #else
 296   u64 tmp = v->key[0] ^ v->key[1];
 297   return clib_xxhash (tmp);
 298 #endif
 299 }
 300
 301 static_always_inline int
 302 ipsec4_hash_key_compare_16_8 (u64 *a, u64 *b)
 303 {
 304 #if defined(CLIB_HAVE_VEC128) && defined(CLIB_HAVE_VEC128_UNALIGNED_LOAD_STORE)
 305   u64x2 v;
 306   v = u64x2_load_unaligned (a) ^ u64x2_load_unaligned (b);
 307   return u64x2_is_all_zero (v);
 308 #else
 309   return ((a[0] ^ b[0]) | (a[1] ^ b[1])) == 0;
 310 #endif
 311 }
 312
 313 /* clib_spinlock_lock is not used to save another memory indirection */
 314 static_always_inline void
 315 ipsec_spinlock_lock (i32 *lock)
 316 {
 317   i32 free = 0;
 318   while (!clib_atomic_cmp_and_swap_acq_relax_n (lock, &free, 1, 0))
 319     {
 320       /* atomic load limits number of compare_exchange executions */
 321       while (clib_atomic_load_relax_n (lock))
 322         CLIB_PAUSE ();
 323       /* on failure, compare_exchange writes lock into free */
 324       free = 0;
 325     }
 326 }
 327
 328 static_always_inline void
 329 ipsec_spinlock_unlock (i32 *lock)
 330 {
 331   /* Make sure all reads/writes are complete before releasing the lock */
 332   clib_atomic_release (lock);
 333 }
 334
 335 u32 ipsec_register_ah_backend (vlib_main_t * vm, ipsec_main_t * im,
 336                                const char *name,
 337                                const char *ah4_encrypt_node_name,
 338                                const char *ah4_decrypt_node_name,
 339                                const char *ah6_encrypt_node_name,
 340                                const char *ah6_decrypt_node_name,
 341                                check_support_cb_t ah_check_support_cb,
 342                                add_del_sa_sess_cb_t ah_add_del_sa_sess_cb);
 343
 344 u32 ipsec_register_esp_backend (
 345   vlib_main_t *vm, ipsec_main_t *im, const char *name,
 346   const char *esp4_encrypt_node_name, const char *esp4_encrypt_tun_node_name,
 347   const char *esp4_decrypt_node_name, const char *esp4_decrypt_tun_node_name,
 348   const char *esp6_encrypt_node_name, const char *esp6_encrypt_tun_node_name,
 349   const char *esp6_decrypt_node_name, const char *esp6_decrypt_tun_node_name,
 350   const char *esp_mpls_encrypt_tun_node_name,
 351   check_support_cb_t esp_check_support_cb,
 352   add_del_sa_sess_cb_t esp_add_del_sa_sess_cb,
 353   enable_disable_cb_t enable_disable_cb);
 354
 355 int ipsec_select_ah_backend (ipsec_main_t * im, u32 ah_backend_idx);
 356 int ipsec_select_esp_backend (ipsec_main_t * im, u32 esp_backend_idx);
 357
 358 clib_error_t *ipsec_rsc_in_use (ipsec_main_t * im);
 359 void ipsec_set_async_mode (u32 is_enabled);
 360
 361 extern void ipsec_register_udp_port (u16 udp_port);
 362 extern void ipsec_unregister_udp_port (u16 udp_port);
 363
 364 extern clib_error_t *ipsec_register_next_header (vlib_main_t *vm,
 365                                                  u8 next_header,
 366                                                  const char *next_node);
 367
 368 #endif /* __IPSEC_H__ */
 369
 370 /*
 371  * fd.io coding-style-patch-verification: ON
 372  *
 373  * Local Variables:
 374  * eval: (c-set-style "gnu")
 375  * End:
 376  */