src/vnet/ipsec/esp_decrypt.c

   1 /*
   2  * esp_decrypt.c : IPSec ESP decrypt 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/esp.h>
  24 #include <vnet/ipsec/ipsec_io.h>
  25
  26 #define foreach_esp_decrypt_next                \
  27 _(DROP, "error-drop")                           \
  28 _(IP4_INPUT, "ip4-input-no-checksum")           \
  29 _(IP6_INPUT, "ip6-input")                       \
  30 _(IPSEC_GRE_INPUT, "ipsec-gre-input")
  31
  32 #define _(v, s) ESP_DECRYPT_NEXT_##v,
  33 typedef enum
  34 {
  35   foreach_esp_decrypt_next
  36 #undef _
  37     ESP_DECRYPT_N_NEXT,
  38 } esp_decrypt_next_t;
  39
  40
  41 #define foreach_esp_decrypt_error                               \
  42  _(RX_PKTS, "ESP pkts received")                                \
  43  _(DECRYPTION_FAILED, "ESP decryption failed")                  \
  44  _(INTEG_ERROR, "Integrity check failed")                       \
  45  _(CRYPTO_ENGINE_ERROR, "crypto engine error (packet dropped)") \
  46  _(REPLAY, "SA replayed packet")                                \
  47  _(RUNT, "undersized packet")                                   \
  48  _(CHAINED_BUFFER, "chained buffers (packet dropped)")          \
  49  _(OVERSIZED_HEADER, "buffer with oversized header (dropped)")  \
  50  _(NO_TAIL_SPACE, "no enough buffer tail space (dropped)")
  51
  52
  53 typedef enum
  54 {
  55 #define _(sym,str) ESP_DECRYPT_ERROR_##sym,
  56   foreach_esp_decrypt_error
  57 #undef _
  58     ESP_DECRYPT_N_ERROR,
  59 } esp_decrypt_error_t;
  60
  61 static char *esp_decrypt_error_strings[] = {
  62 #define _(sym,string) string,
  63   foreach_esp_decrypt_error
  64 #undef _
  65 };
  66
  67 typedef struct
  68 {
  69   u32 seq;
  70   ipsec_crypto_alg_t crypto_alg;
  71   ipsec_integ_alg_t integ_alg;
  72 } esp_decrypt_trace_t;
  73
  74 /* packet trace format function */
  75 static u8 *
  76 format_esp_decrypt_trace (u8 * s, va_list * args)
  77 {
  78   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  79   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  80   esp_decrypt_trace_t *t = va_arg (*args, esp_decrypt_trace_t *);
  81
  82   s = format (s, "esp: crypto %U integrity %U seq %u",
  83               format_ipsec_crypto_alg, t->crypto_alg,
  84               format_ipsec_integ_alg, t->integ_alg, t->seq);
  85   return s;
  86 }
  87
  88 typedef struct
  89 {
  90   union
  91   {
  92     struct
  93     {
  94       u8 icv_sz;
  95       u8 iv_sz;
  96       ipsec_sa_flags_t flags:8;
  97       u32 sa_index;
  98     };
  99     u64 sa_data;
 100   };
 101
 102   i16 current_data;
 103   i16 current_length;
 104   u16 hdr_sz;
 105 } esp_decrypt_packet_data_t;
 106
 107 STATIC_ASSERT_SIZEOF (esp_decrypt_packet_data_t, 2 * sizeof (u64));
 108
 109 #define ESP_ENCRYPT_PD_F_FD_TRANSPORT (1 << 2)
 110
 111 always_inline uword
 112 esp_decrypt_inline (vlib_main_t * vm,
 113                     vlib_node_runtime_t * node, vlib_frame_t * from_frame,
 114                     int is_ip6)
 115 {
 116   ipsec_main_t *im = &ipsec_main;
 117   u32 thread_index = vm->thread_index;
 118   u16 buffer_data_size = vlib_buffer_get_default_data_size (vm);
 119   u16 len;
 120   ipsec_per_thread_data_t *ptd = vec_elt_at_index (im->ptd, thread_index);
 121   u32 *from = vlib_frame_vector_args (from_frame);
 122   u32 n, n_left = from_frame->n_vectors;
 123   vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
 124   u16 nexts[VLIB_FRAME_SIZE], *next = nexts;
 125   esp_decrypt_packet_data_t pkt_data[VLIB_FRAME_SIZE], *pd = pkt_data;
 126   esp_decrypt_packet_data_t cpd = { };
 127   u32 current_sa_index = ~0, current_sa_bytes = 0, current_sa_pkts = 0;
 128   const u8 esp_sz = sizeof (esp_header_t);
 129   ipsec_sa_t *sa0 = 0;
 130
 131   vlib_get_buffers (vm, from, b, n_left);
 132   vec_reset_length (ptd->crypto_ops);
 133   vec_reset_length (ptd->integ_ops);
 134   clib_memset_u16 (nexts, -1, n_left);
 135
 136   while (n_left > 0)
 137     {
 138       u8 *payload;
 139
 140       if (n_left > 2)
 141         {
 142           u8 *p;
 143           vlib_prefetch_buffer_header (b[2], LOAD);
 144           p = vlib_buffer_get_current (b[1]);
 145           CLIB_PREFETCH (p, CLIB_CACHE_LINE_BYTES, LOAD);
 146           p -= CLIB_CACHE_LINE_BYTES;
 147           CLIB_PREFETCH (p, CLIB_CACHE_LINE_BYTES, LOAD);
 148         }
 149
 150       if (vlib_buffer_chain_linearize (vm, b[0]) != 1)
 151         {
 152           b[0]->error = node->errors[ESP_DECRYPT_ERROR_CHAINED_BUFFER];
 153           next[0] = ESP_DECRYPT_NEXT_DROP;
 154           goto next;
 155         }
 156
 157       if (vnet_buffer (b[0])->ipsec.sad_index != current_sa_index)
 158         {
 159           current_sa_index = vnet_buffer (b[0])->ipsec.sad_index;
 160           sa0 = pool_elt_at_index (im->sad, current_sa_index);
 161           cpd.icv_sz = sa0->integ_icv_size;
 162           cpd.iv_sz = sa0->crypto_iv_size;
 163           cpd.flags = sa0->flags;
 164           cpd.sa_index = current_sa_index;
 165
 166           vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
 167                                            current_sa_index, current_sa_pkts,
 168                                            current_sa_bytes);
 169
 170           current_sa_bytes = current_sa_pkts = 0;
 171         }
 172
 173       /* store packet data for next round for easier prefetch */
 174       pd->sa_data = cpd.sa_data;
 175       pd->current_data = b[0]->current_data;
 176       pd->current_length = b[0]->current_length;
 177       pd->hdr_sz = pd->current_data - vnet_buffer (b[0])->l3_hdr_offset;
 178       payload = b[0]->data + pd->current_data;
 179
 180       /* we need 4 extra bytes for HMAC calculation when ESN are used */
 181       if (ipsec_sa_is_set_USE_ESN (sa0) && pd->icv_sz &&
 182           (pd->current_data + pd->current_length + 4 > buffer_data_size))
 183         {
 184           b[0]->error = node->errors[ESP_DECRYPT_ERROR_NO_TAIL_SPACE];
 185           next[0] = ESP_DECRYPT_NEXT_DROP;
 186           goto next;
 187         }
 188
 189       /* anti-reply check */
 190       if (ipsec_sa_anti_replay_check (sa0, &((esp_header_t *) payload)->seq))
 191         {
 192           b[0]->error = node->errors[ESP_DECRYPT_ERROR_REPLAY];
 193           next[0] = ESP_DECRYPT_NEXT_DROP;
 194           goto next;
 195         }
 196
 197       if (pd->current_length < cpd.icv_sz + esp_sz + cpd.iv_sz)
 198         {
 199           b[0]->error = node->errors[ESP_DECRYPT_ERROR_RUNT];
 200           next[0] = ESP_DECRYPT_NEXT_DROP;
 201           goto next;
 202         }
 203
 204       len = pd->current_length - cpd.icv_sz;
 205       current_sa_pkts += 1;
 206       current_sa_bytes += pd->current_length;
 207
 208       if (PREDICT_TRUE (sa0->integ_op_id != VNET_CRYPTO_OP_NONE))
 209         {
 210           vnet_crypto_op_t *op;
 211           vec_add2_aligned (ptd->integ_ops, op, 1, CLIB_CACHE_LINE_BYTES);
 212
 213           vnet_crypto_op_init (op, sa0->integ_op_id);
 214           op->key_index = sa0->integ_key_index;
 215           op->src = payload;
 216           op->flags = VNET_CRYPTO_OP_FLAG_HMAC_CHECK;
 217           op->user_data = b - bufs;
 218           op->digest = payload + len;
 219           op->digest_len = cpd.icv_sz;
 220           op->len = len;
 221           if (ipsec_sa_is_set_USE_ESN (sa0))
 222             {
 223               /* shift ICV for 4 bytes to insert ESN */
 224               u8 tmp[ESP_MAX_ICV_SIZE], sz = sizeof (sa0->seq_hi);
 225               clib_memcpy_fast (tmp, payload + len, ESP_MAX_ICV_SIZE);
 226               clib_memcpy_fast (payload + len, &sa0->seq_hi, sz);
 227               clib_memcpy_fast (payload + len + sz, tmp, ESP_MAX_ICV_SIZE);
 228               op->len += sz;
 229               op->digest += sz;
 230             }
 231         }
 232
 233       payload += esp_sz;
 234       len -= esp_sz;
 235
 236       if (sa0->crypto_enc_op_id != VNET_CRYPTO_OP_NONE)
 237         {
 238           vnet_crypto_op_t *op;
 239           vec_add2_aligned (ptd->crypto_ops, op, 1, CLIB_CACHE_LINE_BYTES);
 240           vnet_crypto_op_init (op, sa0->crypto_dec_op_id);
 241           op->key_index = sa0->crypto_key_index;
 242           op->iv = payload;
 243
 244           if (ipsec_sa_is_set_IS_AEAD (sa0))
 245             {
 246               esp_header_t *esp0;
 247               esp_aead_t *aad;
 248               u8 *scratch;
 249
 250               /*
 251                * construct the AAD and the nonce (Salt || IV) in a scratch
 252                * space in front of the IP header.
 253                */
 254               scratch = payload - esp_sz;
 255               esp0 = (esp_header_t *) (scratch);
 256
 257               scratch -= (sizeof (*aad) + pd->hdr_sz);
 258               op->aad = scratch;
 259
 260               esp_aad_fill (op, esp0, sa0);
 261
 262               /*
 263                * we don't need to refer to the ESP header anymore so we
 264                * can overwrite it with the salt and use the IV where it is
 265                * to form the nonce = (Salt + IV)
 266                */
 267               op->iv -= sizeof (sa0->salt);
 268               clib_memcpy_fast (op->iv, &sa0->salt, sizeof (sa0->salt));
 269
 270               op->tag = payload + len;
 271               op->tag_len = 16;
 272             }
 273           op->src = op->dst = payload += cpd.iv_sz;
 274           op->len = len - cpd.iv_sz;
 275           op->user_data = b - bufs;
 276         }
 277
 278       /* next */
 279     next:
 280       n_left -= 1;
 281       next += 1;
 282       pd += 1;
 283       b += 1;
 284     }
 285
 286   vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
 287                                    current_sa_index, current_sa_pkts,
 288                                    current_sa_bytes);
 289
 290   if ((n = vec_len (ptd->integ_ops)))
 291     {
 292       vnet_crypto_op_t *op = ptd->integ_ops;
 293       n -= vnet_crypto_process_ops (vm, op, n);
 294       while (n)
 295         {
 296           ASSERT (op - ptd->integ_ops < vec_len (ptd->integ_ops));
 297           if (op->status != VNET_CRYPTO_OP_STATUS_COMPLETED)
 298             {
 299               u32 err, bi = op->user_data;
 300               if (op->status == VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC)
 301                 err = ESP_DECRYPT_ERROR_INTEG_ERROR;
 302               else
 303                 err = ESP_DECRYPT_ERROR_CRYPTO_ENGINE_ERROR;
 304               bufs[bi]->error = node->errors[err];
 305               nexts[bi] = ESP_DECRYPT_NEXT_DROP;
 306               n--;
 307             }
 308           op++;
 309         }
 310     }
 311   if ((n = vec_len (ptd->crypto_ops)))
 312     {
 313       vnet_crypto_op_t *op = ptd->crypto_ops;
 314       n -= vnet_crypto_process_ops (vm, op, n);
 315       while (n)
 316         {
 317           ASSERT (op - ptd->crypto_ops < vec_len (ptd->crypto_ops));
 318           if (op->status != VNET_CRYPTO_OP_STATUS_COMPLETED)
 319             {
 320               u32 err, bi;
 321
 322               bi = op->user_data;
 323
 324               if (op->status == VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC)
 325                 err = ESP_DECRYPT_ERROR_DECRYPTION_FAILED;
 326               else
 327                 err = ESP_DECRYPT_ERROR_CRYPTO_ENGINE_ERROR;
 328
 329               bufs[bi]->error = node->errors[err];
 330               nexts[bi] = ESP_DECRYPT_NEXT_DROP;
 331               n--;
 332             }
 333           op++;
 334         }
 335     }
 336
 337   /* Post decryption ronud - adjust packet data start and length and next
 338      node */
 339
 340   n_left = from_frame->n_vectors;
 341   next = nexts;
 342   pd = pkt_data;
 343   b = bufs;
 344
 345   while (n_left)
 346     {
 347       const u8 tun_flags = IPSEC_SA_FLAG_IS_TUNNEL |
 348         IPSEC_SA_FLAG_IS_TUNNEL_V6;
 349
 350       if (n_left >= 2)
 351         {
 352           void *data = b[1]->data + pd[1].current_data;
 353
 354           /* buffer metadata */
 355           vlib_prefetch_buffer_header (b[1], LOAD);
 356
 357           /* esp_footer_t */
 358           CLIB_PREFETCH (data + pd[1].current_length - pd[1].icv_sz - 2,
 359                          CLIB_CACHE_LINE_BYTES, LOAD);
 360
 361           /* packet headers */
 362           CLIB_PREFETCH (data - CLIB_CACHE_LINE_BYTES,
 363                          CLIB_CACHE_LINE_BYTES * 2, LOAD);
 364         }
 365
 366       if (next[0] < ESP_DECRYPT_N_NEXT)
 367         goto trace;
 368
 369       sa0 = vec_elt_at_index (im->sad, pd->sa_index);
 370       u8 *payload = b[0]->data + pd->current_data;
 371
 372       ipsec_sa_anti_replay_advance (sa0, ((esp_header_t *) payload)->seq);
 373
 374       esp_footer_t *f = (esp_footer_t *) (b[0]->data + pd->current_data +
 375                                           pd->current_length - sizeof (*f) -
 376                                           pd->icv_sz);
 377       u16 adv = pd->iv_sz + esp_sz;
 378       u16 tail = sizeof (esp_footer_t) + f->pad_length + pd->icv_sz;
 379
 380       if ((pd->flags & tun_flags) == 0) /* transport mode */
 381         {
 382           u8 udp_sz = (is_ip6 == 0 && pd->flags & IPSEC_SA_FLAG_UDP_ENCAP) ?
 383             sizeof (udp_header_t) : 0;
 384           u16 ip_hdr_sz = pd->hdr_sz - udp_sz;
 385           u8 *old_ip = b[0]->data + pd->current_data - ip_hdr_sz - udp_sz;
 386           u8 *ip = old_ip + adv + udp_sz;
 387
 388           if (is_ip6 && ip_hdr_sz > 64)
 389             memmove (ip, old_ip, ip_hdr_sz);
 390           else
 391             clib_memcpy_le64 (ip, old_ip, ip_hdr_sz);
 392
 393           b[0]->current_data = pd->current_data + adv - ip_hdr_sz;
 394           b[0]->current_length = pd->current_length + ip_hdr_sz - tail - adv;
 395
 396           if (is_ip6)
 397             {
 398               ip6_header_t *ip6 = (ip6_header_t *) ip;
 399               u16 len = clib_net_to_host_u16 (ip6->payload_length);
 400               len -= adv + tail;
 401               ip6->payload_length = clib_host_to_net_u16 (len);
 402               ip6->protocol = f->next_header;
 403               next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
 404             }
 405           else
 406             {
 407               ip4_header_t *ip4 = (ip4_header_t *) ip;
 408               ip_csum_t sum = ip4->checksum;
 409               u16 len = clib_net_to_host_u16 (ip4->length);
 410               len = clib_host_to_net_u16 (len - adv - tail - udp_sz);
 411               sum = ip_csum_update (sum, ip4->protocol, f->next_header,
 412                                     ip4_header_t, protocol);
 413               sum = ip_csum_update (sum, ip4->length, len,
 414                                     ip4_header_t, length);
 415               ip4->checksum = ip_csum_fold (sum);
 416               ip4->protocol = f->next_header;
 417               ip4->length = len;
 418               next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
 419             }
 420         }
 421       else
 422         {
 423           if (PREDICT_TRUE (f->next_header == IP_PROTOCOL_IP_IN_IP))
 424             {
 425               next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
 426               b[0]->current_data = pd->current_data + adv;
 427               b[0]->current_length = pd->current_length + adv - tail;
 428             }
 429           else if (f->next_header == IP_PROTOCOL_IPV6)
 430             {
 431               next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
 432               b[0]->current_data = pd->current_data + adv;
 433               b[0]->current_length = pd->current_length + adv - tail;
 434             }
 435           else
 436             {
 437               next[0] = ESP_DECRYPT_NEXT_DROP;
 438               b[0]->error = node->errors[ESP_DECRYPT_ERROR_DECRYPTION_FAILED];
 439             }
 440         }
 441
 442       if (PREDICT_FALSE (ipsec_sa_is_set_IS_GRE (sa0)))
 443         next[0] = ESP_DECRYPT_NEXT_IPSEC_GRE_INPUT;
 444
 445     trace:
 446       if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
 447         {
 448           esp_decrypt_trace_t *tr;
 449           u8 *payload = b[0]->data + pd->current_data;
 450           tr = vlib_add_trace (vm, node, b[0], sizeof (*tr));
 451           sa0 = pool_elt_at_index (im->sad,
 452                                    vnet_buffer (b[0])->ipsec.sad_index);
 453           tr->crypto_alg = sa0->crypto_alg;
 454           tr->integ_alg = sa0->integ_alg;
 455           tr->seq = clib_host_to_net_u32 (((esp_header_t *) payload)->seq);
 456         }
 457
 458       /* next */
 459       n_left -= 1;
 460       next += 1;
 461       pd += 1;
 462       b += 1;
 463     }
 464
 465   n_left = from_frame->n_vectors;
 466   vlib_node_increment_counter (vm, node->node_index,
 467                                ESP_DECRYPT_ERROR_RX_PKTS, n_left);
 468
 469   vlib_buffer_enqueue_to_next (vm, node, from, nexts, n_left);
 470
 471   b = bufs;
 472   return n_left;
 473 }
 474
 475 VLIB_NODE_FN (esp4_decrypt_node) (vlib_main_t * vm,
 476                                   vlib_node_runtime_t * node,
 477                                   vlib_frame_t * from_frame)
 478 {
 479   return esp_decrypt_inline (vm, node, from_frame, 0 /* is_ip6 */ );
 480 }
 481
 482 /* *INDENT-OFF* */
 483 VLIB_REGISTER_NODE (esp4_decrypt_node) = {
 484   .name = "esp4-decrypt",
 485   .vector_size = sizeof (u32),
 486   .format_trace = format_esp_decrypt_trace,
 487   .type = VLIB_NODE_TYPE_INTERNAL,
 488
 489   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
 490   .error_strings = esp_decrypt_error_strings,
 491
 492   .n_next_nodes = ESP_DECRYPT_N_NEXT,
 493   .next_nodes = {
 494 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
 495     foreach_esp_decrypt_next
 496 #undef _
 497   },
 498 };
 499 /* *INDENT-ON* */
 500
 501 VLIB_NODE_FN (esp6_decrypt_node) (vlib_main_t * vm,
 502                                   vlib_node_runtime_t * node,
 503                                   vlib_frame_t * from_frame)
 504 {
 505   return esp_decrypt_inline (vm, node, from_frame, 1 /* is_ip6 */ );
 506 }
 507
 508 /* *INDENT-OFF* */
 509 VLIB_REGISTER_NODE (esp6_decrypt_node) = {
 510   .name = "esp6-decrypt",
 511   .vector_size = sizeof (u32),
 512   .format_trace = format_esp_decrypt_trace,
 513   .type = VLIB_NODE_TYPE_INTERNAL,
 514
 515   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
 516   .error_strings = esp_decrypt_error_strings,
 517
 518   .n_next_nodes = ESP_DECRYPT_N_NEXT,
 519   .next_nodes = {
 520 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
 521     foreach_esp_decrypt_next
 522 #undef _
 523   },
 524 };
 525 /* *INDENT-ON* */
 526
 527 /*
 528  * fd.io coding-style-patch-verification: ON
 529  *
 530  * Local Variables:
 531  * eval: (c-set-style "gnu")
 532  * End:
 533  */