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