src/plugins/nat/nat_inlines.h

   1 /*
   2  * Copyright (c) 2018 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  * @brief The NAT inline functions
  17  */
  18
  19 #ifndef __included_nat_inlines_h__
  20 #define __included_nat_inlines_h__
  21
  22 #include <vnet/fib/ip4_fib.h>
  23 #include <nat/nat.h>
  24 #include <nat/nat_ha.h>
  25
  26 always_inline u32
  27 ip_proto_to_snat_proto (u8 ip_proto)
  28 {
  29   u32 snat_proto = ~0;
  30
  31   snat_proto = (ip_proto == IP_PROTOCOL_UDP) ? SNAT_PROTOCOL_UDP : snat_proto;
  32   snat_proto = (ip_proto == IP_PROTOCOL_TCP) ? SNAT_PROTOCOL_TCP : snat_proto;
  33   snat_proto =
  34     (ip_proto == IP_PROTOCOL_ICMP) ? SNAT_PROTOCOL_ICMP : snat_proto;
  35   snat_proto =
  36     (ip_proto == IP_PROTOCOL_ICMP6) ? SNAT_PROTOCOL_ICMP : snat_proto;
  37
  38   return snat_proto;
  39 }
  40
  41 always_inline u8
  42 snat_proto_to_ip_proto (snat_protocol_t snat_proto)
  43 {
  44   u8 ip_proto = ~0;
  45
  46   ip_proto = (snat_proto == SNAT_PROTOCOL_UDP) ? IP_PROTOCOL_UDP : ip_proto;
  47   ip_proto = (snat_proto == SNAT_PROTOCOL_TCP) ? IP_PROTOCOL_TCP : ip_proto;
  48   ip_proto = (snat_proto == SNAT_PROTOCOL_ICMP) ? IP_PROTOCOL_ICMP : ip_proto;
  49
  50   return ip_proto;
  51 }
  52
  53 static_always_inline u8
  54 icmp_is_error_message (icmp46_header_t * icmp)
  55 {
  56   switch (icmp->type)
  57     {
  58     case ICMP4_destination_unreachable:
  59     case ICMP4_time_exceeded:
  60     case ICMP4_parameter_problem:
  61     case ICMP4_source_quench:
  62     case ICMP4_redirect:
  63     case ICMP4_alternate_host_address:
  64       return 1;
  65     }
  66   return 0;
  67 }
  68
  69 always_inline u8
  70 is_interface_addr (snat_main_t * sm, vlib_node_runtime_t * node,
  71                    u32 sw_if_index0, u32 ip4_addr)
  72 {
  73   snat_runtime_t *rt = (snat_runtime_t *) node->runtime_data;
  74   ip4_address_t *first_int_addr;
  75
  76   if (PREDICT_FALSE (rt->cached_sw_if_index != sw_if_index0))
  77     {
  78       first_int_addr =
  79         ip4_interface_first_address (sm->ip4_main, sw_if_index0,
  80                                      0 /* just want the address */ );
  81       rt->cached_sw_if_index = sw_if_index0;
  82       if (first_int_addr)
  83         rt->cached_ip4_address = first_int_addr->as_u32;
  84       else
  85         rt->cached_ip4_address = 0;
  86     }
  87
  88   if (PREDICT_FALSE (ip4_addr == rt->cached_ip4_address))
  89     return 1;
  90   else
  91     return 0;
  92 }
  93
  94 always_inline u8
  95 maximum_sessions_exceeded (snat_main_t * sm, u32 thread_index)
  96 {
  97   if (pool_elts (sm->per_thread_data[thread_index].sessions) >=
  98       sm->max_translations)
  99     return 1;
 100
 101   return 0;
 102 }
 103
 104 always_inline void
 105 nat_send_all_to_node (vlib_main_t * vm, u32 * bi_vector,
 106                       vlib_node_runtime_t * node, vlib_error_t * error,
 107                       u32 next)
 108 {
 109   u32 n_left_from, *from, next_index, *to_next, n_left_to_next;
 110
 111   from = bi_vector;
 112   n_left_from = vec_len (bi_vector);
 113   next_index = node->cached_next_index;
 114   while (n_left_from > 0)
 115     {
 116       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 117       while (n_left_from > 0 && n_left_to_next > 0)
 118         {
 119           u32 bi0 = to_next[0] = from[0];
 120           from += 1;
 121           n_left_from -= 1;
 122           to_next += 1;
 123           n_left_to_next -= 1;
 124           vlib_buffer_t *p0 = vlib_get_buffer (vm, bi0);
 125           if (error)
 126             p0->error = *error;
 127           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
 128                                            n_left_to_next, bi0, next);
 129         }
 130       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 131     }
 132 }
 133
 134 always_inline void
 135 user_session_increment (snat_main_t * sm, snat_user_t * u, u8 is_static)
 136 {
 137   if (u->nsessions + u->nstaticsessions < sm->max_translations_per_user)
 138     {
 139       if (is_static)
 140         u->nstaticsessions++;
 141       else
 142         u->nsessions++;
 143     }
 144 }
 145
 146 always_inline void
 147 nat44_delete_user_with_no_session (snat_main_t * sm, snat_user_t * u,
 148                                    u32 thread_index)
 149 {
 150   clib_bihash_kv_8_8_t kv;
 151   snat_user_key_t u_key;
 152   snat_main_per_thread_data_t *tsm = vec_elt_at_index (sm->per_thread_data,
 153                                                        thread_index);
 154
 155   if (u->nstaticsessions == 0 && u->nsessions == 0)
 156     {
 157       u_key.addr.as_u32 = u->addr.as_u32;
 158       u_key.fib_index = u->fib_index;
 159       kv.key = u_key.as_u64;
 160       pool_put_index (tsm->list_pool, u->sessions_per_user_list_head_index);
 161       pool_put (tsm->users, u);
 162       clib_bihash_add_del_8_8 (&tsm->user_hash, &kv, 0);
 163       vlib_set_simple_counter (&sm->total_users, thread_index, 0,
 164                                pool_elts (tsm->users));
 165     }
 166 }
 167
 168 always_inline void
 169 nat44_delete_session (snat_main_t * sm, snat_session_t * ses,
 170                       u32 thread_index)
 171 {
 172   snat_main_per_thread_data_t *tsm = vec_elt_at_index (sm->per_thread_data,
 173                                                        thread_index);
 174   clib_bihash_kv_8_8_t kv, value;
 175   snat_user_key_t u_key;
 176   snat_user_t *u;
 177
 178   clib_dlist_remove (tsm->list_pool, ses->per_user_index);
 179   pool_put_index (tsm->list_pool, ses->per_user_index);
 180   pool_put (tsm->sessions, ses);
 181   vlib_set_simple_counter (&sm->total_sessions, thread_index, 0,
 182                            pool_elts (tsm->sessions));
 183
 184   u_key.addr = ses->in2out.addr;
 185   u_key.fib_index = ses->in2out.fib_index;
 186   kv.key = u_key.as_u64;
 187   if (!clib_bihash_search_8_8 (&tsm->user_hash, &kv, &value))
 188     {
 189       u = pool_elt_at_index (tsm->users, value.value);
 190       if (snat_is_session_static (ses))
 191         u->nstaticsessions--;
 192       else
 193         u->nsessions--;
 194
 195       nat44_delete_user_with_no_session (sm, u, thread_index);
 196     }
 197 }
 198
 199 /** \brief Set TCP session state.
 200     @return 1 if session was closed, otherwise 0
 201 */
 202 always_inline int
 203 nat44_set_tcp_session_state_i2o (snat_main_t * sm, snat_session_t * ses,
 204                                  tcp_header_t * tcp, u32 thread_index)
 205 {
 206   if ((ses->state == 0) && (tcp->flags & TCP_FLAG_RST))
 207     ses->state = NAT44_SES_RST;
 208   if ((ses->state == NAT44_SES_RST) && !(tcp->flags & TCP_FLAG_RST))
 209     ses->state = 0;
 210   if ((tcp->flags & TCP_FLAG_ACK) && (ses->state & NAT44_SES_I2O_SYN) &&
 211       (ses->state & NAT44_SES_O2I_SYN))
 212     ses->state = 0;
 213   if (tcp->flags & TCP_FLAG_SYN)
 214     ses->state |= NAT44_SES_I2O_SYN;
 215   if (tcp->flags & TCP_FLAG_FIN)
 216     {
 217       ses->i2o_fin_seq = clib_net_to_host_u32 (tcp->seq_number);
 218       ses->state |= NAT44_SES_I2O_FIN;
 219     }
 220   if ((tcp->flags & TCP_FLAG_ACK) && (ses->state & NAT44_SES_O2I_FIN))
 221     {
 222       if (clib_net_to_host_u32 (tcp->ack_number) > ses->o2i_fin_seq)
 223         ses->state |= NAT44_SES_O2I_FIN_ACK;
 224     }
 225   if (nat44_is_ses_closed (ses)
 226       && !(ses->flags & SNAT_SESSION_FLAG_OUTPUT_FEATURE))
 227     {
 228       nat_free_session_data (sm, ses, thread_index, 0);
 229       nat44_delete_session (sm, ses, thread_index);
 230       return 1;
 231     }
 232   return 0;
 233 }
 234
 235 always_inline int
 236 nat44_set_tcp_session_state_o2i (snat_main_t * sm, snat_session_t * ses,
 237                                  tcp_header_t * tcp, u32 thread_index)
 238 {
 239   if ((ses->state == 0) && (tcp->flags & TCP_FLAG_RST))
 240     ses->state = NAT44_SES_RST;
 241   if ((ses->state == NAT44_SES_RST) && !(tcp->flags & TCP_FLAG_RST))
 242     ses->state = 0;
 243   if ((tcp->flags & TCP_FLAG_ACK) && (ses->state & NAT44_SES_I2O_SYN) &&
 244       (ses->state & NAT44_SES_O2I_SYN))
 245     ses->state = 0;
 246   if (tcp->flags & TCP_FLAG_SYN)
 247     ses->state |= NAT44_SES_O2I_SYN;
 248   if (tcp->flags & TCP_FLAG_FIN)
 249     {
 250       ses->o2i_fin_seq = clib_net_to_host_u32 (tcp->seq_number);
 251       ses->state |= NAT44_SES_O2I_FIN;
 252     }
 253   if ((tcp->flags & TCP_FLAG_ACK) && (ses->state & NAT44_SES_I2O_FIN))
 254     {
 255       if (clib_net_to_host_u32 (tcp->ack_number) > ses->i2o_fin_seq)
 256         ses->state |= NAT44_SES_I2O_FIN_ACK;
 257     }
 258   if (nat44_is_ses_closed (ses))
 259     {
 260       nat_free_session_data (sm, ses, thread_index, 0);
 261       nat44_delete_session (sm, ses, thread_index);
 262       return 1;
 263     }
 264   return 0;
 265 }
 266
 267 always_inline u32
 268 nat44_session_get_timeout (snat_main_t * sm, snat_session_t * s)
 269 {
 270   switch (s->in2out.protocol)
 271     {
 272     case SNAT_PROTOCOL_ICMP:
 273       return sm->icmp_timeout;
 274     case SNAT_PROTOCOL_UDP:
 275       return sm->udp_timeout;
 276     case SNAT_PROTOCOL_TCP:
 277       {
 278         if (s->state)
 279           return sm->tcp_transitory_timeout;
 280         else
 281           return sm->tcp_established_timeout;
 282       }
 283     default:
 284       return sm->udp_timeout;
 285     }
 286
 287   return 0;
 288 }
 289
 290 always_inline void
 291 nat44_session_update_counters (snat_session_t * s, f64 now, uword bytes,
 292                                u32 thread_index)
 293 {
 294   s->last_heard = now;
 295   s->total_pkts++;
 296   s->total_bytes += bytes;
 297   nat_ha_sref (&s->out2in.addr, s->out2in.port, &s->ext_host_addr,
 298                s->ext_host_port, s->out2in.protocol, s->out2in.fib_index,
 299                s->total_pkts, s->total_bytes, thread_index,
 300                &s->ha_last_refreshed, now);
 301 }
 302
 303 /** \brief Per-user LRU list maintenance */
 304 always_inline void
 305 nat44_session_update_lru (snat_main_t * sm, snat_session_t * s,
 306                           u32 thread_index)
 307 {
 308   clib_dlist_remove (sm->per_thread_data[thread_index].list_pool,
 309                      s->per_user_index);
 310   clib_dlist_addtail (sm->per_thread_data[thread_index].list_pool,
 311                       s->per_user_list_head_index, s->per_user_index);
 312 }
 313
 314 always_inline void
 315 make_ed_kv (clib_bihash_kv_16_8_t * kv, ip4_address_t * l_addr,
 316             ip4_address_t * r_addr, u8 proto, u32 fib_index, u16 l_port,
 317             u16 r_port)
 318 {
 319   nat_ed_ses_key_t *key = (nat_ed_ses_key_t *) kv->key;
 320
 321   key->l_addr.as_u32 = l_addr->as_u32;
 322   key->r_addr.as_u32 = r_addr->as_u32;
 323   key->fib_index = fib_index;
 324   key->proto = proto;
 325   key->l_port = l_port;
 326   key->r_port = r_port;
 327
 328   kv->value = ~0ULL;
 329 }
 330
 331 always_inline void
 332 make_sm_kv (clib_bihash_kv_8_8_t * kv, ip4_address_t * addr, u8 proto,
 333             u32 fib_index, u16 port)
 334 {
 335   snat_session_key_t key;
 336
 337   key.addr.as_u32 = addr->as_u32;
 338   key.port = port;
 339   key.protocol = proto;
 340   key.fib_index = fib_index;
 341
 342   kv->key = key.as_u64;
 343   kv->value = ~0ULL;
 344 }
 345
 346 static_always_inline int
 347 get_icmp_i2o_ed_key (ip4_header_t * ip0, nat_ed_ses_key_t * p_key0)
 348 {
 349   icmp46_header_t *icmp0;
 350   nat_ed_ses_key_t key0;
 351   icmp_echo_header_t *echo0, *inner_echo0 = 0;
 352   ip4_header_t *inner_ip0 = 0;
 353   void *l4_header = 0;
 354   icmp46_header_t *inner_icmp0;
 355
 356   icmp0 = (icmp46_header_t *) ip4_next_header (ip0);
 357   echo0 = (icmp_echo_header_t *) (icmp0 + 1);
 358
 359   if (!icmp_is_error_message (icmp0))
 360     {
 361       key0.proto = IP_PROTOCOL_ICMP;
 362       key0.l_addr = ip0->src_address;
 363       key0.r_addr = ip0->dst_address;
 364       key0.l_port = echo0->identifier;
 365       key0.r_port = 0;
 366     }
 367   else
 368     {
 369       inner_ip0 = (ip4_header_t *) (echo0 + 1);
 370       l4_header = ip4_next_header (inner_ip0);
 371       key0.proto = inner_ip0->protocol;
 372       key0.r_addr = inner_ip0->src_address;
 373       key0.l_addr = inner_ip0->dst_address;
 374       switch (ip_proto_to_snat_proto (inner_ip0->protocol))
 375         {
 376         case SNAT_PROTOCOL_ICMP:
 377           inner_icmp0 = (icmp46_header_t *) l4_header;
 378           inner_echo0 = (icmp_echo_header_t *) (inner_icmp0 + 1);
 379           key0.r_port = 0;
 380           key0.l_port = inner_echo0->identifier;
 381           break;
 382         case SNAT_PROTOCOL_UDP:
 383         case SNAT_PROTOCOL_TCP:
 384           key0.l_port = ((tcp_udp_header_t *) l4_header)->dst_port;
 385           key0.r_port = ((tcp_udp_header_t *) l4_header)->src_port;
 386           break;
 387         default:
 388           return NAT_IN2OUT_ED_ERROR_UNSUPPORTED_PROTOCOL;
 389         }
 390     }
 391   *p_key0 = key0;
 392   return 0;
 393 }
 394
 395
 396 static_always_inline int
 397 get_icmp_o2i_ed_key (ip4_header_t * ip0, nat_ed_ses_key_t * p_key0)
 398 {
 399   icmp46_header_t *icmp0;
 400   nat_ed_ses_key_t key0;
 401   icmp_echo_header_t *echo0, *inner_echo0 = 0;
 402   ip4_header_t *inner_ip0;
 403   void *l4_header = 0;
 404   icmp46_header_t *inner_icmp0;
 405
 406   icmp0 = (icmp46_header_t *) ip4_next_header (ip0);
 407   echo0 = (icmp_echo_header_t *) (icmp0 + 1);
 408
 409   if (!icmp_is_error_message (icmp0))
 410     {
 411       key0.proto = IP_PROTOCOL_ICMP;
 412       key0.l_addr = ip0->dst_address;
 413       key0.r_addr = ip0->src_address;
 414       key0.l_port = echo0->identifier;
 415       key0.r_port = 0;
 416     }
 417   else
 418     {
 419       inner_ip0 = (ip4_header_t *) (echo0 + 1);
 420       l4_header = ip4_next_header (inner_ip0);
 421       key0.proto = inner_ip0->protocol;
 422       key0.l_addr = inner_ip0->src_address;
 423       key0.r_addr = inner_ip0->dst_address;
 424       switch (ip_proto_to_snat_proto (inner_ip0->protocol))
 425         {
 426         case SNAT_PROTOCOL_ICMP:
 427           inner_icmp0 = (icmp46_header_t *) l4_header;
 428           inner_echo0 = (icmp_echo_header_t *) (inner_icmp0 + 1);
 429           key0.l_port = inner_echo0->identifier;
 430           key0.r_port = 0;
 431           break;
 432         case SNAT_PROTOCOL_UDP:
 433         case SNAT_PROTOCOL_TCP:
 434           key0.l_port = ((tcp_udp_header_t *) l4_header)->src_port;
 435           key0.r_port = ((tcp_udp_header_t *) l4_header)->dst_port;
 436           break;
 437         default:
 438           return -1;
 439         }
 440     }
 441   *p_key0 = key0;
 442   return 0;
 443 }
 444
 445 always_inline void
 446 mss_clamping (snat_main_t * sm, tcp_header_t * tcp, ip_csum_t * sum)
 447 {
 448   u8 *data;
 449   u8 opt_len, opts_len, kind;
 450   u16 mss;
 451
 452   if (!(sm->mss_clamping && tcp_syn (tcp)))
 453     return;
 454
 455   opts_len = (tcp_doff (tcp) << 2) - sizeof (tcp_header_t);
 456   data = (u8 *) (tcp + 1);
 457   for (; opts_len > 0; opts_len -= opt_len, data += opt_len)
 458     {
 459       kind = data[0];
 460
 461       if (kind == TCP_OPTION_EOL)
 462         break;
 463       else if (kind == TCP_OPTION_NOOP)
 464         {
 465           opt_len = 1;
 466           continue;
 467         }
 468       else
 469         {
 470           if (opts_len < 2)
 471             return;
 472           opt_len = data[1];
 473
 474           if (opt_len < 2 || opt_len > opts_len)
 475             return;
 476         }
 477
 478       if (kind == TCP_OPTION_MSS)
 479         {
 480           mss = *(u16 *) (data + 2);
 481           if (clib_net_to_host_u16 (mss) > sm->mss_clamping)
 482             {
 483               *sum =
 484                 ip_csum_update (*sum, mss, sm->mss_value_net, ip4_header_t,
 485                                 length);
 486               clib_memcpy_fast (data + 2, &sm->mss_value_net, 2);
 487             }
 488           return;
 489         }
 490     }
 491 }
 492
 493 /**
 494  * @brief Check if packet should be translated
 495  *
 496  * Packets aimed at outside interface and external address with active session
 497  * should be translated.
 498  *
 499  * @param sm            NAT main
 500  * @param rt            NAT runtime data
 501  * @param sw_if_index0  index of the inside interface
 502  * @param ip0           IPv4 header
 503  * @param proto0        NAT protocol
 504  * @param rx_fib_index0 RX FIB index
 505  *
 506  * @returns 0 if packet should be translated otherwise 1
 507  */
 508 static inline int
 509 snat_not_translate_fast (snat_main_t * sm, vlib_node_runtime_t * node,
 510                          u32 sw_if_index0, ip4_header_t * ip0, u32 proto0,
 511                          u32 rx_fib_index0)
 512 {
 513   if (sm->out2in_dpo)
 514     return 0;
 515
 516   fib_node_index_t fei = FIB_NODE_INDEX_INVALID;
 517   nat_outside_fib_t *outside_fib;
 518   fib_prefix_t pfx = {
 519     .fp_proto = FIB_PROTOCOL_IP4,
 520     .fp_len = 32,
 521     .fp_addr = {
 522                 .ip4.as_u32 = ip0->dst_address.as_u32,
 523                 }
 524     ,
 525   };
 526
 527   /* Don't NAT packet aimed at the intfc address */
 528   if (PREDICT_FALSE (is_interface_addr (sm, node, sw_if_index0,
 529                                         ip0->dst_address.as_u32)))
 530     return 1;
 531
 532   fei = fib_table_lookup (rx_fib_index0, &pfx);
 533   if (FIB_NODE_INDEX_INVALID != fei)
 534     {
 535       u32 sw_if_index = fib_entry_get_resolving_interface (fei);
 536       if (sw_if_index == ~0)
 537         {
 538           vec_foreach (outside_fib, sm->outside_fibs)
 539           {
 540             fei = fib_table_lookup (outside_fib->fib_index, &pfx);
 541             if (FIB_NODE_INDEX_INVALID != fei)
 542               {
 543                 sw_if_index = fib_entry_get_resolving_interface (fei);
 544                 if (sw_if_index != ~0)
 545                   break;
 546               }
 547           }
 548         }
 549       if (sw_if_index == ~0)
 550         return 1;
 551
 552       snat_interface_t *i;
 553       pool_foreach (i, sm->interfaces, (
 554                                          {
 555                                          /* NAT packet aimed at outside interface */
 556                                          if ((nat_interface_is_outside (i))
 557                                              && (sw_if_index ==
 558                                                  i->sw_if_index)) return 0;}
 559                     ));
 560     }
 561
 562   return 1;
 563 }
 564
 565 #endif /* __included_nat_inlines_h__ */
 566
 567 /*
 568  * fd.io coding-style-patch-verification: ON
 569  *
 570  * Local Variables:
 571  * eval: (c-set-style "gnu")
 572  * End:
 573  */