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 #include <vnet/l2/l2_input.h>
  22
  23 #include <vnet/ipsec/ipsec.h>
  24 #include <vnet/ipsec/esp.h>
  25 #include <vnet/ipsec/ipsec_io.h>
  26 #include <vnet/ipsec/ipsec_tun.h>
  27
  28 #include <vnet/gre/packet.h>
  29
  30 #define foreach_esp_decrypt_next                                              \
  31   _ (DROP, "error-drop")                                                      \
  32   _ (IP4_INPUT, "ip4-input-no-checksum")                                      \
  33   _ (IP6_INPUT, "ip6-input")                                                  \
  34   _ (L2_INPUT, "l2-input")                                                    \
  35   _ (MPLS_INPUT, "mpls-input")                                                \
  36   _ (HANDOFF, "handoff")
  37
  38 #define _(v, s) ESP_DECRYPT_NEXT_##v,
  39 typedef enum
  40 {
  41   foreach_esp_decrypt_next
  42 #undef _
  43     ESP_DECRYPT_N_NEXT,
  44 } esp_decrypt_next_t;
  45
  46 #define foreach_esp_decrypt_post_next                                         \
  47   _ (DROP, "error-drop")                                                      \
  48   _ (IP4_INPUT, "ip4-input-no-checksum")                                      \
  49   _ (IP6_INPUT, "ip6-input")                                                  \
  50   _ (MPLS_INPUT, "mpls-input")                                                \
  51   _ (L2_INPUT, "l2-input")
  52
  53 #define _(v, s) ESP_DECRYPT_POST_NEXT_##v,
  54 typedef enum
  55 {
  56   foreach_esp_decrypt_post_next
  57 #undef _
  58     ESP_DECRYPT_POST_N_NEXT,
  59 } esp_decrypt_post_next_t;
  60
  61 #define foreach_esp_decrypt_error                                             \
  62   _ (RX_PKTS, "ESP pkts received")                                            \
  63   _ (RX_POST_PKTS, "ESP-POST pkts received")                                  \
  64   _ (HANDOFF, "hand-off")                                                     \
  65   _ (DECRYPTION_FAILED, "ESP decryption failed")                              \
  66   _ (INTEG_ERROR, "Integrity check failed")                                   \
  67   _ (CRYPTO_ENGINE_ERROR, "crypto engine error (packet dropped)")             \
  68   _ (REPLAY, "SA replayed packet")                                            \
  69   _ (RUNT, "undersized packet")                                               \
  70   _ (NO_BUFFERS, "no buffers (packet dropped)")                               \
  71   _ (OVERSIZED_HEADER, "buffer with oversized header (dropped)")              \
  72   _ (NO_TAIL_SPACE, "no enough buffer tail space (dropped)")                  \
  73   _ (TUN_NO_PROTO, "no tunnel protocol")                                      \
  74   _ (UNSUP_PAYLOAD, "unsupported payload")
  75
  76 typedef enum
  77 {
  78 #define _(sym,str) ESP_DECRYPT_ERROR_##sym,
  79   foreach_esp_decrypt_error
  80 #undef _
  81     ESP_DECRYPT_N_ERROR,
  82 } esp_decrypt_error_t;
  83
  84 static char *esp_decrypt_error_strings[] = {
  85 #define _(sym,string) string,
  86   foreach_esp_decrypt_error
  87 #undef _
  88 };
  89
  90 typedef struct
  91 {
  92   u32 seq;
  93   u32 sa_seq;
  94   u32 sa_seq_hi;
  95   u32 pkt_seq_hi;
  96   ipsec_crypto_alg_t crypto_alg;
  97   ipsec_integ_alg_t integ_alg;
  98 } esp_decrypt_trace_t;
  99
 100 /* The number of byres in the hisequence number */
 101 #define N_HI_ESN_BYTES 4
 102
 103 /* packet trace format function */
 104 static u8 *
 105 format_esp_decrypt_trace (u8 * s, va_list * args)
 106 {
 107   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
 108   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
 109   esp_decrypt_trace_t *t = va_arg (*args, esp_decrypt_trace_t *);
 110
 111   s = format (s,
 112               "esp: crypto %U integrity %U pkt-seq %d sa-seq %u sa-seq-hi %u "
 113               "pkt-seq-hi %u",
 114               format_ipsec_crypto_alg, t->crypto_alg, format_ipsec_integ_alg,
 115               t->integ_alg, t->seq, t->sa_seq, t->sa_seq_hi, t->pkt_seq_hi);
 116   return s;
 117 }
 118
 119 #define ESP_ENCRYPT_PD_F_FD_TRANSPORT (1 << 2)
 120
 121 static_always_inline void
 122 esp_process_ops (vlib_main_t * vm, vlib_node_runtime_t * node,
 123                  vnet_crypto_op_t * ops, vlib_buffer_t * b[], u16 * nexts,
 124                  int e)
 125 {
 126   vnet_crypto_op_t *op = ops;
 127   u32 n_fail, n_ops = vec_len (ops);
 128
 129   if (n_ops == 0)
 130     return;
 131
 132   n_fail = n_ops - vnet_crypto_process_ops (vm, op, n_ops);
 133
 134   while (n_fail)
 135     {
 136       ASSERT (op - ops < n_ops);
 137       if (op->status != VNET_CRYPTO_OP_STATUS_COMPLETED)
 138         {
 139           u32 err, bi = op->user_data;
 140           if (op->status == VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC)
 141             err = e;
 142           else
 143             err = ESP_DECRYPT_ERROR_CRYPTO_ENGINE_ERROR;
 144           b[bi]->error = node->errors[err];
 145           nexts[bi] = ESP_DECRYPT_NEXT_DROP;
 146           n_fail--;
 147         }
 148       op++;
 149     }
 150 }
 151
 152 static_always_inline void
 153 esp_process_chained_ops (vlib_main_t * vm, vlib_node_runtime_t * node,
 154                          vnet_crypto_op_t * ops, vlib_buffer_t * b[],
 155                          u16 * nexts, vnet_crypto_op_chunk_t * chunks, int e)
 156 {
 157
 158   vnet_crypto_op_t *op = ops;
 159   u32 n_fail, n_ops = vec_len (ops);
 160
 161   if (PREDICT_TRUE (n_ops == 0))
 162     return;
 163
 164   n_fail = n_ops - vnet_crypto_process_chained_ops (vm, op, chunks, n_ops);
 165
 166   while (n_fail)
 167     {
 168       ASSERT (op - ops < n_ops);
 169       if (op->status != VNET_CRYPTO_OP_STATUS_COMPLETED)
 170         {
 171           u32 err, bi = op->user_data;
 172           if (op->status == VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC)
 173             err = e;
 174           else
 175             err = ESP_DECRYPT_ERROR_CRYPTO_ENGINE_ERROR;
 176           b[bi]->error = node->errors[err];
 177           nexts[bi] = ESP_DECRYPT_NEXT_DROP;
 178           n_fail--;
 179         }
 180       op++;
 181     }
 182 }
 183
 184 always_inline void
 185 esp_remove_tail (vlib_main_t * vm, vlib_buffer_t * b, vlib_buffer_t * last,
 186                  u16 tail)
 187 {
 188   vlib_buffer_t *before_last = b;
 189
 190   if (last->current_length > tail)
 191     {
 192       last->current_length -= tail;
 193       return;
 194     }
 195   ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
 196
 197   while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
 198     {
 199       before_last = b;
 200       b = vlib_get_buffer (vm, b->next_buffer);
 201     }
 202   before_last->current_length -= tail - last->current_length;
 203   vlib_buffer_free_one (vm, before_last->next_buffer);
 204   before_last->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
 205 }
 206
 207 /* ICV is splitted in last two buffers so move it to the last buffer and
 208    return pointer to it */
 209 static_always_inline u8 *
 210 esp_move_icv (vlib_main_t * vm, vlib_buffer_t * first,
 211               esp_decrypt_packet_data_t * pd,
 212               esp_decrypt_packet_data2_t * pd2, u16 icv_sz, u16 * dif)
 213 {
 214   vlib_buffer_t *before_last, *bp;
 215   u16 last_sz = pd2->lb->current_length;
 216   u16 first_sz = icv_sz - last_sz;
 217
 218   bp = before_last = first;
 219   while (bp->flags & VLIB_BUFFER_NEXT_PRESENT)
 220     {
 221       before_last = bp;
 222       bp = vlib_get_buffer (vm, bp->next_buffer);
 223     }
 224
 225   u8 *lb_curr = vlib_buffer_get_current (pd2->lb);
 226   memmove (lb_curr + first_sz, lb_curr, last_sz);
 227   clib_memcpy_fast (lb_curr, vlib_buffer_get_tail (before_last) - first_sz,
 228                     first_sz);
 229   before_last->current_length -= first_sz;
 230   if (before_last == first)
 231     pd->current_length -= first_sz;
 232   clib_memset (vlib_buffer_get_tail (before_last), 0, first_sz);
 233   if (dif)
 234     dif[0] = first_sz;
 235   pd2->lb = before_last;
 236   pd2->icv_removed = 1;
 237   pd2->free_buffer_index = before_last->next_buffer;
 238   before_last->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
 239   return lb_curr;
 240 }
 241
 242 static_always_inline u16
 243 esp_insert_esn (vlib_main_t *vm, ipsec_sa_t *sa, esp_decrypt_packet_data_t *pd,
 244                 esp_decrypt_packet_data2_t *pd2, u32 *data_len, u8 **digest,
 245                 u16 *len, vlib_buffer_t *b, u8 *payload)
 246 {
 247   if (!ipsec_sa_is_set_USE_ESN (sa))
 248     return 0;
 249   /* shift ICV by 4 bytes to insert ESN */
 250   u32 seq_hi = clib_host_to_net_u32 (pd->seq_hi);
 251   u8 tmp[ESP_MAX_ICV_SIZE];
 252
 253   if (pd2->icv_removed)
 254     {
 255       u16 space_left = vlib_buffer_space_left_at_end (vm, pd2->lb);
 256       if (space_left >= N_HI_ESN_BYTES)
 257         {
 258           clib_memcpy_fast (vlib_buffer_get_tail (pd2->lb), &seq_hi,
 259                             N_HI_ESN_BYTES);
 260           *data_len += N_HI_ESN_BYTES;
 261         }
 262       else
 263         return N_HI_ESN_BYTES;
 264
 265       len[0] = b->current_length;
 266     }
 267   else
 268     {
 269       clib_memcpy_fast (tmp, payload + len[0], ESP_MAX_ICV_SIZE);
 270       clib_memcpy_fast (payload + len[0], &seq_hi, N_HI_ESN_BYTES);
 271       clib_memcpy_fast (payload + len[0] + N_HI_ESN_BYTES, tmp,
 272                         ESP_MAX_ICV_SIZE);
 273       *data_len += N_HI_ESN_BYTES;
 274       *digest += N_HI_ESN_BYTES;
 275     }
 276   return N_HI_ESN_BYTES;
 277 }
 278
 279 static_always_inline u8 *
 280 esp_move_icv_esn (vlib_main_t * vm, vlib_buffer_t * first,
 281                   esp_decrypt_packet_data_t * pd,
 282                   esp_decrypt_packet_data2_t * pd2, u16 icv_sz,
 283                   ipsec_sa_t * sa, u8 * extra_esn, u32 * len)
 284 {
 285   u16 dif = 0;
 286   u8 *digest = esp_move_icv (vm, first, pd, pd2, icv_sz, &dif);
 287   if (dif)
 288     *len -= dif;
 289
 290   if (ipsec_sa_is_set_USE_ESN (sa))
 291     {
 292       u32 seq_hi = clib_host_to_net_u32 (pd->seq_hi);
 293       u16 space_left = vlib_buffer_space_left_at_end (vm, pd2->lb);
 294
 295       if (space_left >= N_HI_ESN_BYTES)
 296         {
 297           clib_memcpy_fast (vlib_buffer_get_tail (pd2->lb), &seq_hi,
 298                             N_HI_ESN_BYTES);
 299           *len += N_HI_ESN_BYTES;
 300         }
 301       else
 302         {
 303           /* no space for ESN at the tail, use the next buffer
 304            * (with ICV data) */
 305           ASSERT (pd2->icv_removed);
 306           vlib_buffer_t *tmp = vlib_get_buffer (vm, pd2->free_buffer_index);
 307           clib_memcpy_fast (vlib_buffer_get_current (tmp) - N_HI_ESN_BYTES,
 308                             &seq_hi, N_HI_ESN_BYTES);
 309           extra_esn[0] = 1;
 310         }
 311     }
 312   return digest;
 313 }
 314
 315 static_always_inline int
 316 esp_decrypt_chain_integ (vlib_main_t *vm, ipsec_per_thread_data_t *ptd,
 317                          const esp_decrypt_packet_data_t *pd,
 318                          esp_decrypt_packet_data2_t *pd2, ipsec_sa_t *sa0,
 319                          vlib_buffer_t *b, u8 icv_sz, u8 *start_src,
 320                          u32 start_len, u8 **digest, u16 *n_ch,
 321                          u32 *integ_total_len)
 322 {
 323   vnet_crypto_op_chunk_t *ch;
 324   vlib_buffer_t *cb = vlib_get_buffer (vm, b->next_buffer);
 325   u16 n_chunks = 1;
 326   u32 total_len;
 327   vec_add2 (ptd->chunks, ch, 1);
 328   total_len = ch->len = start_len;
 329   ch->src = start_src;
 330
 331   while (1)
 332     {
 333       vec_add2 (ptd->chunks, ch, 1);
 334       n_chunks += 1;
 335       ch->src = vlib_buffer_get_current (cb);
 336       if (pd2->lb == cb)
 337         {
 338           if (pd2->icv_removed)
 339             ch->len = cb->current_length;
 340           else
 341             ch->len = cb->current_length - icv_sz;
 342           if (ipsec_sa_is_set_USE_ESN (sa0))
 343             {
 344               u32 seq_hi = clib_host_to_net_u32 (pd->seq_hi);
 345               u8 tmp[ESP_MAX_ICV_SIZE];
 346               u8 *esn;
 347               vlib_buffer_t *tmp_b;
 348               u16 space_left = vlib_buffer_space_left_at_end (vm, pd2->lb);
 349               if (space_left < N_HI_ESN_BYTES)
 350                 {
 351                   if (pd2->icv_removed)
 352                     {
 353                       /* use pre-data area from the last bufer
 354                          that was removed from the chain */
 355                       tmp_b = vlib_get_buffer (vm, pd2->free_buffer_index);
 356                       esn = tmp_b->data - N_HI_ESN_BYTES;
 357                     }
 358                   else
 359                     {
 360                       /* no space, need to allocate new buffer */
 361                       u32 tmp_bi = 0;
 362                       if (vlib_buffer_alloc (vm, &tmp_bi, 1) != 1)
 363                         return -1;
 364                       tmp_b = vlib_get_buffer (vm, tmp_bi);
 365                       esn = tmp_b->data;
 366                       pd2->free_buffer_index = tmp_bi;
 367                     }
 368                   clib_memcpy_fast (esn, &seq_hi, N_HI_ESN_BYTES);
 369
 370                   vec_add2 (ptd->chunks, ch, 1);
 371                   n_chunks += 1;
 372                   ch->src = esn;
 373                   ch->len = N_HI_ESN_BYTES;
 374                 }
 375               else
 376                 {
 377                   if (pd2->icv_removed)
 378                     {
 379                       clib_memcpy_fast (vlib_buffer_get_tail (pd2->lb),
 380                                         &seq_hi, N_HI_ESN_BYTES);
 381                     }
 382                   else
 383                     {
 384                       clib_memcpy_fast (tmp, *digest, ESP_MAX_ICV_SIZE);
 385                       clib_memcpy_fast (*digest, &seq_hi, N_HI_ESN_BYTES);
 386                       clib_memcpy_fast (*digest + N_HI_ESN_BYTES, tmp,
 387                                         ESP_MAX_ICV_SIZE);
 388                       *digest += N_HI_ESN_BYTES;
 389                     }
 390                   ch->len += N_HI_ESN_BYTES;
 391                 }
 392             }
 393           total_len += ch->len;
 394           break;
 395         }
 396       else
 397         total_len += ch->len = cb->current_length;
 398
 399       if (!(cb->flags & VLIB_BUFFER_NEXT_PRESENT))
 400         break;
 401
 402       cb = vlib_get_buffer (vm, cb->next_buffer);
 403     }
 404
 405   if (n_ch)
 406     *n_ch = n_chunks;
 407   if (integ_total_len)
 408     *integ_total_len = total_len;
 409
 410   return 0;
 411 }
 412
 413 static_always_inline u32
 414 esp_decrypt_chain_crypto (vlib_main_t * vm, ipsec_per_thread_data_t * ptd,
 415                           esp_decrypt_packet_data_t * pd,
 416                           esp_decrypt_packet_data2_t * pd2,
 417                           ipsec_sa_t * sa0, vlib_buffer_t * b, u8 icv_sz,
 418                           u8 * start, u32 start_len, u8 ** tag, u16 * n_ch)
 419 {
 420   vnet_crypto_op_chunk_t *ch;
 421   vlib_buffer_t *cb = b;
 422   u16 n_chunks = 1;
 423   u32 total_len;
 424   vec_add2 (ptd->chunks, ch, 1);
 425   total_len = ch->len = start_len;
 426   ch->src = ch->dst = start;
 427   cb = vlib_get_buffer (vm, cb->next_buffer);
 428   n_chunks = 1;
 429
 430   while (1)
 431     {
 432       vec_add2 (ptd->chunks, ch, 1);
 433       n_chunks += 1;
 434       ch->src = ch->dst = vlib_buffer_get_current (cb);
 435       if (pd2->lb == cb)
 436         {
 437           if (ipsec_sa_is_set_IS_AEAD (sa0))
 438             {
 439               if (pd2->lb->current_length < icv_sz)
 440                 {
 441                   u16 dif = 0;
 442                   *tag = esp_move_icv (vm, b, pd, pd2, icv_sz, &dif);
 443
 444                   /* this chunk does not contain crypto data */
 445                   n_chunks -= 1;
 446                   /* and fix previous chunk's length as it might have
 447                      been changed */
 448                   ASSERT (n_chunks > 0);
 449                   if (pd2->lb == b)
 450                     {
 451                       total_len -= dif;
 452                       ch[-1].len -= dif;
 453                     }
 454                   else
 455                     {
 456                       total_len = total_len + pd2->lb->current_length -
 457                         ch[-1].len;
 458                       ch[-1].len = pd2->lb->current_length;
 459                     }
 460                   break;
 461                 }
 462               else
 463                 *tag = vlib_buffer_get_tail (pd2->lb) - icv_sz;
 464             }
 465
 466           if (pd2->icv_removed)
 467             total_len += ch->len = cb->current_length;
 468           else
 469             total_len += ch->len = cb->current_length - icv_sz;
 470         }
 471       else
 472         total_len += ch->len = cb->current_length;
 473
 474       if (!(cb->flags & VLIB_BUFFER_NEXT_PRESENT))
 475         break;
 476
 477       cb = vlib_get_buffer (vm, cb->next_buffer);
 478     }
 479
 480   if (n_ch)
 481     *n_ch = n_chunks;
 482
 483   return total_len;
 484 }
 485
 486 static_always_inline void
 487 esp_decrypt_prepare_sync_op (vlib_main_t * vm, vlib_node_runtime_t * node,
 488                              ipsec_per_thread_data_t * ptd,
 489                              vnet_crypto_op_t *** crypto_ops,
 490                              vnet_crypto_op_t *** integ_ops,
 491                              vnet_crypto_op_t * op,
 492                              ipsec_sa_t * sa0, u8 * payload,
 493                              u16 len, u8 icv_sz, u8 iv_sz,
 494                              esp_decrypt_packet_data_t * pd,
 495                              esp_decrypt_packet_data2_t * pd2,
 496                              vlib_buffer_t * b, u16 * next, u32 index)
 497 {
 498   const u8 esp_sz = sizeof (esp_header_t);
 499
 500   if (PREDICT_TRUE (sa0->integ_op_id != VNET_CRYPTO_OP_NONE))
 501     {
 502       vnet_crypto_op_init (op, sa0->integ_op_id);
 503       op->key_index = sa0->integ_key_index;
 504       op->src = payload;
 505       op->flags = VNET_CRYPTO_OP_FLAG_HMAC_CHECK;
 506       op->user_data = index;
 507       op->digest = payload + len;
 508       op->digest_len = icv_sz;
 509       op->len = len;
 510
 511       if (pd->is_chain)
 512         {
 513           /* buffer is chained */
 514           op->len = pd->current_length;
 515
 516           /* special case when ICV is splitted and needs to be reassembled
 517            * first -> move it to the last buffer. Also take into account
 518            * that ESN needs to be added after encrypted data and may or
 519            * may not fit in the tail.*/
 520           if (pd2->lb->current_length < icv_sz)
 521             {
 522               u8 extra_esn = 0;
 523               op->digest =
 524                 esp_move_icv_esn (vm, b, pd, pd2, icv_sz, sa0,
 525                                   &extra_esn, &op->len);
 526
 527               if (extra_esn)
 528                 {
 529                   /* esn is in the last buffer, that was unlinked from
 530                    * the chain */
 531                   op->len = b->current_length;
 532                 }
 533               else
 534                 {
 535                   if (pd2->lb == b)
 536                     {
 537                       /* we now have a single buffer of crypto data, adjust
 538                        * the length (second buffer contains only ICV) */
 539                       *integ_ops = &ptd->integ_ops;
 540                       *crypto_ops = &ptd->crypto_ops;
 541                       len = b->current_length;
 542                       goto out;
 543                     }
 544                 }
 545             }
 546           else
 547             op->digest = vlib_buffer_get_tail (pd2->lb) - icv_sz;
 548
 549           op->flags |= VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS;
 550           op->chunk_index = vec_len (ptd->chunks);
 551           if (esp_decrypt_chain_integ (vm, ptd, pd, pd2, sa0, b, icv_sz,
 552                                        payload, pd->current_length,
 553                                        &op->digest, &op->n_chunks, 0) < 0)
 554             {
 555               b->error = node->errors[ESP_DECRYPT_ERROR_NO_BUFFERS];
 556               next[0] = ESP_DECRYPT_NEXT_DROP;
 557               return;
 558             }
 559         }
 560       else
 561         esp_insert_esn (vm, sa0, pd, pd2, &op->len, &op->digest, &len, b,
 562                         payload);
 563     out:
 564       vec_add_aligned (*(integ_ops[0]), op, 1, CLIB_CACHE_LINE_BYTES);
 565     }
 566
 567   payload += esp_sz;
 568   len -= esp_sz;
 569
 570   if (sa0->crypto_dec_op_id != VNET_CRYPTO_OP_NONE)
 571     {
 572       vnet_crypto_op_init (op, sa0->crypto_dec_op_id);
 573       op->key_index = sa0->crypto_key_index;
 574       op->iv = payload;
 575
 576       if (ipsec_sa_is_set_IS_CTR (sa0))
 577         {
 578           /* construct nonce in a scratch space in front of the IP header */
 579           esp_ctr_nonce_t *nonce =
 580             (esp_ctr_nonce_t *) (payload - esp_sz - pd->hdr_sz -
 581                                  sizeof (*nonce));
 582           if (ipsec_sa_is_set_IS_AEAD (sa0))
 583             {
 584               /* constuct aad in a scratch space in front of the nonce */
 585               esp_header_t *esp0 = (esp_header_t *) (payload - esp_sz);
 586               op->aad = (u8 *) nonce - sizeof (esp_aead_t);
 587               op->aad_len = esp_aad_fill (op->aad, esp0, sa0, pd->seq_hi);
 588               op->tag = payload + len;
 589               op->tag_len = 16;
 590             }
 591           else
 592             {
 593               nonce->ctr = clib_host_to_net_u32 (1);
 594             }
 595           nonce->salt = sa0->salt;
 596           ASSERT (sizeof (u64) == iv_sz);
 597           nonce->iv = *(u64 *) op->iv;
 598           op->iv = (u8 *) nonce;
 599         }
 600       op->src = op->dst = payload += iv_sz;
 601       op->len = len - iv_sz;
 602       op->user_data = index;
 603
 604       if (pd->is_chain && (pd2->lb != b))
 605         {
 606           /* buffer is chained */
 607           op->flags |= VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS;
 608           op->chunk_index = vec_len (ptd->chunks);
 609           esp_decrypt_chain_crypto (vm, ptd, pd, pd2, sa0, b, icv_sz,
 610                                     payload, len - pd->iv_sz + pd->icv_sz,
 611                                     &op->tag, &op->n_chunks);
 612         }
 613
 614       vec_add_aligned (*(crypto_ops[0]), op, 1, CLIB_CACHE_LINE_BYTES);
 615     }
 616 }
 617
 618 static_always_inline esp_decrypt_error_t
 619 esp_decrypt_prepare_async_frame (vlib_main_t *vm, vlib_node_runtime_t *node,
 620                                  ipsec_per_thread_data_t *ptd,
 621                                  vnet_crypto_async_frame_t *f, ipsec_sa_t *sa0,
 622                                  u8 *payload, u16 len, u8 icv_sz, u8 iv_sz,
 623                                  esp_decrypt_packet_data_t *pd,
 624                                  esp_decrypt_packet_data2_t *pd2, u32 bi,
 625                                  vlib_buffer_t *b, u16 *next, u16 async_next)
 626 {
 627   const u8 esp_sz = sizeof (esp_header_t);
 628   esp_decrypt_packet_data_t *async_pd = &(esp_post_data (b))->decrypt_data;
 629   esp_decrypt_packet_data2_t *async_pd2 = esp_post_data2 (b);
 630   u8 *tag = payload + len, *iv = payload + esp_sz, *aad = 0;
 631   u32 key_index;
 632   u32 crypto_len, integ_len = 0;
 633   i16 crypto_start_offset, integ_start_offset = 0;
 634   u8 flags = 0;
 635
 636   if (!ipsec_sa_is_set_IS_AEAD (sa0))
 637     {
 638       /* linked algs */
 639       key_index = sa0->linked_key_index;
 640       integ_start_offset = payload - b->data;
 641       integ_len = len;
 642       if (PREDICT_TRUE (sa0->integ_op_id != VNET_CRYPTO_OP_NONE))
 643         flags |= VNET_CRYPTO_OP_FLAG_HMAC_CHECK;
 644
 645       if (pd->is_chain)
 646         {
 647           /* buffer is chained */
 648           integ_len = pd->current_length;
 649
 650           /* special case when ICV is splitted and needs to be reassembled
 651            * first -> move it to the last buffer. Also take into account
 652            * that ESN needs to be added after encrypted data and may or
 653            * may not fit in the tail.*/
 654           if (pd2->lb->current_length < icv_sz)
 655             {
 656               u8 extra_esn = 0;
 657               tag = esp_move_icv_esn (vm, b, pd, pd2, icv_sz, sa0,
 658                                       &extra_esn, &integ_len);
 659
 660               if (extra_esn)
 661                 {
 662                   /* esn is in the last buffer, that was unlinked from
 663                    * the chain */
 664                   integ_len = b->current_length;
 665                 }
 666               else
 667                 {
 668                   if (pd2->lb == b)
 669                     {
 670                       /* we now have a single buffer of crypto data, adjust
 671                        * the length (second buffer contains only ICV) */
 672                       len = b->current_length;
 673                       goto out;
 674                     }
 675                 }
 676             }
 677           else
 678             tag = vlib_buffer_get_tail (pd2->lb) - icv_sz;
 679
 680           flags |= VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS;
 681           if (esp_decrypt_chain_integ (vm, ptd, pd, pd2, sa0, b, icv_sz,
 682                                        payload, pd->current_length, &tag, 0,
 683                                        &integ_len) < 0)
 684             {
 685               /* allocate buffer failed, will not add to frame and drop */
 686               return (ESP_DECRYPT_ERROR_NO_BUFFERS);
 687             }
 688         }
 689       else
 690         esp_insert_esn (vm, sa0, pd, pd2, &integ_len, &tag, &len, b, payload);
 691     }
 692   else
 693     key_index = sa0->crypto_key_index;
 694
 695 out:
 696   /* crypto */
 697   payload += esp_sz;
 698   len -= esp_sz;
 699   iv = payload;
 700
 701   if (ipsec_sa_is_set_IS_CTR (sa0))
 702     {
 703       /* construct nonce in a scratch space in front of the IP header */
 704       esp_ctr_nonce_t *nonce =
 705         (esp_ctr_nonce_t *) (payload - esp_sz - pd->hdr_sz - sizeof (*nonce));
 706       if (ipsec_sa_is_set_IS_AEAD (sa0))
 707         {
 708           /* constuct aad in a scratch space in front of the nonce */
 709           esp_header_t *esp0 = (esp_header_t *) (payload - esp_sz);
 710           aad = (u8 *) nonce - sizeof (esp_aead_t);
 711           esp_aad_fill (aad, esp0, sa0, pd->seq_hi);
 712           tag = payload + len;
 713         }
 714       else
 715         {
 716           nonce->ctr = clib_host_to_net_u32 (1);
 717         }
 718       nonce->salt = sa0->salt;
 719       ASSERT (sizeof (u64) == iv_sz);
 720       nonce->iv = *(u64 *) iv;
 721       iv = (u8 *) nonce;
 722     }
 723
 724   crypto_start_offset = (payload += iv_sz) - b->data;
 725   crypto_len = len - iv_sz;
 726
 727   if (pd->is_chain && (pd2->lb != b))
 728     {
 729       /* buffer is chained */
 730       flags |= VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS;
 731
 732       crypto_len = esp_decrypt_chain_crypto (vm, ptd, pd, pd2, sa0, b, icv_sz,
 733                                              payload,
 734                                              len - pd->iv_sz + pd->icv_sz,
 735                                              &tag, 0);
 736     }
 737
 738   *async_pd = *pd;
 739   *async_pd2 = *pd2;
 740
 741   /* for AEAD integ_len - crypto_len will be negative, it is ok since it
 742    * is ignored by the engine. */
 743   vnet_crypto_async_add_to_frame (
 744     vm, f, key_index, crypto_len, integ_len - crypto_len, crypto_start_offset,
 745     integ_start_offset, bi, async_next, iv, tag, aad, flags);
 746
 747   return (ESP_DECRYPT_ERROR_RX_PKTS);
 748 }
 749
 750 static_always_inline void
 751 esp_decrypt_post_crypto (vlib_main_t *vm, const vlib_node_runtime_t *node,
 752                          const esp_decrypt_packet_data_t *pd,
 753                          const esp_decrypt_packet_data2_t *pd2,
 754                          vlib_buffer_t *b, u16 *next, int is_ip6, int is_tun,
 755                          int is_async)
 756 {
 757   ipsec_sa_t *sa0 = ipsec_sa_get (pd->sa_index);
 758   vlib_buffer_t *lb = b;
 759   const u8 esp_sz = sizeof (esp_header_t);
 760   const u8 tun_flags = IPSEC_SA_FLAG_IS_TUNNEL | IPSEC_SA_FLAG_IS_TUNNEL_V6;
 761   u8 pad_length = 0, next_header = 0;
 762   u16 icv_sz;
 763
 764   /*
 765    * redo the anti-reply check
 766    * in this frame say we have sequence numbers, s, s+1, s+1, s+1
 767    * and s and s+1 are in the window. When we did the anti-replay
 768    * check above we did so against the state of the window (W),
 769    * after packet s-1. So each of the packets in the sequence will be
 770    * accepted.
 771    * This time s will be cheked against Ws-1, s+1 chceked against Ws
 772    * (i.e. the window state is updated/advnaced)
 773    * so this time the successive s+! packet will be dropped.
 774    * This is a consequence of batching the decrypts. If the
 775    * check-dcrypt-advance process was done for each packet it would
 776    * be fine. But we batch the decrypts because it's much more efficient
 777    * to do so in SW and if we offload to HW and the process is async.
 778    *
 779    * You're probably thinking, but this means an attacker can send the
 780    * above sequence and cause VPP to perform decrpyts that will fail,
 781    * and that's true. But if the attacker can determine s (a valid
 782    * sequence number in the window) which is non-trivial, it can generate
 783    * a sequence s, s+1, s+2, s+3, ... s+n and nothing will prevent any
 784    * implementation, sequential or batching, from decrypting these.
 785    */
 786   if (ipsec_sa_anti_replay_and_sn_advance (sa0, pd->seq, pd->seq_hi, true,
 787                                            NULL))
 788     {
 789       b->error = node->errors[ESP_DECRYPT_ERROR_REPLAY];
 790       next[0] = ESP_DECRYPT_NEXT_DROP;
 791       return;
 792     }
 793
 794   u64 n_lost =
 795     ipsec_sa_anti_replay_advance (sa0, vm->thread_index, pd->seq, pd->seq_hi);
 796
 797   vlib_prefetch_simple_counter (&ipsec_sa_lost_counters, vm->thread_index,
 798                                 pd->sa_index);
 799
 800   if (pd->is_chain)
 801     {
 802       lb = pd2->lb;
 803       icv_sz = pd2->icv_removed ? 0 : pd->icv_sz;
 804       if (pd2->free_buffer_index)
 805         {
 806           vlib_buffer_free_one (vm, pd2->free_buffer_index);
 807           lb->next_buffer = 0;
 808         }
 809       if (lb->current_length < sizeof (esp_footer_t) + icv_sz)
 810         {
 811           /* esp footer is either splitted in two buffers or in the before
 812            * last buffer */
 813
 814           vlib_buffer_t *before_last = b, *bp = b;
 815           while (bp->flags & VLIB_BUFFER_NEXT_PRESENT)
 816             {
 817               before_last = bp;
 818               bp = vlib_get_buffer (vm, bp->next_buffer);
 819             }
 820           u8 *bt = vlib_buffer_get_tail (before_last);
 821
 822           if (lb->current_length == icv_sz)
 823             {
 824               esp_footer_t *f = (esp_footer_t *) (bt - sizeof (*f));
 825               pad_length = f->pad_length;
 826               next_header = f->next_header;
 827             }
 828           else
 829             {
 830               pad_length = (bt - 1)[0];
 831               next_header = ((u8 *) vlib_buffer_get_current (lb))[0];
 832             }
 833         }
 834       else
 835         {
 836           esp_footer_t *f =
 837             (esp_footer_t *) (lb->data + lb->current_data +
 838                               lb->current_length - sizeof (esp_footer_t) -
 839                               icv_sz);
 840           pad_length = f->pad_length;
 841           next_header = f->next_header;
 842         }
 843     }
 844   else
 845     {
 846       icv_sz = pd->icv_sz;
 847       esp_footer_t *f =
 848         (esp_footer_t *) (lb->data + lb->current_data + lb->current_length -
 849                           sizeof (esp_footer_t) - icv_sz);
 850       pad_length = f->pad_length;
 851       next_header = f->next_header;
 852     }
 853
 854   u16 adv = pd->iv_sz + esp_sz;
 855   u16 tail = sizeof (esp_footer_t) + pad_length + icv_sz;
 856   u16 tail_orig = sizeof (esp_footer_t) + pad_length + pd->icv_sz;
 857   b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
 858
 859   if ((pd->flags & tun_flags) == 0 && !is_tun)  /* transport mode */
 860     {
 861       u8 udp_sz = (is_ip6 == 0 && pd->flags & IPSEC_SA_FLAG_UDP_ENCAP) ?
 862         sizeof (udp_header_t) : 0;
 863       u16 ip_hdr_sz = pd->hdr_sz - udp_sz;
 864       u8 *old_ip = b->data + pd->current_data - ip_hdr_sz - udp_sz;
 865       u8 *ip = old_ip + adv + udp_sz;
 866
 867       if (is_ip6 && ip_hdr_sz > 64)
 868         memmove (ip, old_ip, ip_hdr_sz);
 869       else
 870         clib_memcpy_le64 (ip, old_ip, ip_hdr_sz);
 871
 872       b->current_data = pd->current_data + adv - ip_hdr_sz;
 873       b->current_length += ip_hdr_sz - adv;
 874       esp_remove_tail (vm, b, lb, tail);
 875
 876       if (is_ip6)
 877         {
 878           ip6_header_t *ip6 = (ip6_header_t *) ip;
 879           u16 len = clib_net_to_host_u16 (ip6->payload_length);
 880           len -= adv + tail_orig;
 881           ip6->payload_length = clib_host_to_net_u16 (len);
 882           ip6->protocol = next_header;
 883           next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
 884         }
 885       else
 886         {
 887           ip4_header_t *ip4 = (ip4_header_t *) ip;
 888           ip_csum_t sum = ip4->checksum;
 889           u16 len = clib_net_to_host_u16 (ip4->length);
 890           len = clib_host_to_net_u16 (len - adv - tail_orig - udp_sz);
 891           sum = ip_csum_update (sum, ip4->protocol, next_header,
 892                                 ip4_header_t, protocol);
 893           sum = ip_csum_update (sum, ip4->length, len, ip4_header_t, length);
 894           ip4->checksum = ip_csum_fold (sum);
 895           ip4->protocol = next_header;
 896           ip4->length = len;
 897           next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
 898         }
 899     }
 900   else
 901     {
 902       if (PREDICT_TRUE (next_header == IP_PROTOCOL_IP_IN_IP))
 903         {
 904           next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
 905           b->current_data = pd->current_data + adv;
 906           b->current_length = pd->current_length - adv;
 907           esp_remove_tail (vm, b, lb, tail);
 908         }
 909       else if (next_header == IP_PROTOCOL_IPV6)
 910         {
 911           next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
 912           b->current_data = pd->current_data + adv;
 913           b->current_length = pd->current_length - adv;
 914           esp_remove_tail (vm, b, lb, tail);
 915         }
 916       else if (next_header == IP_PROTOCOL_MPLS_IN_IP)
 917         {
 918           next[0] = ESP_DECRYPT_NEXT_MPLS_INPUT;
 919           b->current_data = pd->current_data + adv;
 920           b->current_length = pd->current_length - adv;
 921           esp_remove_tail (vm, b, lb, tail);
 922         }
 923       else
 924         {
 925           if (is_tun && next_header == IP_PROTOCOL_GRE)
 926             {
 927               gre_header_t *gre;
 928
 929               b->current_data = pd->current_data + adv;
 930               b->current_length = pd->current_length - adv - tail;
 931
 932               gre = vlib_buffer_get_current (b);
 933
 934               vlib_buffer_advance (b, sizeof (*gre));
 935
 936               switch (clib_net_to_host_u16 (gre->protocol))
 937                 {
 938                 case GRE_PROTOCOL_teb:
 939                   vnet_update_l2_len (b);
 940                   next[0] = ESP_DECRYPT_NEXT_L2_INPUT;
 941                   break;
 942                 case GRE_PROTOCOL_ip4:
 943                   next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
 944                   break;
 945                 case GRE_PROTOCOL_ip6:
 946                   next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
 947                   break;
 948                 default:
 949                   b->error = node->errors[ESP_DECRYPT_ERROR_UNSUP_PAYLOAD];
 950                   next[0] = ESP_DECRYPT_NEXT_DROP;
 951                   break;
 952                 }
 953             }
 954           else
 955             {
 956               next[0] = ESP_DECRYPT_NEXT_DROP;
 957               b->error = node->errors[ESP_DECRYPT_ERROR_UNSUP_PAYLOAD];
 958               return;
 959             }
 960         }
 961       if (is_tun)
 962         {
 963           if (ipsec_sa_is_set_IS_PROTECT (sa0))
 964             {
 965               /*
 966                * There are two encap possibilities
 967                * 1) the tunnel and ths SA are prodiving encap, i.e. it's
 968                *   MAC | SA-IP | TUN-IP | ESP | PAYLOAD
 969                * implying the SA is in tunnel mode (on a tunnel interface)
 970                * 2) only the tunnel provides encap
 971                *   MAC | TUN-IP | ESP | PAYLOAD
 972                * implying the SA is in transport mode.
 973                *
 974                * For 2) we need only strip the tunnel encap and we're good.
 975                *  since the tunnel and crypto ecnap (int the tun=protect
 976                * object) are the same and we verified above that these match
 977                * for 1) we need to strip the SA-IP outer headers, to
 978                * reveal the tunnel IP and then check that this matches
 979                * the configured tunnel.
 980                */
 981               const ipsec_tun_protect_t *itp;
 982
 983               itp =
 984                 ipsec_tun_protect_get (vnet_buffer (b)->ipsec.protect_index);
 985
 986               if (PREDICT_TRUE (next_header == IP_PROTOCOL_IP_IN_IP))
 987                 {
 988                   const ip4_header_t *ip4;
 989
 990                   ip4 = vlib_buffer_get_current (b);
 991
 992                   if (!ip46_address_is_equal_v4 (&itp->itp_tun.src,
 993                                                  &ip4->dst_address) ||
 994                       !ip46_address_is_equal_v4 (&itp->itp_tun.dst,
 995                                                  &ip4->src_address))
 996                     {
 997                       next[0] = ESP_DECRYPT_NEXT_DROP;
 998                       b->error = node->errors[ESP_DECRYPT_ERROR_TUN_NO_PROTO];
 999                     }
1000                 }
1001               else if (next_header == IP_PROTOCOL_IPV6)
1002                 {
1003                   const ip6_header_t *ip6;
1004
1005                   ip6 = vlib_buffer_get_current (b);
1006
1007                   if (!ip46_address_is_equal_v6 (&itp->itp_tun.src,
1008                                                  &ip6->dst_address) ||
1009                       !ip46_address_is_equal_v6 (&itp->itp_tun.dst,
1010                                                  &ip6->src_address))
1011                     {
1012                       next[0] = ESP_DECRYPT_NEXT_DROP;
1013                       b->error = node->errors[ESP_DECRYPT_ERROR_TUN_NO_PROTO];
1014                     }
1015                 }
1016             }
1017         }
1018     }
1019
1020   if (PREDICT_FALSE (n_lost))
1021     vlib_increment_simple_counter (&ipsec_sa_lost_counters, vm->thread_index,
1022                                    pd->sa_index, n_lost);
1023 }
1024
1025 always_inline uword
1026 esp_decrypt_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
1027                     vlib_frame_t *from_frame, int is_ip6, int is_tun,
1028                     u16 async_next_node)
1029 {
1030   ipsec_main_t *im = &ipsec_main;
1031   u32 thread_index = vm->thread_index;
1032   u16 len;
1033   ipsec_per_thread_data_t *ptd = vec_elt_at_index (im->ptd, thread_index);
1034   u32 *from = vlib_frame_vector_args (from_frame);
1035   u32 n_left = from_frame->n_vectors;
1036   vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
1037   vlib_buffer_t *sync_bufs[VLIB_FRAME_SIZE];
1038   u16 sync_nexts[VLIB_FRAME_SIZE], *sync_next = sync_nexts, n_sync = 0;
1039   u16 async_nexts[VLIB_FRAME_SIZE], *async_next = async_nexts;
1040   u16 noop_nexts[VLIB_FRAME_SIZE], *noop_next = noop_nexts, n_noop = 0;
1041   u32 sync_bi[VLIB_FRAME_SIZE];
1042   u32 noop_bi[VLIB_FRAME_SIZE];
1043   esp_decrypt_packet_data_t pkt_data[VLIB_FRAME_SIZE], *pd = pkt_data;
1044   esp_decrypt_packet_data2_t pkt_data2[VLIB_FRAME_SIZE], *pd2 = pkt_data2;
1045   esp_decrypt_packet_data_t cpd = { };
1046   u32 current_sa_index = ~0, current_sa_bytes = 0, current_sa_pkts = 0;
1047   const u8 esp_sz = sizeof (esp_header_t);
1048   ipsec_sa_t *sa0 = 0;
1049   vnet_crypto_op_t _op, *op = &_op;
1050   vnet_crypto_op_t **crypto_ops;
1051   vnet_crypto_op_t **integ_ops;
1052   int is_async = im->async_mode;
1053   vnet_crypto_async_op_id_t async_op = ~0;
1054   vnet_crypto_async_frame_t *async_frames[VNET_CRYPTO_ASYNC_OP_N_IDS];
1055   esp_decrypt_error_t err;
1056
1057   vlib_get_buffers (vm, from, b, n_left);
1058   if (!is_async)
1059     {
1060       vec_reset_length (ptd->crypto_ops);
1061       vec_reset_length (ptd->integ_ops);
1062       vec_reset_length (ptd->chained_crypto_ops);
1063       vec_reset_length (ptd->chained_integ_ops);
1064     }
1065   vec_reset_length (ptd->async_frames);
1066   vec_reset_length (ptd->chunks);
1067   clib_memset (sync_nexts, -1, sizeof (sync_nexts));
1068   clib_memset (async_frames, 0, sizeof (async_frames));
1069
1070   while (n_left > 0)
1071     {
1072       u8 *payload;
1073
1074       err = ESP_DECRYPT_ERROR_RX_PKTS;
1075       if (n_left > 2)
1076         {
1077           u8 *p;
1078           vlib_prefetch_buffer_header (b[2], LOAD);
1079           p = vlib_buffer_get_current (b[1]);
1080           clib_prefetch_load (p);
1081           p -= CLIB_CACHE_LINE_BYTES;
1082           clib_prefetch_load (p);
1083         }
1084
1085       u32 n_bufs = vlib_buffer_chain_linearize (vm, b[0]);
1086       if (n_bufs == 0)
1087         {
1088           err = ESP_DECRYPT_ERROR_NO_BUFFERS;
1089           esp_set_next_index (b[0], node, err, n_noop, noop_nexts,
1090                               ESP_DECRYPT_NEXT_DROP);
1091           goto next;
1092         }
1093
1094       if (vnet_buffer (b[0])->ipsec.sad_index != current_sa_index)
1095         {
1096           if (current_sa_pkts)
1097             vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
1098                                              current_sa_index,
1099                                              current_sa_pkts,
1100                                              current_sa_bytes);
1101           current_sa_bytes = current_sa_pkts = 0;
1102
1103           current_sa_index = vnet_buffer (b[0])->ipsec.sad_index;
1104           sa0 = ipsec_sa_get (current_sa_index);
1105
1106           /* fetch the second cacheline ASAP */
1107           clib_prefetch_load (sa0->cacheline1);
1108           cpd.icv_sz = sa0->integ_icv_size;
1109           cpd.iv_sz = sa0->crypto_iv_size;
1110           cpd.flags = sa0->flags;
1111           cpd.sa_index = current_sa_index;
1112           is_async = im->async_mode | ipsec_sa_is_set_IS_ASYNC (sa0);
1113         }
1114
1115       if (PREDICT_FALSE (~0 == sa0->thread_index))
1116         {
1117           /* this is the first packet to use this SA, claim the SA
1118            * for this thread. this could happen simultaneously on
1119            * another thread */
1120           clib_atomic_cmp_and_swap (&sa0->thread_index, ~0,
1121                                     ipsec_sa_assign_thread (thread_index));
1122         }
1123
1124       if (PREDICT_FALSE (thread_index != sa0->thread_index))
1125         {
1126           vnet_buffer (b[0])->ipsec.thread_index = sa0->thread_index;
1127           err = ESP_DECRYPT_ERROR_HANDOFF;
1128           esp_set_next_index (b[0], node, err, n_noop, noop_nexts,
1129                               ESP_DECRYPT_NEXT_HANDOFF);
1130           goto next;
1131         }
1132
1133       /* store packet data for next round for easier prefetch */
1134       pd->sa_data = cpd.sa_data;
1135       pd->current_data = b[0]->current_data;
1136       pd->hdr_sz = pd->current_data - vnet_buffer (b[0])->l3_hdr_offset;
1137       payload = b[0]->data + pd->current_data;
1138       pd->seq = clib_host_to_net_u32 (((esp_header_t *) payload)->seq);
1139       pd->is_chain = 0;
1140       pd2->lb = b[0];
1141       pd2->free_buffer_index = 0;
1142       pd2->icv_removed = 0;
1143
1144       if (n_bufs > 1)
1145         {
1146           pd->is_chain = 1;
1147           /* find last buffer in the chain */
1148           while (pd2->lb->flags & VLIB_BUFFER_NEXT_PRESENT)
1149             pd2->lb = vlib_get_buffer (vm, pd2->lb->next_buffer);
1150
1151           crypto_ops = &ptd->chained_crypto_ops;
1152           integ_ops = &ptd->chained_integ_ops;
1153         }
1154       else
1155         {
1156           crypto_ops = &ptd->crypto_ops;
1157           integ_ops = &ptd->integ_ops;
1158         }
1159
1160       pd->current_length = b[0]->current_length;
1161
1162       /* anti-reply check */
1163       if (ipsec_sa_anti_replay_and_sn_advance (sa0, pd->seq, ~0, false,
1164                                                &pd->seq_hi))
1165         {
1166           err = ESP_DECRYPT_ERROR_REPLAY;
1167           esp_set_next_index (b[0], node, err, n_noop, noop_nexts,
1168                               ESP_DECRYPT_NEXT_DROP);
1169           goto next;
1170         }
1171
1172       if (pd->current_length < cpd.icv_sz + esp_sz + cpd.iv_sz)
1173         {
1174           err = ESP_DECRYPT_ERROR_RUNT;
1175           esp_set_next_index (b[0], node, err, n_noop, noop_nexts,
1176                               ESP_DECRYPT_NEXT_DROP);
1177           goto next;
1178         }
1179
1180       len = pd->current_length - cpd.icv_sz;
1181       current_sa_pkts += 1;
1182       current_sa_bytes += vlib_buffer_length_in_chain (vm, b[0]);
1183
1184       if (is_async)
1185         {
1186           async_op = sa0->crypto_async_dec_op_id;
1187
1188           /* get a frame for this op if we don't yet have one or it's full
1189            */
1190           if (NULL == async_frames[async_op] ||
1191               vnet_crypto_async_frame_is_full (async_frames[async_op]))
1192             {
1193               async_frames[async_op] =
1194                 vnet_crypto_async_get_frame (vm, async_op);
1195               /* Save the frame to the list we'll submit at the end */
1196               vec_add1 (ptd->async_frames, async_frames[async_op]);
1197             }
1198
1199           err = esp_decrypt_prepare_async_frame (
1200             vm, node, ptd, async_frames[async_op], sa0, payload, len,
1201             cpd.icv_sz, cpd.iv_sz, pd, pd2, from[b - bufs], b[0], async_next,
1202             async_next_node);
1203           if (ESP_DECRYPT_ERROR_RX_PKTS != err)
1204             {
1205               esp_set_next_index (b[0], node, err, n_noop, noop_nexts,
1206                                   ESP_DECRYPT_NEXT_DROP);
1207             }
1208         }
1209       else
1210         esp_decrypt_prepare_sync_op (
1211           vm, node, ptd, &crypto_ops, &integ_ops, op, sa0, payload, len,
1212           cpd.icv_sz, cpd.iv_sz, pd, pd2, b[0], sync_next, b - bufs);
1213       /* next */
1214     next:
1215       if (ESP_DECRYPT_ERROR_RX_PKTS != err)
1216         {
1217           noop_bi[n_noop] = from[b - bufs];
1218           n_noop++;
1219           noop_next++;
1220         }
1221       else if (!is_async)
1222         {
1223           sync_bi[n_sync] = from[b - bufs];
1224           sync_bufs[n_sync] = b[0];
1225           n_sync++;
1226           sync_next++;
1227           pd += 1;
1228           pd2 += 1;
1229         }
1230       else
1231         async_next++;
1232
1233       n_left -= 1;
1234       b += 1;
1235     }
1236
1237   if (PREDICT_TRUE (~0 != current_sa_index))
1238     vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
1239                                      current_sa_index, current_sa_pkts,
1240                                      current_sa_bytes);
1241
1242   /* submit or free all of the open frames */
1243   vnet_crypto_async_frame_t **async_frame;
1244
1245   vec_foreach (async_frame, ptd->async_frames)
1246     {
1247       /* free frame and move on if no ops were successfully added */
1248       if (PREDICT_FALSE (!(*async_frame)->n_elts))
1249         {
1250           vnet_crypto_async_free_frame (vm, *async_frame);
1251           continue;
1252         }
1253       if (vnet_crypto_async_submit_open_frame (vm, *async_frame) < 0)
1254         {
1255           n_noop += esp_async_recycle_failed_submit (
1256             vm, *async_frame, node, ESP_DECRYPT_ERROR_CRYPTO_ENGINE_ERROR,
1257             n_noop, noop_bi, noop_nexts, ESP_DECRYPT_NEXT_DROP);
1258           vnet_crypto_async_reset_frame (*async_frame);
1259           vnet_crypto_async_free_frame (vm, *async_frame);
1260         }
1261     }
1262
1263   if (n_sync)
1264     {
1265       esp_process_ops (vm, node, ptd->integ_ops, sync_bufs, sync_nexts,
1266                        ESP_DECRYPT_ERROR_INTEG_ERROR);
1267       esp_process_chained_ops (vm, node, ptd->chained_integ_ops, sync_bufs,
1268                                sync_nexts, ptd->chunks,
1269                                ESP_DECRYPT_ERROR_INTEG_ERROR);
1270
1271       esp_process_ops (vm, node, ptd->crypto_ops, sync_bufs, sync_nexts,
1272                        ESP_DECRYPT_ERROR_DECRYPTION_FAILED);
1273       esp_process_chained_ops (vm, node, ptd->chained_crypto_ops, sync_bufs,
1274                                sync_nexts, ptd->chunks,
1275                                ESP_DECRYPT_ERROR_DECRYPTION_FAILED);
1276     }
1277
1278   /* Post decryption ronud - adjust packet data start and length and next
1279      node */
1280
1281   n_left = n_sync;
1282   sync_next = sync_nexts;
1283   pd = pkt_data;
1284   pd2 = pkt_data2;
1285   b = sync_bufs;
1286
1287   while (n_left)
1288     {
1289       if (n_left >= 2)
1290         {
1291           void *data = b[1]->data + pd[1].current_data;
1292
1293           /* buffer metadata */
1294           vlib_prefetch_buffer_header (b[1], LOAD);
1295
1296           /* esp_footer_t */
1297           CLIB_PREFETCH (data + pd[1].current_length - pd[1].icv_sz - 2,
1298                          CLIB_CACHE_LINE_BYTES, LOAD);
1299
1300           /* packet headers */
1301           CLIB_PREFETCH (data - CLIB_CACHE_LINE_BYTES,
1302                          CLIB_CACHE_LINE_BYTES * 2, LOAD);
1303         }
1304
1305       /* save the sa_index as GRE_teb post_crypto changes L2 opaque */
1306       if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
1307         current_sa_index = vnet_buffer (b[0])->ipsec.sad_index;
1308
1309       if (sync_next[0] >= ESP_DECRYPT_N_NEXT)
1310         esp_decrypt_post_crypto (vm, node, pd, pd2, b[0], sync_next, is_ip6,
1311                                  is_tun, 0);
1312
1313       /* trace: */
1314       if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
1315         {
1316           esp_decrypt_trace_t *tr;
1317           tr = vlib_add_trace (vm, node, b[0], sizeof (*tr));
1318           sa0 = ipsec_sa_get (current_sa_index);
1319           tr->crypto_alg = sa0->crypto_alg;
1320           tr->integ_alg = sa0->integ_alg;
1321           tr->seq = pd->seq;
1322           tr->sa_seq = sa0->seq;
1323           tr->sa_seq_hi = sa0->seq_hi;
1324           tr->pkt_seq_hi = pd->seq_hi;
1325         }
1326
1327       /* next */
1328       n_left -= 1;
1329       sync_next += 1;
1330       pd += 1;
1331       pd2 += 1;
1332       b += 1;
1333     }
1334
1335   vlib_node_increment_counter (vm, node->node_index, ESP_DECRYPT_ERROR_RX_PKTS,
1336                                from_frame->n_vectors);
1337
1338   if (n_sync)
1339     vlib_buffer_enqueue_to_next (vm, node, sync_bi, sync_nexts, n_sync);
1340
1341   if (n_noop)
1342     vlib_buffer_enqueue_to_next (vm, node, noop_bi, noop_nexts, n_noop);
1343
1344   return (from_frame->n_vectors);
1345 }
1346
1347 always_inline uword
1348 esp_decrypt_post_inline (vlib_main_t * vm,
1349                          vlib_node_runtime_t * node,
1350                          vlib_frame_t * from_frame, int is_ip6, int is_tun)
1351 {
1352   u32 *from = vlib_frame_vector_args (from_frame);
1353   u32 n_left = from_frame->n_vectors;
1354   vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
1355   u16 nexts[VLIB_FRAME_SIZE], *next = nexts;
1356   vlib_get_buffers (vm, from, b, n_left);
1357
1358   while (n_left > 0)
1359     {
1360       esp_decrypt_packet_data_t *pd = &(esp_post_data (b[0]))->decrypt_data;
1361
1362       if (n_left > 2)
1363         {
1364           vlib_prefetch_buffer_header (b[2], LOAD);
1365           vlib_prefetch_buffer_header (b[1], LOAD);
1366         }
1367
1368       if (!pd->is_chain)
1369         esp_decrypt_post_crypto (vm, node, pd, 0, b[0], next, is_ip6, is_tun,
1370                                  1);
1371       else
1372         {
1373           esp_decrypt_packet_data2_t *pd2 = esp_post_data2 (b[0]);
1374           esp_decrypt_post_crypto (vm, node, pd, pd2, b[0], next, is_ip6,
1375                                    is_tun, 1);
1376         }
1377
1378       /*trace: */
1379       if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
1380         {
1381           ipsec_sa_t *sa0 = ipsec_sa_get (pd->sa_index);
1382           esp_decrypt_trace_t *tr;
1383           esp_decrypt_packet_data_t *async_pd =
1384             &(esp_post_data (b[0]))->decrypt_data;
1385           tr = vlib_add_trace (vm, node, b[0], sizeof (*tr));
1386           sa0 = ipsec_sa_get (async_pd->sa_index);
1387
1388           tr->crypto_alg = sa0->crypto_alg;
1389           tr->integ_alg = sa0->integ_alg;
1390           tr->seq = pd->seq;
1391           tr->sa_seq = sa0->seq;
1392           tr->sa_seq_hi = sa0->seq_hi;
1393         }
1394
1395       n_left--;
1396       next++;
1397       b++;
1398     }
1399
1400   n_left = from_frame->n_vectors;
1401   vlib_node_increment_counter (vm, node->node_index,
1402                                ESP_DECRYPT_ERROR_RX_POST_PKTS, n_left);
1403
1404   vlib_buffer_enqueue_to_next (vm, node, from, nexts, n_left);
1405
1406   return n_left;
1407 }
1408
1409 VLIB_NODE_FN (esp4_decrypt_node) (vlib_main_t * vm,
1410                                   vlib_node_runtime_t * node,
1411                                   vlib_frame_t * from_frame)
1412 {
1413   return esp_decrypt_inline (vm, node, from_frame, 0, 0,
1414                              esp_decrypt_async_next.esp4_post_next);
1415 }
1416
1417 VLIB_NODE_FN (esp4_decrypt_post_node) (vlib_main_t * vm,
1418                                        vlib_node_runtime_t * node,
1419                                        vlib_frame_t * from_frame)
1420 {
1421   return esp_decrypt_post_inline (vm, node, from_frame, 0, 0);
1422 }
1423
1424 VLIB_NODE_FN (esp4_decrypt_tun_node) (vlib_main_t * vm,
1425                                       vlib_node_runtime_t * node,
1426                                       vlib_frame_t * from_frame)
1427 {
1428   return esp_decrypt_inline (vm, node, from_frame, 0, 1,
1429                              esp_decrypt_async_next.esp4_tun_post_next);
1430 }
1431
1432 VLIB_NODE_FN (esp4_decrypt_tun_post_node) (vlib_main_t * vm,
1433                                            vlib_node_runtime_t * node,
1434                                            vlib_frame_t * from_frame)
1435 {
1436   return esp_decrypt_post_inline (vm, node, from_frame, 0, 1);
1437 }
1438
1439 VLIB_NODE_FN (esp6_decrypt_node) (vlib_main_t * vm,
1440                                   vlib_node_runtime_t * node,
1441                                   vlib_frame_t * from_frame)
1442 {
1443   return esp_decrypt_inline (vm, node, from_frame, 1, 0,
1444                              esp_decrypt_async_next.esp6_post_next);
1445 }
1446
1447 VLIB_NODE_FN (esp6_decrypt_post_node) (vlib_main_t * vm,
1448                                        vlib_node_runtime_t * node,
1449                                        vlib_frame_t * from_frame)
1450 {
1451   return esp_decrypt_post_inline (vm, node, from_frame, 1, 0);
1452 }
1453
1454 VLIB_NODE_FN (esp6_decrypt_tun_node) (vlib_main_t * vm,
1455                                       vlib_node_runtime_t * node,
1456                                       vlib_frame_t * from_frame)
1457 {
1458   return esp_decrypt_inline (vm, node, from_frame, 1, 1,
1459                              esp_decrypt_async_next.esp6_tun_post_next);
1460 }
1461
1462 VLIB_NODE_FN (esp6_decrypt_tun_post_node) (vlib_main_t * vm,
1463                                            vlib_node_runtime_t * node,
1464                                            vlib_frame_t * from_frame)
1465 {
1466   return esp_decrypt_post_inline (vm, node, from_frame, 1, 1);
1467 }
1468
1469 /* *INDENT-OFF* */
1470 VLIB_REGISTER_NODE (esp4_decrypt_node) = {
1471   .name = "esp4-decrypt",
1472   .vector_size = sizeof (u32),
1473   .format_trace = format_esp_decrypt_trace,
1474   .type = VLIB_NODE_TYPE_INTERNAL,
1475
1476   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
1477   .error_strings = esp_decrypt_error_strings,
1478
1479   .n_next_nodes = ESP_DECRYPT_N_NEXT,
1480   .next_nodes = {
1481     [ESP_DECRYPT_NEXT_DROP] = "ip4-drop",
1482     [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
1483     [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
1484     [ESP_DECRYPT_NEXT_MPLS_INPUT] = "mpls-drop",
1485     [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
1486     [ESP_DECRYPT_NEXT_HANDOFF] = "esp4-decrypt-handoff",
1487   },
1488 };
1489
1490 VLIB_REGISTER_NODE (esp4_decrypt_post_node) = {
1491   .name = "esp4-decrypt-post",
1492   .vector_size = sizeof (u32),
1493   .format_trace = format_esp_decrypt_trace,
1494   .type = VLIB_NODE_TYPE_INTERNAL,
1495
1496   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
1497   .error_strings = esp_decrypt_error_strings,
1498
1499   .sibling_of = "esp4-decrypt",
1500 };
1501
1502 VLIB_REGISTER_NODE (esp6_decrypt_node) = {
1503   .name = "esp6-decrypt",
1504   .vector_size = sizeof (u32),
1505   .format_trace = format_esp_decrypt_trace,
1506   .type = VLIB_NODE_TYPE_INTERNAL,
1507
1508   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
1509   .error_strings = esp_decrypt_error_strings,
1510
1511   .n_next_nodes = ESP_DECRYPT_N_NEXT,
1512   .next_nodes = {
1513     [ESP_DECRYPT_NEXT_DROP] = "ip6-drop",
1514     [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
1515     [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
1516     [ESP_DECRYPT_NEXT_MPLS_INPUT] = "mpls-drop",
1517     [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
1518     [ESP_DECRYPT_NEXT_HANDOFF]=  "esp6-decrypt-handoff",
1519   },
1520 };
1521
1522 VLIB_REGISTER_NODE (esp6_decrypt_post_node) = {
1523   .name = "esp6-decrypt-post",
1524   .vector_size = sizeof (u32),
1525   .format_trace = format_esp_decrypt_trace,
1526   .type = VLIB_NODE_TYPE_INTERNAL,
1527
1528   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
1529   .error_strings = esp_decrypt_error_strings,
1530
1531   .sibling_of = "esp6-decrypt",
1532 };
1533
1534 VLIB_REGISTER_NODE (esp4_decrypt_tun_node) = {
1535   .name = "esp4-decrypt-tun",
1536   .vector_size = sizeof (u32),
1537   .format_trace = format_esp_decrypt_trace,
1538   .type = VLIB_NODE_TYPE_INTERNAL,
1539   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
1540   .error_strings = esp_decrypt_error_strings,
1541   .n_next_nodes = ESP_DECRYPT_N_NEXT,
1542   .next_nodes = {
1543     [ESP_DECRYPT_NEXT_DROP] = "ip4-drop",
1544     [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
1545     [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
1546     [ESP_DECRYPT_NEXT_MPLS_INPUT] = "mpls-input",
1547     [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
1548     [ESP_DECRYPT_NEXT_HANDOFF] = "esp4-decrypt-tun-handoff",
1549   },
1550 };
1551
1552 VLIB_REGISTER_NODE (esp4_decrypt_tun_post_node) = {
1553   .name = "esp4-decrypt-tun-post",
1554   .vector_size = sizeof (u32),
1555   .format_trace = format_esp_decrypt_trace,
1556   .type = VLIB_NODE_TYPE_INTERNAL,
1557
1558   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
1559   .error_strings = esp_decrypt_error_strings,
1560
1561   .sibling_of = "esp4-decrypt-tun",
1562 };
1563
1564 VLIB_REGISTER_NODE (esp6_decrypt_tun_node) = {
1565   .name = "esp6-decrypt-tun",
1566   .vector_size = sizeof (u32),
1567   .format_trace = format_esp_decrypt_trace,
1568   .type = VLIB_NODE_TYPE_INTERNAL,
1569   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
1570   .error_strings = esp_decrypt_error_strings,
1571   .n_next_nodes = ESP_DECRYPT_N_NEXT,
1572   .next_nodes = {
1573     [ESP_DECRYPT_NEXT_DROP] = "ip6-drop",
1574     [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
1575     [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
1576     [ESP_DECRYPT_NEXT_MPLS_INPUT] = "mpls-input",
1577     [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
1578     [ESP_DECRYPT_NEXT_HANDOFF]=  "esp6-decrypt-tun-handoff",
1579   },
1580 };
1581
1582 VLIB_REGISTER_NODE (esp6_decrypt_tun_post_node) = {
1583   .name = "esp6-decrypt-tun-post",
1584   .vector_size = sizeof (u32),
1585   .format_trace = format_esp_decrypt_trace,
1586   .type = VLIB_NODE_TYPE_INTERNAL,
1587
1588   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
1589   .error_strings = esp_decrypt_error_strings,
1590
1591   .sibling_of = "esp6-decrypt-tun",
1592 };
1593 /* *INDENT-ON* */
1594
1595 #ifndef CLIB_MARCH_VARIANT
1596
1597 static clib_error_t *
1598 esp_decrypt_init (vlib_main_t *vm)
1599 {
1600   ipsec_main_t *im = &ipsec_main;
1601
1602   im->esp4_dec_fq_index =
1603     vlib_frame_queue_main_init (esp4_decrypt_node.index, 0);
1604   im->esp6_dec_fq_index =
1605     vlib_frame_queue_main_init (esp6_decrypt_node.index, 0);
1606   im->esp4_dec_tun_fq_index =
1607     vlib_frame_queue_main_init (esp4_decrypt_tun_node.index, 0);
1608   im->esp6_dec_tun_fq_index =
1609     vlib_frame_queue_main_init (esp6_decrypt_tun_node.index, 0);
1610
1611   return 0;
1612 }
1613
1614 VLIB_INIT_FUNCTION (esp_decrypt_init);
1615
1616 #endif
1617
1618 /*
1619  * fd.io coding-style-patch-verification: ON
1620  *
1621  * Local Variables:
1622  * eval: (c-set-style "gnu")
1623  * End:
1624  */