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