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