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 <vlibmemory/api.h>
17 #include <wireguard/wireguard.h>
18 #include <wireguard/wireguard_send.h>
19 #include <wireguard/wireguard_timer.h>
22 get_random_u32_max (u32 max)
24 vlib_main_t *vm = vlib_get_main ();
25 u32 seed = (u32) (vlib_time_now (vm) * 1e6);
26 return random_u32 (&seed) % max;
30 stop_timer (wg_peer_t * peer, u32 timer_id)
32 if (peer->timers[timer_id] != ~0)
34 tw_timer_stop_16t_2w_512sl (peer->timer_wheel, peer->timers[timer_id]);
35 peer->timers[timer_id] = ~0;
40 start_timer (wg_peer_t * peer, u32 timer_id, u32 interval_ticks)
42 ASSERT (vlib_get_thread_index () == 0);
44 if (peer->timers[timer_id] == ~0)
46 peer->timers[timer_id] =
47 tw_timer_start_16t_2w_512sl (peer->timer_wheel, peer - wg_peer_pool,
48 timer_id, interval_ticks);
61 start_timer_thread_fn (void *arg)
63 wg_timers_args *a = arg;
64 wg_peer_t *peer = wg_peer_get (a->peer_idx);
66 start_timer (peer, a->timer_id, a->interval_ticks);
71 start_timer_from_mt (u32 peer_idx, u32 timer_id, u32 interval_ticks)
76 .interval_ticks = interval_ticks,
79 vl_api_rpc_call_main_thread (start_timer_thread_fn, (u8 *) & a, sizeof (a));
83 timer_ticks_left (vlib_main_t * vm, f64 init_time_sec, u32 interval_ticks)
85 static const int32_t rounding = (int32_t) (WHZ / 2);
88 ticks_remain = (init_time_sec - vlib_time_now (vm)) * WHZ + interval_ticks;
89 return (ticks_remain > rounding) ? (u32) ticks_remain : 0;
93 wg_expired_retransmit_handshake (vlib_main_t * vm, wg_peer_t * peer)
95 if (peer->rehandshake_started == ~0)
98 u32 ticks = timer_ticks_left (vm, peer->rehandshake_started,
99 peer->rehandshake_interval_tick);
102 start_timer (peer, WG_TIMER_RETRANSMIT_HANDSHAKE, ticks);
106 if (peer->timer_handshake_attempts > MAX_TIMER_HANDSHAKES)
108 stop_timer (peer, WG_TIMER_SEND_KEEPALIVE);
110 /* We set a timer for destroying any residue that might be left
111 * of a partial exchange.
113 start_timer (peer, WG_TIMER_KEY_ZEROING, REJECT_AFTER_TIME * 3 * WHZ);
118 ++peer->timer_handshake_attempts;
119 wg_send_handshake (vm, peer, true);
124 wg_expired_send_keepalive (vlib_main_t * vm, wg_peer_t * peer)
126 if (peer->last_sent_packet < peer->last_received_packet)
128 u32 ticks = timer_ticks_left (vm, peer->last_received_packet,
129 KEEPALIVE_TIMEOUT * WHZ);
132 start_timer (peer, WG_TIMER_SEND_KEEPALIVE, ticks);
136 wg_send_keepalive (vm, peer);
137 if (peer->timer_need_another_keepalive)
139 peer->timer_need_another_keepalive = false;
140 start_timer (peer, WG_TIMER_SEND_KEEPALIVE,
141 KEEPALIVE_TIMEOUT * WHZ);
147 wg_expired_send_persistent_keepalive (vlib_main_t * vm, wg_peer_t * peer)
149 if (peer->persistent_keepalive_interval)
151 f64 latest_time = peer->last_sent_packet > peer->last_received_packet
152 ? peer->last_sent_packet : peer->last_received_packet;
154 u32 ticks = timer_ticks_left (vm, latest_time,
155 peer->persistent_keepalive_interval *
159 start_timer (peer, WG_TIMER_PERSISTENT_KEEPALIVE, ticks);
163 wg_send_keepalive (vm, peer);
168 wg_expired_new_handshake (vlib_main_t * vm, wg_peer_t * peer)
170 u32 ticks = timer_ticks_left (vm, peer->last_sent_packet,
171 peer->new_handshake_interval_tick);
174 start_timer (peer, WG_TIMER_NEW_HANDSHAKE, ticks);
178 wg_send_handshake (vm, peer, false);
182 wg_expired_zero_key_material (vlib_main_t * vm, wg_peer_t * peer)
185 timer_ticks_left (vm, peer->session_derived, REJECT_AFTER_TIME * 3 * WHZ);
188 start_timer (peer, WG_TIMER_KEY_ZEROING, ticks);
194 noise_remote_clear (vm, &peer->remote);
199 wg_timers_any_authenticated_packet_traversal (wg_peer_t * peer)
201 if (peer->persistent_keepalive_interval)
203 start_timer_from_mt (peer - wg_peer_pool,
204 WG_TIMER_PERSISTENT_KEEPALIVE,
205 peer->persistent_keepalive_interval * WHZ);
210 wg_timers_any_authenticated_packet_sent (wg_peer_t * peer)
212 peer->last_sent_packet = vlib_time_now (vlib_get_main ());
216 wg_timers_handshake_initiated (wg_peer_t * peer)
218 peer->rehandshake_started = vlib_time_now (vlib_get_main ());
219 peer->rehandshake_interval_tick =
220 REKEY_TIMEOUT * WHZ + get_random_u32_max (REKEY_TIMEOUT_JITTER);
222 start_timer_from_mt (peer - wg_peer_pool, WG_TIMER_RETRANSMIT_HANDSHAKE,
223 peer->rehandshake_interval_tick);
227 wg_timers_session_derived (wg_peer_t * peer)
229 peer->session_derived = vlib_time_now (vlib_get_main ());
231 start_timer_from_mt (peer - wg_peer_pool, WG_TIMER_KEY_ZEROING,
232 REJECT_AFTER_TIME * 3 * WHZ);
235 /* Should be called after an authenticated data packet is sent. */
237 wg_timers_data_sent (wg_peer_t * peer)
239 peer->new_handshake_interval_tick =
240 (KEEPALIVE_TIMEOUT + REKEY_TIMEOUT) * WHZ +
241 get_random_u32_max (REKEY_TIMEOUT_JITTER);
243 start_timer_from_mt (peer - wg_peer_pool, WG_TIMER_NEW_HANDSHAKE,
244 peer->new_handshake_interval_tick);
247 /* Should be called after an authenticated data packet is received. */
249 wg_timers_data_received (wg_peer_t * peer)
251 if (peer->timers[WG_TIMER_SEND_KEEPALIVE] == ~0)
253 start_timer_from_mt (peer - wg_peer_pool, WG_TIMER_SEND_KEEPALIVE,
254 KEEPALIVE_TIMEOUT * WHZ);
257 peer->timer_need_another_keepalive = true;
260 /* Should be called after a handshake response message is received and processed
261 * or when getting key confirmation via the first data message.
264 wg_timers_handshake_complete (wg_peer_t * peer)
266 peer->rehandshake_started = ~0;
267 peer->timer_handshake_attempts = 0;
271 wg_timers_any_authenticated_packet_received (wg_peer_t * peer)
273 peer->last_received_packet = vlib_time_now (vlib_get_main ());
276 static vlib_node_registration_t wg_timer_mngr_node;
279 expired_timer_callback (u32 * expired_timers)
285 wg_main_t *wmp = &wg_main;
286 vlib_main_t *vm = wmp->vlib_main;
290 /* Need to invalidate all of them because one can restart other */
291 for (i = 0; i < vec_len (expired_timers); i++)
293 pool_index = expired_timers[i] & 0x0FFFFFFF;
294 timer_id = expired_timers[i] >> 28;
296 peer = wg_peer_get (pool_index);
297 peer->timers[timer_id] = ~0;
300 for (i = 0; i < vec_len (expired_timers); i++)
302 pool_index = expired_timers[i] & 0x0FFFFFFF;
303 timer_id = expired_timers[i] >> 28;
305 peer = wg_peer_get (pool_index);
308 case WG_TIMER_RETRANSMIT_HANDSHAKE:
309 wg_expired_retransmit_handshake (vm, peer);
311 case WG_TIMER_PERSISTENT_KEEPALIVE:
312 wg_expired_send_persistent_keepalive (vm, peer);
314 case WG_TIMER_SEND_KEEPALIVE:
315 wg_expired_send_keepalive (vm, peer);
317 case WG_TIMER_NEW_HANDSHAKE:
318 wg_expired_new_handshake (vm, peer);
320 case WG_TIMER_KEY_ZEROING:
321 wg_expired_zero_key_material (vm, peer);
330 wg_timer_wheel_init ()
332 wg_main_t *wmp = &wg_main;
333 tw_timer_wheel_16t_2w_512sl_t *tw = &wmp->timer_wheel;
334 tw_timer_wheel_init_16t_2w_512sl (tw,
335 expired_timer_callback,
336 WG_TICK /* timer period in s */ , ~0);
340 wg_timer_mngr_fn (vlib_main_t * vm, vlib_node_runtime_t * rt,
343 wg_main_t *wmp = &wg_main;
344 uword event_type = 0;
346 /* Park the process until the feature is configured */
349 vlib_process_wait_for_event (vm);
350 event_type = vlib_process_get_events (vm, 0);
351 if (event_type == WG_START_EVENT)
357 clib_warning ("Unknown event type %d", event_type);
361 * Reset the timer wheel time so it won't try to
362 * expire Avogadro's number of time slots.
364 wmp->timer_wheel.last_run_time = vlib_time_now (vm);
368 vlib_process_wait_for_event_or_clock (vm, WG_TICK);
369 vlib_process_get_events (vm, NULL);
371 tw_timer_expire_timers_16t_2w_512sl (&wmp->timer_wheel,
379 wg_timers_stop (wg_peer_t * peer)
381 ASSERT (vlib_get_thread_index () == 0);
382 if (peer->timer_wheel)
384 stop_timer (peer, WG_TIMER_RETRANSMIT_HANDSHAKE);
385 stop_timer (peer, WG_TIMER_PERSISTENT_KEEPALIVE);
386 stop_timer (peer, WG_TIMER_SEND_KEEPALIVE);
387 stop_timer (peer, WG_TIMER_NEW_HANDSHAKE);
388 stop_timer (peer, WG_TIMER_KEY_ZEROING);
393 VLIB_REGISTER_NODE (wg_timer_mngr_node, static) = {
394 .function = wg_timer_mngr_fn,
395 .type = VLIB_NODE_TYPE_PROCESS,
402 wg_feature_init (wg_main_t * wmp)
404 if (wmp->feature_init)
406 vlib_process_signal_event (wmp->vlib_main, wg_timer_mngr_node.index,
408 wmp->feature_init = 1;
414 * fd.io coding-style-patch-verification: ON
417 * eval: (c-set-style "gnu")