Home | History | Annotate | Line # | Download | only in netinet
ip_carp.h revision 1.3
      1 /*	$NetBSD: ip_carp.h,v 1.3 2007/02/17 22:34:11 dyoung Exp $	*/
      2 /*	$OpenBSD: ip_carp.h,v 1.18 2005/04/20 23:00:41 mpf Exp $	*/
      3 
      4 /*
      5  * Copyright (c) 2002 Michael Shalayeff. All rights reserved.
      6  * Copyright (c) 2003 Ryan McBride. All rights reserved.
      7  *
      8  * Redistribution and use in source and binary forms, with or without
      9  * modification, are permitted provided that the following conditions
     10  * are met:
     11  * 1. Redistributions of source code must retain the above copyright
     12  *    notice, this list of conditions and the following disclaimer.
     13  * 2. Redistributions in binary form must reproduce the above copyright
     14  *    notice, this list of conditions and the following disclaimer in the
     15  *    documentation and/or other materials provided with the distribution.
     16  *
     17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     20  * IN NO EVENT SHALL THE AUTHOR OR HIS RELATIVES BE LIABLE FOR ANY DIRECT,
     21  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
     23  * SERVICES; LOSS OF MIND, USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     25  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
     26  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
     27  * THE POSSIBILITY OF SUCH DAMAGE.
     28  */
     29 
     30 #ifndef _NETINET_IP_CARP_H_
     31 #define _NETINET_IP_CARP_H_
     32 
     33 /*
     34  * The CARP header layout is as follows:
     35  *
     36  *     0                   1                   2                   3
     37  *     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
     38  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     39  *    |Version| Type  | VirtualHostID |    AdvSkew    |    Auth Len   |
     40  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     41  *    |   Reserved    |     AdvBase   |          Checksum             |
     42  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     43  *    |                         Counter (1)                           |
     44  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     45  *    |                         Counter (2)                           |
     46  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     47  *    |                        SHA-1 HMAC (1)                         |
     48  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     49  *    |                        SHA-1 HMAC (2)                         |
     50  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     51  *    |                        SHA-1 HMAC (3)                         |
     52  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     53  *    |                        SHA-1 HMAC (4)                         |
     54  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     55  *    |                        SHA-1 HMAC (5)                         |
     56  *    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     57  *
     58  */
     59 
     60 struct carp_header {
     61 #if BYTE_ORDER == LITTLE_ENDIAN
     62 	u_int8_t	carp_type:4,
     63 			carp_version:4;
     64 #endif
     65 #if BYTE_ORDER == BIG_ENDIAN
     66 	u_int8_t	carp_version:4,
     67 			carp_type:4;
     68 #endif
     69 	u_int8_t	carp_vhid;	/* virtual host id */
     70 	u_int8_t	carp_advskew;	/* advertisement skew */
     71 	u_int8_t	carp_authlen;   /* size of counter+md, 32bit chunks */
     72 	u_int8_t	carp_pad1;	/* reserved */
     73 	u_int8_t	carp_advbase;	/* advertisement interval */
     74 	u_int16_t	carp_cksum;
     75 	u_int32_t	carp_counter[2];
     76 	unsigned char	carp_md[20];	/* SHA1 HMAC */
     77 } __packed;
     78 
     79 #define	CARP_DFLTTL		255
     80 
     81 /* carp_version */
     82 #define	CARP_VERSION		2
     83 
     84 /* carp_type */
     85 #define	CARP_ADVERTISEMENT	0x01
     86 
     87 #define	CARP_KEY_LEN		20	/* a sha1 hash of a passphrase */
     88 
     89 /* carp_advbase */
     90 #define	CARP_DFLTINTV		1
     91 
     92 /*
     93  * Statistics.
     94  */
     95 struct carpstats {
     96 	u_int64_t	carps_ipackets;		/* total input packets, IPv4 */
     97 	u_int64_t	carps_ipackets6;	/* total input packets, IPv6 */
     98 	u_int64_t	carps_badif;		/* wrong interface */
     99 	u_int64_t	carps_badttl;		/* TTL is not CARP_DFLTTL */
    100 	u_int64_t	carps_hdrops;		/* packets shorter than hdr */
    101 	u_int64_t	carps_badsum;		/* bad checksum */
    102 	u_int64_t	carps_badver;		/* bad (incl unsupp) version */
    103 	u_int64_t	carps_badlen;		/* data length does not match */
    104 	u_int64_t	carps_badauth;		/* bad authentication */
    105 	u_int64_t	carps_badvhid;		/* bad VHID */
    106 	u_int64_t	carps_badaddrs;		/* bad address list */
    107 
    108 	u_int64_t	carps_opackets;		/* total output packets, IPv4 */
    109 	u_int64_t	carps_opackets6;	/* total output packets, IPv6 */
    110 	u_int64_t	carps_onomem;		/* no memory for an mbuf */
    111 	u_int64_t	carps_ostates;		/* total state updates sent */
    112 
    113 	u_int64_t	carps_preempt;		/* if enabled, preemptions */
    114 };
    115 
    116 #define CARPDEVNAMSIZ	16
    117 #ifdef IFNAMSIZ
    118 #if CARPDEVNAMSIZ != IFNAMSIZ
    119 #error
    120 #endif
    121 #endif
    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 
    131 	char		carpr_carpdev[CARPDEVNAMSIZ];
    132 	int		carpr_vhid;
    133 	int		carpr_advskew;
    134 	int		carpr_advbase;
    135 	unsigned char	carpr_key[CARP_KEY_LEN];
    136 };
    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_ARPBALANCE	4	/* balance arp responses */
    145 #define CARPCTL_STATS		5	/* carp statistics */
    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 	{ "arpbalance", CTLTYPE_INT }, \
    154 }
    155 
    156 #ifdef _KERNEL
    157 void		 carp_ifdetach (struct ifnet *);
    158 void		 carp_proto_input (struct mbuf *, ...);
    159 void		 carp_carpdev_state(void *);
    160 int		 carp6_proto_input(struct mbuf **, int *, int);
    161 int		 carp_iamatch(struct in_ifaddr *, u_char *,
    162 		     u_int32_t *, u_int32_t);
    163 struct ifaddr	*carp_iamatch6(void *, struct in6_addr *);
    164 struct ifnet	*carp_ourether(void *, struct ether_header *, u_char, int);
    165 int		 carp_input(struct mbuf *, u_int8_t *, u_int8_t *, u_int16_t);
    166 int		 carp_output(struct ifnet *, struct mbuf *,
    167 		     const struct sockaddr *, struct rtentry *);
    168 #endif /* _KERNEL */
    169 #endif /* _NETINET_IP_CARP_H_ */
    170