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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
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>
25 static fib_source_t wg_fib_source;
27 index_t *wg_peer_by_adj_index;
30 wg_peer_get (index_t peeri)
32 return (pool_elt_at_index (wg_main.peers, peeri));
36 wg_peer_endpoint_reset (wg_peer_endpoint_t * ep)
38 ip46_address_reset (&ep->addr);
43 wg_peer_endpoint_init (wg_peer_endpoint_t * ep,
44 const ip46_address_t * addr, u16 port)
46 ip46_address_copy (&ep->addr, addr);
51 wg_peer_fib_flush (wg_peer_t * peer)
53 wg_peer_allowed_ip_t *allowed_ip;
55 vec_foreach (allowed_ip, peer->allowed_ips)
57 fib_table_entry_delete_index (allowed_ip->fib_entry_index, wg_fib_source);
58 allowed_ip->fib_entry_index = FIB_NODE_INDEX_INVALID;
63 wg_peer_fib_populate (wg_peer_t * peer, u32 fib_index)
65 wg_peer_allowed_ip_t *allowed_ip;
67 vec_foreach (allowed_ip, peer->allowed_ips)
69 allowed_ip->fib_entry_index =
70 fib_table_entry_path_add (fib_index,
74 fib_proto_to_dpo (allowed_ip->
76 &peer->dst.addr, peer->wg_sw_if_index, ~0, 1,
77 NULL, FIB_ROUTE_PATH_FLAG_NONE);
82 wg_peer_clear (vlib_main_t * vm, wg_peer_t * peer)
84 wg_timers_stop (peer);
85 noise_remote_clear (vm, &peer->remote);
86 peer->last_sent_handshake = vlib_time_now (vm) - (REKEY_TIMEOUT + 1);
88 clib_memset (&peer->cookie_maker, 0, sizeof (peer->cookie_maker));
90 wg_peer_endpoint_reset (&peer->src);
91 wg_peer_endpoint_reset (&peer->dst);
93 if (INDEX_INVALID != peer->adj_index)
95 adj_unlock (peer->adj_index);
96 wg_peer_by_adj_index[peer->adj_index] = INDEX_INVALID;
98 wg_peer_fib_flush (peer);
100 peer->adj_index = INDEX_INVALID;
101 peer->persistent_keepalive_interval = 0;
102 peer->timer_handshake_attempts = 0;
103 peer->timer_need_another_keepalive = false;
104 peer->is_dead = true;
105 vec_free (peer->allowed_ips);
109 wg_peer_init (vlib_main_t * vm, wg_peer_t * peer)
111 wg_timers_init (peer, vlib_time_now (vm));
112 wg_peer_clear (vm, peer);
116 wg_peer_build_rewrite (const wg_peer_t * peer)
119 ip4_udp_header_t *hdr;
122 vec_validate (rewrite, sizeof (*hdr) - 1);
123 hdr = (ip4_udp_header_t *) rewrite;
125 hdr->ip4.ip_version_and_header_length = 0x45;
127 hdr->ip4.src_address = peer->src.addr.ip4;
128 hdr->ip4.dst_address = peer->dst.addr.ip4;
129 hdr->ip4.protocol = IP_PROTOCOL_UDP;
130 hdr->ip4.checksum = ip4_header_checksum (&hdr->ip4);
132 hdr->udp.src_port = clib_host_to_net_u16 (peer->src.port);
133 hdr->udp.dst_port = clib_host_to_net_u16 (peer->dst.port);
134 hdr->udp.checksum = 0;
140 wg_peer_adj_stack (wg_peer_t * peer)
146 adj = adj_get (peer->adj_index);
147 sw_if_index = adj->rewrite_header.sw_if_index;
149 wgi = wg_if_get (wg_if_find_by_sw_if_index (sw_if_index));
154 if (!vnet_sw_interface_is_admin_up (vnet_get_main (), wgi->sw_if_index))
156 adj_midchain_delegate_unstack (peer->adj_index);
163 .fp_proto = FIB_PROTOCOL_IP4,
164 .fp_addr = peer->dst.addr,
169 fib_index = fib_table_find (FIB_PROTOCOL_IP4, peer->table_id);
171 adj_midchain_delegate_stack (peer->adj_index, fib_index, &dst);
176 wg_peer_if_admin_state_change (wg_if_t * wgi, index_t peeri, void *data)
178 wg_peer_adj_stack (wg_peer_get (peeri));
180 return (WALK_CONTINUE);
184 wg_peer_if_table_change (wg_if_t * wgi, index_t peeri, void *data)
186 wg_peer_table_bind_ctx_t *ctx = data;
189 peer = wg_peer_get (peeri);
191 wg_peer_fib_flush (peer);
192 wg_peer_fib_populate (peer, ctx->new_fib_index);
194 return (WALK_CONTINUE);
198 wg_peer_fill (vlib_main_t * vm, wg_peer_t * peer,
200 const ip46_address_t * dst,
202 u16 persistent_keepalive_interval,
203 const fib_prefix_t * allowed_ips, u32 wg_sw_if_index)
205 wg_peer_endpoint_init (&peer->dst, dst, port);
207 peer->table_id = table_id;
208 peer->persistent_keepalive_interval = persistent_keepalive_interval;
209 peer->wg_sw_if_index = wg_sw_if_index;
210 peer->last_sent_handshake = vlib_time_now (vm) - (REKEY_TIMEOUT + 1);
211 peer->is_dead = false;
213 const wg_if_t *wgi = wg_if_get (wg_if_find_by_sw_if_index (wg_sw_if_index));
216 return (VNET_API_ERROR_INVALID_INTERFACE);
218 ip_address_to_46 (&wgi->src_ip, &peer->src.addr);
219 peer->src.port = wgi->port;
222 * and an adjacency for the endpoint address in the overlay
223 * on the wg interface
225 peer->rewrite = wg_peer_build_rewrite (peer);
227 peer->adj_index = adj_nbr_add_or_lock (FIB_PROTOCOL_IP4,
229 &peer->dst.addr, wgi->sw_if_index);
231 vec_validate_init_empty (wg_peer_by_adj_index,
232 peer->adj_index, INDEX_INVALID);
233 wg_peer_by_adj_index[peer->adj_index] = peer - wg_main.peers;
235 adj_nbr_midchain_update_rewrite (peer->adj_index,
238 ADJ_FLAG_MIDCHAIN_IP_STACK,
239 vec_dup (peer->rewrite));
240 wg_peer_adj_stack (peer);
243 * add a route in the overlay to each of the allowed-ips
247 vec_validate (peer->allowed_ips, vec_len (allowed_ips) - 1);
249 vec_foreach_index (ii, allowed_ips)
251 peer->allowed_ips[ii].prefix = allowed_ips[ii];
254 wg_peer_fib_populate (peer,
255 fib_table_get_index_for_sw_if_index
256 (FIB_PROTOCOL_IP4, peer->wg_sw_if_index));
262 wg_peer_add (u32 tun_sw_if_index,
263 const u8 public_key[NOISE_PUBLIC_KEY_LEN],
265 const ip46_address_t * endpoint,
266 const fib_prefix_t * allowed_ips,
267 u16 port, u16 persistent_keepalive, u32 * peer_index)
273 vlib_main_t *vm = vlib_get_main ();
275 if (tun_sw_if_index == ~0)
276 return (VNET_API_ERROR_INVALID_SW_IF_INDEX);
278 wg_if = wg_if_get (wg_if_find_by_sw_if_index (tun_sw_if_index));
280 return (VNET_API_ERROR_INVALID_SW_IF_INDEX);
283 pool_foreach (peer, wg_main.peers,
285 if (!memcmp (peer->remote.r_public, public_key, NOISE_PUBLIC_KEY_LEN))
287 return (VNET_API_ERROR_ENTRY_ALREADY_EXISTS);
292 if (pool_elts (wg_main.peers) > MAX_PEERS)
293 return (VNET_API_ERROR_LIMIT_EXCEEDED);
295 pool_get (wg_main.peers, peer);
297 wg_peer_init (vm, peer);
299 rv = wg_peer_fill (vm, peer, table_id, endpoint, (u16) port,
300 persistent_keepalive, allowed_ips, tun_sw_if_index);
304 wg_peer_clear (vm, peer);
305 pool_put (wg_main.peers, peer);
309 noise_remote_init (&peer->remote, peer - wg_main.peers, public_key,
311 cookie_maker_init (&peer->cookie_maker, public_key);
313 if (peer->persistent_keepalive_interval != 0)
315 wg_send_keepalive (vm, peer);
318 *peer_index = peer - wg_main.peers;
319 wg_if_peer_add (wg_if, *peer_index);
325 wg_peer_remove (index_t peeri)
327 wg_main_t *wmp = &wg_main;
328 wg_peer_t *peer = NULL;
331 if (pool_is_free_index (wmp->peers, peeri))
332 return VNET_API_ERROR_NO_SUCH_ENTRY;
334 peer = pool_elt_at_index (wmp->peers, peeri);
336 wgi = wg_if_get (wg_if_find_by_sw_if_index (peer->wg_sw_if_index));
337 wg_if_peer_remove (wgi, peeri);
339 vnet_feature_enable_disable ("ip4-output", "wg-output-tun",
340 peer->wg_sw_if_index, 0, 0, 0);
341 wg_peer_clear (wmp->vlib_main, peer);
342 pool_put (wmp->peers, peer);
348 wg_peer_walk (wg_peer_walk_cb_t fn, void *data)
353 pool_foreach_index(peeri, wg_main.peers,
355 if (WALK_STOP == fn(peeri, data))
362 format_wg_peer_endpoint (u8 * s, va_list * args)
364 wg_peer_endpoint_t *ep = va_arg (*args, wg_peer_endpoint_t *);
366 s = format (s, "%U:%d",
367 format_ip46_address, &ep->addr, IP46_TYPE_ANY, ep->port);
373 format_wg_peer (u8 * s, va_list * va)
375 index_t peeri = va_arg (*va, index_t);
376 wg_peer_allowed_ip_t *allowed_ip;
377 u8 key[NOISE_KEY_LEN_BASE64];
380 peer = wg_peer_get (peeri);
381 key_to_base64 (peer->remote.r_public, NOISE_PUBLIC_KEY_LEN, key);
383 s = format (s, "[%d] key:%=45s endpoint:[%U->%U] %U keep-alive:%d adj:%d",
386 format_wg_peer_endpoint, &peer->src,
387 format_wg_peer_endpoint, &peer->dst,
388 format_vnet_sw_if_index_name, vnet_get_main (),
389 peer->wg_sw_if_index,
390 peer->persistent_keepalive_interval, peer->adj_index);
392 s = format (s, "\n allowed-ips:");
393 vec_foreach (allowed_ip, peer->allowed_ips)
395 s = format (s, " %U", format_fib_prefix, &allowed_ip->prefix);
401 static clib_error_t *
402 wg_peer_module_init (vlib_main_t * vm)
404 wg_fib_source = fib_source_allocate ("wireguard", 0xb0, //
405 FIB_SOURCE_BH_SIMPLE);
410 VLIB_INIT_FUNCTION (wg_peer_module_init);
413 * fd.io coding-style-patch-verification: ON
416 * eval: (c-set-style "gnu")