ip_icmp.h revision 139823
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 *	@(#)ip_icmp.h	8.1 (Berkeley) 6/10/93
30 * $FreeBSD: head/sys/netinet/ip_icmp.h 139823 2005-01-07 01:45:51Z imp $
31 */
32
33#ifndef _NETINET_IP_ICMP_H_
34#define _NETINET_IP_ICMP_H_
35
36/*
37 * Interface Control Message Protocol Definitions.
38 * Per RFC 792, September 1981.
39 */
40
41/*
42 * Internal of an ICMP Router Advertisement
43 */
44struct icmp_ra_addr {
45	u_int32_t ira_addr;
46	u_int32_t ira_preference;
47};
48
49/*
50 * Structure of an icmp header.
51 */
52struct icmp {
53	u_char	icmp_type;		/* type of message, see below */
54	u_char	icmp_code;		/* type sub code */
55	u_short	icmp_cksum;		/* ones complement cksum of struct */
56	union {
57		u_char ih_pptr;			/* ICMP_PARAMPROB */
58		struct in_addr ih_gwaddr;	/* ICMP_REDIRECT */
59		struct ih_idseq {
60			n_short	icd_id;
61			n_short	icd_seq;
62		} ih_idseq;
63		int ih_void;
64
65		/* ICMP_UNREACH_NEEDFRAG -- Path MTU Discovery (RFC1191) */
66		struct ih_pmtu {
67			n_short ipm_void;
68			n_short ipm_nextmtu;
69		} ih_pmtu;
70
71		struct ih_rtradv {
72			u_char irt_num_addrs;
73			u_char irt_wpa;
74			u_int16_t irt_lifetime;
75		} ih_rtradv;
76	} icmp_hun;
77#define	icmp_pptr	icmp_hun.ih_pptr
78#define	icmp_gwaddr	icmp_hun.ih_gwaddr
79#define	icmp_id		icmp_hun.ih_idseq.icd_id
80#define	icmp_seq	icmp_hun.ih_idseq.icd_seq
81#define	icmp_void	icmp_hun.ih_void
82#define	icmp_pmvoid	icmp_hun.ih_pmtu.ipm_void
83#define	icmp_nextmtu	icmp_hun.ih_pmtu.ipm_nextmtu
84#define	icmp_num_addrs	icmp_hun.ih_rtradv.irt_num_addrs
85#define	icmp_wpa	icmp_hun.ih_rtradv.irt_wpa
86#define	icmp_lifetime	icmp_hun.ih_rtradv.irt_lifetime
87	union {
88		struct id_ts {			/* ICMP Timestamp */
89			n_time its_otime;	/* Originate */
90			n_time its_rtime;	/* Receive */
91			n_time its_ttime;	/* Transmit */
92		} id_ts;
93		struct id_ip  {
94			struct ip idi_ip;
95			/* options and then 64 bits of data */
96		} id_ip;
97		struct icmp_ra_addr id_radv;
98		u_int32_t id_mask;
99		char	id_data[1];
100	} icmp_dun;
101#define	icmp_otime	icmp_dun.id_ts.its_otime
102#define	icmp_rtime	icmp_dun.id_ts.its_rtime
103#define	icmp_ttime	icmp_dun.id_ts.its_ttime
104#define	icmp_ip		icmp_dun.id_ip.idi_ip
105#define	icmp_radv	icmp_dun.id_radv
106#define	icmp_mask	icmp_dun.id_mask
107#define	icmp_data	icmp_dun.id_data
108};
109
110/*
111 * Lower bounds on packet lengths for various types.
112 * For the error advice packets must first insure that the
113 * packet is large enough to contain the returned ip header.
114 * Only then can we do the check to see if 64 bits of packet
115 * data have been returned, since we need to check the returned
116 * ip header length.
117 */
118#define	ICMP_MINLEN	8				/* abs minimum */
119#define	ICMP_TSLEN	(8 + 3 * sizeof (n_time))	/* timestamp */
120#define	ICMP_MASKLEN	12				/* address mask */
121#define	ICMP_ADVLENMIN	(8 + sizeof (struct ip) + 8)	/* min */
122#define	ICMP_ADVLEN(p)	(8 + ((p)->icmp_ip.ip_hl << 2) + 8)
123	/* N.B.: must separately check that ip_hl >= 5 */
124
125/*
126 * Definition of type and code field values.
127 */
128#define	ICMP_ECHOREPLY		0		/* echo reply */
129#define	ICMP_UNREACH		3		/* dest unreachable, codes: */
130#define		ICMP_UNREACH_NET	0		/* bad net */
131#define		ICMP_UNREACH_HOST	1		/* bad host */
132#define		ICMP_UNREACH_PROTOCOL	2		/* bad protocol */
133#define		ICMP_UNREACH_PORT	3		/* bad port */
134#define		ICMP_UNREACH_NEEDFRAG	4		/* IP_DF caused drop */
135#define		ICMP_UNREACH_SRCFAIL	5		/* src route failed */
136#define		ICMP_UNREACH_NET_UNKNOWN 6		/* unknown net */
137#define		ICMP_UNREACH_HOST_UNKNOWN 7		/* unknown host */
138#define		ICMP_UNREACH_ISOLATED	8		/* src host isolated */
139#define		ICMP_UNREACH_NET_PROHIB	9		/* prohibited access */
140#define		ICMP_UNREACH_HOST_PROHIB 10		/* ditto */
141#define		ICMP_UNREACH_TOSNET	11		/* bad tos for net */
142#define		ICMP_UNREACH_TOSHOST	12		/* bad tos for host */
143#define		ICMP_UNREACH_FILTER_PROHIB 13		/* admin prohib */
144#define		ICMP_UNREACH_HOST_PRECEDENCE 14		/* host prec vio. */
145#define		ICMP_UNREACH_PRECEDENCE_CUTOFF 15	/* prec cutoff */
146#define	ICMP_SOURCEQUENCH	4		/* packet lost, slow down */
147#define	ICMP_REDIRECT		5		/* shorter route, codes: */
148#define		ICMP_REDIRECT_NET	0		/* for network */
149#define		ICMP_REDIRECT_HOST	1		/* for host */
150#define		ICMP_REDIRECT_TOSNET	2		/* for tos and net */
151#define		ICMP_REDIRECT_TOSHOST	3		/* for tos and host */
152#define	ICMP_ALTHOSTADDR	6		/* alternate host address */
153#define	ICMP_ECHO		8		/* echo service */
154#define	ICMP_ROUTERADVERT	9		/* router advertisement */
155#define		ICMP_ROUTERADVERT_NORMAL		0	/* normal advertisement */
156#define		ICMP_ROUTERADVERT_NOROUTE_COMMON	16	/* selective routing */
157#define	ICMP_ROUTERSOLICIT	10		/* router solicitation */
158#define	ICMP_TIMXCEED		11		/* time exceeded, code: */
159#define		ICMP_TIMXCEED_INTRANS	0		/* ttl==0 in transit */
160#define		ICMP_TIMXCEED_REASS	1		/* ttl==0 in reass */
161#define	ICMP_PARAMPROB		12		/* ip header bad */
162#define		ICMP_PARAMPROB_ERRATPTR 0		/* error at param ptr */
163#define		ICMP_PARAMPROB_OPTABSENT 1		/* req. opt. absent */
164#define		ICMP_PARAMPROB_LENGTH 2			/* bad length */
165#define	ICMP_TSTAMP		13		/* timestamp request */
166#define	ICMP_TSTAMPREPLY	14		/* timestamp reply */
167#define	ICMP_IREQ		15		/* information request */
168#define	ICMP_IREQREPLY		16		/* information reply */
169#define	ICMP_MASKREQ		17		/* address mask request */
170#define	ICMP_MASKREPLY		18		/* address mask reply */
171#define	ICMP_TRACEROUTE		30		/* traceroute */
172#define	ICMP_DATACONVERR	31		/* data conversion error */
173#define	ICMP_MOBILE_REDIRECT	32		/* mobile host redirect */
174#define	ICMP_IPV6_WHEREAREYOU	33		/* IPv6 where-are-you */
175#define	ICMP_IPV6_IAMHERE	34		/* IPv6 i-am-here */
176#define	ICMP_MOBILE_REGREQUEST	35		/* mobile registration req */
177#define	ICMP_MOBILE_REGREPLY	36		/* mobile registration reply */
178#define	ICMP_SKIP		39		/* SKIP */
179#define	ICMP_PHOTURIS		40		/* Photuris */
180#define		ICMP_PHOTURIS_UNKNOWN_INDEX	1	/* unknown sec index */
181#define		ICMP_PHOTURIS_AUTH_FAILED	2	/* auth failed */
182#define		ICMP_PHOTURIS_DECRYPT_FAILED	3	/* decrypt failed */
183
184#define	ICMP_MAXTYPE		40
185
186#define	ICMP_INFOTYPE(type) \
187	((type) == ICMP_ECHOREPLY || (type) == ICMP_ECHO || \
188	(type) == ICMP_ROUTERADVERT || (type) == ICMP_ROUTERSOLICIT || \
189	(type) == ICMP_TSTAMP || (type) == ICMP_TSTAMPREPLY || \
190	(type) == ICMP_IREQ || (type) == ICMP_IREQREPLY || \
191	(type) == ICMP_MASKREQ || (type) == ICMP_MASKREPLY)
192
193#ifdef _KERNEL
194void	icmp_error(struct mbuf *, int, int, n_long, struct ifnet *);
195void	icmp_input(struct mbuf *, int);
196#endif
197
198#endif
199