src/plugins/acl/acl.h

   1 /*
   2  * Copyright (c) 2016 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 included_acl_h
  16 #define included_acl_h
  17
  18 #include <vnet/vnet.h>
  19 #include <vnet/ip/ip.h>
  20 #include <vnet/l2/l2_output.h>
  21
  22
  23 #include <vppinfra/hash.h>
  24 #include <vppinfra/error.h>
  25 #include <vppinfra/bitmap.h>
  26 #include <vppinfra/elog.h>
  27 #include <vppinfra/bihash_48_8.h>
  28 #include <vppinfra/bihash_40_8.h>
  29
  30 #include "fa_node.h"
  31 #include "hash_lookup_types.h"
  32
  33 #define  ACL_PLUGIN_VERSION_MAJOR 1
  34 #define  ACL_PLUGIN_VERSION_MINOR 3
  35
  36 #define UDP_SESSION_IDLE_TIMEOUT_SEC 600
  37 #define TCP_SESSION_IDLE_TIMEOUT_SEC (3600*24)
  38 #define TCP_SESSION_TRANSIENT_TIMEOUT_SEC 120
  39
  40 extern vlib_node_registration_t acl_in_node;
  41 extern vlib_node_registration_t acl_out_node;
  42
  43 void input_acl_packet_match(u32 sw_if_index, vlib_buffer_t * b0, u32 *nextp, u32 *acl_match_p, u32 *rule_match_p, u32 *trace_bitmap);
  44 void output_acl_packet_match(u32 sw_if_index, vlib_buffer_t * b0, u32 *nextp, u32 *acl_match_p, u32 *rule_match_p, u32 *trace_bitmap);
  45
  46 enum acl_timeout_e {
  47   ACL_TIMEOUT_UDP_IDLE = 0,
  48   ACL_TIMEOUT_TCP_IDLE,
  49   ACL_TIMEOUT_TCP_TRANSIENT,
  50   ACL_N_TIMEOUTS
  51 };
  52
  53
  54 enum address_e { IP4, IP6 };
  55 typedef struct
  56 {
  57   enum address_e type;
  58   union {
  59     ip6_address_t ip6;
  60     ip4_address_t ip4;
  61   } addr;
  62 } address_t;
  63
  64 /*
  65  * ACL rules
  66  */
  67 typedef struct
  68 {
  69   u8 is_permit;
  70   u8 is_ipv6;
  71   ip46_address_t src;
  72   u8 src_prefixlen;
  73   ip46_address_t dst;
  74   u8 dst_prefixlen;
  75   u8 proto;
  76   u16 src_port_or_type_first;
  77   u16 src_port_or_type_last;
  78   u16 dst_port_or_code_first;
  79   u16 dst_port_or_code_last;
  80   u8 tcp_flags_value;
  81   u8 tcp_flags_mask;
  82 } acl_rule_t;
  83
  84 typedef struct
  85 {
  86   u8 is_permit;
  87   u8 is_ipv6;
  88   u8 src_mac[6];
  89   u8 src_mac_mask[6];
  90   ip46_address_t src_ip_addr;
  91   u8 src_prefixlen;
  92 } macip_acl_rule_t;
  93
  94 /*
  95  * ACL
  96  */
  97 typedef struct
  98 {
  99   u8 tag[64];
 100   u32 count;
 101   acl_rule_t *rules;
 102 } acl_list_t;
 103
 104 typedef struct
 105 {
 106   u8 tag[64];
 107   u32 count;
 108   macip_acl_rule_t *rules;
 109   /* References to the classifier tables that will enforce the rules */
 110   u32 ip4_table_index;
 111   u32 ip6_table_index;
 112   u32 l2_table_index;
 113 } macip_acl_list_t;
 114
 115 /*
 116  * An element describing a particular configuration fo the mask,
 117  * and how many times it has been used.
 118  */
 119 typedef struct
 120 {
 121   fa_5tuple_t mask;
 122   u32 refcount;
 123 } ace_mask_type_entry_t;
 124
 125 typedef struct {
 126   /* mheap to hold all the ACL module related allocations, other than hash */
 127   void *acl_mheap;
 128
 129   /* API message ID base */
 130   u16 msg_id_base;
 131
 132   acl_list_t *acls;     /* Pool of ACLs */
 133   hash_acl_info_t *hash_acl_infos; /* corresponding hash matching housekeeping info */
 134   clib_bihash_48_8_t acl_lookup_hash; /* ACL lookup hash table. */
 135
 136   /* mheap to hold all the miscellaneous allocations related to hash-based lookups */
 137   void *hash_lookup_mheap;
 138   int acl_lookup_hash_initialized;
 139   applied_hash_ace_entry_t **input_hash_entry_vec_by_sw_if_index;
 140   applied_hash_ace_entry_t **output_hash_entry_vec_by_sw_if_index;
 141   applied_hash_acl_info_t *input_applied_hash_acl_info_by_sw_if_index;
 142   applied_hash_acl_info_t *output_applied_hash_acl_info_by_sw_if_index;
 143
 144   macip_acl_list_t *macip_acls; /* Pool of MAC-IP ACLs */
 145
 146   /* ACLs associated with interfaces */
 147   u32 **input_acl_vec_by_sw_if_index;
 148   u32 **output_acl_vec_by_sw_if_index;
 149
 150   /* interfaces on which given ACLs are applied */
 151   u32 **input_sw_if_index_vec_by_acl;
 152   u32 **output_sw_if_index_vec_by_acl;
 153
 154   /* Total count of interface+direction pairs enabled */
 155   u32 fa_total_enabled_count;
 156
 157   /* Do we use hash-based ACL matching or linear */
 158   int use_hash_acl_matching;
 159
 160   /* a pool of all mask types present in all ACEs */
 161   ace_mask_type_entry_t *ace_mask_type_pool;
 162
 163   /*
 164    * Classify tables used to grab the packets for the ACL check,
 165    * and serving as the 5-tuple session tables at the same time
 166    */
 167   u32 *acl_ip4_input_classify_table_by_sw_if_index;
 168   u32 *acl_ip6_input_classify_table_by_sw_if_index;
 169   u32 *acl_ip4_output_classify_table_by_sw_if_index;
 170   u32 *acl_ip6_output_classify_table_by_sw_if_index;
 171
 172   /* MACIP (input) ACLs associated with the interfaces */
 173   u32 *macip_acl_by_sw_if_index;
 174
 175   /* bitmaps when set the processing is enabled on the interface */
 176   uword *fa_in_acl_on_sw_if_index;
 177   uword *fa_out_acl_on_sw_if_index;
 178   /* bihash holding all of the sessions */
 179   int fa_sessions_hash_is_initialized;
 180   clib_bihash_40_8_t fa_sessions_hash;
 181   /* The process node which orcherstrates the cleanup */
 182   u32 fa_cleaner_node_index;
 183   /* FA session timeouts, in seconds */
 184   u32 session_timeout_sec[ACL_N_TIMEOUTS];
 185   /* total session adds/dels */
 186   u64 fa_session_total_adds;
 187   u64 fa_session_total_dels;
 188
 189   /* L2 datapath glue */
 190
 191   /* next indices within L2 classifiers for ip4/ip6 fa L2 nodes */
 192   u32 l2_input_classify_next_acl_ip4;
 193   u32 l2_input_classify_next_acl_ip6;
 194   u32 l2_output_classify_next_acl_ip4;
 195   u32 l2_output_classify_next_acl_ip6;
 196   /* next node indices for L2 dispatch */
 197   u32 fa_acl_in_ip4_l2_node_feat_next_node_index[32];
 198   u32 fa_acl_in_ip6_l2_node_feat_next_node_index[32];
 199   u32 fa_acl_out_ip4_l2_node_feat_next_node_index[32];
 200   u32 fa_acl_out_ip6_l2_node_feat_next_node_index[32];
 201
 202   /* EH values that we can skip over */
 203   uword *fa_ipv6_known_eh_bitmap;
 204
 205   /* whether to match L4 ACEs with ports on the non-initial fragment */
 206   int l4_match_nonfirst_fragment;
 207
 208   /* conn table per-interface conn table parameters */
 209   u32 fa_conn_table_hash_num_buckets;
 210   uword fa_conn_table_hash_memory_size;
 211   u64 fa_conn_table_max_entries;
 212
 213   /*
 214    * If the cleaner has to delete more than this number
 215    * of connections, it halves the sleep time.
 216    */
 217
 218 #define ACL_FA_DEFAULT_MAX_DELETED_SESSIONS_PER_INTERVAL 100
 219   u64 fa_max_deleted_sessions_per_interval;
 220
 221   /*
 222    * If the cleaner deletes less than these connections,
 223    * it increases the wait time by the "increment"
 224    */
 225
 226 #define ACL_FA_DEFAULT_MIN_DELETED_SESSIONS_PER_INTERVAL 1
 227   u64 fa_min_deleted_sessions_per_interval;
 228
 229 #define ACL_FA_DEFAULT_CLEANER_WAIT_TIME_INCREMENT 0.1
 230   f64 fa_cleaner_wait_time_increment;
 231
 232   u64 fa_current_cleaner_timer_wait_interval;
 233
 234   int fa_interrupt_generation;
 235
 236   /* per-worker data related t conn management */
 237   acl_fa_per_worker_data_t *per_worker_data;
 238
 239   /* Configured session timeout */
 240   u64 session_timeout[ACL_N_TIMEOUTS];
 241
 242
 243   /* Counters for the cleaner thread */
 244
 245 #define foreach_fa_cleaner_counter                                         \
 246   _(fa_cleaner_cnt_delete_by_sw_index, "delete_by_sw_index events")        \
 247   _(fa_cleaner_cnt_delete_by_sw_index_ok, "delete_by_sw_index handled ok") \
 248   _(fa_cleaner_cnt_unknown_event, "unknown events received")               \
 249   _(fa_cleaner_cnt_timer_restarted, "session idle timers restarted")       \
 250   _(fa_cleaner_cnt_wait_with_timeout, "event wait with timeout called")    \
 251   _(fa_cleaner_cnt_wait_without_timeout, "event wait w/o timeout called")  \
 252   _(fa_cleaner_cnt_event_cycles, "total event cycles")                     \
 253 /* end of counters */
 254 #define _(id, desc) u32 id;
 255   foreach_fa_cleaner_counter
 256 #undef _
 257
 258   /* convenience */
 259   vlib_main_t * vlib_main;
 260   vnet_main_t * vnet_main;
 261 } acl_main_t;
 262
 263 #define foreach_acl_eh                                          \
 264    _(HOPBYHOP , 0  , "IPv6ExtHdrHopByHop")                      \
 265    _(ROUTING  , 43 , "IPv6ExtHdrRouting")                       \
 266    _(DESTOPT  , 60 , "IPv6ExtHdrDestOpt")                       \
 267    _(FRAGMENT , 44 , "IPv6ExtHdrFragment")                      \
 268    _(MOBILITY , 135, "Mobility Header")                         \
 269    _(HIP      , 139, "Experimental use Host Identity Protocol") \
 270    _(SHIM6    , 140, "Shim6 Protocol")                          \
 271    _(EXP1     , 253, "Use for experimentation and testing")     \
 272    _(EXP2     , 254, "Use for experimentation and testing")
 273
 274 /*
 275
 276  "No Next Header" is not a header.
 277  Also, Fragment header needs special processing.
 278
 279    _(NONEXT   , 59 , "NoNextHdr")                               \
 280
 281
 282 ESP is hiding its internal format, so no point in trying to go past it.
 283
 284    _(ESP      , 50 , "EncapsulatingSecurityPayload")            \
 285
 286
 287 AH has a special treatment of its length, it is in 32-bit words, not 64-bit words like the rest.
 288
 289    _(AUTH     , 51 , "Authentication Header")                   \
 290
 291
 292 */
 293
 294
 295  typedef enum {
 296  #define _(N, v, s) ACL_EH_##N = v,
 297          foreach_acl_eh
 298  #undef _
 299  } acl_eh_t;
 300
 301
 302
 303 extern acl_main_t acl_main;
 304
 305
 306 #endif