src/plugins/snat/snat.h

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