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