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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
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>
27 wg_peer_t *wg_peer_pool;
29 index_t *wg_peer_by_adj_index;
32 wg_peer_endpoint_reset (wg_peer_endpoint_t * ep)
34 ip46_address_reset (&ep->addr);
39 wg_peer_endpoint_init (wg_peer_endpoint_t *ep, const ip46_address_t *addr,
42 ip46_address_copy (&ep->addr, addr);
47 wg_peer_clear (vlib_main_t * vm, wg_peer_t * peer)
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++)
56 peer->timers_dispatched[i] = 0;
59 peer->last_sent_handshake = vlib_time_now (vm) - (REKEY_TIMEOUT + 1);
61 clib_memset (&peer->cookie_maker, 0, sizeof (peer->cookie_maker));
63 wg_peer_endpoint_reset (&peer->src);
64 wg_peer_endpoint_reset (&peer->dst);
66 adj_index_t *adj_index;
67 vec_foreach (adj_index, peer->adj_indices)
69 if (INDEX_INVALID != *adj_index)
71 wg_peer_by_adj_index[*adj_index] = INDEX_INVALID;
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 vec_free (peer->allowed_ips);
87 vec_free (peer->adj_indices);
91 wg_peer_init (vlib_main_t * vm, wg_peer_t * peer)
93 peer->api_client_by_client_index = hash_create (0, sizeof (u32));
94 peer->api_clients = NULL;
95 wg_peer_clear (vm, peer);
99 wg_peer_build_rewrite (const wg_peer_t *peer, u8 is_ip4)
104 ip4_udp_header_t *hdr;
106 /* reserve space for ip4, udp and wireguard headers */
107 vec_validate (rewrite, sizeof (ip4_udp_wg_header_t) - 1);
108 hdr = (ip4_udp_header_t *) rewrite;
110 hdr->ip4.ip_version_and_header_length = 0x45;
112 hdr->ip4.src_address = peer->src.addr.ip4;
113 hdr->ip4.dst_address = peer->dst.addr.ip4;
114 hdr->ip4.protocol = IP_PROTOCOL_UDP;
115 hdr->ip4.checksum = ip4_header_checksum (&hdr->ip4);
117 hdr->udp.src_port = clib_host_to_net_u16 (peer->src.port);
118 hdr->udp.dst_port = clib_host_to_net_u16 (peer->dst.port);
119 hdr->udp.checksum = 0;
123 ip6_udp_header_t *hdr;
125 /* reserve space for ip6, udp and wireguard headers */
126 vec_validate (rewrite, sizeof (ip6_udp_wg_header_t) - 1);
127 hdr = (ip6_udp_header_t *) rewrite;
129 hdr->ip6.ip_version_traffic_class_and_flow_label = 0x60;
130 ip6_address_copy (&hdr->ip6.src_address, &peer->src.addr.ip6);
131 ip6_address_copy (&hdr->ip6.dst_address, &peer->dst.addr.ip6);
132 hdr->ip6.protocol = IP_PROTOCOL_UDP;
133 hdr->ip6.hop_limit = 64;
135 hdr->udp.src_port = clib_host_to_net_u16 (peer->src.port);
136 hdr->udp.dst_port = clib_host_to_net_u16 (peer->dst.port);
137 hdr->udp.checksum = 0;
144 wg_peer_adj_stack (wg_peer_t *peer, adj_index_t ai)
149 fib_protocol_t fib_proto;
151 if (!adj_is_valid (ai))
155 sw_if_index = adj->rewrite_header.sw_if_index;
156 u8 is_ip4 = ip46_address_is_ip4 (&peer->src.addr);
157 fib_proto = is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
159 wgi = wg_if_get (wg_if_find_by_sw_if_index (sw_if_index));
164 if (!vnet_sw_interface_is_admin_up (vnet_get_main (), wgi->sw_if_index))
166 adj_midchain_delegate_unstack (ai);
172 .fp_len = is_ip4 ? 32 : 128,
173 .fp_proto = fib_proto,
174 .fp_addr = peer->dst.addr,
179 fib_index = fib_table_find (fib_proto, peer->table_id);
181 adj_midchain_delegate_stack (ai, fib_index, &dst);
186 wg_peer_66_fixup (vlib_main_t *vm, const ip_adjacency_t *adj, vlib_buffer_t *b,
190 ip6_header_t *ip6_out;
191 ip6_header_t *ip6_in;
193 /* Must set locally originated otherwise we're not allowed to
194 fragment the packet later */
195 b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
197 ip6_out = vlib_buffer_get_current (b);
198 iph_offset = vnet_buffer (b)->ip.save_rewrite_length;
199 ip6_in = vlib_buffer_get_current (b) + iph_offset;
201 ip6_out->ip_version_traffic_class_and_flow_label =
202 ip6_in->ip_version_traffic_class_and_flow_label;
206 wg_peer_46_fixup (vlib_main_t *vm, const ip_adjacency_t *adj, vlib_buffer_t *b,
210 ip6_header_t *ip6_out;
211 ip4_header_t *ip4_in;
213 /* Must set locally originated otherwise we're not allowed to
214 fragment the packet later */
215 b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
217 ip6_out = vlib_buffer_get_current (b);
218 iph_offset = vnet_buffer (b)->ip.save_rewrite_length;
219 ip4_in = vlib_buffer_get_current (b) + iph_offset;
221 u32 vtcfl = 0x6 << 28;
222 vtcfl |= ip4_in->tos << 20;
223 vtcfl |= vnet_buffer (b)->ip.flow_hash & 0x000fffff;
225 ip6_out->ip_version_traffic_class_and_flow_label =
226 clib_host_to_net_u32 (vtcfl);
229 static adj_midchain_fixup_t
230 wg_peer_get_fixup (wg_peer_t *peer, vnet_link_t lt)
232 if (!ip46_address_is_ip4 (&peer->dst.addr))
234 if (lt == VNET_LINK_IP4)
235 return (wg_peer_46_fixup);
236 if (lt == VNET_LINK_IP6)
237 return (wg_peer_66_fixup);
243 wg_peer_if_admin_state_change (index_t peeri, void *data)
246 adj_index_t *adj_index;
247 peer = wg_peer_get (peeri);
248 vec_foreach (adj_index, peer->adj_indices)
250 wg_peer_adj_stack (peer, *adj_index);
252 return (WALK_CONTINUE);
256 wg_peer_if_adj_change (index_t peeri, void *data)
258 adj_index_t *adj_index = data;
259 adj_midchain_fixup_t fixup;
262 fib_prefix_t *allowed_ip;
264 adj = adj_get (*adj_index);
266 peer = wg_peer_get (peeri);
267 vec_foreach (allowed_ip, peer->allowed_ips)
269 if (fib_prefix_is_cover_addr_46 (allowed_ip,
270 &adj->sub_type.nbr.next_hop))
272 vec_add1 (peer->adj_indices, *adj_index);
273 vec_validate_init_empty (wg_peer_by_adj_index, *adj_index,
275 wg_peer_by_adj_index[*adj_index] = peer - wg_peer_pool;
277 fixup = wg_peer_get_fixup (peer, adj_get_link_type (*adj_index));
278 adj_nbr_midchain_update_rewrite (*adj_index, fixup, NULL,
279 ADJ_FLAG_MIDCHAIN_IP_STACK,
280 vec_dup (peer->rewrite));
282 wg_peer_adj_stack (peer, *adj_index);
287 return (WALK_CONTINUE);
291 wg_peer_adj_walk (adj_index_t ai, void *data)
293 return wg_peer_if_adj_change ((*(index_t *) (data)), &ai) == WALK_CONTINUE ?
294 ADJ_WALK_RC_CONTINUE :
299 wg_peer_if_delete (index_t peeri, void *data)
301 wg_peer_remove (peeri);
302 return (WALK_CONTINUE);
306 wg_peer_fill (vlib_main_t *vm, wg_peer_t *peer, u32 table_id,
307 const ip46_address_t *dst, u16 port,
308 u16 persistent_keepalive_interval,
309 const fib_prefix_t *allowed_ips, u32 wg_sw_if_index)
311 index_t perri = peer - wg_peer_pool;
312 wg_peer_endpoint_init (&peer->dst, dst, port);
314 peer->table_id = table_id;
315 peer->wg_sw_if_index = wg_sw_if_index;
316 peer->timer_wheel = &wg_main.timer_wheel;
317 peer->persistent_keepalive_interval = persistent_keepalive_interval;
318 peer->last_sent_handshake = vlib_time_now (vm) - (REKEY_TIMEOUT + 1);
319 wg_peer_update_flags (perri, WG_PEER_STATUS_DEAD, false);
321 const wg_if_t *wgi = wg_if_get (wg_if_find_by_sw_if_index (wg_sw_if_index));
324 return (VNET_API_ERROR_INVALID_INTERFACE);
326 ip_address_to_46 (&wgi->src_ip, &peer->src.addr);
327 peer->src.port = wgi->port;
329 u8 is_ip4 = ip46_address_is_ip4 (&peer->dst.addr);
330 peer->rewrite = wg_peer_build_rewrite (peer, is_ip4);
333 vec_validate (peer->allowed_ips, vec_len (allowed_ips) - 1);
334 vec_foreach_index (ii, allowed_ips)
336 peer->allowed_ips[ii] = allowed_ips[ii];
339 fib_protocol_t proto;
340 FOR_EACH_FIB_IP_PROTOCOL (proto)
342 adj_nbr_walk (wg_sw_if_index, proto, wg_peer_adj_walk, &perri);
348 wg_peer_update_flags (index_t peeri, wg_peer_flags flag, bool add_del)
350 wg_peer_t *peer = wg_peer_get (peeri);
351 if ((add_del && (peer->flags & flag)) || (!add_del && !(peer->flags & flag)))
357 wg_api_peer_event (peeri, peer->flags);
361 wg_peer_add (u32 tun_sw_if_index, const u8 public_key[NOISE_PUBLIC_KEY_LEN],
362 u32 table_id, const ip46_address_t *endpoint,
363 const fib_prefix_t *allowed_ips, u16 port,
364 u16 persistent_keepalive, u32 *peer_index)
370 vlib_main_t *vm = vlib_get_main ();
372 if (tun_sw_if_index == ~0)
373 return (VNET_API_ERROR_INVALID_SW_IF_INDEX);
375 wg_if = wg_if_get (wg_if_find_by_sw_if_index (tun_sw_if_index));
377 return (VNET_API_ERROR_INVALID_SW_IF_INDEX);
380 pool_foreach (peer, wg_peer_pool)
382 if (!memcmp (peer->remote.r_public, public_key, NOISE_PUBLIC_KEY_LEN))
384 return (VNET_API_ERROR_ENTRY_ALREADY_EXISTS);
389 if (pool_elts (wg_peer_pool) > MAX_PEERS)
390 return (VNET_API_ERROR_LIMIT_EXCEEDED);
392 pool_get (wg_peer_pool, peer);
394 wg_peer_init (vm, peer);
396 rv = wg_peer_fill (vm, peer, table_id, endpoint, (u16) port,
397 persistent_keepalive, allowed_ips, tun_sw_if_index);
401 wg_peer_clear (vm, peer);
402 pool_put (wg_peer_pool, peer);
406 noise_remote_init (&peer->remote, peer - wg_peer_pool, public_key,
408 cookie_maker_init (&peer->cookie_maker, public_key);
410 wg_send_handshake (vm, peer, false);
411 if (peer->persistent_keepalive_interval != 0)
413 wg_send_keepalive (vm, peer);
416 *peer_index = peer - wg_peer_pool;
417 wg_if_peer_add (wg_if, *peer_index);
423 wg_peer_remove (index_t peeri)
425 wg_main_t *wmp = &wg_main;
426 wg_peer_t *peer = NULL;
429 if (pool_is_free_index (wg_peer_pool, peeri))
430 return VNET_API_ERROR_NO_SUCH_ENTRY;
432 peer = pool_elt_at_index (wg_peer_pool, peeri);
434 wgi = wg_if_get (wg_if_find_by_sw_if_index (peer->wg_sw_if_index));
435 wg_if_peer_remove (wgi, peeri);
437 noise_remote_clear (wmp->vlib_main, &peer->remote);
438 wg_peer_clear (wmp->vlib_main, peer);
439 pool_put (wg_peer_pool, peer);
445 wg_peer_walk (wg_peer_walk_cb_t fn, void *data)
450 pool_foreach_index (peeri, wg_peer_pool)
452 if (WALK_STOP == fn(peeri, data))
456 return INDEX_INVALID;
460 format_wg_peer_endpoint (u8 * s, va_list * args)
462 wg_peer_endpoint_t *ep = va_arg (*args, wg_peer_endpoint_t *);
464 s = format (s, "%U:%d", format_ip46_address, &ep->addr, IP46_TYPE_ANY,
471 format_wg_peer (u8 * s, va_list * va)
473 index_t peeri = va_arg (*va, index_t);
474 fib_prefix_t *allowed_ip;
475 adj_index_t *adj_index;
476 u8 key[NOISE_KEY_LEN_BASE64];
479 peer = wg_peer_get (peeri);
480 key_to_base64 (peer->remote.r_public, NOISE_PUBLIC_KEY_LEN, key);
484 "[%d] endpoint:[%U->%U] %U keep-alive:%d flags: %d, api-clients count: %d",
485 peeri, format_wg_peer_endpoint, &peer->src, format_wg_peer_endpoint,
486 &peer->dst, format_vnet_sw_if_index_name, vnet_get_main (),
487 peer->wg_sw_if_index, peer->persistent_keepalive_interval, peer->flags,
488 pool_elts (peer->api_clients));
489 s = format (s, "\n adj:");
490 vec_foreach (adj_index, peer->adj_indices)
492 s = format (s, " %d", *adj_index);
494 s = format (s, "\n key:%=s %U", key, format_hex_bytes,
495 peer->remote.r_public, NOISE_PUBLIC_KEY_LEN);
496 s = format (s, "\n allowed-ips:");
497 vec_foreach (allowed_ip, peer->allowed_ips)
499 s = format (s, " %U", format_fib_prefix, allowed_ip);
506 * fd.io coding-style-patch-verification: ON
509 * eval: (c-set-style "gnu")