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