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 typedef clib_error_t *(*add_del_sa_sess_cb_t) (u32 sa_index, u8 is_add);
  30 typedef clib_error_t *(*check_support_cb_t) (ipsec_sa_t * sa);
  31 typedef clib_error_t *(*enable_disable_cb_t) (int is_enable);
  32
  33 typedef struct
  34 {
  35   u8 *name;
  36   /* add/del callback */
  37   add_del_sa_sess_cb_t add_del_sa_sess_cb;
  38   /* check support function */
  39   check_support_cb_t check_support_cb;
  40   u32 ah4_encrypt_node_index;
  41   u32 ah4_decrypt_node_index;
  42   u32 ah4_encrypt_next_index;
  43   u32 ah4_decrypt_next_index;
  44   u32 ah6_encrypt_node_index;
  45   u32 ah6_decrypt_node_index;
  46   u32 ah6_encrypt_next_index;
  47   u32 ah6_decrypt_next_index;
  48 } ipsec_ah_backend_t;
  49
  50 typedef struct
  51 {
  52   u8 *name;
  53   /* add/del callback */
  54   add_del_sa_sess_cb_t add_del_sa_sess_cb;
  55   /* check support function */
  56   check_support_cb_t check_support_cb;
  57   /* enable or disable function */
  58   enable_disable_cb_t enable_disable_cb;
  59   u32 esp4_encrypt_node_index;
  60   u32 esp4_decrypt_node_index;
  61   u32 esp4_encrypt_next_index;
  62   u32 esp4_decrypt_next_index;
  63   u32 esp6_encrypt_node_index;
  64   u32 esp6_decrypt_node_index;
  65   u32 esp6_encrypt_next_index;
  66   u32 esp6_decrypt_next_index;
  67   u32 esp4_decrypt_tun_node_index;
  68   u32 esp4_decrypt_tun_next_index;
  69   u32 esp6_decrypt_tun_node_index;
  70   u32 esp6_decrypt_tun_next_index;
  71   u32 esp44_encrypt_tun_feature_index;
  72   u32 esp46_encrypt_tun_feature_index;
  73   u32 esp66_encrypt_tun_feature_index;
  74   u32 esp64_encrypt_tun_feature_index;
  75 } ipsec_esp_backend_t;
  76
  77 typedef struct
  78 {
  79   vnet_crypto_op_id_t enc_op_id;
  80   vnet_crypto_op_id_t dec_op_id;
  81   vnet_crypto_alg_t alg;
  82   u8 iv_size;
  83   u8 block_size;
  84   u8 icv_size;
  85 } ipsec_main_crypto_alg_t;
  86
  87 typedef struct
  88 {
  89   vnet_crypto_op_id_t op_id;
  90   vnet_crypto_alg_t alg;
  91   u8 icv_size;
  92 } ipsec_main_integ_alg_t;
  93
  94 typedef struct
  95 {
  96   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  97   vnet_crypto_op_t *crypto_ops;
  98   vnet_crypto_op_t *integ_ops;
  99   vnet_crypto_op_t *chained_crypto_ops;
 100   vnet_crypto_op_t *chained_integ_ops;
 101   vnet_crypto_op_chunk_t *chunks;
 102 } ipsec_per_thread_data_t;
 103
 104 typedef struct
 105 {
 106   /* pool of tunnel instances */
 107   ipsec_spd_t *spds;
 108   /* Pool of security associations */
 109   ipsec_sa_t *sad;
 110   /* pool of policies */
 111   ipsec_policy_t *policies;
 112
 113   uword *tunnel_index_by_key;
 114
 115   /* convenience */
 116   vlib_main_t *vlib_main;
 117   vnet_main_t *vnet_main;
 118
 119   /* hashes */
 120   uword *spd_index_by_spd_id;
 121   uword *spd_index_by_sw_if_index;
 122   uword *sa_index_by_sa_id;
 123   uword *ipsec4_if_pool_index_by_key;
 124   uword *ipsec6_if_pool_index_by_key;
 125   uword *ipsec_if_real_dev_by_show_dev;
 126   uword *ipsec_if_by_sw_if_index;
 127   uword *tun4_protect_by_key;
 128   uword *tun6_protect_by_key;
 129
 130   /* node indices */
 131   u32 error_drop_node_index;
 132   u32 esp4_encrypt_node_index;
 133   u32 esp4_decrypt_node_index;
 134   u32 esp4_decrypt_tun_node_index;
 135   u32 ah4_encrypt_node_index;
 136   u32 ah4_decrypt_node_index;
 137   u32 esp6_encrypt_node_index;
 138   u32 esp6_decrypt_node_index;
 139   u32 esp6_decrypt_tun_node_index;
 140   u32 ah6_encrypt_node_index;
 141   u32 ah6_decrypt_node_index;
 142   /* next node indices */
 143   u32 esp4_encrypt_next_index;
 144   u32 esp4_decrypt_next_index;
 145   u32 esp4_decrypt_tun_next_index;
 146   u32 ah4_encrypt_next_index;
 147   u32 ah4_decrypt_next_index;
 148   u32 esp6_encrypt_next_index;
 149   u32 esp6_decrypt_next_index;
 150   u32 esp6_decrypt_tun_next_index;
 151   u32 ah6_encrypt_next_index;
 152   u32 ah6_decrypt_next_index;
 153
 154   /* tun encrypt arcs and feature nodes */
 155   u32 esp44_encrypt_tun_feature_index;
 156   u32 esp64_encrypt_tun_feature_index;
 157   u32 esp46_encrypt_tun_feature_index;
 158   u32 esp66_encrypt_tun_feature_index;
 159
 160   /* tun nodes to drop packets when no crypto alg set on outbound SA */
 161   u32 esp4_no_crypto_tun_feature_index;
 162   u32 esp6_no_crypto_tun_feature_index;
 163
 164   /* pool of ah backends */
 165   ipsec_ah_backend_t *ah_backends;
 166   /* pool of esp backends */
 167   ipsec_esp_backend_t *esp_backends;
 168   /* index of current ah backend */
 169   u32 ah_current_backend;
 170   /* index of current esp backend */
 171   u32 esp_current_backend;
 172   /* index of default ah backend */
 173   u32 ah_default_backend;
 174   /* index of default esp backend */
 175   u32 esp_default_backend;
 176
 177   /* crypto alg data */
 178   ipsec_main_crypto_alg_t *crypto_algs;
 179
 180   /* crypto integ data */
 181   ipsec_main_integ_alg_t *integ_algs;
 182
 183   /* per-thread data */
 184   ipsec_per_thread_data_t *ptd;
 185
 186   /** Worker handoff */
 187   u32 ah4_enc_fq_index;
 188   u32 ah4_dec_fq_index;
 189   u32 ah6_enc_fq_index;
 190   u32 ah6_dec_fq_index;
 191
 192   u32 esp4_enc_fq_index;
 193   u32 esp4_dec_fq_index;
 194   u32 esp6_enc_fq_index;
 195   u32 esp6_dec_fq_index;
 196   u32 esp4_enc_tun_fq_index;
 197   u32 esp6_enc_tun_fq_index;
 198   u32 esp4_dec_tun_fq_index;
 199   u32 esp6_dec_tun_fq_index;
 200
 201   u8 async_mode;
 202 } ipsec_main_t;
 203
 204 typedef enum ipsec_format_flags_t_
 205 {
 206   IPSEC_FORMAT_BRIEF = 0,
 207   IPSEC_FORMAT_DETAIL = (1 << 0),
 208   IPSEC_FORMAT_INSECURE = (1 << 1),
 209 } ipsec_format_flags_t;
 210
 211 extern ipsec_main_t ipsec_main;
 212
 213 clib_error_t *ipsec_add_del_sa_sess_cb (ipsec_main_t * im, u32 sa_index,
 214                                         u8 is_add);
 215
 216 clib_error_t *ipsec_check_support_cb (ipsec_main_t * im, ipsec_sa_t * sa);
 217
 218 extern vlib_node_registration_t ah4_encrypt_node;
 219 extern vlib_node_registration_t ah4_decrypt_node;
 220 extern vlib_node_registration_t ah6_encrypt_node;
 221 extern vlib_node_registration_t ah6_decrypt_node;
 222 extern vlib_node_registration_t esp4_encrypt_node;
 223 extern vlib_node_registration_t esp4_decrypt_node;
 224 extern vlib_node_registration_t esp6_encrypt_node;
 225 extern vlib_node_registration_t esp6_decrypt_node;
 226 extern vlib_node_registration_t esp4_encrypt_tun_node;
 227 extern vlib_node_registration_t esp6_encrypt_tun_node;
 228 extern vlib_node_registration_t esp4_decrypt_tun_node;
 229 extern vlib_node_registration_t esp6_decrypt_tun_node;
 230 extern vlib_node_registration_t ipsec4_if_input_node;
 231 extern vlib_node_registration_t ipsec6_if_input_node;
 232
 233 /*
 234  * functions
 235  */
 236 u8 *format_ipsec_replay_window (u8 * s, va_list * args);
 237
 238 /*
 239  *  inline functions
 240  */
 241
 242 static_always_inline u32
 243 get_next_output_feature_node_index (vlib_buffer_t * b,
 244                                     vlib_node_runtime_t * nr)
 245 {
 246   u32 next;
 247   vlib_main_t *vm = vlib_get_main ();
 248   vlib_node_t *node = vlib_get_node (vm, nr->node_index);
 249
 250   vnet_feature_next (&next, b);
 251   return node->next_nodes[next];
 252 }
 253
 254 u32 ipsec_register_ah_backend (vlib_main_t * vm, ipsec_main_t * im,
 255                                const char *name,
 256                                const char *ah4_encrypt_node_name,
 257                                const char *ah4_decrypt_node_name,
 258                                const char *ah6_encrypt_node_name,
 259                                const char *ah6_decrypt_node_name,
 260                                check_support_cb_t ah_check_support_cb,
 261                                add_del_sa_sess_cb_t ah_add_del_sa_sess_cb);
 262
 263 u32 ipsec_register_esp_backend (vlib_main_t * vm, ipsec_main_t * im,
 264                                 const char *name,
 265                                 const char *esp4_encrypt_node_name,
 266                                 const char *esp4_encrypt_tun_node_name,
 267                                 const char *esp4_decrypt_node_name,
 268                                 const char *esp4_decrypt_tun_node_name,
 269                                 const char *esp6_encrypt_node_name,
 270                                 const char *esp6_encrypt_tun_node_name,
 271                                 const char *esp6_decrypt_node_name,
 272                                 const char *esp6_decrypt_tun_node_name,
 273                                 check_support_cb_t esp_check_support_cb,
 274                                 add_del_sa_sess_cb_t esp_add_del_sa_sess_cb,
 275                                 enable_disable_cb_t enable_disable_cb);
 276
 277 int ipsec_select_ah_backend (ipsec_main_t * im, u32 ah_backend_idx);
 278 int ipsec_select_esp_backend (ipsec_main_t * im, u32 esp_backend_idx);
 279
 280 clib_error_t *ipsec_rsc_in_use (ipsec_main_t * im);
 281
 282 always_inline ipsec_sa_t *
 283 ipsec_sa_get (u32 sa_index)
 284 {
 285   return (pool_elt_at_index (ipsec_main.sad, sa_index));
 286 }
 287
 288 void ipsec_add_feature (const char *arc_name, const char *node_name,
 289                         u32 * out_feature_index);
 290
 291 void ipsec_set_async_mode (u32 is_enabled);
 292
 293 #endif /* __IPSEC_H__ */
 294
 295 /*
 296  * fd.io coding-style-patch-verification: ON
 297  *
 298  * Local Variables:
 299  * eval: (c-set-style "gnu")
 300  * End:
 301  */