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