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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
15 #ifndef included_acl_h
16 #define included_acl_h
18 #include <vnet/vnet.h>
19 #include <vnet/ip/ip.h>
20 #include <vnet/l2/l2_output.h>
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 "bihash_40_8.h"
30 #include "hash_lookup_types.h"
32 #define ACL_PLUGIN_VERSION_MAJOR 1
33 #define ACL_PLUGIN_VERSION_MINOR 3
35 #define UDP_SESSION_IDLE_TIMEOUT_SEC 600
36 #define TCP_SESSION_IDLE_TIMEOUT_SEC (3600*24)
37 #define TCP_SESSION_TRANSIENT_TIMEOUT_SEC 120
39 extern vlib_node_registration_t acl_in_node;
40 extern vlib_node_registration_t acl_out_node;
42 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);
43 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);
46 ACL_TIMEOUT_UDP_IDLE = 0,
48 ACL_TIMEOUT_TCP_TRANSIENT,
53 enum address_e { IP4, IP6 };
75 u16 src_port_or_type_first;
76 u16 src_port_or_type_last;
77 u16 dst_port_or_code_first;
78 u16 dst_port_or_code_last;
89 ip46_address_t src_ip_addr;
107 macip_acl_rule_t *rules;
108 /* References to the classifier tables that will enforce the rules */
115 * An element describing a particular configuration fo the mask,
116 * and how many times it has been used.
122 } ace_mask_type_entry_t;
125 /* mheap to hold all the ACL module related allocations, other than hash */
128 /* API message ID base */
131 acl_list_t *acls; /* Pool of ACLs */
132 hash_acl_info_t *hash_acl_infos; /* corresponding hash matching housekeeping info */
133 clib_bihash_48_8_t acl_lookup_hash; /* ACL lookup hash table. */
135 /* mheap to hold all the miscellaneous allocations related to hash-based lookups */
136 void *hash_lookup_mheap;
137 int acl_lookup_hash_initialized;
138 applied_hash_ace_entry_t **input_hash_entry_vec_by_sw_if_index;
139 applied_hash_ace_entry_t **output_hash_entry_vec_by_sw_if_index;
140 applied_hash_acl_info_t *input_applied_hash_acl_info_by_sw_if_index;
141 applied_hash_acl_info_t *output_applied_hash_acl_info_by_sw_if_index;
143 macip_acl_list_t *macip_acls; /* Pool of MAC-IP ACLs */
145 /* ACLs associated with interfaces */
146 u32 **input_acl_vec_by_sw_if_index;
147 u32 **output_acl_vec_by_sw_if_index;
149 /* interfaces on which given ACLs are applied */
150 u32 **input_sw_if_index_vec_by_acl;
151 u32 **output_sw_if_index_vec_by_acl;
153 /* Total count of interface+direction pairs enabled */
154 u32 fa_total_enabled_count;
156 /* Do we use hash-based ACL matching or linear */
157 int use_hash_acl_matching;
159 /* a pool of all mask types present in all ACEs */
160 ace_mask_type_entry_t *ace_mask_type_pool;
163 * Classify tables used to grab the packets for the ACL check,
164 * and serving as the 5-tuple session tables at the same time
166 u32 *acl_ip4_input_classify_table_by_sw_if_index;
167 u32 *acl_ip6_input_classify_table_by_sw_if_index;
168 u32 *acl_ip4_output_classify_table_by_sw_if_index;
169 u32 *acl_ip6_output_classify_table_by_sw_if_index;
171 /* MACIP (input) ACLs associated with the interfaces */
172 u32 *macip_acl_by_sw_if_index;
174 /* bitmaps when set the processing is enabled on the interface */
175 uword *fa_in_acl_on_sw_if_index;
176 uword *fa_out_acl_on_sw_if_index;
177 /* bihash holding all of the sessions */
178 int fa_sessions_hash_is_initialized;
179 clib_bihash_40_8_t fa_sessions_hash;
180 /* The process node which orcherstrates the cleanup */
181 u32 fa_cleaner_node_index;
182 /* FA session timeouts, in seconds */
183 u32 session_timeout_sec[ACL_N_TIMEOUTS];
184 /* total session adds/dels */
185 u64 fa_session_total_adds;
186 u64 fa_session_total_dels;
188 /* L2 datapath glue */
190 /* next indices within L2 classifiers for ip4/ip6 fa L2 nodes */
191 u32 l2_input_classify_next_acl_ip4;
192 u32 l2_input_classify_next_acl_ip6;
193 u32 l2_output_classify_next_acl_ip4;
194 u32 l2_output_classify_next_acl_ip6;
195 /* next node indices for L2 dispatch */
196 u32 fa_acl_in_ip4_l2_node_feat_next_node_index[32];
197 u32 fa_acl_in_ip6_l2_node_feat_next_node_index[32];
198 u32 fa_acl_out_ip4_l2_node_feat_next_node_index[32];
199 u32 fa_acl_out_ip6_l2_node_feat_next_node_index[32];
201 /* EH values that we can skip over */
202 uword *fa_ipv6_known_eh_bitmap;
204 /* whether to match L4 ACEs with ports on the non-initial fragment */
205 int l4_match_nonfirst_fragment;
207 /* conn table per-interface conn table parameters */
208 u32 fa_conn_table_hash_num_buckets;
209 uword fa_conn_table_hash_memory_size;
210 u64 fa_conn_table_max_entries;
213 * If the cleaner has to delete more than this number
214 * of connections, it halves the sleep time.
217 #define ACL_FA_DEFAULT_MAX_DELETED_SESSIONS_PER_INTERVAL 100
218 u64 fa_max_deleted_sessions_per_interval;
221 * If the cleaner deletes less than these connections,
222 * it increases the wait time by the "increment"
225 #define ACL_FA_DEFAULT_MIN_DELETED_SESSIONS_PER_INTERVAL 1
226 u64 fa_min_deleted_sessions_per_interval;
228 #define ACL_FA_DEFAULT_CLEANER_WAIT_TIME_INCREMENT 0.1
229 f64 fa_cleaner_wait_time_increment;
231 u64 fa_current_cleaner_timer_wait_interval;
233 /* per-worker data related t conn management */
234 acl_fa_per_worker_data_t *per_worker_data;
236 /* Configured session timeout */
237 u64 session_timeout[ACL_N_TIMEOUTS];
240 /* Counters for the cleaner thread */
242 #define foreach_fa_cleaner_counter \
243 _(fa_cleaner_cnt_delete_by_sw_index, "delete_by_sw_index events") \
244 _(fa_cleaner_cnt_delete_by_sw_index_ok, "delete_by_sw_index handled ok") \
245 _(fa_cleaner_cnt_unknown_event, "unknown events received") \
246 _(fa_cleaner_cnt_timer_restarted, "session idle timers restarted") \
247 _(fa_cleaner_cnt_wait_with_timeout, "event wait with timeout called") \
248 _(fa_cleaner_cnt_wait_without_timeout, "event wait w/o timeout called") \
249 _(fa_cleaner_cnt_event_cycles, "total event cycles") \
250 /* end of counters */
251 #define _(id, desc) u32 id;
252 foreach_fa_cleaner_counter
256 vlib_main_t * vlib_main;
257 vnet_main_t * vnet_main;
260 #define foreach_acl_eh \
261 _(HOPBYHOP , 0 , "IPv6ExtHdrHopByHop") \
262 _(ROUTING , 43 , "IPv6ExtHdrRouting") \
263 _(DESTOPT , 60 , "IPv6ExtHdrDestOpt") \
264 _(FRAGMENT , 44 , "IPv6ExtHdrFragment") \
265 _(MOBILITY , 135, "Mobility Header") \
266 _(HIP , 139, "Experimental use Host Identity Protocol") \
267 _(SHIM6 , 140, "Shim6 Protocol") \
268 _(EXP1 , 253, "Use for experimentation and testing") \
269 _(EXP2 , 254, "Use for experimentation and testing")
273 "No Next Header" is not a header.
274 Also, Fragment header needs special processing.
276 _(NONEXT , 59 , "NoNextHdr") \
279 ESP is hiding its internal format, so no point in trying to go past it.
281 _(ESP , 50 , "EncapsulatingSecurityPayload") \
284 AH has a special treatment of its length, it is in 32-bit words, not 64-bit words like the rest.
286 _(AUTH , 51 , "Authentication Header") \
293 #define _(N, v, s) ACL_EH_##N = v,
300 extern acl_main_t acl_main;