src/plugins/nat/nat.h

   1
   2 /*
   3  * nat.h - NAT plugin definitions
   4  *
   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:
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  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.
  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
  32
  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
  39
  40 #define SNAT_FLAG_HAIRPINNING (1 << 0)
  41
  42 /* Key */
  43 typedef struct {
  44   union
  45   {
  46     struct
  47     {
  48       ip4_address_t addr;
  49       u16 port;
  50       u16 protocol:3,
  51         fib_index:13;
  52     };
  53     u64 as_u64;
  54   };
  55 } snat_session_key_t;
  56
  57 typedef struct {
  58   union
  59   {
  60     struct
  61     {
  62       ip4_address_t l_addr;
  63       ip4_address_t r_addr;
  64       u32 fib_index;
  65       u16 l_port;
  66       u8 proto;
  67       u8 rsvd;
  68     };
  69     u64 as_u64[2];
  70   };
  71 } nat_ed_ses_key_t;
  72
  73 typedef struct {
  74   union
  75   {
  76     struct
  77     {
  78       ip4_address_t ext_host_addr;
  79       u16 ext_host_port;
  80       u16 out_port;
  81     };
  82     u64 as_u64;
  83   };
  84 } snat_det_out_key_t;
  85
  86 typedef struct {
  87   union
  88   {
  89     struct
  90     {
  91       ip4_address_t addr;
  92       u32 fib_index;
  93     };
  94     u64 as_u64;
  95   };
  96 } snat_user_key_t;
  97
  98 typedef struct {
  99   union
 100   {
 101     struct
 102     {
 103       ip4_address_t addr;
 104       u16 port;
 105       u16 fib_index;
 106     };
 107     u64 as_u64;
 108   };
 109 } snat_worker_key_t;
 110
 111
 112 #define foreach_snat_protocol \
 113   _(UDP, 0, udp, "udp")       \
 114   _(TCP, 1, tcp, "tcp")       \
 115   _(ICMP, 2, icmp, "icmp")
 116
 117 typedef enum {
 118 #define _(N, i, n, s) SNAT_PROTOCOL_##N = i,
 119   foreach_snat_protocol
 120 #undef _
 121 } snat_protocol_t;
 122
 123
 124 #define foreach_snat_session_state          \
 125   _(0, UNKNOWN, "unknown")                 \
 126   _(1, UDP_ACTIVE, "udp-active")           \
 127   _(2, TCP_SYN_SENT, "tcp-syn-sent")       \
 128   _(3, TCP_ESTABLISHED, "tcp-established") \
 129   _(4, TCP_FIN_WAIT, "tcp-fin-wait")       \
 130   _(5, TCP_CLOSE_WAIT, "tcp-close-wait")   \
 131   _(6, TCP_LAST_ACK, "tcp-last-ack")       \
 132   _(7, ICMP_ACTIVE, "icmp-active")
 133
 134 typedef enum {
 135 #define _(v, N, s) SNAT_SESSION_##N = v,
 136   foreach_snat_session_state
 137 #undef _
 138 } snat_session_state_t;
 139
 140
 141 #define SNAT_SESSION_FLAG_STATIC_MAPPING 1
 142 #define SNAT_SESSION_FLAG_UNKNOWN_PROTO  2
 143 #define SNAT_SESSION_FLAG_LOAD_BALANCING 4
 144
 145 typedef CLIB_PACKED(struct {
 146   snat_session_key_t out2in;    /* 0-15 */
 147
 148   snat_session_key_t in2out;    /* 16-31 */
 149
 150   u32 flags;                    /* 32-35 */
 151
 152   /* per-user translations */
 153   u32 per_user_index;           /* 36-39 */
 154
 155   u32 per_user_list_head_index; /* 40-43 */
 156
 157   /* Last heard timer */
 158   f64 last_heard;               /* 44-51 */
 159
 160   u64 total_bytes;              /* 52-59 */
 161
 162   u32 total_pkts;               /* 60-63 */
 163
 164   /* Outside address */
 165   u32 outside_address_index;    /* 64-67 */
 166
 167   /* External host address */
 168   ip4_address_t ext_host_addr;  /* 68-71 */
 169
 170 }) snat_session_t;
 171
 172
 173 typedef struct {
 174   ip4_address_t addr;
 175   u32 fib_index;
 176   u32 sessions_per_user_list_head_index;
 177   u32 nsessions;
 178   u32 nstaticsessions;
 179 } snat_user_t;
 180
 181 typedef struct {
 182   ip4_address_t addr;
 183   u32 fib_index;
 184 #define _(N, i, n, s) \
 185   u16 busy_##n##_ports; \
 186   u16 * busy_##n##_ports_per_thread; \
 187   uword * busy_##n##_port_bitmap;
 188   foreach_snat_protocol
 189 #undef _
 190 } snat_address_t;
 191
 192 typedef struct {
 193   u16 in_port;
 194   snat_det_out_key_t out;
 195   u8 state;
 196   u32 expire;
 197 } snat_det_session_t;
 198
 199 typedef struct {
 200   ip4_address_t in_addr;
 201   u8 in_plen;
 202   ip4_address_t out_addr;
 203   u8 out_plen;
 204   u32 sharing_ratio;
 205   u16 ports_per_host;
 206   u32 ses_num;
 207   /* vector of sessions */
 208   snat_det_session_t * sessions;
 209 } snat_det_map_t;
 210
 211 typedef struct {
 212   ip4_address_t addr;
 213   u16 port;
 214   u8 probability;
 215   u8 prefix;
 216 } nat44_lb_addr_port_t;
 217
 218 typedef struct {
 219   ip4_address_t local_addr;
 220   ip4_address_t external_addr;
 221   u16 local_port;
 222   u16 external_port;
 223   u8 addr_only;
 224   u32 vrf_id;
 225   u32 fib_index;
 226   snat_protocol_t proto;
 227   nat44_lb_addr_port_t *locals;
 228 } snat_static_mapping_t;
 229
 230 typedef struct {
 231   u32 sw_if_index;
 232   u8 is_inside;
 233 } snat_interface_t;
 234
 235 typedef struct {
 236   ip4_address_t l_addr;
 237   u16 l_port;
 238   u16 e_port;
 239   u32 sw_if_index;
 240   u32 vrf_id;
 241   snat_protocol_t proto;
 242   int addr_only;
 243   int is_add;
 244 } snat_static_map_resolve_t;
 245
 246 typedef struct {
 247   /* Main lookup tables */
 248   clib_bihash_8_8_t out2in;
 249   clib_bihash_8_8_t in2out;
 250
 251   /* Find-a-user => src address lookup */
 252   clib_bihash_8_8_t user_hash;
 253
 254   /* User pool */
 255   snat_user_t * users;
 256
 257   /* Session pool */
 258   snat_session_t * sessions;
 259
 260   /* Pool of doubly-linked list elements */
 261   dlist_elt_t * list_pool;
 262
 263   u32 snat_thread_index;
 264 } snat_main_per_thread_data_t;
 265
 266 struct snat_main_s;
 267
 268 typedef u32 snat_icmp_match_function_t (struct snat_main_s *sm,
 269                                         vlib_node_runtime_t *node,
 270                                         u32 thread_index,
 271                                         vlib_buffer_t *b0,
 272                                         u8 *p_proto,
 273                                         snat_session_key_t *p_value,
 274                                         u8 *p_dont_translate,
 275                                         void *d,
 276                                         void *e);
 277
 278 typedef u32 (snat_get_worker_function_t) (ip4_header_t * ip, u32 rx_fib_index);
 279
 280 typedef struct snat_main_s {
 281   /* Endpoint address dependent sessions lookup tables */
 282   clib_bihash_16_8_t out2in_ed;
 283   clib_bihash_16_8_t in2out_ed;
 284
 285   /* Non-translated packets worker lookup => src address + VRF */
 286   clib_bihash_8_8_t worker_by_in;
 287
 288   /* Translated packets worker lookup => IP address + port number */
 289   clib_bihash_8_8_t worker_by_out;
 290
 291   snat_icmp_match_function_t * icmp_match_in2out_cb;
 292   snat_icmp_match_function_t * icmp_match_out2in_cb;
 293
 294   u32 num_workers;
 295   u32 first_worker_index;
 296   u32 next_worker;
 297   u32 * workers;
 298   snat_get_worker_function_t * worker_in2out_cb;
 299   snat_get_worker_function_t * worker_out2in_cb;
 300   u16 port_per_thread;
 301   u32 num_snat_thread;
 302
 303   /* Per thread data */
 304   snat_main_per_thread_data_t * per_thread_data;
 305
 306   /* Find a static mapping by local */
 307   clib_bihash_8_8_t static_mapping_by_local;
 308
 309   /* Find a static mapping by external */
 310   clib_bihash_8_8_t static_mapping_by_external;
 311
 312   /* Static mapping pool */
 313   snat_static_mapping_t * static_mappings;
 314
 315   /* Interface pool */
 316   snat_interface_t * interfaces;
 317   snat_interface_t * output_feature_interfaces;
 318
 319   /* Vector of outside addresses */
 320   snat_address_t * addresses;
 321
 322   /* sw_if_indices whose intfc addresses should be auto-added */
 323   u32 * auto_add_sw_if_indices;
 324
 325   /* vector of interface address static mappings to resolve. */
 326   snat_static_map_resolve_t *to_resolve;
 327
 328   /* Randomize port allocation order */
 329   u32 random_seed;
 330
 331   /* Worker handoff index */
 332   u32 fq_in2out_index;
 333   u32 fq_in2out_output_index;
 334   u32 fq_out2in_index;
 335
 336   /* in2out and out2in node index */
 337   u32 in2out_node_index;
 338   u32 in2out_output_node_index;
 339   u32 out2in_node_index;
 340
 341   /* Deterministic NAT */
 342   snat_det_map_t * det_maps;
 343
 344   /* Config parameters */
 345   u8 static_mapping_only;
 346   u8 static_mapping_connection_tracking;
 347   u8 deterministic;
 348   u32 translation_buckets;
 349   u32 translation_memory_size;
 350   u32 user_buckets;
 351   u32 user_memory_size;
 352   u32 max_translations_per_user;
 353   u32 outside_vrf_id;
 354   u32 outside_fib_index;
 355   u32 inside_vrf_id;
 356   u32 inside_fib_index;
 357
 358   /* tenant VRF aware address pool activation flag */
 359   u8 vrf_mode;
 360
 361   /* values of various timeouts */
 362   u32 udp_timeout;
 363   u32 tcp_established_timeout;
 364   u32 tcp_transitory_timeout;
 365   u32 icmp_timeout;
 366
 367   /* API message ID base */
 368   u16 msg_id_base;
 369
 370   /* convenience */
 371   vlib_main_t * vlib_main;
 372   vnet_main_t * vnet_main;
 373   ip4_main_t * ip4_main;
 374   ip_lookup_main_t * ip4_lookup_main;
 375   api_main_t * api_main;
 376 } snat_main_t;
 377
 378 extern snat_main_t snat_main;
 379 extern vlib_node_registration_t snat_in2out_node;
 380 extern vlib_node_registration_t snat_in2out_output_node;
 381 extern vlib_node_registration_t snat_out2in_node;
 382 extern vlib_node_registration_t snat_in2out_fast_node;
 383 extern vlib_node_registration_t snat_out2in_fast_node;
 384 extern vlib_node_registration_t snat_in2out_worker_handoff_node;
 385 extern vlib_node_registration_t snat_in2out_output_worker_handoff_node;
 386 extern vlib_node_registration_t snat_out2in_worker_handoff_node;
 387 extern vlib_node_registration_t snat_det_in2out_node;
 388 extern vlib_node_registration_t snat_det_out2in_node;
 389 extern vlib_node_registration_t snat_hairpin_dst_node;
 390 extern vlib_node_registration_t snat_hairpin_src_node;
 391
 392 void snat_free_outside_address_and_port (snat_main_t * sm,
 393                                          u32 thread_index,
 394                                          snat_session_key_t * k,
 395                                          u32 address_index);
 396
 397 int snat_alloc_outside_address_and_port (snat_main_t * sm,
 398                                          u32 fib_index,
 399                                          u32 thread_index,
 400                                          snat_session_key_t * k,
 401                                          u32 * address_indexp);
 402
 403 int snat_static_mapping_match (snat_main_t * sm,
 404                                snat_session_key_t match,
 405                                snat_session_key_t * mapping,
 406                                u8 by_external,
 407                                u8 *is_addr_only);
 408
 409 void snat_add_del_addr_to_fib (ip4_address_t * addr,
 410                                u8 p_len,
 411                                u32 sw_if_index,
 412                                int is_add);
 413
 414 format_function_t format_snat_user;
 415
 416 typedef struct {
 417   u32 cached_sw_if_index;
 418   u32 cached_ip4_address;
 419 } snat_runtime_t;
 420
 421 /** \brief Check if SNAT session is created from static mapping.
 422     @param s SNAT session
 423     @return 1 if SNAT session is created from static mapping otherwise 0
 424 */
 425 #define snat_is_session_static(s) s->flags & SNAT_SESSION_FLAG_STATIC_MAPPING
 426
 427 /** \brief Check if SNAT session for unknown protocol.
 428     @param s SNAT session
 429     @return 1 if SNAT session for unknown protocol otherwise 0
 430 */
 431 #define snat_is_unk_proto_session(s) s->flags & SNAT_SESSION_FLAG_UNKNOWN_PROTO
 432
 433 /*
 434  * Why is this here? Because we don't need to touch this layer to
 435  * simply reply to an icmp. We need to change id to a unique
 436  * value to NAT an echo request/reply.
 437  */
 438
 439 typedef struct {
 440   u16 identifier;
 441   u16 sequence;
 442 } icmp_echo_header_t;
 443
 444 always_inline u32
 445 ip_proto_to_snat_proto (u8 ip_proto)
 446 {
 447   u32 snat_proto = ~0;
 448
 449   snat_proto = (ip_proto == IP_PROTOCOL_UDP) ? SNAT_PROTOCOL_UDP : snat_proto;
 450   snat_proto = (ip_proto == IP_PROTOCOL_TCP) ? SNAT_PROTOCOL_TCP : snat_proto;
 451   snat_proto = (ip_proto == IP_PROTOCOL_ICMP) ? SNAT_PROTOCOL_ICMP : snat_proto;
 452   snat_proto = (ip_proto == IP_PROTOCOL_ICMP6) ? SNAT_PROTOCOL_ICMP : snat_proto;
 453
 454   return snat_proto;
 455 }
 456
 457 always_inline u8
 458 snat_proto_to_ip_proto (snat_protocol_t snat_proto)
 459 {
 460   u8 ip_proto = ~0;
 461
 462   ip_proto = (snat_proto == SNAT_PROTOCOL_UDP) ? IP_PROTOCOL_UDP : ip_proto;
 463   ip_proto = (snat_proto == SNAT_PROTOCOL_TCP) ? IP_PROTOCOL_TCP : ip_proto;
 464   ip_proto = (snat_proto == SNAT_PROTOCOL_ICMP) ? IP_PROTOCOL_ICMP : ip_proto;
 465
 466   return ip_proto;
 467 }
 468
 469 typedef struct {
 470   u16 src_port, dst_port;
 471 } tcp_udp_header_t;
 472
 473 u32 icmp_match_in2out_fast(snat_main_t *sm, vlib_node_runtime_t *node,
 474                            u32 thread_index, vlib_buffer_t *b0, u8 *p_proto,
 475                            snat_session_key_t *p_value,
 476                            u8 *p_dont_translate, void *d, void *e);
 477 u32 icmp_match_in2out_slow(snat_main_t *sm, vlib_node_runtime_t *node,
 478                            u32 thread_index, vlib_buffer_t *b0, u8 *p_proto,
 479                            snat_session_key_t *p_value,
 480                            u8 *p_dont_translate, void *d, void *e);
 481 u32 icmp_match_in2out_det(snat_main_t *sm, vlib_node_runtime_t *node,
 482                           u32 thread_index, vlib_buffer_t *b0, u8 *p_proto,
 483                           snat_session_key_t *p_value,
 484                           u8 *p_dont_translate, void *d, void *e);
 485 u32 icmp_match_out2in_fast(snat_main_t *sm, vlib_node_runtime_t *node,
 486                            u32 thread_index, vlib_buffer_t *b0, u8 *p_proto,
 487                            snat_session_key_t *p_value,
 488                            u8 *p_dont_translate, void *d, void *e);
 489 u32 icmp_match_out2in_slow(snat_main_t *sm, vlib_node_runtime_t *node,
 490                            u32 thread_index, vlib_buffer_t *b0, u8 *p_proto,
 491                            snat_session_key_t *p_value,
 492                            u8 *p_dont_translate, void *d, void *e);
 493 u32 icmp_match_out2in_det(snat_main_t *sm, vlib_node_runtime_t *node,
 494                           u32 thread_index, vlib_buffer_t *b0, u8 *p_proto,
 495                           snat_session_key_t *p_value,
 496                           u8 *p_dont_translate, void *d, void *e);
 497 void increment_v4_address(ip4_address_t * a);
 498 void snat_add_address(snat_main_t *sm, ip4_address_t *addr, u32 vrf_id);
 499 int snat_del_address(snat_main_t *sm, ip4_address_t addr, u8 delete_sm);
 500 int snat_add_static_mapping(ip4_address_t l_addr, ip4_address_t e_addr,
 501                             u16 l_port, u16 e_port, u32 vrf_id, int addr_only,
 502                             u32 sw_if_index, snat_protocol_t proto, int is_add);
 503 clib_error_t * snat_api_init(vlib_main_t * vm, snat_main_t * sm);
 504 int snat_set_workers (uword * bitmap);
 505 int snat_interface_add_del(u32 sw_if_index, u8 is_inside, int is_del);
 506 int snat_interface_add_del_output_feature(u32 sw_if_index, u8 is_inside,
 507                                           int is_del);
 508 int snat_add_interface_address(snat_main_t *sm, u32 sw_if_index, int is_del);
 509 uword unformat_snat_protocol(unformat_input_t * input, va_list * args);
 510 u8 * format_snat_protocol(u8 * s, va_list * args);
 511 int nat44_add_del_lb_static_mapping (ip4_address_t e_addr, u16 e_port,
 512                                      snat_protocol_t proto, u32 vrf_id,
 513                                      nat44_lb_addr_port_t *locals, u8 is_add);
 514
 515 static_always_inline u8
 516 icmp_is_error_message (icmp46_header_t * icmp)
 517 {
 518   switch(icmp->type)
 519     {
 520     case ICMP4_destination_unreachable:
 521     case ICMP4_time_exceeded:
 522     case ICMP4_parameter_problem:
 523     case ICMP4_source_quench:
 524     case ICMP4_redirect:
 525     case ICMP4_alternate_host_address:
 526       return 1;
 527     }
 528   return 0;
 529 }
 530
 531 static_always_inline u8
 532 is_interface_addr(snat_main_t *sm, vlib_node_runtime_t *node, u32 sw_if_index0,
 533                   u32 ip4_addr)
 534 {
 535   snat_runtime_t *rt = (snat_runtime_t *) node->runtime_data;
 536   ip4_address_t * first_int_addr;
 537
 538   if (PREDICT_FALSE(rt->cached_sw_if_index != sw_if_index0))
 539     {
 540       first_int_addr =
 541         ip4_interface_first_address (sm->ip4_main, sw_if_index0,
 542                                      0 /* just want the address */);
 543       rt->cached_sw_if_index = sw_if_index0;
 544       if (first_int_addr)
 545         rt->cached_ip4_address = first_int_addr->as_u32;
 546       else
 547         rt->cached_ip4_address = 0;
 548     }
 549
 550   if (PREDICT_FALSE(ip4_addr == rt->cached_ip4_address))
 551     return 1;
 552   else
 553     return 0;
 554 }
 555
 556 #endif /* __included_nat_h__ */