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>
34 #define SNAT_UDP_TIMEOUT 300
35 #define SNAT_UDP_TIMEOUT_MIN 120
36 #define SNAT_TCP_TRANSITORY_TIMEOUT 240
37 #define SNAT_TCP_ESTABLISHED_TIMEOUT 7440
38 #define SNAT_TCP_INCOMING_SYN 6
39 #define SNAT_ICMP_TIMEOUT 60
41 #define NAT_FQ_NELTS 64
43 #define SNAT_FLAG_HAIRPINNING (1 << 0)
81 ip4_address_t ext_host_addr;
102 #define foreach_snat_protocol \
103 _(UDP, 0, udp, "udp") \
104 _(TCP, 1, tcp, "tcp") \
105 _(ICMP, 2, icmp, "icmp")
108 #define _(N, i, n, s) SNAT_PROTOCOL_##N = i,
109 foreach_snat_protocol
114 #define foreach_snat_session_state \
115 _(0, UNKNOWN, "unknown") \
116 _(1, UDP_ACTIVE, "udp-active") \
117 _(2, TCP_SYN_SENT, "tcp-syn-sent") \
118 _(3, TCP_ESTABLISHED, "tcp-established") \
119 _(4, TCP_FIN_WAIT, "tcp-fin-wait") \
120 _(5, TCP_CLOSE_WAIT, "tcp-close-wait") \
121 _(6, TCP_CLOSING, "tcp-closing") \
122 _(7, TCP_LAST_ACK, "tcp-last-ack") \
123 _(8, TCP_CLOSED, "tcp-closed") \
124 _(9, ICMP_ACTIVE, "icmp-active")
127 #define _(v, N, s) SNAT_SESSION_##N = v,
128 foreach_snat_session_state
130 } snat_session_state_t;
132 #define NAT44_SES_I2O_FIN 1
133 #define NAT44_SES_O2I_FIN 2
134 #define NAT44_SES_I2O_FIN_ACK 4
135 #define NAT44_SES_O2I_FIN_ACK 8
137 #define nat44_is_ses_closed(s) s->state == 0xf
139 #define SNAT_SESSION_FLAG_STATIC_MAPPING 1
140 #define SNAT_SESSION_FLAG_UNKNOWN_PROTO 2
141 #define SNAT_SESSION_FLAG_LOAD_BALANCING 4
142 #define SNAT_SESSION_FLAG_TWICE_NAT 8
143 #define SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT 16
144 #define SNAT_SESSION_FLAG_FWD_BYPASS 32
146 #define NAT_INTERFACE_FLAG_IS_INSIDE 1
147 #define NAT_INTERFACE_FLAG_IS_OUTSIDE 2
149 typedef CLIB_PACKED(struct {
150 snat_session_key_t out2in; /* 0-15 */
152 snat_session_key_t in2out; /* 16-31 */
154 u32 flags; /* 32-35 */
156 /* per-user translations */
157 u32 per_user_index; /* 36-39 */
159 u32 per_user_list_head_index; /* 40-43 */
161 /* Last heard timer */
162 f64 last_heard; /* 44-51 */
164 u64 total_bytes; /* 52-59 */
166 u32 total_pkts; /* 60-63 */
168 /* Outside address */
169 u32 outside_address_index; /* 64-67 */
171 /* External host address and port */
172 ip4_address_t ext_host_addr; /* 68-71 */
173 u16 ext_host_port; /* 72-73 */
175 /* External hos address and port after translation */
176 ip4_address_t ext_host_nat_addr; /* 74-77 */
177 u16 ext_host_nat_port; /* 78-79 */
179 /* TCP session state */
189 u32 sessions_per_user_list_head_index;
197 #define _(N, i, n, s) \
198 u16 busy_##n##_ports; \
199 u16 * busy_##n##_ports_per_thread; \
200 uword * busy_##n##_port_bitmap;
201 foreach_snat_protocol
207 snat_det_out_key_t out;
210 } snat_det_session_t;
213 ip4_address_t in_addr;
215 ip4_address_t out_addr;
220 /* vector of sessions */
221 snat_det_session_t * sessions;
229 } nat44_lb_addr_port_t;
238 ip4_address_t local_addr;
239 ip4_address_t external_addr;
243 twice_nat_type_t twice_nat;
247 snat_protocol_t proto;
250 nat44_lb_addr_port_t *locals;
251 } snat_static_mapping_t;
259 ip4_address_t l_addr;
264 snat_protocol_t proto;
269 } snat_static_map_resolve_t;
272 /* Main lookup tables */
273 clib_bihash_8_8_t out2in;
274 clib_bihash_8_8_t in2out;
276 /* Endpoint dependent sessions lookup tables */
277 clib_bihash_16_8_t out2in_ed;
278 clib_bihash_16_8_t in2out_ed;
280 /* Find-a-user => src address lookup */
281 clib_bihash_8_8_t user_hash;
287 snat_session_t * sessions;
289 /* Pool of doubly-linked list elements */
290 dlist_elt_t * list_pool;
292 u32 snat_thread_index;
293 } snat_main_per_thread_data_t;
297 typedef u32 snat_icmp_match_function_t (struct snat_main_s *sm,
298 vlib_node_runtime_t *node,
303 snat_session_key_t *p_value,
304 u8 *p_dont_translate,
308 typedef u32 (snat_get_worker_function_t) (ip4_header_t * ip, u32 rx_fib_index);
310 typedef int nat_alloc_out_addr_and_port_function_t (snat_address_t * addresses,
313 snat_session_key_t * k,
314 u32 * address_indexp,
316 u32 snat_thread_index);
318 typedef struct snat_main_s {
319 snat_icmp_match_function_t * icmp_match_in2out_cb;
320 snat_icmp_match_function_t * icmp_match_out2in_cb;
323 u32 first_worker_index;
325 snat_get_worker_function_t * worker_in2out_cb;
326 snat_get_worker_function_t * worker_out2in_cb;
330 /* Per thread data */
331 snat_main_per_thread_data_t * per_thread_data;
333 /* Find a static mapping by local */
334 clib_bihash_8_8_t static_mapping_by_local;
336 /* Find a static mapping by external */
337 clib_bihash_8_8_t static_mapping_by_external;
339 /* Static mapping pool */
340 snat_static_mapping_t * static_mappings;
343 snat_interface_t * interfaces;
344 snat_interface_t * output_feature_interfaces;
346 /* Vector of outside addresses */
347 snat_address_t * addresses;
348 nat_alloc_out_addr_and_port_function_t *alloc_addr_and_port;
353 /* Vector of twice NAT addresses for extenal hosts */
354 snat_address_t * twice_nat_addresses;
356 /* sw_if_indices whose intfc addresses should be auto-added */
357 u32 * auto_add_sw_if_indices;
358 u32 * auto_add_sw_if_indices_twice_nat;
360 /* vector of interface address static mappings to resolve. */
361 snat_static_map_resolve_t *to_resolve;
363 /* Randomize port allocation order */
366 /* Worker handoff index */
368 u32 fq_in2out_output_index;
371 /* in2out and out2in node index */
372 u32 in2out_node_index;
373 u32 in2out_output_node_index;
374 u32 out2in_node_index;
375 u32 error_node_index;
377 /* Deterministic NAT */
378 snat_det_map_t * det_maps;
380 /* If forwarding is enabled */
381 u8 forwarding_enabled;
383 /* Config parameters */
384 u8 static_mapping_only;
385 u8 static_mapping_connection_tracking;
388 u8 endpoint_dependent;
389 u32 translation_buckets;
390 u32 translation_memory_size;
391 u32 max_translations;
393 u32 user_memory_size;
394 u32 max_translations_per_user;
396 u32 outside_fib_index;
398 u32 inside_fib_index;
400 /* values of various timeouts */
402 u32 tcp_established_timeout;
403 u32 tcp_transitory_timeout;
406 /* API message ID base */
410 vlib_log_class_t log_class;
413 vlib_main_t * vlib_main;
414 vnet_main_t * vnet_main;
415 ip4_main_t * ip4_main;
416 ip_lookup_main_t * ip4_lookup_main;
417 api_main_t * api_main;
420 extern snat_main_t snat_main;
421 extern vlib_node_registration_t snat_in2out_node;
422 extern vlib_node_registration_t snat_in2out_output_node;
423 extern vlib_node_registration_t snat_out2in_node;
424 extern vlib_node_registration_t snat_in2out_fast_node;
425 extern vlib_node_registration_t snat_out2in_fast_node;
426 extern vlib_node_registration_t snat_in2out_worker_handoff_node;
427 extern vlib_node_registration_t snat_in2out_output_worker_handoff_node;
428 extern vlib_node_registration_t snat_out2in_worker_handoff_node;
429 extern vlib_node_registration_t snat_det_in2out_node;
430 extern vlib_node_registration_t snat_det_out2in_node;
431 extern vlib_node_registration_t snat_hairpin_dst_node;
432 extern vlib_node_registration_t snat_hairpin_src_node;
433 extern vlib_node_registration_t nat44_ed_in2out_node;
434 extern vlib_node_registration_t nat44_ed_in2out_output_node;
435 extern vlib_node_registration_t nat44_ed_out2in_node;
436 extern vlib_node_registration_t nat44_ed_hairpin_dst_node;
437 extern vlib_node_registration_t nat44_ed_hairpin_src_node;
438 extern vlib_node_registration_t nat44_ed_in2out_worker_handoff_node;
439 extern vlib_node_registration_t nat44_ed_in2out_output_worker_handoff_node;
440 extern vlib_node_registration_t nat44_ed_out2in_worker_handoff_node;
442 void snat_free_outside_address_and_port (snat_address_t * addresses,
444 snat_session_key_t * k,
447 int snat_alloc_outside_address_and_port (snat_address_t * addresses,
450 snat_session_key_t * k,
451 u32 * address_indexp,
453 u32 snat_thread_index);
455 int snat_static_mapping_match (snat_main_t * sm,
456 snat_session_key_t match,
457 snat_session_key_t * mapping,
460 twice_nat_type_t *twice_nat,
463 void snat_add_del_addr_to_fib (ip4_address_t * addr,
468 format_function_t format_snat_user;
469 format_function_t format_snat_static_mapping;
470 format_function_t format_snat_static_map_to_resolve;
471 format_function_t format_snat_session;
472 format_function_t format_det_map_ses;
475 u32 cached_sw_if_index;
476 u32 cached_ip4_address;
479 /** \brief Check if SNAT session is created from static mapping.
480 @param s SNAT session
481 @return 1 if SNAT session is created from static mapping otherwise 0
483 #define snat_is_session_static(s) (s->flags & SNAT_SESSION_FLAG_STATIC_MAPPING)
485 /** \brief Check if SNAT session for unknown protocol.
486 @param s SNAT session
487 @return 1 if SNAT session for unknown protocol otherwise 0
489 #define snat_is_unk_proto_session(s) (s->flags & SNAT_SESSION_FLAG_UNKNOWN_PROTO)
491 /** \brief Check if NAT session is twice NAT.
493 @return 1 if NAT session is twice NAT
495 #define is_twice_nat_session(s) (s->flags & SNAT_SESSION_FLAG_TWICE_NAT)
497 /** \brief Check if NAT session is load-balancing.
499 @return 1 if NAT session is load-balancing
501 #define is_lb_session(s) (s->flags & SNAT_SESSION_FLAG_LOAD_BALANCING)
503 /** \brief Check if NAT session is forwarding bypass.
505 @return 1 if NAT session is load-balancing
507 #define is_fwd_bypass_session(s) (s->flags & SNAT_SESSION_FLAG_FWD_BYPASS)
509 /** \brief Check if NAT session is endpoint dependent.
511 @return 1 if NAT session is endpoint dependent
513 #define is_ed_session(s) (s->flags & SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT)
515 #define nat_interface_is_inside(i) i->flags & NAT_INTERFACE_FLAG_IS_INSIDE
516 #define nat_interface_is_outside(i) i->flags & NAT_INTERFACE_FLAG_IS_OUTSIDE
518 #define nat_log_err(...) \
519 vlib_log(VLIB_LOG_LEVEL_ERR, snat_main.log_class, __VA_ARGS__)
520 #define nat_log_warn(...) \
521 vlib_log(VLIB_LOG_LEVEL_WARNING, snat_main.log_class, __VA_ARGS__)
522 #define nat_log_notice(...) \
523 vlib_log(VLIB_LOG_LEVEL_NOTICE, snat_main.log_class, __VA_ARGS__)
524 #define nat_log_info(...) \
525 vlib_log(VLIB_LOG_LEVEL_INFO, snat_main.log_class, __VA_ARGS__)
526 #define nat_log_debug(...)\
527 vlib_log(VLIB_LOG_LEVEL_DEBUG, snat_main.log_class, __VA_ARGS__)
530 * Why is this here? Because we don't need to touch this layer to
531 * simply reply to an icmp. We need to change id to a unique
532 * value to NAT an echo request/reply.
538 } icmp_echo_header_t;
541 u16 src_port, dst_port;
544 u32 icmp_match_in2out_fast(snat_main_t *sm, vlib_node_runtime_t *node,
545 u32 thread_index, vlib_buffer_t *b0,
546 ip4_header_t *ip0, u8 *p_proto,
547 snat_session_key_t *p_value,
548 u8 *p_dont_translate, void *d, void *e);
549 u32 icmp_match_in2out_slow(snat_main_t *sm, vlib_node_runtime_t *node,
550 u32 thread_index, vlib_buffer_t *b0,
551 ip4_header_t *ip0, u8 *p_proto,
552 snat_session_key_t *p_value,
553 u8 *p_dont_translate, void *d, void *e);
554 u32 icmp_match_in2out_det(snat_main_t *sm, vlib_node_runtime_t *node,
555 u32 thread_index, vlib_buffer_t *b0,
556 ip4_header_t *ip0, u8 *p_proto,
557 snat_session_key_t *p_value,
558 u8 *p_dont_translate, void *d, void *e);
559 u32 icmp_match_in2out_ed(snat_main_t *sm, vlib_node_runtime_t *node,
560 u32 thread_index, vlib_buffer_t *b0,
561 ip4_header_t *ip0, u8 *p_proto,
562 snat_session_key_t *p_value,
563 u8 *p_dont_translate, void *d, void *e);
564 u32 icmp_match_out2in_fast(snat_main_t *sm, vlib_node_runtime_t *node,
565 u32 thread_index, vlib_buffer_t *b0,
566 ip4_header_t *ip0, u8 *p_proto,
567 snat_session_key_t *p_value,
568 u8 *p_dont_translate, void *d, void *e);
569 u32 icmp_match_out2in_slow(snat_main_t *sm, vlib_node_runtime_t *node,
570 u32 thread_index, vlib_buffer_t *b0,
571 ip4_header_t *ip0, u8 *p_proto,
572 snat_session_key_t *p_value,
573 u8 *p_dont_translate, void *d, void *e);
574 u32 icmp_match_out2in_det(snat_main_t *sm, vlib_node_runtime_t *node,
575 u32 thread_index, vlib_buffer_t *b0,
576 ip4_header_t *ip0, u8 *p_proto,
577 snat_session_key_t *p_value,
578 u8 *p_dont_translate, void *d, void *e);
579 u32 icmp_match_out2in_ed(snat_main_t *sm, vlib_node_runtime_t *node,
580 u32 thread_index, vlib_buffer_t *b0,
581 ip4_header_t *ip0, u8 *p_proto,
582 snat_session_key_t *p_value,
583 u8 *p_dont_translate, void *d, void *e);
584 void increment_v4_address(ip4_address_t * a);
585 int snat_add_address(snat_main_t *sm, ip4_address_t *addr, u32 vrf_id,
587 int snat_del_address(snat_main_t *sm, ip4_address_t addr, u8 delete_sm,
589 void nat44_add_del_address_dpo (ip4_address_t addr, u8 is_add);
590 int snat_add_static_mapping(ip4_address_t l_addr, ip4_address_t e_addr,
591 u16 l_port, u16 e_port, u32 vrf_id, int addr_only,
592 u32 sw_if_index, snat_protocol_t proto, int is_add,
593 twice_nat_type_t twice_nat, u8 out2in_only,
595 clib_error_t * snat_api_init(vlib_main_t * vm, snat_main_t * sm);
596 int snat_set_workers (uword * bitmap);
597 int snat_interface_add_del(u32 sw_if_index, u8 is_inside, int is_del);
598 int snat_interface_add_del_output_feature(u32 sw_if_index, u8 is_inside,
600 int snat_add_interface_address(snat_main_t *sm, u32 sw_if_index, int is_del,
602 uword unformat_snat_protocol(unformat_input_t * input, va_list * args);
603 u8 * format_snat_protocol(u8 * s, va_list * args);
604 int nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
605 snat_protocol_t proto, u32 vrf_id,
606 nat44_lb_addr_port_t *locals, u8 is_add,
607 twice_nat_type_t twice_nat, u8 out2in_only,
609 int nat44_del_session (snat_main_t *sm, ip4_address_t *addr, u16 port,
610 snat_protocol_t proto, u32 vrf_id, int is_in);
611 int nat44_del_ed_session (snat_main_t *sm, ip4_address_t *addr, u16 port,
612 ip4_address_t *eh_addr, u16 eh_port, u8 proto,
613 u32 vrf_id, int is_in);
614 void nat_free_session_data (snat_main_t * sm, snat_session_t * s,
616 snat_user_t * nat_user_get_or_create (snat_main_t *sm, ip4_address_t *addr,
617 u32 fib_index, u32 thread_index);
618 snat_session_t * nat_session_alloc_or_recycle (snat_main_t *sm, snat_user_t *u,
620 void nat_set_alloc_addr_and_port_mape (u16 psid, u16 psid_offset,
622 void nat_set_alloc_addr_and_port_default (void);
624 #endif /* __included_snat_h__ */