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. 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
30#ifndef NETINET_IP_ICMP_H
31#define NETINET_IP_ICMP_H
32
33#include <endian.h>
34#include <netinet/in.h>
35#include <netinet/ip.h>
36#include <stdint.h>
37
38struct icmp {
39	uint8_t icmp_type;
40	uint8_t icmp_code;
41	uint16_t icmp_cksum;
42	union {
43		uint8_t ih_pptr;
44		struct in_addr ih_gwaddr;
45		struct ih_idseq {
46			uint16_t icd_id;
47			uint16_t icd_seq;
48		} ih_idseq;
49		int32_t ih_void;
50
51		/* ICMP_UNREACH_NEEDFRAG (RFC 1191) */
52		struct ih_pmtu {
53			uint16_t ipm_void;
54			uint16_t ipm_nextmtu;
55		} ih_pmtu;
56	} icmp_hun;
57	union {
58		struct id_ts {
59			uint32_t its_otime;
60			uint32_t its_rtime;
61			uint32_t its_ttime;
62		} id_ts;
63		struct id_ip {
64			struct ip idi_ip;
65		} id_ip;
66		uint32_t id_mask;
67		char id_data[1];
68	} icmp_dun;
69};
70
71#define icmp_pptr      icmp_hun.ih_pptr
72#define icmp_gwaddr    icmp_hun.ih_gwaddr
73#define icmp_id        icmp_hun.ih_idseq.icd_id
74#define icmp_seq       icmp_hun.ih_idseq.icd_seq
75#define icmp_void      icmp_hun.ih_void
76#define icmp_pmvoid    icmp_hun.ih_pmtu.ipm_void
77#define icmp_nextmtu   icmp_hun.ih_pmtu.ipm_nextmtu
78
79#define icmp_otime     icmp_dun.id_ts.its_otime
80#define icmp_rtime     icmp_dun.id_ts.its_rtime
81#define icmp_ttime     icmp_dun.id_ts.its_ttime
82#define icmp_ip        icmp_dun.id_ip.idi_ip
83#define icmp_mask      icmp_dun.id_mask
84#define icmp_data      icmp_dun.id_data
85
86#define ICMP_MINLEN                        8 /* absolute minimum length */
87#define	ICMP_TSLEN                        (8 + 3 * sizeof (uint32_t)) /* timestamp */
88#define	ICMP_MASKLEN                      12 /* address mask */
89#define ICMP_ADVLENMIN (8 + sizeof(struct ip) + 8)
90#define ICMP_ADVLEN(p) (8 + ((p)->icmp_ip.ip_hl << 2) + 8)
91
92/* Definition of type and code field values.
93 * http://www.iana.org/assignments/icmp-parameters
94 */
95#define   ICMP_ECHOREPLY                   0 /* echo reply */
96#define   ICMP_UNREACH                     3 /* dest unreachable, codes: */
97#define   ICMP_SOURCEQUENCH                4 /* packet lost, slow down */
98#define   ICMP_REDIRECT                    5 /* shorter route, codes: */
99#define   ICMP_ALTHOSTADDR                 6 /* alternate host address */
100#define   ICMP_ECHO                        8 /* echo service */
101#define   ICMP_ROUTERADVERT                9 /* router advertisement */
102#define   ICMP_ROUTERSOLICIT              10 /* router solicitation */
103#define   ICMP_TIMXCEED                   11 /* time exceeded, code: */
104#define   ICMP_PARAMPROB                  12 /* ip header bad */
105#define   ICMP_TSTAMP                     13 /* timestamp request */
106#define   ICMP_TSTAMPREPLY                14 /* timestamp reply */
107#define   ICMP_IREQ                       15 /* information request */
108#define   ICMP_IREQREPLY                  16 /* information reply */
109#define   ICMP_MASKREQ                    17 /* address mask request */
110#define   ICMP_MASKREPLY                  18 /* address mask reply */
111#define   ICMP_TRACEROUTE                 30 /* traceroute */
112#define   ICMP_DATACONVERR                31 /* data conversion error */
113#define   ICMP_MOBILE_REDIRECT            32 /* mobile host redirect */
114#define   ICMP_IPV6_WHEREAREYOU           33 /* IPv6 where-are-you */
115#define   ICMP_IPV6_IAMHERE               34 /* IPv6 i-am-here */
116#define   ICMP_MOBILE_REGREQUEST          35 /* mobile registration req */
117#define   ICMP_MOBILE_REGREPLY            36 /* mobile registration reply */
118#define   ICMP_SKIP                       39 /* SKIP */
119#define   ICMP_PHOTURIS                   40 /* Photuris */
120
121#define   ICMP_MAXTYPE                    40
122
123#define   ICMP_UNREACH_NET                 0 /* bad net */
124#define   ICMP_UNREACH_HOST                1 /* bad host */
125#define   ICMP_UNREACH_PROTOCOL            2 /* bad protocol */
126#define   ICMP_UNREACH_PORT                3 /* bad port */
127#define   ICMP_UNREACH_NEEDFRAG            4 /* IP_DF caused drop */
128#define   ICMP_UNREACH_SRCFAIL             5 /* src route failed */
129#define   ICMP_UNREACH_NET_UNKNOWN         6 /* unknown net */
130#define   ICMP_UNREACH_HOST_UNKNOWN        7 /* unknown host */
131#define   ICMP_UNREACH_ISOLATED            8 /* src host isolated */
132#define   ICMP_UNREACH_NET_PROHIB          9 /* for crypto devs */
133#define   ICMP_UNREACH_HOST_PROHIB        10 /* ditto */
134#define   ICMP_UNREACH_TOSNET             11 /* bad tos for net */
135#define   ICMP_UNREACH_TOSHOST            12 /* bad tos for host */
136#define   ICMP_UNREACH_FILTER_PROHIB      13 /* prohibited access */
137#define   ICMP_UNREACH_HOST_PRECEDENCE    14 /* precedence violat'n*/
138#define   ICMP_UNREACH_PRECEDENCE_CUTOFF  15 /* precedence cutoff */
139
140#define   ICMP_REDIRECT_NET                0 /* for network */
141#define   ICMP_REDIRECT_HOST               1 /* for host */
142#define   ICMP_REDIRECT_TOSNET             2 /* for tos and net */
143#define   ICMP_REDIRECT_TOSHOST            3 /* for tos and host */
144
145#define   ICMP_ROUTERADVERT_NORMAL         0 /* normal advertisement */
146#define   ICMP_ROUTERADVERT_NOROUTE_COMMON 16 /* selective routing */
147
148#define   ICMP_TIMXCEED_INTRANS            0 /* ttl==0 in transit */
149#define   ICMP_TIMXCEED_REASS              1 /* ttl==0 in reass */
150
151#define   ICMP_PARAMPROB_ERRATPTR          0 /* req. opt. absent */
152#define   ICMP_PARAMPROB_OPTABSENT         1 /* req. opt. absent */
153#define   ICMP_PARAMPROB_LENGTH            2 /* bad length */
154
155#define   ICMP_PHOTURIS_UNKNOWN_INDEX     1 /* unknown sec index */
156#define   ICMP_PHOTURIS_AUTH_FAILED       2 /* auth failed */
157#define   ICMP_PHOTURIS_DECRYPT_FAILED    3 /* decrypt failed */
158
159
160#define ICMP_INFOTYPE(type) \
161        ((type) == ICMP_ECHOREPLY || (type) == ICMP_ECHO || \
162        (type) == ICMP_ROUTERADVERT || (type) == ICMP_ROUTERSOLICIT || \
163        (type) == ICMP_TSTAMP || (type) == ICMP_TSTAMPREPLY || \
164        (type) == ICMP_IREQ || (type) == ICMP_IREQREPLY || \
165        (type) == ICMP_MASKREQ || (type) == ICMP_MASKREPLY)
166
167#endif /* NETINET_IP_ICMP_H */
168