ip_icmp.h revision 1.36
1/* $NetBSD: ip_icmp.h,v 1.36 2018/01/19 10:21:24 maxv Exp $ */ 2 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/* 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} __packed; 50 51/* 52 * Structure of an icmp header. 53 */ 54struct icmp { 55 u_int8_t icmp_type; /* type of message, see below */ 56 u_int8_t icmp_code; /* type sub code */ 57 u_int16_t icmp_cksum; /* ones complement cksum of struct */ 58 59 union { 60 int32_t ih_void; 61 62 /* ICMP_PARAMPROB */ 63 u_int8_t ih_pptr; 64 65 /* ICMP_REDIRECT */ 66 struct in_addr ih_gwaddr; 67 68 /* ICMP_ECHO and friends */ 69 struct ih_idseq { 70 n_short icd_id; 71 n_short icd_seq; 72 } ih_idseq __packed; 73 74 /* ICMP_UNREACH_NEEDFRAG (Path MTU Discovery, RFC1191) */ 75 struct ih_pmtu { 76 n_short ipm_void; 77 n_short ipm_nextmtu; 78 } ih_pmtu __packed; 79 80 /* ICMP_ROUTERADVERT */ 81 struct ih_rtradv { 82 u_int8_t irt_num_addrs; 83 u_int8_t irt_wpa; 84 u_int16_t irt_lifetime; 85 } ih_rtradv __packed; 86 } icmp_hun /* XXX __packed ??? */; 87 88#define icmp_pptr icmp_hun.ih_pptr 89#define icmp_gwaddr icmp_hun.ih_gwaddr 90#define icmp_id icmp_hun.ih_idseq.icd_id 91#define icmp_seq icmp_hun.ih_idseq.icd_seq 92#define icmp_void icmp_hun.ih_void 93#define icmp_pmvoid icmp_hun.ih_pmtu.ipm_void 94#define icmp_nextmtu icmp_hun.ih_pmtu.ipm_nextmtu 95#define icmp_num_addrs icmp_hun.ih_rtradv.irt_num_addrs 96#define icmp_wpa icmp_hun.ih_rtradv.irt_wpa 97#define icmp_lifetime icmp_hun.ih_rtradv.irt_lifetime 98 99 union { 100 /* ICMP_TSTAMP and friends */ 101 struct id_ts { 102 n_time its_otime; 103 n_time its_rtime; 104 n_time its_ttime; 105 } id_ts __packed; 106 107 struct id_ip { 108 struct ip idi_ip; 109 /* options and then 64 bits of data */ 110 } id_ip /* XXX: __packed ??? */; 111 112 /* ICMP_ROUTERADVERT */ 113 struct icmp_ra_addr id_radv; 114 115 /* ICMP_MASKREQ and friends */ 116 u_int32_t id_mask; 117 118 int8_t id_data[1]; 119 } icmp_dun /* XXX __packed ??? */; 120 121#define icmp_otime icmp_dun.id_ts.its_otime 122#define icmp_rtime icmp_dun.id_ts.its_rtime 123#define icmp_ttime icmp_dun.id_ts.its_ttime 124#define icmp_ip icmp_dun.id_ip.idi_ip 125#define icmp_radv icmp_dun.id_radv 126#define icmp_mask icmp_dun.id_mask 127#define icmp_data icmp_dun.id_data 128}; 129 130/* 131 * Lower bounds on packet lengths for various types. 132 * For the error advice packets must first insure that the 133 * packet is large enought to contain the returned ip header. 134 * Only then can we do the check to see if 64 bits of packet 135 * data have been returned, since we need to check the returned 136 * ip header length. 137 */ 138#define ICMP_MINLEN 8 /* abs minimum */ 139#define ICMP_TSLEN (8 + 3 * sizeof (n_time)) /* timestamp */ 140#define ICMP_MASKLEN 12 /* address mask */ 141#define ICMP_ADVLENMIN (8 + sizeof (struct ip) + 8) /* min */ 142#define ICMP_ADVLEN(p) (8 + ((p)->icmp_ip.ip_hl << 2) + 8) 143 /* N.B.: must separately check that ip_hl >= 5 */ 144 145/* 146 * Definition of type and code field values. 147 */ 148#define ICMP_ECHOREPLY 0 /* echo reply */ 149#define ICMP_UNREACH 3 /* dest unreachable, codes: */ 150#define ICMP_UNREACH_NET 0 /* bad net */ 151#define ICMP_UNREACH_HOST 1 /* bad host */ 152#define ICMP_UNREACH_PROTOCOL 2 /* bad protocol */ 153#define ICMP_UNREACH_PORT 3 /* bad port */ 154#define ICMP_UNREACH_NEEDFRAG 4 /* IP_DF caused drop */ 155#define ICMP_UNREACH_SRCFAIL 5 /* src route failed */ 156#define ICMP_UNREACH_NET_UNKNOWN 6 /* unknown net */ 157#define ICMP_UNREACH_HOST_UNKNOWN 7 /* unknown host */ 158#define ICMP_UNREACH_ISOLATED 8 /* src host isolated */ 159#define ICMP_UNREACH_NET_PROHIB 9 /* prohibited access */ 160#define ICMP_UNREACH_HOST_PROHIB 10 /* ditto */ 161#define ICMP_UNREACH_TOSNET 11 /* bad tos for net */ 162#define ICMP_UNREACH_TOSHOST 12 /* bad tos for host */ 163#define ICMP_UNREACH_ADMIN_PROHIBIT 13 /* communication 164 administratively 165 prohibited */ 166#define ICMP_UNREACH_HOST_PREC 14 /* host precedence 167 violation */ 168#define ICMP_UNREACH_PREC_CUTOFF 15 /* precedence cutoff */ 169#define ICMP_SOURCEQUENCH 4 /* packet lost, slow down */ 170#define ICMP_REDIRECT 5 /* shorter route, codes: */ 171#define ICMP_REDIRECT_NET 0 /* for network */ 172#define ICMP_REDIRECT_HOST 1 /* for host */ 173#define ICMP_REDIRECT_TOSNET 2 /* for tos and net */ 174#define ICMP_REDIRECT_TOSHOST 3 /* for tos and host */ 175#define ICMP_ALTHOSTADDR 6 /* alternative host address */ 176#define ICMP_ECHO 8 /* echo service */ 177#define ICMP_ROUTERADVERT 9 /* router advertisement */ 178#define ICMP_ROUTERADVERT_NORMAL 0 179#define ICMP_ROUTERADVERT_NOROUTE 16 180#define ICMP_ROUTERSOLICIT 10 /* router solicitation */ 181#define ICMP_TIMXCEED 11 /* time exceeded, code: */ 182#define ICMP_TIMXCEED_INTRANS 0 /* ttl==0 in transit */ 183#define ICMP_TIMXCEED_REASS 1 /* ttl==0 in reass */ 184#define ICMP_PARAMPROB 12 /* ip header bad */ 185#define ICMP_PARAMPROB_ERRATPTR 0 186#define ICMP_PARAMPROB_OPTABSENT 1 187#define ICMP_PARAMPROB_LENGTH 2 188#define ICMP_TSTAMP 13 /* timestamp request */ 189#define ICMP_TSTAMPREPLY 14 /* timestamp reply */ 190#define ICMP_IREQ 15 /* information request */ 191#define ICMP_IREQREPLY 16 /* information reply */ 192#define ICMP_MASKREQ 17 /* address mask request */ 193#define ICMP_MASKREPLY 18 /* address mask reply */ 194#define ICMP_TRACEROUTE 30 /* traceroute */ 195#define ICMP_DATACONVERR 31 /* data conversion error */ 196#define ICMP_MOBILE_REDIRECT 32 /* mobile redirect */ 197#define ICMP_IPV6_WHEREAREYOU 33 /* ipv6 where are you */ 198#define ICMP_IPV6_IAMHERE 34 /* ipv6 i am here */ 199#define ICMP_MOBILE_REGREQUEST 35 /* mobile registration req */ 200#define ICMP_MOBILE_REGREPLY 36 /* mobile registration reply */ 201#define ICMP_SKIP 39 /* SKIP */ 202#define ICMP_PHOTURIS 40 /* security */ 203#define ICMP_PHOTURIS_UNKNOWN_INDEX 0 /* unknown sec index */ 204#define ICMP_PHOTURIS_AUTH_FAILED 1 /* auth failed */ 205#define ICMP_PHOTURIS_DECOMPRESS_FAILED 2 /* decompress failed */ 206#define ICMP_PHOTURIS_DECRYPT_FAILED 3 /* decrypt failed */ 207#define ICMP_PHOTURIS_NEED_AUTHN 4 /* no authentication */ 208#define ICMP_PHOTURIS_NEED_AUTHZ 5 /* no authorization */ 209 210#define ICMP_MAXTYPE 40 211#define ICMP_NTYPES (ICMP_MAXTYPE + 1) 212 213#ifdef ICMP_STRINGS 214static const char *icmp_type[] = { 215 "echoreply", "unassigned_1", "unassigned_2", "unreach", 216 "sourcequench", "redirect", "althostaddr", "unassigned_7", 217 "echo", "routeradvert", "routersolicit", "timxceed", 218 "paramprob", "tstamp", "tstampreply", "ireq", 219 "ireqreply", "maskreq", "maskreply", "reserved_19", 220 "reserved_20", "reserved_21", "reserved_22", "reserved_23", 221 "reserved_24", "reserved_25", "reserved_26", "reserved_27", 222 "reserved_28", "reserved_29", "traceroute", "dataconverr", 223 "mobile_redirect", "ipv6_whereareyou", "ipv6_iamhere", 224 "mobile_regrequest", "mobile_regreply", "reserved_37", 225 "reserved_38", "skip", "photuris", NULL 226}; 227static const char *icmp_code_none[] = { "none", NULL }; 228static const char *icmp_code_unreach[] = { 229 "net", "host", "oprt", "needfrag", "srcfail", "net_unknown", 230 "host_unknown", "isolated", "net_prohib", "host_prohib", 231 "tosnet", "toshost", "admin_prohibit", "host_prec", "prec_cutoff", NULL 232}; 233static const char *icmp_code_redirect[] = { 234 "net", "host", "tosnet", "toshost", NULL 235}; 236static const char *icmp_code_routeradvert[] = { 237 "normal", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", 238 "noroute", NULL 239}; 240static const char *icmp_code_timxceed[] = { 241 "intrans", "reass", NULL 242}; 243static const char *icmp_code_paramprob[] = { 244 "erratptr", "optabsent", "length", NULL 245}; 246static const char *icmp_code_photuris[] = { 247 "unknown_index", "auth_failed", "decompress_failed", 248 "decrypt_failed", "need_authn", "need_authz", NULL 249}; 250#endif 251 252#define ICMP_INFOTYPE(type) \ 253 ((type) == ICMP_ECHOREPLY || (type) == ICMP_ECHO || \ 254 (type) == ICMP_ROUTERADVERT || (type) == ICMP_ROUTERSOLICIT || \ 255 (type) == ICMP_TSTAMP || (type) == ICMP_TSTAMPREPLY || \ 256 (type) == ICMP_IREQ || (type) == ICMP_IREQREPLY || \ 257 (type) == ICMP_MASKREQ || (type) == ICMP_MASKREPLY) 258 259#ifdef _KERNEL 260void icmp_error(struct mbuf *, int, int, n_long, int); 261void icmp_mtudisc(struct icmp *, struct in_addr); 262void icmp_input(struct mbuf *, ...); 263void icmp_init(void); 264void icmp_reflect(struct mbuf *); 265void icmp_send(struct mbuf *, struct mbuf *); 266int icmp_sysctl(int *, u_int, void *, size_t *, void *, size_t); 267 268void icmp_mtudisc_callback_register(void (*)(struct in_addr)); 269int icmp_ratelimit(const struct in_addr *, const int, const int); 270void icmp_mtudisc_lock(void); 271void icmp_mtudisc_unlock(void); 272#endif 273 274 275#endif /* !_NETINET_IP_ICMP_H_ */ 276