sys/netinet/ip_carp.h

   1 /*
   2  * Copyright (c) 2002 Michael Shalayeff. All rights reserved.
   3  * Copyright (c) 2003 Ryan McBride. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17  * IN NO EVENT SHALL THE AUTHOR OR HIS RELATIVES BE LIABLE FOR ANY DIRECT,
  18  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  20  * SERVICES; LOSS OF MIND, USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  22  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  23  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  24  * THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26 /*
  27  * $FreeBSD: src/sys/netinet/ip_carp.h,v 1.3 2006/12/01 18:37:41 imp Exp $
  28  * $OpenBSD: ip_carp.h,v 1.8 2004/07/29 22:12:15 mcbride Exp $
  29  * $DragonFly: src/sys/netinet/ip_carp.h,v 1.1 2007/08/16 20:03:57 dillon Exp $
  30  */
  31
  32
  33 #ifndef _IP_CARP_H
  34 #define _IP_CARP_H
  35
  36 /*
  37  * The CARP header layout is as follows:
  38  *
  39  *     0                   1                   2                   3
  40  *     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  41  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  42  *    |Version| Type  | VirtualHostID |    AdvSkew    |    Auth Len   |
  43  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  44  *    |   Reserved    |     AdvBase   |          Checksum             |
  45  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  46  *    |                         Counter (1)                           |
  47  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  48  *    |                         Counter (2)                           |
  49  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  50  *    |                        SHA-1 HMAC (1)                         |
  51  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  52  *    |                        SHA-1 HMAC (2)                         |
  53  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  54  *    |                        SHA-1 HMAC (3)                         |
  55  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  56  *    |                        SHA-1 HMAC (4)                         |
  57  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  58  *    |                        SHA-1 HMAC (5)                         |
  59  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  60  *
  61  */
  62
  63 struct carp_header {
  64 #if BYTE_ORDER == LITTLE_ENDIAN
  65         u_int8_t        carp_type:4,
  66                         carp_version:4;
  67 #endif
  68 #if BYTE_ORDER == BIG_ENDIAN
  69         u_int8_t        carp_version:4,
  70                         carp_type:4;
  71 #endif
  72         u_int8_t        carp_vhid;      /* virtual host id */
  73         u_int8_t        carp_advskew;   /* advertisement skew */
  74         u_int8_t        carp_authlen;   /* size of counter+md, 32bit chunks */
  75         u_int8_t        carp_pad1;      /* reserved */
  76         u_int8_t        carp_advbase;   /* advertisement interval */
  77         u_int16_t       carp_cksum;
  78         u_int32_t       carp_counter[2];
  79         unsigned char   carp_md[20];    /* SHA1 HMAC */
  80 } __packed;
  81
  82 #ifdef CTASSERT
  83 CTASSERT(sizeof(struct carp_header) == 36);
  84 #endif
  85
  86 #define CARP_DFLTTL             255
  87
  88 /* carp_version */
  89 #define CARP_VERSION            2
  90
  91 /* carp_type */
  92 #define CARP_ADVERTISEMENT      0x01
  93
  94 #define CARP_KEY_LEN            20      /* a sha1 hash of a passphrase */
  95
  96 /* carp_advbase */
  97 #define CARP_DFLTINTV           1
  98
  99 /*
 100  * Statistics.
 101  */
 102 struct carpstats {
 103         uint64_t        carps_ipackets;         /* total input packets, IPv4 */
 104         uint64_t        carps_ipackets6;        /* total input packets, IPv6 */
 105         uint64_t        carps_badif;            /* wrong interface */
 106         uint64_t        carps_badttl;           /* TTL is not CARP_DFLTTL */
 107         uint64_t        carps_hdrops;           /* packets shorter than hdr */
 108         uint64_t        carps_badsum;           /* bad checksum */
 109         uint64_t        carps_badver;           /* bad (incl unsupp) version */
 110         uint64_t        carps_badlen;           /* data length does not match */
 111         uint64_t        carps_badauth;          /* bad authentication */
 112         uint64_t        carps_badvhid;          /* bad VHID */
 113         uint64_t        carps_badaddrs;         /* bad address list */
 114
 115         uint64_t        carps_opackets;         /* total output packets, IPv4 */
 116         uint64_t        carps_opackets6;        /* total output packets, IPv6 */
 117         uint64_t        carps_onomem;           /* no memory for an mbuf */
 118         uint64_t        carps_ostates;          /* total state updates sent */
 119
 120         uint64_t        carps_preempt;          /* if enabled, preemptions */
 121 };
 122
 123 /*
 124  * Configuration structure for SIOCSVH SIOCGVH
 125  */
 126 struct carpreq {
 127         int             carpr_state;
 128 #define CARP_STATES     "INIT", "BACKUP", "MASTER"
 129 #define CARP_MAXSTATE   2
 130         int             carpr_vhid;
 131         int             carpr_advskew;
 132         int             carpr_advbase;
 133         unsigned char   carpr_key[CARP_KEY_LEN];
 134 };
 135 #define SIOCSVH _IOWR('i', 245, struct ifreq)
 136 #define SIOCGVH _IOWR('i', 246, struct ifreq)
 137
 138 /*
 139  * Names for CARP sysctl objects
 140  */
 141 #define CARPCTL_ALLOW           1       /* accept incoming CARP packets */
 142 #define CARPCTL_PREEMPT         2       /* high-pri backup preemption mode */
 143 #define CARPCTL_LOG             3       /* log bad packets */
 144 #define CARPCTL_STATS           4       /* statistics (read-only) */
 145 #define CARPCTL_ARPBALANCE      5       /* balance arp responses */
 146 #define CARPCTL_MAXID           6
 147
 148 #define CARPCTL_NAMES { \
 149         { 0, 0 }, \
 150         { "allow", CTLTYPE_INT }, \
 151         { "preempt", CTLTYPE_INT }, \
 152         { "log", CTLTYPE_INT }, \
 153         { "stats", CTLTYPE_STRUCT }, \
 154         { "arpbalance", CTLTYPE_INT }, \
 155 }
 156
 157 #ifdef _KERNEL
 158 void             carp_carpdev_state(void *);
 159 void             carp_input (struct mbuf *, int);
 160 int              carp6_input (struct mbuf **, int *, int);
 161 int              carp_output (struct ifnet *, struct mbuf *, struct sockaddr *,
 162                      struct rtentry *);
 163 int              carp_iamatch (void *, struct in_ifaddr *, struct in_addr *,
 164                      u_int8_t **);
 165 struct ifaddr   *carp_iamatch6(void *, struct in6_addr *);
 166 void            *carp_macmatch6(void *, struct mbuf *, const struct in6_addr *);
 167 struct  ifnet   *carp_forus (void *, void *);
 168 #endif
 169 #endif /* _IP_CARP_H */