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 static vlib_node_registration_t ipsec_output_ip4_node;
  49 static vlib_node_registration_t ipsec_output_ip6_node;
  50
  51 typedef struct
  52 {
  53   u32 spd_id;
  54 } ipsec_output_trace_t;
  55
  56 /* packet trace format function */
  57 static u8 *
  58 format_ipsec_output_trace (u8 * s, va_list * args)
  59 {
  60   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  61   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  62   ipsec_output_trace_t *t = va_arg (*args, ipsec_output_trace_t *);
  63
  64   if (t->spd_id != ~0)
  65     {
  66       s = format (s, "spd %u ", t->spd_id);
  67     }
  68   else
  69     {
  70       s = format (s, "no spd");
  71     }
  72   return s;
  73 }
  74
  75 always_inline ipsec_policy_t *
  76 ipsec_output_policy_match (ipsec_spd_t * spd, u8 pr, u32 la, u32 ra, u16 lp,
  77                            u16 rp)
  78 {
  79   ipsec_policy_t *p;
  80   u32 *i;
  81
  82   if (!spd)
  83     return 0;
  84
  85   vec_foreach (i, spd->ipv4_outbound_policies)
  86   {
  87     p = pool_elt_at_index (spd->policies, *i);
  88     if (PREDICT_FALSE (p->protocol && (p->protocol != pr)))
  89       continue;
  90
  91     if (ra < clib_net_to_host_u32 (p->raddr.start.ip4.as_u32))
  92       continue;
  93
  94     if (ra > clib_net_to_host_u32 (p->raddr.stop.ip4.as_u32))
  95       continue;
  96
  97     if (la < clib_net_to_host_u32 (p->laddr.start.ip4.as_u32))
  98       continue;
  99
 100     if (la > clib_net_to_host_u32 (p->laddr.stop.ip4.as_u32))
 101       continue;
 102
 103     if (PREDICT_FALSE
 104         ((pr != IP_PROTOCOL_TCP) && (pr != IP_PROTOCOL_UDP)
 105          && (pr != IP_PROTOCOL_SCTP)))
 106       return p;
 107
 108     if (lp < p->lport.start)
 109       continue;
 110
 111     if (lp > p->lport.stop)
 112       continue;
 113
 114     if (rp < p->rport.start)
 115       continue;
 116
 117     if (rp > p->rport.stop)
 118       continue;
 119
 120     return p;
 121   }
 122   return 0;
 123 }
 124
 125 always_inline uword
 126 ip6_addr_match_range (ip6_address_t * a, ip6_address_t * la,
 127                       ip6_address_t * ua)
 128 {
 129   if ((memcmp (a->as_u64, la->as_u64, 2 * sizeof (u64)) >= 0) &&
 130       (memcmp (a->as_u64, ua->as_u64, 2 * sizeof (u64)) <= 0))
 131     return 1;
 132   return 0;
 133 }
 134
 135 always_inline ipsec_policy_t *
 136 ipsec_output_ip6_policy_match (ipsec_spd_t * spd,
 137                                ip6_address_t * la,
 138                                ip6_address_t * ra, u16 lp, u16 rp, u8 pr)
 139 {
 140   ipsec_policy_t *p;
 141   u32 *i;
 142
 143   if (!spd)
 144     return 0;
 145
 146   vec_foreach (i, spd->ipv6_outbound_policies)
 147   {
 148     p = pool_elt_at_index (spd->policies, *i);
 149     if (PREDICT_FALSE (p->protocol && (p->protocol != pr)))
 150       continue;
 151
 152     if (!ip6_addr_match_range (ra, &p->raddr.start.ip6, &p->raddr.stop.ip6))
 153       continue;
 154
 155     if (!ip6_addr_match_range (la, &p->laddr.start.ip6, &p->laddr.stop.ip6))
 156       continue;
 157
 158     if (PREDICT_FALSE
 159         ((pr != IP_PROTOCOL_TCP) && (pr != IP_PROTOCOL_UDP)
 160          && (pr != IP_PROTOCOL_SCTP)))
 161       return p;
 162
 163     if (lp < p->lport.start)
 164       continue;
 165
 166     if (lp > p->lport.stop)
 167       continue;
 168
 169     if (rp < p->rport.start)
 170       continue;
 171
 172     if (rp > p->rport.stop)
 173       continue;
 174
 175     return p;
 176   }
 177
 178   return 0;
 179 }
 180
 181 static inline uword
 182 ipsec_output_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
 183                      vlib_frame_t * from_frame, int is_ipv6)
 184 {
 185   ipsec_main_t *im = &ipsec_main;
 186
 187   u32 *from, *to_next = 0;
 188   u32 n_left_from, sw_if_index0, last_sw_if_index = (u32) ~ 0;
 189   u32 next_node_index = (u32) ~ 0, last_next_node_index = (u32) ~ 0;
 190   vlib_frame_t *f = 0;
 191   u32 spd_index0 = ~0;
 192   ipsec_spd_t *spd0 = 0;
 193   int bogus;
 194   u64 nc_protect = 0, nc_bypass = 0, nc_discard = 0, nc_nomatch = 0;
 195
 196   from = vlib_frame_vector_args (from_frame);
 197   n_left_from = from_frame->n_vectors;
 198
 199   while (n_left_from > 0)
 200     {
 201       u32 bi0;
 202       vlib_buffer_t *b0;
 203       ipsec_policy_t *p0;
 204       ip4_header_t *ip0;
 205       ip6_header_t *ip6_0 = 0;
 206       udp_header_t *udp0;
 207       u32 iph_offset = 0;
 208       tcp_header_t *tcp0;
 209
 210       bi0 = from[0];
 211       b0 = vlib_get_buffer (vm, bi0);
 212       sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
 213       iph_offset = vnet_buffer (b0)->ip.save_rewrite_length;
 214       ip0 = (ip4_header_t *) ((u8 *) vlib_buffer_get_current (b0)
 215                               + iph_offset);
 216
 217       /* lookup for SPD only if sw_if_index is changed */
 218       if (PREDICT_FALSE (last_sw_if_index != sw_if_index0))
 219         {
 220           uword *p = hash_get (im->spd_index_by_sw_if_index, sw_if_index0);
 221           ASSERT (p);
 222           spd_index0 = p[0];
 223           spd0 = pool_elt_at_index (im->spds, spd_index0);
 224           last_sw_if_index = sw_if_index0;
 225         }
 226
 227       if (is_ipv6)
 228         {
 229           ip6_0 = (ip6_header_t *) ((u8 *) vlib_buffer_get_current (b0)
 230                                     + iph_offset);
 231
 232           udp0 = ip6_next_header (ip6_0);
 233 #if 0
 234           clib_warning
 235             ("packet received from %U port %u to %U port %u spd_id %u",
 236              format_ip6_address, &ip6_0->src_address,
 237              clib_net_to_host_u16 (udp0->src_port), format_ip6_address,
 238              &ip6_0->dst_address, clib_net_to_host_u16 (udp0->dst_port),
 239              spd0->id);
 240 #endif
 241
 242           p0 = ipsec_output_ip6_policy_match (spd0,
 243                                               &ip6_0->src_address,
 244                                               &ip6_0->dst_address,
 245                                               clib_net_to_host_u16
 246                                               (udp0->src_port),
 247                                               clib_net_to_host_u16
 248                                               (udp0->dst_port),
 249                                               ip6_0->protocol);
 250         }
 251       else
 252         {
 253           udp0 = (udp_header_t *) ((u8 *) ip0 + ip4_header_bytes (ip0));
 254
 255 #if 0
 256           clib_warning ("packet received from %U to %U port %u",
 257                         format_ip4_address, ip0->src_address.as_u8,
 258                         format_ip4_address, ip0->dst_address.as_u8,
 259                         clib_net_to_host_u16 (udp0->dst_port));
 260           clib_warning ("sw_if_index0 %u spd_index0 %u spd_id %u",
 261                         sw_if_index0, spd_index0, spd0->id);
 262 #endif
 263
 264           p0 = ipsec_output_policy_match (spd0, ip0->protocol,
 265                                           clib_net_to_host_u32
 266                                           (ip0->src_address.as_u32),
 267                                           clib_net_to_host_u32
 268                                           (ip0->dst_address.as_u32),
 269                                           clib_net_to_host_u16
 270                                           (udp0->src_port),
 271                                           clib_net_to_host_u16
 272                                           (udp0->dst_port));
 273         }
 274       tcp0 = (void *) udp0;
 275
 276       if (PREDICT_TRUE (p0 != NULL))
 277         {
 278           if (p0->policy == IPSEC_POLICY_ACTION_PROTECT)
 279             {
 280               ipsec_sa_t *sa = 0;
 281               nc_protect++;
 282               sa = pool_elt_at_index (im->sad, p0->sa_index);
 283               if (sa->protocol == IPSEC_PROTOCOL_ESP)
 284                 next_node_index = im->esp_encrypt_node_index;
 285               else
 286                 next_node_index = im->ah_encrypt_node_index;
 287               vnet_buffer (b0)->ipsec.sad_index = p0->sa_index;
 288               p0->counter.packets++;
 289               if (is_ipv6)
 290                 {
 291                   p0->counter.bytes +=
 292                     clib_net_to_host_u16 (ip6_0->payload_length);
 293                   p0->counter.bytes += sizeof (ip6_header_t);
 294                   if (PREDICT_FALSE
 295                       (b0->flags & VNET_BUFFER_F_OFFLOAD_TCP_CKSUM))
 296                     {
 297                       tcp0->checksum =
 298                         ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip6_0,
 299                                                            &bogus);
 300                       b0->flags &= ~VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
 301                     }
 302                   if (PREDICT_FALSE
 303                       (b0->flags & VNET_BUFFER_F_OFFLOAD_UDP_CKSUM))
 304                     {
 305                       udp0->checksum =
 306                         ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip6_0,
 307                                                            &bogus);
 308                       b0->flags &= ~VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
 309                     }
 310                 }
 311               else
 312                 {
 313                   p0->counter.bytes += clib_net_to_host_u16 (ip0->length);
 314                   if (b0->flags & VNET_BUFFER_F_OFFLOAD_IP_CKSUM)
 315                     {
 316                       ip0->checksum = ip4_header_checksum (ip0);
 317                       b0->flags &= ~VNET_BUFFER_F_OFFLOAD_IP_CKSUM;
 318                     }
 319                   if (PREDICT_FALSE
 320                       (b0->flags & VNET_BUFFER_F_OFFLOAD_TCP_CKSUM))
 321                     {
 322                       tcp0->checksum =
 323                         ip4_tcp_udp_compute_checksum (vm, b0, ip0);
 324                       b0->flags &= ~VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
 325                     }
 326                   if (PREDICT_FALSE
 327                       (b0->flags & VNET_BUFFER_F_OFFLOAD_UDP_CKSUM))
 328                     {
 329                       udp0->checksum =
 330                         ip4_tcp_udp_compute_checksum (vm, b0, ip0);
 331                       b0->flags &= ~VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
 332                     }
 333                 }
 334               vlib_buffer_advance (b0, iph_offset);
 335             }
 336           else if (p0->policy == IPSEC_POLICY_ACTION_BYPASS)
 337             {
 338               nc_bypass++;
 339               next_node_index = get_next_output_feature_node_index (b0, node);
 340               p0->counter.packets++;
 341               if (is_ipv6)
 342                 {
 343                   p0->counter.bytes +=
 344                     clib_net_to_host_u16 (ip6_0->payload_length);
 345                   p0->counter.bytes += sizeof (ip6_header_t);
 346                 }
 347               else
 348                 {
 349                   p0->counter.bytes += clib_net_to_host_u16 (ip0->length);
 350                 }
 351             }
 352           else
 353             {
 354               nc_discard++;
 355               p0->counter.packets++;
 356               if (is_ipv6)
 357                 {
 358                   p0->counter.bytes +=
 359                     clib_net_to_host_u16 (ip6_0->payload_length);
 360                   p0->counter.bytes += sizeof (ip6_header_t);
 361                 }
 362               else
 363                 {
 364                   p0->counter.bytes += clib_net_to_host_u16 (ip0->length);
 365                 }
 366               next_node_index = im->error_drop_node_index;
 367             }
 368         }
 369       else
 370         {
 371           nc_nomatch++;
 372           next_node_index = im->error_drop_node_index;
 373         }
 374
 375       from += 1;
 376       n_left_from -= 1;
 377
 378       if (PREDICT_FALSE ((last_next_node_index != next_node_index) || f == 0))
 379         {
 380           /* if this is not 1st frame */
 381           if (f)
 382             vlib_put_frame_to_node (vm, last_next_node_index, f);
 383
 384           last_next_node_index = next_node_index;
 385
 386           f = vlib_get_frame_to_node (vm, next_node_index);
 387           to_next = vlib_frame_vector_args (f);
 388         }
 389
 390       to_next[0] = bi0;
 391       to_next += 1;
 392       f->n_vectors++;
 393
 394       if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
 395         {
 396           ipsec_output_trace_t *tr =
 397             vlib_add_trace (vm, node, b0, sizeof (*tr));
 398           if (spd0)
 399             tr->spd_id = spd0->id;
 400         }
 401     }
 402
 403   vlib_put_frame_to_node (vm, next_node_index, f);
 404   vlib_node_increment_counter (vm, node->node_index,
 405                                IPSEC_OUTPUT_ERROR_POLICY_PROTECT, nc_protect);
 406   vlib_node_increment_counter (vm, node->node_index,
 407                                IPSEC_OUTPUT_ERROR_POLICY_BYPASS, nc_bypass);
 408   vlib_node_increment_counter (vm, node->node_index,
 409                                IPSEC_OUTPUT_ERROR_POLICY_DISCARD, nc_discard);
 410   vlib_node_increment_counter (vm, node->node_index,
 411                                IPSEC_OUTPUT_ERROR_POLICY_NO_MATCH,
 412                                nc_nomatch);
 413   return from_frame->n_vectors;
 414 }
 415
 416 static uword
 417 ipsec_output_ip4_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
 418                           vlib_frame_t * frame)
 419 {
 420   return ipsec_output_inline (vm, node, frame, 0);
 421 }
 422
 423 /* *INDENT-OFF* */
 424 VLIB_REGISTER_NODE (ipsec_output_ip4_node,static) = {
 425   .function = ipsec_output_ip4_node_fn,
 426   .name = "ipsec-output-ip4",
 427   .vector_size = sizeof (u32),
 428   .format_trace = format_ipsec_output_trace,
 429   .type = VLIB_NODE_TYPE_INTERNAL,
 430
 431   .n_errors = ARRAY_LEN(ipsec_output_error_strings),
 432   .error_strings = ipsec_output_error_strings,
 433
 434   .n_next_nodes = IPSEC_OUTPUT_N_NEXT,
 435   .next_nodes = {
 436 #define _(s,n) [IPSEC_OUTPUT_NEXT_##s] = n,
 437     foreach_ipsec_output_next
 438 #undef _
 439   },
 440 };
 441 /* *INDENT-ON* */
 442
 443 VLIB_NODE_FUNCTION_MULTIARCH (ipsec_output_ip4_node, ipsec_output_ip4_node_fn)
 444      static uword
 445        ipsec_output_ip6_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
 446                                  vlib_frame_t * frame)
 447 {
 448   return ipsec_output_inline (vm, node, frame, 1);
 449 }
 450
 451 /* *INDENT-OFF* */
 452 VLIB_REGISTER_NODE (ipsec_output_ip6_node,static) = {
 453   .function = ipsec_output_ip6_node_fn,
 454   .name = "ipsec-output-ip6",
 455   .vector_size = sizeof (u32),
 456   .format_trace = format_ipsec_output_trace,
 457   .type = VLIB_NODE_TYPE_INTERNAL,
 458
 459   .n_errors = ARRAY_LEN(ipsec_output_error_strings),
 460   .error_strings = ipsec_output_error_strings,
 461
 462   .n_next_nodes = IPSEC_OUTPUT_N_NEXT,
 463   .next_nodes = {
 464 #define _(s,n) [IPSEC_OUTPUT_NEXT_##s] = n,
 465     foreach_ipsec_output_next
 466 #undef _
 467   },
 468 };
 469 /* *INDENT-ON* */
 470
 471 VLIB_NODE_FUNCTION_MULTIARCH (ipsec_output_ip6_node, ipsec_output_ip6_node_fn)
 472 #else /* IPSEC > 1 */
 473
 474 /* Dummy ipsec output node, in case when IPSec is disabled */
 475
 476 static uword
 477 ipsec_output_node_fn (vlib_main_t * vm,
 478                       vlib_node_runtime_t * node, vlib_frame_t * frame)
 479 {
 480   clib_warning ("IPSec disabled");
 481   return 0;
 482 }
 483
 484 /* *INDENT-OFF* */
 485 VLIB_REGISTER_NODE (ipsec_output_node) = {
 486   .vector_size = sizeof (u32),
 487   .function = ipsec_output_node_fn,
 488   .name = "ipsec-output-ip4",
 489 };
 490
 491 VLIB_REGISTER_NODE (ipsec_output_node) = {
 492   .vector_size = sizeof (u32),
 493   .function = ipsec_output_node_fn,
 494   .name = "ipsec-output-ip6",
 495 };
 496 /* *INDENT-ON* */
 497 #endif
 498
 499 /*
 500  * fd.io coding-style-patch-verification: ON
 501  *
 502  * Local Variables:
 503  * eval: (c-set-style "gnu")
 504  * End:
 505  */