xref: /openbsd/usr.sbin/bgpd/session.h (revision 404b540a)
1 /*	$OpenBSD: session.h,v 1.102 2009/09/02 08:06:42 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 blockmodes {
69 	BM_NORMAL,
70 	BM_NONBLOCK
71 };
72 
73 enum msg_type {
74 	OPEN = 1,
75 	UPDATE,
76 	NOTIFICATION,
77 	KEEPALIVE,
78 	RREFRESH
79 };
80 
81 enum suberr_header {
82 	ERR_HDR_SYNC = 1,
83 	ERR_HDR_LEN,
84 	ERR_HDR_TYPE
85 };
86 
87 enum suberr_open {
88 	ERR_OPEN_VERSION = 1,
89 	ERR_OPEN_AS,
90 	ERR_OPEN_BGPID,
91 	ERR_OPEN_OPT,
92 	ERR_OPEN_AUTH,
93 	ERR_OPEN_HOLDTIME,
94 	ERR_OPEN_CAPA
95 };
96 
97 enum opt_params {
98 	OPT_PARAM_NONE,
99 	OPT_PARAM_AUTH,
100 	OPT_PARAM_CAPABILITIES
101 };
102 
103 enum capa_codes {
104 	CAPA_NONE,
105 	CAPA_MP,
106 	CAPA_REFRESH,
107 	CAPA_RESTART = 64,
108 	CAPA_AS4BYTE = 65
109 };
110 
111 struct bgp_msg {
112 	struct buf	*buf;
113 	enum msg_type	 type;
114 	u_int16_t	 len;
115 };
116 
117 struct msg_header {
118 	u_char			 marker[MSGSIZE_HEADER_MARKER];
119 	u_int16_t		 len;
120 	u_int8_t		 type;
121 };
122 
123 struct msg_open {
124 	struct msg_header	 header;
125 	u_int32_t		 bgpid;
126 	u_int16_t		 myas;
127 	u_int16_t		 holdtime;
128 	u_int8_t		 version;
129 	u_int8_t		 optparamlen;
130 };
131 
132 struct bgpd_sysdep {
133 	u_int8_t		no_pfkey;
134 	u_int8_t		no_md5sig;
135 };
136 
137 struct ctl_conn {
138 	TAILQ_ENTRY(ctl_conn)	entry;
139 	struct imsgbuf		ibuf;
140 	int			restricted;
141 };
142 
143 TAILQ_HEAD(ctl_conns, ctl_conn)	ctl_conns;
144 
145 struct peer_stats {
146 	u_int64_t		 msg_rcvd_open;
147 	u_int64_t		 msg_rcvd_update;
148 	u_int64_t		 msg_rcvd_notification;
149 	u_int64_t		 msg_rcvd_keepalive;
150 	u_int64_t		 msg_rcvd_rrefresh;
151 	u_int64_t		 msg_sent_open;
152 	u_int64_t		 msg_sent_update;
153 	u_int64_t		 msg_sent_notification;
154 	u_int64_t		 msg_sent_keepalive;
155 	u_int64_t		 msg_sent_rrefresh;
156 	u_int64_t		 prefix_rcvd_update;
157 	u_int64_t		 prefix_rcvd_withdraw;
158 	u_int64_t		 prefix_sent_update;
159 	u_int64_t		 prefix_sent_withdraw;
160 	time_t			 last_updown;
161 	time_t			 last_read;
162 	u_int32_t		 prefix_cnt;
163 	u_int8_t		 last_sent_errcode;
164 	u_int8_t		 last_sent_suberr;
165 };
166 
167 enum Timer {
168 	Timer_None,
169 	Timer_ConnectRetry,
170 	Timer_Keepalive,
171 	Timer_Hold,
172 	Timer_IdleHold,
173 	Timer_IdleHoldReset,
174 	Timer_CarpUndemote,
175 	Timer_Max
176 };
177 
178 struct peer_timer {
179 	TAILQ_ENTRY(peer_timer)	entry;
180 	enum Timer		type;
181 	time_t			val;
182 };
183 
184 TAILQ_HEAD(peer_timer_head, peer_timer);
185 
186 struct peer {
187 	struct peer_config	 conf;
188 	struct peer_stats	 stats;
189 	struct {
190 		struct capabilities	ann;
191 		struct capabilities	peer;
192 	}			 capa;
193 	struct {
194 		struct bgpd_addr	local_addr;
195 		u_int32_t		spi_in;
196 		u_int32_t		spi_out;
197 		enum auth_method	method;
198 		u_int8_t		established;
199 	} auth;
200 	struct sockaddr_storage	 sa_local;
201 	struct sockaddr_storage	 sa_remote;
202 	struct peer_timer_head	 timers;
203 	struct msgbuf		 wbuf;
204 	struct buf_read		*rbuf;
205 	struct peer		*next;
206 	int			 fd;
207 	int			 lasterr;
208 	u_int			 errcnt;
209 	u_int			 IdleHoldTime;
210 	u_int32_t		 remote_bgpid;
211 	enum session_state	 state;
212 	enum session_state	 prev_state;
213 	u_int16_t		 short_as;
214 	u_int16_t		 holdtime;
215 	u_int8_t		 depend_ok;
216 	u_int8_t		 demoted;
217 	u_int8_t		 passive;
218 };
219 
220 struct peer	*peers;
221 
222 struct ctl_timer {
223 	enum Timer	type;
224 	time_t		val;
225 };
226 
227 /* session.c */
228 void		 session_socket_blockmode(int, enum blockmodes);
229 pid_t		 session_main(struct bgpd_config *, struct peer *,
230 		    struct network_head *, struct filter_head *,
231 		    struct mrt_head *, struct rib_names *,
232 		    int[2], int[2], int[2], int[2]);
233 void		 bgp_fsm(struct peer *, enum session_events);
234 int		 session_neighbor_rrefresh(struct peer *p);
235 struct peer	*getpeerbyaddr(struct bgpd_addr *);
236 struct peer	*getpeerbydesc(const char *);
237 int		 imsg_compose_parent(int, pid_t, void *, u_int16_t);
238 int		 imsg_compose_rde(int, pid_t, void *, u_int16_t);
239 void	 	 session_stop(struct peer *, u_int8_t);
240 
241 /* log.c */
242 char		*log_fmt_peer(const struct peer_config *);
243 void		 log_statechange(struct peer *, enum session_state,
244 		    enum session_events);
245 void		 log_notification(const struct peer *, u_int8_t, u_int8_t,
246 		    u_char *, u_int16_t);
247 void		 log_conn_attempt(const struct peer *, struct sockaddr *);
248 
249 /* parse.y */
250 int	 parse_config(char *, struct bgpd_config *, struct mrt_head *,
251 	    struct peer **, struct network_head *, struct filter_head *);
252 
253 /* config.c */
254 int	 merge_config(struct bgpd_config *, struct bgpd_config *,
255 	    struct peer *, struct listen_addrs *);
256 void	 prepare_listeners(struct bgpd_config *);
257 
258 /* rde.c */
259 pid_t	 rde_main(struct bgpd_config *, struct peer *, struct network_head *,
260 	    struct filter_head *, struct mrt_head *, struct rib_names *,
261 	    int[2], int[2], int[2], int[2], int);
262 
263 /* control.c */
264 int	control_init(int, char *);
265 int	control_listen(int);
266 void	control_shutdown(int);
267 int	control_dispatch_msg(struct pollfd *, u_int *);
268 unsigned int	control_accept(int, int);
269 
270 /* pfkey.c */
271 int	pfkey_establish(struct peer *);
272 int	pfkey_remove(struct peer *);
273 int	pfkey_init(struct bgpd_sysdep *);
274 
275 /* printconf.c */
276 void	print_config(struct bgpd_config *, struct rib_names *,
277 	    struct network_head *, struct peer *, struct filter_head *,
278 	    struct mrt_head *);
279 
280 /* carp.c */
281 int	 carp_demote_init(char *, int);
282 void	 carp_demote_shutdown(void);
283 int	 carp_demote_get(char *);
284 int	 carp_demote_set(char *, int);
285 
286 /* timer.c */
287 struct peer_timer	*timer_get(struct peer *, enum Timer);
288 struct peer_timer	*timer_nextisdue(struct peer *);
289 time_t			 timer_nextduein(struct peer *);
290 int			 timer_running(struct peer *, enum Timer, time_t *);
291 void			 timer_set(struct peer *, enum Timer, u_int);
292 void			 timer_stop(struct peer *, enum Timer);
293 void			 timer_remove(struct peer *, enum Timer);
294 void			 timer_remove_all(struct peer *);
295