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