xref: /freebsd/contrib/tcpdump/ospf.h (revision ea906c4152774dff300bb26fbfc1e4188351c89a)
1 /* @(#) $Header: /tcpdump/master/tcpdump/ospf.h,v 1.16.2.2 2006/12/13 08:24:27 hannes Exp $ (LBL) */
2 /*
3  * Copyright (c) 1991, 1993, 1994, 1995, 1996, 1997
4  *	The Regents of the University of California.  All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that: (1) source code distributions
8  * retain the above copyright notice and this paragraph in its entirety, (2)
9  * distributions including binary code include the above copyright notice and
10  * this paragraph in its entirety in the documentation or other materials
11  * provided with the distribution, and (3) all advertising materials mentioning
12  * features or use of this software display the following acknowledgement:
13  * ``This product includes software developed by the University of California,
14  * Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
15  * the University nor the names of its contributors may be used to endorse
16  * or promote products derived from this software without specific prior
17  * written permission.
18  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
19  * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
20  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
21  *
22  * OSPF support contributed by Jeffrey Honig (jch@mitchell.cit.cornell.edu)
23  */
24 #define	OSPF_TYPE_UMD           0	/* UMd's special monitoring packets */
25 #define	OSPF_TYPE_HELLO         1	/* Hello */
26 #define	OSPF_TYPE_DD            2	/* Database Description */
27 #define	OSPF_TYPE_LS_REQ        3	/* Link State Request */
28 #define	OSPF_TYPE_LS_UPDATE     4	/* Link State Update */
29 #define	OSPF_TYPE_LS_ACK        5	/* Link State Ack */
30 
31 /* Options field
32  *
33  * +------------------------------------+
34  * | * | O | DC | EA | N/P | MC | E | T |
35  * +------------------------------------+
36  *
37  */
38 
39 #define OSPF_OPTION_T	0x01	/* T bit: TOS support	*/
40 #define OSPF_OPTION_E	0x02	/* E bit: External routes advertised	*/
41 #define	OSPF_OPTION_MC	0x04	/* MC bit: Multicast capable */
42 #define	OSPF_OPTION_NP	0x08	/* N/P bit: NSSA capable */
43 #define	OSPF_OPTION_EA	0x10	/* EA bit: External Attribute capable */
44 #define	OSPF_OPTION_DC	0x20	/* DC bit: Demand circuit capable */
45 #define	OSPF_OPTION_O	0x40	/* O bit: Opaque LSA capable */
46 #define	OSPF_OPTION_DN	0x80	/* DN bit: Up/Down Bit capable - draft-ietf-ospf-2547-dnbit-04 */
47 
48 /* ospf_authtype	*/
49 #define	OSPF_AUTH_NONE		0	/* No auth-data */
50 #define	OSPF_AUTH_SIMPLE	1	/* Simple password */
51 #define OSPF_AUTH_SIMPLE_LEN	8	/* max length of simple authentication */
52 #define OSPF_AUTH_MD5		2	/* MD5 authentication */
53 #define OSPF_AUTH_MD5_LEN	16	/* length of MD5 authentication */
54 
55 /* db_flags	*/
56 #define	OSPF_DB_INIT		0x04	    /*	*/
57 #define	OSPF_DB_MORE		0x02
58 #define	OSPF_DB_MASTER		0x01
59 
60 /* ls_type	*/
61 #define	LS_TYPE_ROUTER		1   /* router link */
62 #define	LS_TYPE_NETWORK		2   /* network link */
63 #define	LS_TYPE_SUM_IP		3   /* summary link */
64 #define	LS_TYPE_SUM_ABR		4   /* summary area link */
65 #define	LS_TYPE_ASE		5   /* ASE  */
66 #define	LS_TYPE_GROUP		6   /* Group membership (multicast */
67 				    /* extensions 23 July 1991) */
68 #define	LS_TYPE_NSSA            7   /* rfc3101 - Not so Stubby Areas */
69 #define	LS_TYPE_OPAQUE_LL       9   /* rfc2370 - Opaque Link Local */
70 #define	LS_TYPE_OPAQUE_AL      10   /* rfc2370 - Opaque Link Local */
71 #define	LS_TYPE_OPAQUE_DW      11   /* rfc2370 - Opaque Domain Wide */
72 
73 #define LS_OPAQUE_TYPE_TE       1   /* rfc3630 */
74 #define LS_OPAQUE_TYPE_GRACE    3   /* rfc3623 */
75 #define LS_OPAQUE_TYPE_RI       4   /* draft-ietf-ospf-cap-03 */
76 
77 #define LS_OPAQUE_TE_TLV_ROUTER 1   /* rfc3630 */
78 #define LS_OPAQUE_TE_TLV_LINK   2   /* rfc3630 */
79 
80 #define LS_OPAQUE_TE_LINK_SUBTLV_LINK_TYPE             1 /* rfc3630 */
81 #define LS_OPAQUE_TE_LINK_SUBTLV_LINK_ID               2 /* rfc3630 */
82 #define LS_OPAQUE_TE_LINK_SUBTLV_LOCAL_IP              3 /* rfc3630 */
83 #define LS_OPAQUE_TE_LINK_SUBTLV_REMOTE_IP             4 /* rfc3630 */
84 #define LS_OPAQUE_TE_LINK_SUBTLV_TE_METRIC             5 /* rfc3630 */
85 #define LS_OPAQUE_TE_LINK_SUBTLV_MAX_BW                6 /* rfc3630 */
86 #define LS_OPAQUE_TE_LINK_SUBTLV_MAX_RES_BW            7 /* rfc3630 */
87 #define LS_OPAQUE_TE_LINK_SUBTLV_UNRES_BW              8 /* rfc3630 */
88 #define LS_OPAQUE_TE_LINK_SUBTLV_ADMIN_GROUP           9 /* rfc3630 */
89 #define LS_OPAQUE_TE_LINK_SUBTLV_LINK_LOCAL_REMOTE_ID 11 /* draft-ietf-ccamp-ospf-gmpls-extensions */
90 #define LS_OPAQUE_TE_LINK_SUBTLV_LINK_PROTECTION_TYPE 14 /* draft-ietf-ccamp-ospf-gmpls-extensions */
91 #define LS_OPAQUE_TE_LINK_SUBTLV_INTF_SW_CAP_DESCR    15 /* draft-ietf-ccamp-ospf-gmpls-extensions */
92 #define LS_OPAQUE_TE_LINK_SUBTLV_SHARED_RISK_GROUP    16 /* draft-ietf-ccamp-ospf-gmpls-extensions */
93 #define LS_OPAQUE_TE_LINK_SUBTLV_BW_CONSTRAINTS       17 /* rfc4124 */
94 
95 #define LS_OPAQUE_TE_LINK_SUBTLV_LINK_TYPE_PTP        1  /* rfc3630 */
96 #define LS_OPAQUE_TE_LINK_SUBTLV_LINK_TYPE_MA         2  /* rfc3630 */
97 
98 #define LS_OPAQUE_GRACE_TLV_PERIOD       1 /* rfc3623 */
99 #define LS_OPAQUE_GRACE_TLV_REASON       2 /* rfc3623 */
100 #define LS_OPAQUE_GRACE_TLV_INT_ADDRESS  3 /* rfc3623 */
101 
102 #define LS_OPAQUE_GRACE_TLV_REASON_UNKNOWN     0 /* rfc3623 */
103 #define LS_OPAQUE_GRACE_TLV_REASON_SW_RESTART  1 /* rfc3623 */
104 #define LS_OPAQUE_GRACE_TLV_REASON_SW_UPGRADE  2 /* rfc3623 */
105 #define LS_OPAQUE_GRACE_TLV_REASON_CP_SWITCH   3 /* rfc3623 */
106 
107 #define LS_OPAQUE_RI_TLV_CAP             1 /* draft-ietf-ospf-cap-03 */
108 
109 /*************************************************
110  *
111  * is the above a bug in the documentation?
112  *
113  *************************************************/
114 
115 
116 /* rla_link.link_type	*/
117 #define	RLA_TYPE_ROUTER		1   /* point-to-point to another router	*/
118 #define	RLA_TYPE_TRANSIT	2   /* connection to transit network	*/
119 #define	RLA_TYPE_STUB		3   /* connection to stub network	*/
120 #define RLA_TYPE_VIRTUAL	4   /* virtual link			*/
121 
122 /* rla_flags	*/
123 #define	RLA_FLAG_B	0x01
124 #define	RLA_FLAG_E	0x02
125 #define	RLA_FLAG_W1	0x04
126 #define	RLA_FLAG_W2	0x08
127 
128 /* sla_tosmetric breakdown	*/
129 #define	SLA_MASK_TOS		0x7f000000
130 #define	SLA_MASK_METRIC		0x00ffffff
131 #define SLA_SHIFT_TOS		24
132 
133 /* asla_tosmetric breakdown	*/
134 #define	ASLA_FLAG_EXTERNAL	0x80000000
135 #define	ASLA_MASK_TOS		0x7f000000
136 #define	ASLA_SHIFT_TOS		24
137 #define	ASLA_MASK_METRIC	0x00ffffff
138 
139 /* multicast vertex type */
140 #define	MCLA_VERTEX_ROUTER	1
141 #define	MCLA_VERTEX_NETWORK	2
142 
143 /* link state advertisement header */
144 struct lsa_hdr {
145     u_int16_t ls_age;
146     u_int8_t ls_options;
147     u_int8_t ls_type;
148     union {
149         struct in_addr lsa_id;
150         struct { /* opaque LSAs change the LSA-ID field */
151             u_int8_t opaque_type;
152             u_int8_t opaque_id[3];
153 	} opaque_field;
154     } un_lsa_id;
155     struct in_addr ls_router;
156     u_int32_t ls_seq;
157     u_int16_t ls_chksum;
158     u_int16_t ls_length;
159 };
160 
161 /* link state advertisement */
162 struct lsa {
163     struct lsa_hdr ls_hdr;
164 
165     /* Link state types */
166     union {
167 	/* Router links advertisements */
168 	struct {
169 	    u_int8_t rla_flags;
170 	    u_int8_t rla_zero[1];
171 	    u_int16_t rla_count;
172 	    struct rlalink {
173 		struct in_addr link_id;
174 		struct in_addr link_data;
175 		u_int8_t link_type;
176 		u_int8_t link_toscount;
177 		u_int16_t link_tos0metric;
178 	    } rla_link[1];		/* may repeat	*/
179 	} un_rla;
180 
181 	/* Network links advertisements */
182 	struct {
183 	    struct in_addr nla_mask;
184 	    struct in_addr nla_router[1];	/* may repeat	*/
185 	} un_nla;
186 
187 	/* Summary links advertisements */
188 	struct {
189 	    struct in_addr sla_mask;
190 	    u_int32_t sla_tosmetric[1];	/* may repeat	*/
191 	} un_sla;
192 
193 	/* AS external links advertisements */
194 	struct {
195 	    struct in_addr asla_mask;
196 	    struct aslametric {
197 		u_int32_t asla_tosmetric;
198 		struct in_addr asla_forward;
199 		struct in_addr asla_tag;
200 	    } asla_metric[1];		/* may repeat	*/
201 	} un_asla;
202 
203 	/* Multicast group membership */
204 	struct mcla {
205 	    u_int32_t mcla_vtype;
206 	    struct in_addr mcla_vid;
207 	} un_mcla[1];
208 
209         /* Opaque TE LSA */
210         struct {
211 	    u_int16_t type;
212 	    u_int16_t length;
213 	    u_int8_t data[1]; /* may repeat   */
214 	} un_te_lsa_tlv;
215 
216         /* Opaque Grace LSA */
217         struct {
218 	    u_int16_t type;
219 	    u_int16_t length;
220 	    u_int8_t data[1]; /* may repeat   */
221 	} un_grace_tlv;
222 
223         /* Opaque Router information LSA */
224         struct {
225 	    u_int16_t type;
226 	    u_int16_t length;
227 	    u_int8_t data[1]; /* may repeat   */
228 	} un_ri_tlv;
229 
230         /* Unknown LSA */
231         struct unknown {
232 	    u_int8_t data[1]; /* may repeat   */
233 	} un_unknown[1];
234 
235     } lsa_un;
236 };
237 
238 
239 /*
240  * TOS metric struct (will be 0 or more in router links update)
241  */
242 struct tos_metric {
243     u_int8_t tos_type;
244     u_int8_t tos_zero;
245     u_int16_t tos_metric;
246 };
247 
248 #define	OSPF_AUTH_SIZE	8
249 
250 /*
251  * the main header
252  */
253 struct ospfhdr {
254     u_int8_t ospf_version;
255     u_int8_t ospf_type;
256     u_int16_t ospf_len;
257     struct in_addr ospf_routerid;
258     struct in_addr ospf_areaid;
259     u_int16_t ospf_chksum;
260     u_int16_t ospf_authtype;
261     u_int8_t ospf_authdata[OSPF_AUTH_SIZE];
262     union {
263 
264 	/* Hello packet */
265 	struct {
266 	    struct in_addr hello_mask;
267 	    u_int16_t hello_helloint;
268 	    u_int8_t hello_options;
269 	    u_int8_t hello_priority;
270 	    u_int32_t hello_deadint;
271 	    struct in_addr hello_dr;
272 	    struct in_addr hello_bdr;
273 	    struct in_addr hello_neighbor[1]; /* may repeat	*/
274 	} un_hello;
275 
276 	/* Database Description packet */
277 	struct {
278 	    u_int8_t db_zero[2];
279 	    u_int8_t db_options;
280 	    u_int8_t db_flags;
281 	    u_int32_t db_seq;
282 	    struct lsa_hdr db_lshdr[1]; /* may repeat	*/
283 	} un_db;
284 
285 	/* Link State Request */
286 	struct lsr {
287 	    u_int8_t ls_type[4];
288             union {
289                 struct in_addr ls_stateid;
290                 struct { /* opaque LSAs change the LSA-ID field */
291                     u_int8_t opaque_type;
292                     u_int8_t opaque_id[3];
293                 } opaque_field;
294             } un_ls_stateid;
295 	    struct in_addr ls_router;
296 	} un_lsr[1];		/* may repeat	*/
297 
298 	/* Link State Update */
299 	struct {
300 	    u_int32_t lsu_count;
301 	    struct lsa lsu_lsa[1]; /* may repeat	*/
302 	} un_lsu;
303 
304 	/* Link State Acknowledgement */
305 	struct {
306 	    struct lsa_hdr lsa_lshdr[1]; /* may repeat	*/
307 	} un_lsa ;
308     } ospf_un ;
309 };
310 
311 #define	ospf_hello	ospf_un.un_hello
312 #define	ospf_db		ospf_un.un_db
313 #define	ospf_lsr	ospf_un.un_lsr
314 #define	ospf_lsu	ospf_un.un_lsu
315 #define	ospf_lsa	ospf_un.un_lsa
316 
317