Home | History | Annotate | Download | only in netinet
      1 /*	$OpenBSD: ip_icmp.h,v 1.21 2005/07/31 03:30:55 pascoe Exp $	*/
      2 /*	$NetBSD: ip_icmp.h,v 1.10 1996/02/13 23:42:28 christos Exp $	*/
      3 
      4 /*
      5  * Copyright (c) 1982, 1986, 1993
      6  *	The Regents of the University of California.  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  * 3. Neither the name of the University nor the names of its contributors
     17  *    may be used to endorse or promote products derived from this software
     18  *    without specific prior written permission.
     19  *
     20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     30  * SUCH DAMAGE.
     31  *
     32  *	@(#)ip_icmp.h	8.1 (Berkeley) 6/10/93
     33  */
     34 
     35 #ifndef _NETINET_IP_ICMP_H_
     36 #define _NETINET_IP_ICMP_H_
     37 
     38 #include <netinet/ip.h>
     39 #include <sys/cdefs.h>
     40 
     41 __BEGIN_DECLS
     42 
     43 /*
     44  * Interface Control Message Protocol Definitions.
     45  * Per RFC 792, September 1981.
     46  * RFC 950, August 1985. (Address Mask Request / Reply)
     47  * RFC 1256, September 1991. (Router Advertisement and Solicitation)
     48  * RFC 1108, November 1991. (Param Problem, Missing Req. Option)
     49  * RFC 1393, January 1993. (Traceroute)
     50  * RFC 1475, June 1993. (Datagram Conversion Error)
     51  * RFC 1812, June 1995. (adm prohib, host precedence, precedence cutoff)
     52  * RFC 2002, October 1996. (Mobility changes to Router Advertisement)
     53  */
     54 
     55 /*
     56  * ICMP Router Advertisement data
     57  */
     58 struct icmp_ra_addr {
     59 	uint32_t  ira_addr;
     60 	uint32_t  ira_preference;
     61 };
     62 
     63 /*
     64  * Structure of an icmp header.
     65  */
     66 struct icmp {
     67 	uint8_t  icmp_type;		/* type of message, see below */
     68 	uint8_t  icmp_code;		/* type sub code */
     69 	uint16_t icmp_cksum;		/* ones complement cksum of struct */
     70 	union {
     71 		uint8_t   ih_pptr;		/* ICMP_PARAMPROB */
     72 		struct in_addr ih_gwaddr;	/* ICMP_REDIRECT */
     73 		struct ih_idseq {
     74 			  uint16_t  icd_id;
     75 			  uint16_t  icd_seq;
     76 		} ih_idseq;
     77 		int32_t   ih_void;
     78 
     79 		/* ICMP_UNREACH_NEEDFRAG -- Path MTU Discovery (RFC1191) */
     80 		struct ih_pmtu {
     81 			  uint16_t  ipm_void;
     82 			  uint16_t  ipm_nextmtu;
     83 		} ih_pmtu;
     84 
     85 		struct ih_rtradv {
     86 			uint8_t   irt_num_addrs;
     87 			uint8_t   irt_wpa;
     88 			uint16_t  irt_lifetime;
     89 		} ih_rtradv;
     90 	} icmp_hun;
     91 #define	icmp_pptr	  icmp_hun.ih_pptr
     92 #define	icmp_gwaddr	  icmp_hun.ih_gwaddr
     93 #define	icmp_id		  icmp_hun.ih_idseq.icd_id
     94 #define	icmp_seq	  icmp_hun.ih_idseq.icd_seq
     95 #define	icmp_void	  icmp_hun.ih_void
     96 #define	icmp_pmvoid	  icmp_hun.ih_pmtu.ipm_void
     97 #define	icmp_nextmtu	  icmp_hun.ih_pmtu.ipm_nextmtu
     98 #define	icmp_num_addrs	  icmp_hun.ih_rtradv.irt_num_addrs
     99 #define	icmp_wpa	  icmp_hun.ih_rtradv.irt_wpa
    100 #define	icmp_lifetime	  icmp_hun.ih_rtradv.irt_lifetime
    101 	union {
    102 		struct id_ts {
    103 			  uint32_t  its_otime;
    104 			  uint32_t  its_rtime;
    105 			  uint32_t  its_ttime;
    106 		} id_ts;
    107 		struct id_ip  {
    108 			  struct ip idi_ip;
    109 			  /* options and then 64 bits of data */
    110 		} id_ip;
    111 		uint32_t  id_mask;
    112 		int8_t	  id_data[1];
    113 	} icmp_dun;
    114 #define	icmp_otime	  icmp_dun.id_ts.its_otime
    115 #define	icmp_rtime	  icmp_dun.id_ts.its_rtime
    116 #define	icmp_ttime	  icmp_dun.id_ts.its_ttime
    117 #define	icmp_ip		  icmp_dun.id_ip.idi_ip
    118 #define	icmp_mask	  icmp_dun.id_mask
    119 #define	icmp_data	  icmp_dun.id_data
    120 };
    121 
    122 /*
    123  * For IPv6 transition related ICMP errors.
    124  */
    125 #define	ICMP_V6ADVLENMIN	(8 + sizeof(struct ip) + 40)
    126 #define	ICMP_V6ADVLEN(p)	(8 + ((p)->icmp_ip.ip_hl << 2) + 40)
    127 
    128 /*
    129  * Lower bounds on packet lengths for various types.
    130  * For the error advice packets must first insure that the
    131  * packet is large enough to contain the returned ip header.
    132  * Only then can we do the check to see if 64 bits of packet
    133  * data have been returned, since we need to check the returned
    134  * ip header length.
    135  */
    136 #define	ICMP_MINLEN	8				/* abs minimum */
    137 #define	ICMP_TSLEN	(8 + 3 * sizeof (n_time))	/* timestamp */
    138 #define	ICMP_MASKLEN	12				/* address mask */
    139 #define	ICMP_ADVLENMIN	(8 + sizeof (struct ip) + 8)	/* min */
    140 #define	ICMP_ADVLEN(p)	(8 + ((p)->icmp_ip.ip_hl << 2) + 8)
    141 	/* N.B.: must separately check that ip_hl >= 5 */
    142 
    143 /*
    144  * Definition of type and code field values.
    145  *	http://www.iana.org/assignments/icmp-parameters
    146  */
    147 #define	ICMP_ECHOREPLY		0		/* echo reply */
    148 #define	ICMP_UNREACH		3		/* dest unreachable, codes: */
    149 #define	ICMP_UNREACH_NET		0	/* bad net */
    150 #define	ICMP_UNREACH_HOST		1	/* bad host */
    151 #define	ICMP_UNREACH_PROTOCOL		2	/* bad protocol */
    152 #define	ICMP_UNREACH_PORT		3	/* bad port */
    153 #define	ICMP_UNREACH_NEEDFRAG		4	/* IP_DF caused drop */
    154 #define	ICMP_UNREACH_SRCFAIL		5	/* src route failed */
    155 #define	ICMP_UNREACH_NET_UNKNOWN	6	/* unknown net */
    156 #define	ICMP_UNREACH_HOST_UNKNOWN	7	/* unknown host */
    157 #define	ICMP_UNREACH_ISOLATED		8	/* src host isolated */
    158 #define	ICMP_UNREACH_NET_PROHIB		9	/* for crypto devs */
    159 #define	ICMP_UNREACH_HOST_PROHIB	10	/* ditto */
    160 #define	ICMP_UNREACH_TOSNET		11	/* bad tos for net */
    161 #define	ICMP_UNREACH_TOSHOST		12	/* bad tos for host */
    162 #define	ICMP_UNREACH_FILTER_PROHIB	13	/* prohibited access */
    163 #define	ICMP_UNREACH_HOST_PRECEDENCE	14	/* precedence violat'n*/
    164 #define	ICMP_UNREACH_PRECEDENCE_CUTOFF	15	/* precedence cutoff */
    165 #define	ICMP_SOURCEQUENCH	4		/* packet lost, slow down */
    166 #define	ICMP_REDIRECT		5		/* shorter route, codes: */
    167 #define	ICMP_REDIRECT_NET	0		/* for network */
    168 #define	ICMP_REDIRECT_HOST	1		/* for host */
    169 #define	ICMP_REDIRECT_TOSNET	2		/* for tos and net */
    170 #define	ICMP_REDIRECT_TOSHOST	3		/* for tos and host */
    171 #define	ICMP_ALTHOSTADDR	6		/* alternate host address */
    172 #define	ICMP_ECHO		8		/* echo service */
    173 #define	ICMP_ROUTERADVERT	9		/* router advertisement */
    174 #define	ICMP_ROUTERADVERT_NORMAL		0	/* normal advertisement */
    175 #define	ICMP_ROUTERADVERT_NOROUTE_COMMON	16	/* selective routing */
    176 #define	ICMP_ROUTERSOLICIT	10		/* router solicitation */
    177 #define	ICMP_TIMXCEED		11		/* time exceeded, code: */
    178 #define	ICMP_TIMXCEED_INTRANS	0		/* ttl==0 in transit */
    179 #define	ICMP_TIMXCEED_REASS	1		/* ttl==0 in reass */
    180 #define	ICMP_PARAMPROB		12		/* ip header bad */
    181 #define	ICMP_PARAMPROB_ERRATPTR 0		/* req. opt. absent */
    182 #define	ICMP_PARAMPROB_OPTABSENT 1		/* req. opt. absent */
    183 #define	ICMP_PARAMPROB_LENGTH	2		/* bad length */
    184 #define	ICMP_TSTAMP		13		/* timestamp request */
    185 #define	ICMP_TSTAMPREPLY	14		/* timestamp reply */
    186 #define	ICMP_IREQ		15		/* information request */
    187 #define	ICMP_IREQREPLY		16		/* information reply */
    188 #define	ICMP_MASKREQ		17		/* address mask request */
    189 #define	ICMP_MASKREPLY		18		/* address mask reply */
    190 #define	ICMP_TRACEROUTE		30		/* traceroute */
    191 #define	ICMP_DATACONVERR	31		/* data conversion error */
    192 #define	ICMP_MOBILE_REDIRECT	32		/* mobile host redirect */
    193 #define	ICMP_IPV6_WHEREAREYOU	33		/* IPv6 where-are-you */
    194 #define	ICMP_IPV6_IAMHERE	34		/* IPv6 i-am-here */
    195 #define	ICMP_MOBILE_REGREQUEST	35		/* mobile registration req */
    196 #define	ICMP_MOBILE_REGREPLY	36		/* mobile registration reply */
    197 #define	ICMP_SKIP		39		/* SKIP */
    198 #define	ICMP_PHOTURIS		40		/* Photuris */
    199 #define	ICMP_PHOTURIS_UNKNOWN_INDEX	1	/* unknown sec index */
    200 #define	ICMP_PHOTURIS_AUTH_FAILED	2	/* auth failed */
    201 #define	ICMP_PHOTURIS_DECRYPT_FAILED	3	/* decrypt failed */
    202 
    203 #define	ICMP_MAXTYPE		40
    204 
    205 #define	ICMP_INFOTYPE(type) \
    206 	((type) == ICMP_ECHOREPLY || (type) == ICMP_ECHO || \
    207 	(type) == ICMP_ROUTERADVERT || (type) == ICMP_ROUTERSOLICIT || \
    208 	(type) == ICMP_TSTAMP || (type) == ICMP_TSTAMPREPLY || \
    209 	(type) == ICMP_IREQ || (type) == ICMP_IREQREPLY || \
    210 	(type) == ICMP_MASKREQ || (type) == ICMP_MASKREPLY)
    211 
    212 __END_DECLS
    213 
    214 #endif /* _NETINET_IP_ICMP_H_ */
    215