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