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