src/plugins/dpdk/ipsec/esp_decrypt.c

   1 /*
   2  * esp_decrypt.c : IPSec ESP Decrypt node using DPDK Cryptodev
   3  *
   4  * Copyright (c) 2016 Intel 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
  22 #include <vnet/ipsec/ipsec.h>
  23 #include <dpdk/ipsec/ipsec.h>
  24 #include <dpdk/ipsec/esp.h>
  25 #include <dpdk/device/dpdk.h>
  26 #include <dpdk/device/dpdk_priv.h>
  27
  28 #define foreach_esp_decrypt_next               \
  29 _(DROP, "error-drop")                          \
  30 _(IP4_INPUT, "ip4-input")                      \
  31 _(IP6_INPUT, "ip6-input")
  32
  33 #define _(v, s) ESP_DECRYPT_NEXT_##v,
  34 typedef enum {
  35   foreach_esp_decrypt_next
  36 #undef _
  37   ESP_DECRYPT_N_NEXT,
  38 } esp_decrypt_next_t;
  39
  40 #define foreach_esp_decrypt_error                \
  41  _(RX_PKTS, "ESP pkts received")                 \
  42  _(DECRYPTION_FAILED, "ESP decryption failed")   \
  43  _(REPLAY, "SA replayed packet")                 \
  44  _(NOT_IP, "Not IP packet (dropped)")            \
  45  _(ENQ_FAIL, "Enqueue failed (buffer full)")     \
  46  _(NO_CRYPTODEV, "Cryptodev not configured")     \
  47  _(BAD_LEN, "Invalid ciphertext length")
  48
  49
  50 typedef enum {
  51 #define _(sym,str) ESP_DECRYPT_ERROR_##sym,
  52   foreach_esp_decrypt_error
  53 #undef _
  54   ESP_DECRYPT_N_ERROR,
  55 } esp_decrypt_error_t;
  56
  57 static char * esp_decrypt_error_strings[] = {
  58 #define _(sym,string) string,
  59   foreach_esp_decrypt_error
  60 #undef _
  61 };
  62
  63 vlib_node_registration_t dpdk_esp_decrypt_node;
  64
  65 typedef struct {
  66   ipsec_crypto_alg_t crypto_alg;
  67   ipsec_integ_alg_t integ_alg;
  68 } esp_decrypt_trace_t;
  69
  70 /* packet trace format function */
  71 static u8 * format_esp_decrypt_trace (u8 * s, va_list * args)
  72 {
  73   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  74   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  75   esp_decrypt_trace_t * t = va_arg (*args, esp_decrypt_trace_t *);
  76
  77   s = format (s, "esp: crypto %U integrity %U",
  78               format_ipsec_crypto_alg, t->crypto_alg,
  79               format_ipsec_integ_alg, t->integ_alg);
  80   return s;
  81 }
  82
  83 static uword
  84 dpdk_esp_decrypt_node_fn (vlib_main_t * vm,
  85              vlib_node_runtime_t * node,
  86              vlib_frame_t * from_frame)
  87 {
  88   u32 n_left_from, *from, *to_next, next_index;
  89   ipsec_main_t *im = &ipsec_main;
  90   u32 thread_index = vlib_get_thread_index();
  91   dpdk_crypto_main_t * dcm = &dpdk_crypto_main;
  92   dpdk_esp_main_t * em = &dpdk_esp_main;
  93   u32 i;
  94
  95   from = vlib_frame_vector_args (from_frame);
  96   n_left_from = from_frame->n_vectors;
  97
  98   crypto_worker_main_t *cwm =
  99     vec_elt_at_index(dcm->workers_main, thread_index);
 100   u32 n_qps = vec_len(cwm->qp_data);
 101   struct rte_crypto_op ** cops_to_enq[n_qps];
 102   u32 n_cop_qp[n_qps], * bi_to_enq[n_qps];
 103
 104   for (i = 0; i < n_qps; i++)
 105     {
 106       bi_to_enq[i] = cwm->qp_data[i].bi;
 107       cops_to_enq[i] = cwm->qp_data[i].cops;
 108     }
 109
 110   memset(n_cop_qp, 0, n_qps * sizeof(u32));
 111
 112   crypto_alloc_cops();
 113
 114   next_index = ESP_DECRYPT_NEXT_DROP;
 115
 116   while (n_left_from > 0)
 117     {
 118       u32 n_left_to_next;
 119
 120       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 121
 122       while (n_left_from > 0 && n_left_to_next > 0)
 123         {
 124           u32 bi0, sa_index0 = ~0, seq, trunc_size, iv_size;
 125           vlib_buffer_t * b0;
 126           esp_header_t * esp0;
 127           ipsec_sa_t * sa0;
 128           struct rte_mbuf * mb0 = 0;
 129           const int BLOCK_SIZE = 16;
 130           crypto_sa_session_t * sa_sess;
 131           void * sess;
 132           u16 qp_index;
 133           struct rte_crypto_op * cop = 0;
 134
 135           bi0 = from[0];
 136           from += 1;
 137           n_left_from -= 1;
 138
 139           b0 = vlib_get_buffer (vm, bi0);
 140           esp0 = vlib_buffer_get_current (b0);
 141
 142           sa_index0 = vnet_buffer(b0)->ipsec.sad_index;
 143           sa0 = pool_elt_at_index (im->sad, sa_index0);
 144
 145           seq = clib_host_to_net_u32(esp0->seq);
 146
 147           /* anti-replay check */
 148           if (sa0->use_anti_replay)
 149             {
 150               int rv = 0;
 151
 152               if (PREDICT_TRUE(sa0->use_esn))
 153                 rv = esp_replay_check_esn(sa0, seq);
 154               else
 155                 rv = esp_replay_check(sa0, seq);
 156
 157               if (PREDICT_FALSE(rv))
 158                 {
 159                   clib_warning ("anti-replay SPI %u seq %u", sa0->spi, seq);
 160                   vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
 161                                                ESP_DECRYPT_ERROR_REPLAY, 1);
 162                   to_next[0] = bi0;
 163                   to_next += 1;
 164                   n_left_to_next -= 1;
 165                   goto trace;
 166                 }
 167             }
 168
 169           sa0->total_data_size += b0->current_length;
 170
 171           sa_sess = pool_elt_at_index(cwm->sa_sess_d[0], sa_index0);
 172
 173           if (PREDICT_FALSE(!sa_sess->sess))
 174             {
 175               int ret = create_sym_sess(sa0, sa_sess, 0);
 176
 177               if (PREDICT_FALSE (ret))
 178                 {
 179                   to_next[0] = bi0;
 180                   to_next += 1;
 181                   n_left_to_next -= 1;
 182                   goto trace;
 183                 }
 184             }
 185
 186           sess = sa_sess->sess;
 187           qp_index = sa_sess->qp_index;
 188
 189           ASSERT (vec_len (vec_elt (cwm->qp_data, qp_index).free_cops) > 0);
 190           cop = vec_pop (vec_elt (cwm->qp_data, qp_index).free_cops);
 191           ASSERT (cop->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED);
 192
 193           cops_to_enq[qp_index][0] = cop;
 194           cops_to_enq[qp_index] += 1;
 195           n_cop_qp[qp_index] += 1;
 196           bi_to_enq[qp_index][0] = bi0;
 197           bi_to_enq[qp_index] += 1;
 198
 199           rte_crypto_op_attach_sym_session(cop, sess);
 200
 201           if (sa0->crypto_alg == IPSEC_CRYPTO_ALG_AES_GCM_128)
 202             trunc_size = 16;
 203           else
 204             trunc_size = em->esp_integ_algs[sa0->integ_alg].trunc_size;
 205           iv_size = em->esp_crypto_algs[sa0->crypto_alg].iv_len;
 206
 207           /* Convert vlib buffer to mbuf */
 208           mb0 = rte_mbuf_from_vlib_buffer(b0);
 209           mb0->data_len = b0->current_length;
 210           mb0->pkt_len = b0->current_length;
 211           mb0->data_off = RTE_PKTMBUF_HEADROOM + b0->current_data;
 212
 213           /* Outer IP header has already been stripped */
 214           u16 payload_len = rte_pktmbuf_pkt_len(mb0) - sizeof (esp_header_t) -
 215               iv_size - trunc_size;
 216
 217           if ((payload_len & (BLOCK_SIZE - 1)) || (payload_len <= 0))
 218             {
 219               clib_warning ("payload %u not multiple of %d\n",
 220                             payload_len, BLOCK_SIZE);
 221               vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
 222                                            ESP_DECRYPT_ERROR_BAD_LEN, 1);
 223               vec_add (vec_elt (cwm->qp_data, qp_index).free_cops, &cop, 1);
 224               bi_to_enq[qp_index] -= 1;
 225               cops_to_enq[qp_index] -= 1;
 226               n_cop_qp[qp_index] -= 1;
 227               to_next[0] = bi0;
 228               to_next += 1;
 229               n_left_to_next -= 1;
 230               goto trace;
 231             }
 232
 233           struct rte_crypto_sym_op *sym_cop = (struct rte_crypto_sym_op *)(cop + 1);
 234
 235           u8 is_aead = sa0->crypto_alg == IPSEC_CRYPTO_ALG_AES_GCM_128;
 236           u32 cipher_off, cipher_len;
 237           u32 auth_off = 0, auth_len = 0, aad_size = 0;
 238           u8 *aad = NULL, *digest = NULL;
 239           u64 digest_paddr = 0;
 240
 241           u8 *iv = rte_pktmbuf_mtod_offset(mb0, void*, sizeof (esp_header_t));
 242           dpdk_cop_priv_t *priv = (dpdk_cop_priv_t *)(sym_cop + 1);
 243           dpdk_gcm_cnt_blk *icb = &priv->cb;
 244
 245           cipher_off = sizeof (esp_header_t) + iv_size;
 246           cipher_len = payload_len;
 247
 248           digest =
 249             vlib_buffer_get_current (b0) + sizeof(esp_header_t) +
 250             iv_size + payload_len;
 251
 252           if (is_aead)
 253             {
 254               u32 *_iv = (u32 *) iv;
 255
 256               crypto_set_icb (icb, sa0->salt, _iv[0], _iv[1]);
 257               iv_size = 16;
 258
 259               aad = priv->aad;
 260               clib_memcpy(aad, esp0, 8);
 261               aad_size = 8;
 262               if (sa0->use_esn)
 263                 {
 264                   *((u32*)&aad[8]) = sa0->seq_hi;
 265                   aad_size = 12;
 266                 }
 267             }
 268           else
 269             {
 270               clib_memcpy(icb, iv, 16);
 271
 272               auth_off = 0;
 273               auth_len = sizeof(esp_header_t) + iv_size + payload_len;
 274
 275               if (sa0->use_esn)
 276                 {
 277                   dpdk_cop_priv_t* priv = (dpdk_cop_priv_t*) (sym_cop + 1);
 278
 279                   clib_memcpy (priv->icv, digest, trunc_size);
 280                   *((u32*) digest) = sa0->seq_hi;
 281                   auth_len += sizeof(sa0->seq_hi);
 282
 283                   digest = priv->icv;
 284                   digest_paddr =
 285                     cop->phys_addr + (uintptr_t) priv->icv - (uintptr_t) cop;
 286                 }
 287             }
 288
 289           crypto_op_setup (is_aead, mb0, cop, sess,
 290                            cipher_off, cipher_len, (u8 *) icb, iv_size,
 291                            auth_off, auth_len, aad, aad_size,
 292                            digest, digest_paddr, trunc_size);
 293 trace:
 294           if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED))
 295             {
 296               esp_decrypt_trace_t *tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
 297               tr->crypto_alg = sa0->crypto_alg;
 298               tr->integ_alg = sa0->integ_alg;
 299             }
 300         }
 301       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 302     }
 303   vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
 304                                ESP_DECRYPT_ERROR_RX_PKTS,
 305                                from_frame->n_vectors);
 306   crypto_qp_data_t *qpd;
 307   /* *INDENT-OFF* */
 308   vec_foreach_index (i, cwm->qp_data)
 309     {
 310       u32 enq;
 311
 312       if (!n_cop_qp[i])
 313         continue;
 314
 315       qpd = vec_elt_at_index(cwm->qp_data, i);
 316       enq = rte_cryptodev_enqueue_burst(qpd->dev_id, qpd->qp_id,
 317                                         qpd->cops, n_cop_qp[i]);
 318       qpd->inflights += enq;
 319
 320       if (PREDICT_FALSE(enq < n_cop_qp[i]))
 321         {
 322           crypto_free_cop (qpd, &qpd->cops[enq], n_cop_qp[i] - enq);
 323           vlib_buffer_free (vm, &qpd->bi[enq], n_cop_qp[i] - enq);
 324
 325           vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
 326                                        ESP_DECRYPT_ERROR_ENQ_FAIL,
 327                                        n_cop_qp[i] - enq);
 328         }
 329     }
 330   /* *INDENT-ON* */
 331
 332   return from_frame->n_vectors;
 333 }
 334
 335 /* *INDENT-OFF* */
 336 VLIB_REGISTER_NODE (dpdk_esp_decrypt_node) = {
 337   .function = dpdk_esp_decrypt_node_fn,
 338   .name = "dpdk-esp-decrypt",
 339   .vector_size = sizeof (u32),
 340   .format_trace = format_esp_decrypt_trace,
 341   .type = VLIB_NODE_TYPE_INTERNAL,
 342
 343   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
 344   .error_strings = esp_decrypt_error_strings,
 345
 346   .n_next_nodes = ESP_DECRYPT_N_NEXT,
 347   .next_nodes = {
 348 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
 349     foreach_esp_decrypt_next
 350 #undef _
 351   },
 352 };
 353 /* *INDENT-ON* */
 354
 355 VLIB_NODE_FUNCTION_MULTIARCH (dpdk_esp_decrypt_node, dpdk_esp_decrypt_node_fn)
 356
 357 /*
 358  * Decrypt Post Node
 359  */
 360
 361 #define foreach_esp_decrypt_post_error        \
 362  _(PKTS, "ESP post pkts")
 363
 364 typedef enum {
 365 #define _(sym,str) ESP_DECRYPT_POST_ERROR_##sym,
 366   foreach_esp_decrypt_post_error
 367 #undef _
 368   ESP_DECRYPT_POST_N_ERROR,
 369 } esp_decrypt_post_error_t;
 370
 371 static char * esp_decrypt_post_error_strings[] = {
 372 #define _(sym,string) string,
 373   foreach_esp_decrypt_post_error
 374 #undef _
 375 };
 376
 377 vlib_node_registration_t dpdk_esp_decrypt_post_node;
 378
 379 static u8 * format_esp_decrypt_post_trace (u8 * s, va_list * args)
 380 {
 381   return s;
 382 }
 383
 384 static uword
 385 dpdk_esp_decrypt_post_node_fn (vlib_main_t * vm,
 386              vlib_node_runtime_t * node,
 387              vlib_frame_t * from_frame)
 388 {
 389   u32 n_left_from, *from, *to_next = 0, next_index;
 390   ipsec_sa_t * sa0;
 391   u32 sa_index0 = ~0;
 392   ipsec_main_t *im = &ipsec_main;
 393   dpdk_esp_main_t *em = &dpdk_esp_main;
 394
 395   from = vlib_frame_vector_args (from_frame);
 396   n_left_from = from_frame->n_vectors;
 397
 398   next_index = node->cached_next_index;
 399
 400   while (n_left_from > 0)
 401     {
 402       u32 n_left_to_next;
 403
 404       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 405
 406       while (n_left_from > 0 && n_left_to_next > 0)
 407         {
 408           esp_footer_t * f0;
 409           u32 bi0, next0, trunc_size, iv_size;
 410           vlib_buffer_t * b0 = 0;
 411           ip4_header_t *ih4 = 0, *oh4 = 0;
 412           ip6_header_t *ih6 = 0, *oh6 = 0;
 413           u8 tunnel_mode = 1;
 414           u8 transport_ip6 = 0;
 415
 416           next0 = ESP_DECRYPT_NEXT_DROP;
 417
 418           bi0 = from[0];
 419           from += 1;
 420           n_left_from -= 1;
 421           n_left_to_next -= 1;
 422
 423           b0 = vlib_get_buffer (vm, bi0);
 424
 425           sa_index0 = vnet_buffer(b0)->ipsec.sad_index;
 426           sa0 = pool_elt_at_index (im->sad, sa_index0);
 427
 428           to_next[0] = bi0;
 429           to_next += 1;
 430
 431           if (sa0->crypto_alg == IPSEC_CRYPTO_ALG_AES_GCM_128)
 432             trunc_size = 16;
 433           else
 434             trunc_size = em->esp_integ_algs[sa0->integ_alg].trunc_size;
 435           iv_size = em->esp_crypto_algs[sa0->crypto_alg].iv_len;
 436
 437           if (sa0->use_anti_replay)
 438             {
 439               esp_header_t * esp0 = vlib_buffer_get_current (b0);
 440               u32 seq;
 441               seq = clib_host_to_net_u32(esp0->seq);
 442               if (PREDICT_TRUE(sa0->use_esn))
 443                 esp_replay_advance_esn(sa0, seq);
 444               else
 445                 esp_replay_advance(sa0, seq);
 446             }
 447
 448           ih4 = (ip4_header_t *) (b0->data + sizeof(ethernet_header_t));
 449           vlib_buffer_advance (b0, sizeof (esp_header_t) + iv_size);
 450
 451           b0->current_length -= (trunc_size + 2);
 452           b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
 453           f0 = (esp_footer_t *) ((u8 *) vlib_buffer_get_current (b0) +
 454                                  b0->current_length);
 455           b0->current_length -= f0->pad_length;
 456
 457           /* transport mode */
 458           if (PREDICT_FALSE(!sa0->is_tunnel && !sa0->is_tunnel_ip6))
 459             {
 460               tunnel_mode = 0;
 461
 462               if (PREDICT_TRUE((ih4->ip_version_and_header_length & 0xF0) != 0x40))
 463                 {
 464                   if (PREDICT_TRUE((ih4->ip_version_and_header_length & 0xF0) == 0x60))
 465                     transport_ip6 = 1;
 466                   else
 467                     {
 468                       clib_warning("next header: 0x%x", f0->next_header);
 469                       vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
 470                                                    ESP_DECRYPT_ERROR_NOT_IP, 1);
 471                       goto trace;
 472                     }
 473                 }
 474             }
 475
 476           if (PREDICT_TRUE (tunnel_mode))
 477             {
 478               if (PREDICT_TRUE(f0->next_header == IP_PROTOCOL_IP_IN_IP))
 479                 next0 = ESP_DECRYPT_NEXT_IP4_INPUT;
 480               else if (f0->next_header == IP_PROTOCOL_IPV6)
 481                 next0 = ESP_DECRYPT_NEXT_IP6_INPUT;
 482               else
 483                 {
 484                   clib_warning("next header: 0x%x", f0->next_header);
 485                   vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
 486                                                ESP_DECRYPT_ERROR_DECRYPTION_FAILED,
 487                                                1);
 488                   goto trace;
 489                 }
 490             }
 491           /* transport mode */
 492           else
 493             {
 494               if (PREDICT_FALSE(transport_ip6))
 495                 {
 496                   ih6 = (ip6_header_t *) (b0->data + sizeof(ethernet_header_t));
 497                   vlib_buffer_advance (b0, -sizeof(ip6_header_t));
 498                   oh6 = vlib_buffer_get_current (b0);
 499                   memmove(oh6, ih6, sizeof(ip6_header_t));
 500
 501                   next0 = ESP_DECRYPT_NEXT_IP6_INPUT;
 502                   oh6->protocol = f0->next_header;
 503                   oh6->payload_length =
 504                       clib_host_to_net_u16 (
 505                           vlib_buffer_length_in_chain(vm, b0) -
 506                           sizeof (ip6_header_t));
 507                 }
 508               else
 509                 {
 510                   vlib_buffer_advance (b0, -sizeof(ip4_header_t));
 511                   oh4 = vlib_buffer_get_current (b0);
 512                   memmove(oh4, ih4, sizeof(ip4_header_t));
 513
 514                   next0 = ESP_DECRYPT_NEXT_IP4_INPUT;
 515                   oh4->ip_version_and_header_length = 0x45;
 516                   oh4->fragment_id = 0;
 517                   oh4->flags_and_fragment_offset = 0;
 518                   oh4->protocol = f0->next_header;
 519                   oh4->length = clib_host_to_net_u16 (
 520                       vlib_buffer_length_in_chain (vm, b0));
 521                   oh4->checksum = ip4_header_checksum (oh4);
 522                 }
 523             }
 524
 525           vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32)~0;
 526
 527 trace:
 528           if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED))
 529             {
 530               esp_decrypt_trace_t *tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
 531               tr->crypto_alg = sa0->crypto_alg;
 532               tr->integ_alg = sa0->integ_alg;
 533             }
 534
 535           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 536                                            to_next, n_left_to_next, bi0, next0);
 537         }
 538       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 539     }
 540   vlib_node_increment_counter (vm, dpdk_esp_decrypt_post_node.index,
 541                                ESP_DECRYPT_POST_ERROR_PKTS,
 542                                from_frame->n_vectors);
 543
 544   return from_frame->n_vectors;
 545 }
 546
 547 /* *INDENT-OFF* */
 548 VLIB_REGISTER_NODE (dpdk_esp_decrypt_post_node) = {
 549   .function = dpdk_esp_decrypt_post_node_fn,
 550   .name = "dpdk-esp-decrypt-post",
 551   .vector_size = sizeof (u32),
 552   .format_trace = format_esp_decrypt_post_trace,
 553   .type = VLIB_NODE_TYPE_INTERNAL,
 554
 555   .n_errors = ARRAY_LEN(esp_decrypt_post_error_strings),
 556   .error_strings = esp_decrypt_post_error_strings,
 557
 558   .n_next_nodes = ESP_DECRYPT_N_NEXT,
 559   .next_nodes = {
 560 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
 561     foreach_esp_decrypt_next
 562 #undef _
 563   },
 564 };
 565 /* *INDENT-ON* */
 566
 567 VLIB_NODE_FUNCTION_MULTIARCH (dpdk_esp_decrypt_post_node, dpdk_esp_decrypt_post_node_fn)