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               u32 sa_index = 0;
 274               ipsec_sa_t *sa = 0;
 275               nc_protect++;
 276               sa_index = ipsec_get_sa_index_by_sa_id (p0->sa_id);
 277               sa = pool_elt_at_index (im->sad, sa_index);
 278               if (sa->protocol == IPSEC_PROTOCOL_ESP)
 279                 next_node_index = im->esp_encrypt_node_index;
 280               else
 281                 next_node_index = im->ah_encrypt_node_index;
 282               vnet_buffer (b0)->ipsec.sad_index = p0->sa_index;
 283               vlib_buffer_advance (b0, iph_offset);
 284               p0->counter.packets++;
 285               if (is_ipv6)
 286                 {
 287                   p0->counter.bytes +=
 288                     clib_net_to_host_u16 (ip6_0->payload_length);
 289                   p0->counter.bytes += sizeof (ip6_header_t);
 290                 }
 291               else
 292                 {
 293                   p0->counter.bytes += clib_net_to_host_u16 (ip0->length);
 294                 }
 295             }
 296           else if (p0->policy == IPSEC_POLICY_ACTION_BYPASS)
 297             {
 298               nc_bypass++;
 299               next_node_index = get_next_output_feature_node_index (b0, node);
 300               p0->counter.packets++;
 301               if (is_ipv6)
 302                 {
 303                   p0->counter.bytes +=
 304                     clib_net_to_host_u16 (ip6_0->payload_length);
 305                   p0->counter.bytes += sizeof (ip6_header_t);
 306                 }
 307               else
 308                 {
 309                   p0->counter.bytes += clib_net_to_host_u16 (ip0->length);
 310                 }
 311             }
 312           else
 313             {
 314               nc_discard++;
 315               p0->counter.packets++;
 316               if (is_ipv6)
 317                 {
 318                   p0->counter.bytes +=
 319                     clib_net_to_host_u16 (ip6_0->payload_length);
 320                   p0->counter.bytes += sizeof (ip6_header_t);
 321                 }
 322               else
 323                 {
 324                   p0->counter.bytes += clib_net_to_host_u16 (ip0->length);
 325                 }
 326               next_node_index = im->error_drop_node_index;
 327             }
 328         }
 329       else
 330         {
 331           nc_nomatch++;
 332           next_node_index = im->error_drop_node_index;
 333         }
 334
 335       from += 1;
 336       n_left_from -= 1;
 337
 338       if (PREDICT_FALSE ((last_next_node_index != next_node_index) || f == 0))
 339         {
 340           /* if this is not 1st frame */
 341           if (f)
 342             vlib_put_frame_to_node (vm, last_next_node_index, f);
 343
 344           last_next_node_index = next_node_index;
 345
 346           f = vlib_get_frame_to_node (vm, next_node_index);
 347           to_next = vlib_frame_vector_args (f);
 348         }
 349
 350       to_next[0] = bi0;
 351       to_next += 1;
 352       f->n_vectors++;
 353
 354       if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
 355         {
 356           ipsec_output_trace_t *tr =
 357             vlib_add_trace (vm, node, b0, sizeof (*tr));
 358           if (spd0)
 359             tr->spd_id = spd0->id;
 360         }
 361     }
 362
 363   vlib_put_frame_to_node (vm, next_node_index, f);
 364   vlib_node_increment_counter (vm, node->node_index,
 365                                IPSEC_OUTPUT_ERROR_POLICY_PROTECT, nc_protect);
 366   vlib_node_increment_counter (vm, node->node_index,
 367                                IPSEC_OUTPUT_ERROR_POLICY_BYPASS, nc_bypass);
 368   vlib_node_increment_counter (vm, node->node_index,
 369                                IPSEC_OUTPUT_ERROR_POLICY_DISCARD, nc_discard);
 370   vlib_node_increment_counter (vm, node->node_index,
 371                                IPSEC_OUTPUT_ERROR_POLICY_NO_MATCH,
 372                                nc_nomatch);
 373   return from_frame->n_vectors;
 374 }
 375
 376 static uword
 377 ipsec_output_ip4_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
 378                           vlib_frame_t * frame)
 379 {
 380   return ipsec_output_inline (vm, node, frame, 0);
 381 }
 382
 383 /* *INDENT-OFF* */
 384 VLIB_REGISTER_NODE (ipsec_output_ip4_node,static) = {
 385   .function = ipsec_output_ip4_node_fn,
 386   .name = "ipsec-output-ip4",
 387   .vector_size = sizeof (u32),
 388   .format_trace = format_ipsec_output_trace,
 389   .type = VLIB_NODE_TYPE_INTERNAL,
 390
 391   .n_errors = ARRAY_LEN(ipsec_output_error_strings),
 392   .error_strings = ipsec_output_error_strings,
 393
 394   .n_next_nodes = IPSEC_OUTPUT_N_NEXT,
 395   .next_nodes = {
 396 #define _(s,n) [IPSEC_OUTPUT_NEXT_##s] = n,
 397     foreach_ipsec_output_next
 398 #undef _
 399   },
 400 };
 401 /* *INDENT-ON* */
 402
 403 VLIB_NODE_FUNCTION_MULTIARCH (ipsec_output_ip4_node, ipsec_output_ip4_node_fn)
 404      static uword
 405        ipsec_output_ip6_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
 406                                  vlib_frame_t * frame)
 407 {
 408   return ipsec_output_inline (vm, node, frame, 1);
 409 }
 410
 411 /* *INDENT-OFF* */
 412 VLIB_REGISTER_NODE (ipsec_output_ip6_node,static) = {
 413   .function = ipsec_output_ip6_node_fn,
 414   .name = "ipsec-output-ip6",
 415   .vector_size = sizeof (u32),
 416   .format_trace = format_ipsec_output_trace,
 417   .type = VLIB_NODE_TYPE_INTERNAL,
 418
 419   .n_errors = ARRAY_LEN(ipsec_output_error_strings),
 420   .error_strings = ipsec_output_error_strings,
 421
 422   .n_next_nodes = IPSEC_OUTPUT_N_NEXT,
 423   .next_nodes = {
 424 #define _(s,n) [IPSEC_OUTPUT_NEXT_##s] = n,
 425     foreach_ipsec_output_next
 426 #undef _
 427   },
 428 };
 429 /* *INDENT-ON* */
 430
 431 VLIB_NODE_FUNCTION_MULTIARCH (ipsec_output_ip6_node, ipsec_output_ip6_node_fn)
 432 #else /* IPSEC > 1 */
 433
 434 /* Dummy ipsec output node, in case when IPSec is disabled */
 435
 436 static uword
 437 ipsec_output_node_fn (vlib_main_t * vm,
 438                       vlib_node_runtime_t * node, vlib_frame_t * frame)
 439 {
 440   clib_warning ("IPSec disabled");
 441   return 0;
 442 }
 443
 444 /* *INDENT-OFF* */
 445 VLIB_REGISTER_NODE (ipsec_output_node) = {
 446   .vector_size = sizeof (u32),
 447   .function = ipsec_output_node_fn,
 448   .name = "ipsec-output-ip4",
 449 };
 450
 451 VLIB_REGISTER_NODE (ipsec_output_node) = {
 452   .vector_size = sizeof (u32),
 453   .function = ipsec_output_node_fn,
 454   .name = "ipsec-output-ip6",
 455 };
 456 /* *INDENT-ON* */
 457 #endif
 458
 459 /*
 460  * fd.io coding-style-patch-verification: ON
 461  *
 462  * Local Variables:
 463  * eval: (c-set-style "gnu")
 464  * End:
 465  */