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