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   _ (PEER, "Peer error")                                                      \
  29   _ (INTERFACE, "Interface error")                                            \
  30   _ (DECRYPTION, "Failed during decryption")                                  \
  31   _ (KEEPALIVE_SEND, "Failed while sending Keepalive")                        \
  32   _ (HANDSHAKE_SEND, "Failed while sending Handshake")                        \
  33   _ (HANDSHAKE_RECEIVE, "Failed while receiving Handshake")                   \
  34   _ (TOO_BIG, "Packet too big")                                               \
  35   _ (UNDEFINED, "Undefined error")
  36
  37 typedef enum
  38 {
  39 #define _(sym,str) WG_INPUT_ERROR_##sym,
  40   foreach_wg_input_error
  41 #undef _
  42     WG_INPUT_N_ERROR,
  43 } wg_input_error_t;
  44
  45 static char *wg_input_error_strings[] = {
  46 #define _(sym,string) string,
  47   foreach_wg_input_error
  48 #undef _
  49 };
  50
  51 typedef struct
  52 {
  53   message_type_t type;
  54   u16 current_length;
  55   bool is_keepalive;
  56   index_t peer;
  57 } wg_input_trace_t;
  58
  59 u8 *
  60 format_wg_message_type (u8 * s, va_list * args)
  61 {
  62   message_type_t type = va_arg (*args, message_type_t);
  63
  64   switch (type)
  65     {
  66 #define _(v,a) case MESSAGE_##v: return (format (s, "%s", a));
  67       foreach_wg_message_type
  68 #undef _
  69     }
  70   return (format (s, "unknown"));
  71 }
  72
  73 /* packet trace format function */
  74 static u8 *
  75 format_wg_input_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
  80   wg_input_trace_t *t = va_arg (*args, wg_input_trace_t *);
  81
  82   s = format (s, "Wireguard input: \n");
  83   s = format (s, "    Type: %U\n", format_wg_message_type, t->type);
  84   s = format (s, "    Peer: %d\n", t->peer);
  85   s = format (s, "    Length: %d\n", t->current_length);
  86   s = format (s, "    Keepalive: %s", t->is_keepalive ? "true" : "false");
  87
  88   return s;
  89 }
  90
  91 typedef enum
  92 {
  93   WG_INPUT_NEXT_HANDOFF_HANDSHAKE,
  94   WG_INPUT_NEXT_HANDOFF_DATA,
  95   WG_INPUT_NEXT_IP4_INPUT,
  96   WG_INPUT_NEXT_IP6_INPUT,
  97   WG_INPUT_NEXT_PUNT,
  98   WG_INPUT_NEXT_ERROR,
  99   WG_INPUT_N_NEXT,
 100 } wg_input_next_t;
 101
 102 /* static void */
 103 /* set_peer_address (wg_peer_t * peer, ip4_address_t ip4, u16 udp_port) */
 104 /* { */
 105 /*   if (peer) */
 106 /*     { */
 107 /*       ip46_address_set_ip4 (&peer->dst.addr, &ip4); */
 108 /*       peer->dst.port = udp_port; */
 109 /*     } */
 110 /* } */
 111
 112 static u8
 113 is_ip4_header (u8 *data)
 114 {
 115   return (data[0] >> 4) == 0x4;
 116 }
 117
 118 static wg_input_error_t
 119 wg_handshake_process (vlib_main_t *vm, wg_main_t *wmp, vlib_buffer_t *b,
 120                       u32 node_idx, u8 is_ip4)
 121 {
 122   ASSERT (vm->thread_index == 0);
 123
 124   enum cookie_mac_state mac_state;
 125   bool packet_needs_cookie;
 126   bool under_load;
 127   index_t *wg_ifs;
 128   wg_if_t *wg_if;
 129   wg_peer_t *peer = NULL;
 130
 131   void *current_b_data = vlib_buffer_get_current (b);
 132
 133   ip46_address_t src_ip;
 134   if (is_ip4)
 135     {
 136       ip4_header_t *iph4 =
 137         current_b_data - sizeof (udp_header_t) - sizeof (ip4_header_t);
 138       ip46_address_set_ip4 (&src_ip, &iph4->src_address);
 139     }
 140   else
 141     {
 142       ip6_header_t *iph6 =
 143         current_b_data - sizeof (udp_header_t) - sizeof (ip6_header_t);
 144       ip46_address_set_ip6 (&src_ip, &iph6->src_address);
 145     }
 146
 147   udp_header_t *uhd = current_b_data - sizeof (udp_header_t);
 148   u16 udp_src_port = clib_host_to_net_u16 (uhd->src_port);;
 149   u16 udp_dst_port = clib_host_to_net_u16 (uhd->dst_port);;
 150
 151   message_header_t *header = current_b_data;
 152   under_load = false;
 153
 154   if (PREDICT_FALSE (header->type == MESSAGE_HANDSHAKE_COOKIE))
 155     {
 156       message_handshake_cookie_t *packet =
 157         (message_handshake_cookie_t *) current_b_data;
 158       u32 *entry =
 159         wg_index_table_lookup (&wmp->index_table, packet->receiver_index);
 160       if (entry)
 161         peer = wg_peer_get (*entry);
 162       else
 163         return WG_INPUT_ERROR_PEER;
 164
 165       // TODO: Implement cookie_maker_consume_payload
 166
 167       return WG_INPUT_ERROR_NONE;
 168     }
 169
 170   u32 len = (header->type == MESSAGE_HANDSHAKE_INITIATION ?
 171              sizeof (message_handshake_initiation_t) :
 172              sizeof (message_handshake_response_t));
 173
 174   message_macs_t *macs = (message_macs_t *)
 175     ((u8 *) current_b_data + len - sizeof (*macs));
 176
 177   index_t *ii;
 178   wg_ifs = wg_if_indexes_get_by_port (udp_dst_port);
 179   if (NULL == wg_ifs)
 180     return WG_INPUT_ERROR_INTERFACE;
 181
 182   vec_foreach (ii, wg_ifs)
 183     {
 184       wg_if = wg_if_get (*ii);
 185       if (NULL == wg_if)
 186         continue;
 187
 188       mac_state = cookie_checker_validate_macs (
 189         vm, &wg_if->cookie_checker, macs, current_b_data, len, under_load,
 190         &src_ip, udp_src_port);
 191       if (mac_state == INVALID_MAC)
 192         {
 193           wg_if = NULL;
 194           continue;
 195         }
 196       break;
 197     }
 198
 199   if (NULL == wg_if)
 200     return WG_INPUT_ERROR_HANDSHAKE_MAC;
 201
 202   if ((under_load && mac_state == VALID_MAC_WITH_COOKIE)
 203       || (!under_load && mac_state == VALID_MAC_BUT_NO_COOKIE))
 204     packet_needs_cookie = false;
 205   else if (under_load && mac_state == VALID_MAC_BUT_NO_COOKIE)
 206     packet_needs_cookie = true;
 207   else
 208     return WG_INPUT_ERROR_HANDSHAKE_MAC;
 209
 210   switch (header->type)
 211     {
 212     case MESSAGE_HANDSHAKE_INITIATION:
 213       {
 214         message_handshake_initiation_t *message = current_b_data;
 215
 216         if (packet_needs_cookie)
 217           {
 218             // TODO: Add processing
 219           }
 220         noise_remote_t *rp;
 221         if (noise_consume_initiation
 222             (vm, noise_local_get (wg_if->local_idx), &rp,
 223              message->sender_index, message->unencrypted_ephemeral,
 224              message->encrypted_static, message->encrypted_timestamp))
 225           {
 226             peer = wg_peer_get (rp->r_peer_idx);
 227           }
 228         else
 229           {
 230             return WG_INPUT_ERROR_PEER;
 231           }
 232
 233         // set_peer_address (peer, ip4_src, udp_src_port);
 234         if (PREDICT_FALSE (!wg_send_handshake_response (vm, peer)))
 235           {
 236             vlib_node_increment_counter (vm, node_idx,
 237                                          WG_INPUT_ERROR_HANDSHAKE_SEND, 1);
 238           }
 239         else
 240           {
 241             wg_peer_update_flags (rp->r_peer_idx, WG_PEER_ESTABLISHED, true);
 242           }
 243         break;
 244       }
 245     case MESSAGE_HANDSHAKE_RESPONSE:
 246       {
 247         message_handshake_response_t *resp = current_b_data;
 248         u32 *entry =
 249           wg_index_table_lookup (&wmp->index_table, resp->receiver_index);
 250
 251         if (PREDICT_TRUE (entry != NULL))
 252           {
 253             peer = wg_peer_get (*entry);
 254             if (wg_peer_is_dead (peer))
 255               return WG_INPUT_ERROR_PEER;
 256           }
 257         else
 258           return WG_INPUT_ERROR_PEER;
 259
 260         if (!noise_consume_response
 261             (vm, &peer->remote, resp->sender_index,
 262              resp->receiver_index, resp->unencrypted_ephemeral,
 263              resp->encrypted_nothing))
 264           {
 265             return WG_INPUT_ERROR_PEER;
 266           }
 267         if (packet_needs_cookie)
 268           {
 269             // TODO: Add processing
 270           }
 271
 272         // set_peer_address (peer, ip4_src, udp_src_port);
 273         if (noise_remote_begin_session (vm, &peer->remote))
 274           {
 275
 276             wg_timers_session_derived (peer);
 277             wg_timers_handshake_complete (peer);
 278             if (PREDICT_FALSE (!wg_send_keepalive (vm, peer)))
 279               {
 280                 vlib_node_increment_counter (vm, node_idx,
 281                                              WG_INPUT_ERROR_KEEPALIVE_SEND, 1);
 282               }
 283             else
 284               {
 285                 wg_peer_update_flags (*entry, WG_PEER_ESTABLISHED, true);
 286               }
 287           }
 288         break;
 289       }
 290     default:
 291       return WG_INPUT_ERROR_HANDSHAKE_RECEIVE;
 292     }
 293
 294   wg_timers_any_authenticated_packet_received (peer);
 295   wg_timers_any_authenticated_packet_traversal (peer);
 296   return WG_INPUT_ERROR_NONE;
 297 }
 298
 299 always_inline uword
 300 wg_input_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
 301                  vlib_frame_t *frame, u8 is_ip4)
 302 {
 303   message_type_t header_type;
 304   u32 n_left_from;
 305   u32 *from;
 306   vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
 307   u16 nexts[VLIB_FRAME_SIZE], *next;
 308   u32 thread_index = vm->thread_index;
 309
 310   from = vlib_frame_vector_args (frame);
 311   n_left_from = frame->n_vectors;
 312   b = bufs;
 313   next = nexts;
 314
 315   vlib_get_buffers (vm, from, bufs, n_left_from);
 316
 317   wg_main_t *wmp = &wg_main;
 318   wg_peer_t *peer = NULL;
 319
 320   while (n_left_from > 0)
 321     {
 322       bool is_keepalive = false;
 323       next[0] = WG_INPUT_NEXT_PUNT;
 324       header_type =
 325         ((message_header_t *) vlib_buffer_get_current (b[0]))->type;
 326       u32 *peer_idx;
 327
 328       if (PREDICT_TRUE (header_type == MESSAGE_DATA))
 329         {
 330           message_data_t *data = vlib_buffer_get_current (b[0]);
 331
 332           peer_idx = wg_index_table_lookup (&wmp->index_table,
 333                                             data->receiver_index);
 334
 335           if (peer_idx)
 336             {
 337               peer = wg_peer_get (*peer_idx);
 338             }
 339           else
 340             {
 341               next[0] = WG_INPUT_NEXT_ERROR;
 342               b[0]->error = node->errors[WG_INPUT_ERROR_PEER];
 343               goto out;
 344             }
 345
 346           if (PREDICT_FALSE (~0 == peer->input_thread_index))
 347             {
 348               /* this is the first packet to use this peer, claim the peer
 349                * for this thread.
 350                */
 351               clib_atomic_cmp_and_swap (&peer->input_thread_index, ~0,
 352                                         wg_peer_assign_thread (thread_index));
 353             }
 354
 355           if (PREDICT_TRUE (thread_index != peer->input_thread_index))
 356             {
 357               next[0] = WG_INPUT_NEXT_HANDOFF_DATA;
 358               goto next;
 359             }
 360
 361           u16 encr_len = b[0]->current_length - sizeof (message_data_t);
 362           u16 decr_len = encr_len - NOISE_AUTHTAG_LEN;
 363           if (PREDICT_FALSE (decr_len >= WG_DEFAULT_DATA_SIZE))
 364             {
 365               b[0]->error = node->errors[WG_INPUT_ERROR_TOO_BIG];
 366               goto out;
 367             }
 368
 369           u8 *decr_data = wmp->per_thread_data[thread_index].data;
 370
 371           enum noise_state_crypt state_cr = noise_remote_decrypt (vm,
 372                                                                   &peer->remote,
 373                                                                   data->receiver_index,
 374                                                                   data->counter,
 375                                                                   data->encrypted_data,
 376                                                                   encr_len,
 377                                                                   decr_data);
 378
 379           if (PREDICT_FALSE (state_cr == SC_CONN_RESET))
 380             {
 381               wg_timers_handshake_complete (peer);
 382             }
 383           else if (PREDICT_FALSE (state_cr == SC_KEEP_KEY_FRESH))
 384             {
 385               wg_send_handshake_from_mt (*peer_idx, false);
 386             }
 387           else if (PREDICT_FALSE (state_cr == SC_FAILED))
 388             {
 389               wg_peer_update_flags (*peer_idx, WG_PEER_ESTABLISHED, false);
 390               next[0] = WG_INPUT_NEXT_ERROR;
 391               b[0]->error = node->errors[WG_INPUT_ERROR_DECRYPTION];
 392               goto out;
 393             }
 394
 395           clib_memcpy (vlib_buffer_get_current (b[0]), decr_data, decr_len);
 396           b[0]->current_length = decr_len;
 397           vnet_buffer_offload_flags_clear (b[0],
 398                                            VNET_BUFFER_OFFLOAD_F_UDP_CKSUM);
 399
 400           wg_timers_any_authenticated_packet_received (peer);
 401           wg_timers_any_authenticated_packet_traversal (peer);
 402
 403           /* Keepalive packet has zero length */
 404           if (decr_len == 0)
 405             {
 406               is_keepalive = true;
 407               goto out;
 408             }
 409
 410           wg_timers_data_received (peer);
 411
 412           ip46_address_t src_ip;
 413           u8 is_ip4_inner = is_ip4_header (vlib_buffer_get_current (b[0]));
 414           if (is_ip4_inner)
 415             {
 416               ip46_address_set_ip4 (
 417                 &src_ip, &((ip4_header_t *) vlib_buffer_get_current (b[0]))
 418                             ->src_address);
 419             }
 420           else
 421             {
 422               ip46_address_set_ip6 (
 423                 &src_ip, &((ip6_header_t *) vlib_buffer_get_current (b[0]))
 424                             ->src_address);
 425             }
 426
 427           const fib_prefix_t *allowed_ip;
 428           bool allowed = false;
 429
 430           /*
 431            * we could make this into an ACL, but the expectation
 432            * is that there aren't many allowed IPs and thus a linear
 433            * walk is fater than an ACL
 434            */
 435
 436           vec_foreach (allowed_ip, peer->allowed_ips)
 437           {
 438             if (fib_prefix_is_cover_addr_46 (allowed_ip, &src_ip))
 439               {
 440                 allowed = true;
 441                 break;
 442               }
 443           }
 444           if (allowed)
 445             {
 446               vnet_buffer (b[0])->sw_if_index[VLIB_RX] = peer->wg_sw_if_index;
 447               next[0] = is_ip4_inner ? WG_INPUT_NEXT_IP4_INPUT :
 448                                        WG_INPUT_NEXT_IP6_INPUT;
 449             }
 450         }
 451       else
 452         {
 453           peer_idx = NULL;
 454
 455           /* Handshake packets should be processed in main thread */
 456           if (thread_index != 0)
 457             {
 458               next[0] = WG_INPUT_NEXT_HANDOFF_HANDSHAKE;
 459               goto next;
 460             }
 461
 462           wg_input_error_t ret =
 463             wg_handshake_process (vm, wmp, b[0], node->node_index, is_ip4);
 464           if (ret != WG_INPUT_ERROR_NONE)
 465             {
 466               next[0] = WG_INPUT_NEXT_ERROR;
 467               b[0]->error = node->errors[ret];
 468             }
 469         }
 470
 471     out:
 472       if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
 473                          && (b[0]->flags & VLIB_BUFFER_IS_TRACED)))
 474         {
 475           wg_input_trace_t *t = vlib_add_trace (vm, node, b[0], sizeof (*t));
 476           t->type = header_type;
 477           t->current_length = b[0]->current_length;
 478           t->is_keepalive = is_keepalive;
 479           t->peer = peer_idx ? *peer_idx : INDEX_INVALID;
 480         }
 481     next:
 482       n_left_from -= 1;
 483       next += 1;
 484       b += 1;
 485     }
 486   vlib_buffer_enqueue_to_next (vm, node, from, nexts, frame->n_vectors);
 487
 488   return frame->n_vectors;
 489 }
 490
 491 VLIB_NODE_FN (wg4_input_node)
 492 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
 493 {
 494   return wg_input_inline (vm, node, frame, /* is_ip4 */ 1);
 495 }
 496
 497 VLIB_NODE_FN (wg6_input_node)
 498 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
 499 {
 500   return wg_input_inline (vm, node, frame, /* is_ip4 */ 0);
 501 }
 502
 503 /* *INDENT-OFF* */
 504 VLIB_REGISTER_NODE (wg4_input_node) =
 505 {
 506   .name = "wg4-input",
 507   .vector_size = sizeof (u32),
 508   .format_trace = format_wg_input_trace,
 509   .type = VLIB_NODE_TYPE_INTERNAL,
 510   .n_errors = ARRAY_LEN (wg_input_error_strings),
 511   .error_strings = wg_input_error_strings,
 512   .n_next_nodes = WG_INPUT_N_NEXT,
 513   /* edit / add dispositions here */
 514   .next_nodes = {
 515         [WG_INPUT_NEXT_HANDOFF_HANDSHAKE] = "wg4-handshake-handoff",
 516         [WG_INPUT_NEXT_HANDOFF_DATA] = "wg4-input-data-handoff",
 517         [WG_INPUT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
 518         [WG_INPUT_NEXT_IP6_INPUT] = "ip6-input",
 519         [WG_INPUT_NEXT_PUNT] = "error-punt",
 520         [WG_INPUT_NEXT_ERROR] = "error-drop",
 521   },
 522 };
 523
 524 VLIB_REGISTER_NODE (wg6_input_node) =
 525 {
 526   .name = "wg6-input",
 527   .vector_size = sizeof (u32),
 528   .format_trace = format_wg_input_trace,
 529   .type = VLIB_NODE_TYPE_INTERNAL,
 530   .n_errors = ARRAY_LEN (wg_input_error_strings),
 531   .error_strings = wg_input_error_strings,
 532   .n_next_nodes = WG_INPUT_N_NEXT,
 533   /* edit / add dispositions here */
 534   .next_nodes = {
 535         [WG_INPUT_NEXT_HANDOFF_HANDSHAKE] = "wg6-handshake-handoff",
 536         [WG_INPUT_NEXT_HANDOFF_DATA] = "wg6-input-data-handoff",
 537         [WG_INPUT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
 538         [WG_INPUT_NEXT_IP6_INPUT] = "ip6-input",
 539         [WG_INPUT_NEXT_PUNT] = "error-punt",
 540         [WG_INPUT_NEXT_ERROR] = "error-drop",
 541   },
 542 };
 543 /* *INDENT-ON* */
 544
 545 /*
 546  * fd.io coding-style-patch-verification: ON
 547  *
 548  * Local Variables:
 549  * eval: (c-set-style "gnu")
 550  * End:
 551  */