vnet/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 #if DPDK==1
  16 #include <vnet/devices/dpdk/dpdk.h>
  17 #endif
  18
  19 #define foreach_ipsec_policy_action \
  20   _(0, BYPASS,  "bypass")          \
  21   _(1, DISCARD, "discard")         \
  22   _(2, RESOLVE, "resolve")         \
  23   _(3, PROTECT, "protect")
  24
  25 typedef enum {
  26 #define _(v,f,s) IPSEC_POLICY_ACTION_##f = v,
  27   foreach_ipsec_policy_action
  28 #undef _
  29   IPSEC_POLICY_N_ACTION,
  30 } ipsec_policy_action_t;
  31
  32 #define foreach_ipsec_crypto_alg \
  33   _(0, NONE,  "none")               \
  34   _(1, AES_CBC_128, "aes-cbc-128")  \
  35   _(2, AES_CBC_192, "aes-cbc-192")  \
  36   _(3, AES_CBC_256, "aes-cbc-256")
  37
  38 typedef enum {
  39 #define _(v,f,s) IPSEC_CRYPTO_ALG_##f = v,
  40   foreach_ipsec_crypto_alg
  41 #undef _
  42   IPSEC_CRYPTO_N_ALG,
  43 } ipsec_crypto_alg_t;
  44
  45 #define foreach_ipsec_integ_alg \
  46   _(0, NONE,  "none")                                                     \
  47   _(1, MD5_96, "md5-96")           /* RFC2403 */                          \
  48   _(2, SHA1_96, "sha1-96")         /* RFC2404 */                          \
  49   _(3, SHA_256_96, "sha-256-96")   /* draft-ietf-ipsec-ciph-sha-256-00 */ \
  50   _(4, SHA_256_128, "sha-256-128") /* RFC4868 */                          \
  51   _(5, SHA_384_192, "sha-384-192") /* RFC4868 */                          \
  52   _(6, SHA_512_256, "sha-512-256") /* RFC4868 */
  53
  54 typedef enum {
  55 #define _(v,f,s) IPSEC_INTEG_ALG_##f = v,
  56   foreach_ipsec_integ_alg
  57 #undef _
  58   IPSEC_INTEG_N_ALG,
  59 } ipsec_integ_alg_t;
  60
  61 typedef enum {
  62         IPSEC_PROTOCOL_AH = 0,
  63         IPSEC_PROTOCOL_ESP = 1
  64 } ipsec_protocol_t;
  65
  66 typedef struct {
  67     u32 id;
  68     u32 spi;
  69     ipsec_protocol_t protocol;
  70
  71     ipsec_crypto_alg_t crypto_alg;
  72     u8 crypto_key_len;
  73     u8 crypto_key[128];
  74
  75     ipsec_integ_alg_t integ_alg;
  76     u8 integ_key_len;
  77     u8 integ_key[128];
  78
  79     u8 use_esn;
  80     u8 use_anti_replay;
  81
  82     u8 is_tunnel;
  83     u8 is_tunnel_ip6;
  84     ip46_address_t tunnel_src_addr;
  85     ip46_address_t tunnel_dst_addr;
  86
  87     /* runtime */
  88     u32 seq;
  89     u32 seq_hi;
  90     u32 last_seq;
  91     u32 last_seq_hi;
  92     u64 replay_window;
  93 } ipsec_sa_t;
  94
  95 typedef struct {
  96   ip46_address_t start, stop;
  97 } ip46_address_range_t;
  98
  99 typedef struct {
 100   u16 start, stop;
 101 } port_range_t;
 102
 103 typedef struct {
 104   u8 is_add;
 105   u8 esn;
 106   u8 anti_replay;
 107   ip4_address_t local_ip, remote_ip;
 108   u32 local_spi;
 109   u32 remote_spi;
 110 } ipsec_add_del_tunnel_args_t;
 111
 112 typedef enum {
 113   IPSEC_IF_SET_KEY_TYPE_NONE,
 114   IPSEC_IF_SET_KEY_TYPE_LOCAL_CRYPTO,
 115   IPSEC_IF_SET_KEY_TYPE_REMOTE_CRYPTO,
 116   IPSEC_IF_SET_KEY_TYPE_LOCAL_INTEG,
 117   IPSEC_IF_SET_KEY_TYPE_REMOTE_INTEG,
 118 } ipsec_if_set_key_type_t;
 119
 120 typedef  struct {
 121     u32 id;
 122     i32 priority;
 123     u8 is_outbound;
 124
 125     // Selector
 126     u8 is_ipv6;
 127     ip46_address_range_t laddr;
 128     ip46_address_range_t raddr;
 129     u8 protocol;
 130     port_range_t lport;
 131     port_range_t rport;
 132
 133     // Policy
 134     u8 policy;
 135     u32 sa_id;
 136     u32 sa_index;
 137
 138     // Counter
 139     vlib_counter_t counter;
 140 } ipsec_policy_t;
 141
 142 typedef struct {
 143         u32 id;
 144         /* pool of policies */
 145         ipsec_policy_t * policies;
 146         /* vectors of policy indices */
 147         u32 * ipv4_outbound_policies;
 148         u32 * ipv6_outbound_policies;
 149         u32 * ipv4_inbound_protect_policy_indices;
 150         u32 * ipv4_inbound_policy_discard_and_bypass_indices;
 151         u32 * ipv6_inbound_protect_policy_indices;
 152         u32 * ipv6_inbound_policy_discard_and_bypass_indices;
 153 } ipsec_spd_t;
 154
 155 typedef struct {
 156   u32 spd_index;
 157 } ip4_ipsec_config_t;
 158
 159 typedef struct {
 160   u32 spd_index;
 161 } ip6_ipsec_config_t;
 162
 163 typedef struct {
 164   u32 input_sa_index;
 165   u32 output_sa_index;
 166   u32 hw_if_index;
 167 } ipsec_tunnel_if_t;
 168
 169 typedef struct {
 170   /* pool of tunnel instances */
 171   ipsec_spd_t * spds;
 172   ipsec_sa_t * sad;
 173
 174   /* pool of tunnel interfaces */
 175   ipsec_tunnel_if_t * tunnel_interfaces;
 176   u32 * free_tunnel_if_indices;
 177
 178   u32 * empty_buffers;
 179
 180   uword * tunnel_index_by_key;
 181
 182   /* convenience */
 183   vlib_main_t *vlib_main;
 184   vnet_main_t *vnet_main;
 185
 186   /* next node indices */
 187   u32 feature_next_node_index[32];
 188
 189   /* hashes */
 190   uword * spd_index_by_spd_id;
 191   uword * spd_index_by_sw_if_index;
 192   uword * sa_index_by_sa_id;
 193   uword * ipsec_if_pool_index_by_key;
 194
 195   /* node indexes */
 196   u32 error_drop_node_index;
 197   u32 ip4_lookup_node_index;
 198   u32 esp_encrypt_node_index;
 199
 200 } ipsec_main_t;
 201
 202 ipsec_main_t ipsec_main;
 203
 204 extern vlib_node_registration_t esp_encrypt_node;
 205 extern vlib_node_registration_t esp_decrypt_node;
 206 extern vlib_node_registration_t ipsec_if_output_node;
 207 extern vlib_node_registration_t ipsec_if_input_node;
 208
 209
 210 /*
 211  * functions
 212  */
 213 int ipsec_set_interface_spd(vlib_main_t * vm, u32 sw_if_index, u32 spd_id, int is_add);
 214 int ipsec_add_del_spd(vlib_main_t * vm, u32 spd_id, int is_add);
 215 int ipsec_add_del_policy(vlib_main_t * vm, ipsec_policy_t * policy, int is_add);
 216 int ipsec_add_del_sa(vlib_main_t * vm, ipsec_sa_t * new_sa, int is_add);
 217 int ipsec_set_sa_key(vlib_main_t * vm, ipsec_sa_t * sa_update);
 218
 219 u8 * format_ipsec_if_output_trace (u8 * s, va_list * args);
 220 u8 * format_ipsec_policy_action (u8 * s, va_list * args);
 221 u8 * format_ipsec_crypto_alg (u8 * s, va_list * args);
 222 u8 * format_ipsec_integ_alg (u8 * s, va_list * args);
 223 u8 * format_ipsec_replay_window(u8 * s, va_list * args);
 224 uword unformat_ipsec_policy_action (unformat_input_t * input, va_list * args);
 225 uword unformat_ipsec_crypto_alg (unformat_input_t * input, va_list * args);
 226 uword unformat_ipsec_integ_alg (unformat_input_t * input, va_list * args);
 227
 228 u32 ipsec_add_del_tunnel_if (vnet_main_t * vnm, ipsec_add_del_tunnel_args_t * args);
 229 int ipsec_set_interface_key(vnet_main_t * vnm, u32 hw_if_index, ipsec_if_set_key_type_t type, u8 alg, u8 * key);
 230
 231
 232 /*
 233  *  inline functions
 234  */
 235
 236 always_inline void
 237 ipsec_alloc_empty_buffers(vlib_main_t * vm, ipsec_main_t *im)
 238 {
 239 #if DPDK==1
 240   dpdk_main_t * dm = &dpdk_main;
 241   u32 free_list_index = dm->vlib_buffer_free_list_index;
 242 #else
 243   u32 free_list_index = VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX;
 244 #endif
 245   uword l = vec_len (im->empty_buffers);
 246   uword n_alloc = 0;
 247
 248   if (PREDICT_FALSE(l < VLIB_FRAME_SIZE))
 249     {
 250       if (!im->empty_buffers) {
 251         vec_alloc (im->empty_buffers, 2 * VLIB_FRAME_SIZE );
 252       }
 253
 254       n_alloc = vlib_buffer_alloc_from_free_list (vm, im->empty_buffers + l,
 255                                                   2 * VLIB_FRAME_SIZE - l,
 256                                                   free_list_index);
 257
 258       _vec_len (im->empty_buffers) = l + n_alloc;
 259     }
 260 }
 261
 262 static_always_inline u32 /* FIXME move to interface???.h */
 263 get_next_output_feature_node_index( vnet_main_t * vnm,
 264                                     vlib_buffer_t * b)
 265 {
 266   vlib_main_t * vm = vlib_get_main();
 267   vlib_node_t * node;
 268   u32 r;
 269   intf_output_feat_t next_feature;
 270
 271   u8 * node_names[] = {
 272 #define _(sym, str) (u8 *) str,
 273     foreach_intf_output_feat
 274 #undef _
 275   };
 276
 277   count_trailing_zeros(next_feature, vnet_buffer(b)->output_features.bitmap);
 278
 279   if (next_feature >= INTF_OUTPUT_FEAT_DONE)
 280     {
 281       u32 sw_if_index = vnet_buffer(b)->sw_if_index[VLIB_TX];
 282       vnet_hw_interface_t * hw = vnet_get_sup_hw_interface(vnm, sw_if_index);
 283       r = hw->output_node_index;
 284     }
 285   else
 286     {
 287       vnet_buffer(b)->output_features.bitmap &= ~(1 << next_feature);
 288       /* FIXME */
 289       node = vlib_get_node_by_name(vm, node_names[next_feature]);
 290       r = node->index;
 291     }
 292
 293   return r;
 294 }