xref: /freebsd/contrib/tcpdump/ospf.h (revision 6b3455a7665208c366849f0b2b3bc916fb97516e)
1 /* @(#) $Header: /tcpdump/master/tcpdump/ospf.h,v 1.11 2003/10/22 17:08:46 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 
47 /* ospf_authtype	*/
48 #define	OSPF_AUTH_NONE		0	/* No auth-data */
49 #define	OSPF_AUTH_SIMPLE	1	/* Simple password */
50 #define OSPF_AUTH_MD5		2	/* MD5 authentication */
51 #define OSPF_AUTH_MD5_LEN	16	/* length of MD5 authentication */
52 
53 /* db_flags	*/
54 #define	OSPF_DB_INIT		0x04	    /*	*/
55 #define	OSPF_DB_MORE		0x02
56 #define	OSPF_DB_MASTER		0x01
57 
58 /* ls_type	*/
59 #define	LS_TYPE_ROUTER		1   /* router link */
60 #define	LS_TYPE_NETWORK		2   /* network link */
61 #define	LS_TYPE_SUM_IP		3   /* summary link */
62 #define	LS_TYPE_SUM_ABR		4   /* summary area link */
63 #define	LS_TYPE_ASE		5   /* ASE  */
64 #define	LS_TYPE_GROUP		6   /* Group membership (multicast */
65 				    /* extensions 23 July 1991) */
66 #define	LS_TYPE_NSSA            7   /* rfc1587 - Not so Stubby Areas */
67 #define	LS_TYPE_OPAQUE_LL       9   /* rfc2370 - Opaque Link Local */
68 #define	LS_TYPE_OPAQUE_AL      10   /* rfc2370 - Opaque Link Local */
69 #define	LS_TYPE_OPAQUE_DW      11   /* rfc2370 - Opaque Domain Wide */
70 
71 #define LS_OPAQUE_TYPE_TE       1   /* rfc3630 */
72 #define LS_OPAQUE_TYPE_GRACE    3   /* draft-ietf-ospf-hitless-restart */
73 
74 #define LS_OPAQUE_TE_TLV_ROUTER 1   /* rfc3630 */
75 #define LS_OPAQUE_TE_TLV_LINK   2   /* rfc3630 */
76 
77 #define LS_OPAQUE_TE_LINK_SUBTLV_LINK_TYPE             1 /* rfc3630 */
78 #define LS_OPAQUE_TE_LINK_SUBTLV_LINK_ID               2 /* rfc3630 */
79 #define LS_OPAQUE_TE_LINK_SUBTLV_LOCAL_IP              3 /* rfc3630 */
80 #define LS_OPAQUE_TE_LINK_SUBTLV_REMOTE_IP             4 /* rfc3630 */
81 #define LS_OPAQUE_TE_LINK_SUBTLV_TE_METRIC             5 /* rfc3630 */
82 #define LS_OPAQUE_TE_LINK_SUBTLV_MAX_BW                6 /* rfc3630 */
83 #define LS_OPAQUE_TE_LINK_SUBTLV_MAX_RES_BW            7 /* rfc3630 */
84 #define LS_OPAQUE_TE_LINK_SUBTLV_UNRES_BW              8 /* rfc3630 */
85 #define LS_OPAQUE_TE_LINK_SUBTLV_ADMIN_GROUP           9 /* rfc3630 */
86 #define LS_OPAQUE_TE_LINK_SUBTLV_LINK_LOCAL_REMOTE_ID 11 /* draft-ietf-ccamp-ospf-gmpls-extensions */
87 #define LS_OPAQUE_TE_LINK_SUBTLV_LINK_PROTECTION_TYPE 14 /* draft-ietf-ccamp-ospf-gmpls-extensions */
88 #define LS_OPAQUE_TE_LINK_SUBTLV_INTF_SW_CAP_DESCR    15 /* draft-ietf-ccamp-ospf-gmpls-extensions */
89 #define LS_OPAQUE_TE_LINK_SUBTLV_SHARED_RISK_GROUP    16 /* draft-ietf-ccamp-ospf-gmpls-extensions */
90 
91 #define LS_OPAQUE_TE_LINK_SUBTLV_LINK_TYPE_PTP        1  /* rfc3630 */
92 #define LS_OPAQUE_TE_LINK_SUBTLV_LINK_TYPE_MA         2  /* rfc3630 */
93 
94 /*************************************************
95  *
96  * is the above a bug in the documentation?
97  *
98  *************************************************/
99 
100 
101 /* rla_link.link_type	*/
102 #define	RLA_TYPE_ROUTER		1   /* point-to-point to another router	*/
103 #define	RLA_TYPE_TRANSIT	2   /* connection to transit network	*/
104 #define	RLA_TYPE_STUB		3   /* connection to stub network	*/
105 #define RLA_TYPE_VIRTUAL	4   /* virtual link			*/
106 
107 /* rla_flags	*/
108 #define	RLA_FLAG_B	0x01
109 #define	RLA_FLAG_E	0x02
110 #define	RLA_FLAG_W1	0x04
111 #define	RLA_FLAG_W2	0x08
112 
113 /* sla_tosmetric breakdown	*/
114 #define	SLA_MASK_TOS		0x7f000000
115 #define	SLA_MASK_METRIC		0x00ffffff
116 #define SLA_SHIFT_TOS		24
117 
118 /* asla_tosmetric breakdown	*/
119 #define	ASLA_FLAG_EXTERNAL	0x80000000
120 #define	ASLA_MASK_TOS		0x7f000000
121 #define	ASLA_SHIFT_TOS		24
122 #define	ASLA_MASK_METRIC	0x00ffffff
123 
124 /* multicast vertex type */
125 #define	MCLA_VERTEX_ROUTER	1
126 #define	MCLA_VERTEX_NETWORK	2
127 
128 /* link state advertisement header */
129 struct lsa_hdr {
130     u_int16_t ls_age;
131     u_int8_t ls_options;
132     u_int8_t ls_type;
133     union {
134         struct in_addr lsa_id;
135         struct { /* opaque LSAs change the LSA-ID field */
136             u_int8_t opaque_type;
137             u_int8_t opaque_id[3];
138 	} opaque_field;
139     } un_lsa_id;
140     struct in_addr ls_router;
141     u_int32_t ls_seq;
142     u_int16_t ls_chksum;
143     u_int16_t ls_length;
144 };
145 
146 /* link state advertisement */
147 struct lsa {
148     struct lsa_hdr ls_hdr;
149 
150     /* Link state types */
151     union {
152 	/* Router links advertisements */
153 	struct {
154 	    u_int8_t rla_flags;
155 	    u_int8_t rla_zero[1];
156 	    u_int16_t rla_count;
157 	    struct rlalink {
158 		struct in_addr link_id;
159 		struct in_addr link_data;
160 		u_int8_t link_type;
161 		u_int8_t link_toscount;
162 		u_int16_t link_tos0metric;
163 	    } rla_link[1];		/* may repeat	*/
164 	} un_rla;
165 
166 	/* Network links advertisements */
167 	struct {
168 	    struct in_addr nla_mask;
169 	    struct in_addr nla_router[1];	/* may repeat	*/
170 	} un_nla;
171 
172 	/* Summary links advertisements */
173 	struct {
174 	    struct in_addr sla_mask;
175 	    u_int32_t sla_tosmetric[1];	/* may repeat	*/
176 	} un_sla;
177 
178 	/* AS external links advertisements */
179 	struct {
180 	    struct in_addr asla_mask;
181 	    struct aslametric {
182 		u_int32_t asla_tosmetric;
183 		struct in_addr asla_forward;
184 		struct in_addr asla_tag;
185 	    } asla_metric[1];		/* may repeat	*/
186 	} un_asla;
187 
188 	/* Multicast group membership */
189 	struct mcla {
190 	    u_int32_t mcla_vtype;
191 	    struct in_addr mcla_vid;
192 	} un_mcla[1];
193 
194         /* Opaque TE LSA */
195         struct {
196 	    u_int16_t type;
197 	    u_int16_t length;
198 	    u_int8_t data[1]; /* may repeat   */
199 	} un_te_lsa_tlv;
200 
201         /* Unknown LSA */
202         struct unknown {
203 	    u_int8_t data[1]; /* may repeat   */
204 	} un_unknown[1];
205 
206     } lsa_un;
207 };
208 
209 
210 /*
211  * TOS metric struct (will be 0 or more in router links update)
212  */
213 struct tos_metric {
214     u_int8_t tos_type;
215     u_int8_t tos_zero;
216     u_int16_t tos_metric;
217 };
218 
219 #define	OSPF_AUTH_SIZE	8
220 
221 /*
222  * the main header
223  */
224 struct ospfhdr {
225     u_int8_t ospf_version;
226     u_int8_t ospf_type;
227     u_int16_t ospf_len;
228     struct in_addr ospf_routerid;
229     struct in_addr ospf_areaid;
230     u_int16_t ospf_chksum;
231     u_int16_t ospf_authtype;
232     u_int8_t ospf_authdata[OSPF_AUTH_SIZE];
233     union {
234 
235 	/* Hello packet */
236 	struct {
237 	    struct in_addr hello_mask;
238 	    u_int16_t hello_helloint;
239 	    u_int8_t hello_options;
240 	    u_int8_t hello_priority;
241 	    u_int32_t hello_deadint;
242 	    struct in_addr hello_dr;
243 	    struct in_addr hello_bdr;
244 	    struct in_addr hello_neighbor[1]; /* may repeat	*/
245 	} un_hello;
246 
247 	/* Database Description packet */
248 	struct {
249 	    u_int8_t db_zero[2];
250 	    u_int8_t db_options;
251 	    u_int8_t db_flags;
252 	    u_int32_t db_seq;
253 	    struct lsa_hdr db_lshdr[1]; /* may repeat	*/
254 	} un_db;
255 
256 	/* Link State Request */
257 	struct lsr {
258 	    u_int8_t ls_type[4];
259             union {
260                 struct in_addr ls_stateid;
261                 struct { /* opaque LSAs change the LSA-ID field */
262                     u_int8_t opaque_type;
263                     u_int8_t opaque_id[3];
264                 } opaque_field;
265             } un_ls_stateid;
266 	    struct in_addr ls_router;
267 	} un_lsr[1];		/* may repeat	*/
268 
269 	/* Link State Update */
270 	struct {
271 	    u_int32_t lsu_count;
272 	    struct lsa lsu_lsa[1]; /* may repeat	*/
273 	} un_lsu;
274 
275 	/* Link State Acknowledgement */
276 	struct {
277 	    struct lsa_hdr lsa_lshdr[1]; /* may repeat	*/
278 	} un_lsa ;
279     } ospf_un ;
280 };
281 
282 #define	ospf_hello	ospf_un.un_hello
283 #define	ospf_db		ospf_un.un_db
284 #define	ospf_lsr	ospf_un.un_lsr
285 #define	ospf_lsu	ospf_un.un_lsu
286 #define	ospf_lsa	ospf_un.un_lsa
287 
288