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/feature/feature.h>
  20
  21 #include <openssl/hmac.h>
  22 #include <openssl/rand.h>
  23 #include <openssl/evp.h>
  24
  25 #include <vppinfra/types.h>
  26 #include <vppinfra/cache.h>
  27
  28 #include <vnet/ipsec/ipsec_spd.h>
  29 #include <vnet/ipsec/ipsec_spd_policy.h>
  30 #include <vnet/ipsec/ipsec_sa.h>
  31 #include <vnet/ipsec/ipsec_if.h>
  32 #include <vnet/ipsec/ipsec_io.h>
  33
  34 typedef clib_error_t *(*add_del_sa_sess_cb_t) (u32 sa_index, u8 is_add);
  35 typedef clib_error_t *(*check_support_cb_t) (ipsec_sa_t * sa);
  36
  37 typedef struct
  38 {
  39   u8 *name;
  40   /* add/del callback */
  41   add_del_sa_sess_cb_t add_del_sa_sess_cb;
  42   /* check support function */
  43   check_support_cb_t check_support_cb;
  44   u32 ah4_encrypt_node_index;
  45   u32 ah4_decrypt_node_index;
  46   u32 ah4_encrypt_next_index;
  47   u32 ah4_decrypt_next_index;
  48   u32 ah6_encrypt_node_index;
  49   u32 ah6_decrypt_node_index;
  50   u32 ah6_encrypt_next_index;
  51   u32 ah6_decrypt_next_index;
  52 } ipsec_ah_backend_t;
  53
  54 typedef struct
  55 {
  56   u8 *name;
  57   /* add/del callback */
  58   add_del_sa_sess_cb_t add_del_sa_sess_cb;
  59   /* check support function */
  60   check_support_cb_t check_support_cb;
  61   u32 esp4_encrypt_node_index;
  62   u32 esp4_decrypt_node_index;
  63   u32 esp4_encrypt_next_index;
  64   u32 esp4_decrypt_next_index;
  65   u32 esp6_encrypt_node_index;
  66   u32 esp6_decrypt_node_index;
  67   u32 esp6_encrypt_next_index;
  68   u32 esp6_decrypt_next_index;
  69 } ipsec_esp_backend_t;
  70
  71 typedef struct
  72 {
  73   const EVP_CIPHER *type;
  74   u8 iv_size;
  75   u8 block_size;
  76 } ipsec_proto_main_crypto_alg_t;
  77
  78 typedef struct
  79 {
  80   const EVP_MD *md;
  81   u8 trunc_size;
  82 } ipsec_proto_main_integ_alg_t;
  83
  84 typedef struct
  85 {
  86   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  87 #if OPENSSL_VERSION_NUMBER >= 0x10100000L
  88   EVP_CIPHER_CTX *encrypt_ctx;
  89 #else
  90   EVP_CIPHER_CTX encrypt_ctx;
  91 #endif
  92     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
  93 #if OPENSSL_VERSION_NUMBER >= 0x10100000L
  94   EVP_CIPHER_CTX *decrypt_ctx;
  95 #else
  96   EVP_CIPHER_CTX decrypt_ctx;
  97 #endif
  98     CLIB_CACHE_LINE_ALIGN_MARK (cacheline2);
  99 #if OPENSSL_VERSION_NUMBER >= 0x10100000L
 100   HMAC_CTX *hmac_ctx;
 101 #else
 102   HMAC_CTX hmac_ctx;
 103 #endif
 104   ipsec_crypto_alg_t last_encrypt_alg;
 105   ipsec_crypto_alg_t last_decrypt_alg;
 106   ipsec_integ_alg_t last_integ_alg;
 107 } ipsec_proto_main_per_thread_data_t;
 108
 109 typedef struct
 110 {
 111   ipsec_proto_main_crypto_alg_t *ipsec_proto_main_crypto_algs;
 112   ipsec_proto_main_integ_alg_t *ipsec_proto_main_integ_algs;
 113   ipsec_proto_main_per_thread_data_t *per_thread_data;
 114 } ipsec_proto_main_t;
 115
 116 extern ipsec_proto_main_t ipsec_proto_main;
 117
 118 typedef struct
 119 {
 120   /* pool of tunnel instances */
 121   ipsec_spd_t *spds;
 122   /* Pool of security associations */
 123   ipsec_sa_t *sad;
 124   /* pool of policies */
 125   ipsec_policy_t *policies;
 126
 127   /* pool of tunnel interfaces */
 128   ipsec_tunnel_if_t *tunnel_interfaces;
 129   u32 *free_tunnel_if_indices;
 130
 131   u32 **empty_buffers;
 132
 133   uword *tunnel_index_by_key;
 134
 135   /* convenience */
 136   vlib_main_t *vlib_main;
 137   vnet_main_t *vnet_main;
 138
 139   /* next node indices */
 140   u32 feature_next_node_index[32];
 141
 142   /* hashes */
 143   uword *spd_index_by_spd_id;
 144   uword *spd_index_by_sw_if_index;
 145   uword *sa_index_by_sa_id;
 146   uword *ipsec_if_pool_index_by_key;
 147   uword *ipsec_if_real_dev_by_show_dev;
 148
 149   /* node indices */
 150   u32 error_drop_node_index;
 151   u32 esp4_encrypt_node_index;
 152   u32 esp4_decrypt_node_index;
 153   u32 ah4_encrypt_node_index;
 154   u32 ah4_decrypt_node_index;
 155   u32 esp6_encrypt_node_index;
 156   u32 esp6_decrypt_node_index;
 157   u32 ah6_encrypt_node_index;
 158   u32 ah6_decrypt_node_index;
 159   /* next node indices */
 160   u32 esp4_encrypt_next_index;
 161   u32 esp4_decrypt_next_index;
 162   u32 ah4_encrypt_next_index;
 163   u32 ah4_decrypt_next_index;
 164   u32 esp6_encrypt_next_index;
 165   u32 esp6_decrypt_next_index;
 166   u32 ah6_encrypt_next_index;
 167   u32 ah6_decrypt_next_index;
 168
 169   /* pool of ah backends */
 170   ipsec_ah_backend_t *ah_backends;
 171   /* pool of esp backends */
 172   ipsec_esp_backend_t *esp_backends;
 173   /* index of current ah backend */
 174   u32 ah_current_backend;
 175   /* index of current esp backend */
 176   u32 esp_current_backend;
 177   /* index of default ah backend */
 178   u32 ah_default_backend;
 179   /* index of default esp backend */
 180   u32 esp_default_backend;
 181 } ipsec_main_t;
 182
 183 extern ipsec_main_t ipsec_main;
 184
 185 clib_error_t *ipsec_add_del_sa_sess_cb (ipsec_main_t * im, u32 sa_index,
 186                                         u8 is_add);
 187
 188 clib_error_t *ipsec_check_support_cb (ipsec_main_t * im, ipsec_sa_t * sa);
 189
 190 extern vlib_node_registration_t esp4_encrypt_node;
 191 extern vlib_node_registration_t esp4_decrypt_node;
 192 extern vlib_node_registration_t ah4_encrypt_node;
 193 extern vlib_node_registration_t ah4_decrypt_node;
 194 extern vlib_node_registration_t esp6_encrypt_node;
 195 extern vlib_node_registration_t esp6_decrypt_node;
 196 extern vlib_node_registration_t ah6_encrypt_node;
 197 extern vlib_node_registration_t ah6_decrypt_node;
 198 extern vlib_node_registration_t ipsec_if_input_node;
 199
 200 /*
 201  * functions
 202  */
 203 u8 *format_ipsec_replay_window (u8 * s, va_list * args);
 204
 205 /*
 206  *  inline functions
 207  */
 208
 209 always_inline void
 210 ipsec_alloc_empty_buffers (vlib_main_t * vm, ipsec_main_t * im)
 211 {
 212   u32 thread_index = vm->thread_index;
 213   uword l = vec_len (im->empty_buffers[thread_index]);
 214   uword n_alloc = 0;
 215
 216   if (PREDICT_FALSE (l < VLIB_FRAME_SIZE))
 217     {
 218       if (!im->empty_buffers[thread_index])
 219         {
 220           vec_alloc (im->empty_buffers[thread_index], 2 * VLIB_FRAME_SIZE);
 221         }
 222
 223       n_alloc = vlib_buffer_alloc (vm, im->empty_buffers[thread_index] + l,
 224                                    2 * VLIB_FRAME_SIZE - l);
 225
 226       _vec_len (im->empty_buffers[thread_index]) = l + n_alloc;
 227     }
 228 }
 229
 230 static_always_inline u32
 231 get_next_output_feature_node_index (vlib_buffer_t * b,
 232                                     vlib_node_runtime_t * nr)
 233 {
 234   u32 next;
 235   vlib_main_t *vm = vlib_get_main ();
 236   vlib_node_t *node = vlib_get_node (vm, nr->node_index);
 237
 238   vnet_feature_next (&next, b);
 239   return node->next_nodes[next];
 240 }
 241
 242 u32 ipsec_register_ah_backend (vlib_main_t * vm, ipsec_main_t * im,
 243                                const char *name,
 244                                const char *ah4_encrypt_node_name,
 245                                const char *ah4_decrypt_node_name,
 246                                const char *ah6_encrypt_node_name,
 247                                const char *ah6_decrypt_node_name,
 248                                check_support_cb_t ah_check_support_cb,
 249                                add_del_sa_sess_cb_t ah_add_del_sa_sess_cb);
 250
 251 u32 ipsec_register_esp_backend (vlib_main_t * vm, ipsec_main_t * im,
 252                                 const char *name,
 253                                 const char *esp4_encrypt_node_name,
 254                                 const char *esp4_decrypt_node_name,
 255                                 const char *esp6_encrypt_node_name,
 256                                 const char *esp6_decrypt_node_name,
 257                                 check_support_cb_t esp_check_support_cb,
 258                                 add_del_sa_sess_cb_t esp_add_del_sa_sess_cb);
 259
 260 int ipsec_select_ah_backend (ipsec_main_t * im, u32 ah_backend_idx);
 261 int ipsec_select_esp_backend (ipsec_main_t * im, u32 esp_backend_idx);
 262 #endif /* __IPSEC_H__ */
 263
 264 /*
 265  * fd.io coding-style-patch-verification: ON
 266  *
 267  * Local Variables:
 268  * eval: (c-set-style "gnu")
 269  * End:
 270  */