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