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