include/protocols/routed.h

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