src/vnet/ipsec/ipsec_output.c

   1 /*
   2  * ipsec_output.c : IPSec output node
   3  *
   4  * Copyright (c) 2015 Cisco and/or its affiliates.
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #include <vnet/vnet.h>
  19 #include <vnet/api_errno.h>
  20 #include <vnet/ip/ip.h>
  21
  22 #include <vnet/ipsec/ipsec.h>
  23
  24 #if WITH_LIBSSL > 0
  25
  26 #define foreach_ipsec_output_error                   \
  27  _(RX_PKTS, "IPSec pkts received")                   \
  28  _(POLICY_DISCARD, "IPSec policy discard")           \
  29  _(POLICY_NO_MATCH, "IPSec policy (no match)")       \
  30  _(POLICY_PROTECT, "IPSec policy protect")           \
  31  _(POLICY_BYPASS, "IPSec policy bypass")             \
  32  _(ENCAPS_FAILED, "IPSec encapsulation failed")
  33
  34 typedef enum
  35 {
  36 #define _(sym,str) IPSEC_OUTPUT_ERROR_##sym,
  37   foreach_ipsec_output_error
  38 #undef _
  39     IPSEC_DECAP_N_ERROR,
  40 } ipsec_output_error_t;
  41
  42 static char *ipsec_output_error_strings[] = {
  43 #define _(sym,string) string,
  44   foreach_ipsec_output_error
  45 #undef _
  46 };
  47
  48 typedef struct
  49 {
  50   u32 spd_id;
  51   u32 policy_id;
  52 } ipsec_output_trace_t;
  53
  54 /* packet trace format function */
  55 static u8 *
  56 format_ipsec_output_trace (u8 * s, va_list * args)
  57 {
  58   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  59   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  60   ipsec_output_trace_t *t = va_arg (*args, ipsec_output_trace_t *);
  61
  62   s = format (s, "spd %u policy %d", t->spd_id, t->policy_id);
  63
  64   return s;
  65 }
  66
  67 always_inline ipsec_policy_t *
  68 ipsec_output_policy_match (ipsec_spd_t * spd, u8 pr, u32 la, u32 ra, u16 lp,
  69                            u16 rp)
  70 {
  71   ipsec_main_t *im = &ipsec_main;
  72   ipsec_policy_t *p;
  73   u32 *i;
  74
  75   if (!spd)
  76     return 0;
  77
  78   vec_foreach (i, spd->policies[IPSEC_SPD_POLICY_IP4_OUTBOUND])
  79   {
  80     p = pool_elt_at_index (im->policies, *i);
  81     if (PREDICT_FALSE (p->protocol && (p->protocol != pr)))
  82       continue;
  83
  84     if (ra < clib_net_to_host_u32 (p->raddr.start.ip4.as_u32))
  85       continue;
  86
  87     if (ra > clib_net_to_host_u32 (p->raddr.stop.ip4.as_u32))
  88       continue;
  89
  90     if (la < clib_net_to_host_u32 (p->laddr.start.ip4.as_u32))
  91       continue;
  92
  93     if (la > clib_net_to_host_u32 (p->laddr.stop.ip4.as_u32))
  94       continue;
  95
  96     if (PREDICT_FALSE
  97         ((pr != IP_PROTOCOL_TCP) && (pr != IP_PROTOCOL_UDP)
  98          && (pr != IP_PROTOCOL_SCTP)))
  99       return p;
 100
 101     if (lp < p->lport.start)
 102       continue;
 103
 104     if (lp > p->lport.stop)
 105       continue;
 106
 107     if (rp < p->rport.start)
 108       continue;
 109
 110     if (rp > p->rport.stop)
 111       continue;
 112
 113     return p;
 114   }
 115   return 0;
 116 }
 117
 118 always_inline uword
 119 ip6_addr_match_range (ip6_address_t * a, ip6_address_t * la,
 120                       ip6_address_t * ua)
 121 {
 122   if ((memcmp (a->as_u64, la->as_u64, 2 * sizeof (u64)) >= 0) &&
 123       (memcmp (a->as_u64, ua->as_u64, 2 * sizeof (u64)) <= 0))
 124     return 1;
 125   return 0;
 126 }
 127
 128 always_inline ipsec_policy_t *
 129 ipsec6_output_policy_match (ipsec_spd_t * spd,
 130                             ip6_address_t * la,
 131                             ip6_address_t * ra, u16 lp, u16 rp, u8 pr)
 132 {
 133   ipsec_main_t *im = &ipsec_main;
 134   ipsec_policy_t *p;
 135   u32 *i;
 136
 137   if (!spd)
 138     return 0;
 139
 140   vec_foreach (i, spd->policies[IPSEC_SPD_POLICY_IP6_OUTBOUND])
 141   {
 142     p = pool_elt_at_index (im->policies, *i);
 143     if (PREDICT_FALSE (p->protocol && (p->protocol != pr)))
 144       continue;
 145
 146     if (!ip6_addr_match_range (ra, &p->raddr.start.ip6, &p->raddr.stop.ip6))
 147       continue;
 148
 149     if (!ip6_addr_match_range (la, &p->laddr.start.ip6, &p->laddr.stop.ip6))
 150       continue;
 151
 152     if (PREDICT_FALSE
 153         ((pr != IP_PROTOCOL_TCP) && (pr != IP_PROTOCOL_UDP)
 154          && (pr != IP_PROTOCOL_SCTP)))
 155       return p;
 156
 157     if (lp < p->lport.start)
 158       continue;
 159
 160     if (lp > p->lport.stop)
 161       continue;
 162
 163     if (rp < p->rport.start)
 164       continue;
 165
 166     if (rp > p->rport.stop)
 167       continue;
 168
 169     return p;
 170   }
 171
 172   return 0;
 173 }
 174
 175 static inline uword
 176 ipsec_output_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
 177                      vlib_frame_t * from_frame, int is_ipv6)
 178 {
 179   ipsec_main_t *im = &ipsec_main;
 180
 181   u32 *from, *to_next = 0, thread_index;
 182   u32 n_left_from, sw_if_index0, last_sw_if_index = (u32) ~ 0;
 183   u32 next_node_index = (u32) ~ 0, last_next_node_index = (u32) ~ 0;
 184   vlib_frame_t *f = 0;
 185   u32 spd_index0 = ~0;
 186   ipsec_spd_t *spd0 = 0;
 187   int bogus;
 188   u64 nc_protect = 0, nc_bypass = 0, nc_discard = 0, nc_nomatch = 0;
 189
 190   from = vlib_frame_vector_args (from_frame);
 191   n_left_from = from_frame->n_vectors;
 192   thread_index = vm->thread_index;
 193
 194   while (n_left_from > 0)
 195     {
 196       u32 bi0, pi0;
 197       vlib_buffer_t *b0;
 198       ipsec_policy_t *p0;
 199       ip4_header_t *ip0;
 200       ip6_header_t *ip6_0 = 0;
 201       udp_header_t *udp0;
 202       u32 iph_offset = 0;
 203       tcp_header_t *tcp0;
 204       u64 bytes0;
 205
 206       bi0 = from[0];
 207       b0 = vlib_get_buffer (vm, bi0);
 208       sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
 209       iph_offset = vnet_buffer (b0)->ip.save_rewrite_length;
 210       ip0 = (ip4_header_t *) ((u8 *) vlib_buffer_get_current (b0)
 211                               + iph_offset);
 212
 213       /* lookup for SPD only if sw_if_index is changed */
 214       if (PREDICT_FALSE (last_sw_if_index != sw_if_index0))
 215         {
 216           uword *p = hash_get (im->spd_index_by_sw_if_index, sw_if_index0);
 217           ASSERT (p);
 218           spd_index0 = p[0];
 219           spd0 = pool_elt_at_index (im->spds, spd_index0);
 220           last_sw_if_index = sw_if_index0;
 221         }
 222
 223       if (is_ipv6)
 224         {
 225           ip6_0 = (ip6_header_t *) ((u8 *) vlib_buffer_get_current (b0)
 226                                     + iph_offset);
 227
 228           udp0 = ip6_next_header (ip6_0);
 229 #if 0
 230           clib_warning
 231             ("packet received from %U port %u to %U port %u spd_id %u",
 232              format_ip6_address, &ip6_0->src_address,
 233              clib_net_to_host_u16 (udp0->src_port), format_ip6_address,
 234              &ip6_0->dst_address, clib_net_to_host_u16 (udp0->dst_port),
 235              spd0->id);
 236 #endif
 237
 238           p0 = ipsec6_output_policy_match (spd0,
 239                                            &ip6_0->src_address,
 240                                            &ip6_0->dst_address,
 241                                            clib_net_to_host_u16
 242                                            (udp0->src_port),
 243                                            clib_net_to_host_u16
 244                                            (udp0->dst_port), ip6_0->protocol);
 245         }
 246       else
 247         {
 248           udp0 = (udp_header_t *) ((u8 *) ip0 + ip4_header_bytes (ip0));
 249
 250 #if 0
 251           clib_warning ("packet received from %U to %U port %u",
 252                         format_ip4_address, ip0->src_address.as_u8,
 253                         format_ip4_address, ip0->dst_address.as_u8,
 254                         clib_net_to_host_u16 (udp0->dst_port));
 255           clib_warning ("sw_if_index0 %u spd_index0 %u spd_id %u",
 256                         sw_if_index0, spd_index0, spd0->id);
 257 #endif
 258
 259           p0 = ipsec_output_policy_match (spd0, ip0->protocol,
 260                                           clib_net_to_host_u32
 261                                           (ip0->src_address.as_u32),
 262                                           clib_net_to_host_u32
 263                                           (ip0->dst_address.as_u32),
 264                                           clib_net_to_host_u16
 265                                           (udp0->src_port),
 266                                           clib_net_to_host_u16
 267                                           (udp0->dst_port));
 268         }
 269       tcp0 = (void *) udp0;
 270
 271       if (PREDICT_TRUE (p0 != NULL))
 272         {
 273           pi0 = p0 - im->policies;
 274
 275           vlib_prefetch_combined_counter (&ipsec_spd_policy_counters,
 276                                           thread_index, pi0);
 277
 278           if (is_ipv6)
 279             {
 280               bytes0 = clib_net_to_host_u16 (ip6_0->payload_length);
 281               bytes0 += sizeof (ip6_header_t);
 282             }
 283           else
 284             {
 285               bytes0 = clib_net_to_host_u16 (ip0->length);
 286             }
 287
 288           if (p0->policy == IPSEC_POLICY_ACTION_PROTECT)
 289             {
 290               ipsec_sa_t *sa = 0;
 291               nc_protect++;
 292               sa = pool_elt_at_index (im->sad, p0->sa_index);
 293               if (sa->protocol == IPSEC_PROTOCOL_ESP)
 294                 if (is_ipv6)
 295                   next_node_index = im->esp6_encrypt_node_index;
 296                 else
 297                   next_node_index = im->esp4_encrypt_node_index;
 298               else if (is_ipv6)
 299                 next_node_index = im->ah6_encrypt_node_index;
 300               else
 301                 next_node_index = im->ah4_encrypt_node_index;
 302               vnet_buffer (b0)->ipsec.sad_index = p0->sa_index;
 303
 304               if (is_ipv6)
 305                 {
 306                   if (PREDICT_FALSE
 307                       (b0->flags & VNET_BUFFER_F_OFFLOAD_TCP_CKSUM))
 308                     {
 309                       tcp0->checksum =
 310                         ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip6_0,
 311                                                            &bogus);
 312                       b0->flags &= ~VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
 313                     }
 314                   if (PREDICT_FALSE
 315                       (b0->flags & VNET_BUFFER_F_OFFLOAD_UDP_CKSUM))
 316                     {
 317                       udp0->checksum =
 318                         ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip6_0,
 319                                                            &bogus);
 320                       b0->flags &= ~VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
 321                     }
 322                 }
 323               else
 324                 {
 325                   if (b0->flags & VNET_BUFFER_F_OFFLOAD_IP_CKSUM)
 326                     {
 327                       ip0->checksum = ip4_header_checksum (ip0);
 328                       b0->flags &= ~VNET_BUFFER_F_OFFLOAD_IP_CKSUM;
 329                     }
 330                   if (PREDICT_FALSE
 331                       (b0->flags & VNET_BUFFER_F_OFFLOAD_TCP_CKSUM))
 332                     {
 333                       tcp0->checksum =
 334                         ip4_tcp_udp_compute_checksum (vm, b0, ip0);
 335                       b0->flags &= ~VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
 336                     }
 337                   if (PREDICT_FALSE
 338                       (b0->flags & VNET_BUFFER_F_OFFLOAD_UDP_CKSUM))
 339                     {
 340                       udp0->checksum =
 341                         ip4_tcp_udp_compute_checksum (vm, b0, ip0);
 342                       b0->flags &= ~VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
 343                     }
 344                 }
 345               vlib_buffer_advance (b0, iph_offset);
 346             }
 347           else if (p0->policy == IPSEC_POLICY_ACTION_BYPASS)
 348             {
 349               nc_bypass++;
 350               next_node_index = get_next_output_feature_node_index (b0, node);
 351             }
 352           else
 353             {
 354               nc_discard++;
 355               next_node_index = im->error_drop_node_index;
 356             }
 357           vlib_increment_combined_counter
 358             (&ipsec_spd_policy_counters, thread_index, pi0, 1, bytes0);
 359         }
 360       else
 361         {
 362           pi0 = ~0;
 363           nc_nomatch++;
 364           next_node_index = im->error_drop_node_index;
 365         }
 366
 367       from += 1;
 368       n_left_from -= 1;
 369
 370       if (PREDICT_FALSE ((last_next_node_index != next_node_index) || f == 0))
 371         {
 372           /* if this is not 1st frame */
 373           if (f)
 374             vlib_put_frame_to_node (vm, last_next_node_index, f);
 375
 376           last_next_node_index = next_node_index;
 377
 378           f = vlib_get_frame_to_node (vm, next_node_index);
 379
 380           /* frame->frame_flags, copy it from node */
 381           /* Copy trace flag from next_frame and from runtime. */
 382           f->frame_flags |= node->flags & VLIB_NODE_FLAG_TRACE;
 383
 384           to_next = vlib_frame_vector_args (f);
 385         }
 386
 387       to_next[0] = bi0;
 388       to_next += 1;
 389       f->n_vectors++;
 390
 391       if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE) &&
 392           PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
 393         {
 394           ipsec_output_trace_t *tr =
 395             vlib_add_trace (vm, node, b0, sizeof (*tr));
 396           if (spd0)
 397             tr->spd_id = spd0->id;
 398           tr->policy_id = pi0;
 399         }
 400     }
 401
 402   vlib_put_frame_to_node (vm, next_node_index, f);
 403   vlib_node_increment_counter (vm, node->node_index,
 404                                IPSEC_OUTPUT_ERROR_POLICY_PROTECT, nc_protect);
 405   vlib_node_increment_counter (vm, node->node_index,
 406                                IPSEC_OUTPUT_ERROR_POLICY_BYPASS, nc_bypass);
 407   vlib_node_increment_counter (vm, node->node_index,
 408                                IPSEC_OUTPUT_ERROR_POLICY_DISCARD, nc_discard);
 409   vlib_node_increment_counter (vm, node->node_index,
 410                                IPSEC_OUTPUT_ERROR_POLICY_NO_MATCH,
 411                                nc_nomatch);
 412   return from_frame->n_vectors;
 413 }
 414
 415 VLIB_NODE_FN (ipsec4_output_node) (vlib_main_t * vm,
 416                                    vlib_node_runtime_t * node,
 417                                    vlib_frame_t * frame)
 418 {
 419   return ipsec_output_inline (vm, node, frame, 0);
 420 }
 421
 422 /* *INDENT-OFF* */
 423 VLIB_REGISTER_NODE (ipsec4_output_node) = {
 424   .name = "ipsec4-output-feature",
 425   .vector_size = sizeof (u32),
 426   .format_trace = format_ipsec_output_trace,
 427   .type = VLIB_NODE_TYPE_INTERNAL,
 428
 429   .n_errors = ARRAY_LEN(ipsec_output_error_strings),
 430   .error_strings = ipsec_output_error_strings,
 431
 432   .n_next_nodes = IPSEC_OUTPUT_N_NEXT,
 433   .next_nodes = {
 434 #define _(s,n) [IPSEC_OUTPUT_NEXT_##s] = n,
 435     foreach_ipsec_output_next
 436 #undef _
 437   },
 438 };
 439 /* *INDENT-ON* */
 440
 441 VLIB_NODE_FN (ipsec6_output_node) (vlib_main_t * vm,
 442                                    vlib_node_runtime_t * node,
 443                                    vlib_frame_t * frame)
 444 {
 445   return ipsec_output_inline (vm, node, frame, 1);
 446 }
 447
 448 /* *INDENT-OFF* */
 449 VLIB_REGISTER_NODE (ipsec6_output_node) = {
 450   .name = "ipsec6-output-feature",
 451   .vector_size = sizeof (u32),
 452   .format_trace = format_ipsec_output_trace,
 453   .type = VLIB_NODE_TYPE_INTERNAL,
 454
 455   .n_errors = ARRAY_LEN(ipsec_output_error_strings),
 456   .error_strings = ipsec_output_error_strings,
 457
 458   .n_next_nodes = IPSEC_OUTPUT_N_NEXT,
 459   .next_nodes = {
 460 #define _(s,n) [IPSEC_OUTPUT_NEXT_##s] = n,
 461     foreach_ipsec_output_next
 462 #undef _
 463   },
 464 };
 465 /* *INDENT-ON* */
 466
 467 #else /* IPSEC > 1 */
 468
 469 /* Dummy ipsec output node, in case when IPSec is disabled */
 470
 471 static uword
 472 ipsec_output_node_fn (vlib_main_t * vm,
 473                       vlib_node_runtime_t * node, vlib_frame_t * frame)
 474 {
 475   clib_warning ("IPSec disabled");
 476   return 0;
 477 }
 478
 479 /* *INDENT-OFF* */
 480 VLIB_REGISTER_NODE (ipsec4_output_node) = {
 481   .vector_size = sizeof (u32),
 482   .function = ipsec_output_node_fn,
 483   .name = "ipsec4-output-feature",
 484 };
 485
 486 VLIB_REGISTER_NODE (ipsec6_output_node) = {
 487   .vector_size = sizeof (u32),
 488   .function = ipsec_output_node_fn,
 489   .name = "ipsec6-output-feature",
 490 };
 491 /* *INDENT-ON* */
 492 #endif
 493
 494 /*
 495  * fd.io coding-style-patch-verification: ON
 496  *
 497  * Local Variables:
 498  * eval: (c-set-style "gnu")
 499  * End:
 500  */