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