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 esp_decrypt_error_t
 611 esp_decrypt_prepare_async_frame (vlib_main_t *vm, vlib_node_runtime_t *node,
 612                                  ipsec_per_thread_data_t *ptd,
 613                                  vnet_crypto_async_frame_t *f, ipsec_sa_t *sa0,
 614                                  u8 *payload, u16 len, u8 icv_sz, u8 iv_sz,
 615                                  esp_decrypt_packet_data_t *pd,
 616                                  esp_decrypt_packet_data2_t *pd2, u32 bi,
 617                                  vlib_buffer_t *b, u16 *next, u16 async_next)
 618 {
 619   const u8 esp_sz = sizeof (esp_header_t);
 620   u32 current_protect_index = vnet_buffer (b)->ipsec.protect_index;
 621   esp_decrypt_packet_data_t *async_pd = &(esp_post_data (b))->decrypt_data;
 622   esp_decrypt_packet_data2_t *async_pd2 = esp_post_data2 (b);
 623   u8 *tag = payload + len, *iv = payload + esp_sz, *aad = 0;
 624   u32 key_index;
 625   u32 crypto_len, integ_len = 0;
 626   i16 crypto_start_offset, integ_start_offset = 0;
 627   u8 flags = 0;
 628
 629   if (!ipsec_sa_is_set_IS_AEAD (sa0))
 630     {
 631       /* linked algs */
 632       key_index = sa0->linked_key_index;
 633       integ_start_offset = payload - b->data;
 634       integ_len = len;
 635
 636       if (pd->is_chain)
 637         {
 638           /* buffer is chained */
 639           integ_len = pd->current_length;
 640
 641           /* special case when ICV is splitted and needs to be reassembled
 642            * first -> move it to the last buffer. Also take into account
 643            * that ESN needs to be added after encrypted data and may or
 644            * may not fit in the tail.*/
 645           if (pd2->lb->current_length < icv_sz)
 646             {
 647               u8 extra_esn = 0;
 648               tag = esp_move_icv_esn (vm, b, pd, pd2, icv_sz, sa0,
 649                                       &extra_esn, &integ_len);
 650
 651               if (extra_esn)
 652                 {
 653                   /* esn is in the last buffer, that was unlinked from
 654                    * the chain */
 655                   integ_len = b->current_length;
 656                 }
 657               else
 658                 {
 659                   if (pd2->lb == b)
 660                     {
 661                       /* we now have a single buffer of crypto data, adjust
 662                        * the length (second buffer contains only ICV) */
 663                       len = b->current_length;
 664                       goto out;
 665                     }
 666                 }
 667             }
 668           else
 669             tag = vlib_buffer_get_tail (pd2->lb) - icv_sz;
 670
 671           flags |= VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS;
 672           if (esp_decrypt_chain_integ (vm, ptd, pd2, sa0, b, icv_sz, payload,
 673                                        pd->current_length, &tag,
 674                                        0, &integ_len) < 0)
 675             {
 676               /* allocate buffer failed, will not add to frame and drop */
 677               return (ESP_DECRYPT_ERROR_NO_BUFFERS);
 678             }
 679         }
 680       else
 681         esp_insert_esn (vm, sa0, pd2, &integ_len, &tag, &len, b, payload);
 682     }
 683   else
 684     key_index = sa0->crypto_key_index;
 685
 686 out:
 687   /* crypto */
 688   payload += esp_sz;
 689   len -= esp_sz;
 690   iv = payload;
 691
 692   if (ipsec_sa_is_set_IS_CTR (sa0))
 693     {
 694       /* construct nonce in a scratch space in front of the IP header */
 695       esp_ctr_nonce_t *nonce =
 696         (esp_ctr_nonce_t *) (payload - esp_sz - pd->hdr_sz - sizeof (*nonce));
 697       if (ipsec_sa_is_set_IS_AEAD (sa0))
 698         {
 699           /* constuct aad in a scratch space in front of the nonce */
 700           esp_header_t *esp0 = (esp_header_t *) (payload - esp_sz);
 701           aad = (u8 *) nonce - sizeof (esp_aead_t);
 702           esp_aad_fill (aad, esp0, sa0);
 703           tag = payload + len;
 704         }
 705       else
 706         {
 707           nonce->ctr = clib_host_to_net_u32 (1);
 708         }
 709       nonce->salt = sa0->salt;
 710       ASSERT (sizeof (u64) == iv_sz);
 711       nonce->iv = *(u64 *) iv;
 712       iv = (u8 *) nonce;
 713     }
 714
 715   crypto_start_offset = (payload += iv_sz) - b->data;
 716   crypto_len = len - iv_sz;
 717
 718   if (pd->is_chain && (pd2->lb != b))
 719     {
 720       /* buffer is chained */
 721       flags |= VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS;
 722
 723       crypto_len = esp_decrypt_chain_crypto (vm, ptd, pd, pd2, sa0, b, icv_sz,
 724                                              payload,
 725                                              len - pd->iv_sz + pd->icv_sz,
 726                                              &tag, 0);
 727     }
 728
 729   *async_pd = *pd;
 730   *async_pd2 = *pd2;
 731   pd->protect_index = current_protect_index;
 732
 733   /* for AEAD integ_len - crypto_len will be negative, it is ok since it
 734    * is ignored by the engine. */
 735   vnet_crypto_async_add_to_frame (
 736     vm, f, key_index, crypto_len, integ_len - crypto_len, crypto_start_offset,
 737     integ_start_offset, bi, async_next, iv, tag, aad, flags);
 738
 739   return (ESP_DECRYPT_ERROR_RX_PKTS);
 740 }
 741
 742 static_always_inline void
 743 esp_decrypt_post_crypto (vlib_main_t * vm, vlib_node_runtime_t * node,
 744                          esp_decrypt_packet_data_t * pd,
 745                          esp_decrypt_packet_data2_t * pd2, vlib_buffer_t * b,
 746                          u16 * next, int is_ip6, int is_tun, int is_async)
 747 {
 748   ipsec_sa_t *sa0 = ipsec_sa_get (pd->sa_index);
 749   vlib_buffer_t *lb = b;
 750   const u8 esp_sz = sizeof (esp_header_t);
 751   const u8 tun_flags = IPSEC_SA_FLAG_IS_TUNNEL | IPSEC_SA_FLAG_IS_TUNNEL_V6;
 752   u8 pad_length = 0, next_header = 0;
 753   u16 icv_sz;
 754
 755   /*
 756    * redo the anti-reply check
 757    * in this frame say we have sequence numbers, s, s+1, s+1, s+1
 758    * and s and s+1 are in the window. When we did the anti-replay
 759    * check above we did so against the state of the window (W),
 760    * after packet s-1. So each of the packets in the sequence will be
 761    * accepted.
 762    * This time s will be cheked against Ws-1, s+1 chceked against Ws
 763    * (i.e. the window state is updated/advnaced)
 764    * so this time the successive s+! packet will be dropped.
 765    * This is a consequence of batching the decrypts. If the
 766    * check-dcrypt-advance process was done for each packet it would
 767    * be fine. But we batch the decrypts because it's much more efficient
 768    * to do so in SW and if we offload to HW and the process is async.
 769    *
 770    * You're probably thinking, but this means an attacker can send the
 771    * above sequence and cause VPP to perform decrpyts that will fail,
 772    * and that's true. But if the attacker can determine s (a valid
 773    * sequence number in the window) which is non-trivial, it can generate
 774    * a sequence s, s+1, s+2, s+3, ... s+n and nothing will prevent any
 775    * implementation, sequential or batching, from decrypting these.
 776    */
 777   if (ipsec_sa_anti_replay_check (sa0, pd->seq))
 778     {
 779       b->error = node->errors[ESP_DECRYPT_ERROR_REPLAY];
 780       next[0] = ESP_DECRYPT_NEXT_DROP;
 781       return;
 782     }
 783
 784   ipsec_sa_anti_replay_advance (sa0, pd->seq);
 785
 786   if (pd->is_chain)
 787     {
 788       lb = pd2->lb;
 789       icv_sz = pd2->icv_removed ? 0 : pd->icv_sz;
 790       if (pd2->free_buffer_index)
 791         {
 792           vlib_buffer_free_one (vm, pd2->free_buffer_index);
 793           lb->next_buffer = 0;
 794         }
 795       if (lb->current_length < sizeof (esp_footer_t) + icv_sz)
 796         {
 797           /* esp footer is either splitted in two buffers or in the before
 798            * last buffer */
 799
 800           vlib_buffer_t *before_last = b, *bp = b;
 801           while (bp->flags & VLIB_BUFFER_NEXT_PRESENT)
 802             {
 803               before_last = bp;
 804               bp = vlib_get_buffer (vm, bp->next_buffer);
 805             }
 806           u8 *bt = vlib_buffer_get_tail (before_last);
 807
 808           if (lb->current_length == icv_sz)
 809             {
 810               esp_footer_t *f = (esp_footer_t *) (bt - sizeof (*f));
 811               pad_length = f->pad_length;
 812               next_header = f->next_header;
 813             }
 814           else
 815             {
 816               pad_length = (bt - 1)[0];
 817               next_header = ((u8 *) vlib_buffer_get_current (lb))[0];
 818             }
 819         }
 820       else
 821         {
 822           esp_footer_t *f =
 823             (esp_footer_t *) (lb->data + lb->current_data +
 824                               lb->current_length - sizeof (esp_footer_t) -
 825                               icv_sz);
 826           pad_length = f->pad_length;
 827           next_header = f->next_header;
 828         }
 829     }
 830   else
 831     {
 832       icv_sz = pd->icv_sz;
 833       esp_footer_t *f =
 834         (esp_footer_t *) (lb->data + lb->current_data + lb->current_length -
 835                           sizeof (esp_footer_t) - icv_sz);
 836       pad_length = f->pad_length;
 837       next_header = f->next_header;
 838     }
 839
 840   u16 adv = pd->iv_sz + esp_sz;
 841   u16 tail = sizeof (esp_footer_t) + pad_length + icv_sz;
 842   u16 tail_orig = sizeof (esp_footer_t) + pad_length + pd->icv_sz;
 843   b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
 844
 845   if ((pd->flags & tun_flags) == 0 && !is_tun)  /* transport mode */
 846     {
 847       u8 udp_sz = (is_ip6 == 0 && pd->flags & IPSEC_SA_FLAG_UDP_ENCAP) ?
 848         sizeof (udp_header_t) : 0;
 849       u16 ip_hdr_sz = pd->hdr_sz - udp_sz;
 850       u8 *old_ip = b->data + pd->current_data - ip_hdr_sz - udp_sz;
 851       u8 *ip = old_ip + adv + udp_sz;
 852
 853       if (is_ip6 && ip_hdr_sz > 64)
 854         memmove (ip, old_ip, ip_hdr_sz);
 855       else
 856         clib_memcpy_le64 (ip, old_ip, ip_hdr_sz);
 857
 858       b->current_data = pd->current_data + adv - ip_hdr_sz;
 859       b->current_length += ip_hdr_sz - adv;
 860       esp_remove_tail (vm, b, lb, tail);
 861
 862       if (is_ip6)
 863         {
 864           ip6_header_t *ip6 = (ip6_header_t *) ip;
 865           u16 len = clib_net_to_host_u16 (ip6->payload_length);
 866           len -= adv + tail_orig;
 867           ip6->payload_length = clib_host_to_net_u16 (len);
 868           ip6->protocol = next_header;
 869           next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
 870         }
 871       else
 872         {
 873           ip4_header_t *ip4 = (ip4_header_t *) ip;
 874           ip_csum_t sum = ip4->checksum;
 875           u16 len = clib_net_to_host_u16 (ip4->length);
 876           len = clib_host_to_net_u16 (len - adv - tail_orig - udp_sz);
 877           sum = ip_csum_update (sum, ip4->protocol, next_header,
 878                                 ip4_header_t, protocol);
 879           sum = ip_csum_update (sum, ip4->length, len, ip4_header_t, length);
 880           ip4->checksum = ip_csum_fold (sum);
 881           ip4->protocol = next_header;
 882           ip4->length = len;
 883           next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
 884         }
 885     }
 886   else
 887     {
 888       if (PREDICT_TRUE (next_header == IP_PROTOCOL_IP_IN_IP))
 889         {
 890           next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
 891           b->current_data = pd->current_data + adv;
 892           b->current_length = pd->current_length - adv;
 893           esp_remove_tail (vm, b, lb, tail);
 894         }
 895       else if (next_header == IP_PROTOCOL_IPV6)
 896         {
 897           next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
 898           b->current_data = pd->current_data + adv;
 899           b->current_length = pd->current_length - adv;
 900           esp_remove_tail (vm, b, lb, tail);
 901         }
 902       else if (next_header == IP_PROTOCOL_MPLS_IN_IP)
 903         {
 904           next[0] = ESP_DECRYPT_NEXT_MPLS_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
 910         {
 911           if (is_tun && next_header == IP_PROTOCOL_GRE)
 912             {
 913               gre_header_t *gre;
 914
 915               b->current_data = pd->current_data + adv;
 916               b->current_length = pd->current_length - adv - tail;
 917
 918               gre = vlib_buffer_get_current (b);
 919
 920               vlib_buffer_advance (b, sizeof (*gre));
 921
 922               switch (clib_net_to_host_u16 (gre->protocol))
 923                 {
 924                 case GRE_PROTOCOL_teb:
 925                   vnet_update_l2_len (b);
 926                   next[0] = ESP_DECRYPT_NEXT_L2_INPUT;
 927                   break;
 928                 case GRE_PROTOCOL_ip4:
 929                   next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
 930                   break;
 931                 case GRE_PROTOCOL_ip6:
 932                   next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
 933                   break;
 934                 default:
 935                   b->error = node->errors[ESP_DECRYPT_ERROR_UNSUP_PAYLOAD];
 936                   next[0] = ESP_DECRYPT_NEXT_DROP;
 937                   break;
 938                 }
 939             }
 940           else
 941             {
 942               next[0] = ESP_DECRYPT_NEXT_DROP;
 943               b->error = node->errors[ESP_DECRYPT_ERROR_UNSUP_PAYLOAD];
 944               return;
 945             }
 946         }
 947       if (is_tun)
 948         {
 949           if (ipsec_sa_is_set_IS_PROTECT (sa0))
 950             {
 951               /*
 952                * There are two encap possibilities
 953                * 1) the tunnel and ths SA are prodiving encap, i.e. it's
 954                *   MAC | SA-IP | TUN-IP | ESP | PAYLOAD
 955                * implying the SA is in tunnel mode (on a tunnel interface)
 956                * 2) only the tunnel provides encap
 957                *   MAC | TUN-IP | ESP | PAYLOAD
 958                * implying the SA is in transport mode.
 959                *
 960                * For 2) we need only strip the tunnel encap and we're good.
 961                *  since the tunnel and crypto ecnap (int the tun=protect
 962                * object) are the same and we verified above that these match
 963                * for 1) we need to strip the SA-IP outer headers, to
 964                * reveal the tunnel IP and then check that this matches
 965                * the configured tunnel.
 966                */
 967               const ipsec_tun_protect_t *itp;
 968
 969               if (is_async)
 970                 itp = ipsec_tun_protect_get (pd->protect_index);
 971               else
 972                 itp =
 973                   ipsec_tun_protect_get (vnet_buffer (b)->
 974                                          ipsec.protect_index);
 975
 976               if (PREDICT_TRUE (next_header == IP_PROTOCOL_IP_IN_IP))
 977                 {
 978                   const ip4_header_t *ip4;
 979
 980                   ip4 = vlib_buffer_get_current (b);
 981
 982                   if (!ip46_address_is_equal_v4 (&itp->itp_tun.src,
 983                                                  &ip4->dst_address) ||
 984                       !ip46_address_is_equal_v4 (&itp->itp_tun.dst,
 985                                                  &ip4->src_address))
 986                     {
 987                       next[0] = ESP_DECRYPT_NEXT_DROP;
 988                       b->error = node->errors[ESP_DECRYPT_ERROR_TUN_NO_PROTO];
 989                     }
 990                 }
 991               else if (next_header == IP_PROTOCOL_IPV6)
 992                 {
 993                   const ip6_header_t *ip6;
 994
 995                   ip6 = vlib_buffer_get_current (b);
 996
 997                   if (!ip46_address_is_equal_v6 (&itp->itp_tun.src,
 998                                                  &ip6->dst_address) ||
 999                       !ip46_address_is_equal_v6 (&itp->itp_tun.dst,
1000                                                  &ip6->src_address))
1001                     {
1002                       next[0] = ESP_DECRYPT_NEXT_DROP;
1003                       b->error = node->errors[ESP_DECRYPT_ERROR_TUN_NO_PROTO];
1004                     }
1005                 }
1006             }
1007         }
1008     }
1009 }
1010
1011 always_inline uword
1012 esp_decrypt_inline (vlib_main_t * vm,
1013                     vlib_node_runtime_t * node, vlib_frame_t * from_frame,
1014                     int is_ip6, int is_tun, u16 async_next)
1015 {
1016   ipsec_main_t *im = &ipsec_main;
1017   u32 thread_index = vm->thread_index;
1018   u16 len;
1019   ipsec_per_thread_data_t *ptd = vec_elt_at_index (im->ptd, thread_index);
1020   u32 *from = vlib_frame_vector_args (from_frame);
1021   u32 n_left = from_frame->n_vectors;
1022   vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
1023   u16 nexts[VLIB_FRAME_SIZE], *next = nexts;
1024   esp_decrypt_packet_data_t pkt_data[VLIB_FRAME_SIZE], *pd = pkt_data;
1025   esp_decrypt_packet_data2_t pkt_data2[VLIB_FRAME_SIZE], *pd2 = pkt_data2;
1026   esp_decrypt_packet_data_t cpd = { };
1027   u32 current_sa_index = ~0, current_sa_bytes = 0, current_sa_pkts = 0;
1028   const u8 esp_sz = sizeof (esp_header_t);
1029   ipsec_sa_t *sa0 = 0;
1030   vnet_crypto_op_t _op, *op = &_op;
1031   vnet_crypto_op_t **crypto_ops = &ptd->crypto_ops;
1032   vnet_crypto_op_t **integ_ops = &ptd->integ_ops;
1033   int is_async = im->async_mode;
1034   vnet_crypto_async_op_id_t async_op = ~0;
1035   u16 n_async_drop = 0;
1036   vnet_crypto_async_frame_t *async_frames[VNET_CRYPTO_ASYNC_OP_N_IDS];
1037
1038   vlib_get_buffers (vm, from, b, n_left);
1039   if (!is_async)
1040     {
1041       vec_reset_length (ptd->crypto_ops);
1042       vec_reset_length (ptd->integ_ops);
1043       vec_reset_length (ptd->chained_crypto_ops);
1044       vec_reset_length (ptd->chained_integ_ops);
1045     }
1046   vec_reset_length (ptd->async_frames);
1047   vec_reset_length (ptd->chunks);
1048   clib_memset_u16 (nexts, -1, n_left);
1049   clib_memset (async_frames, 0, sizeof (async_frames));
1050
1051   while (n_left > 0)
1052     {
1053       u8 *payload;
1054
1055       if (n_left > 2)
1056         {
1057           u8 *p;
1058           vlib_prefetch_buffer_header (b[2], LOAD);
1059           p = vlib_buffer_get_current (b[1]);
1060           CLIB_PREFETCH (p, CLIB_CACHE_LINE_BYTES, LOAD);
1061           p -= CLIB_CACHE_LINE_BYTES;
1062           CLIB_PREFETCH (p, CLIB_CACHE_LINE_BYTES, LOAD);
1063         }
1064
1065       u32 n_bufs = vlib_buffer_chain_linearize (vm, b[0]);
1066       if (n_bufs == 0)
1067         {
1068           b[0]->error = node->errors[ESP_DECRYPT_ERROR_NO_BUFFERS];
1069           esp_set_next_index (is_async, from, nexts, from[b - bufs],
1070                               &n_async_drop, ESP_DECRYPT_NEXT_DROP, next);
1071           next[0] = ESP_DECRYPT_NEXT_DROP;
1072           goto next;
1073         }
1074
1075       if (vnet_buffer (b[0])->ipsec.sad_index != current_sa_index)
1076         {
1077           if (current_sa_pkts)
1078             vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
1079                                              current_sa_index,
1080                                              current_sa_pkts,
1081                                              current_sa_bytes);
1082           current_sa_bytes = current_sa_pkts = 0;
1083
1084           current_sa_index = vnet_buffer (b[0])->ipsec.sad_index;
1085           sa0 = ipsec_sa_get (current_sa_index);
1086
1087           /* fetch the second cacheline ASAP */
1088           CLIB_PREFETCH (sa0->cacheline1, CLIB_CACHE_LINE_BYTES, LOAD);
1089           cpd.icv_sz = sa0->integ_icv_size;
1090           cpd.iv_sz = sa0->crypto_iv_size;
1091           cpd.flags = sa0->flags;
1092           cpd.sa_index = current_sa_index;
1093         }
1094
1095       if (is_async)
1096         {
1097           async_op = sa0->crypto_async_dec_op_id;
1098
1099           if (PREDICT_FALSE (async_op == 0))
1100             {
1101               esp_set_next_index (is_async, from, nexts, from[b - bufs],
1102                                   &n_async_drop, ESP_DECRYPT_NEXT_DROP, next);
1103               goto next;
1104             }
1105
1106           /* get a frame for this op if we don't yet have one or it's full
1107            */
1108           if (NULL == async_frames[async_op] ||
1109               vnet_crypto_async_frame_is_full (async_frames[async_op]))
1110             {
1111               async_frames[async_op] =
1112                 vnet_crypto_async_get_frame (vm, async_op);
1113               /* Save the frame to the list we'll submit at the end */
1114               vec_add1 (ptd->async_frames, async_frames[async_op]);
1115             }
1116         }
1117
1118       if (PREDICT_FALSE (~0 == sa0->thread_index))
1119         {
1120           /* this is the first packet to use this SA, claim the SA
1121            * for this thread. this could happen simultaneously on
1122            * another thread */
1123           clib_atomic_cmp_and_swap (&sa0->thread_index, ~0,
1124                                     ipsec_sa_assign_thread (thread_index));
1125         }
1126
1127       if (PREDICT_FALSE (thread_index != sa0->thread_index))
1128         {
1129           vnet_buffer (b[0])->ipsec.thread_index = sa0->thread_index;
1130           esp_set_next_index (is_async, from, nexts, from[b - bufs],
1131                               &n_async_drop, ESP_DECRYPT_NEXT_HANDOFF, next);
1132           next[0] = ESP_DECRYPT_NEXT_HANDOFF;
1133           goto next;
1134         }
1135
1136       /* store packet data for next round for easier prefetch */
1137       pd->sa_data = cpd.sa_data;
1138       pd->current_data = b[0]->current_data;
1139       pd->hdr_sz = pd->current_data - vnet_buffer (b[0])->l3_hdr_offset;
1140       payload = b[0]->data + pd->current_data;
1141       pd->seq = clib_host_to_net_u32 (((esp_header_t *) payload)->seq);
1142       pd->is_chain = 0;
1143       pd2->lb = b[0];
1144       pd2->free_buffer_index = 0;
1145       pd2->icv_removed = 0;
1146
1147       if (n_bufs > 1)
1148         {
1149           pd->is_chain = 1;
1150           /* find last buffer in the chain */
1151           while (pd2->lb->flags & VLIB_BUFFER_NEXT_PRESENT)
1152             pd2->lb = vlib_get_buffer (vm, pd2->lb->next_buffer);
1153
1154           crypto_ops = &ptd->chained_crypto_ops;
1155           integ_ops = &ptd->chained_integ_ops;
1156         }
1157
1158       pd->current_length = b[0]->current_length;
1159
1160       /* anti-reply check */
1161       if (ipsec_sa_anti_replay_check (sa0, pd->seq))
1162         {
1163           b[0]->error = node->errors[ESP_DECRYPT_ERROR_REPLAY];
1164           esp_set_next_index (is_async, from, nexts, from[b - bufs],
1165                               &n_async_drop, ESP_DECRYPT_NEXT_DROP, next);
1166           goto next;
1167         }
1168
1169       if (pd->current_length < cpd.icv_sz + esp_sz + cpd.iv_sz)
1170         {
1171           b[0]->error = node->errors[ESP_DECRYPT_ERROR_RUNT];
1172           esp_set_next_index (is_async, from, nexts, from[b - bufs],
1173                               &n_async_drop, ESP_DECRYPT_NEXT_DROP, next);
1174           goto next;
1175         }
1176
1177       len = pd->current_length - cpd.icv_sz;
1178       current_sa_pkts += 1;
1179       current_sa_bytes += vlib_buffer_length_in_chain (vm, b[0]);
1180
1181       if (is_async)
1182         {
1183           esp_decrypt_error_t err;
1184
1185           err = esp_decrypt_prepare_async_frame (
1186             vm, node, ptd, async_frames[async_op], sa0, payload, len,
1187             cpd.icv_sz, cpd.iv_sz, pd, pd2, from[b - bufs], b[0], next,
1188             async_next);
1189           if (ESP_DECRYPT_ERROR_RX_PKTS != err)
1190             {
1191               b[0]->error = err;
1192               esp_set_next_index (1, from, nexts, from[b - bufs],
1193                                   &n_async_drop, ESP_DECRYPT_NEXT_DROP, next);
1194             }
1195         }
1196       else
1197         esp_decrypt_prepare_sync_op (vm, node, ptd, &crypto_ops, &integ_ops,
1198                                      op, sa0, payload, len, cpd.icv_sz,
1199                                      cpd.iv_sz, pd, pd2, b[0], next,
1200                                      b - bufs);
1201       /* next */
1202     next:
1203       n_left -= 1;
1204       next += 1;
1205       pd += 1;
1206       pd2 += 1;
1207       b += 1;
1208     }
1209
1210   if (PREDICT_TRUE (~0 != current_sa_index))
1211     vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
1212                                      current_sa_index, current_sa_pkts,
1213                                      current_sa_bytes);
1214
1215   if (is_async)
1216     {
1217       /* submit all of the open frames */
1218       vnet_crypto_async_frame_t **async_frame;
1219
1220       vec_foreach (async_frame, ptd->async_frames)
1221         {
1222           if (vnet_crypto_async_submit_open_frame (vm, *async_frame) < 0)
1223             {
1224               esp_async_recycle_failed_submit (
1225                 *async_frame, b, from, nexts, &n_async_drop,
1226                 ESP_DECRYPT_NEXT_DROP, ESP_DECRYPT_ERROR_CRYPTO_ENGINE_ERROR);
1227               vnet_crypto_async_reset_frame (*async_frame);
1228               vnet_crypto_async_free_frame (vm, *async_frame);
1229             }
1230         }
1231
1232       /* no post process in async */
1233       vlib_node_increment_counter (vm, node->node_index,
1234                                    ESP_DECRYPT_ERROR_RX_PKTS,
1235                                    from_frame->n_vectors);
1236       if (n_async_drop)
1237         vlib_buffer_enqueue_to_next (vm, node, from, nexts, n_async_drop);
1238
1239       return n_left;
1240     }
1241   else
1242     {
1243       esp_process_ops (vm, node, ptd->integ_ops, bufs, nexts,
1244                        ESP_DECRYPT_ERROR_INTEG_ERROR);
1245       esp_process_chained_ops (vm, node, ptd->chained_integ_ops, bufs, nexts,
1246                                ptd->chunks, ESP_DECRYPT_ERROR_INTEG_ERROR);
1247
1248       esp_process_ops (vm, node, ptd->crypto_ops, bufs, nexts,
1249                        ESP_DECRYPT_ERROR_DECRYPTION_FAILED);
1250       esp_process_chained_ops (vm, node, ptd->chained_crypto_ops, bufs, nexts,
1251                                ptd->chunks,
1252                                ESP_DECRYPT_ERROR_DECRYPTION_FAILED);
1253     }
1254
1255   /* Post decryption ronud - adjust packet data start and length and next
1256      node */
1257
1258   n_left = from_frame->n_vectors;
1259   next = nexts;
1260   pd = pkt_data;
1261   pd2 = pkt_data2;
1262   b = bufs;
1263
1264   while (n_left)
1265     {
1266       if (n_left >= 2)
1267         {
1268           void *data = b[1]->data + pd[1].current_data;
1269
1270           /* buffer metadata */
1271           vlib_prefetch_buffer_header (b[1], LOAD);
1272
1273           /* esp_footer_t */
1274           CLIB_PREFETCH (data + pd[1].current_length - pd[1].icv_sz - 2,
1275                          CLIB_CACHE_LINE_BYTES, LOAD);
1276
1277           /* packet headers */
1278           CLIB_PREFETCH (data - CLIB_CACHE_LINE_BYTES,
1279                          CLIB_CACHE_LINE_BYTES * 2, LOAD);
1280         }
1281
1282       /* save the sa_index as GRE_teb post_crypto changes L2 opaque */
1283       if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
1284         current_sa_index = vnet_buffer (b[0])->ipsec.sad_index;
1285
1286       if (next[0] >= ESP_DECRYPT_N_NEXT)
1287         esp_decrypt_post_crypto (vm, node, pd, pd2, b[0], next, is_ip6,
1288                                  is_tun, 0);
1289
1290       /* trace: */
1291       if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
1292         {
1293           esp_decrypt_trace_t *tr;
1294           tr = vlib_add_trace (vm, node, b[0], sizeof (*tr));
1295           sa0 = ipsec_sa_get (current_sa_index);
1296           tr->crypto_alg = sa0->crypto_alg;
1297           tr->integ_alg = sa0->integ_alg;
1298           tr->seq = pd->seq;
1299           tr->sa_seq = sa0->last_seq;
1300           tr->sa_seq_hi = sa0->seq_hi;
1301         }
1302
1303       /* next */
1304       n_left -= 1;
1305       next += 1;
1306       pd += 1;
1307       pd2 += 1;
1308       b += 1;
1309     }
1310
1311   n_left = from_frame->n_vectors;
1312   vlib_node_increment_counter (vm, node->node_index,
1313                                ESP_DECRYPT_ERROR_RX_PKTS, n_left);
1314
1315   vlib_buffer_enqueue_to_next (vm, node, from, nexts, n_left);
1316
1317   return n_left;
1318 }
1319
1320 always_inline uword
1321 esp_decrypt_post_inline (vlib_main_t * vm,
1322                          vlib_node_runtime_t * node,
1323                          vlib_frame_t * from_frame, int is_ip6, int is_tun)
1324 {
1325   u32 *from = vlib_frame_vector_args (from_frame);
1326   u32 n_left = from_frame->n_vectors;
1327   vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
1328   u16 nexts[VLIB_FRAME_SIZE], *next = nexts;
1329   vlib_get_buffers (vm, from, b, n_left);
1330
1331   while (n_left > 0)
1332     {
1333       esp_decrypt_packet_data_t *pd = &(esp_post_data (b[0]))->decrypt_data;
1334
1335       if (n_left > 2)
1336         {
1337           vlib_prefetch_buffer_header (b[2], LOAD);
1338           vlib_prefetch_buffer_header (b[1], LOAD);
1339         }
1340
1341       if (!pd->is_chain)
1342         esp_decrypt_post_crypto (vm, node, pd, 0, b[0], next, is_ip6, is_tun,
1343                                  1);
1344       else
1345         {
1346           esp_decrypt_packet_data2_t *pd2 = esp_post_data2 (b[0]);
1347           esp_decrypt_post_crypto (vm, node, pd, pd2, b[0], next, is_ip6,
1348                                    is_tun, 1);
1349         }
1350
1351       /*trace: */
1352       if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
1353         {
1354           ipsec_sa_t *sa0 = ipsec_sa_get (pd->sa_index);
1355           esp_decrypt_trace_t *tr;
1356           esp_decrypt_packet_data_t *async_pd =
1357             &(esp_post_data (b[0]))->decrypt_data;
1358           tr = vlib_add_trace (vm, node, b[0], sizeof (*tr));
1359           sa0 = ipsec_sa_get (async_pd->sa_index);
1360
1361           tr->crypto_alg = sa0->crypto_alg;
1362           tr->integ_alg = sa0->integ_alg;
1363           tr->seq = pd->seq;
1364           tr->sa_seq = sa0->last_seq;
1365           tr->sa_seq_hi = sa0->seq_hi;
1366         }
1367
1368       n_left--;
1369       next++;
1370       b++;
1371     }
1372
1373   n_left = from_frame->n_vectors;
1374   vlib_node_increment_counter (vm, node->node_index,
1375                                ESP_DECRYPT_ERROR_RX_POST_PKTS, n_left);
1376
1377   vlib_buffer_enqueue_to_next (vm, node, from, nexts, n_left);
1378
1379   return n_left;
1380 }
1381
1382 VLIB_NODE_FN (esp4_decrypt_node) (vlib_main_t * vm,
1383                                   vlib_node_runtime_t * node,
1384                                   vlib_frame_t * from_frame)
1385 {
1386   return esp_decrypt_inline (vm, node, from_frame, 0, 0,
1387                              esp_decrypt_async_next.esp4_post_next);
1388 }
1389
1390 VLIB_NODE_FN (esp4_decrypt_post_node) (vlib_main_t * vm,
1391                                        vlib_node_runtime_t * node,
1392                                        vlib_frame_t * from_frame)
1393 {
1394   return esp_decrypt_post_inline (vm, node, from_frame, 0, 0);
1395 }
1396
1397 VLIB_NODE_FN (esp4_decrypt_tun_node) (vlib_main_t * vm,
1398                                       vlib_node_runtime_t * node,
1399                                       vlib_frame_t * from_frame)
1400 {
1401   return esp_decrypt_inline (vm, node, from_frame, 0, 1,
1402                              esp_decrypt_async_next.esp4_tun_post_next);
1403 }
1404
1405 VLIB_NODE_FN (esp4_decrypt_tun_post_node) (vlib_main_t * vm,
1406                                            vlib_node_runtime_t * node,
1407                                            vlib_frame_t * from_frame)
1408 {
1409   return esp_decrypt_post_inline (vm, node, from_frame, 0, 1);
1410 }
1411
1412 VLIB_NODE_FN (esp6_decrypt_node) (vlib_main_t * vm,
1413                                   vlib_node_runtime_t * node,
1414                                   vlib_frame_t * from_frame)
1415 {
1416   return esp_decrypt_inline (vm, node, from_frame, 1, 0,
1417                              esp_decrypt_async_next.esp6_post_next);
1418 }
1419
1420 VLIB_NODE_FN (esp6_decrypt_post_node) (vlib_main_t * vm,
1421                                        vlib_node_runtime_t * node,
1422                                        vlib_frame_t * from_frame)
1423 {
1424   return esp_decrypt_post_inline (vm, node, from_frame, 1, 0);
1425 }
1426
1427 VLIB_NODE_FN (esp6_decrypt_tun_node) (vlib_main_t * vm,
1428                                       vlib_node_runtime_t * node,
1429                                       vlib_frame_t * from_frame)
1430 {
1431   return esp_decrypt_inline (vm, node, from_frame, 1, 1,
1432                              esp_decrypt_async_next.esp6_tun_post_next);
1433 }
1434
1435 VLIB_NODE_FN (esp6_decrypt_tun_post_node) (vlib_main_t * vm,
1436                                            vlib_node_runtime_t * node,
1437                                            vlib_frame_t * from_frame)
1438 {
1439   return esp_decrypt_post_inline (vm, node, from_frame, 1, 1);
1440 }
1441
1442 /* *INDENT-OFF* */
1443 VLIB_REGISTER_NODE (esp4_decrypt_node) = {
1444   .name = "esp4-decrypt",
1445   .vector_size = sizeof (u32),
1446   .format_trace = format_esp_decrypt_trace,
1447   .type = VLIB_NODE_TYPE_INTERNAL,
1448
1449   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
1450   .error_strings = esp_decrypt_error_strings,
1451
1452   .n_next_nodes = ESP_DECRYPT_N_NEXT,
1453   .next_nodes = {
1454     [ESP_DECRYPT_NEXT_DROP] = "ip4-drop",
1455     [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
1456     [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
1457     [ESP_DECRYPT_NEXT_MPLS_INPUT] = "mpls-drop",
1458     [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
1459     [ESP_DECRYPT_NEXT_HANDOFF] = "esp4-decrypt-handoff",
1460   },
1461 };
1462
1463 VLIB_REGISTER_NODE (esp4_decrypt_post_node) = {
1464   .name = "esp4-decrypt-post",
1465   .vector_size = sizeof (u32),
1466   .format_trace = format_esp_decrypt_trace,
1467   .type = VLIB_NODE_TYPE_INTERNAL,
1468
1469   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
1470   .error_strings = esp_decrypt_error_strings,
1471
1472   .sibling_of = "esp4-decrypt",
1473 };
1474
1475 VLIB_REGISTER_NODE (esp6_decrypt_node) = {
1476   .name = "esp6-decrypt",
1477   .vector_size = sizeof (u32),
1478   .format_trace = format_esp_decrypt_trace,
1479   .type = VLIB_NODE_TYPE_INTERNAL,
1480
1481   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
1482   .error_strings = esp_decrypt_error_strings,
1483
1484   .n_next_nodes = ESP_DECRYPT_N_NEXT,
1485   .next_nodes = {
1486     [ESP_DECRYPT_NEXT_DROP] = "ip6-drop",
1487     [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
1488     [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
1489     [ESP_DECRYPT_NEXT_MPLS_INPUT] = "mpls-drop",
1490     [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
1491     [ESP_DECRYPT_NEXT_HANDOFF]=  "esp6-decrypt-handoff",
1492   },
1493 };
1494
1495 VLIB_REGISTER_NODE (esp6_decrypt_post_node) = {
1496   .name = "esp6-decrypt-post",
1497   .vector_size = sizeof (u32),
1498   .format_trace = format_esp_decrypt_trace,
1499   .type = VLIB_NODE_TYPE_INTERNAL,
1500
1501   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
1502   .error_strings = esp_decrypt_error_strings,
1503
1504   .sibling_of = "esp6-decrypt",
1505 };
1506
1507 VLIB_REGISTER_NODE (esp4_decrypt_tun_node) = {
1508   .name = "esp4-decrypt-tun",
1509   .vector_size = sizeof (u32),
1510   .format_trace = format_esp_decrypt_trace,
1511   .type = VLIB_NODE_TYPE_INTERNAL,
1512   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
1513   .error_strings = esp_decrypt_error_strings,
1514   .n_next_nodes = ESP_DECRYPT_N_NEXT,
1515   .next_nodes = {
1516     [ESP_DECRYPT_NEXT_DROP] = "ip4-drop",
1517     [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
1518     [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
1519     [ESP_DECRYPT_NEXT_MPLS_INPUT] = "mpls-input",
1520     [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
1521     [ESP_DECRYPT_NEXT_HANDOFF] = "esp4-decrypt-tun-handoff",
1522   },
1523 };
1524
1525 VLIB_REGISTER_NODE (esp4_decrypt_tun_post_node) = {
1526   .name = "esp4-decrypt-tun-post",
1527   .vector_size = sizeof (u32),
1528   .format_trace = format_esp_decrypt_trace,
1529   .type = VLIB_NODE_TYPE_INTERNAL,
1530
1531   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
1532   .error_strings = esp_decrypt_error_strings,
1533
1534   .sibling_of = "esp4-decrypt-tun",
1535 };
1536
1537 VLIB_REGISTER_NODE (esp6_decrypt_tun_node) = {
1538   .name = "esp6-decrypt-tun",
1539   .vector_size = sizeof (u32),
1540   .format_trace = format_esp_decrypt_trace,
1541   .type = VLIB_NODE_TYPE_INTERNAL,
1542   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
1543   .error_strings = esp_decrypt_error_strings,
1544   .n_next_nodes = ESP_DECRYPT_N_NEXT,
1545   .next_nodes = {
1546     [ESP_DECRYPT_NEXT_DROP] = "ip6-drop",
1547     [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
1548     [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
1549     [ESP_DECRYPT_NEXT_MPLS_INPUT] = "mpls-input",
1550     [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
1551     [ESP_DECRYPT_NEXT_HANDOFF]=  "esp6-decrypt-tun-handoff",
1552   },
1553 };
1554
1555 VLIB_REGISTER_NODE (esp6_decrypt_tun_post_node) = {
1556   .name = "esp6-decrypt-tun-post",
1557   .vector_size = sizeof (u32),
1558   .format_trace = format_esp_decrypt_trace,
1559   .type = VLIB_NODE_TYPE_INTERNAL,
1560
1561   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
1562   .error_strings = esp_decrypt_error_strings,
1563
1564   .sibling_of = "esp6-decrypt-tun",
1565 };
1566 /* *INDENT-ON* */
1567
1568 #ifndef CLIB_MARCH_VARIANT
1569
1570 static clib_error_t *
1571 esp_decrypt_init (vlib_main_t *vm)
1572 {
1573   ipsec_main_t *im = &ipsec_main;
1574
1575   im->esp4_dec_fq_index =
1576     vlib_frame_queue_main_init (esp4_decrypt_node.index, 0);
1577   im->esp6_dec_fq_index =
1578     vlib_frame_queue_main_init (esp6_decrypt_node.index, 0);
1579   im->esp4_dec_tun_fq_index =
1580     vlib_frame_queue_main_init (esp4_decrypt_tun_node.index, 0);
1581   im->esp6_dec_tun_fq_index =
1582     vlib_frame_queue_main_init (esp6_decrypt_tun_node.index, 0);
1583
1584   return 0;
1585 }
1586
1587 VLIB_INIT_FUNCTION (esp_decrypt_init);
1588
1589 #endif
1590
1591 /*
1592  * fd.io coding-style-patch-verification: ON
1593  *
1594  * Local Variables:
1595  * eval: (c-set-style "gnu")
1596  * End:
1597  */