src/plugins/wireguard/wireguard_peer.c

   1 /*
   2  * Copyright (c) 2020 Doc.ai and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #include <vnet/adj/adj_midchain.h>
  17 #include <vnet/fib/fib_table.h>
  18 #include <wireguard/wireguard_peer.h>
  19 #include <wireguard/wireguard_if.h>
  20 #include <wireguard/wireguard_messages.h>
  21 #include <wireguard/wireguard_key.h>
  22 #include <wireguard/wireguard_send.h>
  23 #include <wireguard/wireguard.h>
  24
  25 static fib_source_t wg_fib_source;
  26 wg_peer_t *wg_peer_pool;
  27
  28 index_t *wg_peer_by_adj_index;
  29
  30 static void
  31 wg_peer_endpoint_reset (wg_peer_endpoint_t * ep)
  32 {
  33   ip46_address_reset (&ep->addr);
  34   ep->port = 0;
  35 }
  36
  37 static void
  38 wg_peer_endpoint_init (wg_peer_endpoint_t * ep,
  39                        const ip46_address_t * addr, u16 port)
  40 {
  41   ip46_address_copy (&ep->addr, addr);
  42   ep->port = port;
  43 }
  44
  45 static void
  46 wg_peer_fib_flush (wg_peer_t * peer)
  47 {
  48   wg_peer_allowed_ip_t *allowed_ip;
  49
  50   vec_foreach (allowed_ip, peer->allowed_ips)
  51   {
  52     fib_table_entry_delete_index (allowed_ip->fib_entry_index, wg_fib_source);
  53     allowed_ip->fib_entry_index = FIB_NODE_INDEX_INVALID;
  54   }
  55 }
  56
  57 static void
  58 wg_peer_fib_populate (wg_peer_t * peer, u32 fib_index)
  59 {
  60   wg_peer_allowed_ip_t *allowed_ip;
  61
  62   vec_foreach (allowed_ip, peer->allowed_ips)
  63   {
  64     allowed_ip->fib_entry_index =
  65       fib_table_entry_path_add (fib_index,
  66                                 &allowed_ip->prefix,
  67                                 wg_fib_source,
  68                                 FIB_ENTRY_FLAG_NONE,
  69                                 fib_proto_to_dpo (allowed_ip->
  70                                                   prefix.fp_proto),
  71                                 &peer->dst.addr, peer->wg_sw_if_index, ~0, 1,
  72                                 NULL, FIB_ROUTE_PATH_FLAG_NONE);
  73   }
  74 }
  75
  76 static void
  77 wg_peer_clear (vlib_main_t * vm, wg_peer_t * peer)
  78 {
  79   wg_timers_stop (peer);
  80   for (int i = 0; i < WG_N_TIMERS; i++)
  81     {
  82       peer->timers[i] = ~0;
  83     }
  84
  85   peer->last_sent_handshake = vlib_time_now (vm) - (REKEY_TIMEOUT + 1);
  86
  87   clib_memset (&peer->cookie_maker, 0, sizeof (peer->cookie_maker));
  88
  89   wg_peer_endpoint_reset (&peer->src);
  90   wg_peer_endpoint_reset (&peer->dst);
  91
  92   if (INDEX_INVALID != peer->adj_index)
  93     {
  94       adj_unlock (peer->adj_index);
  95       wg_peer_by_adj_index[peer->adj_index] = INDEX_INVALID;
  96     }
  97   wg_peer_fib_flush (peer);
  98
  99   peer->input_thread_index = ~0;
 100   peer->output_thread_index = ~0;
 101   peer->adj_index = INDEX_INVALID;
 102   peer->timer_wheel = 0;
 103   peer->persistent_keepalive_interval = 0;
 104   peer->timer_handshake_attempts = 0;
 105   peer->last_sent_packet = 0;
 106   peer->last_received_packet = 0;
 107   peer->session_derived = 0;
 108   peer->rehandshake_started = 0;
 109   peer->new_handshake_interval_tick = 0;
 110   peer->rehandshake_interval_tick = 0;
 111   peer->timer_need_another_keepalive = false;
 112   peer->is_dead = true;
 113   vec_free (peer->allowed_ips);
 114 }
 115
 116 static void
 117 wg_peer_init (vlib_main_t * vm, wg_peer_t * peer)
 118 {
 119   peer->adj_index = INDEX_INVALID;
 120   wg_peer_clear (vm, peer);
 121 }
 122
 123 static u8 *
 124 wg_peer_build_rewrite (const wg_peer_t * peer)
 125 {
 126   // v4 only for now
 127   ip4_udp_header_t *hdr;
 128   u8 *rewrite = NULL;
 129
 130   vec_validate (rewrite, sizeof (*hdr) - 1);
 131   hdr = (ip4_udp_header_t *) rewrite;
 132
 133   hdr->ip4.ip_version_and_header_length = 0x45;
 134   hdr->ip4.ttl = 64;
 135   hdr->ip4.src_address = peer->src.addr.ip4;
 136   hdr->ip4.dst_address = peer->dst.addr.ip4;
 137   hdr->ip4.protocol = IP_PROTOCOL_UDP;
 138   hdr->ip4.checksum = ip4_header_checksum (&hdr->ip4);
 139
 140   hdr->udp.src_port = clib_host_to_net_u16 (peer->src.port);
 141   hdr->udp.dst_port = clib_host_to_net_u16 (peer->dst.port);
 142   hdr->udp.checksum = 0;
 143
 144   return (rewrite);
 145 }
 146
 147 static void
 148 wg_peer_adj_stack (wg_peer_t * peer)
 149 {
 150   ip_adjacency_t *adj;
 151   u32 sw_if_index;
 152   wg_if_t *wgi;
 153
 154   adj = adj_get (peer->adj_index);
 155   sw_if_index = adj->rewrite_header.sw_if_index;
 156
 157   wgi = wg_if_get (wg_if_find_by_sw_if_index (sw_if_index));
 158
 159   if (!wgi)
 160     return;
 161
 162   if (!vnet_sw_interface_is_admin_up (vnet_get_main (), wgi->sw_if_index))
 163     {
 164       adj_midchain_delegate_unstack (peer->adj_index);
 165     }
 166   else
 167     {
 168       /* *INDENT-OFF* */
 169       fib_prefix_t dst = {
 170         .fp_len = 32,
 171         .fp_proto = FIB_PROTOCOL_IP4,
 172         .fp_addr = peer->dst.addr,
 173       };
 174       /* *INDENT-ON* */
 175       u32 fib_index;
 176
 177       fib_index = fib_table_find (FIB_PROTOCOL_IP4, peer->table_id);
 178
 179       adj_midchain_delegate_stack (peer->adj_index, fib_index, &dst);
 180     }
 181 }
 182
 183 walk_rc_t
 184 wg_peer_if_admin_state_change (wg_if_t * wgi, index_t peeri, void *data)
 185 {
 186   wg_peer_adj_stack (wg_peer_get (peeri));
 187
 188   return (WALK_CONTINUE);
 189 }
 190
 191 walk_rc_t
 192 wg_peer_if_table_change (wg_if_t * wgi, index_t peeri, void *data)
 193 {
 194   wg_peer_table_bind_ctx_t *ctx = data;
 195   wg_peer_t *peer;
 196
 197   peer = wg_peer_get (peeri);
 198
 199   wg_peer_fib_flush (peer);
 200   wg_peer_fib_populate (peer, ctx->new_fib_index);
 201
 202   return (WALK_CONTINUE);
 203 }
 204
 205 static int
 206 wg_peer_fill (vlib_main_t * vm, wg_peer_t * peer,
 207               u32 table_id,
 208               const ip46_address_t * dst,
 209               u16 port,
 210               u16 persistent_keepalive_interval,
 211               const fib_prefix_t * allowed_ips, u32 wg_sw_if_index)
 212 {
 213   wg_peer_endpoint_init (&peer->dst, dst, port);
 214
 215   peer->table_id = table_id;
 216   peer->wg_sw_if_index = wg_sw_if_index;
 217   peer->timer_wheel = &wg_main.timer_wheel;
 218   peer->persistent_keepalive_interval = persistent_keepalive_interval;
 219   peer->last_sent_handshake = vlib_time_now (vm) - (REKEY_TIMEOUT + 1);
 220   peer->is_dead = false;
 221
 222   const wg_if_t *wgi = wg_if_get (wg_if_find_by_sw_if_index (wg_sw_if_index));
 223
 224   if (NULL == wgi)
 225     return (VNET_API_ERROR_INVALID_INTERFACE);
 226
 227   ip_address_to_46 (&wgi->src_ip, &peer->src.addr);
 228   peer->src.port = wgi->port;
 229
 230   /*
 231    * and an adjacency for the endpoint address in the overlay
 232    * on the wg interface
 233    */
 234   peer->rewrite = wg_peer_build_rewrite (peer);
 235
 236   peer->adj_index = adj_nbr_add_or_lock (FIB_PROTOCOL_IP4,
 237                                          VNET_LINK_IP4,
 238                                          &peer->dst.addr, wgi->sw_if_index);
 239
 240   vec_validate_init_empty (wg_peer_by_adj_index,
 241                            peer->adj_index, INDEX_INVALID);
 242   wg_peer_by_adj_index[peer->adj_index] = peer - wg_peer_pool;
 243
 244   adj_nbr_midchain_update_rewrite (peer->adj_index,
 245                                    NULL,
 246                                    NULL,
 247                                    ADJ_FLAG_MIDCHAIN_IP_STACK,
 248                                    vec_dup (peer->rewrite));
 249   wg_peer_adj_stack (peer);
 250
 251   /*
 252    * add a route in the overlay to each of the allowed-ips
 253    */
 254   u32 ii;
 255
 256   vec_validate (peer->allowed_ips, vec_len (allowed_ips) - 1);
 257
 258   vec_foreach_index (ii, allowed_ips)
 259   {
 260     peer->allowed_ips[ii].prefix = allowed_ips[ii];
 261   }
 262
 263   wg_peer_fib_populate (peer,
 264                         fib_table_get_index_for_sw_if_index
 265                         (FIB_PROTOCOL_IP4, peer->wg_sw_if_index));
 266
 267   return (0);
 268 }
 269
 270 int
 271 wg_peer_add (u32 tun_sw_if_index,
 272              const u8 public_key[NOISE_PUBLIC_KEY_LEN],
 273              u32 table_id,
 274              const ip46_address_t * endpoint,
 275              const fib_prefix_t * allowed_ips,
 276              u16 port, u16 persistent_keepalive, u32 * peer_index)
 277 {
 278   wg_if_t *wg_if;
 279   wg_peer_t *peer;
 280   int rv;
 281
 282   vlib_main_t *vm = vlib_get_main ();
 283
 284   if (tun_sw_if_index == ~0)
 285     return (VNET_API_ERROR_INVALID_SW_IF_INDEX);
 286
 287   wg_if = wg_if_get (wg_if_find_by_sw_if_index (tun_sw_if_index));
 288   if (!wg_if)
 289     return (VNET_API_ERROR_INVALID_SW_IF_INDEX);
 290
 291   /* *INDENT-OFF* */
 292   pool_foreach (peer, wg_peer_pool,
 293   ({
 294     if (!memcmp (peer->remote.r_public, public_key, NOISE_PUBLIC_KEY_LEN))
 295     {
 296       return (VNET_API_ERROR_ENTRY_ALREADY_EXISTS);
 297     }
 298   }));
 299   /* *INDENT-ON* */
 300
 301   if (pool_elts (wg_peer_pool) > MAX_PEERS)
 302     return (VNET_API_ERROR_LIMIT_EXCEEDED);
 303
 304   pool_get (wg_peer_pool, peer);
 305
 306   wg_peer_init (vm, peer);
 307
 308   rv = wg_peer_fill (vm, peer, table_id, endpoint, (u16) port,
 309                      persistent_keepalive, allowed_ips, tun_sw_if_index);
 310
 311   if (rv)
 312     {
 313       wg_peer_clear (vm, peer);
 314       pool_put (wg_peer_pool, peer);
 315       return (rv);
 316     }
 317
 318   noise_remote_init (&peer->remote, peer - wg_peer_pool, public_key,
 319                      wg_if->local_idx);
 320   cookie_maker_init (&peer->cookie_maker, public_key);
 321
 322   if (peer->persistent_keepalive_interval != 0)
 323     {
 324       wg_send_keepalive (vm, peer);
 325     }
 326
 327   *peer_index = peer - wg_peer_pool;
 328   wg_if_peer_add (wg_if, *peer_index);
 329
 330   return (0);
 331 }
 332
 333 int
 334 wg_peer_remove (index_t peeri)
 335 {
 336   wg_main_t *wmp = &wg_main;
 337   wg_peer_t *peer = NULL;
 338   wg_if_t *wgi;
 339
 340   if (pool_is_free_index (wg_peer_pool, peeri))
 341     return VNET_API_ERROR_NO_SUCH_ENTRY;
 342
 343   peer = pool_elt_at_index (wg_peer_pool, peeri);
 344
 345   wgi = wg_if_get (wg_if_find_by_sw_if_index (peer->wg_sw_if_index));
 346   wg_if_peer_remove (wgi, peeri);
 347
 348   vnet_feature_enable_disable ("ip4-output", "wg-output-tun",
 349                                peer->wg_sw_if_index, 0, 0, 0);
 350
 351   noise_remote_clear (wmp->vlib_main, &peer->remote);
 352   wg_peer_clear (wmp->vlib_main, peer);
 353   pool_put (wg_peer_pool, peer);
 354
 355   return (0);
 356 }
 357
 358 index_t
 359 wg_peer_walk (wg_peer_walk_cb_t fn, void *data)
 360 {
 361   index_t peeri;
 362
 363   /* *INDENT-OFF* */
 364   pool_foreach_index(peeri, wg_peer_pool,
 365   {
 366     if (WALK_STOP == fn(peeri, data))
 367       return peeri;
 368   });
 369   /* *INDENT-ON* */
 370   return INDEX_INVALID;
 371 }
 372
 373 static u8 *
 374 format_wg_peer_endpoint (u8 * s, va_list * args)
 375 {
 376   wg_peer_endpoint_t *ep = va_arg (*args, wg_peer_endpoint_t *);
 377
 378   s = format (s, "%U:%d",
 379               format_ip46_address, &ep->addr, IP46_TYPE_ANY, ep->port);
 380
 381   return (s);
 382 }
 383
 384 u8 *
 385 format_wg_peer (u8 * s, va_list * va)
 386 {
 387   index_t peeri = va_arg (*va, index_t);
 388   wg_peer_allowed_ip_t *allowed_ip;
 389   u8 key[NOISE_KEY_LEN_BASE64];
 390   wg_peer_t *peer;
 391
 392   peer = wg_peer_get (peeri);
 393   key_to_base64 (peer->remote.r_public, NOISE_PUBLIC_KEY_LEN, key);
 394
 395   s = format (s, "[%d] endpoint:[%U->%U] %U keep-alive:%d adj:%d",
 396               peeri,
 397               format_wg_peer_endpoint, &peer->src,
 398               format_wg_peer_endpoint, &peer->dst,
 399               format_vnet_sw_if_index_name, vnet_get_main (),
 400               peer->wg_sw_if_index,
 401               peer->persistent_keepalive_interval, peer->adj_index);
 402   s = format (s, "\n  key:%=s %U",
 403               key, format_hex_bytes, peer->remote.r_public,
 404               NOISE_PUBLIC_KEY_LEN);
 405   s = format (s, "\n  allowed-ips:");
 406   vec_foreach (allowed_ip, peer->allowed_ips)
 407   {
 408     s = format (s, " %U", format_fib_prefix, &allowed_ip->prefix);
 409   }
 410
 411   return s;
 412 }
 413
 414 static clib_error_t *
 415 wg_peer_module_init (vlib_main_t * vm)
 416 {
 417   /*
 418    * use a priority better than interface source, so that
 419    * if the same subnet is added to the wg interface and is
 420    * used as an allowed IP, then the wireguard soueced prefix
 421    * wins and traffic is routed to the endpoint rather than dropped
 422    */
 423   wg_fib_source = fib_source_allocate ("wireguard", 0x2, FIB_SOURCE_BH_API);
 424
 425   return (NULL);
 426 }
 427
 428 VLIB_INIT_FUNCTION (wg_peer_module_init);
 429
 430 /*
 431  * fd.io coding-style-patch-verification: ON
 432  *
 433  * Local Variables:
 434  * eval: (c-set-style "gnu")
 435  * End:
 436  */