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 3
33 #define UDP_SESSION_IDLE_TIMEOUT_SEC 600
34 #define TCP_SESSION_IDLE_TIMEOUT_SEC (3600*24)
35 #define TCP_SESSION_TRANSIENT_TIMEOUT_SEC 120
37 extern vlib_node_registration_t acl_in_node;
38 extern vlib_node_registration_t acl_out_node;
40 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);
41 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);
44 ACL_TIMEOUT_UDP_IDLE = 0,
46 ACL_TIMEOUT_TCP_TRANSIENT,
51 enum address_e { IP4, IP6 };
73 u16 src_port_or_type_first;
74 u16 src_port_or_type_last;
75 u16 dst_port_or_code_first;
76 u16 dst_port_or_code_last;
87 ip46_address_t src_ip_addr;
105 macip_acl_rule_t *rules;
106 /* References to the classifier tables that will enforce the rules */
113 /* API message ID base */
116 acl_list_t *acls; /* Pool of ACLs */
117 macip_acl_list_t *macip_acls; /* Pool of MAC-IP ACLs */
119 /* ACLs associated with interfaces */
120 u32 **input_acl_vec_by_sw_if_index;
121 u32 **output_acl_vec_by_sw_if_index;
124 * Classify tables used to grab the packets for the ACL check,
125 * and serving as the 5-tuple session tables at the same time
127 u32 *acl_ip4_input_classify_table_by_sw_if_index;
128 u32 *acl_ip6_input_classify_table_by_sw_if_index;
129 u32 *acl_ip4_output_classify_table_by_sw_if_index;
130 u32 *acl_ip6_output_classify_table_by_sw_if_index;
132 /* MACIP (input) ACLs associated with the interfaces */
133 u32 *macip_acl_by_sw_if_index;
135 /* bitmaps when set the processing is enabled on the interface */
136 uword *fa_in_acl_on_sw_if_index;
137 uword *fa_out_acl_on_sw_if_index;
138 /* bitmap, when set the hash is initialized */
139 uword *fa_sessions_on_sw_if_index;
140 clib_bihash_40_8_t *fa_sessions_by_sw_if_index;
141 /* The process node which orcherstrates the cleanup */
142 u32 fa_cleaner_node_index;
143 /* FA session timeouts, in seconds */
144 u32 session_timeout_sec[ACL_N_TIMEOUTS];
145 /* session add/delete counters */
146 u64 *fa_session_adds_by_sw_if_index;
147 u64 *fa_session_dels_by_sw_if_index;
149 /* L2 datapath glue */
151 /* next indices within L2 classifiers for ip4/ip6 fa L2 nodes */
152 u32 l2_input_classify_next_acl_ip4;
153 u32 l2_input_classify_next_acl_ip6;
154 u32 l2_output_classify_next_acl_ip4;
155 u32 l2_output_classify_next_acl_ip6;
156 /* next node indices for L2 dispatch */
157 u32 fa_acl_in_ip4_l2_node_feat_next_node_index[32];
158 u32 fa_acl_in_ip6_l2_node_feat_next_node_index[32];
159 u32 fa_acl_out_ip4_l2_node_feat_next_node_index[32];
160 u32 fa_acl_out_ip6_l2_node_feat_next_node_index[32];
162 /* EH values that we can skip over */
163 uword *fa_ipv6_known_eh_bitmap;
165 /* whether to match L4 ACEs with ports on the non-initial fragment */
166 int l4_match_nonfirst_fragment;
168 /* conn table per-interface conn table parameters */
169 u32 fa_conn_table_hash_num_buckets;
170 uword fa_conn_table_hash_memory_size;
171 u64 fa_conn_table_max_entries;
174 * If the cleaner has to delete more than this number
175 * of connections, it halves the sleep time.
178 #define ACL_FA_DEFAULT_MAX_DELETED_SESSIONS_PER_INTERVAL 100
179 u64 fa_max_deleted_sessions_per_interval;
182 * If the cleaner deletes less than these connections,
183 * it increases the wait time by the "increment"
186 #define ACL_FA_DEFAULT_MIN_DELETED_SESSIONS_PER_INTERVAL 1
187 u64 fa_min_deleted_sessions_per_interval;
189 #define ACL_FA_DEFAULT_CLEANER_WAIT_TIME_INCREMENT 0.1
190 f64 fa_cleaner_wait_time_increment;
192 u64 fa_current_cleaner_timer_wait_interval;
194 /* per-worker data related t conn management */
195 acl_fa_per_worker_data_t *per_worker_data;
197 /* Configured session timeout */
198 u64 session_timeout[ACL_N_TIMEOUTS];
201 /* Counters for the cleaner thread */
203 #define foreach_fa_cleaner_counter \
204 _(fa_cleaner_cnt_delete_by_sw_index, "delete_by_sw_index events") \
205 _(fa_cleaner_cnt_delete_by_sw_index_ok, "delete_by_sw_index handled ok") \
206 _(fa_cleaner_cnt_unknown_event, "unknown events received") \
207 _(fa_cleaner_cnt_timer_restarted, "session idle timers restarted") \
208 _(fa_cleaner_cnt_wait_with_timeout, "event wait with timeout called") \
209 _(fa_cleaner_cnt_wait_without_timeout, "event wait w/o timeout called") \
210 _(fa_cleaner_cnt_event_cycles, "total event cycles") \
211 /* end of counters */
212 #define _(id, desc) u32 id;
213 foreach_fa_cleaner_counter
217 vlib_main_t * vlib_main;
218 vnet_main_t * vnet_main;
221 #define foreach_acl_eh \
222 _(HOPBYHOP , 0 , "IPv6ExtHdrHopByHop") \
223 _(ROUTING , 43 , "IPv6ExtHdrRouting") \
224 _(DESTOPT , 60 , "IPv6ExtHdrDestOpt") \
225 _(FRAGMENT , 44 , "IPv6ExtHdrFragment") \
226 _(MOBILITY , 135, "Mobility Header") \
227 _(HIP , 139, "Experimental use Host Identity Protocol") \
228 _(SHIM6 , 140, "Shim6 Protocol") \
229 _(EXP1 , 253, "Use for experimentation and testing") \
230 _(EXP2 , 254, "Use for experimentation and testing")
234 "No Next Header" is not a header.
235 Also, Fragment header needs special processing.
237 _(NONEXT , 59 , "NoNextHdr") \
240 ESP is hiding its internal format, so no point in trying to go past it.
242 _(ESP , 50 , "EncapsulatingSecurityPayload") \
245 AH has a special treatment of its length, it is in 32-bit words, not 64-bit words like the rest.
247 _(AUTH , 51 , "Authentication Header") \
254 #define _(N, v, s) ACL_EH_##N = v,
261 extern acl_main_t acl_main;