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
  22 #include <vnet/ipsec/ipsec.h>
  23 #include <vnet/ipsec/esp.h>
  24 #include <vnet/ipsec/ipsec_io.h>
  25
  26 #define foreach_esp_decrypt_next                \
  27 _(DROP, "error-drop")                           \
  28 _(IP4_INPUT, "ip4-input-no-checksum")           \
  29 _(IP6_INPUT, "ip6-input")                       \
  30 _(IPSEC_GRE_INPUT, "ipsec-gre-input")
  31
  32 #define _(v, s) ESP_DECRYPT_NEXT_##v,
  33 typedef enum
  34 {
  35   foreach_esp_decrypt_next
  36 #undef _
  37     ESP_DECRYPT_N_NEXT,
  38 } esp_decrypt_next_t;
  39
  40
  41 #define foreach_esp_decrypt_error                               \
  42  _(RX_PKTS, "ESP pkts received")                                \
  43  _(DECRYPTION_FAILED, "ESP decryption failed")                  \
  44  _(INTEG_ERROR, "Integrity check failed")                       \
  45  _(CRYPTO_ENGINE_ERROR, "crypto engine error (packet dropped)") \
  46  _(REPLAY, "SA replayed packet")                                \
  47  _(CHAINED_BUFFER, "chained buffers (packet dropped)")          \
  48  _(OVERSIZED_HEADER, "buffer with oversized header (dropped)")  \
  49  _(NO_TAIL_SPACE, "no enough buffer tail space (dropped)")
  50
  51
  52 typedef enum
  53 {
  54 #define _(sym,str) ESP_DECRYPT_ERROR_##sym,
  55   foreach_esp_decrypt_error
  56 #undef _
  57     ESP_DECRYPT_N_ERROR,
  58 } esp_decrypt_error_t;
  59
  60 static char *esp_decrypt_error_strings[] = {
  61 #define _(sym,string) string,
  62   foreach_esp_decrypt_error
  63 #undef _
  64 };
  65
  66 typedef struct
  67 {
  68   u32 seq;
  69   ipsec_crypto_alg_t crypto_alg;
  70   ipsec_integ_alg_t integ_alg;
  71 } esp_decrypt_trace_t;
  72
  73 /* packet trace format function */
  74 static u8 *
  75 format_esp_decrypt_trace (u8 * s, va_list * args)
  76 {
  77   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  78   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  79   esp_decrypt_trace_t *t = va_arg (*args, esp_decrypt_trace_t *);
  80
  81   s = format (s, "esp: crypto %U integrity %U seq %u",
  82               format_ipsec_crypto_alg, t->crypto_alg,
  83               format_ipsec_integ_alg, t->integ_alg, t->seq);
  84   return s;
  85 }
  86
  87 typedef struct
  88 {
  89   union
  90   {
  91     struct
  92     {
  93       u8 icv_sz;
  94       u8 iv_sz;
  95       ipsec_sa_flags_t flags:8;
  96       u32 sa_index;
  97     };
  98     u64 sa_data;
  99   };
 100
 101   i16 current_data;
 102   i16 current_length;
 103   u16 hdr_sz;
 104 } esp_decrypt_packet_data_t;
 105
 106 STATIC_ASSERT_SIZEOF (esp_decrypt_packet_data_t, 2 * sizeof (u64));
 107
 108 #define ESP_ENCRYPT_PD_F_FD_TRANSPORT (1 << 2)
 109
 110 always_inline uword
 111 esp_decrypt_inline (vlib_main_t * vm,
 112                     vlib_node_runtime_t * node, vlib_frame_t * from_frame,
 113                     int is_ip6)
 114 {
 115   ipsec_main_t *im = &ipsec_main;
 116   u32 thread_index = vm->thread_index;
 117   u16 buffer_data_size = vlib_buffer_get_default_data_size (vm);
 118   u16 len;
 119   ipsec_per_thread_data_t *ptd = vec_elt_at_index (im->ptd, thread_index);
 120   u32 *from = vlib_frame_vector_args (from_frame);
 121   u32 n, n_left = from_frame->n_vectors;
 122   vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
 123   u16 nexts[VLIB_FRAME_SIZE], *next = nexts;
 124   esp_decrypt_packet_data_t pkt_data[VLIB_FRAME_SIZE], *pd = pkt_data;
 125   esp_decrypt_packet_data_t cpd = { };
 126   u32 current_sa_index = ~0, current_sa_bytes = 0, current_sa_pkts = 0;
 127   const u8 esp_sz = sizeof (esp_header_t);
 128   ipsec_sa_t *sa0 = 0;
 129
 130   vlib_get_buffers (vm, from, b, n_left);
 131   vec_reset_length (ptd->crypto_ops);
 132   vec_reset_length (ptd->integ_ops);
 133   clib_memset_u16 (nexts, -1, n_left);
 134
 135   while (n_left > 0)
 136     {
 137       u8 *payload;
 138
 139       if (n_left > 2)
 140         {
 141           u8 *p;
 142           vlib_prefetch_buffer_header (b[2], LOAD);
 143           p = vlib_buffer_get_current (b[1]);
 144           CLIB_PREFETCH (p, CLIB_CACHE_LINE_BYTES, LOAD);
 145           p -= CLIB_CACHE_LINE_BYTES;
 146           CLIB_PREFETCH (p, CLIB_CACHE_LINE_BYTES, LOAD);
 147         }
 148
 149       if (vlib_buffer_chain_linearize (vm, b[0]) != 1)
 150         {
 151           b[0]->error = node->errors[ESP_DECRYPT_ERROR_CHAINED_BUFFER];
 152           next[0] = ESP_DECRYPT_NEXT_DROP;
 153           goto next;
 154         }
 155
 156       if (vnet_buffer (b[0])->ipsec.sad_index != current_sa_index)
 157         {
 158           current_sa_index = vnet_buffer (b[0])->ipsec.sad_index;
 159           sa0 = pool_elt_at_index (im->sad, current_sa_index);
 160           cpd.icv_sz = sa0->integ_icv_size;
 161           cpd.iv_sz = sa0->crypto_iv_size;
 162           cpd.flags = sa0->flags;
 163           cpd.sa_index = current_sa_index;
 164
 165           vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
 166                                            current_sa_index, current_sa_pkts,
 167                                            current_sa_bytes);
 168
 169           current_sa_bytes = current_sa_pkts = 0;
 170         }
 171
 172       /* store packet data for next round for easier prefetch */
 173       pd->sa_data = cpd.sa_data;
 174       pd->current_data = b[0]->current_data;
 175       pd->current_length = b[0]->current_length;
 176       pd->hdr_sz = pd->current_data - vnet_buffer (b[0])->l3_hdr_offset;
 177       payload = b[0]->data + pd->current_data;
 178
 179       /* we need 4 extra bytes for HMAC calculation when ESN are used */
 180       if (ipsec_sa_is_set_USE_ESN (sa0) && pd->icv_sz &&
 181           (pd->current_data + pd->current_length + 4 > buffer_data_size))
 182         {
 183           b[0]->error = node->errors[ESP_DECRYPT_ERROR_NO_TAIL_SPACE];
 184           next[0] = ESP_DECRYPT_NEXT_DROP;
 185           goto next;
 186         }
 187
 188       /* anti-reply check */
 189       if (ipsec_sa_anti_replay_check (sa0, &((esp_header_t *) payload)->seq))
 190         {
 191           b[0]->error = node->errors[ESP_DECRYPT_ERROR_REPLAY];
 192           next[0] = ESP_DECRYPT_NEXT_DROP;
 193           goto next;
 194         }
 195
 196       len = pd->current_length - cpd.icv_sz;
 197       current_sa_pkts += 1;
 198       current_sa_bytes += pd->current_length;
 199
 200       if (PREDICT_TRUE (sa0->integ_op_id != VNET_CRYPTO_OP_NONE))
 201         {
 202           vnet_crypto_op_t *op;
 203           vec_add2_aligned (ptd->integ_ops, op, 1, CLIB_CACHE_LINE_BYTES);
 204
 205           vnet_crypto_op_init (op, sa0->integ_op_id);
 206           op->key = sa0->integ_key.data;
 207           op->key_len = sa0->integ_key.len;
 208           op->src = payload;
 209           op->flags = VNET_CRYPTO_OP_FLAG_HMAC_CHECK;
 210           op->user_data = b - bufs;
 211           op->digest = payload + len;
 212           op->digest_len = cpd.icv_sz;
 213           op->len = len;
 214           if (ipsec_sa_is_set_USE_ESN (sa0))
 215             {
 216               /* shift ICV for 4 bytes to insert ESN */
 217               u8 tmp[ESP_MAX_ICV_SIZE], sz = sizeof (sa0->seq_hi);
 218               clib_memcpy_fast (tmp, payload + len, ESP_MAX_ICV_SIZE);
 219               clib_memcpy_fast (payload + len, &sa0->seq_hi, sz);
 220               clib_memcpy_fast (payload + len + sz, tmp, ESP_MAX_ICV_SIZE);
 221               op->len += sz;
 222               op->digest += sz;
 223             }
 224         }
 225
 226       payload += esp_sz;
 227       len -= esp_sz;
 228
 229       if (sa0->crypto_enc_op_id != VNET_CRYPTO_OP_NONE)
 230         {
 231           vnet_crypto_op_t *op;
 232           vec_add2_aligned (ptd->crypto_ops, op, 1, CLIB_CACHE_LINE_BYTES);
 233           vnet_crypto_op_init (op, sa0->crypto_dec_op_id);
 234           op->key = sa0->crypto_key.data;
 235           op->iv = payload;
 236
 237           if (ipsec_sa_is_set_IS_AEAD (sa0))
 238             {
 239               esp_header_t *esp0;
 240               esp_aead_t *aad;
 241               u8 *scratch;
 242
 243               /*
 244                * construct the AAD and the nonce (Salt || IV) in a scratch
 245                * space in front of the IP header.
 246                */
 247               scratch = payload - esp_sz;
 248               esp0 = (esp_header_t *) (scratch);
 249
 250               scratch -= (sizeof (*aad) + pd->hdr_sz);
 251               op->aad = scratch;
 252
 253               esp_aad_fill (op, esp0, sa0);
 254
 255               /*
 256                * we don't need to refer to the ESP header anymore so we
 257                * can overwrite it with the salt and use the IV where it is
 258                * to form the nonce = (Salt + IV)
 259                */
 260               op->iv -= sizeof (sa0->salt);
 261               clib_memcpy_fast (op->iv, &sa0->salt, sizeof (sa0->salt));
 262               op->iv_len = cpd.iv_sz + sizeof (sa0->salt);
 263
 264               op->tag = payload + len;
 265               op->tag_len = 16;
 266             }
 267           op->src = op->dst = payload += cpd.iv_sz;
 268           op->len = len - cpd.iv_sz;
 269           op->user_data = b - bufs;
 270         }
 271
 272       /* next */
 273     next:
 274       n_left -= 1;
 275       next += 1;
 276       pd += 1;
 277       b += 1;
 278     }
 279
 280   vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
 281                                    current_sa_index, current_sa_pkts,
 282                                    current_sa_bytes);
 283
 284   if ((n = vec_len (ptd->integ_ops)))
 285     {
 286       vnet_crypto_op_t *op = ptd->integ_ops;
 287       n -= vnet_crypto_process_ops (vm, op, n);
 288       while (n)
 289         {
 290           ASSERT (op - ptd->integ_ops < vec_len (ptd->integ_ops));
 291           if (op->status != VNET_CRYPTO_OP_STATUS_COMPLETED)
 292             {
 293               u32 err, bi = op->user_data;
 294               if (op->status == VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC)
 295                 err = ESP_DECRYPT_ERROR_INTEG_ERROR;
 296               else
 297                 err = ESP_DECRYPT_ERROR_CRYPTO_ENGINE_ERROR;
 298               bufs[bi]->error = node->errors[err];
 299               nexts[bi] = ESP_DECRYPT_NEXT_DROP;
 300               n--;
 301             }
 302           op++;
 303         }
 304     }
 305   if ((n = vec_len (ptd->crypto_ops)))
 306     {
 307       vnet_crypto_op_t *op = ptd->crypto_ops;
 308       n -= vnet_crypto_process_ops (vm, op, n);
 309       while (n)
 310         {
 311           ASSERT (op - ptd->crypto_ops < vec_len (ptd->crypto_ops));
 312           if (op->status != VNET_CRYPTO_OP_STATUS_COMPLETED)
 313             {
 314               u32 err, bi;
 315
 316               bi = op->user_data;
 317
 318               if (op->status == VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC)
 319                 err = ESP_DECRYPT_ERROR_DECRYPTION_FAILED;
 320               else
 321                 err = ESP_DECRYPT_ERROR_CRYPTO_ENGINE_ERROR;
 322
 323               bufs[bi]->error = node->errors[err];
 324               nexts[bi] = ESP_DECRYPT_NEXT_DROP;
 325               n--;
 326             }
 327           op++;
 328         }
 329     }
 330
 331   /* Post decryption ronud - adjust packet data start and length and next
 332      node */
 333
 334   n_left = from_frame->n_vectors;
 335   next = nexts;
 336   pd = pkt_data;
 337   b = bufs;
 338
 339   while (n_left)
 340     {
 341       const u8 tun_flags = IPSEC_SA_FLAG_IS_TUNNEL |
 342         IPSEC_SA_FLAG_IS_TUNNEL_V6;
 343
 344       if (n_left >= 2)
 345         {
 346           void *data = b[1]->data + pd[1].current_data;
 347
 348           /* buffer metadata */
 349           vlib_prefetch_buffer_header (b[1], LOAD);
 350
 351           /* esp_footer_t */
 352           CLIB_PREFETCH (data + pd[1].current_length - pd[1].icv_sz - 2,
 353                          CLIB_CACHE_LINE_BYTES, LOAD);
 354
 355           /* packet headers */
 356           CLIB_PREFETCH (data - CLIB_CACHE_LINE_BYTES,
 357                          CLIB_CACHE_LINE_BYTES * 2, LOAD);
 358         }
 359
 360       if (next[0] < ESP_DECRYPT_N_NEXT)
 361         goto trace;
 362
 363       sa0 = vec_elt_at_index (im->sad, pd->sa_index);
 364       u8 *payload = b[0]->data + pd->current_data;
 365
 366       ipsec_sa_anti_replay_advance (sa0, &((esp_header_t *) payload)->seq);
 367
 368       esp_footer_t *f = (esp_footer_t *) (b[0]->data + pd->current_data +
 369                                           pd->current_length - sizeof (*f) -
 370                                           pd->icv_sz);
 371       u16 adv = pd->iv_sz + esp_sz;
 372       u16 tail = sizeof (esp_footer_t) + f->pad_length + pd->icv_sz;
 373
 374       if ((pd->flags & tun_flags) == 0) /* transport mode */
 375         {
 376           u8 udp_sz = (is_ip6 == 0 && pd->flags & IPSEC_SA_FLAG_UDP_ENCAP) ?
 377             sizeof (udp_header_t) : 0;
 378           u16 ip_hdr_sz = pd->hdr_sz - udp_sz;
 379           u8 *old_ip = b[0]->data + pd->current_data - ip_hdr_sz - udp_sz;
 380           u8 *ip = old_ip + adv + udp_sz;
 381
 382           if (is_ip6 && ip_hdr_sz > 64)
 383             memmove (ip, old_ip, ip_hdr_sz);
 384           else
 385             clib_memcpy_le64 (ip, old_ip, ip_hdr_sz);
 386
 387           b[0]->current_data = pd->current_data + adv - ip_hdr_sz;
 388           b[0]->current_length = pd->current_length + ip_hdr_sz - tail - adv;
 389
 390           if (is_ip6)
 391             {
 392               ip6_header_t *ip6 = (ip6_header_t *) ip;
 393               u16 len = clib_net_to_host_u16 (ip6->payload_length);
 394               len -= adv + tail;
 395               ip6->payload_length = clib_host_to_net_u16 (len);
 396               ip6->protocol = f->next_header;
 397               next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
 398             }
 399           else
 400             {
 401               ip4_header_t *ip4 = (ip4_header_t *) ip;
 402               ip_csum_t sum = ip4->checksum;
 403               u16 len = clib_net_to_host_u16 (ip4->length);
 404               len = clib_host_to_net_u16 (len - adv - tail - udp_sz);
 405               sum = ip_csum_update (sum, ip4->protocol, f->next_header,
 406                                     ip4_header_t, protocol);
 407               sum = ip_csum_update (sum, ip4->length, len,
 408                                     ip4_header_t, length);
 409               ip4->checksum = ip_csum_fold (sum);
 410               ip4->protocol = f->next_header;
 411               ip4->length = len;
 412               next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
 413             }
 414         }
 415       else
 416         {
 417           if (PREDICT_TRUE (f->next_header == IP_PROTOCOL_IP_IN_IP))
 418             {
 419               next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
 420               b[0]->current_data = pd->current_data + adv;
 421               b[0]->current_length = pd->current_length + adv - tail;
 422             }
 423           else if (f->next_header == IP_PROTOCOL_IPV6)
 424             {
 425               next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
 426               b[0]->current_data = pd->current_data + adv;
 427               b[0]->current_length = pd->current_length + adv - tail;
 428             }
 429           else
 430             {
 431               next[0] = ESP_DECRYPT_NEXT_DROP;
 432               b[0]->error = node->errors[ESP_DECRYPT_ERROR_DECRYPTION_FAILED];
 433             }
 434         }
 435
 436       if (PREDICT_FALSE (ipsec_sa_is_set_IS_GRE (sa0)))
 437         next[0] = ESP_DECRYPT_NEXT_IPSEC_GRE_INPUT;
 438
 439     trace:
 440       if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
 441         {
 442           esp_decrypt_trace_t *tr;
 443           u8 *payload = b[0]->data + pd->current_data;
 444           tr = vlib_add_trace (vm, node, b[0], sizeof (*tr));
 445           sa0 = pool_elt_at_index (im->sad,
 446                                    vnet_buffer (b[0])->ipsec.sad_index);
 447           tr->crypto_alg = sa0->crypto_alg;
 448           tr->integ_alg = sa0->integ_alg;
 449           tr->seq = clib_host_to_net_u32 (((esp_header_t *) payload)->seq);
 450         }
 451
 452       /* next */
 453       n_left -= 1;
 454       next += 1;
 455       pd += 1;
 456       b += 1;
 457     }
 458
 459   n_left = from_frame->n_vectors;
 460   vlib_node_increment_counter (vm, node->node_index,
 461                                ESP_DECRYPT_ERROR_RX_PKTS, n_left);
 462
 463   vlib_buffer_enqueue_to_next (vm, node, from, nexts, n_left);
 464
 465   b = bufs;
 466   return n_left;
 467 }
 468
 469 VLIB_NODE_FN (esp4_decrypt_node) (vlib_main_t * vm,
 470                                   vlib_node_runtime_t * node,
 471                                   vlib_frame_t * from_frame)
 472 {
 473   return esp_decrypt_inline (vm, node, from_frame, 0 /* is_ip6 */ );
 474 }
 475
 476 /* *INDENT-OFF* */
 477 VLIB_REGISTER_NODE (esp4_decrypt_node) = {
 478   .name = "esp4-decrypt",
 479   .vector_size = sizeof (u32),
 480   .format_trace = format_esp_decrypt_trace,
 481   .type = VLIB_NODE_TYPE_INTERNAL,
 482
 483   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
 484   .error_strings = esp_decrypt_error_strings,
 485
 486   .n_next_nodes = ESP_DECRYPT_N_NEXT,
 487   .next_nodes = {
 488 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
 489     foreach_esp_decrypt_next
 490 #undef _
 491   },
 492 };
 493 /* *INDENT-ON* */
 494
 495 VLIB_NODE_FN (esp6_decrypt_node) (vlib_main_t * vm,
 496                                   vlib_node_runtime_t * node,
 497                                   vlib_frame_t * from_frame)
 498 {
 499   return esp_decrypt_inline (vm, node, from_frame, 1 /* is_ip6 */ );
 500 }
 501
 502 /* *INDENT-OFF* */
 503 VLIB_REGISTER_NODE (esp6_decrypt_node) = {
 504   .name = "esp6-decrypt",
 505   .vector_size = sizeof (u32),
 506   .format_trace = format_esp_decrypt_trace,
 507   .type = VLIB_NODE_TYPE_INTERNAL,
 508
 509   .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
 510   .error_strings = esp_decrypt_error_strings,
 511
 512   .n_next_nodes = ESP_DECRYPT_N_NEXT,
 513   .next_nodes = {
 514 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
 515     foreach_esp_decrypt_next
 516 #undef _
 517   },
 518 };
 519 /* *INDENT-ON* */
 520
 521 /*
 522  * fd.io coding-style-patch-verification: ON
 523  *
 524  * Local Variables:
 525  * eval: (c-set-style "gnu")
 526  * End:
 527  */