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 (la < clib_net_to_host_u32 (p->laddr.start.ip4.as_u32))
  92       continue;
  93
  94     if (la > clib_net_to_host_u32 (p->laddr.stop.ip4.as_u32))
  95       continue;
  96
  97     if (ra < clib_net_to_host_u32 (p->raddr.start.ip4.as_u32))
  98       continue;
  99
 100     if (ra > clib_net_to_host_u32 (p->raddr.stop.ip4.as_u32))
 101       continue;
 102
 103     if (PREDICT_FALSE ((pr != IP_PROTOCOL_TCP) && (pr != IP_PROTOCOL_UDP)))
 104       return p;
 105
 106     if (lp < p->lport.start)
 107       continue;
 108
 109     if (lp > p->lport.stop)
 110       continue;
 111
 112     if (rp < p->rport.start)
 113       continue;
 114
 115     if (rp > p->rport.stop)
 116       continue;
 117
 118     return p;
 119   }
 120   return 0;
 121 }
 122
 123 always_inline uword
 124 ip6_addr_match_range (ip6_address_t * a, ip6_address_t * la,
 125                       ip6_address_t * ua)
 126 {
 127   if ((memcmp (a->as_u64, la->as_u64, 2 * sizeof (u64)) >= 0) &&
 128       (memcmp (a->as_u64, ua->as_u64, 2 * sizeof (u64)) <= 0))
 129     return 1;
 130   return 0;
 131 }
 132
 133 always_inline ipsec_policy_t *
 134 ipsec_output_ip6_policy_match (ipsec_spd_t * spd,
 135                                ip6_address_t * la,
 136                                ip6_address_t * ra, u16 lp, u16 rp, u8 pr)
 137 {
 138   ipsec_policy_t *p;
 139   u32 *i;
 140
 141   if (!spd)
 142     return 0;
 143
 144   vec_foreach (i, spd->ipv6_outbound_policies)
 145   {
 146     p = pool_elt_at_index (spd->policies, *i);
 147     if (PREDICT_FALSE (p->protocol && (p->protocol != pr)))
 148       continue;
 149
 150     if (!ip6_addr_match_range (ra, &p->raddr.start.ip6, &p->raddr.stop.ip6))
 151       continue;
 152
 153     if (!ip6_addr_match_range (la, &p->laddr.start.ip6, &p->laddr.stop.ip6))
 154       continue;
 155
 156     if (PREDICT_FALSE ((pr != IP_PROTOCOL_TCP) && (pr != IP_PROTOCOL_UDP)))
 157       return p;
 158
 159     if (lp < p->lport.start)
 160       continue;
 161
 162     if (lp > p->lport.stop)
 163       continue;
 164
 165     if (rp < p->rport.start)
 166       continue;
 167
 168     if (rp > p->rport.stop)
 169       continue;
 170
 171     return p;
 172   }
 173
 174   return 0;
 175 }
 176
 177 static inline uword
 178 ipsec_output_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
 179                      vlib_frame_t * from_frame, int is_ipv6)
 180 {
 181   ipsec_main_t *im = &ipsec_main;
 182
 183   u32 *from, *to_next = 0;
 184   u32 n_left_from, sw_if_index0, last_sw_if_index = (u32) ~ 0;
 185   u32 next_node_index = (u32) ~ 0, last_next_node_index = (u32) ~ 0;
 186   vlib_frame_t *f = 0;
 187   u32 spd_index0 = ~0;
 188   ipsec_spd_t *spd0 = 0;
 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
 194   while (n_left_from > 0)
 195     {
 196       u32 bi0;
 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
 204       bi0 = from[0];
 205       b0 = vlib_get_buffer (vm, bi0);
 206       sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
 207       iph_offset = vnet_buffer (b0)->ip.save_rewrite_length;
 208       ip0 = (ip4_header_t *) ((u8 *) vlib_buffer_get_current (b0)
 209                               + iph_offset);
 210
 211       /* lookup for SPD only if sw_if_index is changed */
 212       if (PREDICT_FALSE (last_sw_if_index != sw_if_index0))
 213         {
 214           uword *p = hash_get (im->spd_index_by_sw_if_index, sw_if_index0);
 215           ASSERT (p);
 216           spd_index0 = p[0];
 217           spd0 = pool_elt_at_index (im->spds, spd_index0);
 218           last_sw_if_index = sw_if_index0;
 219         }
 220
 221       if (is_ipv6)
 222         {
 223           ip6_0 = (ip6_header_t *) ((u8 *) vlib_buffer_get_current (b0)
 224                                     + iph_offset);
 225
 226           udp0 = ip6_next_header (ip6_0);
 227 #if 0
 228           clib_warning
 229             ("packet received from %U port %u to %U port %u spd_id %u",
 230              format_ip6_address, &ip6_0->src_address,
 231              clib_net_to_host_u16 (udp0->src_port), format_ip6_address,
 232              &ip6_0->dst_address, clib_net_to_host_u16 (udp0->dst_port),
 233              spd0->id);
 234 #endif
 235
 236           p0 = ipsec_output_ip6_policy_match (spd0,
 237                                               &ip6_0->src_address,
 238                                               &ip6_0->dst_address,
 239                                               clib_net_to_host_u16
 240                                               (udp0->src_port),
 241                                               clib_net_to_host_u16
 242                                               (udp0->dst_port),
 243                                               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                                           clib_net_to_host_u32
 260                                           (ip0->src_address.as_u32),
 261                                           clib_net_to_host_u32
 262                                           (ip0->dst_address.as_u32),
 263                                           clib_net_to_host_u16
 264                                           (udp0->src_port),
 265                                           clib_net_to_host_u16
 266                                           (udp0->dst_port));
 267         }
 268
 269       if (PREDICT_TRUE (p0 != NULL))
 270         {
 271           if (p0->policy == IPSEC_POLICY_ACTION_PROTECT)
 272             {
 273               nc_protect++;
 274               next_node_index = im->esp_encrypt_node_index;
 275               vnet_buffer (b0)->ipsec.sad_index = p0->sa_index;
 276               vlib_buffer_advance (b0, iph_offset);
 277               p0->counter.packets++;
 278               if (is_ipv6)
 279                 {
 280                   p0->counter.bytes +=
 281                     clib_net_to_host_u16 (ip6_0->payload_length);
 282                   p0->counter.bytes += sizeof (ip6_header_t);
 283                 }
 284               else
 285                 {
 286                   p0->counter.bytes += clib_net_to_host_u16 (ip0->length);
 287                 }
 288             }
 289           else if (p0->policy == IPSEC_POLICY_ACTION_BYPASS)
 290             {
 291               nc_bypass++;
 292               next_node_index = get_next_output_feature_node_index (b0, node);
 293               p0->counter.packets++;
 294               if (is_ipv6)
 295                 {
 296                   p0->counter.bytes +=
 297                     clib_net_to_host_u16 (ip6_0->payload_length);
 298                   p0->counter.bytes += sizeof (ip6_header_t);
 299                 }
 300               else
 301                 {
 302                   p0->counter.bytes += clib_net_to_host_u16 (ip0->length);
 303                 }
 304             }
 305           else
 306             {
 307               nc_discard++;
 308               p0->counter.packets++;
 309               if (is_ipv6)
 310                 {
 311                   p0->counter.bytes +=
 312                     clib_net_to_host_u16 (ip6_0->payload_length);
 313                   p0->counter.bytes += sizeof (ip6_header_t);
 314                 }
 315               else
 316                 {
 317                   p0->counter.bytes += clib_net_to_host_u16 (ip0->length);
 318                 }
 319               next_node_index = im->error_drop_node_index;
 320             }
 321         }
 322       else
 323         {
 324           nc_nomatch++;
 325           next_node_index = im->error_drop_node_index;
 326         }
 327
 328       from += 1;
 329       n_left_from -= 1;
 330
 331       if (PREDICT_FALSE ((last_next_node_index != next_node_index) || f == 0))
 332         {
 333           /* if this is not 1st frame */
 334           if (f)
 335             vlib_put_frame_to_node (vm, last_next_node_index, f);
 336
 337           last_next_node_index = next_node_index;
 338
 339           f = vlib_get_frame_to_node (vm, next_node_index);
 340           to_next = vlib_frame_vector_args (f);
 341         }
 342
 343       to_next[0] = bi0;
 344       to_next += 1;
 345       f->n_vectors++;
 346
 347       if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
 348         {
 349           ipsec_output_trace_t *tr =
 350             vlib_add_trace (vm, node, b0, sizeof (*tr));
 351           if (spd0)
 352             tr->spd_id = spd0->id;
 353         }
 354     }
 355
 356   vlib_put_frame_to_node (vm, next_node_index, f);
 357   vlib_node_increment_counter (vm, node->node_index,
 358                                IPSEC_OUTPUT_ERROR_POLICY_PROTECT, nc_protect);
 359   vlib_node_increment_counter (vm, node->node_index,
 360                                IPSEC_OUTPUT_ERROR_POLICY_BYPASS, nc_bypass);
 361   vlib_node_increment_counter (vm, node->node_index,
 362                                IPSEC_OUTPUT_ERROR_POLICY_DISCARD, nc_discard);
 363   vlib_node_increment_counter (vm, node->node_index,
 364                                IPSEC_OUTPUT_ERROR_POLICY_NO_MATCH,
 365                                nc_nomatch);
 366   return from_frame->n_vectors;
 367 }
 368
 369 static uword
 370 ipsec_output_ip4_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
 371                           vlib_frame_t * frame)
 372 {
 373   return ipsec_output_inline (vm, node, frame, 0);
 374 }
 375
 376 /* *INDENT-OFF* */
 377 VLIB_REGISTER_NODE (ipsec_output_ip4_node,static) = {
 378   .function = ipsec_output_ip4_node_fn,
 379   .name = "ipsec-output-ip4",
 380   .vector_size = sizeof (u32),
 381   .format_trace = format_ipsec_output_trace,
 382   .type = VLIB_NODE_TYPE_INTERNAL,
 383
 384   .n_errors = ARRAY_LEN(ipsec_output_error_strings),
 385   .error_strings = ipsec_output_error_strings,
 386
 387   .n_next_nodes = IPSEC_OUTPUT_N_NEXT,
 388   .next_nodes = {
 389 #define _(s,n) [IPSEC_OUTPUT_NEXT_##s] = n,
 390     foreach_ipsec_output_next
 391 #undef _
 392   },
 393 };
 394 /* *INDENT-ON* */
 395
 396 VLIB_NODE_FUNCTION_MULTIARCH (ipsec_output_ip4_node, ipsec_output_ip4_node_fn)
 397      static uword
 398        ipsec_output_ip6_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
 399                                  vlib_frame_t * frame)
 400 {
 401   return ipsec_output_inline (vm, node, frame, 1);
 402 }
 403
 404 /* *INDENT-OFF* */
 405 VLIB_REGISTER_NODE (ipsec_output_ip6_node,static) = {
 406   .function = ipsec_output_ip6_node_fn,
 407   .name = "ipsec-output-ip6",
 408   .vector_size = sizeof (u32),
 409   .format_trace = format_ipsec_output_trace,
 410   .type = VLIB_NODE_TYPE_INTERNAL,
 411
 412   .n_errors = ARRAY_LEN(ipsec_output_error_strings),
 413   .error_strings = ipsec_output_error_strings,
 414
 415   .n_next_nodes = IPSEC_OUTPUT_N_NEXT,
 416   .next_nodes = {
 417 #define _(s,n) [IPSEC_OUTPUT_NEXT_##s] = n,
 418     foreach_ipsec_output_next
 419 #undef _
 420   },
 421 };
 422 /* *INDENT-ON* */
 423
 424 VLIB_NODE_FUNCTION_MULTIARCH (ipsec_output_ip6_node, ipsec_output_ip6_node_fn)
 425 #else /* IPSEC > 1 */
 426
 427 /* Dummy ipsec output node, in case when IPSec is disabled */
 428
 429 static uword
 430 ipsec_output_node_fn (vlib_main_t * vm,
 431                       vlib_node_runtime_t * node, vlib_frame_t * frame)
 432 {
 433   clib_warning ("IPSec disabled");
 434   return 0;
 435 }
 436
 437 /* *INDENT-OFF* */
 438 VLIB_REGISTER_NODE (ipsec_output_node) = {
 439   .vector_size = sizeof (u32),
 440   .function = ipsec_output_node_fn,
 441   .name = "ipsec-output-ip4",
 442 };
 443
 444 VLIB_REGISTER_NODE (ipsec_output_node) = {
 445   .vector_size = sizeof (u32),
 446   .function = ipsec_output_node_fn,
 447   .name = "ipsec-output-ip6",
 448 };
 449 /* *INDENT-ON* */
 450 #endif
 451
 452 /*
 453  * fd.io coding-style-patch-verification: ON
 454  *
 455  * Local Variables:
 456  * eval: (c-set-style "gnu")
 457  * End:
 458  */