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