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