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