3 * nat.h - NAT plugin definitions
5 * Copyright (c) 2016 Cisco and/or its affiliates.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 #ifndef __included_nat_h__
19 #define __included_nat_h__
21 #include <vnet/vnet.h>
22 #include <vnet/ip/ip.h>
23 #include <vnet/ethernet/ethernet.h>
24 #include <vnet/ip/icmp46_packet.h>
25 #include <vnet/api_errno.h>
26 #include <vppinfra/bihash_8_8.h>
27 #include <vppinfra/bihash_16_8.h>
28 #include <vppinfra/dlist.h>
29 #include <vppinfra/error.h>
30 #include <vlibapi/api.h>
33 #define SNAT_UDP_TIMEOUT 300
34 #define SNAT_UDP_TIMEOUT_MIN 120
35 #define SNAT_TCP_TRANSITORY_TIMEOUT 240
36 #define SNAT_TCP_ESTABLISHED_TIMEOUT 7440
37 #define SNAT_TCP_INCOMING_SYN 6
38 #define SNAT_ICMP_TIMEOUT 60
40 #define SNAT_FLAG_HAIRPINNING (1 << 0)
78 ip4_address_t ext_host_addr;
99 #define foreach_snat_protocol \
100 _(UDP, 0, udp, "udp") \
101 _(TCP, 1, tcp, "tcp") \
102 _(ICMP, 2, icmp, "icmp")
105 #define _(N, i, n, s) SNAT_PROTOCOL_##N = i,
106 foreach_snat_protocol
111 #define foreach_snat_session_state \
112 _(0, UNKNOWN, "unknown") \
113 _(1, UDP_ACTIVE, "udp-active") \
114 _(2, TCP_SYN_SENT, "tcp-syn-sent") \
115 _(3, TCP_ESTABLISHED, "tcp-established") \
116 _(4, TCP_FIN_WAIT, "tcp-fin-wait") \
117 _(5, TCP_CLOSE_WAIT, "tcp-close-wait") \
118 _(6, TCP_LAST_ACK, "tcp-last-ack") \
119 _(7, ICMP_ACTIVE, "icmp-active")
122 #define _(v, N, s) SNAT_SESSION_##N = v,
123 foreach_snat_session_state
125 } snat_session_state_t;
128 #define SNAT_SESSION_FLAG_STATIC_MAPPING 1
129 #define SNAT_SESSION_FLAG_UNKNOWN_PROTO 2
130 #define SNAT_SESSION_FLAG_LOAD_BALANCING 4
132 typedef CLIB_PACKED(struct {
133 snat_session_key_t out2in; /* 0-15 */
135 snat_session_key_t in2out; /* 16-31 */
137 u32 flags; /* 32-35 */
139 /* per-user translations */
140 u32 per_user_index; /* 36-39 */
142 u32 per_user_list_head_index; /* 40-43 */
144 /* Last heard timer */
145 f64 last_heard; /* 44-51 */
147 u64 total_bytes; /* 52-59 */
149 u32 total_pkts; /* 60-63 */
151 /* Outside address */
152 u32 outside_address_index; /* 64-67 */
154 /* External host address */
155 ip4_address_t ext_host_addr; /* 68-71 */
163 u32 sessions_per_user_list_head_index;
171 #define _(N, i, n, s) \
172 u16 busy_##n##_ports; \
173 u16 * busy_##n##_ports_per_thread; \
174 uword * busy_##n##_port_bitmap;
175 foreach_snat_protocol
181 snat_det_out_key_t out;
184 } snat_det_session_t;
187 ip4_address_t in_addr;
189 ip4_address_t out_addr;
194 /* vector of sessions */
195 snat_det_session_t * sessions;
203 } nat44_lb_addr_port_t;
206 ip4_address_t local_addr;
207 ip4_address_t external_addr;
213 snat_protocol_t proto;
215 nat44_lb_addr_port_t *locals;
216 } snat_static_mapping_t;
224 ip4_address_t l_addr;
229 snat_protocol_t proto;
232 } snat_static_map_resolve_t;
235 /* Main lookup tables */
236 clib_bihash_8_8_t out2in;
237 clib_bihash_8_8_t in2out;
239 /* Find-a-user => src address lookup */
240 clib_bihash_8_8_t user_hash;
246 snat_session_t * sessions;
248 /* Pool of doubly-linked list elements */
249 dlist_elt_t * list_pool;
251 u32 snat_thread_index;
252 } snat_main_per_thread_data_t;
256 typedef u32 snat_icmp_match_function_t (struct snat_main_s *sm,
257 vlib_node_runtime_t *node,
262 snat_session_key_t *p_value,
263 u8 *p_dont_translate,
267 typedef u32 (snat_get_worker_function_t) (ip4_header_t * ip, u32 rx_fib_index);
269 typedef struct snat_main_s {
270 /* Endpoint address dependent sessions lookup tables */
271 clib_bihash_16_8_t out2in_ed;
272 clib_bihash_16_8_t in2out_ed;
274 snat_icmp_match_function_t * icmp_match_in2out_cb;
275 snat_icmp_match_function_t * icmp_match_out2in_cb;
278 u32 first_worker_index;
281 snat_get_worker_function_t * worker_in2out_cb;
282 snat_get_worker_function_t * worker_out2in_cb;
286 /* Per thread data */
287 snat_main_per_thread_data_t * per_thread_data;
289 /* Find a static mapping by local */
290 clib_bihash_8_8_t static_mapping_by_local;
292 /* Find a static mapping by external */
293 clib_bihash_8_8_t static_mapping_by_external;
295 /* Static mapping pool */
296 snat_static_mapping_t * static_mappings;
299 snat_interface_t * interfaces;
300 snat_interface_t * output_feature_interfaces;
302 /* Vector of outside addresses */
303 snat_address_t * addresses;
305 /* sw_if_indices whose intfc addresses should be auto-added */
306 u32 * auto_add_sw_if_indices;
308 /* vector of interface address static mappings to resolve. */
309 snat_static_map_resolve_t *to_resolve;
311 /* Randomize port allocation order */
314 /* Worker handoff index */
316 u32 fq_in2out_output_index;
319 /* in2out and out2in node index */
320 u32 in2out_node_index;
321 u32 in2out_output_node_index;
322 u32 out2in_node_index;
324 /* Deterministic NAT */
325 snat_det_map_t * det_maps;
327 /* Config parameters */
328 u8 static_mapping_only;
329 u8 static_mapping_connection_tracking;
331 u32 translation_buckets;
332 u32 translation_memory_size;
333 u32 max_translations;
335 u32 user_memory_size;
336 u32 max_translations_per_user;
338 u32 outside_fib_index;
340 u32 inside_fib_index;
342 /* tenant VRF aware address pool activation flag */
345 /* values of various timeouts */
347 u32 tcp_established_timeout;
348 u32 tcp_transitory_timeout;
351 /* API message ID base */
355 vlib_main_t * vlib_main;
356 vnet_main_t * vnet_main;
357 ip4_main_t * ip4_main;
358 ip_lookup_main_t * ip4_lookup_main;
359 api_main_t * api_main;
362 extern snat_main_t snat_main;
363 extern vlib_node_registration_t snat_in2out_node;
364 extern vlib_node_registration_t snat_in2out_output_node;
365 extern vlib_node_registration_t snat_out2in_node;
366 extern vlib_node_registration_t snat_in2out_fast_node;
367 extern vlib_node_registration_t snat_out2in_fast_node;
368 extern vlib_node_registration_t snat_in2out_worker_handoff_node;
369 extern vlib_node_registration_t snat_in2out_output_worker_handoff_node;
370 extern vlib_node_registration_t snat_out2in_worker_handoff_node;
371 extern vlib_node_registration_t snat_det_in2out_node;
372 extern vlib_node_registration_t snat_det_out2in_node;
373 extern vlib_node_registration_t snat_hairpin_dst_node;
374 extern vlib_node_registration_t snat_hairpin_src_node;
376 void snat_free_outside_address_and_port (snat_main_t * sm,
378 snat_session_key_t * k,
381 int snat_alloc_outside_address_and_port (snat_main_t * sm,
384 snat_session_key_t * k,
385 u32 * address_indexp);
387 int snat_static_mapping_match (snat_main_t * sm,
388 snat_session_key_t match,
389 snat_session_key_t * mapping,
393 void snat_add_del_addr_to_fib (ip4_address_t * addr,
398 format_function_t format_snat_user;
401 u32 cached_sw_if_index;
402 u32 cached_ip4_address;
405 /** \brief Check if SNAT session is created from static mapping.
406 @param s SNAT session
407 @return 1 if SNAT session is created from static mapping otherwise 0
409 #define snat_is_session_static(s) s->flags & SNAT_SESSION_FLAG_STATIC_MAPPING
411 /** \brief Check if SNAT session for unknown protocol.
412 @param s SNAT session
413 @return 1 if SNAT session for unknown protocol otherwise 0
415 #define snat_is_unk_proto_session(s) s->flags & SNAT_SESSION_FLAG_UNKNOWN_PROTO
418 * Why is this here? Because we don't need to touch this layer to
419 * simply reply to an icmp. We need to change id to a unique
420 * value to NAT an echo request/reply.
426 } icmp_echo_header_t;
429 ip_proto_to_snat_proto (u8 ip_proto)
433 snat_proto = (ip_proto == IP_PROTOCOL_UDP) ? SNAT_PROTOCOL_UDP : snat_proto;
434 snat_proto = (ip_proto == IP_PROTOCOL_TCP) ? SNAT_PROTOCOL_TCP : snat_proto;
435 snat_proto = (ip_proto == IP_PROTOCOL_ICMP) ? SNAT_PROTOCOL_ICMP : snat_proto;
436 snat_proto = (ip_proto == IP_PROTOCOL_ICMP6) ? SNAT_PROTOCOL_ICMP : snat_proto;
442 snat_proto_to_ip_proto (snat_protocol_t snat_proto)
446 ip_proto = (snat_proto == SNAT_PROTOCOL_UDP) ? IP_PROTOCOL_UDP : ip_proto;
447 ip_proto = (snat_proto == SNAT_PROTOCOL_TCP) ? IP_PROTOCOL_TCP : ip_proto;
448 ip_proto = (snat_proto == SNAT_PROTOCOL_ICMP) ? IP_PROTOCOL_ICMP : ip_proto;
454 u16 src_port, dst_port;
457 u32 icmp_match_in2out_fast(snat_main_t *sm, vlib_node_runtime_t *node,
458 u32 thread_index, vlib_buffer_t *b0,
459 ip4_header_t *ip0, u8 *p_proto,
460 snat_session_key_t *p_value,
461 u8 *p_dont_translate, void *d, void *e);
462 u32 icmp_match_in2out_slow(snat_main_t *sm, vlib_node_runtime_t *node,
463 u32 thread_index, vlib_buffer_t *b0,
464 ip4_header_t *ip0, u8 *p_proto,
465 snat_session_key_t *p_value,
466 u8 *p_dont_translate, void *d, void *e);
467 u32 icmp_match_in2out_det(snat_main_t *sm, vlib_node_runtime_t *node,
468 u32 thread_index, vlib_buffer_t *b0,
469 ip4_header_t *ip0, u8 *p_proto,
470 snat_session_key_t *p_value,
471 u8 *p_dont_translate, void *d, void *e);
472 u32 icmp_match_out2in_fast(snat_main_t *sm, vlib_node_runtime_t *node,
473 u32 thread_index, vlib_buffer_t *b0,
474 ip4_header_t *ip0, u8 *p_proto,
475 snat_session_key_t *p_value,
476 u8 *p_dont_translate, void *d, void *e);
477 u32 icmp_match_out2in_slow(snat_main_t *sm, vlib_node_runtime_t *node,
478 u32 thread_index, vlib_buffer_t *b0,
479 ip4_header_t *ip0, u8 *p_proto,
480 snat_session_key_t *p_value,
481 u8 *p_dont_translate, void *d, void *e);
482 u32 icmp_match_out2in_det(snat_main_t *sm, vlib_node_runtime_t *node,
483 u32 thread_index, vlib_buffer_t *b0,
484 ip4_header_t *ip0, u8 *p_proto,
485 snat_session_key_t *p_value,
486 u8 *p_dont_translate, void *d, void *e);
487 void increment_v4_address(ip4_address_t * a);
488 void snat_add_address(snat_main_t *sm, ip4_address_t *addr, u32 vrf_id);
489 int snat_del_address(snat_main_t *sm, ip4_address_t addr, u8 delete_sm);
490 int snat_add_static_mapping(ip4_address_t l_addr, ip4_address_t e_addr,
491 u16 l_port, u16 e_port, u32 vrf_id, int addr_only,
492 u32 sw_if_index, snat_protocol_t proto, int is_add);
493 clib_error_t * snat_api_init(vlib_main_t * vm, snat_main_t * sm);
494 int snat_set_workers (uword * bitmap);
495 int snat_interface_add_del(u32 sw_if_index, u8 is_inside, int is_del);
496 int snat_interface_add_del_output_feature(u32 sw_if_index, u8 is_inside,
498 int snat_add_interface_address(snat_main_t *sm, u32 sw_if_index, int is_del);
499 uword unformat_snat_protocol(unformat_input_t * input, va_list * args);
500 u8 * format_snat_protocol(u8 * s, va_list * args);
501 int nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
502 snat_protocol_t proto, u32 vrf_id,
503 nat44_lb_addr_port_t *locals, u8 is_add);
505 static_always_inline u8
506 icmp_is_error_message (icmp46_header_t * icmp)
510 case ICMP4_destination_unreachable:
511 case ICMP4_time_exceeded:
512 case ICMP4_parameter_problem:
513 case ICMP4_source_quench:
515 case ICMP4_alternate_host_address:
521 static_always_inline u8
522 is_interface_addr(snat_main_t *sm, vlib_node_runtime_t *node, u32 sw_if_index0,
525 snat_runtime_t *rt = (snat_runtime_t *) node->runtime_data;
526 ip4_address_t * first_int_addr;
528 if (PREDICT_FALSE(rt->cached_sw_if_index != sw_if_index0))
531 ip4_interface_first_address (sm->ip4_main, sw_if_index0,
532 0 /* just want the address */);
533 rt->cached_sw_if_index = sw_if_index0;
535 rt->cached_ip4_address = first_int_addr->as_u32;
537 rt->cached_ip4_address = 0;
540 if (PREDICT_FALSE(ip4_addr == rt->cached_ip4_address))
547 maximum_sessions_exceeded (snat_main_t *sm, u32 thread_index)
549 if (pool_elts (sm->per_thread_data[thread_index].sessions) >= sm->max_translations)
555 #endif /* __included_nat_h__ */