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 "bihash_40_8.h"
30 #define ACL_PLUGIN_VERSION_MAJOR 1
31 #define ACL_PLUGIN_VERSION_MINOR 2
33 extern vlib_node_registration_t acl_in_node;
34 extern vlib_node_registration_t acl_out_node;
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);
40 ACL_TIMEOUT_UDP_IDLE = 0,
42 ACL_TIMEOUT_TCP_TRANSIENT,
47 enum address_e { IP4, IP6 };
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;
83 ip46_address_t src_ip_addr;
101 macip_acl_rule_t *rules;
102 /* References to the classifier tables that will enforce the rules */
109 /* API message ID base */
112 acl_list_t *acls; /* Pool of ACLs */
113 macip_acl_list_t *macip_acls; /* Pool of MAC-IP ACLs */
115 /* ACLs associated with interfaces */
116 u32 **input_acl_vec_by_sw_if_index;
117 u32 **output_acl_vec_by_sw_if_index;
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
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;
128 /* MACIP (input) ACLs associated with the interfaces */
129 u32 *macip_acl_by_sw_if_index;
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;
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];
139 /* ACL match actions (must be coherent across in/out ACLs to next indices (can differ) */
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];
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;
163 /* L2 datapath glue */
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];
181 /* EH values that we can skip over */
182 uword *fa_ipv6_known_eh_bitmap;
184 /* whether to match L4 ACEs with ports on the non-initial fragment */
185 int l4_match_nonfirst_fragment;
187 /* conn table per-interface conn table parameters */
188 u32 fa_conn_table_hash_num_buckets;
189 uword fa_conn_table_hash_memory_size;
190 u64 fa_conn_table_max_entries;
193 * If the cleaner has to delete more than this number
194 * of connections, it halves the sleep time.
197 #define ACL_FA_DEFAULT_MAX_DELETED_SESSIONS_PER_INTERVAL 100
198 u64 fa_max_deleted_sessions_per_interval;
201 * If the cleaner deletes less than these connections,
202 * it increases the wait time by the "increment"
205 #define ACL_FA_DEFAULT_MIN_DELETED_SESSIONS_PER_INTERVAL 1
206 u64 fa_min_deleted_sessions_per_interval;
208 #define ACL_FA_DEFAULT_CLEANER_WAIT_TIME_INCREMENT 0.1
209 f64 fa_cleaner_wait_time_increment;
211 u64 fa_current_cleaner_timer_wait_interval;
212 u32 fa_conn_list_head[ACL_N_TIMEOUTS];
213 u32 fa_conn_list_tail[ACL_N_TIMEOUTS];
215 /* Counters for the cleaner thread */
217 #define foreach_fa_cleaner_counter \
218 _(fa_cleaner_cnt_delete_by_sw_index, "delete_by_sw_index events") \
219 _(fa_cleaner_cnt_delete_by_sw_index_ok, "delete_by_sw_index handled ok") \
220 _(fa_cleaner_cnt_unknown_event, "unknown events received") \
221 _(fa_cleaner_cnt_deleted_sessions, "sessions deleted") \
222 _(fa_cleaner_cnt_timer_restarted, "session idle timers restarted") \
223 _(fa_cleaner_cnt_wait_with_timeout, "event wait with timeout called") \
224 _(fa_cleaner_cnt_wait_without_timeout, "event wait w/o timeout called") \
225 _(fa_cleaner_cnt_event_cycles, "total event cycles") \
226 _(fa_cleaner_cnt_already_deleted, "try to delete already deleted conn") \
227 /* end of counters */
228 #define _(id, desc) u32 id;
229 foreach_fa_cleaner_counter
233 vlib_main_t * vlib_main;
234 vnet_main_t * vnet_main;
237 #define foreach_acl_eh \
238 _(HOPBYHOP , 0 , "IPv6ExtHdrHopByHop") \
239 _(ROUTING , 43 , "IPv6ExtHdrRouting") \
240 _(DESTOPT , 60 , "IPv6ExtHdrDestOpt") \
241 _(FRAGMENT , 44 , "IPv6ExtHdrFragment") \
242 _(MOBILITY , 135, "Mobility Header") \
243 _(HIP , 139, "Experimental use Host Identity Protocol") \
244 _(SHIM6 , 140, "Shim6 Protocol") \
245 _(EXP1 , 253, "Use for experimentation and testing") \
246 _(EXP2 , 254, "Use for experimentation and testing")
250 "No Next Header" is not a header.
251 Also, Fragment header needs special processing.
253 _(NONEXT , 59 , "NoNextHdr") \
256 ESP is hiding its internal format, so no point in trying to go past it.
258 _(ESP , 50 , "EncapsulatingSecurityPayload") \
261 AH has a special treatment of its length, it is in 32-bit words, not 64-bit words like the rest.
263 _(AUTH , 51 , "Authentication Header") \
270 #define _(N, v, s) ACL_EH_##N = v,
277 extern acl_main_t acl_main;