src/plugins/cnat/cnat_node_feature.c

   1 /*
   2  * Copyright (c) 2020 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 #include <vlibmemory/api.h>
  17 #include <cnat/cnat_node.h>
  18 #include <cnat/cnat_translation.h>
  19 #include <cnat/cnat_inline.h>
  20 #include <cnat/cnat_src_policy.h>
  21 #include <cnat/cnat_snat.h>
  22
  23 #include <vnet/dpo/load_balance.h>
  24 #include <vnet/dpo/load_balance_map.h>
  25
  26 #include <vnet/ip/ip4_inlines.h>
  27 #include <vnet/ip/ip6_inlines.h>
  28
  29 typedef enum cnat_feature_next_
  30 {
  31   CNAT_FEATURE_NEXT_DROP,
  32   CNAT_FEATURE_N_NEXT,
  33 } cnat_feature_next_t;
  34
  35 vlib_node_registration_t cnat_input_feature_ip4_node;
  36 vlib_node_registration_t cnat_input_feature_ip6_node;
  37 vlib_node_registration_t cnat_output_feature_ip4_node;
  38 vlib_node_registration_t cnat_output_feature_ip6_node;
  39
  40 always_inline uword
  41 cnat_input_feature_fn (vlib_main_t *vm, vlib_node_runtime_t *node,
  42                        vlib_buffer_t *b, cnat_node_ctx_t *ctx,
  43                        int session_not_found, cnat_session_t *session)
  44 {
  45   vlib_combined_counter_main_t *cntm = &cnat_translation_counters;
  46   const cnat_translation_t *ct = NULL;
  47   ip4_header_t *ip4 = NULL;
  48   ip_protocol_t iproto;
  49   ip6_header_t *ip6 = NULL;
  50   udp_header_t *udp0;
  51   cnat_client_t *cc;
  52   u32 next0;
  53   index_t cti;
  54   u8 trace_flags = 0;
  55
  56   /* By default follow arc default next */
  57   vnet_feature_next (&next0, b);
  58
  59   if (AF_IP4 == ctx->af)
  60     {
  61       ip4 = vlib_buffer_get_current (b);
  62       iproto = ip4->protocol;
  63       udp0 = (udp_header_t *) (ip4 + 1);
  64       cc = cnat_client_ip4_find (
  65         &ip4->dst_address); /* TODO do this only if no session? */
  66     }
  67   else
  68     {
  69       ip6 = vlib_buffer_get_current (b);
  70       iproto = ip6->protocol;
  71       udp0 = (udp_header_t *) (ip6 + 1);
  72       cc = cnat_client_ip6_find (&ip6->dst_address); /* TODO: same as above */
  73     }
  74
  75   /* Wrong session key */
  76   if (session->key.cs_proto == 0)
  77     goto trace;
  78
  79   if (!session_not_found)
  80     /* session table hit */
  81     cnat_timestamp_update (session->value.cs_ts_index, ctx->now);
  82   else if (!cc)
  83     goto trace; /* dst address is not a vip */
  84   else
  85     {
  86       ct = cnat_find_translation (
  87         cc->parent_cci, clib_host_to_net_u16 (udp0->dst_port), iproto);
  88       if (NULL == ct)
  89         /* Dont translate  */
  90         /* TODO: create identity session to avoid slowpath ? */
  91         goto trace;
  92
  93       /* New flow, create the sessions */
  94       const load_balance_t *lb0;
  95       cnat_ep_trk_t *trk0;
  96       u32 rsession_flags = CNAT_SESSION_FLAG_NO_CLIENT;
  97       u32 dpoi_index = -1;
  98
  99       lb0 = load_balance_get (ct->ct_lb.dpoi_index);
 100       if (!lb0->lb_n_buckets)
 101         /* Can't translate TODO: should drop / reject? */
 102         goto trace;
 103
 104       /* session table miss */
 105       trk0 = cnat_load_balance (ct, ctx->af, ip4, ip6, &dpoi_index);
 106       if (PREDICT_FALSE (NULL == trk0))
 107         {
 108           /* Dont translate & Follow the fib programming */
 109           vnet_buffer (b)->ip.adj_index[VLIB_TX] = cc->cc_parent.dpoi_index;
 110           next0 = cc->cc_parent.dpoi_next_node;
 111           goto trace;
 112         }
 113
 114       ip46_address_copy (&session->value.cs_ip[VLIB_TX],
 115                          &trk0->ct_ep[VLIB_TX].ce_ip.ip);
 116
 117       /* never source nat in this node */
 118       if (AF_IP4 == ctx->af)
 119         ip46_address_set_ip4 (&session->value.cs_ip[VLIB_RX],
 120                               &ip4->src_address);
 121       else
 122         ip46_address_set_ip6 (&session->value.cs_ip[VLIB_RX],
 123                               &ip6->src_address);
 124
 125       session->value.cs_port[VLIB_TX] =
 126         clib_host_to_net_u16 (trk0->ct_ep[VLIB_TX].ce_port);
 127       session->value.cs_port[VLIB_RX] = udp0->src_port;
 128
 129       const dpo_id_t *dpo0;
 130       const load_balance_t *lb1;
 131       fib_entry_t *fib_entry;
 132       fib_entry = fib_entry_get (trk0->ct_fei);
 133
 134       lb1 = load_balance_get (fib_entry->fe_lb /*[fct] */.dpoi_index);
 135       dpo0 = load_balance_get_bucket_i (lb1, 0);
 136
 137       session->value.dpoi_next_node = dpo0->dpoi_next_node;
 138       session->value.cs_lbi = dpo0->dpoi_index;
 139
 140       if (trk0->ct_flags & CNAT_TRK_FLAG_NO_NAT)
 141         session->value.flags |= CNAT_SESSION_FLAG_NO_NAT;
 142
 143       /* refcnt session in current client */
 144       cnat_client_cnt_session (cc);
 145       cnat_session_create (session, ctx, CNAT_LOCATION_OUTPUT, rsession_flags);
 146       trace_flags |= CNAT_TRACE_SESSION_CREATED;
 147     }
 148
 149   next0 = session->value.dpoi_next_node;
 150   vnet_buffer (b)->ip.adj_index[VLIB_TX] = session->value.cs_lbi;
 151
 152   if (session->value.flags & CNAT_SESSION_FLAG_NO_NAT)
 153     goto trace;
 154
 155   if (AF_IP4 == ctx->af)
 156     cnat_translation_ip4 (session, ip4, udp0);
 157   else
 158     cnat_translation_ip6 (session, ip6, udp0);
 159
 160   if (NULL != ct)
 161     {
 162       cti = ct - cnat_translation_pool;
 163       vlib_increment_combined_counter (cntm, ctx->thread_index, cti, 1,
 164                                        vlib_buffer_length_in_chain (vm, b));
 165     }
 166
 167 trace:
 168   if (PREDICT_FALSE (ctx->do_trace))
 169     {
 170       trace_flags |= session_not_found ? 0 : CNAT_TRACE_SESSION_FOUND;
 171       cnat_add_trace (vm, node, b, session, ct, trace_flags);
 172     }
 173   return next0;
 174 }
 175
 176 VLIB_NODE_FN (cnat_input_feature_ip4_node)
 177 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
 178 {
 179   if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
 180     return cnat_node_inline (vm, node, frame, cnat_input_feature_fn, AF_IP4,
 181                              CNAT_LOCATION_INPUT, 1 /* do_trace */);
 182   return cnat_node_inline (vm, node, frame, cnat_input_feature_fn, AF_IP4,
 183                            CNAT_LOCATION_INPUT, 0 /* do_trace */);
 184 }
 185
 186 VLIB_REGISTER_NODE (cnat_input_feature_ip4_node) = {
 187   .name = "cnat-input-ip4",
 188   .vector_size = sizeof (u32),
 189   .format_trace = format_cnat_trace,
 190   .type = VLIB_NODE_TYPE_INTERNAL,
 191   .n_errors = CNAT_N_ERROR,
 192   .error_strings = cnat_error_strings,
 193   .n_next_nodes = IP_LOOKUP_N_NEXT,
 194   .next_nodes = IP4_LOOKUP_NEXT_NODES,
 195 };
 196
 197 VNET_FEATURE_INIT (cnat_in_ip4_feature, static) = {
 198   .arc_name = "ip4-unicast",
 199   .node_name = "cnat-input-ip4",
 200   .runs_before = VNET_FEATURES ("acl-plugin-in-ip4-fa"),
 201 };
 202
 203 VLIB_NODE_FN (cnat_input_feature_ip6_node)
 204 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
 205 {
 206   if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
 207     return cnat_node_inline (vm, node, frame, cnat_input_feature_fn, AF_IP6,
 208                              CNAT_LOCATION_INPUT, 1 /* do_trace */);
 209   return cnat_node_inline (vm, node, frame, cnat_input_feature_fn, AF_IP6,
 210                            CNAT_LOCATION_INPUT, 0 /* do_trace */);
 211 }
 212
 213 VLIB_REGISTER_NODE (cnat_input_feature_ip6_node) = {
 214   .name = "cnat-input-ip6",
 215   .vector_size = sizeof (u32),
 216   .format_trace = format_cnat_trace,
 217   .type = VLIB_NODE_TYPE_INTERNAL,
 218   .n_errors = CNAT_N_ERROR,
 219   .error_strings = cnat_error_strings,
 220   .n_next_nodes = CNAT_FEATURE_N_NEXT,
 221   .next_nodes = {
 222       [CNAT_FEATURE_NEXT_DROP] = "error-drop",
 223   },
 224 };
 225
 226 VNET_FEATURE_INIT (cnat_in_ip6_feature, static) = {
 227   .arc_name = "ip6-unicast",
 228   .node_name = "cnat-input-ip6",
 229   .runs_before = VNET_FEATURES ("acl-plugin-in-ip6-fa"),
 230 };
 231
 232 /* output feature node, creates snat sessions when required and
 233  * translates back for existing sessions */
 234 always_inline uword
 235 cnat_output_feature_fn (vlib_main_t *vm, vlib_node_runtime_t *node,
 236                         vlib_buffer_t *b, cnat_node_ctx_t *ctx,
 237                         int session_not_found, cnat_session_t *session)
 238 {
 239   cnat_main_t *cm = &cnat_main;
 240   cnat_snat_policy_main_t *cms = &cnat_snat_policy_main;
 241   ip4_header_t *ip4 = NULL;
 242   ip_protocol_t iproto;
 243   ip6_header_t *ip6 = NULL;
 244   udp_header_t *udp0;
 245   u32 iph_offset = 0;
 246   u32 next0;
 247   u16 sport;
 248   u8 do_snat = 0;
 249   u8 trace_flags = 0;
 250   int rv;
 251
 252   /* By default follow arc default next */
 253   vnet_feature_next (&next0, b);
 254   iph_offset = vnet_buffer (b)->ip.save_rewrite_length;
 255
 256   if (AF_IP4 == ctx->af)
 257     {
 258       ip4 = (ip4_header_t *) ((u8 *) vlib_buffer_get_current (b) + iph_offset);
 259       iproto = ip4->protocol;
 260       udp0 = (udp_header_t *) (ip4 + 1);
 261     }
 262   else
 263     {
 264       ip6 = (ip6_header_t *) ((u8 *) vlib_buffer_get_current (b) + iph_offset);
 265       iproto = ip6->protocol;
 266       udp0 = (udp_header_t *) (ip6 + 1);
 267     }
 268
 269   /* Wrong session key */
 270   if (session->key.cs_proto == 0)
 271     goto trace;
 272
 273   if (!session_not_found)
 274     {
 275       /* session table hit */
 276       cnat_timestamp_update (session->value.cs_ts_index, ctx->now);
 277     }
 278   else if (!cms->snat_policy)
 279     goto trace;
 280   else
 281     {
 282       /* TODO: handle errors? */
 283       cms->snat_policy (vm, b, session, ctx, &do_snat);
 284       if (do_snat != 1)
 285         goto trace;
 286
 287       if (AF_IP4 == ctx->af)
 288         {
 289           if (ip_address_is_zero (&cm->snat_ip4.ce_ip))
 290             goto trace;
 291
 292           ip46_address_set_ip4 (&session->value.cs_ip[VLIB_RX],
 293                                 &ip_addr_v4 (&cm->snat_ip4.ce_ip));
 294           ip46_address_set_ip4 (&session->value.cs_ip[VLIB_TX],
 295                                 &ip4->dst_address);
 296         }
 297       else
 298         {
 299           if (ip_address_is_zero (&cm->snat_ip6.ce_ip))
 300             goto trace;
 301
 302           ip46_address_set_ip6 (&session->value.cs_ip[VLIB_RX],
 303                                 &ip_addr_v6 (&cm->snat_ip6.ce_ip));
 304           ip46_address_set_ip6 (&session->value.cs_ip[VLIB_TX],
 305                                 &ip6->dst_address);
 306         }
 307       sport = 0;
 308       rv = cnat_allocate_port (&sport, iproto);
 309       if (rv)
 310         {
 311           vlib_node_increment_counter (vm, cnat_output_feature_ip6_node.index,
 312                                        CNAT_ERROR_EXHAUSTED_PORTS, 1);
 313           next0 = CNAT_FEATURE_NEXT_DROP;
 314           goto trace;
 315         }
 316       session->value.cs_port[VLIB_RX] = sport;
 317       session->value.cs_port[VLIB_TX] = sport;
 318       if (iproto == IP_PROTOCOL_TCP || iproto == IP_PROTOCOL_UDP)
 319         session->value.cs_port[VLIB_TX] = udp0->dst_port;
 320
 321       session->value.cs_lbi = INDEX_INVALID;
 322       session->value.flags =
 323         CNAT_SESSION_FLAG_NO_CLIENT | CNAT_SESSION_FLAG_ALLOC_PORT;
 324
 325       trace_flags |= CNAT_TRACE_SESSION_CREATED;
 326       cnat_session_create (session, ctx, CNAT_LOCATION_INPUT,
 327                            CNAT_SESSION_FLAG_NO_CLIENT);
 328     }
 329
 330   if (AF_IP4 == ctx->af)
 331     cnat_translation_ip4 (session, ip4, udp0);
 332   else
 333     cnat_translation_ip6 (session, ip6, udp0);
 334
 335 trace:
 336   if (PREDICT_FALSE (ctx->do_trace))
 337     {
 338       trace_flags |= do_snat ? 0 : CNAT_TRACE_NO_NAT;
 339       trace_flags |= session_not_found ? 0 : CNAT_TRACE_SESSION_FOUND;
 340       cnat_add_trace (vm, node, b, session, NULL, trace_flags);
 341     }
 342   return next0;
 343 }
 344
 345 VLIB_NODE_FN (cnat_output_feature_ip4_node)
 346 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
 347 {
 348   if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
 349     return cnat_node_inline (vm, node, frame, cnat_output_feature_fn, AF_IP4,
 350                              CNAT_LOCATION_OUTPUT, 1 /* do_trace */);
 351   return cnat_node_inline (vm, node, frame, cnat_output_feature_fn, AF_IP4,
 352                            CNAT_LOCATION_OUTPUT, 0 /* do_trace */);
 353 }
 354
 355 VLIB_REGISTER_NODE (cnat_output_feature_ip4_node) = {
 356   .name = "cnat-output-ip4",
 357   .vector_size = sizeof (u32),
 358   .format_trace = format_cnat_trace,
 359   .type = VLIB_NODE_TYPE_INTERNAL,
 360   .n_errors = CNAT_N_ERROR,
 361   .error_strings = cnat_error_strings,
 362   .n_next_nodes = CNAT_FEATURE_N_NEXT,
 363   .next_nodes = {
 364       [CNAT_FEATURE_NEXT_DROP] = "error-drop",
 365   },
 366 };
 367
 368 VNET_FEATURE_INIT (cnat_out_ip4_feature, static) = {
 369   .arc_name = "ip4-output",
 370   .node_name = "cnat-output-ip4",
 371   .runs_before = VNET_FEATURES ("gso-ip4"),
 372   .runs_after = VNET_FEATURES ("acl-plugin-out-ip4-fa"),
 373 };
 374
 375 VLIB_NODE_FN (cnat_output_feature_ip6_node)
 376 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
 377 {
 378   if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
 379     return cnat_node_inline (vm, node, frame, cnat_output_feature_fn, AF_IP6,
 380                              CNAT_LOCATION_OUTPUT, 1 /* do_trace */);
 381   return cnat_node_inline (vm, node, frame, cnat_output_feature_fn, AF_IP6,
 382                            CNAT_LOCATION_OUTPUT, 0 /* do_trace */);
 383 }
 384
 385 VLIB_REGISTER_NODE (cnat_output_feature_ip6_node) = {
 386   .name = "cnat-output-ip6",
 387   .vector_size = sizeof (u32),
 388   .format_trace = format_cnat_trace,
 389   .type = VLIB_NODE_TYPE_INTERNAL,
 390   .n_errors = CNAT_N_ERROR,
 391   .error_strings = cnat_error_strings,
 392   .n_next_nodes = CNAT_FEATURE_N_NEXT,
 393   .next_nodes = {
 394       [CNAT_FEATURE_NEXT_DROP] = "error-drop",
 395   },
 396 };
 397
 398 VNET_FEATURE_INIT (cnat_out_ip6_feature, static) = {
 399   .arc_name = "ip6-output",
 400   .node_name = "cnat-output-ip6",
 401   .runs_before = VNET_FEATURES ("gso-ip6"),
 402   .runs_after = VNET_FEATURES ("acl-plugin-out-ip6-fa"),
 403 };
 404
 405 /*
 406  * fd.io coding-style-patch-verification: ON
 407  *
 408  * Local Variables:
 409  * eval: (c-set-style "gnu")
 410  * End:
 411  */