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   u64 nc_protect = 0, nc_bypass = 0, nc_discard = 0, nc_nomatch = 0;
 194
 195   from = vlib_frame_vector_args (from_frame);
 196   n_left_from = from_frame->n_vectors;
 197
 198   while (n_left_from > 0)
 199     {
 200       u32 bi0;
 201       vlib_buffer_t *b0;
 202       ipsec_policy_t *p0;
 203       ip4_header_t *ip0;
 204       ip6_header_t *ip6_0 = 0;
 205       udp_header_t *udp0;
 206       u32 iph_offset = 0;
 207
 208       bi0 = from[0];
 209       b0 = vlib_get_buffer (vm, bi0);
 210       sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
 211       iph_offset = vnet_buffer (b0)->ip.save_rewrite_length;
 212       ip0 = (ip4_header_t *) ((u8 *) vlib_buffer_get_current (b0)
 213                               + iph_offset);
 214
 215       /* lookup for SPD only if sw_if_index is changed */
 216       if (PREDICT_FALSE (last_sw_if_index != sw_if_index0))
 217         {
 218           uword *p = hash_get (im->spd_index_by_sw_if_index, sw_if_index0);
 219           ASSERT (p);
 220           spd_index0 = p[0];
 221           spd0 = pool_elt_at_index (im->spds, spd_index0);
 222           last_sw_if_index = sw_if_index0;
 223         }
 224
 225       if (is_ipv6)
 226         {
 227           ip6_0 = (ip6_header_t *) ((u8 *) vlib_buffer_get_current (b0)
 228                                     + iph_offset);
 229
 230           udp0 = ip6_next_header (ip6_0);
 231 #if 0
 232           clib_warning
 233             ("packet received from %U port %u to %U port %u spd_id %u",
 234              format_ip6_address, &ip6_0->src_address,
 235              clib_net_to_host_u16 (udp0->src_port), format_ip6_address,
 236              &ip6_0->dst_address, clib_net_to_host_u16 (udp0->dst_port),
 237              spd0->id);
 238 #endif
 239
 240           p0 = ipsec_output_ip6_policy_match (spd0,
 241                                               &ip6_0->src_address,
 242                                               &ip6_0->dst_address,
 243                                               clib_net_to_host_u16
 244                                               (udp0->src_port),
 245                                               clib_net_to_host_u16
 246                                               (udp0->dst_port),
 247                                               ip6_0->protocol);
 248         }
 249       else
 250         {
 251           udp0 = (udp_header_t *) ((u8 *) ip0 + ip4_header_bytes (ip0));
 252
 253 #if 0
 254           clib_warning ("packet received from %U to %U port %u",
 255                         format_ip4_address, ip0->src_address.as_u8,
 256                         format_ip4_address, ip0->dst_address.as_u8,
 257                         clib_net_to_host_u16 (udp0->dst_port));
 258           clib_warning ("sw_if_index0 %u spd_index0 %u spd_id %u",
 259                         sw_if_index0, spd_index0, spd0->id);
 260 #endif
 261
 262           p0 = ipsec_output_policy_match (spd0, ip0->protocol,
 263                                           clib_net_to_host_u32
 264                                           (ip0->src_address.as_u32),
 265                                           clib_net_to_host_u32
 266                                           (ip0->dst_address.as_u32),
 267                                           clib_net_to_host_u16
 268                                           (udp0->src_port),
 269                                           clib_net_to_host_u16
 270                                           (udp0->dst_port));
 271         }
 272
 273       if (PREDICT_TRUE (p0 != NULL))
 274         {
 275           if (p0->policy == IPSEC_POLICY_ACTION_PROTECT)
 276             {
 277               ipsec_sa_t *sa = 0;
 278               nc_protect++;
 279               sa = pool_elt_at_index (im->sad, p0->sa_index);
 280               if (sa->protocol == IPSEC_PROTOCOL_ESP)
 281                 next_node_index = im->esp_encrypt_node_index;
 282               else
 283                 next_node_index = im->ah_encrypt_node_index;
 284               vnet_buffer (b0)->ipsec.sad_index = p0->sa_index;
 285               vlib_buffer_advance (b0, iph_offset);
 286               p0->counter.packets++;
 287               if (is_ipv6)
 288                 {
 289                   p0->counter.bytes +=
 290                     clib_net_to_host_u16 (ip6_0->payload_length);
 291                   p0->counter.bytes += sizeof (ip6_header_t);
 292                 }
 293               else
 294                 {
 295                   p0->counter.bytes += clib_net_to_host_u16 (ip0->length);
 296                 }
 297             }
 298           else if (p0->policy == IPSEC_POLICY_ACTION_BYPASS)
 299             {
 300               nc_bypass++;
 301               next_node_index = get_next_output_feature_node_index (b0, node);
 302               p0->counter.packets++;
 303               if (is_ipv6)
 304                 {
 305                   p0->counter.bytes +=
 306                     clib_net_to_host_u16 (ip6_0->payload_length);
 307                   p0->counter.bytes += sizeof (ip6_header_t);
 308                 }
 309               else
 310                 {
 311                   p0->counter.bytes += clib_net_to_host_u16 (ip0->length);
 312                 }
 313             }
 314           else
 315             {
 316               nc_discard++;
 317               p0->counter.packets++;
 318               if (is_ipv6)
 319                 {
 320                   p0->counter.bytes +=
 321                     clib_net_to_host_u16 (ip6_0->payload_length);
 322                   p0->counter.bytes += sizeof (ip6_header_t);
 323                 }
 324               else
 325                 {
 326                   p0->counter.bytes += clib_net_to_host_u16 (ip0->length);
 327                 }
 328               next_node_index = im->error_drop_node_index;
 329             }
 330         }
 331       else
 332         {
 333           nc_nomatch++;
 334           next_node_index = im->error_drop_node_index;
 335         }
 336
 337       from += 1;
 338       n_left_from -= 1;
 339
 340       if (PREDICT_FALSE ((last_next_node_index != next_node_index) || f == 0))
 341         {
 342           /* if this is not 1st frame */
 343           if (f)
 344             vlib_put_frame_to_node (vm, last_next_node_index, f);
 345
 346           last_next_node_index = next_node_index;
 347
 348           f = vlib_get_frame_to_node (vm, next_node_index);
 349           to_next = vlib_frame_vector_args (f);
 350         }
 351
 352       to_next[0] = bi0;
 353       to_next += 1;
 354       f->n_vectors++;
 355
 356       if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
 357         {
 358           ipsec_output_trace_t *tr =
 359             vlib_add_trace (vm, node, b0, sizeof (*tr));
 360           if (spd0)
 361             tr->spd_id = spd0->id;
 362         }
 363     }
 364
 365   vlib_put_frame_to_node (vm, next_node_index, f);
 366   vlib_node_increment_counter (vm, node->node_index,
 367                                IPSEC_OUTPUT_ERROR_POLICY_PROTECT, nc_protect);
 368   vlib_node_increment_counter (vm, node->node_index,
 369                                IPSEC_OUTPUT_ERROR_POLICY_BYPASS, nc_bypass);
 370   vlib_node_increment_counter (vm, node->node_index,
 371                                IPSEC_OUTPUT_ERROR_POLICY_DISCARD, nc_discard);
 372   vlib_node_increment_counter (vm, node->node_index,
 373                                IPSEC_OUTPUT_ERROR_POLICY_NO_MATCH,
 374                                nc_nomatch);
 375   return from_frame->n_vectors;
 376 }
 377
 378 static uword
 379 ipsec_output_ip4_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
 380                           vlib_frame_t * frame)
 381 {
 382   return ipsec_output_inline (vm, node, frame, 0);
 383 }
 384
 385 /* *INDENT-OFF* */
 386 VLIB_REGISTER_NODE (ipsec_output_ip4_node,static) = {
 387   .function = ipsec_output_ip4_node_fn,
 388   .name = "ipsec-output-ip4",
 389   .vector_size = sizeof (u32),
 390   .format_trace = format_ipsec_output_trace,
 391   .type = VLIB_NODE_TYPE_INTERNAL,
 392
 393   .n_errors = ARRAY_LEN(ipsec_output_error_strings),
 394   .error_strings = ipsec_output_error_strings,
 395
 396   .n_next_nodes = IPSEC_OUTPUT_N_NEXT,
 397   .next_nodes = {
 398 #define _(s,n) [IPSEC_OUTPUT_NEXT_##s] = n,
 399     foreach_ipsec_output_next
 400 #undef _
 401   },
 402 };
 403 /* *INDENT-ON* */
 404
 405 VLIB_NODE_FUNCTION_MULTIARCH (ipsec_output_ip4_node, ipsec_output_ip4_node_fn)
 406      static uword
 407        ipsec_output_ip6_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
 408                                  vlib_frame_t * frame)
 409 {
 410   return ipsec_output_inline (vm, node, frame, 1);
 411 }
 412
 413 /* *INDENT-OFF* */
 414 VLIB_REGISTER_NODE (ipsec_output_ip6_node,static) = {
 415   .function = ipsec_output_ip6_node_fn,
 416   .name = "ipsec-output-ip6",
 417   .vector_size = sizeof (u32),
 418   .format_trace = format_ipsec_output_trace,
 419   .type = VLIB_NODE_TYPE_INTERNAL,
 420
 421   .n_errors = ARRAY_LEN(ipsec_output_error_strings),
 422   .error_strings = ipsec_output_error_strings,
 423
 424   .n_next_nodes = IPSEC_OUTPUT_N_NEXT,
 425   .next_nodes = {
 426 #define _(s,n) [IPSEC_OUTPUT_NEXT_##s] = n,
 427     foreach_ipsec_output_next
 428 #undef _
 429   },
 430 };
 431 /* *INDENT-ON* */
 432
 433 VLIB_NODE_FUNCTION_MULTIARCH (ipsec_output_ip6_node, ipsec_output_ip6_node_fn)
 434 #else /* IPSEC > 1 */
 435
 436 /* Dummy ipsec output node, in case when IPSec is disabled */
 437
 438 static uword
 439 ipsec_output_node_fn (vlib_main_t * vm,
 440                       vlib_node_runtime_t * node, vlib_frame_t * frame)
 441 {
 442   clib_warning ("IPSec disabled");
 443   return 0;
 444 }
 445
 446 /* *INDENT-OFF* */
 447 VLIB_REGISTER_NODE (ipsec_output_node) = {
 448   .vector_size = sizeof (u32),
 449   .function = ipsec_output_node_fn,
 450   .name = "ipsec-output-ip4",
 451 };
 452
 453 VLIB_REGISTER_NODE (ipsec_output_node) = {
 454   .vector_size = sizeof (u32),
 455   .function = ipsec_output_node_fn,
 456   .name = "ipsec-output-ip6",
 457 };
 458 /* *INDENT-ON* */
 459 #endif
 460
 461 /*
 462  * fd.io coding-style-patch-verification: ON
 463  *
 464  * Local Variables:
 465  * eval: (c-set-style "gnu")
 466  * End:
 467  */