src/plugins/wireguard/wireguard_peer.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 <vnet/adj/adj_midchain.h>
  18 #include <vnet/fib/fib_table.h>
  19 #include <wireguard/wireguard_peer.h>
  20 #include <wireguard/wireguard_if.h>
  21 #include <wireguard/wireguard_messages.h>
  22 #include <wireguard/wireguard_key.h>
  23 #include <wireguard/wireguard_send.h>
  24 #include <wireguard/wireguard.h>
  25 #include <vnet/tunnel/tunnel_dp.h>
  26
  27 wg_peer_t *wg_peer_pool;
  28
  29 index_t *wg_peer_by_adj_index;
  30
  31 static void
  32 wg_peer_endpoint_reset (wg_peer_endpoint_t * ep)
  33 {
  34   ip46_address_reset (&ep->addr);
  35   ep->port = 0;
  36 }
  37
  38 static void
  39 wg_peer_endpoint_init (wg_peer_endpoint_t *ep, const ip46_address_t *addr,
  40                        u16 port)
  41 {
  42   ip46_address_copy (&ep->addr, addr);
  43   ep->port = port;
  44 }
  45
  46 static void
  47 wg_peer_clear (vlib_main_t * vm, wg_peer_t * peer)
  48 {
  49   index_t perri = peer - wg_peer_pool;
  50   wg_timers_stop (peer);
  51   wg_peer_update_flags (perri, WG_PEER_ESTABLISHED, false);
  52   wg_peer_update_flags (perri, WG_PEER_STATUS_DEAD, true);
  53   for (int i = 0; i < WG_N_TIMERS; i++)
  54     {
  55       peer->timers[i] = ~0;
  56       peer->timers_dispatched[i] = 0;
  57     }
  58
  59   peer->last_sent_handshake = vlib_time_now (vm) - (REKEY_TIMEOUT + 1);
  60
  61   clib_memset (&peer->cookie_maker, 0, sizeof (peer->cookie_maker));
  62
  63   wg_peer_endpoint_reset (&peer->src);
  64   wg_peer_endpoint_reset (&peer->dst);
  65
  66   adj_index_t *adj_index;
  67   vec_foreach (adj_index, peer->adj_indices)
  68     {
  69       wg_peer_by_adj_index[*adj_index] = INDEX_INVALID;
  70
  71       if (adj_is_valid (*adj_index))
  72         adj_midchain_delegate_unstack (*adj_index);
  73     }
  74   peer->input_thread_index = ~0;
  75   peer->output_thread_index = ~0;
  76   peer->timer_wheel = 0;
  77   peer->persistent_keepalive_interval = 0;
  78   peer->timer_handshake_attempts = 0;
  79   peer->last_sent_packet = 0;
  80   peer->last_received_packet = 0;
  81   peer->session_derived = 0;
  82   peer->rehandshake_started = 0;
  83   peer->new_handshake_interval_tick = 0;
  84   peer->rehandshake_interval_tick = 0;
  85   peer->timer_need_another_keepalive = false;
  86   peer->handshake_is_sent = false;
  87   vec_free (peer->rewrite);
  88   vec_free (peer->allowed_ips);
  89   vec_free (peer->adj_indices);
  90 }
  91
  92 static void
  93 wg_peer_init (vlib_main_t * vm, wg_peer_t * peer)
  94 {
  95   peer->api_client_by_client_index = hash_create (0, sizeof (u32));
  96   peer->api_clients = NULL;
  97   wg_peer_clear (vm, peer);
  98 }
  99
 100 static void
 101 wg_peer_adj_stack (wg_peer_t *peer, adj_index_t ai)
 102 {
 103   ip_adjacency_t *adj;
 104   u32 sw_if_index;
 105   wg_if_t *wgi;
 106   fib_protocol_t fib_proto;
 107
 108   if (!adj_is_valid (ai))
 109     return;
 110
 111   adj = adj_get (ai);
 112   sw_if_index = adj->rewrite_header.sw_if_index;
 113   u8 is_ip4 = ip46_address_is_ip4 (&peer->src.addr);
 114   fib_proto = is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
 115
 116   wgi = wg_if_get (wg_if_find_by_sw_if_index (sw_if_index));
 117
 118   if (!wgi)
 119     return;
 120
 121   if (!vnet_sw_interface_is_admin_up (vnet_get_main (), wgi->sw_if_index) ||
 122       !wg_peer_can_send (peer))
 123     {
 124       adj_midchain_delegate_unstack (ai);
 125     }
 126   else
 127     {
 128       /* *INDENT-OFF* */
 129       fib_prefix_t dst = {
 130         .fp_len = is_ip4 ? 32 : 128,
 131         .fp_proto = fib_proto,
 132         .fp_addr = peer->dst.addr,
 133       };
 134       /* *INDENT-ON* */
 135       u32 fib_index;
 136
 137       fib_index = fib_table_find (fib_proto, peer->table_id);
 138
 139       adj_midchain_delegate_stack (ai, fib_index, &dst);
 140     }
 141 }
 142
 143 static void
 144 wg_peer_adj_reset_stacking (adj_index_t ai)
 145 {
 146   adj_midchain_delegate_remove (ai);
 147 }
 148
 149 static void
 150 wg_peer_66_fixup (vlib_main_t *vm, const ip_adjacency_t *adj, vlib_buffer_t *b,
 151                   const void *data)
 152 {
 153   u8 iph_offset = 0;
 154   ip6_header_t *ip6_out;
 155   ip6_header_t *ip6_in;
 156
 157   /* Must set locally originated otherwise we're not allowed to
 158      fragment the packet later */
 159   b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
 160
 161   ip6_out = vlib_buffer_get_current (b);
 162   iph_offset = vnet_buffer (b)->ip.save_rewrite_length;
 163   ip6_in = vlib_buffer_get_current (b) + iph_offset;
 164
 165   ip6_out->ip_version_traffic_class_and_flow_label =
 166     ip6_in->ip_version_traffic_class_and_flow_label;
 167 }
 168
 169 static void
 170 wg_peer_46_fixup (vlib_main_t *vm, const ip_adjacency_t *adj, vlib_buffer_t *b,
 171                   const void *data)
 172 {
 173   u8 iph_offset = 0;
 174   ip6_header_t *ip6_out;
 175   ip4_header_t *ip4_in;
 176
 177   /* Must set locally originated otherwise we're not allowed to
 178      fragment the packet later */
 179   b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
 180
 181   ip6_out = vlib_buffer_get_current (b);
 182   iph_offset = vnet_buffer (b)->ip.save_rewrite_length;
 183   ip4_in = vlib_buffer_get_current (b) + iph_offset;
 184
 185   u32 vtcfl = 0x6 << 28;
 186   vtcfl |= ip4_in->tos << 20;
 187   vtcfl |= vnet_buffer (b)->ip.flow_hash & 0x000fffff;
 188
 189   ip6_out->ip_version_traffic_class_and_flow_label =
 190     clib_host_to_net_u32 (vtcfl);
 191 }
 192
 193 static adj_midchain_fixup_t
 194 wg_peer_get_fixup (wg_peer_t *peer, vnet_link_t lt)
 195 {
 196   if (!ip46_address_is_ip4 (&peer->dst.addr))
 197     {
 198       if (lt == VNET_LINK_IP4)
 199         return (wg_peer_46_fixup);
 200       if (lt == VNET_LINK_IP6)
 201         return (wg_peer_66_fixup);
 202     }
 203   return (NULL);
 204 }
 205
 206 static void
 207 wg_peer_disable (vlib_main_t *vm, wg_peer_t *peer)
 208 {
 209   index_t peeri = peer - wg_peer_pool;
 210
 211   wg_timers_stop (peer);
 212   wg_peer_update_flags (peeri, WG_PEER_ESTABLISHED, false);
 213
 214   for (int i = 0; i < WG_N_TIMERS; i++)
 215     {
 216       peer->timers[i] = ~0;
 217       peer->timers_dispatched[i] = 0;
 218     }
 219   peer->timer_handshake_attempts = 0;
 220
 221   peer->last_sent_handshake = vlib_time_now (vm) - (REKEY_TIMEOUT + 1);
 222   peer->last_sent_packet = 0;
 223   peer->last_received_packet = 0;
 224   peer->session_derived = 0;
 225   peer->rehandshake_started = 0;
 226
 227   peer->new_handshake_interval_tick = 0;
 228   peer->rehandshake_interval_tick = 0;
 229
 230   peer->timer_need_another_keepalive = false;
 231
 232   noise_remote_clear (vm, &peer->remote);
 233 }
 234
 235 static void
 236 wg_peer_enable (vlib_main_t *vm, wg_peer_t *peer)
 237 {
 238   index_t peeri = peer - wg_peer_pool;
 239   wg_if_t *wg_if;
 240   u8 public_key[NOISE_PUBLIC_KEY_LEN];
 241
 242   wg_if = wg_if_get (wg_if_find_by_sw_if_index (peer->wg_sw_if_index));
 243   clib_memcpy (public_key, peer->remote.r_public, NOISE_PUBLIC_KEY_LEN);
 244
 245   noise_remote_init (vm, &peer->remote, peeri, public_key, wg_if->local_idx);
 246
 247   wg_timers_send_first_handshake (peer);
 248 }
 249
 250 walk_rc_t
 251 wg_peer_if_admin_state_change (index_t peeri, void *data)
 252 {
 253   wg_peer_t *peer;
 254   adj_index_t *adj_index;
 255   vlib_main_t *vm = vlib_get_main ();
 256
 257   peer = wg_peer_get (peeri);
 258   vec_foreach (adj_index, peer->adj_indices)
 259     {
 260       wg_peer_adj_stack (peer, *adj_index);
 261     }
 262
 263   if (vnet_sw_interface_is_admin_up (vnet_get_main (), peer->wg_sw_if_index))
 264     {
 265       wg_peer_enable (vm, peer);
 266     }
 267   else
 268     {
 269       wg_peer_disable (vm, peer);
 270     }
 271
 272   return (WALK_CONTINUE);
 273 }
 274
 275 walk_rc_t
 276 wg_peer_if_adj_change (index_t peeri, void *data)
 277 {
 278   adj_index_t *adj_index = data;
 279   adj_midchain_fixup_t fixup;
 280   ip_adjacency_t *adj;
 281   wg_peer_t *peer;
 282   fib_prefix_t *allowed_ip;
 283
 284   adj = adj_get (*adj_index);
 285
 286   peer = wg_peer_get (peeri);
 287   vec_foreach (allowed_ip, peer->allowed_ips)
 288     {
 289       if (fib_prefix_is_cover_addr_46 (allowed_ip,
 290                                        &adj->sub_type.nbr.next_hop))
 291         {
 292           vec_add1 (peer->adj_indices, *adj_index);
 293
 294           vec_validate_init_empty (wg_peer_by_adj_index, *adj_index,
 295                                    INDEX_INVALID);
 296           wg_peer_by_adj_index[*adj_index] = peeri;
 297
 298           fixup = wg_peer_get_fixup (peer, adj_get_link_type (*adj_index));
 299           adj_nbr_midchain_update_rewrite (*adj_index, fixup, NULL,
 300                                            ADJ_FLAG_MIDCHAIN_IP_STACK,
 301                                            vec_dup (peer->rewrite));
 302
 303           wg_peer_adj_stack (peer, *adj_index);
 304           return (WALK_STOP);
 305         }
 306     }
 307
 308   return (WALK_CONTINUE);
 309 }
 310
 311 adj_walk_rc_t
 312 wg_peer_adj_walk (adj_index_t ai, void *data)
 313 {
 314   return wg_peer_if_adj_change ((*(index_t *) (data)), &ai) == WALK_CONTINUE ?
 315            ADJ_WALK_RC_CONTINUE :
 316            ADJ_WALK_RC_STOP;
 317 }
 318
 319 walk_rc_t
 320 wg_peer_if_delete (index_t peeri, void *data)
 321 {
 322   wg_peer_remove (peeri);
 323   return (WALK_CONTINUE);
 324 }
 325
 326 static int
 327 wg_peer_fill (vlib_main_t *vm, wg_peer_t *peer, u32 table_id,
 328               const ip46_address_t *dst, u16 port,
 329               u16 persistent_keepalive_interval,
 330               const fib_prefix_t *allowed_ips, u32 wg_sw_if_index)
 331 {
 332   index_t perri = peer - wg_peer_pool;
 333   wg_peer_endpoint_init (&peer->dst, dst, port);
 334
 335   peer->table_id = table_id;
 336   peer->wg_sw_if_index = wg_sw_if_index;
 337   peer->timer_wheel = &wg_main.timer_wheel;
 338   peer->persistent_keepalive_interval = persistent_keepalive_interval;
 339   peer->last_sent_handshake = vlib_time_now (vm) - (REKEY_TIMEOUT + 1);
 340   wg_peer_update_flags (perri, WG_PEER_STATUS_DEAD, false);
 341
 342   const wg_if_t *wgi = wg_if_get (wg_if_find_by_sw_if_index (wg_sw_if_index));
 343
 344   if (NULL == wgi)
 345     return (VNET_API_ERROR_INVALID_INTERFACE);
 346
 347   ip_address_to_46 (&wgi->src_ip, &peer->src.addr);
 348   peer->src.port = wgi->port;
 349
 350   u8 is_ip4 = ip46_address_is_ip4 (&peer->dst.addr);
 351   peer->rewrite = wg_build_rewrite (&peer->src.addr, peer->src.port,
 352                                     &peer->dst.addr, peer->dst.port, is_ip4);
 353
 354   u32 ii;
 355   vec_validate (peer->allowed_ips, vec_len (allowed_ips) - 1);
 356   vec_foreach_index (ii, allowed_ips)
 357   {
 358     peer->allowed_ips[ii] = allowed_ips[ii];
 359   }
 360
 361   fib_protocol_t proto;
 362   FOR_EACH_FIB_IP_PROTOCOL (proto)
 363   {
 364     adj_nbr_walk (wg_sw_if_index, proto, wg_peer_adj_walk, &perri);
 365   }
 366   return (0);
 367 }
 368
 369 void
 370 wg_peer_update_flags (index_t peeri, wg_peer_flags flag, bool add_del)
 371 {
 372   wg_peer_t *peer = wg_peer_get (peeri);
 373   if ((add_del && (peer->flags & flag)) || (!add_del && !(peer->flags & flag)))
 374     {
 375       return;
 376     }
 377
 378   peer->flags ^= flag;
 379   wg_api_peer_event (peeri, peer->flags);
 380 }
 381
 382 void
 383 wg_peer_update_endpoint (index_t peeri, const ip46_address_t *addr, u16 port)
 384 {
 385   wg_peer_t *peer = wg_peer_get (peeri);
 386
 387   if (ip46_address_is_equal (&peer->dst.addr, addr) && peer->dst.port == port)
 388     return;
 389
 390   wg_peer_endpoint_init (&peer->dst, addr, port);
 391
 392   u8 is_ip4 = ip46_address_is_ip4 (&peer->dst.addr);
 393   vec_free (peer->rewrite);
 394   peer->rewrite = wg_build_rewrite (&peer->src.addr, peer->src.port,
 395                                     &peer->dst.addr, peer->dst.port, is_ip4);
 396
 397   adj_index_t *adj_index;
 398   vec_foreach (adj_index, peer->adj_indices)
 399     {
 400       if (adj_is_valid (*adj_index))
 401         {
 402           adj_midchain_fixup_t fixup =
 403             wg_peer_get_fixup (peer, adj_get_link_type (*adj_index));
 404           adj_nbr_midchain_update_rewrite (*adj_index, fixup, NULL,
 405                                            ADJ_FLAG_MIDCHAIN_IP_STACK,
 406                                            vec_dup (peer->rewrite));
 407
 408           wg_peer_adj_reset_stacking (*adj_index);
 409           wg_peer_adj_stack (peer, *adj_index);
 410         }
 411     }
 412 }
 413
 414 typedef struct wg_peer_upd_ep_args_t_
 415 {
 416   index_t peeri;
 417   ip46_address_t addr;
 418   u16 port;
 419 } wg_peer_upd_ep_args_t;
 420
 421 static void
 422 wg_peer_update_endpoint_thread_fn (wg_peer_upd_ep_args_t *args)
 423 {
 424   wg_peer_update_endpoint (args->peeri, &args->addr, args->port);
 425 }
 426
 427 void
 428 wg_peer_update_endpoint_from_mt (index_t peeri, const ip46_address_t *addr,
 429                                  u16 port)
 430 {
 431   wg_peer_upd_ep_args_t args = {
 432     .peeri = peeri,
 433     .port = port,
 434   };
 435
 436   ip46_address_copy (&args.addr, addr);
 437   vlib_rpc_call_main_thread (wg_peer_update_endpoint_thread_fn, (u8 *) &args,
 438                              sizeof (args));
 439 }
 440
 441 int
 442 wg_peer_add (u32 tun_sw_if_index, const u8 public_key[NOISE_PUBLIC_KEY_LEN],
 443              u32 table_id, const ip46_address_t *endpoint,
 444              const fib_prefix_t *allowed_ips, u16 port,
 445              u16 persistent_keepalive, u32 *peer_index)
 446 {
 447   wg_if_t *wg_if;
 448   wg_peer_t *peer;
 449   int rv;
 450
 451   vlib_main_t *vm = vlib_get_main ();
 452
 453   if (tun_sw_if_index == ~0)
 454     return (VNET_API_ERROR_INVALID_SW_IF_INDEX);
 455
 456   wg_if = wg_if_get (wg_if_find_by_sw_if_index (tun_sw_if_index));
 457   if (!wg_if)
 458     return (VNET_API_ERROR_INVALID_SW_IF_INDEX);
 459
 460   /* *INDENT-OFF* */
 461   pool_foreach (peer, wg_peer_pool)
 462    {
 463     if (!memcmp (peer->remote.r_public, public_key, NOISE_PUBLIC_KEY_LEN))
 464     {
 465       return (VNET_API_ERROR_ENTRY_ALREADY_EXISTS);
 466     }
 467   }
 468   /* *INDENT-ON* */
 469
 470   if (pool_elts (wg_peer_pool) > MAX_PEERS)
 471     return (VNET_API_ERROR_LIMIT_EXCEEDED);
 472
 473   pool_get_zero (wg_peer_pool, peer);
 474
 475   wg_peer_init (vm, peer);
 476
 477   rv = wg_peer_fill (vm, peer, table_id, endpoint, (u16) port,
 478                      persistent_keepalive, allowed_ips, tun_sw_if_index);
 479
 480   if (rv)
 481     {
 482       wg_peer_clear (vm, peer);
 483       pool_put (wg_peer_pool, peer);
 484       return (rv);
 485     }
 486
 487   noise_remote_init (vm, &peer->remote, peer - wg_peer_pool, public_key,
 488                      wg_if->local_idx);
 489   cookie_maker_init (&peer->cookie_maker, public_key);
 490
 491   if (vnet_sw_interface_is_admin_up (vnet_get_main (), tun_sw_if_index))
 492     {
 493       wg_timers_send_first_handshake (peer);
 494     }
 495
 496   *peer_index = peer - wg_peer_pool;
 497   wg_if_peer_add (wg_if, *peer_index);
 498
 499   return (0);
 500 }
 501
 502 int
 503 wg_peer_remove (index_t peeri)
 504 {
 505   wg_main_t *wmp = &wg_main;
 506   wg_peer_t *peer = NULL;
 507   wg_if_t *wgi;
 508
 509   if (pool_is_free_index (wg_peer_pool, peeri))
 510     return VNET_API_ERROR_NO_SUCH_ENTRY;
 511
 512   peer = pool_elt_at_index (wg_peer_pool, peeri);
 513
 514   wgi = wg_if_get (wg_if_find_by_sw_if_index (peer->wg_sw_if_index));
 515   wg_if_peer_remove (wgi, peeri);
 516
 517   noise_remote_clear (wmp->vlib_main, &peer->remote);
 518   wg_peer_clear (wmp->vlib_main, peer);
 519   pool_put (wg_peer_pool, peer);
 520
 521   return (0);
 522 }
 523
 524 index_t
 525 wg_peer_walk (wg_peer_walk_cb_t fn, void *data)
 526 {
 527   index_t peeri;
 528
 529   /* *INDENT-OFF* */
 530   pool_foreach_index (peeri, wg_peer_pool)
 531   {
 532     if (WALK_STOP == fn(peeri, data))
 533       return peeri;
 534   }
 535   /* *INDENT-ON* */
 536   return INDEX_INVALID;
 537 }
 538
 539 static u8 *
 540 format_wg_peer_endpoint (u8 * s, va_list * args)
 541 {
 542   wg_peer_endpoint_t *ep = va_arg (*args, wg_peer_endpoint_t *);
 543
 544   s = format (s, "%U:%d", format_ip46_address, &ep->addr, IP46_TYPE_ANY,
 545               ep->port);
 546
 547   return (s);
 548 }
 549
 550 u8 *
 551 format_wg_peer (u8 * s, va_list * va)
 552 {
 553   index_t peeri = va_arg (*va, index_t);
 554   fib_prefix_t *allowed_ip;
 555   adj_index_t *adj_index;
 556   u8 key[NOISE_KEY_LEN_BASE64];
 557   wg_peer_t *peer;
 558
 559   peer = wg_peer_get (peeri);
 560   key_to_base64 (peer->remote.r_public, NOISE_PUBLIC_KEY_LEN, key);
 561
 562   s = format (
 563     s,
 564     "[%d] endpoint:[%U->%U] %U keep-alive:%d flags: %d, api-clients count: %d",
 565     peeri, format_wg_peer_endpoint, &peer->src, format_wg_peer_endpoint,
 566     &peer->dst, format_vnet_sw_if_index_name, vnet_get_main (),
 567     peer->wg_sw_if_index, peer->persistent_keepalive_interval, peer->flags,
 568     pool_elts (peer->api_clients));
 569   s = format (s, "\n  adj:");
 570   vec_foreach (adj_index, peer->adj_indices)
 571     {
 572       s = format (s, " %d", *adj_index);
 573     }
 574   s = format (s, "\n  key:%=s %U", key, format_hex_bytes,
 575               peer->remote.r_public, NOISE_PUBLIC_KEY_LEN);
 576   s = format (s, "\n  allowed-ips:");
 577   vec_foreach (allowed_ip, peer->allowed_ips)
 578   {
 579     s = format (s, " %U", format_fib_prefix, allowed_ip);
 580   }
 581
 582   return s;
 583 }
 584
 585 /*
 586  * fd.io coding-style-patch-verification: ON
 587  *
 588  * Local Variables:
 589  * eval: (c-set-style "gnu")
 590  * End:
 591  */