src/plugins/wireguard/wireguard_if.c

   1 /*
   2  * Copyright (c) 2020 Cisco and/or its affiliates.
   3  * Copyright (c) 2020 Doc.ai 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/udp/udp.h>
  19
  20 #include <wireguard/wireguard_messages.h>
  21 #include <wireguard/wireguard_if.h>
  22 #include <wireguard/wireguard.h>
  23 #include <wireguard/wireguard_peer.h>
  24
  25 /* pool of interfaces */
  26 wg_if_t *wg_if_pool;
  27
  28 /* bitmap of Allocated WG_ITF instances */
  29 static uword *wg_if_instances;
  30
  31 /* vector of interfaces key'd on their sw_if_index */
  32 static index_t *wg_if_index_by_sw_if_index;
  33
  34 /* vector of interfaces key'd on their UDP port (in network order) */
  35 index_t **wg_if_indexes_by_port;
  36
  37 static u8 *
  38 format_wg_if_name (u8 * s, va_list * args)
  39 {
  40   u32 dev_instance = va_arg (*args, u32);
  41   wg_if_t *wgi = wg_if_get (dev_instance);
  42   return format (s, "wg%d", wgi->user_instance);
  43 }
  44
  45 u8 *
  46 format_wg_if (u8 * s, va_list * args)
  47 {
  48   index_t wgii = va_arg (*args, u32);
  49   wg_if_t *wgi = wg_if_get (wgii);
  50   noise_local_t *local = noise_local_get (wgi->local_idx);
  51   u8 key[NOISE_KEY_LEN_BASE64];
  52
  53   s = format (s, "[%d] %U src:%U port:%d",
  54               wgii,
  55               format_vnet_sw_if_index_name, vnet_get_main (),
  56               wgi->sw_if_index, format_ip_address, &wgi->src_ip, wgi->port);
  57
  58   key_to_base64 (local->l_private, NOISE_PUBLIC_KEY_LEN, key);
  59
  60   s = format (s, " private-key:%s", key);
  61   s =
  62     format (s, " %U", format_hex_bytes, local->l_private,
  63             NOISE_PUBLIC_KEY_LEN);
  64
  65   key_to_base64 (local->l_public, NOISE_PUBLIC_KEY_LEN, key);
  66
  67   s = format (s, " public-key:%s", key);
  68
  69   s =
  70     format (s, " %U", format_hex_bytes, local->l_public,
  71             NOISE_PUBLIC_KEY_LEN);
  72
  73   s = format (s, " mac-key: %U", format_hex_bytes,
  74               &wgi->cookie_checker.cc_mac1_key, NOISE_PUBLIC_KEY_LEN);
  75
  76   return (s);
  77 }
  78
  79 index_t
  80 wg_if_find_by_sw_if_index (u32 sw_if_index)
  81 {
  82   if (vec_len (wg_if_index_by_sw_if_index) <= sw_if_index)
  83     return INDEX_INVALID;
  84   u32 ti = wg_if_index_by_sw_if_index[sw_if_index];
  85   if (ti == ~0)
  86     return INDEX_INVALID;
  87
  88   return (ti);
  89 }
  90
  91 static walk_rc_t
  92 wg_if_find_peer_by_public_key (index_t peeri, void *data)
  93 {
  94   uint8_t *public = data;
  95   wg_peer_t *peer = wg_peer_get (peeri);
  96
  97   if (!memcmp (peer->remote.r_public, public, NOISE_PUBLIC_KEY_LEN))
  98     return (WALK_STOP);
  99   return (WALK_CONTINUE);
 100 }
 101
 102 static noise_remote_t *
 103 wg_remote_get (const uint8_t public[NOISE_PUBLIC_KEY_LEN])
 104 {
 105   index_t peeri;
 106
 107   peeri = wg_peer_walk (wg_if_find_peer_by_public_key, (void *) public);
 108
 109   if (INDEX_INVALID != peeri)
 110     return &wg_peer_get (peeri)->remote;
 111
 112   return NULL;
 113 }
 114
 115 static uint32_t
 116 wg_index_set (noise_remote_t * remote)
 117 {
 118   wg_main_t *wmp = &wg_main;
 119   u32 rnd_seed = (u32) (vlib_time_now (wmp->vlib_main) * 1e6);
 120   u32 ret =
 121     wg_index_table_add (&wmp->index_table, remote->r_peer_idx, rnd_seed);
 122   return ret;
 123 }
 124
 125 static void
 126 wg_index_drop (uint32_t key)
 127 {
 128   wg_main_t *wmp = &wg_main;
 129   wg_index_table_del (&wmp->index_table, key);
 130 }
 131
 132 static clib_error_t *
 133 wg_if_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
 134 {
 135   vnet_hw_interface_t *hi;
 136   index_t wgii;
 137   u32 hw_flags;
 138
 139   hi = vnet_get_hw_interface (vnm, hw_if_index);
 140   hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP ?
 141               VNET_HW_INTERFACE_FLAG_LINK_UP : 0);
 142   vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
 143
 144   wgii = wg_if_find_by_sw_if_index (hi->sw_if_index);
 145
 146   wg_if_peer_walk (wg_if_get (wgii), wg_peer_if_admin_state_change, NULL);
 147
 148   return (NULL);
 149 }
 150
 151 void
 152 wg_if_update_adj (vnet_main_t * vnm, u32 sw_if_index, adj_index_t ai)
 153 {
 154   index_t wgii;
 155
 156   /* Convert any neighbour adjacency that has a next-hop reachable through
 157    * the wg interface into a midchain. This is to avoid sending ARP/ND to
 158    * resolve the next-hop address via the wg interface. Then, if one of the
 159    * peers has matching prefix among allowed prefixes, the midchain will be
 160    * updated to the corresponding one.
 161    */
 162   adj_nbr_midchain_update_rewrite (ai, NULL, NULL, ADJ_FLAG_NONE, NULL);
 163
 164   wgii = wg_if_find_by_sw_if_index (sw_if_index);
 165   wg_if_peer_walk (wg_if_get (wgii), wg_peer_if_adj_change, &ai);
 166 }
 167
 168
 169 /* *INDENT-OFF* */
 170 VNET_DEVICE_CLASS (wg_if_device_class) = {
 171   .name = "Wireguard Tunnel",
 172   .format_device_name = format_wg_if_name,
 173   .admin_up_down_function = wg_if_admin_up_down,
 174 };
 175
 176 VNET_HW_INTERFACE_CLASS(wg_hw_interface_class) = {
 177   .name = "Wireguard",
 178   .update_adjacency = wg_if_update_adj,
 179   .flags = VNET_HW_INTERFACE_CLASS_FLAG_NBMA,
 180 };
 181 /* *INDENT-ON* */
 182
 183 /*
 184  * Maintain a bitmap of allocated wg_if instance numbers.
 185  */
 186 #define WG_ITF_MAX_INSTANCE             (16 * 1024)
 187
 188 static u32
 189 wg_if_instance_alloc (u32 want)
 190 {
 191   /*
 192    * Check for dynamically allocated instance number.
 193    */
 194   if (~0 == want)
 195     {
 196       u32 bit;
 197
 198       bit = clib_bitmap_first_clear (wg_if_instances);
 199       if (bit >= WG_ITF_MAX_INSTANCE)
 200         {
 201           return ~0;
 202         }
 203       wg_if_instances = clib_bitmap_set (wg_if_instances, bit, 1);
 204       return bit;
 205     }
 206
 207   /*
 208    * In range?
 209    */
 210   if (want >= WG_ITF_MAX_INSTANCE)
 211     {
 212       return ~0;
 213     }
 214
 215   /*
 216    * Already in use?
 217    */
 218   if (clib_bitmap_get (wg_if_instances, want))
 219     {
 220       return ~0;
 221     }
 222
 223   /*
 224    * Grant allocation request.
 225    */
 226   wg_if_instances = clib_bitmap_set (wg_if_instances, want, 1);
 227
 228   return want;
 229 }
 230
 231 static int
 232 wg_if_instance_free (u32 instance)
 233 {
 234   if (instance >= WG_ITF_MAX_INSTANCE)
 235     {
 236       return -1;
 237     }
 238
 239   if (clib_bitmap_get (wg_if_instances, instance) == 0)
 240     {
 241       return -1;
 242     }
 243
 244   wg_if_instances = clib_bitmap_set (wg_if_instances, instance, 0);
 245   return 0;
 246 }
 247
 248
 249 int
 250 wg_if_create (u32 user_instance,
 251               const u8 private_key[NOISE_PUBLIC_KEY_LEN],
 252               u16 port, const ip_address_t * src_ip, u32 * sw_if_indexp)
 253 {
 254   vnet_main_t *vnm = vnet_get_main ();
 255   u32 instance, hw_if_index;
 256   vnet_hw_interface_t *hi;
 257   wg_if_t *wg_if;
 258   noise_local_t *local;
 259
 260   ASSERT (sw_if_indexp);
 261
 262   *sw_if_indexp = (u32) ~ 0;
 263
 264   /*
 265    * Allocate a wg_if instance. Either select on dynamically
 266    * or try to use the desired user_instance number.
 267    */
 268   instance = wg_if_instance_alloc (user_instance);
 269   if (instance == ~0)
 270     return VNET_API_ERROR_INVALID_REGISTRATION;
 271
 272   /* *INDENT-OFF* */
 273   struct noise_upcall upcall =  {
 274     .u_remote_get = wg_remote_get,
 275     .u_index_set = wg_index_set,
 276     .u_index_drop = wg_index_drop,
 277   };
 278   /* *INDENT-ON* */
 279
 280   pool_get (noise_local_pool, local);
 281
 282   noise_local_init (local, &upcall);
 283   if (!noise_local_set_private (local, private_key))
 284     {
 285       pool_put (noise_local_pool, local);
 286       wg_if_instance_free (instance);
 287       return VNET_API_ERROR_INVALID_REGISTRATION;
 288     }
 289
 290   pool_get_zero (wg_if_pool, wg_if);
 291
 292   /* tunnel index (or instance) */
 293   u32 t_idx = wg_if - wg_if_pool;
 294
 295   wg_if->user_instance = instance;
 296   if (~0 == wg_if->user_instance)
 297     wg_if->user_instance = t_idx;
 298
 299   vec_validate_init_empty (wg_if_indexes_by_port, port, NULL);
 300   if (vec_len (wg_if_indexes_by_port[port]) == 0)
 301     {
 302       udp_register_dst_port (vlib_get_main (), port, wg4_input_node.index,
 303                              UDP_IP4);
 304       udp_register_dst_port (vlib_get_main (), port, wg6_input_node.index,
 305                              UDP_IP6);
 306     }
 307
 308   vec_add1 (wg_if_indexes_by_port[port], t_idx);
 309
 310   wg_if->port = port;
 311   wg_if->local_idx = local - noise_local_pool;
 312   cookie_checker_update (&wg_if->cookie_checker, local->l_public);
 313
 314   hw_if_index = vnet_register_interface (vnm,
 315                                          wg_if_device_class.index,
 316                                          t_idx,
 317                                          wg_hw_interface_class.index, t_idx);
 318
 319   hi = vnet_get_hw_interface (vnm, hw_if_index);
 320
 321   vec_validate_init_empty (wg_if_index_by_sw_if_index, hi->sw_if_index,
 322                            INDEX_INVALID);
 323   wg_if_index_by_sw_if_index[hi->sw_if_index] = t_idx;
 324
 325   ip_address_copy (&wg_if->src_ip, src_ip);
 326   wg_if->sw_if_index = *sw_if_indexp = hi->sw_if_index;
 327   vnet_set_interface_l3_output_node (vnm->vlib_main, hi->sw_if_index,
 328                                      (u8 *) "tunnel-output");
 329
 330   return 0;
 331 }
 332
 333 int
 334 wg_if_delete (u32 sw_if_index)
 335 {
 336   vnet_main_t *vnm = vnet_get_main ();
 337
 338   if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
 339     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
 340
 341   vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
 342   if (hw == 0 || hw->dev_class_index != wg_if_device_class.index)
 343     return VNET_API_ERROR_INVALID_VALUE;
 344
 345   wg_if_t *wg_if;
 346   index_t wgii = wg_if_find_by_sw_if_index (sw_if_index);
 347   wg_if = wg_if_get (wgii);
 348   if (NULL == wg_if)
 349     return VNET_API_ERROR_INVALID_SW_IF_INDEX_2;
 350
 351   if (wg_if_instance_free (wg_if->user_instance) < 0)
 352     return VNET_API_ERROR_INVALID_VALUE_2;
 353
 354   // Remove peers before interface deletion
 355   wg_if_peer_walk (wg_if, wg_peer_if_delete, NULL);
 356
 357   hash_free (wg_if->peers);
 358
 359   index_t *ii;
 360   index_t *ifs = wg_if_indexes_get_by_port (wg_if->port);
 361   vec_foreach (ii, ifs)
 362     {
 363       if (*ii == wgii)
 364         {
 365           vec_del1 (ifs, ifs - ii);
 366           break;
 367         }
 368     }
 369   if (vec_len (ifs) == 0)
 370     {
 371       udp_unregister_dst_port (vlib_get_main (), wg_if->port, 1);
 372       udp_unregister_dst_port (vlib_get_main (), wg_if->port, 0);
 373     }
 374
 375   vnet_reset_interface_l3_output_node (vnm->vlib_main, sw_if_index);
 376   vnet_delete_hw_interface (vnm, hw->hw_if_index);
 377   pool_put_index (noise_local_pool, wg_if->local_idx);
 378   pool_put (wg_if_pool, wg_if);
 379
 380   return 0;
 381 }
 382
 383 void
 384 wg_if_peer_add (wg_if_t * wgi, index_t peeri)
 385 {
 386   hash_set (wgi->peers, peeri, peeri);
 387
 388   if (1 == hash_elts (wgi->peers))
 389     {
 390       vnet_feature_enable_disable ("ip4-output", "wg4-output-tun",
 391                                    wgi->sw_if_index, 1, 0, 0);
 392       vnet_feature_enable_disable ("ip6-output", "wg6-output-tun",
 393                                    wgi->sw_if_index, 1, 0, 0);
 394     }
 395 }
 396
 397 void
 398 wg_if_peer_remove (wg_if_t * wgi, index_t peeri)
 399 {
 400   hash_unset (wgi->peers, peeri);
 401
 402   if (0 == hash_elts (wgi->peers))
 403     {
 404       vnet_feature_enable_disable ("ip4-output", "wg4-output-tun",
 405                                    wgi->sw_if_index, 0, 0, 0);
 406       vnet_feature_enable_disable ("ip6-output", "wg6-output-tun",
 407                                    wgi->sw_if_index, 0, 0, 0);
 408     }
 409 }
 410
 411 void
 412 wg_if_walk (wg_if_walk_cb_t fn, void *data)
 413 {
 414   index_t wgii;
 415
 416   /* *INDENT-OFF* */
 417   pool_foreach_index (wgii, wg_if_pool)
 418   {
 419     if (WALK_STOP == fn(wgii, data))
 420       break;
 421   }
 422   /* *INDENT-ON* */
 423 }
 424
 425 index_t
 426 wg_if_peer_walk (wg_if_t * wgi, wg_if_peer_walk_cb_t fn, void *data)
 427 {
 428   index_t peeri, val;
 429
 430   /* *INDENT-OFF* */
 431   hash_foreach (peeri, val, wgi->peers, {
 432     if (WALK_STOP == fn (peeri, data))
 433       return peeri;
 434   });
 435   /* *INDENT-ON* */
 436
 437   return INDEX_INVALID;
 438 }
 439
 440 /*
 441  * fd.io coding-style-patch-verification: ON
 442  *
 443  * Local Variables:
 444  * eval: (c-set-style "gnu")
 445  * End:
 446  */