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