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/gre.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 _(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
  46 #define foreach_esp_decrypt_error                               \
  47  _(RX_PKTS, "ESP pkts received")                                \
  48  _(DECRYPTION_FAILED, "ESP decryption failed")                  \
  49  _(INTEG_ERROR, "Integrity check failed")                       \
  50  _(CRYPTO_ENGINE_ERROR, "crypto engine error (packet dropped)") \
  51  _(REPLAY, "SA replayed packet")                                \
  52  _(RUNT, "undersized packet")                                   \
  53  _(NO_BUFFERS, "no buffers (packet dropped)")                   \
  54  _(OVERSIZED_HEADER, "buffer with oversized header (dropped)")  \
  55  _(NO_TAIL_SPACE, "no enough buffer tail space (dropped)")      \
  56  _(TUN_NO_PROTO, "no tunnel protocol")                          \
  57  _(UNSUP_PAYLOAD, "unsupported payload")                        \
  58
  59
  60 typedef enum
  61 {
  62 #define _(sym,str) ESP_DECRYPT_ERROR_##sym,
  63   foreach_esp_decrypt_error
  64 #undef _
  65     ESP_DECRYPT_N_ERROR,
  66 } esp_decrypt_error_t;
  67
  68 static char *esp_decrypt_error_strings[] = {
  69 #define _(sym,string) string,
  70   foreach_esp_decrypt_error
  71 #undef _
  72 };
  73
  74 typedef struct
  75 {
  76   u32 seq;
  77   u32 sa_seq;
  78   u32 sa_seq_hi;
  79   ipsec_crypto_alg_t crypto_alg;
  80   ipsec_integ_alg_t integ_alg;
  81 } esp_decrypt_trace_t;
  82
  83 /* packet trace format function */
  84 static u8 *
  85 format_esp_decrypt_trace (u8 * s, va_list * args)
  86 {
  87   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  88   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  89   esp_decrypt_trace_t *t = va_arg (*args, esp_decrypt_trace_t *);
  90
  91   s =
  92     format (s,
  93             "esp: crypto %U integrity %U pkt-seq %d sa-seq %u sa-seq-hi %u",
  94             format_ipsec_crypto_alg, t->crypto_alg, format_ipsec_integ_alg,
  95             t->integ_alg, t->seq, t->sa_seq, t->sa_seq_hi);
  96   return s;
  97 }
  98
  99 typedef struct
 100 {
 101   union
 102   {
 103     struct
 104     {
 105       u8 icv_sz;
 106       u8 iv_sz;
 107       ipsec_sa_flags_t flags;
 108       u32 sa_index;
 109     };
 110     u64 sa_data;
 111   };
 112
 113   u32 seq;
 114   i16 current_data;
 115   i16 current_length;
 116   u16 hdr_sz;
 117   vlib_buffer_t *lb;
 118   u32 free_buffer_index;
 119   u8 icv_removed;
 120 } esp_decrypt_packet_data_t;
 121
 122 STATIC_ASSERT_SIZEOF (esp_decrypt_packet_data_t, 5 * sizeof (u64));
 123
 124 #define ESP_ENCRYPT_PD_F_FD_TRANSPORT (1 << 2)
 125
 126 static_always_inline void
 127 esp_process_ops (vlib_main_t * vm, vlib_node_runtime_t * node,
 128                  vnet_crypto_op_t * ops, vlib_buffer_t * b[], u16 * nexts,
 129                  int e)
 130 {
 131   vnet_crypto_op_t *op = ops;
 132   u32 n_fail, n_ops = vec_len (ops);
 133
 134   if (n_ops == 0)
 135     return;
 136
 137   n_fail = n_ops - vnet_crypto_process_ops (vm, op, 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           b[bi]->error = node->errors[err];
 150           nexts[bi] = ESP_DECRYPT_NEXT_DROP;
 151           n_fail--;
 152         }
 153       op++;
 154     }
 155 }
 156
 157 static_always_inline void
 158 esp_process_chained_ops (vlib_main_t * vm, vlib_node_runtime_t * node,
 159                          vnet_crypto_op_t * ops, vlib_buffer_t * b[],
 160                          u16 * nexts, vnet_crypto_op_chunk_t * chunks, int e)
 161 {
 162
 163   vnet_crypto_op_t *op = ops;
 164   u32 n_fail, n_ops = vec_len (ops);
 165
 166   if (n_ops == 0)
 167     return;
 168
 169   n_fail = n_ops - vnet_crypto_process_chained_ops (vm, op, chunks, n_ops);
 170
 171   while (n_fail)
 172     {
 173       ASSERT (op - ops < n_ops);
 174       if (op->status != VNET_CRYPTO_OP_STATUS_COMPLETED)
 175         {
 176           u32 err, bi = op->user_data;
 177           if (op->status == VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC)
 178             err = e;
 179           else
 180             err = ESP_DECRYPT_ERROR_CRYPTO_ENGINE_ERROR;
 181           b[bi]->error = node->errors[err];
 182           nexts[bi] = ESP_DECRYPT_NEXT_DROP;
 183           n_fail--;
 184         }
 185       op++;
 186     }
 187 }
 188
 189 always_inline void
 190 esp_remove_tail (vlib_main_t * vm, vlib_buffer_t * b, vlib_buffer_t * last,
 191                  u16 tail)
 192 {
 193   vlib_buffer_t *before_last = b;
 194
 195   if (last->current_length > tail)
 196     {
 197       last->current_length -= tail;
 198       return;
 199     }
 200   ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
 201
 202   while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
 203     {
 204       before_last = b;
 205       b = vlib_get_buffer (vm, b->next_buffer);
 206     }
 207   before_last->current_length -= tail - last->current_length;
 208   vlib_buffer_free_one (vm, before_last->next_buffer);
 209   before_last->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
 210 }
 211
 212 /* ICV is splitted in last two buffers so move it to the last buffer and
 213    return pointer to it */
 214 static_always_inline u8 *
 215 esp_move_icv (vlib_main_t * vm, vlib_buffer_t * first,
 216               esp_decrypt_packet_data_t * pd, u16 icv_sz)
 217 {
 218   vlib_buffer_t *before_last, *bp;
 219   u16 last_sz = pd->lb->current_length;
 220   u16 first_sz = icv_sz - last_sz;
 221
 222   bp = before_last = first;
 223   while (bp->flags & VLIB_BUFFER_NEXT_PRESENT)
 224     {
 225       before_last = bp;
 226       bp = vlib_get_buffer (vm, bp->next_buffer);
 227     }
 228
 229   u8 *lb_curr = vlib_buffer_get_current (pd->lb);
 230   memmove (lb_curr + first_sz, lb_curr, last_sz);
 231   clib_memcpy_fast (lb_curr, vlib_buffer_get_tail (before_last) - first_sz,
 232                     first_sz);
 233   before_last->current_length -= first_sz;
 234   pd->lb = before_last;
 235   pd->icv_removed = 1;
 236   pd->free_buffer_index = before_last->next_buffer;
 237   before_last->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
 238   return lb_curr;
 239 }
 240
 241 always_inline uword
 242 esp_decrypt_inline (vlib_main_t * vm,
 243                     vlib_node_runtime_t * node, vlib_frame_t * from_frame,
 244                     int is_ip6, int is_tun)
 245 {
 246   ipsec_main_t *im = &ipsec_main;
 247   u32 thread_index = vm->thread_index;
 248   u16 buffer_data_size = vlib_buffer_get_default_data_size (vm);
 249   u16 len;
 250   ipsec_per_thread_data_t *ptd = vec_elt_at_index (im->ptd, thread_index);
 251   u32 *from = vlib_frame_vector_args (from_frame);
 252   u32 n_left = from_frame->n_vectors;
 253   vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
 254   u16 nexts[VLIB_FRAME_SIZE], *next = nexts;
 255   esp_decrypt_packet_data_t pkt_data[VLIB_FRAME_SIZE], *pd = pkt_data;
 256   esp_decrypt_packet_data_t cpd = { };
 257   u32 current_sa_index = ~0, current_sa_bytes = 0, current_sa_pkts = 0;
 258   const u8 esp_sz = sizeof (esp_header_t);
 259   ipsec_sa_t *sa0 = 0;
 260   vnet_crypto_op_chunk_t *ch;
 261   vnet_crypto_op_t **crypto_ops = &ptd->crypto_ops;
 262   vnet_crypto_op_t **integ_ops = &ptd->integ_ops;
 263
 264   vlib_get_buffers (vm, from, b, n_left);
 265   vec_reset_length (ptd->crypto_ops);
 266   vec_reset_length (ptd->integ_ops);
 267   vec_reset_length (ptd->chained_crypto_ops);
 268   vec_reset_length (ptd->chained_integ_ops);
 269   vec_reset_length (ptd->chunks);
 270   clib_memset_u16 (nexts, -1, n_left);
 271
 272   while (n_left > 0)
 273     {
 274       u8 *payload;
 275
 276       if (n_left > 2)
 277         {
 278           u8 *p;
 279           vlib_prefetch_buffer_header (b[2], LOAD);
 280           p = vlib_buffer_get_current (b[1]);
 281           CLIB_PREFETCH (p, CLIB_CACHE_LINE_BYTES, LOAD);
 282           p -= CLIB_CACHE_LINE_BYTES;
 283           CLIB_PREFETCH (p, CLIB_CACHE_LINE_BYTES, LOAD);
 284         }
 285
 286       u32 n_bufs = vlib_buffer_chain_linearize (vm, b[0]);
 287       if (n_bufs == 0)
 288         {
 289           b[0]->error = node->errors[ESP_DECRYPT_ERROR_NO_BUFFERS];
 290           next[0] = ESP_DECRYPT_NEXT_DROP;
 291           goto next;
 292         }
 293
 294       if (vnet_buffer (b[0])->ipsec.sad_index != current_sa_index)
 295         {
 296           if (current_sa_pkts)
 297             vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
 298                                              current_sa_index,
 299                                              current_sa_pkts,
 300                                              current_sa_bytes);
 301           current_sa_bytes = current_sa_pkts = 0;
 302
 303           current_sa_index = vnet_buffer (b[0])->ipsec.sad_index;
 304           sa0 = pool_elt_at_index (im->sad, current_sa_index);
 305           cpd.icv_sz = sa0->integ_icv_size;
 306           cpd.iv_sz = sa0->crypto_iv_size;
 307           cpd.flags = sa0->flags;
 308           cpd.sa_index = current_sa_index;
 309         }
 310
 311       if (PREDICT_FALSE (~0 == sa0->decrypt_thread_index))
 312         {
 313           /* this is the first packet to use this SA, claim the SA
 314            * for this thread. this could happen simultaneously on
 315            * another thread */
 316           clib_atomic_cmp_and_swap (&sa0->decrypt_thread_index, ~0,
 317                                     ipsec_sa_assign_thread (thread_index));
 318         }
 319
 320       if (PREDICT_TRUE (thread_index != sa0->decrypt_thread_index))
 321         {
 322           next[0] = ESP_DECRYPT_NEXT_HANDOFF;
 323           goto next;
 324         }
 325
 326       /* store packet data for next round for easier prefetch */
 327       pd->sa_data = cpd.sa_data;
 328       pd->current_data = b[0]->current_data;
 329       pd->current_length = b[0]->current_length;
 330       pd->hdr_sz = pd->current_data - vnet_buffer (b[0])->l3_hdr_offset;
 331       payload = b[0]->data + pd->current_data;
 332       pd->seq = clib_host_to_net_u32 (((esp_header_t *) payload)->seq);
 333       pd->free_buffer_index = 0;
 334       pd->icv_removed = 0;
 335
 336       pd->lb = b[0];
 337       if (n_bufs > 1)
 338         {
 339           /* find last buffer in the chain */
 340           while (pd->lb->flags & VLIB_BUFFER_NEXT_PRESENT)
 341             pd->lb = vlib_get_buffer (vm, pd->lb->next_buffer);
 342
 343           crypto_ops = &ptd->chained_crypto_ops;
 344           integ_ops = &ptd->chained_integ_ops;
 345         }
 346       pd->current_length = b[0]->current_length;
 347
 348       /* we need 4 extra bytes for HMAC calculation when ESN are used */
 349       /* Chained buffers can process ESN as a separate chunk */
 350       if (pd->lb == b[0] && ipsec_sa_is_set_USE_ESN (sa0) && cpd.icv_sz &&
 351           (pd->lb->current_data + pd->lb->current_length + 4
 352            > buffer_data_size))
 353         {
 354           b[0]->error = node->errors[ESP_DECRYPT_ERROR_NO_TAIL_SPACE];
 355           next[0] = ESP_DECRYPT_NEXT_DROP;
 356           goto next;
 357         }
 358
 359       /* anti-reply check */
 360       if (ipsec_sa_anti_replay_check (sa0, pd->seq))
 361         {
 362           b[0]->error = node->errors[ESP_DECRYPT_ERROR_REPLAY];
 363           next[0] = ESP_DECRYPT_NEXT_DROP;
 364           goto next;
 365         }
 366
 367       if (pd->current_length < cpd.icv_sz + esp_sz + cpd.iv_sz)
 368         {
 369           b[0]->error = node->errors[ESP_DECRYPT_ERROR_RUNT];
 370           next[0] = ESP_DECRYPT_NEXT_DROP;
 371           goto next;
 372         }
 373
 374       len = pd->current_length - cpd.icv_sz;
 375       current_sa_pkts += 1;
 376       current_sa_bytes += vlib_buffer_length_in_chain (vm, b[0]);
 377
 378       if (PREDICT_TRUE (sa0->integ_op_id != VNET_CRYPTO_OP_NONE))
 379         {
 380           vnet_crypto_op_t *op;
 381           vec_add2_aligned (integ_ops[0], op, 1, CLIB_CACHE_LINE_BYTES);
 382
 383           vnet_crypto_op_init (op, sa0->integ_op_id);
 384           op->key_index = sa0->integ_key_index;
 385           op->src = payload;
 386           op->flags = VNET_CRYPTO_OP_FLAG_HMAC_CHECK;
 387           op->user_data = b - bufs;
 388           op->digest = payload + len;
 389           op->digest_len = cpd.icv_sz;
 390           op->len = len;
 391
 392           if (pd->lb != b[0])
 393             {
 394               /* buffer is chained */
 395               vlib_buffer_t *cb = b[0];
 396               op->flags |= VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS;
 397               op->chunk_index = vec_len (ptd->chunks);
 398
 399               if (pd->lb->current_length < cpd.icv_sz)
 400                 op->digest = esp_move_icv (vm, b[0], pd, cpd.icv_sz);
 401               else
 402                 op->digest = vlib_buffer_get_tail (pd->lb) - cpd.icv_sz;
 403
 404               vec_add2 (ptd->chunks, ch, 1);
 405               ch->len = pd->current_length;
 406               ch->src = payload;
 407               cb = vlib_get_buffer (vm, cb->next_buffer);
 408               op->n_chunks = 1;
 409               while (1)
 410                 {
 411                   vec_add2 (ptd->chunks, ch, 1);
 412                   op->n_chunks += 1;
 413                   ch->src = vlib_buffer_get_current (cb);
 414                   if (pd->lb == cb)
 415                     {
 416                       if (pd->icv_removed)
 417                         ch->len = cb->current_length;
 418                       else
 419                         ch->len = cb->current_length - cpd.icv_sz;
 420                       if (ipsec_sa_is_set_USE_ESN (sa0))
 421                         {
 422                           u32 seq_hi = clib_host_to_net_u32 (sa0->seq_hi);
 423                           u8 tmp[ESP_MAX_ICV_SIZE], sz = sizeof (sa0->seq_hi);
 424                           u8 *esn;
 425                           vlib_buffer_t *tmp_b;
 426                           u16 space_left = vlib_buffer_space_left_at_end
 427                             (vm, pd->lb);
 428                           if (space_left < sz)
 429                             {
 430                               if (pd->icv_removed)
 431                                 {
 432                                   /* use pre-data area from the last bufer
 433                                      that was removed from the chain */
 434                                   tmp_b =
 435                                     vlib_get_buffer (vm,
 436                                                      pd->free_buffer_index);
 437                                   esn = tmp_b->data - sz;
 438                                 }
 439                               else
 440                                 {
 441                                   /* no space, need to allocate new buffer */
 442                                   u32 tmp_bi = 0;
 443                                   vlib_buffer_alloc (vm, &tmp_bi, 1);
 444                                   tmp_b = vlib_get_buffer (vm, tmp_bi);
 445                                   esn = tmp_b->data;
 446                                   pd->free_buffer_index = tmp_bi;
 447                                 }
 448                               clib_memcpy_fast (esn, &seq_hi, sz);
 449
 450                               vec_add2 (ptd->chunks, ch, 1);
 451                               op->n_chunks += 1;
 452                               ch->src = esn;
 453                               ch->len = sz;
 454                             }
 455                           else
 456                             {
 457                               if (pd->icv_removed)
 458                                 {
 459                                   clib_memcpy_fast (vlib_buffer_get_tail
 460                                                     (pd->lb), &seq_hi, sz);
 461                                 }
 462                               else
 463                                 {
 464                                   clib_memcpy_fast (tmp, op->digest,
 465                                                     ESP_MAX_ICV_SIZE);
 466                                   clib_memcpy_fast (op->digest, &seq_hi, sz);
 467                                   clib_memcpy_fast (op->digest + sz, tmp,
 468                                                     ESP_MAX_ICV_SIZE);
 469                                   op->digest += sz;
 470                                 }
 471                               ch->len += sz;
 472                             }
 473                         }
 474                     }
 475                   else
 476                     ch->len = cb->current_length;
 477
 478                   if (!(cb->flags & VLIB_BUFFER_NEXT_PRESENT))
 479                     break;
 480
 481                   cb = vlib_get_buffer (vm, cb->next_buffer);
 482                 }
 483             }
 484           else if (ipsec_sa_is_set_USE_ESN (sa0))
 485             {
 486               /* shift ICV by 4 bytes to insert ESN */
 487               u32 seq_hi = clib_host_to_net_u32 (sa0->seq_hi);
 488               u8 tmp[ESP_MAX_ICV_SIZE], sz = sizeof (sa0->seq_hi);
 489               clib_memcpy_fast (tmp, payload + len, ESP_MAX_ICV_SIZE);
 490               clib_memcpy_fast (payload + len, &seq_hi, sz);
 491               clib_memcpy_fast (payload + len + sz, tmp, ESP_MAX_ICV_SIZE);
 492               op->len += sz;
 493               op->digest += sz;
 494             }
 495         }
 496
 497       payload += esp_sz;
 498       len -= esp_sz;
 499
 500       if (sa0->crypto_dec_op_id != VNET_CRYPTO_OP_NONE)
 501         {
 502           vnet_crypto_op_t *op;
 503           vec_add2_aligned (crypto_ops[0], op, 1, CLIB_CACHE_LINE_BYTES);
 504           vnet_crypto_op_init (op, sa0->crypto_dec_op_id);
 505           op->key_index = sa0->crypto_key_index;
 506           op->iv = payload;
 507
 508           if (ipsec_sa_is_set_IS_AEAD (sa0))
 509             {
 510               esp_header_t *esp0;
 511               esp_aead_t *aad;
 512               u8 *scratch;
 513
 514               /*
 515                * construct the AAD and the nonce (Salt || IV) in a scratch
 516                * space in front of the IP header.
 517                */
 518               scratch = payload - esp_sz;
 519               esp0 = (esp_header_t *) (scratch);
 520
 521               scratch -= (sizeof (*aad) + pd->hdr_sz);
 522               op->aad = scratch;
 523
 524               esp_aad_fill (op, esp0, sa0);
 525
 526               /*
 527                * we don't need to refer to the ESP header anymore so we
 528                * can overwrite it with the salt and use the IV where it is
 529                * to form the nonce = (Salt + IV)
 530                */
 531               op->iv -= sizeof (sa0->salt);
 532               clib_memcpy_fast (op->iv, &sa0->salt, sizeof (sa0->salt));
 533
 534               op->tag = payload + len;
 535               op->tag_len = 16;
 536             }
 537           op->src = op->dst = payload += cpd.iv_sz;
 538           op->len = len - cpd.iv_sz;
 539           op->user_data = b - bufs;
 540
 541           if (pd->lb != b[0])
 542             {
 543               /* buffer is chained */
 544               vlib_buffer_t *cb = b[0];
 545               op->flags |= VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS;
 546               op->chunk_index = vec_len (ptd->chunks);
 547               vec_add2 (ptd->chunks, ch, 1);
 548               ch->len = len - cpd.iv_sz + cpd.icv_sz;
 549               ch->src = ch->dst = payload;
 550               cb = vlib_get_buffer (vm, cb->next_buffer);
 551               op->n_chunks = 1;
 552
 553               while (1)
 554                 {
 555                   vec_add2 (ptd->chunks, ch, 1);
 556                   op->n_chunks += 1;
 557                   ch->src = ch->dst = vlib_buffer_get_current (cb);
 558                   if (pd->lb == cb)
 559                     {
 560                       if (ipsec_sa_is_set_IS_AEAD (sa0))
 561                         {
 562                           if (pd->lb->current_length < cpd.icv_sz)
 563                             {
 564                               op->tag =
 565                                 esp_move_icv (vm, b[0], pd, cpd.icv_sz);
 566
 567                               /* this chunk does not contain crypto data */
 568                               op->n_chunks -= 1;
 569
 570                               /* and fix previous chunk's length as it might have
 571                                  been changed */
 572                               ASSERT (op->n_chunks > 0);
 573                               ch[-1].len = pd->lb->current_length;
 574                               break;
 575                             }
 576                           else
 577                             op->tag =
 578                               vlib_buffer_get_tail (pd->lb) - cpd.icv_sz;
 579                         }
 580
 581                       if (pd->icv_removed)
 582                         ch->len = cb->current_length;
 583                       else
 584                         ch->len = cb->current_length - cpd.icv_sz;
 585                     }
 586                   else
 587                     ch->len = cb->current_length;
 588
 589                   if (!(cb->flags & VLIB_BUFFER_NEXT_PRESENT))
 590                     break;
 591
 592                   cb = vlib_get_buffer (vm, cb->next_buffer);
 593                 }
 594             }
 595         }
 596
 597       /* next */
 598     next:
 599       n_left -= 1;
 600       next += 1;
 601       pd += 1;
 602       b += 1;
 603     }
 604
 605   if (PREDICT_TRUE (~0 != current_sa_index))
 606     vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
 607                                      current_sa_index, current_sa_pkts,
 608                                      current_sa_bytes);
 609
 610   esp_process_ops (vm, node, ptd->integ_ops, bufs, nexts,
 611                    ESP_DECRYPT_ERROR_INTEG_ERROR);
 612   esp_process_chained_ops (vm, node, ptd->chained_integ_ops, bufs, nexts,
 613                            ptd->chunks, ESP_DECRYPT_ERROR_INTEG_ERROR);
 614
 615   esp_process_ops (vm, node, ptd->crypto_ops, bufs, nexts,
 616                    ESP_DECRYPT_ERROR_DECRYPTION_FAILED);
 617   esp_process_chained_ops (vm, node, ptd->chained_crypto_ops, bufs, nexts,
 618                            ptd->chunks, ESP_DECRYPT_ERROR_DECRYPTION_FAILED);
 619
 620   /* Post decryption ronud - adjust packet data start and length and next
 621      node */
 622
 623   n_left = from_frame->n_vectors;
 624   next = nexts;
 625   pd = pkt_data;
 626   b = bufs;
 627
 628   while (n_left)
 629     {
 630       const u8 tun_flags = IPSEC_SA_FLAG_IS_TUNNEL |
 631         IPSEC_SA_FLAG_IS_TUNNEL_V6;
 632
 633       if (n_left >= 2)
 634         {
 635           void *data = b[1]->data + pd[1].current_data;
 636
 637           /* buffer metadata */
 638           vlib_prefetch_buffer_header (b[1], LOAD);
 639
 640           /* esp_footer_t */
 641           CLIB_PREFETCH (data + pd[1].current_length - pd[1].icv_sz - 2,
 642                          CLIB_CACHE_LINE_BYTES, LOAD);
 643
 644           /* packet headers */
 645           CLIB_PREFETCH (data - CLIB_CACHE_LINE_BYTES,
 646                          CLIB_CACHE_LINE_BYTES * 2, LOAD);
 647         }
 648
 649       if (next[0] < ESP_DECRYPT_N_NEXT)
 650         goto trace;
 651
 652       sa0 = vec_elt_at_index (im->sad, pd->sa_index);
 653
 654       /*
 655        * redo the anti-reply check
 656        * in this frame say we have sequence numbers, s, s+1, s+1, s+1
 657        * and s and s+1 are in the window. When we did the anti-replay
 658        * check above we did so against the state of the window (W),
 659        * after packet s-1. So each of the packets in the sequence will be
 660        * accepted.
 661        * This time s will be cheked against Ws-1, s+1 chceked against Ws
 662        * (i.e. the window state is updated/advnaced)
 663        * so this time the successive s+! packet will be dropped.
 664        * This is a consequence of batching the decrypts. If the
 665        * check-dcrypt-advance process was done for each packet it would
 666        * be fine. But we batch the decrypts because it's much more efficient
 667        * to do so in SW and if we offload to HW and the process is async.
 668        *
 669        * You're probably thinking, but this means an attacker can send the
 670        * above sequence and cause VPP to perform decrpyts that will fail,
 671        * and that's true. But if the attacker can determine s (a valid
 672        * sequence number in the window) which is non-trivial, it can generate
 673        * a sequence s, s+1, s+2, s+3, ... s+n and nothing will prevent any
 674        * implementation, sequential or batching, from decrypting these.
 675        */
 676       if (ipsec_sa_anti_replay_check (sa0, pd->seq))
 677         {
 678           b[0]->error = node->errors[ESP_DECRYPT_ERROR_REPLAY];
 679           next[0] = ESP_DECRYPT_NEXT_DROP;
 680           goto trace;
 681         }
 682
 683       ipsec_sa_anti_replay_advance (sa0, pd->seq);
 684
 685       u8 pad_length = 0, next_header = 0;
 686       u16 icv_sz = pd->icv_removed ? 0 : pd->icv_sz;
 687
 688       if (pd->free_buffer_index)
 689         vlib_buffer_free_one (vm, pd->free_buffer_index);
 690
 691       if (pd->lb->current_length < sizeof (esp_footer_t) + icv_sz)
 692         {
 693           /* esp footer is either splitted in two buffers or in the before
 694            * last buffer */
 695
 696           vlib_buffer_t *before_last = b[0], *bp = b[0];
 697           while (bp->flags & VLIB_BUFFER_NEXT_PRESENT)
 698             {
 699               before_last = bp;
 700               bp = vlib_get_buffer (vm, bp->next_buffer);
 701             }
 702           u8 *bt = vlib_buffer_get_tail (before_last);
 703
 704           if (pd->lb->current_length == icv_sz)
 705             {
 706               esp_footer_t *f = (esp_footer_t *) (bt - sizeof (*f));
 707               pad_length = f->pad_length;
 708               next_header = f->next_header;
 709             }
 710           else
 711             {
 712               pad_length = (bt - 1)[0];
 713               next_header = ((u8 *) vlib_buffer_get_current (pd->lb))[0];
 714             }
 715         }
 716       else
 717         {
 718           esp_footer_t *f =
 719             (esp_footer_t *) (pd->lb->data + pd->lb->current_data +
 720                               pd->lb->current_length - sizeof (esp_footer_t) -
 721                               icv_sz);
 722           pad_length = f->pad_length;
 723           next_header = f->next_header;
 724         }
 725
 726       u16 adv = pd->iv_sz + esp_sz;
 727       u16 tail = sizeof (esp_footer_t) + pad_length + icv_sz;
 728       u16 tail_orig = sizeof (esp_footer_t) + pad_length + pd->icv_sz;
 729       b[0]->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
 730
 731       if ((pd->flags & tun_flags) == 0 && !is_tun)      /* transport mode */
 732         {
 733           u8 udp_sz = (is_ip6 == 0 && pd->flags & IPSEC_SA_FLAG_UDP_ENCAP) ?
 734             sizeof (udp_header_t) : 0;
 735           u16 ip_hdr_sz = pd->hdr_sz - udp_sz;
 736           u8 *old_ip = b[0]->data + pd->current_data - ip_hdr_sz - udp_sz;
 737           u8 *ip = old_ip + adv + udp_sz;
 738
 739           if (is_ip6 && ip_hdr_sz > 64)
 740             memmove (ip, old_ip, ip_hdr_sz);
 741           else
 742             clib_memcpy_le64 (ip, old_ip, ip_hdr_sz);
 743
 744           b[0]->current_data = pd->current_data + adv - ip_hdr_sz;
 745           b[0]->current_length = pd->current_length + ip_hdr_sz - adv;
 746           esp_remove_tail (vm, b[0], pd->lb, tail);
 747
 748           if (is_ip6)
 749             {
 750               ip6_header_t *ip6 = (ip6_header_t *) ip;
 751               u16 len = clib_net_to_host_u16 (ip6->payload_length);
 752               len -= adv + tail_orig;
 753               ip6->payload_length = clib_host_to_net_u16 (len);
 754               ip6->protocol = next_header;
 755               next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
 756             }
 757           else
 758             {
 759               ip4_header_t *ip4 = (ip4_header_t *) ip;
 760               ip_csum_t sum = ip4->checksum;
 761               u16 len = clib_net_to_host_u16 (ip4->length);
 762               len = clib_host_to_net_u16 (len - adv - tail_orig - udp_sz);
 763               sum = ip_csum_update (sum, ip4->protocol, next_header,
 764                                     ip4_header_t, protocol);
 765               sum = ip_csum_update (sum, ip4->length, len,
 766                                     ip4_header_t, length);
 767               ip4->checksum = ip_csum_fold (sum);
 768               ip4->protocol = next_header;
 769               ip4->length = len;
 770               next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
 771             }
 772         }
 773       else
 774         {
 775           if (PREDICT_TRUE (next_header == IP_PROTOCOL_IP_IN_IP))
 776             {
 777               next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
 778               b[0]->current_data = pd->current_data + adv;
 779               b[0]->current_length = pd->current_length - adv;
 780               esp_remove_tail (vm, b[0], pd->lb, tail);
 781             }
 782           else if (next_header == IP_PROTOCOL_IPV6)
 783             {
 784               next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
 785               b[0]->current_data = pd->current_data + adv;
 786               b[0]->current_length = pd->current_length - adv;
 787               esp_remove_tail (vm, b[0], pd->lb, tail);
 788             }
 789           else
 790             {
 791               if (is_tun && next_header == IP_PROTOCOL_GRE)
 792                 {
 793                   gre_header_t *gre;
 794
 795                   b[0]->current_data = pd->current_data + adv;
 796                   b[0]->current_length = pd->current_length - adv - tail;
 797
 798                   gre = vlib_buffer_get_current (b[0]);
 799
 800                   vlib_buffer_advance (b[0], sizeof (*gre));
 801
 802                   switch (clib_net_to_host_u16 (gre->protocol))
 803                     {
 804                     case GRE_PROTOCOL_teb:
 805                       vnet_update_l2_len (b[0]);
 806                       next[0] = ESP_DECRYPT_NEXT_L2_INPUT;
 807                       break;
 808                     case GRE_PROTOCOL_ip4:
 809                       next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
 810                       break;
 811                     case GRE_PROTOCOL_ip6:
 812                       next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
 813                       break;
 814                     default:
 815                       b[0]->error =
 816                         node->errors[ESP_DECRYPT_ERROR_UNSUP_PAYLOAD];
 817                       next[0] = ESP_DECRYPT_NEXT_DROP;
 818                       break;
 819                     }
 820                 }
 821               else
 822                 {
 823                   next[0] = ESP_DECRYPT_NEXT_DROP;
 824                   b[0]->error = node->errors[ESP_DECRYPT_ERROR_UNSUP_PAYLOAD];
 825                   goto trace;
 826                 }
 827             }
 828           if (is_tun)
 829             {
 830               if (ipsec_sa_is_set_IS_PROTECT (sa0))
 831                 {
 832                   /*
 833                    * There are two encap possibilities
 834                    * 1) the tunnel and ths SA are prodiving encap, i.e. it's
 835                    *   MAC | SA-IP | TUN-IP | ESP | PAYLOAD
 836                    * implying the SA is in tunnel mode (on a tunnel interface)
 837                    * 2) only the tunnel provides encap
 838                    *   MAC | TUN-IP | ESP | PAYLOAD
 839                    * implying the SA is in transport mode.
 840                    *
 841                    * For 2) we need only strip the tunnel encap and we're good.
 842                    *  since the tunnel and crypto ecnap (int the tun=protect
 843                    * object) are the same and we verified above that these match
 844                    * for 1) we need to strip the SA-IP outer headers, to
 845                    * reveal the tunnel IP and then check that this matches
 846                    * the configured tunnel.
 847                    */
 848                   const ipsec_tun_protect_t *itp;
 849
 850                   itp = ipsec_tun_protect_get
 851                     (vnet_buffer (b[0])->ipsec.protect_index);
 852
 853                   if (PREDICT_TRUE (next_header == IP_PROTOCOL_IP_IN_IP))
 854                     {
 855                       const ip4_header_t *ip4;
 856
 857                       ip4 = vlib_buffer_get_current (b[0]);
 858
 859                       if (!ip46_address_is_equal_v4 (&itp->itp_tun.src,
 860                                                      &ip4->dst_address) ||
 861                           !ip46_address_is_equal_v4 (&itp->itp_tun.dst,
 862                                                      &ip4->src_address))
 863                         {
 864                           next[0] = ESP_DECRYPT_NEXT_DROP;
 865                           b[0]->error =
 866                             node->errors[ESP_DECRYPT_ERROR_TUN_NO_PROTO];
 867                         }
 868                     }
 869                   else if (next_header == IP_PROTOCOL_IPV6)
 870                     {
 871                       const ip6_header_t *ip6;
 872
 873                       ip6 = vlib_buffer_get_current (b[0]);
 874
 875                       if (!ip46_address_is_equal_v6 (&itp->itp_tun.src,
 876                                                      &ip6->dst_address) ||
 877                           !ip46_address_is_equal_v6 (&itp->itp_tun.dst,
 878                                                      &ip6->src_address))
 879                         {
 880                           next[0] = ESP_DECRYPT_NEXT_DROP;
 881                           b[0]->error =
 882                             node->errors[ESP_DECRYPT_ERROR_TUN_NO_PROTO];
 883                         }
 884                     }
 885                 }
 886             }
 887         }
 888
 889     trace:
 890       if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
 891         {
 892           esp_decrypt_trace_t *tr;
 893           tr = vlib_add_trace (vm, node, b[0], sizeof (*tr));
 894           sa0 = pool_elt_at_index (im->sad,
 895                                    vnet_buffer (b[0])->ipsec.sad_index);
 896           tr->crypto_alg = sa0->crypto_alg;
 897           tr->integ_alg = sa0->integ_alg;
 898           tr->seq = pd->seq;
 899           tr->sa_seq = sa0->last_seq;
 900           tr->sa_seq_hi = sa0->seq_hi;
 901         }
 902
 903       /* next */
 904       n_left -= 1;
 905       next += 1;
 906       pd += 1;
 907       b += 1;
 908     }
 909
 910   n_left = from_frame->n_vectors;
 911   vlib_node_increment_counter (vm, node->node_index,
 912                                ESP_DECRYPT_ERROR_RX_PKTS, n_left);
 913
 914   vlib_buffer_enqueue_to_next (vm, node, from, nexts, n_left);
 915
 916   return n_left;
 917 }
 918
 919 VLIB_NODE_FN (esp4_decrypt_node) (vlib_main_t * vm,
 920                                   vlib_node_runtime_t * node,
 921                                   vlib_frame_t * from_frame)
 922 {
 923   return esp_decrypt_inline (vm, node, from_frame, 0, 0);
 924 }
 925
 926 VLIB_NODE_FN (esp4_decrypt_tun_node) (vlib_main_t * vm,
 927                                       vlib_node_runtime_t * node,
 928                                       vlib_frame_t * from_frame)
 929 {
 930   return esp_decrypt_inline (vm, node, from_frame, 0, 1);
 931 }
 932
 933 VLIB_NODE_FN (esp6_decrypt_node) (vlib_main_t * vm,
 934                                   vlib_node_runtime_t * node,
 935                                   vlib_frame_t * from_frame)
 936 {
 937   return esp_decrypt_inline (vm, node, from_frame, 1, 0);
 938 }
 939
 940 VLIB_NODE_FN (esp6_decrypt_tun_node) (vlib_main_t * vm,
 941                                       vlib_node_runtime_t * node,
 942                                       vlib_frame_t * from_frame)
 943 {
 944   return esp_decrypt_inline (vm, node, from_frame, 1, 1);
 945 }
 946
 947 /* *INDENT-OFF* */
 948 VLIB_REGISTER_NODE (esp4_decrypt_node) = {
 949   .name = "esp4-decrypt",
 950   .vector_size = sizeof (u32),
 951   .format_trace = format_esp_decrypt_trace,
 952   .type = VLIB_NODE_TYPE_INTERNAL,
 953
 954   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
 955   .error_strings = esp_decrypt_error_strings,
 956
 957   .n_next_nodes = ESP_DECRYPT_N_NEXT,
 958   .next_nodes = {
 959     [ESP_DECRYPT_NEXT_DROP] = "ip4-drop",
 960     [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
 961     [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
 962     [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
 963     [ESP_DECRYPT_NEXT_HANDOFF] = "esp4-decrypt-handoff",
 964   },
 965 };
 966
 967 VLIB_REGISTER_NODE (esp6_decrypt_node) = {
 968   .name = "esp6-decrypt",
 969   .vector_size = sizeof (u32),
 970   .format_trace = format_esp_decrypt_trace,
 971   .type = VLIB_NODE_TYPE_INTERNAL,
 972
 973   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
 974   .error_strings = esp_decrypt_error_strings,
 975
 976   .n_next_nodes = ESP_DECRYPT_N_NEXT,
 977   .next_nodes = {
 978     [ESP_DECRYPT_NEXT_DROP] = "ip6-drop",
 979     [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
 980     [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
 981     [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
 982     [ESP_DECRYPT_NEXT_HANDOFF]=  "esp6-decrypt-handoff",
 983   },
 984 };
 985
 986 VLIB_REGISTER_NODE (esp4_decrypt_tun_node) = {
 987   .name = "esp4-decrypt-tun",
 988   .vector_size = sizeof (u32),
 989   .format_trace = format_esp_decrypt_trace,
 990   .type = VLIB_NODE_TYPE_INTERNAL,
 991   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
 992   .error_strings = esp_decrypt_error_strings,
 993   .n_next_nodes = ESP_DECRYPT_N_NEXT,
 994   .next_nodes = {
 995     [ESP_DECRYPT_NEXT_DROP] = "ip4-drop",
 996     [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
 997     [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
 998     [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
 999     [ESP_DECRYPT_NEXT_HANDOFF] = "esp4-decrypt-tun-handoff",
1000   },
1001 };
1002
1003 VLIB_REGISTER_NODE (esp6_decrypt_tun_node) = {
1004   .name = "esp6-decrypt-tun",
1005   .vector_size = sizeof (u32),
1006   .format_trace = format_esp_decrypt_trace,
1007   .type = VLIB_NODE_TYPE_INTERNAL,
1008   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
1009   .error_strings = esp_decrypt_error_strings,
1010   .n_next_nodes = ESP_DECRYPT_N_NEXT,
1011   .next_nodes = {
1012     [ESP_DECRYPT_NEXT_DROP] = "ip6-drop",
1013     [ESP_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
1014     [ESP_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
1015     [ESP_DECRYPT_NEXT_L2_INPUT] = "l2-input",
1016     [ESP_DECRYPT_NEXT_HANDOFF]=  "esp6-decrypt-tun-handoff",
1017   },
1018 };
1019 /* *INDENT-ON* */
1020
1021 /*
1022  * fd.io coding-style-patch-verification: ON
1023  *
1024  * Local Variables:
1025  * eval: (c-set-style "gnu")
1026  * End:
1027  */