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