xref: /openbsd-src/usr.sbin/bgpd/session.h (revision f2da64fbbbf1b03f09f390ab01267c93dfd77c4c)
1 /*	$OpenBSD: session.h,v 1.121 2015/10/25 18:49:01 claudio 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	MSG_PROCESS_LIMIT		25
39 #define	SESSION_CLEAR_DELAY		5
40 
41 enum session_state {
42 	STATE_NONE,
43 	STATE_IDLE,
44 	STATE_CONNECT,
45 	STATE_ACTIVE,
46 	STATE_OPENSENT,
47 	STATE_OPENCONFIRM,
48 	STATE_ESTABLISHED
49 };
50 
51 enum session_events {
52 	EVNT_NONE,
53 	EVNT_START,
54 	EVNT_STOP,
55 	EVNT_CON_OPEN,
56 	EVNT_CON_CLOSED,
57 	EVNT_CON_OPENFAIL,
58 	EVNT_CON_FATAL,
59 	EVNT_TIMER_CONNRETRY,
60 	EVNT_TIMER_HOLDTIME,
61 	EVNT_TIMER_KEEPALIVE,
62 	EVNT_RCVD_OPEN,
63 	EVNT_RCVD_KEEPALIVE,
64 	EVNT_RCVD_UPDATE,
65 	EVNT_RCVD_NOTIFICATION
66 };
67 
68 enum msg_type {
69 	OPEN = 1,
70 	UPDATE,
71 	NOTIFICATION,
72 	KEEPALIVE,
73 	RREFRESH
74 };
75 
76 enum suberr_header {
77 	ERR_HDR_SYNC = 1,
78 	ERR_HDR_LEN,
79 	ERR_HDR_TYPE
80 };
81 
82 enum suberr_open {
83 	ERR_OPEN_VERSION = 1,
84 	ERR_OPEN_AS,
85 	ERR_OPEN_BGPID,
86 	ERR_OPEN_OPT,
87 	ERR_OPEN_AUTH,
88 	ERR_OPEN_HOLDTIME,
89 	ERR_OPEN_CAPA,
90 	ERR_OPEN_GROUP_CONFLICT,	/* draft-ietf-idr-bgp-multisession-07 */
91 	ERR_OPEN_GROUP_REQUIRED		/* draft-ietf-idr-bgp-multisession-07 */
92 };
93 
94 enum suberr_fsm {
95 	ERR_FSM_UNSPECIFIC = 0,
96 	ERR_FSM_UNEX_OPENSENT,
97 	ERR_FSM_UNEX_OPENCONFIRM,
98 	ERR_FSM_UNEX_ESTABLISHED
99 };
100 
101 enum opt_params {
102 	OPT_PARAM_NONE,
103 	OPT_PARAM_AUTH,
104 	OPT_PARAM_CAPABILITIES
105 };
106 
107 enum capa_codes {
108 	CAPA_NONE,
109 	CAPA_MP,
110 	CAPA_REFRESH,
111 	CAPA_RESTART = 64,
112 	CAPA_AS4BYTE = 65
113 };
114 
115 struct bgp_msg {
116 	struct ibuf	*buf;
117 	enum msg_type	 type;
118 	u_int16_t	 len;
119 };
120 
121 struct msg_header {
122 	u_char			 marker[MSGSIZE_HEADER_MARKER];
123 	u_int16_t		 len;
124 	u_int8_t		 type;
125 };
126 
127 struct msg_open {
128 	struct msg_header	 header;
129 	u_int32_t		 bgpid;
130 	u_int16_t		 myas;
131 	u_int16_t		 holdtime;
132 	u_int8_t		 version;
133 	u_int8_t		 optparamlen;
134 };
135 
136 struct bgpd_sysdep {
137 	u_int8_t		no_pfkey;
138 	u_int8_t		no_md5sig;
139 };
140 
141 struct ctl_conn {
142 	TAILQ_ENTRY(ctl_conn)	entry;
143 	struct imsgbuf		ibuf;
144 	int			restricted;
145 };
146 
147 TAILQ_HEAD(ctl_conns, ctl_conn)	ctl_conns;
148 
149 struct peer_stats {
150 	u_int64_t		 msg_rcvd_open;
151 	u_int64_t		 msg_rcvd_update;
152 	u_int64_t		 msg_rcvd_notification;
153 	u_int64_t		 msg_rcvd_keepalive;
154 	u_int64_t		 msg_rcvd_rrefresh;
155 	u_int64_t		 msg_sent_open;
156 	u_int64_t		 msg_sent_update;
157 	u_int64_t		 msg_sent_notification;
158 	u_int64_t		 msg_sent_keepalive;
159 	u_int64_t		 msg_sent_rrefresh;
160 	u_int64_t		 prefix_rcvd_update;
161 	u_int64_t		 prefix_rcvd_withdraw;
162 	u_int64_t		 prefix_rcvd_eor;
163 	u_int64_t		 prefix_sent_update;
164 	u_int64_t		 prefix_sent_withdraw;
165 	u_int64_t		 prefix_sent_eor;
166 	time_t			 last_updown;
167 	time_t			 last_read;
168 	u_int32_t		 prefix_cnt;
169 	u_int8_t		 last_sent_errcode;
170 	u_int8_t		 last_sent_suberr;
171 };
172 
173 enum Timer {
174 	Timer_None,
175 	Timer_ConnectRetry,
176 	Timer_Keepalive,
177 	Timer_Hold,
178 	Timer_IdleHold,
179 	Timer_IdleHoldReset,
180 	Timer_CarpUndemote,
181 	Timer_RestartTimeout,
182 	Timer_Max
183 };
184 
185 struct peer_timer {
186 	TAILQ_ENTRY(peer_timer)	entry;
187 	enum Timer		type;
188 	time_t			val;
189 };
190 
191 TAILQ_HEAD(peer_timer_head, peer_timer);
192 
193 struct peer {
194 	struct peer_config	 conf;
195 	struct peer_stats	 stats;
196 	struct {
197 		struct capabilities	ann;
198 		struct capabilities	peer;
199 		struct capabilities	neg;
200 	}			 capa;
201 	struct {
202 		struct bgpd_addr	local_addr;
203 		u_int32_t		spi_in;
204 		u_int32_t		spi_out;
205 		enum auth_method	method;
206 		u_int8_t		established;
207 	} auth;
208 	struct sockaddr_storage	 sa_local;
209 	struct sockaddr_storage	 sa_remote;
210 	struct peer_timer_head	 timers;
211 	struct msgbuf		 wbuf;
212 	struct ibuf_read	*rbuf;
213 	struct peer		*next;
214 	struct peer		*template;
215 	int			 fd;
216 	int			 lasterr;
217 	u_int			 errcnt;
218 	u_int			 IdleHoldTime;
219 	u_int32_t		 remote_bgpid;
220 	enum session_state	 state;
221 	enum session_state	 prev_state;
222 	u_int16_t		 short_as;
223 	u_int16_t		 holdtime;
224 	u_int8_t		 depend_ok;
225 	u_int8_t		 demoted;
226 	u_int8_t		 passive;
227 };
228 
229 extern struct peer	*peers;
230 extern time_t		 pauseaccept;
231 
232 struct ctl_timer {
233 	enum Timer	type;
234 	time_t		val;
235 };
236 
237 /* carp.c */
238 int	 carp_demote_init(char *, int);
239 void	 carp_demote_shutdown(void);
240 int	 carp_demote_get(char *);
241 int	 carp_demote_set(char *, int);
242 
243 /* config.c */
244 int	 merge_config(struct bgpd_config *, struct bgpd_config *,
245 	    struct peer *);
246 void	 prepare_listeners(struct bgpd_config *);
247 int	 get_mpe_label(struct rdomain *);
248 
249 /* control.c */
250 int	control_init(int, char *);
251 int	control_listen(int);
252 void	control_shutdown(int);
253 int	control_dispatch_msg(struct pollfd *, u_int *);
254 unsigned int	control_accept(int, int);
255 
256 /* log.c */
257 char		*log_fmt_peer(const struct peer_config *);
258 void		 log_statechange(struct peer *, enum session_state,
259 		    enum session_events);
260 void		 log_notification(const struct peer *, u_int8_t, u_int8_t,
261 		    u_char *, u_int16_t, const char *);
262 void		 log_conn_attempt(const struct peer *, struct sockaddr *);
263 
264 /* mrt.c */
265 void		 mrt_dump_bgp_msg(struct mrt *, void *, u_int16_t,
266 		     struct peer *);
267 void		 mrt_dump_state(struct mrt *, u_int16_t, u_int16_t,
268 		     struct peer *);
269 void		 mrt_done(void *);
270 
271 /* parse.y */
272 int	 parse_config(char *, struct bgpd_config *, struct peer **);
273 
274 /* pfkey.c */
275 int	pfkey_read(int, struct sadb_msg *);
276 int	pfkey_establish(struct peer *);
277 int	pfkey_remove(struct peer *);
278 int	pfkey_init(struct bgpd_sysdep *);
279 
280 /* printconf.c */
281 void	print_config(struct bgpd_config *, struct rib_names *,
282 	    struct network_head *, struct peer *, struct filter_head *,
283 	    struct mrt_head *, struct rdomain_head *);
284 
285 /* rde.c */
286 void	 rde_main(int, int);
287 
288 /* session.c */
289 void		 session_main(int, int);
290 void		 bgp_fsm(struct peer *, enum session_events);
291 int		 session_neighbor_rrefresh(struct peer *p);
292 struct peer	*getpeerbyaddr(struct bgpd_addr *);
293 struct peer	*getpeerbydesc(const char *);
294 int		 imsg_ctl_parent(int, u_int32_t, pid_t, void *, u_int16_t);
295 int		 imsg_ctl_rde(int, pid_t, void *, u_int16_t);
296 void	 	 session_stop(struct peer *, u_int8_t);
297 
298 /* timer.c */
299 time_t			 getmonotime(void);
300 struct peer_timer	*timer_get(struct peer *, enum Timer);
301 struct peer_timer	*timer_nextisdue(struct peer *);
302 time_t			 timer_nextduein(struct peer *);
303 int			 timer_running(struct peer *, enum Timer, time_t *);
304 void			 timer_set(struct peer *, enum Timer, u_int);
305 void			 timer_stop(struct peer *, enum Timer);
306 void			 timer_remove(struct peer *, enum Timer);
307 void			 timer_remove_all(struct peer *);
308