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