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 "bihash_40_8.h"
  28 #include "fa_node.h"
  29
  30 #define  ACL_PLUGIN_VERSION_MAJOR 1
  31 #define  ACL_PLUGIN_VERSION_MINOR 2
  32
  33 extern vlib_node_registration_t acl_in_node;
  34 extern vlib_node_registration_t acl_out_node;
  35
  36 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);
  37 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);
  38
  39 enum acl_timeout_e {
  40   ACL_TIMEOUT_UDP_IDLE = 0,
  41   ACL_TIMEOUT_TCP_IDLE,
  42   ACL_TIMEOUT_TCP_TRANSIENT,
  43   ACL_N_TIMEOUTS
  44 };
  45
  46
  47 enum address_e { IP4, IP6 };
  48 typedef struct
  49 {
  50   enum address_e type;
  51   union {
  52     ip6_address_t ip6;
  53     ip4_address_t ip4;
  54   } addr;
  55 } address_t;
  56
  57 /*
  58  * ACL rules
  59  */
  60 typedef struct
  61 {
  62   u8 is_permit;
  63   u8 is_ipv6;
  64   ip46_address_t src;
  65   u8 src_prefixlen;
  66   ip46_address_t dst;
  67   u8 dst_prefixlen;
  68   u8 proto;
  69   u16 src_port_or_type_first;
  70   u16 src_port_or_type_last;
  71   u16 dst_port_or_code_first;
  72   u16 dst_port_or_code_last;
  73   u8 tcp_flags_value;
  74   u8 tcp_flags_mask;
  75 } acl_rule_t;
  76
  77 typedef struct
  78 {
  79   u8 is_permit;
  80   u8 is_ipv6;
  81   u8 src_mac[6];
  82   u8 src_mac_mask[6];
  83   ip46_address_t src_ip_addr;
  84   u8 src_prefixlen;
  85 } macip_acl_rule_t;
  86
  87 /*
  88  * ACL
  89  */
  90 typedef struct
  91 {
  92   u8 tag[64];
  93   u32 count;
  94   acl_rule_t *rules;
  95 } acl_list_t;
  96
  97 typedef struct
  98 {
  99   u8 tag[64];
 100   u32 count;
 101   macip_acl_rule_t *rules;
 102   /* References to the classifier tables that will enforce the rules */
 103   u32 ip4_table_index;
 104   u32 ip6_table_index;
 105   u32 l2_table_index;
 106 } macip_acl_list_t;
 107
 108 typedef struct {
 109   /* API message ID base */
 110   u16 msg_id_base;
 111
 112   acl_list_t *acls;     /* Pool of ACLs */
 113   macip_acl_list_t *macip_acls; /* Pool of MAC-IP ACLs */
 114
 115   /* ACLs associated with interfaces */
 116   u32 **input_acl_vec_by_sw_if_index;
 117   u32 **output_acl_vec_by_sw_if_index;
 118
 119   /*
 120    * Classify tables used to grab the packets for the ACL check,
 121    * and serving as the 5-tuple session tables at the same time
 122    */
 123   u32 *acl_ip4_input_classify_table_by_sw_if_index;
 124   u32 *acl_ip6_input_classify_table_by_sw_if_index;
 125   u32 *acl_ip4_output_classify_table_by_sw_if_index;
 126   u32 *acl_ip6_output_classify_table_by_sw_if_index;
 127
 128   /* MACIP (input) ACLs associated with the interfaces */
 129   u32 *macip_acl_by_sw_if_index;
 130
 131   /* next indices for our nodes in the l2-classify tables */
 132   u32 l2_input_classify_next_acl_old;
 133   u32 l2_output_classify_next_acl_old;
 134
 135   /* next node indices for feature bitmap */
 136   u32 acl_in_node_feat_next_node_index[32];
 137   u32 acl_out_node_feat_next_node_index[32];
 138
 139   /* ACL match actions (must be coherent across in/out ACLs to next indices (can differ) */
 140
 141   u32 acl_in_ip4_match_next[256];
 142   u32 acl_in_ip6_match_next[256];
 143   u32 acl_out_ip4_match_next[256];
 144   u32 acl_out_ip6_match_next[256];
 145   u32 n_match_actions;
 146
 147   /* bitmaps when set the processing is enabled on the interface */
 148   uword *fa_in_acl_on_sw_if_index;
 149   uword *fa_out_acl_on_sw_if_index;
 150   /* bitmap, when set the hash is initialized */
 151   uword *fa_sessions_on_sw_if_index;
 152   clib_bihash_40_8_t *fa_sessions_by_sw_if_index;
 153   /* pool for FA session data. See fa_node.h */
 154   fa_session_t *fa_sessions_pool;
 155   /* The process node which is responsible to deleting the sessions */
 156   u32 fa_cleaner_node_index;
 157   /* FA session timeouts, in seconds */
 158   u32 session_timeout_sec[ACL_N_TIMEOUTS];
 159   /* session add/delete counters */
 160   u64 *fa_session_adds_by_sw_if_index;
 161   u64 *fa_session_dels_by_sw_if_index;
 162
 163   /* L2 datapath glue */
 164
 165   /* active next indices within L2 classifiers - switch old/new path */
 166   u32 l2_input_classify_next_acl_ip4;
 167   u32 l2_input_classify_next_acl_ip6;
 168   u32 l2_output_classify_next_acl_ip4;
 169   u32 l2_output_classify_next_acl_ip6;
 170   /* saved next indices within L2 classifiers for ip4/ip6 fa L2 nodes */
 171   u32 fa_l2_input_classify_next_acl_ip4;
 172   u32 fa_l2_input_classify_next_acl_ip6;
 173   u32 fa_l2_output_classify_next_acl_ip4;
 174   u32 fa_l2_output_classify_next_acl_ip6;
 175   /* next node indices for L2 dispatch */
 176   u32 fa_acl_in_ip4_l2_node_feat_next_node_index[32];
 177   u32 fa_acl_in_ip6_l2_node_feat_next_node_index[32];
 178   u32 fa_acl_out_ip4_l2_node_feat_next_node_index[32];
 179   u32 fa_acl_out_ip6_l2_node_feat_next_node_index[32];
 180
 181   /* EH values that we can skip over */
 182   uword *fa_ipv6_known_eh_bitmap;
 183
 184   /* conn table per-interface conn table parameters */
 185   u32 fa_conn_table_hash_num_buckets;
 186   uword fa_conn_table_hash_memory_size;
 187   u64 fa_conn_table_max_entries;
 188
 189   /*
 190    * If the cleaner has to delete more than this number
 191    * of connections, it halves the sleep time.
 192    */
 193
 194 #define ACL_FA_DEFAULT_MAX_DELETED_SESSIONS_PER_INTERVAL 100
 195   u64 fa_max_deleted_sessions_per_interval;
 196
 197   /*
 198    * If the cleaner deletes less than these connections,
 199    * it increases the wait time by the "increment"
 200    */
 201
 202 #define ACL_FA_DEFAULT_MIN_DELETED_SESSIONS_PER_INTERVAL 1
 203   u64 fa_min_deleted_sessions_per_interval;
 204
 205 #define ACL_FA_DEFAULT_CLEANER_WAIT_TIME_INCREMENT 0.1
 206   f64 fa_cleaner_wait_time_increment;
 207
 208   u64 fa_current_cleaner_timer_wait_interval;
 209   u32 fa_conn_list_head[ACL_N_TIMEOUTS];
 210   u32 fa_conn_list_tail[ACL_N_TIMEOUTS];
 211
 212   /* Counters for the cleaner thread */
 213
 214 #define foreach_fa_cleaner_counter                                         \
 215   _(fa_cleaner_cnt_delete_by_sw_index, "delete_by_sw_index events")        \
 216   _(fa_cleaner_cnt_delete_by_sw_index_ok, "delete_by_sw_index handled ok") \
 217   _(fa_cleaner_cnt_unknown_event, "unknown events received")               \
 218   _(fa_cleaner_cnt_deleted_sessions, "sessions deleted")                   \
 219   _(fa_cleaner_cnt_timer_restarted, "session idle timers restarted")       \
 220   _(fa_cleaner_cnt_wait_with_timeout, "event wait with timeout called")    \
 221   _(fa_cleaner_cnt_wait_without_timeout, "event wait w/o timeout called")  \
 222   _(fa_cleaner_cnt_event_cycles, "total event cycles")                     \
 223   _(fa_cleaner_cnt_already_deleted, "try to delete already deleted conn")  \
 224 /* end of counters */
 225 #define _(id, desc) u32 id;
 226   foreach_fa_cleaner_counter
 227 #undef _
 228
 229   /* convenience */
 230   vlib_main_t * vlib_main;
 231   vnet_main_t * vnet_main;
 232 } acl_main_t;
 233
 234 #define foreach_acl_eh                                          \
 235    _(HOPBYHOP , 0  , "IPv6ExtHdrHopByHop")                      \
 236    _(ROUTING  , 43 , "IPv6ExtHdrRouting")                       \
 237    _(DESTOPT  , 60 , "IPv6ExtHdrDestOpt")                       \
 238    _(MOBILITY , 135, "Mobility Header")                         \
 239    _(HIP      , 139, "Experimental use Host Identity Protocol") \
 240    _(SHIM6    , 140, "Shim6 Protocol")                          \
 241    _(EXP1     , 253, "Use for experimentation and testing")     \
 242    _(EXP2     , 254, "Use for experimentation and testing")
 243
 244 /*
 245
 246  "No Next Header" is not a header.
 247  Also, Fragment header needs special processing.
 248
 249    _(NONEXT   , 59 , "NoNextHdr")                               \
 250    _(FRAGMENT , 44 , "IPv6ExtHdrFragment")                      \
 251
 252
 253 ESP is hiding its internal format, so no point in trying to go past it.
 254
 255    _(ESP      , 50 , "EncapsulatingSecurityPayload")            \
 256
 257
 258 AH has a special treatment of its length, it is in 32-bit words, not 64-bit words like the rest.
 259
 260    _(AUTH     , 51 , "Authentication Header")                   \
 261
 262
 263 */
 264
 265
 266  typedef enum {
 267  #define _(N, v, s) ACL_EH_##N = v,
 268          foreach_acl_eh
 269  #undef _
 270  } acl_eh_t;
 271
 272
 273
 274 extern acl_main_t acl_main;
 275
 276
 277 #endif