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