xref: /freebsd/include/protocols/routed.h (revision ebbd4fa8c8427d3dd847ba33c45c996e0500e6ff)
1 /*-
2  * Copyright (c) 1983, 1989, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgment:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	@(#)routed.h	8.1 (Berkeley) 6/2/93
34  *
35  * $FreeBSD$
36  */
37 
38 #ifndef _ROUTED_H_
39 #define	_ROUTED_H_
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 /*
45  * Routing Information Protocol
46  *
47  * Derived from Xerox NS Routing Information Protocol
48  * by changing 32-bit net numbers to sockaddr's and
49  * padding stuff to 32-bit boundaries.
50  */
51 
52 #define	RIPv1		1
53 #define	RIPv2		2
54 #ifndef RIPVERSION
55 #define	RIPVERSION	RIPv1
56 #endif
57 
58 #define RIP_PORT	520
59 
60 #if RIPVERSION == 1
61 /* Note that this so called sockaddr has a 2-byte sa_family and no sa_len.
62  * It is not a UNIX sockaddr, but the shape of an address as defined
63  * in RIPv1.  It is still defined to allow old versions of programs
64  * such as `gated` to use this file to define RIPv1.
65  */
66 struct netinfo {
67 	struct	sockaddr rip_dst;	/* destination net/host */
68 	u_int32_t   rip_metric;		/* cost of route */
69 };
70 #else
71 struct netinfo {
72 	u_int16_t   n_family;
73 #define	    RIP_AF_INET	    htons(AF_INET)
74 #define	    RIP_AF_UNSPEC   0
75 #define	    RIP_AF_AUTH	    0xffff
76 	u_int16_t   n_tag;		/* optional in RIPv2 */
77 	u_int32_t   n_dst;		/* destination net or host */
78 #define	    RIP_DEFAULT	    0
79 	u_int32_t   n_mask;		/* netmask in RIPv2 */
80 	u_int32_t   n_nhop;		/* optional next hop in RIPv2 */
81 	u_int32_t   n_metric;		/* cost of route */
82 };
83 #endif
84 
85 /* RIPv2 authentication */
86 struct netauth {
87 	u_int16_t   a_family;		/* always RIP_AF_AUTH */
88 	u_int16_t   a_type;
89 #define	    RIP_AUTH_NONE   0
90 #define	    RIP_AUTH_PW	    htons(2)	/* password type */
91 #define	    RIP_AUTH_MD5    htons(3)	/* Keyed MD5 */
92 	union {
93 #define	    RIP_AUTH_PW_LEN 16
94 	    u_int8_t    au_pw[RIP_AUTH_PW_LEN];
95 	    struct a_md5 {
96 		int16_t	md5_pkt_len;	/* RIP-II packet length */
97 		int8_t	md5_keyid;	/* key ID and auth data len */
98 		int8_t	md5_auth_len;	/* 16 */
99 		u_int32_t md5_seqno;	/* sequence number */
100 		u_int32_t rsvd[2];	/* must be 0 */
101 #define	    RIP_AUTH_MD5_LEN RIP_AUTH_PW_LEN
102 	    } a_md5;
103 	} au;
104 };
105 
106 struct rip {
107 	u_int8_t    rip_cmd;		/* request/response */
108 	u_int8_t    rip_vers;		/* protocol version # */
109 	u_int16_t   rip_res1;		/* pad to 32-bit boundary */
110 	union {				/* variable length... */
111 	    struct netinfo ru_nets[1];
112 	    int8_t    ru_tracefile[1];
113 	    struct netauth ru_auth[1];
114 	} ripun;
115 #define	rip_nets	ripun.ru_nets
116 #define rip_auths	ripun.ru_auth
117 #define	rip_tracefile	ripun.ru_tracefile
118 };
119 
120 /* Packet types.
121  */
122 #define	RIPCMD_REQUEST		1	/* want info */
123 #define	RIPCMD_RESPONSE		2	/* responding to request */
124 #define	RIPCMD_TRACEON		3	/* turn tracing on */
125 #define	RIPCMD_TRACEOFF		4	/* turn it off */
126 
127 /* Gated extended RIP to include a "poll" command instead of using
128  * RIPCMD_REQUEST with (RIP_AF_UNSPEC, RIP_DEFAULT).  RFC 1058 says
129  * command 5 is used by Sun Microsystems for its own purposes.
130  */
131 #define RIPCMD_POLL		5
132 
133 #define	RIPCMD_MAX		6
134 
135 #ifdef RIPCMDS
136 const char *ripcmds[RIPCMD_MAX] = {
137 	"#0", "REQUEST", "RESPONSE", "TRACEON", "TRACEOFF"
138 };
139 #endif
140 
141 #define	HOPCNT_INFINITY		16
142 #define	MAXPACKETSIZE		512	/* max broadcast size */
143 #define NETS_LEN ((MAXPACKETSIZE-sizeof(struct rip))	\
144 		      / sizeof(struct netinfo) +1)
145 
146 #define INADDR_RIP_GROUP (u_int32_t)0xe0000009	/* 224.0.0.9 */
147 
148 
149 /* Timer values used in managing the routing table.
150  *
151  * Complete tables are broadcast every SUPPLY_INTERVAL seconds.
152  * If changes occur between updates, dynamic updates containing only changes
153  * may be sent.  When these are sent, a timer is set for a random value
154  * between MIN_WAITTIME and MAX_WAITTIME, and no additional dynamic updates
155  * are sent until the timer expires.
156  *
157  * Every update of a routing entry forces an entry's timer to be reset.
158  * After EXPIRE_TIME without updates, the entry is marked invalid,
159  * but held onto until GARBAGE_TIME so that others may see it, to
160  * "poison" the bad route.
161  */
162 #define	SUPPLY_INTERVAL		30	/* time to supply tables */
163 #define	MIN_WAITTIME		2	/* min sec until next flash updates */
164 #define	MAX_WAITTIME		5	/* max sec until flash update */
165 
166 #define STALE_TIME		90	/* switch to a new gateway */
167 #define	EXPIRE_TIME		180	/* time to mark entry invalid */
168 #define	GARBAGE_TIME		240	/* time to garbage collect */
169 
170 #ifdef __cplusplus
171 }
172 #endif
173 #endif /* !_ROUTED_H_ */
174