src/plugins/wireguard/wireguard_input.c

   1 /*
   2  * Copyright (c) 2020 Doc.ai and/or its affiliates.
   3  * Copyright (c) 2020 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <vlib/vlib.h>
  18 #include <vnet/vnet.h>
  19 #include <vppinfra/error.h>
  20 #include <wireguard/wireguard.h>
  21
  22 #include <wireguard/wireguard_send.h>
  23 #include <wireguard/wireguard_if.h>
  24
  25 #define foreach_wg_input_error                                                \
  26   _ (NONE, "No error")                                                        \
  27   _ (HANDSHAKE_MAC, "Invalid MAC handshake")                                  \
  28   _ (HANDSHAKE_RATELIMITED, "Handshake ratelimited")                          \
  29   _ (PEER, "Peer error")                                                      \
  30   _ (INTERFACE, "Interface error")                                            \
  31   _ (DECRYPTION, "Failed during decryption")                                  \
  32   _ (KEEPALIVE_SEND, "Failed while sending Keepalive")                        \
  33   _ (HANDSHAKE_SEND, "Failed while sending Handshake")                        \
  34   _ (HANDSHAKE_RECEIVE, "Failed while receiving Handshake")                   \
  35   _ (COOKIE_DECRYPTION, "Failed during Cookie decryption")                    \
  36   _ (COOKIE_SEND, "Failed during sending Cookie")                             \
  37   _ (TOO_BIG, "Packet too big")                                               \
  38   _ (UNDEFINED, "Undefined error")                                            \
  39   _ (CRYPTO_ENGINE_ERROR, "crypto engine error (packet dropped)")
  40
  41 typedef enum
  42 {
  43 #define _(sym,str) WG_INPUT_ERROR_##sym,
  44   foreach_wg_input_error
  45 #undef _
  46     WG_INPUT_N_ERROR,
  47 } wg_input_error_t;
  48
  49 static char *wg_input_error_strings[] = {
  50 #define _(sym,string) string,
  51   foreach_wg_input_error
  52 #undef _
  53 };
  54
  55 typedef struct
  56 {
  57   message_type_t type;
  58   u16 current_length;
  59   bool is_keepalive;
  60   index_t peer;
  61 } wg_input_trace_t;
  62
  63 typedef struct
  64 {
  65   index_t peer;
  66   u16 next;
  67 } wg_input_post_trace_t;
  68
  69 u8 *
  70 format_wg_message_type (u8 * s, va_list * args)
  71 {
  72   message_type_t type = va_arg (*args, message_type_t);
  73
  74   switch (type)
  75     {
  76 #define _(v,a) case MESSAGE_##v: return (format (s, "%s", a));
  77       foreach_wg_message_type
  78 #undef _
  79     }
  80   return (format (s, "unknown"));
  81 }
  82
  83 /* packet trace format function */
  84 static u8 *
  85 format_wg_input_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
  90   wg_input_trace_t *t = va_arg (*args, wg_input_trace_t *);
  91
  92   s = format (s, "Wireguard input: \n");
  93   s = format (s, "    Type: %U\n", format_wg_message_type, t->type);
  94   s = format (s, "    Peer: %d\n", t->peer);
  95   s = format (s, "    Length: %d\n", t->current_length);
  96   s = format (s, "    Keepalive: %s", t->is_keepalive ? "true" : "false");
  97
  98   return s;
  99 }
 100
 101 /* post-node packet trace format function */
 102 static u8 *
 103 format_wg_input_post_trace (u8 *s, va_list *args)
 104 {
 105   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
 106   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
 107
 108   wg_input_post_trace_t *t = va_arg (*args, wg_input_post_trace_t *);
 109
 110   s = format (s, "WG input post: \n");
 111   s = format (s, "  peer: %u\n", t->peer);
 112   s = format (s, "  next: %u\n", t->next);
 113
 114   return s;
 115 }
 116
 117 typedef enum
 118 {
 119   WG_INPUT_NEXT_HANDOFF_HANDSHAKE,
 120   WG_INPUT_NEXT_HANDOFF_DATA,
 121   WG_INPUT_NEXT_IP4_INPUT,
 122   WG_INPUT_NEXT_IP6_INPUT,
 123   WG_INPUT_NEXT_PUNT,
 124   WG_INPUT_NEXT_ERROR,
 125   WG_INPUT_N_NEXT,
 126 } wg_input_next_t;
 127
 128 static u8
 129 is_ip4_header (u8 *data)
 130 {
 131   return (data[0] >> 4) == 0x4;
 132 }
 133
 134 static wg_input_error_t
 135 wg_handshake_process (vlib_main_t *vm, wg_main_t *wmp, vlib_buffer_t *b,
 136                       u32 node_idx, u8 is_ip4)
 137 {
 138   ASSERT (vm->thread_index == 0);
 139
 140   enum cookie_mac_state mac_state;
 141   bool packet_needs_cookie;
 142   bool under_load;
 143   index_t *wg_ifs;
 144   wg_if_t *wg_if;
 145   wg_peer_t *peer = NULL;
 146
 147   void *current_b_data = vlib_buffer_get_current (b);
 148
 149   ip46_address_t src_ip;
 150   if (is_ip4)
 151     {
 152       ip4_header_t *iph4 =
 153         current_b_data - sizeof (udp_header_t) - sizeof (ip4_header_t);
 154       ip46_address_set_ip4 (&src_ip, &iph4->src_address);
 155     }
 156   else
 157     {
 158       ip6_header_t *iph6 =
 159         current_b_data - sizeof (udp_header_t) - sizeof (ip6_header_t);
 160       ip46_address_set_ip6 (&src_ip, &iph6->src_address);
 161     }
 162
 163   udp_header_t *uhd = current_b_data - sizeof (udp_header_t);
 164   u16 udp_src_port = clib_host_to_net_u16 (uhd->src_port);
 165   u16 udp_dst_port = clib_host_to_net_u16 (uhd->dst_port);
 166
 167   message_header_t *header = current_b_data;
 168
 169   if (PREDICT_FALSE (header->type == MESSAGE_HANDSHAKE_COOKIE))
 170     {
 171       message_handshake_cookie_t *packet =
 172         (message_handshake_cookie_t *) current_b_data;
 173       u32 *entry =
 174         wg_index_table_lookup (&wmp->index_table, packet->receiver_index);
 175       if (entry)
 176         peer = wg_peer_get (*entry);
 177       else
 178         return WG_INPUT_ERROR_PEER;
 179
 180       if (!cookie_maker_consume_payload (
 181             vm, &peer->cookie_maker, packet->nonce, packet->encrypted_cookie))
 182         return WG_INPUT_ERROR_COOKIE_DECRYPTION;
 183
 184       return WG_INPUT_ERROR_NONE;
 185     }
 186
 187   u32 len = (header->type == MESSAGE_HANDSHAKE_INITIATION ?
 188              sizeof (message_handshake_initiation_t) :
 189              sizeof (message_handshake_response_t));
 190
 191   message_macs_t *macs = (message_macs_t *)
 192     ((u8 *) current_b_data + len - sizeof (*macs));
 193
 194   index_t *ii;
 195   wg_ifs = wg_if_indexes_get_by_port (udp_dst_port);
 196   if (NULL == wg_ifs)
 197     return WG_INPUT_ERROR_INTERFACE;
 198
 199   vec_foreach (ii, wg_ifs)
 200     {
 201       wg_if = wg_if_get (*ii);
 202       if (NULL == wg_if)
 203         continue;
 204
 205       under_load = wg_if_is_under_load (vm, wg_if);
 206       mac_state = cookie_checker_validate_macs (
 207         vm, &wg_if->cookie_checker, macs, current_b_data, len, under_load,
 208         &src_ip, udp_src_port);
 209       if (mac_state == INVALID_MAC)
 210         {
 211           wg_if_dec_handshake_num (wg_if);
 212           wg_if = NULL;
 213           continue;
 214         }
 215       break;
 216     }
 217
 218   if (NULL == wg_if)
 219     return WG_INPUT_ERROR_HANDSHAKE_MAC;
 220
 221   if ((under_load && mac_state == VALID_MAC_WITH_COOKIE)
 222       || (!under_load && mac_state == VALID_MAC_BUT_NO_COOKIE))
 223     packet_needs_cookie = false;
 224   else if (under_load && mac_state == VALID_MAC_BUT_NO_COOKIE)
 225     packet_needs_cookie = true;
 226   else if (mac_state == VALID_MAC_WITH_COOKIE_BUT_RATELIMITED)
 227     return WG_INPUT_ERROR_HANDSHAKE_RATELIMITED;
 228   else
 229     return WG_INPUT_ERROR_HANDSHAKE_MAC;
 230
 231   switch (header->type)
 232     {
 233     case MESSAGE_HANDSHAKE_INITIATION:
 234       {
 235         message_handshake_initiation_t *message = current_b_data;
 236
 237         if (packet_needs_cookie)
 238           {
 239
 240             if (!wg_send_handshake_cookie (vm, message->sender_index,
 241                                            &wg_if->cookie_checker, macs,
 242                                            &ip_addr_46 (&wg_if->src_ip),
 243                                            wg_if->port, &src_ip, udp_src_port))
 244               return WG_INPUT_ERROR_COOKIE_SEND;
 245
 246             return WG_INPUT_ERROR_NONE;
 247           }
 248
 249         noise_remote_t *rp;
 250         if (noise_consume_initiation
 251             (vm, noise_local_get (wg_if->local_idx), &rp,
 252              message->sender_index, message->unencrypted_ephemeral,
 253              message->encrypted_static, message->encrypted_timestamp))
 254           {
 255             peer = wg_peer_get (rp->r_peer_idx);
 256           }
 257         else
 258           {
 259             return WG_INPUT_ERROR_PEER;
 260           }
 261
 262         wg_peer_update_endpoint (rp->r_peer_idx, &src_ip, udp_src_port);
 263
 264         if (PREDICT_FALSE (!wg_send_handshake_response (vm, peer)))
 265           {
 266             vlib_node_increment_counter (vm, node_idx,
 267                                          WG_INPUT_ERROR_HANDSHAKE_SEND, 1);
 268           }
 269         break;
 270       }
 271     case MESSAGE_HANDSHAKE_RESPONSE:
 272       {
 273         message_handshake_response_t *resp = current_b_data;
 274
 275         if (packet_needs_cookie)
 276           {
 277             if (!wg_send_handshake_cookie (vm, resp->sender_index,
 278                                            &wg_if->cookie_checker, macs,
 279                                            &ip_addr_46 (&wg_if->src_ip),
 280                                            wg_if->port, &src_ip, udp_src_port))
 281               return WG_INPUT_ERROR_COOKIE_SEND;
 282
 283             return WG_INPUT_ERROR_NONE;
 284           }
 285
 286         index_t peeri = INDEX_INVALID;
 287         u32 *entry =
 288           wg_index_table_lookup (&wmp->index_table, resp->receiver_index);
 289
 290         if (PREDICT_TRUE (entry != NULL))
 291           {
 292             peeri = *entry;
 293             peer = wg_peer_get (peeri);
 294             if (wg_peer_is_dead (peer))
 295               return WG_INPUT_ERROR_PEER;
 296           }
 297         else
 298           return WG_INPUT_ERROR_PEER;
 299
 300         if (!noise_consume_response
 301             (vm, &peer->remote, resp->sender_index,
 302              resp->receiver_index, resp->unencrypted_ephemeral,
 303              resp->encrypted_nothing))
 304           {
 305             return WG_INPUT_ERROR_PEER;
 306           }
 307
 308         wg_peer_update_endpoint (peeri, &src_ip, udp_src_port);
 309
 310         if (noise_remote_begin_session (vm, &peer->remote))
 311           {
 312
 313             wg_timers_session_derived (peer);
 314             wg_timers_handshake_complete (peer);
 315             if (PREDICT_FALSE (!wg_send_keepalive (vm, peer)))
 316               {
 317                 vlib_node_increment_counter (vm, node_idx,
 318                                              WG_INPUT_ERROR_KEEPALIVE_SEND, 1);
 319               }
 320             else
 321               {
 322                 wg_peer_update_flags (peeri, WG_PEER_ESTABLISHED, true);
 323               }
 324           }
 325         break;
 326       }
 327     default:
 328       return WG_INPUT_ERROR_HANDSHAKE_RECEIVE;
 329     }
 330
 331   wg_timers_any_authenticated_packet_received (peer);
 332   wg_timers_any_authenticated_packet_traversal (peer);
 333   return WG_INPUT_ERROR_NONE;
 334 }
 335
 336 static_always_inline int
 337 wg_input_post_process (vlib_main_t *vm, vlib_buffer_t *b, u16 *next,
 338                        wg_peer_t *peer, message_data_t *data,
 339                        bool *is_keepalive)
 340 {
 341   next[0] = WG_INPUT_NEXT_PUNT;
 342   noise_keypair_t *kp;
 343
 344   if ((kp = wg_get_active_keypair (&peer->remote, data->receiver_index)) ==
 345       NULL)
 346     return -1;
 347
 348   if (!noise_counter_recv (&kp->kp_ctr, data->counter))
 349     {
 350       return -1;
 351     }
 352
 353   u16 encr_len = b->current_length - sizeof (message_data_t);
 354   u16 decr_len = encr_len - NOISE_AUTHTAG_LEN;
 355
 356   vlib_buffer_advance (b, sizeof (message_data_t));
 357   b->current_length = decr_len;
 358   vnet_buffer_offload_flags_clear (b, VNET_BUFFER_OFFLOAD_F_UDP_CKSUM);
 359
 360   /* Keepalive packet has zero length */
 361   if (decr_len == 0)
 362     {
 363       *is_keepalive = true;
 364       return 0;
 365     }
 366
 367   wg_timers_data_received (peer);
 368
 369   ip46_address_t src_ip;
 370   u8 is_ip4_inner = is_ip4_header (vlib_buffer_get_current (b));
 371   if (is_ip4_inner)
 372     {
 373       ip46_address_set_ip4 (
 374         &src_ip, &((ip4_header_t *) vlib_buffer_get_current (b))->src_address);
 375     }
 376   else
 377     {
 378       ip46_address_set_ip6 (
 379         &src_ip, &((ip6_header_t *) vlib_buffer_get_current (b))->src_address);
 380     }
 381
 382   const fib_prefix_t *allowed_ip;
 383   bool allowed = false;
 384
 385   /*
 386    * we could make this into an ACL, but the expectation
 387    * is that there aren't many allowed IPs and thus a linear
 388    * walk is faster than an ACL
 389    */
 390   vec_foreach (allowed_ip, peer->allowed_ips)
 391     {
 392       if (fib_prefix_is_cover_addr_46 (allowed_ip, &src_ip))
 393         {
 394           allowed = true;
 395           break;
 396         }
 397     }
 398   if (allowed)
 399     {
 400       vnet_buffer (b)->sw_if_index[VLIB_RX] = peer->wg_sw_if_index;
 401       next[0] =
 402         is_ip4_inner ? WG_INPUT_NEXT_IP4_INPUT : WG_INPUT_NEXT_IP6_INPUT;
 403     }
 404
 405   return 0;
 406 }
 407
 408 static_always_inline void
 409 wg_input_process_ops (vlib_main_t *vm, vlib_node_runtime_t *node,
 410                       vnet_crypto_op_t *ops, vlib_buffer_t *b[], u16 *nexts,
 411                       u16 drop_next)
 412 {
 413   u32 n_fail, n_ops = vec_len (ops);
 414   vnet_crypto_op_t *op = ops;
 415
 416   if (n_ops == 0)
 417     return;
 418
 419   n_fail = n_ops - vnet_crypto_process_ops (vm, op, n_ops);
 420
 421   while (n_fail)
 422     {
 423       ASSERT (op - ops < n_ops);
 424
 425       if (op->status != VNET_CRYPTO_OP_STATUS_COMPLETED)
 426         {
 427           u32 bi = op->user_data;
 428           b[bi]->error = node->errors[WG_INPUT_ERROR_DECRYPTION];
 429           nexts[bi] = drop_next;
 430           n_fail--;
 431         }
 432       op++;
 433     }
 434 }
 435
 436 always_inline void
 437 wg_prepare_sync_dec_op (vlib_main_t *vm, vnet_crypto_op_t **crypto_ops,
 438                         u8 *src, u32 src_len, u8 *dst, u8 *aad, u32 aad_len,
 439                         vnet_crypto_key_index_t key_index, u32 bi, u8 *iv)
 440 {
 441   vnet_crypto_op_t _op, *op = &_op;
 442   u8 src_[] = {};
 443
 444   vec_add2_aligned (crypto_ops[0], op, 1, CLIB_CACHE_LINE_BYTES);
 445   vnet_crypto_op_init (op, VNET_CRYPTO_OP_CHACHA20_POLY1305_DEC);
 446
 447   op->tag_len = NOISE_AUTHTAG_LEN;
 448   op->tag = src + src_len;
 449   op->src = !src ? src_ : src;
 450   op->len = src_len;
 451   op->dst = dst;
 452   op->key_index = key_index;
 453   op->aad = aad;
 454   op->aad_len = aad_len;
 455   op->iv = iv;
 456   op->user_data = bi;
 457   op->flags |= VNET_CRYPTO_OP_FLAG_HMAC_CHECK;
 458 }
 459
 460 static_always_inline void
 461 wg_input_add_to_frame (vlib_main_t *vm, vnet_crypto_async_frame_t *f,
 462                        u32 key_index, u32 crypto_len, i16 crypto_start_offset,
 463                        u32 buffer_index, u16 next_node, u8 *iv, u8 *tag,
 464                        u8 flags)
 465 {
 466   vnet_crypto_async_frame_elt_t *fe;
 467   u16 index;
 468
 469   ASSERT (f->n_elts < VNET_CRYPTO_FRAME_SIZE);
 470
 471   index = f->n_elts;
 472   fe = &f->elts[index];
 473   f->n_elts++;
 474   fe->key_index = key_index;
 475   fe->crypto_total_length = crypto_len;
 476   fe->crypto_start_offset = crypto_start_offset;
 477   fe->iv = iv;
 478   fe->tag = tag;
 479   fe->flags = flags;
 480   f->buffer_indices[index] = buffer_index;
 481   f->next_node_index[index] = next_node;
 482 }
 483
 484 static_always_inline enum noise_state_crypt
 485 wg_input_process (vlib_main_t *vm, wg_per_thread_data_t *ptd,
 486                   vnet_crypto_op_t **crypto_ops,
 487                   vnet_crypto_async_frame_t **async_frame, vlib_buffer_t *b,
 488                   u32 buf_idx, noise_remote_t *r, uint32_t r_idx,
 489                   uint64_t nonce, uint8_t *src, size_t srclen, uint8_t *dst,
 490                   u32 from_idx, u8 *iv, f64 time, u8 is_async,
 491                   u16 async_next_node)
 492 {
 493   noise_keypair_t *kp;
 494   enum noise_state_crypt ret = SC_FAILED;
 495
 496   if ((kp = wg_get_active_keypair (r, r_idx)) == NULL)
 497     {
 498       goto error;
 499     }
 500
 501   /* We confirm that our values are within our tolerances. These values
 502    * are the same as the encrypt routine.
 503    *
 504    * kp_ctr isn't locked here, we're happy to accept a racy read. */
 505   if (wg_birthdate_has_expired_opt (kp->kp_birthdate, REJECT_AFTER_TIME,
 506                                     time) ||
 507       kp->kp_ctr.c_recv >= REJECT_AFTER_MESSAGES)
 508     goto error;
 509
 510   /* Decrypt, then validate the counter. We don't want to validate the
 511    * counter before decrypting as we do not know the message is authentic
 512    * prior to decryption. */
 513
 514   clib_memset (iv, 0, 4);
 515   clib_memcpy (iv + 4, &nonce, sizeof (nonce));
 516
 517   if (is_async)
 518     {
 519       if (NULL == *async_frame ||
 520           vnet_crypto_async_frame_is_full (*async_frame))
 521         {
 522           *async_frame = vnet_crypto_async_get_frame (
 523             vm, VNET_CRYPTO_OP_CHACHA20_POLY1305_TAG16_AAD0_DEC);
 524           /* Save the frame to the list we'll submit at the end */
 525           vec_add1 (ptd->async_frames, *async_frame);
 526         }
 527
 528       wg_input_add_to_frame (vm, *async_frame, kp->kp_recv_index, srclen,
 529                              src - b->data, buf_idx, async_next_node, iv,
 530                              src + srclen, VNET_CRYPTO_OP_FLAG_HMAC_CHECK);
 531     }
 532   else
 533     {
 534       wg_prepare_sync_dec_op (vm, crypto_ops, src, srclen, dst, NULL, 0,
 535                               kp->kp_recv_index, from_idx, iv);
 536     }
 537
 538   /* If we've received the handshake confirming data packet then move the
 539    * next keypair into current. If we do slide the next keypair in, then
 540    * we skip the REKEY_AFTER_TIME_RECV check. This is safe to do as a
 541    * data packet can't confirm a session that we are an INITIATOR of. */
 542   if (kp == r->r_next)
 543     {
 544       clib_rwlock_writer_lock (&r->r_keypair_lock);
 545       if (kp == r->r_next && kp->kp_local_index == r_idx)
 546         {
 547           noise_remote_keypair_free (vm, r, &r->r_previous);
 548           r->r_previous = r->r_current;
 549           r->r_current = r->r_next;
 550           r->r_next = NULL;
 551
 552           ret = SC_CONN_RESET;
 553           clib_rwlock_writer_unlock (&r->r_keypair_lock);
 554           goto error;
 555         }
 556       clib_rwlock_writer_unlock (&r->r_keypair_lock);
 557     }
 558
 559   /* Similar to when we encrypt, we want to notify the caller when we
 560    * are approaching our tolerances. We notify if:
 561    *  - we're the initiator and the current keypair is older than
 562    *    REKEY_AFTER_TIME_RECV seconds. */
 563   ret = SC_KEEP_KEY_FRESH;
 564   kp = r->r_current;
 565   if (kp != NULL && kp->kp_valid && kp->kp_is_initiator &&
 566       wg_birthdate_has_expired_opt (kp->kp_birthdate, REKEY_AFTER_TIME_RECV,
 567                                     time))
 568     goto error;
 569
 570   ret = SC_OK;
 571 error:
 572   return ret;
 573 }
 574
 575 static_always_inline void
 576 wg_find_outer_addr_port (vlib_buffer_t *b, ip46_address_t *addr, u16 *port,
 577                          u8 is_ip4)
 578 {
 579   if (is_ip4)
 580     {
 581       ip4_udp_header_t *ip4_udp_hdr =
 582         vlib_buffer_get_current (b) - sizeof (ip4_udp_header_t);
 583       ip46_address_set_ip4 (addr, &ip4_udp_hdr->ip4.src_address);
 584       *port = clib_net_to_host_u16 (ip4_udp_hdr->udp.src_port);
 585     }
 586   else
 587     {
 588       ip6_udp_header_t *ip6_udp_hdr =
 589         vlib_buffer_get_current (b) - sizeof (ip6_udp_header_t);
 590       ip46_address_set_ip6 (addr, &ip6_udp_hdr->ip6.src_address);
 591       *port = clib_net_to_host_u16 (ip6_udp_hdr->udp.src_port);
 592     }
 593 }
 594
 595 always_inline uword
 596 wg_input_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
 597                  vlib_frame_t *frame, u8 is_ip4, u16 async_next_node)
 598 {
 599   vnet_main_t *vnm = vnet_get_main ();
 600   vnet_interface_main_t *im = &vnm->interface_main;
 601   wg_main_t *wmp = &wg_main;
 602   wg_per_thread_data_t *ptd =
 603     vec_elt_at_index (wmp->per_thread_data, vm->thread_index);
 604   u32 *from = vlib_frame_vector_args (frame);
 605   u32 n_left_from = frame->n_vectors;
 606
 607   vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
 608   u32 thread_index = vm->thread_index;
 609   vnet_crypto_op_t **crypto_ops = &ptd->crypto_ops;
 610   const u16 drop_next = WG_INPUT_NEXT_PUNT;
 611   message_type_t header_type;
 612   vlib_buffer_t *data_bufs[VLIB_FRAME_SIZE];
 613   u32 data_bi[VLIB_FRAME_SIZE];  /* buffer index for data */
 614   u32 other_bi[VLIB_FRAME_SIZE]; /* buffer index for drop or handoff */
 615   u16 other_nexts[VLIB_FRAME_SIZE], *other_next = other_nexts, n_other = 0;
 616   u16 data_nexts[VLIB_FRAME_SIZE], *data_next = data_nexts, n_data = 0;
 617   u16 n_async = 0;
 618   const u8 is_async = wg_op_mode_is_set_ASYNC ();
 619   vnet_crypto_async_frame_t *async_frame = NULL;
 620
 621   vlib_get_buffers (vm, from, bufs, n_left_from);
 622   vec_reset_length (ptd->crypto_ops);
 623   vec_reset_length (ptd->async_frames);
 624
 625   f64 time = clib_time_now (&vm->clib_time) + vm->time_offset;
 626
 627   wg_peer_t *peer = NULL;
 628   u32 *last_peer_time_idx = NULL;
 629   u32 last_rec_idx = ~0;
 630
 631   bool is_keepalive = false;
 632   u32 *peer_idx = NULL;
 633   index_t peeri = INDEX_INVALID;
 634
 635   while (n_left_from > 0)
 636     {
 637       if (n_left_from > 2)
 638         {
 639           u8 *p;
 640           vlib_prefetch_buffer_header (b[2], LOAD);
 641           p = vlib_buffer_get_current (b[1]);
 642           CLIB_PREFETCH (p, CLIB_CACHE_LINE_BYTES, LOAD);
 643           CLIB_PREFETCH (vlib_buffer_get_tail (b[1]), CLIB_CACHE_LINE_BYTES,
 644                          LOAD);
 645         }
 646
 647       other_next[n_other] = WG_INPUT_NEXT_PUNT;
 648       data_nexts[n_data] = WG_INPUT_N_NEXT;
 649
 650       header_type =
 651         ((message_header_t *) vlib_buffer_get_current (b[0]))->type;
 652
 653       if (PREDICT_TRUE (header_type == MESSAGE_DATA))
 654         {
 655           message_data_t *data = vlib_buffer_get_current (b[0]);
 656           u8 *iv_data = b[0]->pre_data;
 657           u32 buf_idx = from[b - bufs];
 658           peer_idx = wg_index_table_lookup (&wmp->index_table,
 659                                             data->receiver_index);
 660
 661           if (data->receiver_index != last_rec_idx)
 662             {
 663               peer_idx = wg_index_table_lookup (&wmp->index_table,
 664                                                 data->receiver_index);
 665               if (PREDICT_TRUE (peer_idx != NULL))
 666                 {
 667                   peeri = *peer_idx;
 668                   peer = wg_peer_get (peeri);
 669                   last_rec_idx = data->receiver_index;
 670                 }
 671               else
 672                 {
 673                   peer = NULL;
 674                   last_rec_idx = ~0;
 675                 }
 676             }
 677
 678           if (PREDICT_FALSE (!peer_idx))
 679             {
 680               other_next[n_other] = WG_INPUT_NEXT_ERROR;
 681               b[0]->error = node->errors[WG_INPUT_ERROR_PEER];
 682               other_bi[n_other] = buf_idx;
 683               n_other += 1;
 684               goto out;
 685             }
 686
 687           if (PREDICT_FALSE (~0 == peer->input_thread_index))
 688             {
 689               /* this is the first packet to use this peer, claim the peer
 690                * for this thread.
 691                */
 692               clib_atomic_cmp_and_swap (&peer->input_thread_index, ~0,
 693                                         wg_peer_assign_thread (thread_index));
 694             }
 695
 696           if (PREDICT_TRUE (thread_index != peer->input_thread_index))
 697             {
 698               other_next[n_other] = WG_INPUT_NEXT_HANDOFF_DATA;
 699               other_bi[n_other] = buf_idx;
 700               n_other += 1;
 701               goto next;
 702             }
 703
 704           u16 encr_len = b[0]->current_length - sizeof (message_data_t);
 705           u16 decr_len = encr_len - NOISE_AUTHTAG_LEN;
 706           if (PREDICT_FALSE (decr_len >= WG_DEFAULT_DATA_SIZE))
 707             {
 708               b[0]->error = node->errors[WG_INPUT_ERROR_TOO_BIG];
 709               other_bi[n_other] = buf_idx;
 710               n_other += 1;
 711               goto out;
 712             }
 713
 714           enum noise_state_crypt state_cr = wg_input_process (
 715             vm, ptd, crypto_ops, &async_frame, b[0], buf_idx, &peer->remote,
 716             data->receiver_index, data->counter, data->encrypted_data,
 717             decr_len, data->encrypted_data, n_data, iv_data, time, is_async,
 718             async_next_node);
 719
 720           if (PREDICT_FALSE (state_cr == SC_FAILED))
 721             {
 722               wg_peer_update_flags (*peer_idx, WG_PEER_ESTABLISHED, false);
 723               other_next[n_other] = WG_INPUT_NEXT_ERROR;
 724               b[0]->error = node->errors[WG_INPUT_ERROR_DECRYPTION];
 725               other_bi[n_other] = buf_idx;
 726               n_other += 1;
 727               goto out;
 728             }
 729           if (!is_async)
 730             {
 731               data_bufs[n_data] = b[0];
 732               data_bi[n_data] = buf_idx;
 733               n_data += 1;
 734             }
 735           else
 736             {
 737               n_async += 1;
 738             }
 739
 740           if (PREDICT_FALSE (state_cr == SC_CONN_RESET))
 741             {
 742               wg_timers_handshake_complete (peer);
 743               goto next;
 744             }
 745           else if (PREDICT_FALSE (state_cr == SC_KEEP_KEY_FRESH))
 746             {
 747               wg_send_handshake_from_mt (peeri, false);
 748               goto next;
 749             }
 750           else if (PREDICT_TRUE (state_cr == SC_OK))
 751             goto next;
 752         }
 753       else
 754         {
 755           /* Handshake packets should be processed in main thread */
 756           if (thread_index != 0)
 757             {
 758               other_next[n_other] = WG_INPUT_NEXT_HANDOFF_HANDSHAKE;
 759               other_bi[n_other] = from[b - bufs];
 760               n_other += 1;
 761               goto next;
 762             }
 763
 764           wg_input_error_t ret =
 765             wg_handshake_process (vm, wmp, b[0], node->node_index, is_ip4);
 766           if (ret != WG_INPUT_ERROR_NONE)
 767             {
 768               other_next[n_other] = WG_INPUT_NEXT_ERROR;
 769               b[0]->error = node->errors[ret];
 770               other_bi[n_other] = from[b - bufs];
 771               n_other += 1;
 772             }
 773           else
 774             {
 775               other_bi[n_other] = from[b - bufs];
 776               n_other += 1;
 777             }
 778         }
 779
 780     out:
 781       if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE) &&
 782                          (b[0]->flags & VLIB_BUFFER_IS_TRACED)))
 783         {
 784           wg_input_trace_t *t = vlib_add_trace (vm, node, b[0], sizeof (*t));
 785           t->type = header_type;
 786           t->current_length = b[0]->current_length;
 787           t->is_keepalive = is_keepalive;
 788           t->peer = peer_idx ? peeri : INDEX_INVALID;
 789         }
 790
 791     next:
 792       n_left_from -= 1;
 793       b += 1;
 794     }
 795
 796   /* decrypt packets */
 797   wg_input_process_ops (vm, node, ptd->crypto_ops, data_bufs, data_nexts,
 798                         drop_next);
 799
 800   /* process after decryption */
 801   b = data_bufs;
 802   n_left_from = n_data;
 803   last_rec_idx = ~0;
 804   last_peer_time_idx = NULL;
 805
 806   while (n_left_from > 0)
 807     {
 808       bool is_keepalive = false;
 809       u32 *peer_idx = NULL;
 810
 811       if (PREDICT_FALSE (data_next[0] == WG_INPUT_NEXT_PUNT))
 812         {
 813           goto trace;
 814         }
 815       if (n_left_from > 2)
 816         {
 817           u8 *p;
 818           vlib_prefetch_buffer_header (b[2], LOAD);
 819           p = vlib_buffer_get_current (b[1]);
 820           CLIB_PREFETCH (p, CLIB_CACHE_LINE_BYTES, LOAD);
 821           CLIB_PREFETCH (vlib_buffer_get_tail (b[1]), CLIB_CACHE_LINE_BYTES,
 822                          LOAD);
 823         }
 824
 825       message_data_t *data = vlib_buffer_get_current (b[0]);
 826       ip46_address_t out_src_ip;
 827       u16 out_udp_src_port;
 828
 829       wg_find_outer_addr_port (b[0], &out_src_ip, &out_udp_src_port, is_ip4);
 830
 831       if (data->receiver_index != last_rec_idx)
 832         {
 833           peer_idx =
 834             wg_index_table_lookup (&wmp->index_table, data->receiver_index);
 835           if (PREDICT_TRUE (peer_idx != NULL))
 836             {
 837               peeri = *peer_idx;
 838               peer = wg_peer_get (peeri);
 839               last_rec_idx = data->receiver_index;
 840             }
 841           else
 842             {
 843               peer = NULL;
 844               last_rec_idx = ~0;
 845             }
 846         }
 847
 848       if (PREDICT_TRUE (peer != NULL))
 849         {
 850           if (PREDICT_FALSE (wg_input_post_process (vm, b[0], data_next, peer,
 851                                                     data, &is_keepalive) < 0))
 852             goto trace;
 853         }
 854       else
 855         {
 856           data_next[0] = WG_INPUT_NEXT_PUNT;
 857           goto trace;
 858         }
 859
 860       if (PREDICT_FALSE (peer_idx && (last_peer_time_idx != peer_idx)))
 861         {
 862           if (PREDICT_FALSE (
 863                 !ip46_address_is_equal (&peer->dst.addr, &out_src_ip) ||
 864                 peer->dst.port != out_udp_src_port))
 865             wg_peer_update_endpoint_from_mt (peeri, &out_src_ip,
 866                                              out_udp_src_port);
 867           wg_timers_any_authenticated_packet_received_opt (peer, time);
 868           wg_timers_any_authenticated_packet_traversal (peer);
 869           wg_peer_update_flags (*peer_idx, WG_PEER_ESTABLISHED, true);
 870           last_peer_time_idx = peer_idx;
 871         }
 872
 873       vlib_increment_combined_counter (im->combined_sw_if_counters +
 874                                          VNET_INTERFACE_COUNTER_RX,
 875                                        vm->thread_index, peer->wg_sw_if_index,
 876                                        1 /* packets */, b[0]->current_length);
 877
 878     trace:
 879       if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE) &&
 880                          (b[0]->flags & VLIB_BUFFER_IS_TRACED)))
 881         {
 882           wg_input_trace_t *t = vlib_add_trace (vm, node, b[0], sizeof (*t));
 883           t->type = header_type;
 884           t->current_length = b[0]->current_length;
 885           t->is_keepalive = is_keepalive;
 886           t->peer = peer_idx ? peeri : INDEX_INVALID;
 887         }
 888
 889       b += 1;
 890       n_left_from -= 1;
 891       data_next += 1;
 892     }
 893
 894   if (n_async)
 895     {
 896       /* submit all of the open frames */
 897       vnet_crypto_async_frame_t **async_frame;
 898       vec_foreach (async_frame, ptd->async_frames)
 899         {
 900           if (PREDICT_FALSE (
 901                 vnet_crypto_async_submit_open_frame (vm, *async_frame) < 0))
 902             {
 903               u32 n_drop = (*async_frame)->n_elts;
 904               u32 *bi = (*async_frame)->buffer_indices;
 905               u16 index = n_other;
 906               while (n_drop--)
 907                 {
 908                   other_bi[index] = bi[0];
 909                   vlib_buffer_t *b = vlib_get_buffer (vm, bi[0]);
 910                   other_nexts[index] = drop_next;
 911                   b->error = node->errors[WG_INPUT_ERROR_CRYPTO_ENGINE_ERROR];
 912                   bi++;
 913                   index++;
 914                 }
 915               n_other += (*async_frame)->n_elts;
 916
 917               vnet_crypto_async_reset_frame (*async_frame);
 918               vnet_crypto_async_free_frame (vm, *async_frame);
 919             }
 920         }
 921     }
 922
 923   /* enqueue other bufs */
 924   if (n_other)
 925     vlib_buffer_enqueue_to_next (vm, node, other_bi, other_next, n_other);
 926
 927   /* enqueue data bufs */
 928   if (n_data)
 929     vlib_buffer_enqueue_to_next (vm, node, data_bi, data_nexts, n_data);
 930
 931   return frame->n_vectors;
 932 }
 933
 934 always_inline uword
 935 wg_input_post (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame,
 936                u8 is_ip4)
 937 {
 938   vnet_main_t *vnm = vnet_get_main ();
 939   vnet_interface_main_t *im = &vnm->interface_main;
 940   wg_main_t *wmp = &wg_main;
 941   vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
 942   u16 nexts[VLIB_FRAME_SIZE], *next = nexts;
 943   u32 *from = vlib_frame_vector_args (frame);
 944   u32 n_left = frame->n_vectors;
 945   wg_peer_t *peer = NULL;
 946   u32 *peer_idx = NULL;
 947   u32 *last_peer_time_idx = NULL;
 948   index_t peeri = INDEX_INVALID;
 949   u32 last_rec_idx = ~0;
 950   f64 time = clib_time_now (&vm->clib_time) + vm->time_offset;
 951
 952   vlib_get_buffers (vm, from, b, n_left);
 953
 954   if (n_left >= 2)
 955     {
 956       vlib_prefetch_buffer_header (b[0], LOAD);
 957       vlib_prefetch_buffer_header (b[1], LOAD);
 958     }
 959
 960   while (n_left > 0)
 961     {
 962       if (n_left > 2)
 963         {
 964           u8 *p;
 965           vlib_prefetch_buffer_header (b[2], LOAD);
 966           p = vlib_buffer_get_current (b[1]);
 967           CLIB_PREFETCH (p, CLIB_CACHE_LINE_BYTES, LOAD);
 968         }
 969
 970       bool is_keepalive = false;
 971       message_data_t *data = vlib_buffer_get_current (b[0]);
 972       ip46_address_t out_src_ip;
 973       u16 out_udp_src_port;
 974
 975       wg_find_outer_addr_port (b[0], &out_src_ip, &out_udp_src_port, is_ip4);
 976
 977       if (data->receiver_index != last_rec_idx)
 978         {
 979           peer_idx =
 980             wg_index_table_lookup (&wmp->index_table, data->receiver_index);
 981
 982           if (PREDICT_TRUE (peer_idx != NULL))
 983             {
 984               peeri = *peer_idx;
 985               peer = wg_peer_get (peeri);
 986               last_rec_idx = data->receiver_index;
 987             }
 988           else
 989             {
 990               peer = NULL;
 991               last_rec_idx = ~0;
 992             }
 993         }
 994
 995       if (PREDICT_TRUE (peer != NULL))
 996         {
 997           if (PREDICT_FALSE (wg_input_post_process (vm, b[0], next, peer, data,
 998                                                     &is_keepalive) < 0))
 999             goto trace;
1000         }
1001       else
1002         {
1003           next[0] = WG_INPUT_NEXT_PUNT;
1004           goto trace;
1005         }
1006
1007       if (PREDICT_FALSE (peer_idx && (last_peer_time_idx != peer_idx)))
1008         {
1009           if (PREDICT_FALSE (
1010                 !ip46_address_is_equal (&peer->dst.addr, &out_src_ip) ||
1011                 peer->dst.port != out_udp_src_port))
1012             wg_peer_update_endpoint_from_mt (peeri, &out_src_ip,
1013                                              out_udp_src_port);
1014           wg_timers_any_authenticated_packet_received_opt (peer, time);
1015           wg_timers_any_authenticated_packet_traversal (peer);
1016           wg_peer_update_flags (*peer_idx, WG_PEER_ESTABLISHED, true);
1017           last_peer_time_idx = peer_idx;
1018         }
1019
1020       vlib_increment_combined_counter (im->combined_sw_if_counters +
1021                                          VNET_INTERFACE_COUNTER_RX,
1022                                        vm->thread_index, peer->wg_sw_if_index,
1023                                        1 /* packets */, b[0]->current_length);
1024
1025     trace:
1026       if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE) &&
1027                          (b[0]->flags & VLIB_BUFFER_IS_TRACED)))
1028         {
1029           wg_input_post_trace_t *t =
1030             vlib_add_trace (vm, node, b[0], sizeof (*t));
1031           t->next = next[0];
1032           t->peer = peer_idx ? peeri : INDEX_INVALID;
1033         }
1034
1035       b += 1;
1036       next += 1;
1037       n_left -= 1;
1038     }
1039
1040   vlib_buffer_enqueue_to_next (vm, node, from, nexts, frame->n_vectors);
1041   return frame->n_vectors;
1042 }
1043
1044 VLIB_NODE_FN (wg4_input_node)
1045 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
1046 {
1047   return wg_input_inline (vm, node, frame, /* is_ip4 */ 1,
1048                           wg_decrypt_async_next.wg4_post_next);
1049 }
1050
1051 VLIB_NODE_FN (wg6_input_node)
1052 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
1053 {
1054   return wg_input_inline (vm, node, frame, /* is_ip4 */ 0,
1055                           wg_decrypt_async_next.wg6_post_next);
1056 }
1057
1058 VLIB_NODE_FN (wg4_input_post_node)
1059 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *from_frame)
1060 {
1061   return wg_input_post (vm, node, from_frame, /* is_ip4 */ 1);
1062 }
1063
1064 VLIB_NODE_FN (wg6_input_post_node)
1065 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *from_frame)
1066 {
1067   return wg_input_post (vm, node, from_frame, /* is_ip4 */ 0);
1068 }
1069
1070 /* *INDENT-OFF* */
1071 VLIB_REGISTER_NODE (wg4_input_node) =
1072 {
1073   .name = "wg4-input",
1074   .vector_size = sizeof (u32),
1075   .format_trace = format_wg_input_trace,
1076   .type = VLIB_NODE_TYPE_INTERNAL,
1077   .n_errors = ARRAY_LEN (wg_input_error_strings),
1078   .error_strings = wg_input_error_strings,
1079   .n_next_nodes = WG_INPUT_N_NEXT,
1080   /* edit / add dispositions here */
1081   .next_nodes = {
1082         [WG_INPUT_NEXT_HANDOFF_HANDSHAKE] = "wg4-handshake-handoff",
1083         [WG_INPUT_NEXT_HANDOFF_DATA] = "wg4-input-data-handoff",
1084         [WG_INPUT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
1085         [WG_INPUT_NEXT_IP6_INPUT] = "ip6-input",
1086         [WG_INPUT_NEXT_PUNT] = "error-punt",
1087         [WG_INPUT_NEXT_ERROR] = "error-drop",
1088   },
1089 };
1090
1091 VLIB_REGISTER_NODE (wg6_input_node) =
1092 {
1093   .name = "wg6-input",
1094   .vector_size = sizeof (u32),
1095   .format_trace = format_wg_input_trace,
1096   .type = VLIB_NODE_TYPE_INTERNAL,
1097   .n_errors = ARRAY_LEN (wg_input_error_strings),
1098   .error_strings = wg_input_error_strings,
1099   .n_next_nodes = WG_INPUT_N_NEXT,
1100   /* edit / add dispositions here */
1101   .next_nodes = {
1102         [WG_INPUT_NEXT_HANDOFF_HANDSHAKE] = "wg6-handshake-handoff",
1103         [WG_INPUT_NEXT_HANDOFF_DATA] = "wg6-input-data-handoff",
1104         [WG_INPUT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
1105         [WG_INPUT_NEXT_IP6_INPUT] = "ip6-input",
1106         [WG_INPUT_NEXT_PUNT] = "error-punt",
1107         [WG_INPUT_NEXT_ERROR] = "error-drop",
1108   },
1109 };
1110
1111 VLIB_REGISTER_NODE (wg4_input_post_node) = {
1112   .name = "wg4-input-post-node",
1113   .vector_size = sizeof (u32),
1114   .format_trace = format_wg_input_post_trace,
1115   .type = VLIB_NODE_TYPE_INTERNAL,
1116   .sibling_of = "wg4-input",
1117
1118   .n_errors = ARRAY_LEN (wg_input_error_strings),
1119   .error_strings = wg_input_error_strings,
1120 };
1121
1122 VLIB_REGISTER_NODE (wg6_input_post_node) = {
1123   .name = "wg6-input-post-node",
1124   .vector_size = sizeof (u32),
1125   .format_trace = format_wg_input_post_trace,
1126   .type = VLIB_NODE_TYPE_INTERNAL,
1127   .sibling_of = "wg6-input",
1128
1129   .n_errors = ARRAY_LEN (wg_input_error_strings),
1130   .error_strings = wg_input_error_strings,
1131 };
1132
1133 /* *INDENT-ON* */
1134
1135 /*
1136  * fd.io coding-style-patch-verification: ON
1137  *
1138  * Local Variables:
1139  * eval: (c-set-style "gnu")
1140  * End:
1141  */