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 #include "lookup_context.h"
  33
  34 #define  ACL_PLUGIN_VERSION_MAJOR 1
  35 #define  ACL_PLUGIN_VERSION_MINOR 3
  36
  37 #define UDP_SESSION_IDLE_TIMEOUT_SEC 600
  38 #define TCP_SESSION_IDLE_TIMEOUT_SEC (3600*24)
  39 #define TCP_SESSION_TRANSIENT_TIMEOUT_SEC 120
  40
  41 #define SESSION_PURGATORY_TIMEOUT_USEC 10
  42
  43 #define ACL_PLUGIN_HASH_LOOKUP_HEAP_SIZE (2 << 25)
  44 #define ACL_PLUGIN_HASH_LOOKUP_HASH_BUCKETS 65536
  45 #define ACL_PLUGIN_HASH_LOOKUP_HASH_MEMORY (2 << 25)
  46
  47 extern vlib_node_registration_t acl_in_node;
  48 extern vlib_node_registration_t acl_out_node;
  49
  50 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);
  51 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);
  52
  53 enum acl_timeout_e {
  54   ACL_TIMEOUT_UNUSED = 0,
  55   ACL_TIMEOUT_UDP_IDLE,
  56   ACL_TIMEOUT_TCP_IDLE,
  57   ACL_TIMEOUT_TCP_TRANSIENT,
  58   ACL_N_USER_TIMEOUTS,
  59   ACL_TIMEOUT_PURGATORY = ACL_N_USER_TIMEOUTS, /* a special-case queue for deletion-in-progress sessions */
  60   ACL_N_TIMEOUTS
  61 };
  62
  63
  64 enum address_e { IP4, IP6 };
  65 typedef struct
  66 {
  67   enum address_e type;
  68   union {
  69     ip6_address_t ip6;
  70     ip4_address_t ip4;
  71   } addr;
  72 } address_t;
  73
  74 /*
  75  * ACL rules
  76  */
  77 typedef struct
  78 {
  79   u8 is_permit;
  80   u8 is_ipv6;
  81   ip46_address_t src;
  82   u8 src_prefixlen;
  83   ip46_address_t dst;
  84   u8 dst_prefixlen;
  85   u8 proto;
  86   u16 src_port_or_type_first;
  87   u16 src_port_or_type_last;
  88   u16 dst_port_or_code_first;
  89   u16 dst_port_or_code_last;
  90   u8 tcp_flags_value;
  91   u8 tcp_flags_mask;
  92 } acl_rule_t;
  93
  94 typedef struct
  95 {
  96   u8 is_permit;
  97   u8 is_ipv6;
  98   u8 src_mac[6];
  99   u8 src_mac_mask[6];
 100   ip46_address_t src_ip_addr;
 101   u8 src_prefixlen;
 102 } macip_acl_rule_t;
 103
 104 /*
 105  * ACL
 106  */
 107 typedef struct
 108 {
 109   /** Required for pool_get_aligned */
 110   CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
 111   u8 tag[64];
 112   u32 count;
 113   acl_rule_t *rules;
 114 } acl_list_t;
 115
 116 typedef struct
 117 {
 118   /** Required for pool_get_aligned */
 119   CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
 120   u8 tag[64];
 121   u32 count;
 122   macip_acl_rule_t *rules;
 123   /* References to the classifier tables that will enforce the rules */
 124   u32 ip4_table_index;
 125   u32 ip6_table_index;
 126   u32 l2_table_index;
 127   /* outacl classifier tables */
 128   u32 out_ip4_table_index;
 129   u32 out_ip6_table_index;
 130   u32 out_l2_table_index;
 131 } macip_acl_list_t;
 132
 133 /*
 134  * An element describing a particular configuration fo the mask,
 135  * and how many times it has been used.
 136  */
 137 typedef struct
 138 {
 139   /** Required for pool_get_aligned */
 140   CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
 141   fa_5tuple_t mask;
 142   u32 refcount;
 143 } ace_mask_type_entry_t;
 144
 145 typedef struct {
 146   /* mheap to hold all the ACL module related allocations, other than hash */
 147   void *acl_mheap;
 148   uword acl_mheap_size;
 149
 150   /* API message ID base */
 151   u16 msg_id_base;
 152
 153   /* The pool of users of ACL lookup contexts */
 154   acl_lookup_context_user_t *acl_users;
 155   /* The pool of ACL lookup contexts */
 156   acl_lookup_context_t *acl_lookup_contexts;
 157
 158   acl_list_t *acls;     /* Pool of ACLs */
 159   hash_acl_info_t *hash_acl_infos; /* corresponding hash matching housekeeping info */
 160   clib_bihash_48_8_t acl_lookup_hash; /* ACL lookup hash table. */
 161   u32 hash_lookup_hash_buckets;
 162   u32 hash_lookup_hash_memory;
 163
 164   /* mheap to hold all the miscellaneous allocations related to hash-based lookups */
 165   void *hash_lookup_mheap;
 166   uword hash_lookup_mheap_size;
 167   int acl_lookup_hash_initialized;
 168 /*
 169   applied_hash_ace_entry_t **input_hash_entry_vec_by_sw_if_index;
 170   applied_hash_ace_entry_t **output_hash_entry_vec_by_sw_if_index;
 171   applied_hash_acl_info_t *input_applied_hash_acl_info_by_sw_if_index;
 172   applied_hash_acl_info_t *output_applied_hash_acl_info_by_sw_if_index;
 173 */
 174   applied_hash_ace_entry_t **hash_entry_vec_by_lc_index;
 175   applied_hash_acl_info_t *applied_hash_acl_info_by_lc_index;
 176
 177   /* Corresponding lookup context indices for in/out lookups per sw_if_index */
 178   u32 *input_lc_index_by_sw_if_index;
 179   u32 *output_lc_index_by_sw_if_index;
 180   /* context user id for interface ACLs */
 181   u32 interface_acl_user_id;
 182
 183   macip_acl_list_t *macip_acls; /* Pool of MAC-IP ACLs */
 184
 185   /* ACLs associated with interfaces */
 186   u32 **input_acl_vec_by_sw_if_index;
 187   u32 **output_acl_vec_by_sw_if_index;
 188
 189   /* interfaces on which given ACLs are applied */
 190   u32 **input_sw_if_index_vec_by_acl;
 191   u32 **output_sw_if_index_vec_by_acl;
 192
 193   /* bitmaps 1=sw_if_index has in/out ACL processing enabled */
 194   uword *in_acl_on_sw_if_index;
 195   uword *out_acl_on_sw_if_index;
 196
 197   /* lookup contexts where a given ACL is used */
 198   u32 **lc_index_vec_by_acl;
 199
 200   /* input and output policy epochs by interface */
 201   u32 *input_policy_epoch_by_sw_if_index;
 202   u32 *output_policy_epoch_by_sw_if_index;
 203
 204   /* whether we need to take the epoch of the session into account */
 205   int reclassify_sessions;
 206
 207
 208
 209   /* Total count of interface+direction pairs enabled */
 210   u32 fa_total_enabled_count;
 211
 212   /* Do we use hash-based ACL matching or linear */
 213   int use_hash_acl_matching;
 214
 215   /* a pool of all mask types present in all ACEs */
 216   ace_mask_type_entry_t *ace_mask_type_pool;
 217
 218   /*
 219    * Classify tables used to grab the packets for the ACL check,
 220    * and serving as the 5-tuple session tables at the same time
 221    */
 222   u32 *acl_ip4_input_classify_table_by_sw_if_index;
 223   u32 *acl_ip6_input_classify_table_by_sw_if_index;
 224   u32 *acl_ip4_output_classify_table_by_sw_if_index;
 225   u32 *acl_ip6_output_classify_table_by_sw_if_index;
 226
 227   u32 *acl_dot1q_input_classify_table_by_sw_if_index;
 228   u32 *acl_dot1ad_input_classify_table_by_sw_if_index;
 229   u32 *acl_dot1q_output_classify_table_by_sw_if_index;
 230   u32 *acl_dot1ad_output_classify_table_by_sw_if_index;
 231
 232   u32 *acl_etype_input_classify_table_by_sw_if_index;
 233   u32 *acl_etype_output_classify_table_by_sw_if_index;
 234
 235   u16 **input_etype_whitelist_by_sw_if_index;
 236   u16 **output_etype_whitelist_by_sw_if_index;
 237
 238   /* MACIP (input) ACLs associated with the interfaces */
 239   u32 *macip_acl_by_sw_if_index;
 240
 241   /* Vector of interfaces on which given MACIP ACLs are applied */
 242   u32 **sw_if_index_vec_by_macip_acl;
 243
 244   /* bitmaps when set the processing is enabled on the interface */
 245   uword *fa_in_acl_on_sw_if_index;
 246   uword *fa_out_acl_on_sw_if_index;
 247   /* bihash holding all of the sessions */
 248   int fa_sessions_hash_is_initialized;
 249   clib_bihash_40_8_t fa_sessions_hash;
 250   /* The process node which orcherstrates the cleanup */
 251   u32 fa_cleaner_node_index;
 252   /* FA session timeouts, in seconds */
 253   u32 session_timeout_sec[ACL_N_TIMEOUTS];
 254   /* total session adds/dels */
 255   u64 fa_session_total_adds;
 256   u64 fa_session_total_dels;
 257   /* how many sessions went into purgatory */
 258   u64 fa_session_total_deactivations;
 259
 260   /* L2 datapath glue */
 261
 262   /* next indices within L2 classifiers for ip4/ip6 fa L2 nodes */
 263   u32 l2_input_classify_next_acl_ip4;
 264   u32 l2_input_classify_next_acl_ip6;
 265   u32 l2_output_classify_next_acl_ip4;
 266   u32 l2_output_classify_next_acl_ip6;
 267   /* next node indices for L2 dispatch */
 268   u32 fa_acl_in_ip4_l2_node_feat_next_node_index[32];
 269   u32 fa_acl_in_ip6_l2_node_feat_next_node_index[32];
 270   u32 fa_acl_out_ip4_l2_node_feat_next_node_index[32];
 271   u32 fa_acl_out_ip6_l2_node_feat_next_node_index[32];
 272
 273   /* EH values that we can skip over */
 274   uword *fa_ipv6_known_eh_bitmap;
 275
 276   /* whether to match L4 ACEs with ports on the non-initial fragment */
 277   int l4_match_nonfirst_fragment;
 278
 279   /* conn table per-interface conn table parameters */
 280   u32 fa_conn_table_hash_num_buckets;
 281   uword fa_conn_table_hash_memory_size;
 282   u64 fa_conn_table_max_entries;
 283
 284   int trace_sessions;
 285   int trace_acl;
 286
 287   /*
 288    * If the cleaner has to delete more than this number
 289    * of connections, it halves the sleep time.
 290    */
 291
 292 #define ACL_FA_DEFAULT_MAX_DELETED_SESSIONS_PER_INTERVAL 100
 293   u64 fa_max_deleted_sessions_per_interval;
 294
 295   /*
 296    * If the cleaner deletes less than these connections,
 297    * it increases the wait time by the "increment"
 298    */
 299
 300 #define ACL_FA_DEFAULT_MIN_DELETED_SESSIONS_PER_INTERVAL 1
 301   u64 fa_min_deleted_sessions_per_interval;
 302
 303 #define ACL_FA_DEFAULT_CLEANER_WAIT_TIME_INCREMENT 0.1
 304   f64 fa_cleaner_wait_time_increment;
 305
 306   u64 fa_current_cleaner_timer_wait_interval;
 307
 308   int fa_interrupt_generation;
 309
 310   /* per-worker data related t conn management */
 311   acl_fa_per_worker_data_t *per_worker_data;
 312
 313   /* Configured session timeout */
 314   u64 session_timeout[ACL_N_TIMEOUTS];
 315
 316
 317   /* Counters for the cleaner thread */
 318
 319 #define foreach_fa_cleaner_counter                                         \
 320   _(fa_cleaner_cnt_delete_by_sw_index, "delete_by_sw_index events")        \
 321   _(fa_cleaner_cnt_delete_by_sw_index_ok, "delete_by_sw_index handled ok") \
 322   _(fa_cleaner_cnt_unknown_event, "unknown events received")               \
 323   _(fa_cleaner_cnt_timer_restarted, "session idle timers restarted")       \
 324   _(fa_cleaner_cnt_wait_with_timeout, "event wait with timeout called")    \
 325   _(fa_cleaner_cnt_wait_without_timeout, "event wait w/o timeout called")  \
 326   _(fa_cleaner_cnt_event_cycles, "total event cycles")                     \
 327 /* end of counters */
 328 #define _(id, desc) u32 id;
 329   foreach_fa_cleaner_counter
 330 #undef _
 331
 332   /* convenience */
 333   vlib_main_t * vlib_main;
 334   vnet_main_t * vnet_main;
 335   /* logging */
 336   vlib_log_class_t log_default;
 337 } acl_main_t;
 338
 339 #define acl_log_err(...) \
 340   vlib_log(VLIB_LOG_LEVEL_ERR, acl_main.log_default, __VA_ARGS__)
 341 #define acl_log_warn(...) \
 342   vlib_log(VLIB_LOG_LEVEL_WARNING, acl_main.log_default, __VA_ARGS__)
 343 #define acl_log_notice(...) \
 344   vlib_log(VLIB_LOG_LEVEL_NOTICE, acl_main.log_default, __VA_ARGS__)
 345 #define acl_log_info(...) \
 346   vlib_log(VLIB_LOG_LEVEL_INFO, acl_main.log_default, __VA_ARGS__)
 347
 348
 349
 350 #define foreach_acl_eh                                          \
 351    _(HOPBYHOP , 0  , "IPv6ExtHdrHopByHop")                      \
 352    _(ROUTING  , 43 , "IPv6ExtHdrRouting")                       \
 353    _(DESTOPT  , 60 , "IPv6ExtHdrDestOpt")                       \
 354    _(FRAGMENT , 44 , "IPv6ExtHdrFragment")                      \
 355    _(MOBILITY , 135, "Mobility Header")                         \
 356    _(HIP      , 139, "Experimental use Host Identity Protocol") \
 357    _(SHIM6    , 140, "Shim6 Protocol")                          \
 358    _(EXP1     , 253, "Use for experimentation and testing")     \
 359    _(EXP2     , 254, "Use for experimentation and testing")
 360
 361 /*
 362
 363  "No Next Header" is not a header.
 364  Also, Fragment header needs special processing.
 365
 366    _(NONEXT   , 59 , "NoNextHdr")                               \
 367
 368
 369 ESP is hiding its internal format, so no point in trying to go past it.
 370
 371    _(ESP      , 50 , "EncapsulatingSecurityPayload")            \
 372
 373
 374 AH has a special treatment of its length, it is in 32-bit words, not 64-bit words like the rest.
 375
 376    _(AUTH     , 51 , "Authentication Header")                   \
 377
 378
 379 */
 380
 381
 382  typedef enum {
 383  #define _(N, v, s) ACL_EH_##N = v,
 384          foreach_acl_eh
 385  #undef _
 386  } acl_eh_t;
 387
 388
 389
 390 extern acl_main_t acl_main;
 391 /*
 392  * pointer to the above.
 393  * Needed for some gymnastics to be able to provide
 394  * the inline functions from this plugin to other plugins.
 395  */
 396
 397 extern acl_main_t *p_acl_main;
 398
 399 void *acl_plugin_set_heap();
 400
 401
 402 #endif