src/plugins/nat/nat.h

   1 /*
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15 /**
  16  * @file NAT plugin global declarations
  17  */
  18 #ifndef __included_nat_h__
  19 #define __included_nat_h__
  20
  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>
  31 #include <vlib/log.h>
  32
  33 /* default session timeouts */
  34 #define SNAT_UDP_TIMEOUT 300
  35 #define SNAT_TCP_TRANSITORY_TIMEOUT 240
  36 #define SNAT_TCP_ESTABLISHED_TIMEOUT 7440
  37 #define SNAT_ICMP_TIMEOUT 60
  38
  39 /* number of worker handoff frame queue elements */
  40 #define NAT_FQ_NELTS 64
  41
  42 /* NAT buffer flags */
  43 #define SNAT_FLAG_HAIRPINNING (1 << 0)
  44
  45 /* session key (4-tuple) */
  46 typedef struct
  47 {
  48   union
  49   {
  50     struct
  51     {
  52       ip4_address_t addr;
  53       u16 port;
  54       u16 protocol:3, fib_index:13;
  55     };
  56     u64 as_u64;
  57   };
  58 } snat_session_key_t;
  59
  60 /* endpoint-dependent session key (6-tuple) */
  61 typedef struct
  62 {
  63   union
  64   {
  65     struct
  66     {
  67       ip4_address_t l_addr;
  68       ip4_address_t r_addr;
  69       u32 proto:8, fib_index:24;
  70       u16 l_port;
  71       u16 r_port;
  72     };
  73     u64 as_u64[2];
  74   };
  75 } nat_ed_ses_key_t;
  76
  77 /* deterministic session outside key */
  78 typedef struct
  79 {
  80   union
  81   {
  82     struct
  83     {
  84       ip4_address_t ext_host_addr;
  85       u16 ext_host_port;
  86       u16 out_port;
  87     };
  88     u64 as_u64;
  89   };
  90 } snat_det_out_key_t;
  91
  92 /* user (internal host) key */
  93 typedef struct
  94 {
  95   union
  96   {
  97     struct
  98     {
  99       ip4_address_t addr;
 100       u32 fib_index;
 101     };
 102     u64 as_u64;
 103   };
 104 } snat_user_key_t;
 105
 106 typedef struct
 107 {
 108   u32 sw_if_index;
 109   u32 next_index;
 110   u8 cached;
 111 } nat44_reass_trace_t;
 112
 113 /* External address and port allocation modes */
 114 #define foreach_nat_addr_and_port_alloc_alg \
 115   _(0, DEFAULT, "default")         \
 116   _(1, MAPE, "map-e")              \
 117   _(2, RANGE, "port-range")
 118
 119 typedef enum
 120 {
 121 #define _(v, N, s) NAT_ADDR_AND_PORT_ALLOC_ALG_##N = v,
 122   foreach_nat_addr_and_port_alloc_alg
 123 #undef _
 124 } nat_addr_and_port_alloc_alg_t;
 125
 126
 127 /* Supported L4 protocols */
 128 #define foreach_snat_protocol \
 129   _(UDP, 0, udp, "udp")       \
 130   _(TCP, 1, tcp, "tcp")       \
 131   _(ICMP, 2, icmp, "icmp")
 132
 133 typedef enum
 134 {
 135 #define _(N, i, n, s) SNAT_PROTOCOL_##N = i,
 136   foreach_snat_protocol
 137 #undef _
 138 } snat_protocol_t;
 139
 140
 141 /* Session state */
 142 #define foreach_snat_session_state          \
 143   _(0, UNKNOWN, "unknown")                 \
 144   _(1, UDP_ACTIVE, "udp-active")           \
 145   _(2, TCP_SYN_SENT, "tcp-syn-sent")       \
 146   _(3, TCP_ESTABLISHED, "tcp-established") \
 147   _(4, TCP_FIN_WAIT, "tcp-fin-wait")       \
 148   _(5, TCP_CLOSE_WAIT, "tcp-close-wait")   \
 149   _(6, TCP_CLOSING, "tcp-closing")         \
 150   _(7, TCP_LAST_ACK, "tcp-last-ack")       \
 151   _(8, TCP_CLOSED, "tcp-closed")           \
 152   _(9, ICMP_ACTIVE, "icmp-active")
 153
 154 typedef enum
 155 {
 156 #define _(v, N, s) SNAT_SESSION_##N = v,
 157   foreach_snat_session_state
 158 #undef _
 159 } snat_session_state_t;
 160
 161 /* Endpoint dependent TCP session state */
 162 #define NAT44_SES_I2O_FIN 1
 163 #define NAT44_SES_O2I_FIN 2
 164 #define NAT44_SES_I2O_FIN_ACK 4
 165 #define NAT44_SES_O2I_FIN_ACK 8
 166 #define NAT44_SES_I2O_SYN 16
 167 #define NAT44_SES_O2I_SYN 32
 168 #define NAT44_SES_RST     64
 169
 170 /* Session flags */
 171 #define SNAT_SESSION_FLAG_STATIC_MAPPING       1
 172 #define SNAT_SESSION_FLAG_UNKNOWN_PROTO        2
 173 #define SNAT_SESSION_FLAG_LOAD_BALANCING       4
 174 #define SNAT_SESSION_FLAG_TWICE_NAT            8
 175 #define SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT   16
 176 #define SNAT_SESSION_FLAG_FWD_BYPASS           32
 177 #define SNAT_SESSION_FLAG_AFFINITY             64
 178 #define SNAT_SESSION_FLAG_OUTPUT_FEATURE       128
 179
 180 /* NAT interface flags */
 181 #define NAT_INTERFACE_FLAG_IS_INSIDE 1
 182 #define NAT_INTERFACE_FLAG_IS_OUTSIDE 2
 183
 184 /* Static mapping flags */
 185 #define NAT_STATIC_MAPPING_FLAG_ADDR_ONLY    1
 186 #define NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY  2
 187 #define NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT 4
 188 #define NAT_STATIC_MAPPING_FLAG_LB           8
 189
 190 /* *INDENT-OFF* */
 191 typedef CLIB_PACKED(struct
 192 {
 193   /* Outside network key */
 194   snat_session_key_t out2in;
 195
 196   /* Inside network key */
 197   snat_session_key_t in2out;
 198
 199   /* Flags */
 200   u32 flags;
 201
 202   /* Per-user translations */
 203   u32 per_user_index;
 204   u32 per_user_list_head_index;
 205
 206   /* Last heard timer */
 207   f64 last_heard;
 208
 209   /* Counters */
 210   u64 total_bytes;
 211   u32 total_pkts;
 212
 213   /* External host address and port */
 214   ip4_address_t ext_host_addr;
 215   u16 ext_host_port;
 216
 217   /* External host address and port after translation */
 218   ip4_address_t ext_host_nat_addr;
 219   u16 ext_host_nat_port;
 220
 221   /* TCP session state */
 222   u8 state;
 223   u32 i2o_fin_seq;
 224   u32 o2i_fin_seq;
 225 }) snat_session_t;
 226 /* *INDENT-ON* */
 227
 228
 229 typedef struct
 230 {
 231   ip4_address_t addr;
 232   u32 fib_index;
 233   u32 sessions_per_user_list_head_index;
 234   u32 nsessions;
 235   u32 nstaticsessions;
 236 } snat_user_t;
 237
 238 typedef struct
 239 {
 240   ip4_address_t addr;
 241   u32 fib_index;
 242 /* *INDENT-OFF* */
 243 #define _(N, i, n, s) \
 244   u16 busy_##n##_ports; \
 245   u16 * busy_##n##_ports_per_thread; \
 246   uword * busy_##n##_port_bitmap;
 247   foreach_snat_protocol
 248 #undef _
 249 /* *INDENT-ON* */
 250 } snat_address_t;
 251
 252 typedef struct
 253 {
 254   u32 fib_index;
 255   u32 refcount;
 256 } nat_outside_fib_t;
 257
 258 typedef struct
 259 {
 260   /* Inside network port */
 261   u16 in_port;
 262   /* Outside network address and port */
 263   snat_det_out_key_t out;
 264   /* Session state */
 265   u8 state;
 266   /* Expire timeout */
 267   u32 expire;
 268 } snat_det_session_t;
 269
 270 typedef struct
 271 {
 272   /* inside IP address range */
 273   ip4_address_t in_addr;
 274   u8 in_plen;
 275   /* outside IP address range */
 276   ip4_address_t out_addr;
 277   u8 out_plen;
 278   /* inside IP addresses / outside IP addresses */
 279   u32 sharing_ratio;
 280   /* number of ports available to internal host */
 281   u16 ports_per_host;
 282   /* session counter */
 283   u32 ses_num;
 284   /* vector of sessions */
 285   snat_det_session_t *sessions;
 286 } snat_det_map_t;
 287
 288 typedef struct
 289 {
 290   /* backend IP address */
 291   ip4_address_t addr;
 292   /* backend port number */
 293   u16 port;
 294   /* probability of the backend to be randomly matched */
 295   u8 probability;
 296   u8 prefix;
 297   /* backend FIB table */
 298   u32 vrf_id;
 299   u32 fib_index;
 300 } nat44_lb_addr_port_t;
 301
 302 typedef enum
 303 {
 304   /* twice-nat disabled */
 305   TWICE_NAT_DISABLED,
 306   /* twice-nat enabled */
 307   TWICE_NAT,
 308   /* twice-nat only when src IP equals dst IP after translation */
 309   TWICE_NAT_SELF,
 310 } twice_nat_type_t;
 311
 312 typedef enum
 313 {
 314   /* no load-balancing */
 315   NO_LB_NAT,
 316   /* load-balancing */
 317   LB_NAT,
 318   /* load-balancing with affinity */
 319   AFFINITY_LB_NAT,
 320 } lb_nat_type_t;
 321
 322 typedef struct
 323 {
 324   /* local IP address */
 325   ip4_address_t local_addr;
 326   /* external IP address */
 327   ip4_address_t external_addr;
 328   /* local port */
 329   u16 local_port;
 330   /* external port */
 331   u16 external_port;
 332   /* is twice-nat */
 333   twice_nat_type_t twice_nat;
 334   /* local FIB table */
 335   u32 vrf_id;
 336   u32 fib_index;
 337   /* protocol */
 338   snat_protocol_t proto;
 339   /* 0 = disabled, otherwise client IP affinity sticky time in seconds */
 340   u32 affinity;
 341   /* worker threads used by backends/local host */
 342   u32 *workers;
 343   /* opaque string tag */
 344   u8 *tag;
 345   /* backends for load-balancing mode */
 346   nat44_lb_addr_port_t *locals;
 347   /* affinity per service lis */
 348   u32 affinity_per_service_list_head_index;
 349   /* flags */
 350   u32 flags;
 351 } snat_static_mapping_t;
 352
 353 typedef struct
 354 {
 355   u32 sw_if_index;
 356   u8 flags;
 357 } snat_interface_t;
 358
 359 typedef struct
 360 {
 361   ip4_address_t l_addr;
 362   u16 l_port;
 363   u16 e_port;
 364   u32 sw_if_index;
 365   u32 vrf_id;
 366   snat_protocol_t proto;
 367   u32 flags;
 368   int addr_only;
 369   int twice_nat;
 370   int is_add;
 371   int out2in_only;
 372   int identity_nat;
 373   u8 *tag;
 374 } snat_static_map_resolve_t;
 375
 376 typedef struct
 377 {
 378   /* Main lookup tables */
 379   clib_bihash_8_8_t out2in;
 380   clib_bihash_8_8_t in2out;
 381
 382   /* Endpoint dependent sessions lookup tables */
 383   clib_bihash_16_8_t out2in_ed;
 384   clib_bihash_16_8_t in2out_ed;
 385
 386   /* Find-a-user => src address lookup */
 387   clib_bihash_8_8_t user_hash;
 388
 389   /* User pool */
 390   snat_user_t *users;
 391
 392   /* Session pool */
 393   snat_session_t *sessions;
 394
 395   /* Pool of doubly-linked list elements */
 396   dlist_elt_t *list_pool;
 397
 398   /* NAT thread index */
 399   u32 snat_thread_index;
 400 } snat_main_per_thread_data_t;
 401
 402 struct snat_main_s;
 403
 404 /* ICMP session match function */
 405 typedef u32 (snat_icmp_match_function_t) (struct snat_main_s * sm,
 406                                           vlib_node_runtime_t * node,
 407                                           u32 thread_index,
 408                                           vlib_buffer_t * b0,
 409                                           ip4_header_t * ip0, u8 * p_proto,
 410                                           snat_session_key_t * p_value,
 411                                           u8 * p_dont_translate, void *d,
 412                                           void *e);
 413
 414 /* Return worker thread index for given packet */
 415 typedef u32 (snat_get_worker_function_t) (ip4_header_t * ip,
 416                                           u32 rx_fib_index);
 417
 418 /* NAT address and port allacotaion function */
 419 typedef int (nat_alloc_out_addr_and_port_function_t) (snat_address_t *
 420                                                       addresses,
 421                                                       u32 fib_index,
 422                                                       u32 thread_index,
 423                                                       snat_session_key_t * k,
 424                                                       u16 port_per_thread,
 425                                                       u32 snat_thread_index);
 426
 427 typedef struct snat_main_s
 428 {
 429   /* ICMP session match functions */
 430   snat_icmp_match_function_t *icmp_match_in2out_cb;
 431   snat_icmp_match_function_t *icmp_match_out2in_cb;
 432
 433   /* Thread settings */
 434   u32 num_workers;
 435   u32 first_worker_index;
 436   u32 *workers;
 437   snat_get_worker_function_t *worker_in2out_cb;
 438   snat_get_worker_function_t *worker_out2in_cb;
 439   u16 port_per_thread;
 440   u32 num_snat_thread;
 441
 442   /* Per thread data */
 443   snat_main_per_thread_data_t *per_thread_data;
 444
 445   /* Find a static mapping by local */
 446   clib_bihash_8_8_t static_mapping_by_local;
 447
 448   /* Find a static mapping by external */
 449   clib_bihash_8_8_t static_mapping_by_external;
 450
 451   /* Static mapping pool */
 452   snat_static_mapping_t *static_mappings;
 453
 454   /* Interface pool */
 455   snat_interface_t *interfaces;
 456   snat_interface_t *output_feature_interfaces;
 457
 458   /* Vector of outside addresses */
 459   snat_address_t *addresses;
 460   /* Address and port allocation function */
 461   nat_alloc_out_addr_and_port_function_t *alloc_addr_and_port;
 462   /* Address and port allocation type */
 463   nat_addr_and_port_alloc_alg_t addr_and_port_alloc_alg;
 464   /* Port set parameters (MAP-E) */
 465   u8 psid_offset;
 466   u8 psid_length;
 467   u16 psid;
 468   /* Port range parameters */
 469   u16 start_port;
 470   u16 end_port;
 471
 472   /* vector of outside fibs */
 473   nat_outside_fib_t *outside_fibs;
 474
 475   /* Vector of twice NAT addresses for extenal hosts */
 476   snat_address_t *twice_nat_addresses;
 477
 478   /* sw_if_indices whose intfc addresses should be auto-added */
 479   u32 *auto_add_sw_if_indices;
 480   u32 *auto_add_sw_if_indices_twice_nat;
 481
 482   /* vector of interface address static mappings to resolve. */
 483   snat_static_map_resolve_t *to_resolve;
 484
 485   /* Randomize port allocation order */
 486   u32 random_seed;
 487
 488   /* Worker handoff frame-queue index */
 489   u32 fq_in2out_index;
 490   u32 fq_in2out_output_index;
 491   u32 fq_out2in_index;
 492
 493   /* in2out and out2in node index */
 494   u32 in2out_node_index;
 495   u32 in2out_output_node_index;
 496   u32 out2in_node_index;
 497   u32 error_node_index;
 498
 499   /* Deterministic NAT mappings */
 500   snat_det_map_t *det_maps;
 501
 502   /* If forwarding is enabled */
 503   u8 forwarding_enabled;
 504
 505   /* Config parameters */
 506   u8 static_mapping_only;
 507   u8 static_mapping_connection_tracking;
 508   u8 deterministic;
 509   u8 out2in_dpo;
 510   u8 endpoint_dependent;
 511   u32 translation_buckets;
 512   u32 translation_memory_size;
 513   u32 max_translations;
 514   u32 user_buckets;
 515   u32 user_memory_size;
 516   u32 max_translations_per_user;
 517   u32 outside_vrf_id;
 518   u32 outside_fib_index;
 519   u32 inside_vrf_id;
 520   u32 inside_fib_index;
 521
 522   /* values of various timeouts */
 523   u32 udp_timeout;
 524   u32 tcp_established_timeout;
 525   u32 tcp_transitory_timeout;
 526   u32 icmp_timeout;
 527
 528   /* TCP MSS clamping */
 529   u16 mss_clamping;
 530   u16 mss_value_net;
 531
 532   /* API message ID base */
 533   u16 msg_id_base;
 534
 535   /* log class */
 536   vlib_log_class_t log_class;
 537
 538   /* convenience */
 539   vlib_main_t *vlib_main;
 540   vnet_main_t *vnet_main;
 541   ip4_main_t *ip4_main;
 542   ip_lookup_main_t *ip4_lookup_main;
 543   api_main_t *api_main;
 544 } snat_main_t;
 545
 546 typedef struct
 547 {
 548   u32 thread_index;
 549   f64 now;
 550 } nat44_is_idle_session_ctx_t;
 551
 552 typedef struct
 553 {
 554   u32 cached_sw_if_index;
 555   u32 cached_ip4_address;
 556 } snat_runtime_t;
 557
 558 extern snat_main_t snat_main;
 559 extern vlib_node_registration_t snat_in2out_node;
 560 extern vlib_node_registration_t snat_in2out_output_node;
 561 extern vlib_node_registration_t snat_out2in_node;
 562 extern vlib_node_registration_t snat_in2out_fast_node;
 563 extern vlib_node_registration_t snat_out2in_fast_node;
 564 extern vlib_node_registration_t snat_in2out_worker_handoff_node;
 565 extern vlib_node_registration_t snat_in2out_output_worker_handoff_node;
 566 extern vlib_node_registration_t snat_out2in_worker_handoff_node;
 567 extern vlib_node_registration_t snat_det_in2out_node;
 568 extern vlib_node_registration_t snat_det_out2in_node;
 569 extern vlib_node_registration_t snat_hairpin_dst_node;
 570 extern vlib_node_registration_t snat_hairpin_src_node;
 571 extern vlib_node_registration_t nat44_ed_in2out_node;
 572 extern vlib_node_registration_t nat44_ed_in2out_output_node;
 573 extern vlib_node_registration_t nat44_ed_out2in_node;
 574 extern vlib_node_registration_t nat44_ed_hairpin_dst_node;
 575 extern vlib_node_registration_t nat44_ed_hairpin_src_node;
 576 extern vlib_node_registration_t nat44_ed_in2out_worker_handoff_node;
 577 extern vlib_node_registration_t nat44_ed_in2out_output_worker_handoff_node;
 578 extern vlib_node_registration_t nat44_ed_out2in_worker_handoff_node;
 579
 580 /* format functions */
 581 format_function_t format_snat_user;
 582 format_function_t format_snat_static_mapping;
 583 format_function_t format_snat_static_map_to_resolve;
 584 format_function_t format_snat_session;
 585 format_function_t format_det_map_ses;
 586 format_function_t format_snat_key;
 587 format_function_t format_static_mapping_key;
 588 format_function_t format_snat_protocol;
 589 format_function_t format_nat_addr_and_port_alloc_alg;
 590 format_function_t format_nat44_reass_trace;
 591 /* unformat functions */
 592 unformat_function_t unformat_snat_protocol;
 593
 594 /** \brief Check if SNAT session is created from static mapping.
 595     @param s SNAT session
 596     @return 1 if SNAT session is created from static mapping otherwise 0
 597 */
 598 #define snat_is_session_static(s) (s->flags & SNAT_SESSION_FLAG_STATIC_MAPPING)
 599
 600 /** \brief Check if SNAT session for unknown protocol.
 601     @param s SNAT session
 602     @return 1 if SNAT session for unknown protocol otherwise 0
 603 */
 604 #define snat_is_unk_proto_session(s) (s->flags & SNAT_SESSION_FLAG_UNKNOWN_PROTO)
 605
 606 /** \brief Check if NAT session is twice NAT.
 607     @param s NAT session
 608     @return 1 if NAT session is twice NAT
 609 */
 610 #define is_twice_nat_session(s) (s->flags & SNAT_SESSION_FLAG_TWICE_NAT)
 611
 612 /** \brief Check if NAT session is load-balancing.
 613     @param s NAT session
 614     @return 1 if NAT session is load-balancing
 615 */
 616 #define is_lb_session(s) (s->flags & SNAT_SESSION_FLAG_LOAD_BALANCING)
 617
 618 /** \brief Check if NAT session is forwarding bypass.
 619     @param s NAT session
 620     @return 1 if NAT session is load-balancing
 621 */
 622 #define is_fwd_bypass_session(s) (s->flags & SNAT_SESSION_FLAG_FWD_BYPASS)
 623
 624 /** \brief Check if NAT session is endpoint dependent.
 625     @param s NAT session
 626     @return 1 if NAT session is endpoint dependent
 627 */
 628 #define is_ed_session(s) (s->flags & SNAT_SESSION_FLAG_ENDPOINT_DEPENDENT)
 629
 630 /** \brief Check if NAT session has affinity record.
 631     @param s NAT session
 632     @return 1 if NAT session has affinity record
 633 */
 634 #define is_affinity_sessions(s) (s->flags & SNAT_SESSION_FLAG_AFFINITY)
 635
 636 /** \brief Check if NAT interface is inside.
 637     @param i NAT interfce
 638     @return 1 if inside interface
 639 */
 640 #define nat_interface_is_inside(i) i->flags & NAT_INTERFACE_FLAG_IS_INSIDE
 641
 642 /** \brief Check if NAT interface is outside.
 643     @param i NAT interfce
 644     @return 1 if outside interface
 645 */
 646 #define nat_interface_is_outside(i) i->flags & NAT_INTERFACE_FLAG_IS_OUTSIDE
 647
 648 /** \brief Check if NAT44 endpoint-dependent TCP session is closed.
 649     @param s NAT session
 650     @return 1 if session is closed
 651 */
 652 #define nat44_is_ses_closed(s) s->state == 0xf
 653
 654 /** \brief Check if NAT static mapping is address only (1:1NAT).
 655     @param sm NAT static mapping
 656     @return 1 if 1:1NAT, 0 if 1:1NAPT
 657 */
 658 #define is_addr_only_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_ADDR_ONLY)
 659
 660 /** \brief Check if NAT static mapping match only out2in direction.
 661     @param sm NAT static mapping
 662     @return 1 if rule match only out2in direction
 663 */
 664 #define is_out2in_only_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_OUT2IN_ONLY)
 665
 666 /** \brief Check if NAT static mapping is identity NAT.
 667     @param sm NAT static mapping
 668     @return 1 if identity NAT
 669 */
 670 #define is_identity_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_IDENTITY_NAT)
 671
 672 /** \brief Check if NAT static mapping is load-balancing.
 673     @param sm NAT static mapping
 674     @return 1 if load-balancing
 675 */
 676 #define is_lb_static_mapping(sm) (sm->flags & NAT_STATIC_MAPPING_FLAG_LB)
 677
 678 /** \brief Check if client initiating TCP connection (received SYN from client)
 679     @param t TCP header
 680     @return 1 if client initiating TCP connection
 681 */
 682 #define tcp_is_init(t) ((t->flags & TCP_FLAG_SYN) && !(t->flags & TCP_FLAG_ACK))
 683
 684 /* logging */
 685 #define nat_log_err(...) \
 686   vlib_log(VLIB_LOG_LEVEL_ERR, snat_main.log_class, __VA_ARGS__)
 687 #define nat_log_warn(...) \
 688   vlib_log(VLIB_LOG_LEVEL_WARNING, snat_main.log_class, __VA_ARGS__)
 689 #define nat_log_notice(...) \
 690   vlib_log(VLIB_LOG_LEVEL_NOTICE, snat_main.log_class, __VA_ARGS__)
 691 #define nat_log_info(...) \
 692   vlib_log(VLIB_LOG_LEVEL_INFO, snat_main.log_class, __VA_ARGS__)
 693 #define nat_log_debug(...)\
 694   vlib_log(VLIB_LOG_LEVEL_DEBUG, snat_main.log_class, __VA_ARGS__)
 695
 696 /* ICMP session match functions */
 697 u32 icmp_match_in2out_fast (snat_main_t * sm, vlib_node_runtime_t * node,
 698                             u32 thread_index, vlib_buffer_t * b0,
 699                             ip4_header_t * ip0, u8 * p_proto,
 700                             snat_session_key_t * p_value,
 701                             u8 * p_dont_translate, void *d, void *e);
 702 u32 icmp_match_in2out_slow (snat_main_t * sm, vlib_node_runtime_t * node,
 703                             u32 thread_index, vlib_buffer_t * b0,
 704                             ip4_header_t * ip0, u8 * p_proto,
 705                             snat_session_key_t * p_value,
 706                             u8 * p_dont_translate, void *d, void *e);
 707 u32 icmp_match_out2in_fast (snat_main_t * sm, vlib_node_runtime_t * node,
 708                             u32 thread_index, vlib_buffer_t * b0,
 709                             ip4_header_t * ip0, u8 * p_proto,
 710                             snat_session_key_t * p_value,
 711                             u8 * p_dont_translate, void *d, void *e);
 712 u32 icmp_match_out2in_slow (snat_main_t * sm, vlib_node_runtime_t * node,
 713                             u32 thread_index, vlib_buffer_t * b0,
 714                             ip4_header_t * ip0, u8 * p_proto,
 715                             snat_session_key_t * p_value,
 716                             u8 * p_dont_translate, void *d, void *e);
 717
 718 /* ICMP deterministic NAT session match functions */
 719 u32 icmp_match_out2in_det (snat_main_t * sm, vlib_node_runtime_t * node,
 720                            u32 thread_index, vlib_buffer_t * b0,
 721                            ip4_header_t * ip0, u8 * p_proto,
 722                            snat_session_key_t * p_value,
 723                            u8 * p_dont_translate, void *d, void *e);
 724 u32 icmp_match_in2out_det (snat_main_t * sm, vlib_node_runtime_t * node,
 725                            u32 thread_index, vlib_buffer_t * b0,
 726                            ip4_header_t * ip0, u8 * p_proto,
 727                            snat_session_key_t * p_value,
 728                            u8 * p_dont_translate, void *d, void *e);
 729
 730 /* ICMP endpoint-dependent session match functions */
 731 u32 icmp_match_out2in_ed (snat_main_t * sm, vlib_node_runtime_t * node,
 732                           u32 thread_index, vlib_buffer_t * b0,
 733                           ip4_header_t * ip0, u8 * p_proto,
 734                           snat_session_key_t * p_value,
 735                           u8 * p_dont_translate, void *d, void *e);
 736 u32 icmp_match_in2out_ed (snat_main_t * sm, vlib_node_runtime_t * node,
 737                           u32 thread_index, vlib_buffer_t * b0,
 738                           ip4_header_t * ip0, u8 * p_proto,
 739                           snat_session_key_t * p_value,
 740                           u8 * p_dont_translate, void *d, void *e);
 741
 742 u32 icmp_in2out (snat_main_t * sm, vlib_buffer_t * b0, ip4_header_t * ip0,
 743                  icmp46_header_t * icmp0, u32 sw_if_index0, u32 rx_fib_index0,
 744                  vlib_node_runtime_t * node, u32 next0, u32 thread_index,
 745                  void *d, void *e);
 746
 747 u32 icmp_out2in (snat_main_t * sm, vlib_buffer_t * b0, ip4_header_t * ip0,
 748                  icmp46_header_t * icmp0, u32 sw_if_index0, u32 rx_fib_index0,
 749                  vlib_node_runtime_t * node, u32 next0, u32 thread_index,
 750                  void *d, void *e);
 751
 752 /* hairpinning functions */
 753 u32 snat_icmp_hairpinning (snat_main_t * sm, vlib_buffer_t * b0,
 754                            ip4_header_t * ip0, icmp46_header_t * icmp0,
 755                            int is_ed);
 756 void nat_hairpinning_sm_unknown_proto (snat_main_t * sm, vlib_buffer_t * b,
 757                                        ip4_header_t * ip);
 758 void nat44_ed_hairpinning_unknown_proto (snat_main_t * sm, vlib_buffer_t * b,
 759                                          ip4_header_t * ip);
 760 int snat_hairpinning (snat_main_t * sm, vlib_buffer_t * b0,
 761                       ip4_header_t * ip0, udp_header_t * udp0,
 762                       tcp_header_t * tcp0, u32 proto0, int is_ed);
 763 void nat44_reass_hairpinning (snat_main_t * sm, vlib_buffer_t * b0,
 764                               ip4_header_t * ip0, u16 sport, u16 dport,
 765                               u32 proto0, int is_ed);
 766
 767 /* Call back functions for clib_bihash_add_or_overwrite_stale */
 768 int nat44_i2o_ed_is_idle_session_cb (clib_bihash_kv_16_8_t * kv, void *arg);
 769 int nat44_o2i_ed_is_idle_session_cb (clib_bihash_kv_16_8_t * kv, void *arg);
 770 int nat44_i2o_is_idle_session_cb (clib_bihash_kv_8_8_t * kv, void *arg);
 771 int nat44_o2i_is_idle_session_cb (clib_bihash_kv_8_8_t * kv, void *arg);
 772
 773 /**
 774  * @brief Increment IPv4 address
 775  */
 776 void increment_v4_address (ip4_address_t * a);
 777
 778 /**
 779  * @brief Add external address to NAT44 pool
 780  *
 781  * @param addr      IPv4 address
 782  * @param vrf_id    VRF id of tenant, ~0 means independent of VRF
 783  * @param twice_nat 1 if twice NAT address
 784  *
 785  * @return 0 on success, non-zero value otherwise
 786  */
 787 int snat_add_address (snat_main_t * sm, ip4_address_t * addr, u32 vrf_id,
 788                       u8 twice_nat);
 789
 790 /**
 791  * @brief Delete external address from NAT44 pool
 792  *
 793  * @param addr      IPv4 address
 794  * @param delete_sm 1 if delete static mapping using address
 795  * @param twice_nat 1 if twice NAT address
 796  *
 797  * @return 0 on success, non-zero value otherwise
 798  */
 799 int snat_del_address (snat_main_t * sm, ip4_address_t addr, u8 delete_sm,
 800                       u8 twice_nat);
 801
 802 /**
 803  * @brief Add/delete external address to FIB DPO (out2in DPO mode)
 804  *
 805  * @param addr   IPv4 address
 806  * @param is_add 1 = add, 0 = delete
 807  *
 808  * @return 0 on success, non-zero value otherwise
 809  */
 810 void nat44_add_del_address_dpo (ip4_address_t addr, u8 is_add);
 811
 812 /**
 813  * @brief Add/delete NAT44 static mapping
 814  *
 815  * @param l_addr       local IPv4 address
 816  * @param e_addr       external IPv4 address
 817  * @param l_port       local port number
 818  * @param e_port       external port number
 819  * @param vrf_id       local VRF ID
 820  * @param addr_only    1 = 1:1NAT, 0 = 1:1NAPT
 821  * @param sw_if_index  use interface address as external IPv4 address
 822  * @param proto        L4 protocol
 823  * @param is_add       1 = add, 0 = delete
 824  * @param twice_nat    twice-nat mode
 825  * @param out2in_only  if 1 rule match only out2in direction
 826  * @param tag          opaque string tag
 827  * @param identity_nat identity NAT
 828  *
 829  * @return 0 on success, non-zero value otherwise
 830  */
 831 int snat_add_static_mapping (ip4_address_t l_addr, ip4_address_t e_addr,
 832                              u16 l_port, u16 e_port, u32 vrf_id,
 833                              int addr_only, u32 sw_if_index,
 834                              snat_protocol_t proto, int is_add,
 835                              twice_nat_type_t twice_nat, u8 out2in_only,
 836                              u8 * tag, u8 identity_nat);
 837
 838 /**
 839  * @brief Add/delete static mapping with load-balancing (multiple backends)
 840  *
 841  * @param e_addr      external IPv4 address
 842  * @param e_port      external port number
 843  * @param proto       L4 protocol
 844  * @param locals      list of local backends
 845  * @param is_add      1 = add, 0 = delete
 846  * @param twice_nat   twice-nat mode
 847  * @param out2in_only if 1 rule match only out2in direction
 848  * @param tag         opaque string tag
 849  * @param affinity    0 = disabled, otherwise client IP affinity sticky time
 850  *
 851  * @return 0 on success, non-zero value otherwise
 852  */
 853 int nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
 854                                      snat_protocol_t proto,
 855                                      nat44_lb_addr_port_t * locals, u8 is_add,
 856                                      twice_nat_type_t twice_nat,
 857                                      u8 out2in_only, u8 * tag, u32 affinity);
 858
 859 clib_error_t *snat_api_init (vlib_main_t * vm, snat_main_t * sm);
 860
 861 /**
 862  * @brief Set NAT plugin workers
 863  *
 864  * @param bitmap NAT workers bitmap
 865  *
 866  * @return 0 on success, non-zero value otherwise
 867  */
 868 int snat_set_workers (uword * bitmap);
 869
 870 /**
 871  * @brief Enable/disable NAT44 feature on the interface
 872  *
 873  * @param sw_if_index software index of the interface
 874  * @param is_inside   1 = inside, 0 = outside
 875  * @param is_del      1 = delete, 0 = add
 876  *
 877  * @return 0 on success, non-zero value otherwise
 878  */
 879 int snat_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del);
 880
 881 /**
 882  * @brief Enable/disable NAT44 output feature on the interface (postrouting NAT)
 883  *
 884  * @param sw_if_index software index of the interface
 885  * @param is_inside   1 = inside, 0 = outside
 886  * @param is_del      1 = delete, 0 = add
 887  *
 888  * @return 0 on success, non-zero value otherwise
 889  */
 890 int snat_interface_add_del_output_feature (u32 sw_if_index, u8 is_inside,
 891                                            int is_del);
 892
 893 /**
 894  * @brief Add/delete NAT44 pool address from specific interfce
 895  *
 896  * @param sw_if_index software index of the interface
 897  * @param is_del      1 = delete, 0 = add
 898  * @param twice_nat   1 = twice NAT address for extenal hosts
 899  *
 900  * @return 0 on success, non-zero value otherwise
 901  */
 902 int snat_add_interface_address (snat_main_t * sm, u32 sw_if_index, int is_del,
 903                                 u8 twice_nat);
 904
 905 /**
 906  * @brief Delete NAT44 session
 907  *
 908  * @param addr   IPv4 address
 909  * @param port   L4 port number
 910  * @param proto  L4 protocol
 911  * @param vrf_id VRF ID
 912  * @param is_in  1 = inside network addres and por pair, 0 = outside
 913  *
 914  * @return 0 on success, non-zero value otherwise
 915  */
 916 int nat44_del_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
 917                        snat_protocol_t proto, u32 vrf_id, int is_in);
 918
 919 /**
 920  * @brief Delete NAT44 endpoint-dependent session
 921  *
 922  * @param addr   IPv4 address
 923  * @param port   L4 port number
 924  * @param proto  L4 protocol
 925  * @param vrf_id VRF ID
 926  * @param is_in  1 = inside network addres and por pair, 0 = outside
 927  *
 928  * @return 0 on success, non-zero value otherwise
 929  */
 930 int nat44_del_ed_session (snat_main_t * sm, ip4_address_t * addr, u16 port,
 931                           ip4_address_t * eh_addr, u16 eh_port, u8 proto,
 932                           u32 vrf_id, int is_in);
 933
 934 /**
 935  * @brief Free NAT44 session data (lookup keys, external addrres port)
 936  *
 937  * @param s            NAT session
 938  * @param thread_index thread index
 939  */
 940 void nat_free_session_data (snat_main_t * sm, snat_session_t * s,
 941                             u32 thread_index);
 942
 943 /**
 944  * @brief Find or create NAT user
 945  *
 946  * @param addr         IPv4 address
 947  * @param fib_index    FIB table index
 948  * @param thread_index thread index
 949  *
 950  * @return NAT user data structure on success otherwise zero value
 951  */
 952 snat_user_t *nat_user_get_or_create (snat_main_t * sm, ip4_address_t * addr,
 953                                      u32 fib_index, u32 thread_index);
 954
 955 /**
 956  * @brief Allocate new NAT session or recycle last used
 957  *
 958  * @param u            NAT user
 959  * @param thread_index thread index
 960  *
 961  * @return session data structure on success otherwise zero value
 962  */
 963 snat_session_t *nat_session_alloc_or_recycle (snat_main_t * sm,
 964                                               snat_user_t * u,
 965                                               u32 thread_index);
 966
 967 /**
 968  * @brief Allocate NAT endpoint-dependent session
 969  *
 970  * @param u            NAT user
 971  * @param thread_index thread index
 972  *
 973  * @return session data structure on success otherwise zero value
 974  */
 975 snat_session_t *nat_ed_session_alloc (snat_main_t * sm, snat_user_t * u,
 976                                       u32 thread_index, f64 now);
 977
 978 /**
 979  * @brief Set address and port assignment algorithm for MAP-E CE
 980  *
 981  * @param psid        Port Set Identifier value
 982  * @param psid_offset number of offset bits
 983  * @param psid_length length of PSID
 984  */
 985 void nat_set_alloc_addr_and_port_mape (u16 psid, u16 psid_offset,
 986                                        u16 psid_length);
 987
 988 /**
 989  * @brief Set address and port assignment algorithm for port range
 990  *
 991  * @param start_port beginning of the port range
 992  * @param end_port   end of the port range
 993  */
 994 void nat_set_alloc_addr_and_port_range (u16 start_port, u16 end_port);
 995
 996 /**
 997  * @brief Set address and port assignment algorithm to default/standard
 998  */
 999 void nat_set_alloc_addr_and_port_default (void);
