• Home
  • History
  • Annotate
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 <sys/cdefs.h>
39  
40  #include <linux/icmp.h>
41  #include <netinet/ip.h>
42  
43  __BEGIN_DECLS
44  
45  /*
46   * Interface Control Message Protocol Definitions.
47   * Per RFC 792, September 1981.
48   * RFC 950, August 1985. (Address Mask Request / Reply)
49   * RFC 1256, September 1991. (Router Advertisement and Solicitation)
50   * RFC 1108, November 1991. (Param Problem, Missing Req. Option)
51   * RFC 1393, January 1993. (Traceroute)
52   * RFC 1475, June 1993. (Datagram Conversion Error)
53   * RFC 1812, June 1995. (adm prohib, host precedence, precedence cutoff)
54   * RFC 2002, October 1996. (Mobility changes to Router Advertisement)
55   */
56  
57  /*
58   * ICMP Router Advertisement data
59   */
60  struct icmp_ra_addr {
61  	uint32_t  ira_addr;
62  	uint32_t  ira_preference;
63  };
64  
65  /*
66   * Structure of an icmp header.
67   */
68  struct icmp {
69  	uint8_t  icmp_type;		/* type of message, see below */
70  	uint8_t  icmp_code;		/* type sub code */
71  	uint16_t icmp_cksum;		/* ones complement cksum of struct */
72  	union {
73  		uint8_t   ih_pptr;		/* ICMP_PARAMPROB */
74  		struct in_addr ih_gwaddr;	/* ICMP_REDIRECT */
75  		struct ih_idseq {
76  			  uint16_t  icd_id;
77  			  uint16_t  icd_seq;
78  		} ih_idseq;
79  		int32_t   ih_void;
80  
81  		/* ICMP_UNREACH_NEEDFRAG -- Path MTU Discovery (RFC1191) */
82  		struct ih_pmtu {
83  			  uint16_t  ipm_void;
84  			  uint16_t  ipm_nextmtu;
85  		} ih_pmtu;
86  
87  		struct ih_rtradv {
88  			uint8_t   irt_num_addrs;
89  			uint8_t   irt_wpa;
90  			uint16_t  irt_lifetime;
91  		} ih_rtradv;
92  	} icmp_hun;
93  #define	icmp_pptr	  icmp_hun.ih_pptr
94  #define	icmp_gwaddr	  icmp_hun.ih_gwaddr
95  #define	icmp_id		  icmp_hun.ih_idseq.icd_id
96  #define	icmp_seq	  icmp_hun.ih_idseq.icd_seq
97  #define	icmp_void	  icmp_hun.ih_void
98  #define	icmp_pmvoid	  icmp_hun.ih_pmtu.ipm_void
99  #define	icmp_nextmtu	  icmp_hun.ih_pmtu.ipm_nextmtu
100  #define	icmp_num_addrs	  icmp_hun.ih_rtradv.irt_num_addrs
101  #define	icmp_wpa	  icmp_hun.ih_rtradv.irt_wpa
102  #define	icmp_lifetime	  icmp_hun.ih_rtradv.irt_lifetime
103  	union {
104  		struct id_ts {
105  			  uint32_t  its_otime;
106  			  uint32_t  its_rtime;
107  			  uint32_t  its_ttime;
108  		} id_ts;
109  		struct id_ip  {
110  			  struct ip idi_ip;
111  			  /* options and then 64 bits of data */
112  		} id_ip;
113  		uint32_t  id_mask;
114  		int8_t	  id_data[1];
115  	} icmp_dun;
116  #define	icmp_otime	  icmp_dun.id_ts.its_otime
117  #define	icmp_rtime	  icmp_dun.id_ts.its_rtime
118  #define	icmp_ttime	  icmp_dun.id_ts.its_ttime
119  #define	icmp_ip		  icmp_dun.id_ip.idi_ip
120  #define	icmp_mask	  icmp_dun.id_mask
121  #define	icmp_data	  icmp_dun.id_data
122  };
123  
124  /*
125   * For IPv6 transition related ICMP errors.
126   */
127  #define	ICMP_V6ADVLENMIN	(8 + sizeof(struct ip) + 40)
128  #define	ICMP_V6ADVLEN(p)	(8 + ((p)->icmp_ip.ip_hl << 2) + 40)
129  
130  /*
131   * Lower bounds on packet lengths for various types.
132   * For the error advice packets must first insure that the
133   * packet is large enough to contain the returned ip header.
134   * Only then can we do the check to see if 64 bits of packet
135   * data have been returned, since we need to check the returned
136   * ip header length.
137   */
138  #define	ICMP_MINLEN	8				/* abs minimum */
139  #define	ICMP_TSLEN	(8 + 3 * sizeof (n_time))	/* timestamp */
140  #define	ICMP_MASKLEN	12				/* address mask */
141  #define	ICMP_ADVLENMIN	(8 + sizeof (struct ip) + 8)	/* min */
142  #define	ICMP_ADVLEN(p)	(8 + ((p)->icmp_ip.ip_hl << 2) + 8)
143  	/* N.B.: must separately check that ip_hl >= 5 */
144  
145  /*
146   * Definition of type and code field values.
147   *	http://www.iana.org/assignments/icmp-parameters
148   */
149  #define	ICMP_ECHOREPLY		0		/* echo reply */
150  #define	ICMP_UNREACH		3		/* dest unreachable, codes: */
151  #define	ICMP_UNREACH_NET		0	/* bad net */
152  #define	ICMP_UNREACH_HOST		1	/* bad host */
153  #define	ICMP_UNREACH_PROTOCOL		2	/* bad protocol */
154  #define	ICMP_UNREACH_PORT		3	/* bad port */
155  #define	ICMP_UNREACH_NEEDFRAG		4	/* IP_DF caused drop */
156  #define	ICMP_UNREACH_SRCFAIL		5	/* src route failed */
157  #define	ICMP_UNREACH_NET_UNKNOWN	6	/* unknown net */
158  #define	ICMP_UNREACH_HOST_UNKNOWN	7	/* unknown host */
159  #define	ICMP_UNREACH_ISOLATED		8	/* src host isolated */
160  #define	ICMP_UNREACH_NET_PROHIB		9	/* for crypto devs */
161  #define	ICMP_UNREACH_HOST_PROHIB	10	/* ditto */
162  #define	ICMP_UNREACH_TOSNET		11	/* bad tos for net */
163  #define	ICMP_UNREACH_TOSHOST		12	/* bad tos for host */
164  #define	ICMP_UNREACH_FILTER_PROHIB	13	/* prohibited access */
165  #define	ICMP_UNREACH_HOST_PRECEDENCE	14	/* precedence violat'n*/
166  #define	ICMP_UNREACH_PRECEDENCE_CUTOFF	15	/* precedence cutoff */
167  #define	ICMP_SOURCEQUENCH	4		/* packet lost, slow down */
168  #define	ICMP_REDIRECT		5		/* shorter route, codes: */
169  #define	ICMP_REDIRECT_NET	0		/* for network */
170  #define	ICMP_REDIRECT_HOST	1		/* for host */
171  #define	ICMP_REDIRECT_TOSNET	2		/* for tos and net */
172  #define	ICMP_REDIRECT_TOSHOST	3		/* for tos and host */
173  #define	ICMP_ALTHOSTADDR	6		/* alternate host address */
174  #define	ICMP_ECHO		8		/* echo service */
175  #define	ICMP_ROUTERADVERT	9		/* router advertisement */
176  #define	ICMP_ROUTERADVERT_NORMAL		0	/* normal advertisement */
177  #define	ICMP_ROUTERADVERT_NOROUTE_COMMON	16	/* selective routing */
178  #define	ICMP_ROUTERSOLICIT	10		/* router solicitation */
179  #define	ICMP_TIMXCEED		11		/* time exceeded, code: */
180  #define	ICMP_TIMXCEED_INTRANS	0		/* ttl==0 in transit */
181  #define	ICMP_TIMXCEED_REASS	1		/* ttl==0 in reass */
182  #define	ICMP_PARAMPROB		12		/* ip header bad */
183  #define	ICMP_PARAMPROB_ERRATPTR 0		/* req. opt. absent */
184  #define	ICMP_PARAMPROB_OPTABSENT 1		/* req. opt. absent */
185  #define	ICMP_PARAMPROB_LENGTH	2		/* bad length */
186  #define	ICMP_TSTAMP		13		/* timestamp request */
187  #define	ICMP_TSTAMPREPLY	14		/* timestamp reply */
188  #define	ICMP_IREQ		15		/* information request */
189  #define	ICMP_IREQREPLY		16		/* information reply */
190  #define	ICMP_MASKREQ		17		/* address mask request */
191  #define	ICMP_MASKREPLY		18		/* address mask reply */
192  #define	ICMP_TRACEROUTE		30		/* traceroute */
193  #define	ICMP_DATACONVERR	31		/* data conversion error */
194  #define	ICMP_MOBILE_REDIRECT	32		/* mobile host redirect */
195  #define	ICMP_IPV6_WHEREAREYOU	33		/* IPv6 where-are-you */
196  #define	ICMP_IPV6_IAMHERE	34		/* IPv6 i-am-here */
197  #define	ICMP_MOBILE_REGREQUEST	35		/* mobile registration req */
198  #define	ICMP_MOBILE_REGREPLY	36		/* mobile registration reply */
199  #define	ICMP_SKIP		39		/* SKIP */
200  #define	ICMP_PHOTURIS		40		/* Photuris */
201  #define	ICMP_PHOTURIS_UNKNOWN_INDEX	1	/* unknown sec index */
202  #define	ICMP_PHOTURIS_AUTH_FAILED	2	/* auth failed */
203  #define	ICMP_PHOTURIS_DECRYPT_FAILED	3	/* decrypt failed */
204  
205  #define	ICMP_MAXTYPE		40
206  
207  #define	ICMP_INFOTYPE(type) \
208  	((type) == ICMP_ECHOREPLY || (type) == ICMP_ECHO || \
209  	(type) == ICMP_ROUTERADVERT || (type) == ICMP_ROUTERSOLICIT || \
210  	(type) == ICMP_TSTAMP || (type) == ICMP_TSTAMPREPLY || \
211  	(type) == ICMP_IREQ || (type) == ICMP_IREQREPLY || \
212  	(type) == ICMP_MASKREQ || (type) == ICMP_MASKREPLY)
213  
214  __END_DECLS
215  
216  #endif /* _NETINET_IP_ICMP_H_ */
217