1 /* 2 * Copyright (c) 2008-2018 Apple Inc. All rights reserved. 3 * 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5 * 6 * This file contains Original Code and/or Modifications of Original Code 7 * as defined in and that are subject to the Apple Public Source License 8 * Version 2.0 (the 'License'). You may not use this file except in 9 * compliance with the License. The rights granted to you under the License 10 * may not be used to create, or enable the creation or redistribution of, 11 * unlawful or unlicensed copies of an Apple operating system, or to 12 * circumvent, violate, or enable the circumvention or violation of, any 13 * terms of an Apple operating system software license agreement. 14 * 15 * Please obtain a copy of the License at 16 * http://www.opensource.apple.com/apsl/ and read it before using this file. 17 * 18 * The Original Code and all software distributed under the License are 19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23 * Please see the License for the specific language governing rights and 24 * limitations under the License. 25 * 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27 */ 28 /* 29 * Copyright (c) 1982, 1986, 1993 30 * The Regents of the University of California. All rights reserved. 31 * 32 * Redistribution and use in source and binary forms, with or without 33 * modification, are permitted provided that the following conditions 34 * are met: 35 * 1. Redistributions of source code must retain the above copyright 36 * notice, this list of conditions and the following disclaimer. 37 * 2. Redistributions in binary form must reproduce the above copyright 38 * notice, this list of conditions and the following disclaimer in the 39 * documentation and/or other materials provided with the distribution. 40 * 3. All advertising materials mentioning features or use of this software 41 * must display the following acknowledgement: 42 * This product includes software developed by the University of 43 * California, Berkeley and its contributors. 44 * 4. Neither the name of the University nor the names of its contributors 45 * may be used to endorse or promote products derived from this software 46 * without specific prior written permission. 47 * 48 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 49 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 50 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 51 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 52 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 53 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 54 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 55 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 56 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 57 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 58 * SUCH DAMAGE. 59 * 60 * @(#)ip_icmp.h 8.1 (Berkeley) 6/10/93 61 * $FreeBSD: src/sys/netinet/ip_icmp.h,v 1.16 1999/12/29 04:41:01 peter Exp $ 62 */ 63 64 #ifndef _NETINET_IP_ICMP_H_ 65 #define _NETINET_IP_ICMP_H_ 66 #include <sys/appleapiopts.h> 67 68 #include <netinet/in.h> 69 #include <netinet/in_systm.h> 70 #include <netinet/ip.h> 71 #include <sys/types.h> 72 73 /* 74 * Interface Control Message Protocol Definitions. 75 * Per RFC 792, September 1981. 76 */ 77 78 /* 79 * Internal of an ICMP Router Advertisement 80 */ 81 struct icmp_ra_addr { 82 u_int32_t ira_addr; 83 u_int32_t ira_preference; 84 }; 85 86 /* 87 * Structure of an icmp header. 88 */ 89 struct icmp { 90 u_char icmp_type; /* type of message, see below */ 91 u_char icmp_code; /* type sub code */ 92 u_short icmp_cksum; /* ones complement cksum of struct */ 93 union { 94 u_char ih_pptr; /* ICMP_PARAMPROB */ 95 struct in_addr ih_gwaddr; /* ICMP_REDIRECT */ 96 struct ih_idseq { 97 n_short icd_id; 98 n_short icd_seq; 99 } ih_idseq; 100 int ih_void; 101 102 /* ICMP_UNREACH_NEEDFRAG -- Path MTU Discovery (RFC1191) */ 103 struct ih_pmtu { 104 n_short ipm_void; 105 n_short ipm_nextmtu; 106 } ih_pmtu; 107 108 struct ih_rtradv { 109 u_char irt_num_addrs; 110 u_char irt_wpa; 111 u_int16_t irt_lifetime; 112 } ih_rtradv; 113 } icmp_hun; 114 #define icmp_pptr icmp_hun.ih_pptr 115 #define icmp_gwaddr icmp_hun.ih_gwaddr 116 #define icmp_id icmp_hun.ih_idseq.icd_id 117 #define icmp_seq icmp_hun.ih_idseq.icd_seq 118 #define icmp_void icmp_hun.ih_void 119 #define icmp_pmvoid icmp_hun.ih_pmtu.ipm_void 120 #define icmp_nextmtu icmp_hun.ih_pmtu.ipm_nextmtu 121 #define icmp_num_addrs icmp_hun.ih_rtradv.irt_num_addrs 122 #define icmp_wpa icmp_hun.ih_rtradv.irt_wpa 123 #define icmp_lifetime icmp_hun.ih_rtradv.irt_lifetime 124 union { 125 struct id_ts { 126 n_time its_otime; 127 n_time its_rtime; 128 n_time its_ttime; 129 } id_ts; 130 struct id_ip { 131 struct ip idi_ip; 132 /* options and then 64 bits of data */ 133 } id_ip; 134 struct icmp_ra_addr id_radv; 135 u_int32_t id_mask; 136 char id_data[1]; 137 } icmp_dun; 138 #define icmp_otime icmp_dun.id_ts.its_otime 139 #define icmp_rtime icmp_dun.id_ts.its_rtime 140 #define icmp_ttime icmp_dun.id_ts.its_ttime 141 #define icmp_ip icmp_dun.id_ip.idi_ip 142 #define icmp_radv icmp_dun.id_radv 143 #define icmp_mask icmp_dun.id_mask 144 #define icmp_data icmp_dun.id_data 145 }; 146 147 /* 148 * Lower bounds on packet lengths for various types. 149 * For the error advice packets must first insure that the 150 * packet is large enough to contain the returned ip header. 151 * Only then can we do the check to see if 64 bits of packet 152 * data have been returned, since we need to check the returned 153 * ip header length. 154 */ 155 #define ICMP_MINLEN 8 /* abs minimum */ 156 #define ICMP_TSLEN (8 + 3 * sizeof (n_time)) /* timestamp */ 157 #define ICMP_MASKLEN 12 /* address mask */ 158 #define ICMP_ADVLENMIN (8 + sizeof (struct ip) + 8) /* min */ 159 #ifndef _IP_VHL 160 #define ICMP_ADVLEN(p) (8 + ((p)->icmp_ip.ip_hl << 2) + 8) 161 /* N.B.: must separately check that ip_hl >= 5 */ 162 #else 163 #define ICMP_ADVLEN(p) (8 + (IP_VHL_HL((p)->icmp_ip.ip_vhl) << 2) + 8) 164 /* N.B.: must separately check that header length >= 5 */ 165 #endif 166 167 /* 168 * Definition of type and code field values. 169 */ 170 #define ICMP_ECHOREPLY 0 /* echo reply */ 171 #define ICMP_UNREACH 3 /* dest unreachable, codes: */ 172 #define ICMP_UNREACH_NET 0 /* bad net */ 173 #define ICMP_UNREACH_HOST 1 /* bad host */ 174 #define ICMP_UNREACH_PROTOCOL 2 /* bad protocol */ 175 #define ICMP_UNREACH_PORT 3 /* bad port */ 176 #define ICMP_UNREACH_NEEDFRAG 4 /* IP_DF caused drop */ 177 #define ICMP_UNREACH_SRCFAIL 5 /* src route failed */ 178 #define ICMP_UNREACH_NET_UNKNOWN 6 /* unknown net */ 179 #define ICMP_UNREACH_HOST_UNKNOWN 7 /* unknown host */ 180 #define ICMP_UNREACH_ISOLATED 8 /* src host isolated */ 181 #define ICMP_UNREACH_NET_PROHIB 9 /* prohibited access */ 182 #define ICMP_UNREACH_HOST_PROHIB 10 /* ditto */ 183 #define ICMP_UNREACH_TOSNET 11 /* bad tos for net */ 184 #define ICMP_UNREACH_TOSHOST 12 /* bad tos for host */ 185 #define ICMP_UNREACH_FILTER_PROHIB 13 /* admin prohib */ 186 #define ICMP_UNREACH_HOST_PRECEDENCE 14 /* host prec vio. */ 187 #define ICMP_UNREACH_PRECEDENCE_CUTOFF 15 /* prec cutoff */ 188 #define ICMP_SOURCEQUENCH 4 /* packet lost, slow down */ 189 #define ICMP_REDIRECT 5 /* shorter route, codes: */ 190 #define ICMP_REDIRECT_NET 0 /* for network */ 191 #define ICMP_REDIRECT_HOST 1 /* for host */ 192 #define ICMP_REDIRECT_TOSNET 2 /* for tos and net */ 193 #define ICMP_REDIRECT_TOSHOST 3 /* for tos and host */ 194 #define ICMP_ALTHOSTADDR 6 /* alternate host address */ 195 #define ICMP_ECHO 8 /* echo service */ 196 #define ICMP_ROUTERADVERT 9 /* router advertisement */ 197 #define ICMP_ROUTERADVERT_NORMAL 0 /* normal advertisement */ 198 #define ICMP_ROUTERADVERT_NOROUTE_COMMON 16 /* selective routing */ 199 #define ICMP_ROUTERSOLICIT 10 /* router solicitation */ 200 #define ICMP_TIMXCEED 11 /* time exceeded, code: */ 201 #define ICMP_TIMXCEED_INTRANS 0 /* ttl==0 in transit */ 202 #define ICMP_TIMXCEED_REASS 1 /* ttl==0 in reass */ 203 #define ICMP_PARAMPROB 12 /* ip header bad */ 204 #define ICMP_PARAMPROB_ERRATPTR 0 /* error at param ptr */ 205 #define ICMP_PARAMPROB_OPTABSENT 1 /* req. opt. absent */ 206 #define ICMP_PARAMPROB_LENGTH 2 /* bad length */ 207 #define ICMP_TSTAMP 13 /* timestamp request */ 208 #define ICMP_TSTAMPREPLY 14 /* timestamp reply */ 209 #define ICMP_IREQ 15 /* information request */ 210 #define ICMP_IREQREPLY 16 /* information reply */ 211 #define ICMP_MASKREQ 17 /* address mask request */ 212 #define ICMP_MASKREPLY 18 /* address mask reply */ 213 #define ICMP_TRACEROUTE 30 /* traceroute */ 214 #define ICMP_DATACONVERR 31 /* data conversion error */ 215 #define ICMP_MOBILE_REDIRECT 32 /* mobile host redirect */ 216 #define ICMP_IPV6_WHEREAREYOU 33 /* IPv6 where-are-you */ 217 #define ICMP_IPV6_IAMHERE 34 /* IPv6 i-am-here */ 218 #define ICMP_MOBILE_REGREQUEST 35 /* mobile registration req */ 219 #define ICMP_MOBILE_REGREPLY 36 /* mobile registration reply */ 220 #define ICMP_SKIP 39 /* SKIP */ 221 #define ICMP_PHOTURIS 40 /* Photuris */ 222 #define ICMP_PHOTURIS_UNKNOWN_INDEX 1 /* unknown sec index */ 223 #define ICMP_PHOTURIS_AUTH_FAILED 2 /* auth failed */ 224 #define ICMP_PHOTURIS_DECRYPT_FAILED 3 /* decrypt failed */ 225 226 #define ICMP_MAXTYPE 40 227 228 #define ICMP_INFOTYPE(type) \ 229 ((type) == ICMP_ECHOREPLY || (type) == ICMP_ECHO || \ 230 (type) == ICMP_ROUTERADVERT || (type) == ICMP_ROUTERSOLICIT || \ 231 (type) == ICMP_TSTAMP || (type) == ICMP_TSTAMPREPLY || \ 232 (type) == ICMP_IREQ || (type) == ICMP_IREQREPLY || \ 233 (type) == ICMP_MASKREQ || (type) == ICMP_MASKREPLY) 234 235 #define ICMP_ERRORTYPE(type) \ 236 ((type) == ICMP_UNREACH || (type) == ICMP_SOURCEQUENCH || \ 237 (type) == ICMP_REDIRECT || (type) == ICMP_TIMXCEED || \ 238 (type) == ICMP_PARAMPROB) 239 240 #ifdef BSD_KERNEL_PRIVATE 241 void icmp_error(struct mbuf *, int, int, n_long, u_int32_t); 242 void icmp_input(struct mbuf *, int); 243 int ip_next_mtu(int, int); 244 #endif /* BSD_KERNEL_PRIVATE */ 245 #endif /* _NETINET_IP_ICMP_H_ */ 246