1000
1001 /**
1002  * @brief Free outside address and port pair
1003  *
1004  * @param addresses    vector of outside addresses
1005  * @param thread_index thread index
1006  * @param k            adddress, port and protocol
1007  */
1008 void snat_free_outside_address_and_port (snat_address_t * addresses,
1009                                          u32 thread_index,
1010                                          snat_session_key_t * k);
1011
1012 /**
1013  * @brief Alloc outside address and port
1014  *
1015  * @param addresses         vector of outside addresses
1016  * @param fib_index         FIB table index
1017  * @param thread_index      thread index
1018  * @param k                 allocated address and port pair
1019  * @param port_per_thread   number of ports per threead
1020  * @param snat_thread_index NAT thread index
1021  *
1022  * @return 0 on success, non-zero value otherwise
1023  */
1024 int snat_alloc_outside_address_and_port (snat_address_t * addresses,
1025                                          u32 fib_index,
1026                                          u32 thread_index,
1027                                          snat_session_key_t * k,
1028                                          u16 port_per_thread,
1029                                          u32 snat_thread_index);
1030
1031 /**
1032  * @brief Match NAT44 static mapping.
1033  *
1034  * @param match         address and port to match
1035  * @param mapping       external/local address and port of the matched mapping
1036  * @param by_external   if 0 match by local address otherwise match by external
1037  *                      address
1038  * @param is_addr_only  1 if matched mapping is address only
1039  * @param twice_nat     matched mapping is twice NAT type
1040  * @param lb            1 if matched mapping is load-balanced
1041  * @param ext_host_addr external host address
1042  *
1043  * @returns 0 if match found otherwise 1.
1044  */
1045 int snat_static_mapping_match (snat_main_t * sm,
1046                                snat_session_key_t match,
1047                                snat_session_key_t * mapping,
1048                                u8 by_external,
1049                                u8 * is_addr_only,
1050                                twice_nat_type_t * twice_nat,
1051                                lb_nat_type_t * lb,
1052                                ip4_address_t * ext_host_addr,
1053                                u8 * is_identity_nat);
1054
1055 /**
1056  * @brief Add/del NAT address to FIB.
1057  *
1058  * Add the external NAT address to the FIB as receive entries. This ensures
1059  * that VPP will reply to ARP for this address and we don't need to enable
1060  * proxy ARP on the outside interface.
1061  *
1062  * @param addr        IPv4 address
1063  * @param plen        address prefix length
1064  * @param sw_if_index software index of the outside interface
1065  * @param is_add      0 = delete, 1 = add.
1066  */
1067 void snat_add_del_addr_to_fib (ip4_address_t * addr,
1068                                u8 p_len, u32 sw_if_index, int is_add);
1069
1070
1071 /*
1072  * Why is this here? Because we don't need to touch this layer to
1073  * simply reply to an icmp. We need to change id to a unique
1074  * value to NAT an echo request/reply.
1075  */
1076
1077 typedef struct
1078 {
1079   u16 identifier;
1080   u16 sequence;
1081 } icmp_echo_header_t;
1082
1083 typedef struct
1084 {
1085   u16 src_port, dst_port;
1086 } tcp_udp_header_t;
1087
1088 #endif /* __included_nat_h__ */
1089
1090 /*
1091  * fd.io coding-style-patch-verification: ON
1092  *
1093  * Local Variables:
1094  * eval: (c-set-style "gnu")
1095  * End:
1096  */