xref: /freebsd/include/protocols/routed.h (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
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  *	$Revision: 2.26 $
33  */
34 
35 #ifndef _ROUTED_H_
36 #define	_ROUTED_H_
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40 
41 /*
42  * Routing Information Protocol
43  *
44  * Derived from Xerox NS Routing Information Protocol
45  * by changing 32-bit net numbers to sockaddr's and
46  * padding stuff to 32-bit boundaries.
47  */
48 
49 #define	RIPv1		1
50 #define	RIPv2		2
51 #ifndef RIPVERSION
52 #define	RIPVERSION	RIPv1
53 #endif
54 
55 #define RIP_PORT	520
56 
57 #if RIPVERSION == 1
58 /* Note that this so called sockaddr has a 2-byte sa_family and no sa_len.
59  * It is not a UNIX sockaddr, but the shape of an address as defined
60  * in RIPv1.  It is still defined to allow old versions of programs
61  * such as `gated` to use this file to define RIPv1.
62  */
63 struct netinfo {
64 	struct	sockaddr rip_dst;	/* destination net/host */
65 	u_int32_t   rip_metric;		/* cost of route */
66 };
67 #else
68 struct netinfo {
69 	u_int16_t   n_family;
70 #define	    RIP_AF_INET	    htons(AF_INET)
71 #define	    RIP_AF_UNSPEC   0
72 #define	    RIP_AF_AUTH	    0xffff
73 	u_int16_t   n_tag;		/* optional in RIPv2 */
74 	u_int32_t   n_dst;		/* destination net or host */
75 #define	    RIP_DEFAULT	    0
76 	u_int32_t   n_mask;		/* netmask in RIPv2 */
77 	u_int32_t   n_nhop;		/* optional next hop in RIPv2 */
78 	u_int32_t   n_metric;		/* cost of route */
79 };
80 #endif
81 
82 /* RIPv2 authentication */
83 struct netauth {
84 	u_int16_t   a_family;		/* always RIP_AF_AUTH */
85 	u_int16_t   a_type;
86 #define	    RIP_AUTH_NONE   0
87 #define	    RIP_AUTH_PW	    htons(2)	/* password type */
88 #define	    RIP_AUTH_MD5    htons(3)	/* Keyed MD5 */
89 	union {
90 #define	    RIP_AUTH_PW_LEN 16
91 	    u_int8_t    au_pw[RIP_AUTH_PW_LEN];
92 	    struct a_md5 {
93 		int16_t	md5_pkt_len;	/* RIP-II packet length */
94 		int8_t	md5_keyid;	/* key ID and auth data len */
95 		int8_t	md5_auth_len;	/* 16 */
96 		u_int32_t md5_seqno;	/* sequence number */
97 		u_int32_t rsvd[2];	/* must be 0 */
98 #define	    RIP_AUTH_MD5_KEY_LEN   RIP_AUTH_PW_LEN
99 #define	    RIP_AUTH_MD5_HASH_XTRA (sizeof(struct netauth)-sizeof(struct a_md5))
100 #define	    RIP_AUTH_MD5_HASH_LEN  (RIP_AUTH_MD5_KEY_LEN+RIP_AUTH_MD5_HASH_XTRA)
101 	    } a_md5;
102 	} au;
103 };
104 
105 struct rip {
106 	u_int8_t    rip_cmd;		/* request/response */
107 	u_int8_t    rip_vers;		/* protocol version # */
108 	u_int16_t   rip_res1;		/* pad to 32-bit boundary */
109 	union {				/* variable length... */
110 	    struct netinfo ru_nets[1];
111 	    int8_t    ru_tracefile[1];
112 	    struct netauth ru_auth[1];
113 	} ripun;
114 #define	rip_nets	ripun.ru_nets
115 #define rip_auths	ripun.ru_auth
116 #define	rip_tracefile	ripun.ru_tracefile
117 };
118 
119 /* Packet types.
120  */
121 #define	RIPCMD_REQUEST		1	/* want info */
122 #define	RIPCMD_RESPONSE		2	/* responding to request */
123 #define	RIPCMD_TRACEON		3	/* turn tracing on */
124 #define	RIPCMD_TRACEOFF		4	/* turn it off */
125 
126 /* Gated extended RIP to include a "poll" command instead of using
127  * RIPCMD_REQUEST with (RIP_AF_UNSPEC, RIP_DEFAULT).  RFC 1058 says
128  * command 5 is used by Sun Microsystems for its own purposes.
129  */
130 #define RIPCMD_POLL		5
131 
132 #define	RIPCMD_MAX		6
133 
134 #ifdef RIPCMDS
135 const char *ripcmds[RIPCMD_MAX] = {
136 	"#0", "REQUEST", "RESPONSE", "TRACEON", "TRACEOFF"
137 };
138 #endif
139 
140 #define	HOPCNT_INFINITY		16
141 #define	MAXPACKETSIZE		512	/* max broadcast size */
142 #define NETS_LEN ((MAXPACKETSIZE-sizeof(struct rip))	\
143 		      / sizeof(struct netinfo) +1)
144 
145 #define INADDR_RIP_GROUP (u_int32_t)0xe0000009	/* 224.0.0.9 */
146 
147 
148 /* Timer values used in managing the routing table.
149  *
150  * Complete tables are broadcast every SUPPLY_INTERVAL seconds.
151  * If changes occur between updates, dynamic updates containing only changes
152  * may be sent.  When these are sent, a timer is set for a random value
153  * between MIN_WAITTIME and MAX_WAITTIME, and no additional dynamic updates
154  * are sent until the timer expires.
155  *
156  * Every update of a routing entry forces an entry's timer to be reset.
157  * After EXPIRE_TIME without updates, the entry is marked invalid,
158  * but held onto until GARBAGE_TIME so that others may see it, to
159  * "poison" the bad route.
160  */
161 #define	SUPPLY_INTERVAL		30	/* time to supply tables */
162 #define	MIN_WAITTIME		2	/* min sec until next flash updates */
163 #define	MAX_WAITTIME		5	/* max sec until flash update */
164 
165 #define STALE_TIME		90	/* switch to a new gateway */
166 #define	EXPIRE_TIME		180	/* time to mark entry invalid */
167 #define	GARBAGE_TIME		240	/* time to garbage collect */
168 
169 #ifdef __cplusplus
170 }
171 #endif
172 #endif /* !_ROUTED_H_ */
173