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