src/plugins/wireguard/wireguard_peer.h

   1 /*
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15
  16 #ifndef __included_wg_peer_h__
  17 #define __included_wg_peer_h__
  18
  19 #include <vnet/ip/ip.h>
  20
  21 #include <wireguard/wireguard_cookie.h>
  22 #include <wireguard/wireguard_timer.h>
  23 #include <wireguard/wireguard_key.h>
  24 #include <wireguard/wireguard_messages.h>
  25 #include <wireguard/wireguard_if.h>
  26
  27 typedef struct ip4_udp_header_t_
  28 {
  29   ip4_header_t ip4;
  30   udp_header_t udp;
  31 } __clib_packed ip4_udp_header_t;
  32
  33 u8 *format_ip4_udp_header (u8 * s, va_list * va);
  34
  35 typedef struct wg_peer_allowed_ip_t_
  36 {
  37   fib_prefix_t prefix;
  38   fib_node_index_t fib_entry_index;
  39 } wg_peer_allowed_ip_t;
  40
  41 typedef struct wg_peer_endpoint_t_
  42 {
  43   ip46_address_t addr;
  44   u16 port;
  45 } wg_peer_endpoint_t;
  46
  47 typedef struct wg_peer
  48 {
  49   noise_remote_t remote;
  50   cookie_maker_t cookie_maker;
  51
  52   u32 input_thread_index;
  53   u32 output_thread_index;
  54
  55   /* Peer addresses */
  56   wg_peer_endpoint_t dst;
  57   wg_peer_endpoint_t src;
  58   u32 table_id;
  59   adj_index_t adj_index;
  60
  61   /* rewrite built from address information */
  62   u8 *rewrite;
  63
  64   /* Vector of allowed-ips */
  65   wg_peer_allowed_ip_t *allowed_ips;
  66
  67   /* The WG interface this peer is attached to */
  68   u32 wg_sw_if_index;
  69
  70   /* Timers */
  71   tw_timer_wheel_16t_2w_512sl_t *timer_wheel;
  72   u32 timers[WG_N_TIMERS];
  73   u32 timer_handshake_attempts;
  74   u16 persistent_keepalive_interval;
  75
  76   /* Timestamps */
  77   f64 last_sent_handshake;
  78   f64 last_sent_packet;
  79   f64 last_received_packet;
  80   f64 session_derived;
  81   f64 rehandshake_started;
  82
  83   /* Variable intervals */
  84   u32 new_handshake_interval_tick;
  85   u32 rehandshake_interval_tick;
  86
  87   bool timer_need_another_keepalive;
  88
  89   bool is_dead;
  90 } wg_peer_t;
  91
  92 typedef struct wg_peer_table_bind_ctx_t_
  93 {
  94   ip_address_family_t af;
  95   u32 new_fib_index;
  96   u32 old_fib_index;
  97 } wg_peer_table_bind_ctx_t;
  98
  99 int wg_peer_add (u32 tun_sw_if_index,
 100                  const u8 public_key_64[NOISE_PUBLIC_KEY_LEN],
 101                  u32 table_id,
 102                  const ip46_address_t * endpoint,
 103                  const fib_prefix_t * allowed_ips,
 104                  u16 port, u16 persistent_keepalive, index_t * peer_index);
 105 int wg_peer_remove (u32 peer_index);
 106
 107 typedef walk_rc_t (*wg_peer_walk_cb_t) (index_t peeri, void *arg);
 108 index_t wg_peer_walk (wg_peer_walk_cb_t fn, void *data);
 109
 110 u8 *format_wg_peer (u8 * s, va_list * va);
 111
 112 walk_rc_t wg_peer_if_admin_state_change (wg_if_t * wgi, index_t peeri,
 113                                          void *data);
 114 walk_rc_t wg_peer_if_table_change (wg_if_t * wgi, index_t peeri, void *data);
 115
 116 /*
 117  * Expoed for the data-plane
 118  */
 119 extern index_t *wg_peer_by_adj_index;
 120 extern wg_peer_t *wg_peer_pool;
 121
 122 static inline wg_peer_t *
 123 wg_peer_get (index_t peeri)
 124 {
 125   return (pool_elt_at_index (wg_peer_pool, peeri));
 126 }
 127
 128 static inline index_t
 129 wg_peer_get_by_adj_index (index_t ai)
 130 {
 131   return (wg_peer_by_adj_index[ai]);
 132 }
 133
 134 /*
 135  * Makes choice for thread_id should be assigned.
 136 */
 137 static inline u32
 138 wg_peer_assign_thread (u32 thread_id)
 139 {
 140   return ((thread_id) ? thread_id
 141           : (vlib_num_workers ()?
 142              ((unix_time_now_nsec () % vlib_num_workers ()) +
 143               1) : thread_id));
 144 }
 145
 146 #endif // __included_wg_peer_h__
 147
 148 /*
 149  * fd.io coding-style-patch-verification: ON
 150  *
 151  * Local Variables:
 152  * eval: (c-set-style "gnu")
 153  * End:
 154  */