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