ip_icmp.h revision 1.38 1 /* $NetBSD: ip_icmp.h,v 1.38 2018/01/23 07:15:04 maxv Exp $ */
2
3 /*
4 * Copyright (c) 1982, 1986, 1993
5 * The Regents of the University of California. All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 *
31 * @(#)ip_icmp.h 8.1 (Berkeley) 6/10/93
32 */
33
34 #ifndef _NETINET_IP_ICMP_H_
35 #define _NETINET_IP_ICMP_H_
36
37
38 /*
39 * Interface Control Message Protocol Definitions.
40 * Per RFC 792, September 1981.
41 */
42
43 /*
44 * Internal of an ICMP Router Advertisement
45 */
46 struct icmp_ra_addr {
47 u_int32_t ira_addr;
48 u_int32_t ira_preference;
49 } __packed;
50
51 /*
52 * Structure of an icmp header.
53 */
54 struct icmp {
55 u_int8_t icmp_type; /* type of message, see below */
56 u_int8_t icmp_code; /* type sub code */
57 u_int16_t icmp_cksum; /* ones complement cksum of struct */
58
59 union {
60 int32_t ih_void;
61
62 /* Extended Header (RFC4884) */
63 struct ih_exthdr {
64 u_int8_t iex_void1;
65 u_int8_t iex_length;
66 u_int16_t iex_void2;
67 } ih_exthdr __packed;
68
69 /* ICMP_PARAMPROB */
70 u_int8_t ih_pptr;
71
72 /* ICMP_REDIRECT */
73 struct in_addr ih_gwaddr;
74
75 /* ICMP_ECHO and friends */
76 struct ih_idseq {
77 n_short icd_id;
78 n_short icd_seq;
79 } ih_idseq __packed;
80
81 /* ICMP_UNREACH_NEEDFRAG (Path MTU Discovery, RFC1191) */
82 struct ih_pmtu {
83 n_short ipm_void;
84 n_short ipm_nextmtu;
85 } ih_pmtu __packed;
86
87 /* ICMP_ROUTERADVERT */
88 struct ih_rtradv {
89 u_int8_t irt_num_addrs;
90 u_int8_t irt_wpa;
91 u_int16_t irt_lifetime;
92 } ih_rtradv __packed;
93 } icmp_hun /* XXX __packed ??? */;
94
95 #define icmp_pptr icmp_hun.ih_pptr
96 #define icmp_gwaddr icmp_hun.ih_gwaddr
97 #define icmp_id icmp_hun.ih_idseq.icd_id
98 #define icmp_seq icmp_hun.ih_idseq.icd_seq
99 #define icmp_void icmp_hun.ih_void
100 #define icmp_pmvoid icmp_hun.ih_pmtu.ipm_void
101 #define icmp_nextmtu icmp_hun.ih_pmtu.ipm_nextmtu
102 #define icmp_num_addrs icmp_hun.ih_rtradv.irt_num_addrs
103 #define icmp_wpa icmp_hun.ih_rtradv.irt_wpa
104 #define icmp_lifetime icmp_hun.ih_rtradv.irt_lifetime
105
106 union {
107 /* ICMP_TSTAMP and friends */
108 struct id_ts {
109 n_time its_otime;
110 n_time its_rtime;
111 n_time its_ttime;
112 } id_ts __packed;
113
114 struct id_ip {
115 struct ip idi_ip;
116 /* options and then 64 bits of data */
117 } id_ip /* XXX: __packed ??? */;
118
119 /* ICMP_ROUTERADVERT */
120 struct icmp_ra_addr id_radv;
121
122 /* ICMP_MASKREQ and friends */
123 u_int32_t id_mask;
124
125 int8_t id_data[1];
126 } icmp_dun /* XXX __packed ??? */;
127
128 #define icmp_otime icmp_dun.id_ts.its_otime
129 #define icmp_rtime icmp_dun.id_ts.its_rtime
130 #define icmp_ttime icmp_dun.id_ts.its_ttime
131 #define icmp_ip icmp_dun.id_ip.idi_ip
132 #define icmp_radv icmp_dun.id_radv
133 #define icmp_mask icmp_dun.id_mask
134 #define icmp_data icmp_dun.id_data
135 };
136
137 #define ICMP_EXT_VERSION 2
138 #define ICMP_EXT_OFFSET 128
139
140 /*
141 * ICMP Extension Structure Header (RFC4884).
142 */
143 struct icmp_ext_hdr {
144 #if BYTE_ORDER == BIG_ENDIAN
145 u_int8_t version:4;
146 u_int8_t rsvd1:4;
147 #else
148 u_int8_t rsvd1:4;
149 u_int8_t version:4;
150 #endif
151 u_int8_t rsvd2;
152 u_int16_t checksum;
153 } __packed;
154
155 /*
156 * ICMP Extension Object Header (RFC4884).
157 */
158 struct icmp_ext_obj_hdr {
159 u_int16_t length;
160 u_int8_t class_num;
161 u_int8_t c_type;
162 } __packed;
163
164 /*
165 * Lower bounds on packet lengths for various types.
166 * For the error advice packets must first insure that the
167 * packet is large enought to contain the returned ip header.
168 * Only then can we do the check to see if 64 bits of packet
169 * data have been returned, since we need to check the returned
170 * ip header length.
171 */
172 #define ICMP_MINLEN 8 /* abs minimum */
173 #define ICMP_TSLEN (8 + 3 * sizeof (n_time)) /* timestamp */
174 #define ICMP_MASKLEN 12 /* address mask */
175 #define ICMP_ADVLENMIN (8 + sizeof (struct ip) + 8) /* min */
176 #define ICMP_ADVLEN(p) (8 + ((p)->icmp_ip.ip_hl << 2) + 8)
177 /* N.B.: must separately check that ip_hl >= 5 */
178
179 /*
180 * Definition of type and code field values.
181 */
182 #define ICMP_ECHOREPLY 0 /* echo reply */
183 #define ICMP_UNREACH 3 /* dest unreachable, codes: */
184 #define ICMP_UNREACH_NET 0 /* bad net */
185 #define ICMP_UNREACH_HOST 1 /* bad host */
186 #define ICMP_UNREACH_PROTOCOL 2 /* bad protocol */
187 #define ICMP_UNREACH_PORT 3 /* bad port */
188 #define ICMP_UNREACH_NEEDFRAG 4 /* IP_DF caused drop */
189 #define ICMP_UNREACH_SRCFAIL 5 /* src route failed */
190 #define ICMP_UNREACH_NET_UNKNOWN 6 /* unknown net */
191 #define ICMP_UNREACH_HOST_UNKNOWN 7 /* unknown host */
192 #define ICMP_UNREACH_ISOLATED 8 /* src host isolated */
193 #define ICMP_UNREACH_NET_PROHIB 9 /* prohibited access */
194 #define ICMP_UNREACH_HOST_PROHIB 10 /* ditto */
195 #define ICMP_UNREACH_TOSNET 11 /* bad tos for net */
196 #define ICMP_UNREACH_TOSHOST 12 /* bad tos for host */
197 #define ICMP_UNREACH_ADMIN_PROHIBIT 13 /* communication
198 administratively
199 prohibited */
200 #define ICMP_UNREACH_HOST_PREC 14 /* host precedence
201 violation */
202 #define ICMP_UNREACH_PREC_CUTOFF 15 /* precedence cutoff */
203 #define ICMP_SOURCEQUENCH 4 /* packet lost, slow down */
204 #define ICMP_REDIRECT 5 /* shorter route, codes: */
205 #define ICMP_REDIRECT_NET 0 /* for network */
206 #define ICMP_REDIRECT_HOST 1 /* for host */
207 #define ICMP_REDIRECT_TOSNET 2 /* for tos and net */
208 #define ICMP_REDIRECT_TOSHOST 3 /* for tos and host */
209 #define ICMP_ALTHOSTADDR 6 /* alternative host address */
210 #define ICMP_ECHO 8 /* echo service */
211 #define ICMP_ROUTERADVERT 9 /* router advertisement */
212 #define ICMP_ROUTERADVERT_NORMAL 0
213 #define ICMP_ROUTERADVERT_NOROUTE 16
214 #define ICMP_ROUTERSOLICIT 10 /* router solicitation */
215 #define ICMP_TIMXCEED 11 /* time exceeded, code: */
216 #define ICMP_TIMXCEED_INTRANS 0 /* ttl==0 in transit */
217 #define ICMP_TIMXCEED_REASS 1 /* ttl==0 in reass */
218 #define ICMP_PARAMPROB 12 /* ip header bad */
219 #define ICMP_PARAMPROB_ERRATPTR 0
220 #define ICMP_PARAMPROB_OPTABSENT 1
221 #define ICMP_PARAMPROB_LENGTH 2
222 #define ICMP_TSTAMP 13 /* timestamp request */
223 #define ICMP_TSTAMPREPLY 14 /* timestamp reply */
224 #define ICMP_IREQ 15 /* information request */
225 #define ICMP_IREQREPLY 16 /* information reply */
226 #define ICMP_MASKREQ 17 /* address mask request */
227 #define ICMP_MASKREPLY 18 /* address mask reply */
228 #define ICMP_TRACEROUTE 30 /* traceroute */
229 #define ICMP_DATACONVERR 31 /* data conversion error */
230 #define ICMP_MOBILE_REDIRECT 32 /* mobile redirect */
231 #define ICMP_IPV6_WHEREAREYOU 33 /* ipv6 where are you */
232 #define ICMP_IPV6_IAMHERE 34 /* ipv6 i am here */
233 #define ICMP_MOBILE_REGREQUEST 35 /* mobile registration req */
234 #define ICMP_MOBILE_REGREPLY 36 /* mobile registration reply */
235 #define ICMP_SKIP 39 /* SKIP */
236 #define ICMP_PHOTURIS 40 /* security */
237 #define ICMP_PHOTURIS_UNKNOWN_INDEX 0 /* unknown sec index */
238 #define ICMP_PHOTURIS_AUTH_FAILED 1 /* auth failed */
239 #define ICMP_PHOTURIS_DECOMPRESS_FAILED 2 /* decompress failed */
240 #define ICMP_PHOTURIS_DECRYPT_FAILED 3 /* decrypt failed */
241 #define ICMP_PHOTURIS_NEED_AUTHN 4 /* no authentication */
242 #define ICMP_PHOTURIS_NEED_AUTHZ 5 /* no authorization */
243
244 #define ICMP_MAXTYPE 40
245 #define ICMP_NTYPES (ICMP_MAXTYPE + 1)
246
247 #ifdef ICMP_STRINGS
248 static const char *icmp_type[] = {
249 "echoreply", "unassigned_1", "unassigned_2", "unreach",
250 "sourcequench", "redirect", "althostaddr", "unassigned_7",
251 "echo", "routeradvert", "routersolicit", "timxceed",
252 "paramprob", "tstamp", "tstampreply", "ireq",
253 "ireqreply", "maskreq", "maskreply", "reserved_19",
254 "reserved_20", "reserved_21", "reserved_22", "reserved_23",
255 "reserved_24", "reserved_25", "reserved_26", "reserved_27",
256 "reserved_28", "reserved_29", "traceroute", "dataconverr",
257 "mobile_redirect", "ipv6_whereareyou", "ipv6_iamhere",
258 "mobile_regrequest", "mobile_regreply", "reserved_37",
259 "reserved_38", "skip", "photuris", NULL
260 };
261 static const char *icmp_code_none[] = { "none", NULL };
262 static const char *icmp_code_unreach[] = {
263 "net", "host", "oprt", "needfrag", "srcfail", "net_unknown",
264 "host_unknown", "isolated", "net_prohib", "host_prohib",
265 "tosnet", "toshost", "admin_prohibit", "host_prec", "prec_cutoff", NULL
266 };
267 static const char *icmp_code_redirect[] = {
268 "net", "host", "tosnet", "toshost", NULL
269 };
270 static const char *icmp_code_routeradvert[] = {
271 "normal", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "",
272 "noroute", NULL
273 };
274 static const char *icmp_code_timxceed[] = {
275 "intrans", "reass", NULL
276 };
277 static const char *icmp_code_paramprob[] = {
278 "erratptr", "optabsent", "length", NULL
279 };
280 static const char *icmp_code_photuris[] = {
281 "unknown_index", "auth_failed", "decompress_failed",
282 "decrypt_failed", "need_authn", "need_authz", NULL
283 };
284 #endif
285
286 #define ICMP_INFOTYPE(type) \
287 ((type) == ICMP_ECHOREPLY || (type) == ICMP_ECHO || \
288 (type) == ICMP_ROUTERADVERT || (type) == ICMP_ROUTERSOLICIT || \
289 (type) == ICMP_TSTAMP || (type) == ICMP_TSTAMPREPLY || \
290 (type) == ICMP_IREQ || (type) == ICMP_IREQREPLY || \
291 (type) == ICMP_MASKREQ || (type) == ICMP_MASKREPLY)
292
293 #ifdef _KERNEL
294 void icmp_error(struct mbuf *, int, int, n_long, int);
295 void icmp_mtudisc(struct icmp *, struct in_addr);
296 void icmp_input(struct mbuf *, ...);
297 void icmp_init(void);
298 void icmp_reflect(struct mbuf *);
299 int icmp_sysctl(int *, u_int, void *, size_t *, void *, size_t);
300
301 void icmp_mtudisc_callback_register(void (*)(struct in_addr));
302 int icmp_ratelimit(const struct in_addr *, const int, const int);
303 void icmp_mtudisc_lock(void);
304 void icmp_mtudisc_unlock(void);
305 #endif
306
307
308 #endif /* !_NETINET_IP_ICMP_H_ */
309