src/vnet/ipsec/ipsec_spd.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_SPD_H__
  16 #define __IPSEC_SPD_H__
  17
  18 #include <vppinfra/bihash_40_8.h>
  19 #include <vppinfra/bihash_16_8.h>
  20 #include <vlib/vlib.h>
  21
  22 #define foreach_ipsec_spd_policy_type                 \
  23   _(IP4_OUTBOUND, "ip4-outbound")                     \
  24   _(IP6_OUTBOUND, "ip6-outbound")                     \
  25   _(IP4_INBOUND_PROTECT, "ip4-inbound-protect")       \
  26   _(IP6_INBOUND_PROTECT, "ip6-inbound-protect")       \
  27   _(IP4_INBOUND_BYPASS,  "ip4-inbound-bypass")        \
  28   _(IP6_INBOUND_BYPASS,  "ip6-inbound-bypass")        \
  29   _(IP4_INBOUND_DISCARD,  "ip4-inbound-discard")      \
  30   _(IP6_INBOUND_DISCARD,  "ip6-inbound-discard")
  31
  32 typedef enum ipsec_spd_policy_t_
  33 {
  34 #define _(s,v) IPSEC_SPD_POLICY_##s,
  35   foreach_ipsec_spd_policy_type
  36 #undef _
  37     IPSEC_SPD_POLICY_N_TYPES,
  38 } ipsec_spd_policy_type_t;
  39
  40 #define FOR_EACH_IPSEC_SPD_POLICY_TYPE(_t)      \
  41   for (_t = 0; _t < IPSEC_SPD_POLICY_N_TYPES; _t++)
  42
  43 extern u8 *format_ipsec_policy_type (u8 * s, va_list * args);
  44
  45 typedef struct
  46 {
  47   /* index in the mask types pool */
  48   u32 mask_type_idx;
  49   /* counts references correspond to given mask type index */
  50   u32 refcount;
  51 } ipsec_fp_mask_id_t;
  52
  53 /**
  54  * @brief A fast path Security Policy Database
  55  */
  56 typedef struct
  57 {
  58   ipsec_fp_mask_id_t *fp_mask_ids[IPSEC_SPD_POLICY_N_TYPES];
  59   /* names of bihash tables */
  60   u8 *name4_out;
  61   u8 *name4_in;
  62   u8 *name6_out;
  63   u8 *name6_in;
  64   u32 ip6_out_lookup_hash_idx; /* fp ip6 lookup hash out index in the pool */
  65   u32 ip4_out_lookup_hash_idx; /* fp ip4 lookup hash out index in the pool */
  66   u32 ip6_in_lookup_hash_idx;  /* fp ip6 lookup hash in index in the pool */
  67   u32 ip4_in_lookup_hash_idx;  /* fp ip4 lookup hash in index in the pool */
  68 } ipsec_spd_fp_t;
  69
  70 /**
  71  * @brief A Security Policy Database
  72  */
  73 typedef struct
  74 {
  75   /** the User's ID for this policy */
  76   u32 id;
  77   /** vectors for each of the policy types */
  78   u32 *policies[IPSEC_SPD_POLICY_N_TYPES];
  79   ipsec_spd_fp_t fp_spd;
  80 } ipsec_spd_t;
  81
  82 /**
  83  * @brief Add/Delete a SPD
  84  */
  85 extern int ipsec_add_del_spd (vlib_main_t * vm, u32 spd_id, int is_add);
  86
  87 /**
  88  * @brief Bind/attach a SPD to an interface
  89  */
  90 extern int ipsec_set_interface_spd (vlib_main_t * vm,
  91                                     u32 sw_if_index, u32 spd_id, int is_add);
  92
  93 extern u8 *format_ipsec_spd (u8 * s, va_list * args);
  94
  95 extern u8 *format_ipsec_out_spd_flow_cache (u8 *s, va_list *args);
  96 extern u8 *format_ipsec_in_spd_flow_cache (u8 *s, va_list *args);
  97
  98 #endif /* __IPSEC_SPD_H__ */
  99
 100 /*
 101  * fd.io coding-style-patch-verification: ON
 102  *
 103  * Local Variables:
 104  * eval: (c-set-style "gnu")
 105  * End:
 106  */