xref: /openbsd/usr.sbin/bgpd/session.h (revision 088a2cd9)
1 /*	$OpenBSD: session.h,v 1.170 2024/05/18 11:17:30 jsg Exp $ */
2 
3 /*
4  * Copyright (c) 2003, 2004 Henning Brauer <henning@openbsd.org>
5  *
6  * Permission to use, copy, modify, and distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 #include <sys/types.h>
20 #include <sys/socket.h>
21 #include <time.h>
22 
23 #define	MAX_BACKLOG			5
24 #define	INTERVAL_CONNECTRETRY		120
25 #define	INTERVAL_HOLD_INITIAL		240
26 #define	INTERVAL_HOLD			90
27 #define	INTERVAL_IDLE_HOLD_INITIAL	30
28 #define	INTERVAL_HOLD_CLONED		3600
29 #define	INTERVAL_HOLD_DEMOTED		60
30 #define	MAX_IDLE_HOLD			3600
31 #define	MSGSIZE_HEADER			19
32 #define	MSGSIZE_HEADER_MARKER		16
33 #define	MSGSIZE_NOTIFICATION_MIN	21	/* 19 hdr + 1 code + 1 sub */
34 #define	MSGSIZE_OPEN_MIN		29
35 #define	MSGSIZE_UPDATE_MIN		23
36 #define	MSGSIZE_KEEPALIVE		MSGSIZE_HEADER
37 #define	MSGSIZE_RREFRESH		(MSGSIZE_HEADER + 4)
38 #define	MSGSIZE_RREFRESH_MIN		MSGSIZE_RREFRESH
39 #define	MSG_PROCESS_LIMIT		25
40 #define	SESSION_CLEAR_DELAY		5
41 
42 enum session_state {
43 	STATE_NONE,
44 	STATE_IDLE,
45 	STATE_CONNECT,
46 	STATE_ACTIVE,
47 	STATE_OPENSENT,
48 	STATE_OPENCONFIRM,
49 	STATE_ESTABLISHED
50 };
51 
52 enum session_events {
53 	EVNT_NONE,
54 	EVNT_START,
55 	EVNT_STOP,
56 	EVNT_CON_OPEN,
57 	EVNT_CON_CLOSED,
58 	EVNT_CON_OPENFAIL,
59 	EVNT_CON_FATAL,
60 	EVNT_TIMER_CONNRETRY,
61 	EVNT_TIMER_HOLDTIME,
62 	EVNT_TIMER_KEEPALIVE,
63 	EVNT_TIMER_SENDHOLD,
64 	EVNT_RCVD_OPEN,
65 	EVNT_RCVD_KEEPALIVE,
66 	EVNT_RCVD_UPDATE,
67 	EVNT_RCVD_NOTIFICATION
68 };
69 
70 enum msg_type {
71 	OPEN = 1,
72 	UPDATE,
73 	NOTIFICATION,
74 	KEEPALIVE,
75 	RREFRESH
76 };
77 
78 enum suberr_header {
79 	ERR_HDR_SYNC = 1,
80 	ERR_HDR_LEN,
81 	ERR_HDR_TYPE
82 };
83 
84 enum suberr_open {
85 	ERR_OPEN_VERSION = 1,
86 	ERR_OPEN_AS,
87 	ERR_OPEN_BGPID,
88 	ERR_OPEN_OPT,
89 	ERR_OPEN_AUTH,			/* deprecated */
90 	ERR_OPEN_HOLDTIME,
91 	ERR_OPEN_CAPA,
92 	ERR_OPEN_ROLE = 11,
93 };
94 
95 enum suberr_fsm {
96 	ERR_FSM_UNSPECIFIC = 0,
97 	ERR_FSM_UNEX_OPENSENT,
98 	ERR_FSM_UNEX_OPENCONFIRM,
99 	ERR_FSM_UNEX_ESTABLISHED
100 };
101 
102 enum opt_params {
103 	OPT_PARAM_NONE,
104 	OPT_PARAM_AUTH,
105 	OPT_PARAM_CAPABILITIES,
106 	OPT_PARAM_EXT_LEN=255,
107 };
108 
109 struct bgp_msg {
110 	struct ibuf	*buf;
111 	enum msg_type	 type;
112 	uint16_t	 len;
113 };
114 
115 struct bgpd_sysdep {
116 	uint8_t			no_pfkey;
117 	uint8_t			no_md5sig;
118 };
119 
120 struct ctl_conn {
121 	TAILQ_ENTRY(ctl_conn)	entry;
122 	struct imsgbuf		imsgbuf;
123 	int			restricted;
124 	int			throttled;
125 	int			terminate;
126 };
127 
128 struct peer_stats {
129 	unsigned long long	 msg_rcvd_open;
130 	unsigned long long	 msg_rcvd_update;
131 	unsigned long long	 msg_rcvd_notification;
132 	unsigned long long	 msg_rcvd_keepalive;
133 	unsigned long long	 msg_rcvd_rrefresh;
134 	unsigned long long	 msg_sent_open;
135 	unsigned long long	 msg_sent_update;
136 	unsigned long long	 msg_sent_notification;
137 	unsigned long long	 msg_sent_keepalive;
138 	unsigned long long	 msg_sent_rrefresh;
139 	unsigned long long	 refresh_rcvd_req;
140 	unsigned long long	 refresh_rcvd_borr;
141 	unsigned long long	 refresh_rcvd_eorr;
142 	unsigned long long	 refresh_sent_req;
143 	unsigned long long	 refresh_sent_borr;
144 	unsigned long long	 refresh_sent_eorr;
145 	unsigned long long	 prefix_rcvd_update;
146 	unsigned long long	 prefix_rcvd_withdraw;
147 	unsigned long long	 prefix_rcvd_eor;
148 	unsigned long long	 prefix_sent_update;
149 	unsigned long long	 prefix_sent_withdraw;
150 	unsigned long long	 prefix_sent_eor;
151 	time_t			 last_updown;
152 	time_t			 last_read;
153 	time_t			 last_write;
154 	uint32_t		 prefix_cnt;
155 	uint32_t		 prefix_out_cnt;
156 	uint32_t		 pending_update;
157 	uint32_t		 pending_withdraw;
158 	uint8_t			 last_sent_errcode;
159 	uint8_t			 last_sent_suberr;
160 	uint8_t			 last_rcvd_errcode;
161 	uint8_t			 last_rcvd_suberr;
162 	char			 last_reason[REASON_LEN];
163 };
164 
165 enum Timer {
166 	Timer_None,
167 	Timer_ConnectRetry,
168 	Timer_Keepalive,
169 	Timer_Hold,
170 	Timer_SendHold,
171 	Timer_IdleHold,
172 	Timer_IdleHoldReset,
173 	Timer_CarpUndemote,
174 	Timer_RestartTimeout,
175 	Timer_Rtr_Refresh,
176 	Timer_Rtr_Retry,
177 	Timer_Rtr_Expire,
178 	Timer_Rtr_Active,
179 	Timer_Max
180 };
181 
182 struct timer {
183 	TAILQ_ENTRY(timer)	entry;
184 	enum Timer		type;
185 	time_t			val;
186 };
187 
188 TAILQ_HEAD(timer_head, timer);
189 
190 struct peer {
191 	struct peer_config	 conf;
192 	struct peer_stats	 stats;
193 	RB_ENTRY(peer)		 entry;
194 	struct {
195 		struct capabilities	ann;
196 		struct capabilities	peer;
197 		struct capabilities	neg;
198 	}			 capa;
199 	struct {
200 		struct bgpd_addr	local_addr;
201 		uint32_t		spi_in;
202 		uint32_t		spi_out;
203 		enum auth_method	method;
204 		uint8_t			established;
205 	}			 auth;
206 	struct bgpd_addr	 local;
207 	struct bgpd_addr	 local_alt;
208 	struct bgpd_addr	 remote;
209 	struct timer_head	 timers;
210 	struct msgbuf		 wbuf;
211 	struct ibuf_read	*rbuf;
212 	struct peer		*template;
213 	int			 fd;
214 	int			 lasterr;
215 	u_int			 errcnt;
216 	u_int			 IdleHoldTime;
217 	unsigned int		 if_scope;	/* interface scope for IPv6 */
218 	uint32_t		 remote_bgpid;
219 	enum session_state	 state;
220 	enum session_state	 prev_state;
221 	enum reconf_action	 reconf_action;
222 	enum role		 remote_role;
223 	uint16_t		 short_as;
224 	uint16_t		 holdtime;
225 	uint16_t		 local_port;
226 	uint16_t		 remote_port;
227 	uint8_t			 depend_ok;
228 	uint8_t			 demoted;
229 	uint8_t			 passive;
230 	uint8_t			 throttled;
231 	uint8_t			 rpending;
232 };
233 
234 extern time_t		 pauseaccept;
235 
236 struct ctl_timer {
237 	enum Timer	type;
238 	time_t		val;
239 };
240 
241 /* carp.c */
242 int	 carp_demote_init(char *, int);
243 void	 carp_demote_shutdown(void);
244 int	 carp_demote_get(char *);
245 int	 carp_demote_set(char *, int);
246 
247 /* config.c */
248 void	 merge_config(struct bgpd_config *, struct bgpd_config *);
249 int	 prepare_listeners(struct bgpd_config *);
250 
251 /* control.c */
252 int	control_check(char *);
253 int	control_init(int, char *);
254 int	control_listen(int);
255 size_t	control_fill_pfds(struct pollfd *, size_t);
256 void	control_shutdown(int);
257 int	control_dispatch_msg(struct pollfd *, struct peer_head *);
258 unsigned int	control_accept(int, int);
259 
260 /* log.c */
261 char	*log_fmt_peer(const struct peer_config *);
262 void	 log_statechange(struct peer *, enum session_state,
263 	    enum session_events);
264 void	 log_notification(const struct peer *, uint8_t, uint8_t,
265 	    const struct ibuf *, const char *);
266 void	 log_conn_attempt(const struct peer *, struct sockaddr *,
267 	    socklen_t);
268 
269 /* mrt.c */
270 void	 mrt_dump_bgp_msg(struct mrt *, void *, uint16_t,
271 	    struct peer *, enum msg_type);
272 void	 mrt_dump_state(struct mrt *, uint16_t, uint16_t,
273 	    struct peer *);
274 void	 mrt_done(struct mrt *);
275 
276 /* pfkey.c */
277 struct sadb_msg;
278 int	pfkey_read(int, struct sadb_msg *);
279 int	pfkey_establish(struct peer *);
280 int	pfkey_remove(struct peer *);
281 int	pfkey_init(void);
282 int	tcp_md5_check(int, struct peer *);
283 int	tcp_md5_set(int, struct peer *);
284 int	tcp_md5_prep_listener(struct listen_addr *, struct peer_head *);
285 void	tcp_md5_add_listener(struct bgpd_config *, struct peer *);
286 void	tcp_md5_del_listener(struct bgpd_config *, struct peer *);
287 
288 /* printconf.c */
289 void	print_config(struct bgpd_config *, struct rib_names *);
290 
291 /* rde.c */
292 void	rde_main(int, int);
293 
294 /* rtr_proto.c */
295 struct rtr_session;
296 size_t			 rtr_count(void);
297 void			 rtr_check_events(struct pollfd *, size_t);
298 size_t			 rtr_poll_events(struct pollfd *, size_t, time_t *);
299 struct rtr_session	*rtr_new(uint32_t, char *);
300 struct rtr_session	*rtr_get(uint32_t);
301 void			 rtr_free(struct rtr_session *);
302 void			 rtr_open(struct rtr_session *, int);
303 void			 rtr_config_prep(void);
304 void			 rtr_config_merge(void);
305 void			 rtr_config_keep(struct rtr_session *);
306 void			 rtr_roa_merge(struct roa_tree *);
307 void			 rtr_aspa_merge(struct aspa_tree *);
308 void			 rtr_shutdown(void);
309 void			 rtr_show(struct rtr_session *, pid_t);
310 
311 /* rtr.c */
312 void	rtr_sem_acquire(int);
313 void	rtr_sem_release(int);
314 void	rtr_roa_insert(struct roa_tree *, struct roa *);
315 void	rtr_aspa_insert(struct aspa_tree *, struct aspa_set *);
316 void	rtr_main(int, int);
317 void	rtr_imsg_compose(int, uint32_t, pid_t, void *, size_t);
318 void	rtr_recalc(void);
319 
320 /* session.c */
321 RB_PROTOTYPE(peer_head, peer, entry, peer_compare);
322 
323 void		 session_main(int, int);
324 void		 bgp_fsm(struct peer *, enum session_events);
325 int		 session_neighbor_rrefresh(struct peer *p);
326 struct peer	*getpeerbydesc(struct bgpd_config *, const char *);
327 struct peer	*getpeerbyip(struct bgpd_config *, struct sockaddr *);
328 struct peer	*getpeerbyid(struct bgpd_config *, uint32_t);
329 int		 peer_matched(struct peer *, struct ctl_neighbor *);
330 int		 imsg_ctl_parent(struct imsg *);
331 int		 imsg_ctl_rde(struct imsg *);
332 int		 imsg_ctl_rde_msg(int, uint32_t, pid_t);
333 void		 session_stop(struct peer *, uint8_t, const char *);
334 
335 /* timer.c */
336 struct timer	*timer_get(struct timer_head *, enum Timer);
337 struct timer	*timer_nextisdue(struct timer_head *, time_t);
338 time_t		 timer_nextduein(struct timer_head *, time_t);
339 int		 timer_running(struct timer_head *, enum Timer, time_t *);
340 void		 timer_set(struct timer_head *, enum Timer, u_int);
341 void		 timer_stop(struct timer_head *, enum Timer);
342 void		 timer_remove(struct timer_head *, enum Timer);
343 void		 timer_remove_all(struct timer_head *);
344