| 1 | /* $Id: ip_icmp.h 106061 2024-09-16 14:03:52Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * NAT - IP/ICMP handling (declarations/defines).
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2006-2024 Oracle and/or its affiliates.
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox base platform packages, as
|
|---|
| 10 | * available from https://www.virtualbox.org.
|
|---|
| 11 | *
|
|---|
| 12 | * This program is free software; you can redistribute it and/or
|
|---|
| 13 | * modify it under the terms of the GNU General Public License
|
|---|
| 14 | * as published by the Free Software Foundation, in version 3 of the
|
|---|
| 15 | * License.
|
|---|
| 16 | *
|
|---|
| 17 | * This program is distributed in the hope that it will be useful, but
|
|---|
| 18 | * WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 20 | * General Public License for more details.
|
|---|
| 21 | *
|
|---|
| 22 | * You should have received a copy of the GNU General Public License
|
|---|
| 23 | * along with this program; if not, see <https://www.gnu.org/licenses>.
|
|---|
| 24 | *
|
|---|
| 25 | * SPDX-License-Identifier: GPL-3.0-only
|
|---|
| 26 | */
|
|---|
| 27 |
|
|---|
| 28 | /*
|
|---|
| 29 | * This code is based on:
|
|---|
| 30 | *
|
|---|
| 31 | * Copyright (c) 1982, 1986, 1993
|
|---|
| 32 | * The Regents of the University of California. All rights reserved.
|
|---|
| 33 | *
|
|---|
| 34 | * Redistribution and use in source and binary forms, with or without
|
|---|
| 35 | * modification, are permitted provided that the following conditions
|
|---|
| 36 | * are met:
|
|---|
| 37 | * 1. Redistributions of source code must retain the above copyright
|
|---|
| 38 | * notice, this list of conditions and the following disclaimer.
|
|---|
| 39 | * 2. Redistributions in binary form must reproduce the above copyright
|
|---|
| 40 | * notice, this list of conditions and the following disclaimer in the
|
|---|
| 41 | * documentation and/or other materials provided with the distribution.
|
|---|
| 42 | * 3. Neither the name of the University nor the names of its contributors
|
|---|
| 43 | * may be used to endorse or promote products derived from this software
|
|---|
| 44 | * without specific prior written permission.
|
|---|
| 45 | *
|
|---|
| 46 | * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|---|
| 47 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|---|
| 48 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|---|
| 49 | * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|---|
| 50 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|---|
| 51 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|---|
| 52 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|---|
| 53 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|---|
| 54 | * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|---|
| 55 | * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|---|
| 56 | * SUCH DAMAGE.
|
|---|
| 57 | *
|
|---|
| 58 | * @(#)ip_icmp.h 8.1 (Berkeley) 6/10/93
|
|---|
| 59 | * ip_icmp.h,v 1.4 1995/05/30 08:09:43 rgrimes Exp
|
|---|
| 60 | */
|
|---|
| 61 |
|
|---|
| 62 | #ifndef _NETINET_IP_ICMP_H_
|
|---|
| 63 | #define _NETINET_IP_ICMP_H_
|
|---|
| 64 | #include <queue.h>
|
|---|
| 65 |
|
|---|
| 66 | /*
|
|---|
| 67 | * Interface Control Message Protocol Definitions.
|
|---|
| 68 | * Per RFC 792, September 1981.
|
|---|
| 69 | */
|
|---|
| 70 |
|
|---|
| 71 | typedef u_int32_t n_time;
|
|---|
| 72 |
|
|---|
| 73 | /*
|
|---|
| 74 | * Structure of an icmp header.
|
|---|
| 75 | */
|
|---|
| 76 | struct icmp
|
|---|
| 77 | {
|
|---|
| 78 | uint8_t icmp_type; /* type of message, see below */
|
|---|
| 79 | uint8_t icmp_code; /* type sub code */
|
|---|
| 80 | uint16_t icmp_cksum; /* ones complement cksum of struct */
|
|---|
| 81 | union
|
|---|
| 82 | {
|
|---|
| 83 | uint8_t ih_pptr; /* ICMP_PARAMPROB */
|
|---|
| 84 | struct in_addr ih_gwaddr; /* ICMP_REDIRECT */
|
|---|
| 85 | struct ih_idseq
|
|---|
| 86 | {
|
|---|
| 87 | uint16_t icd_id;
|
|---|
| 88 | uint16_t icd_seq;
|
|---|
| 89 | } ih_idseq;
|
|---|
| 90 | int ih_void;
|
|---|
| 91 |
|
|---|
| 92 | /* ICMP_UNREACH_NEEDFRAG -- Path MTU Discovery (RFC1191) */
|
|---|
| 93 | struct ih_pmtu
|
|---|
| 94 | {
|
|---|
| 95 | uint16_t ipm_void;
|
|---|
| 96 | uint16_t ipm_nextmtu;
|
|---|
| 97 | } ih_pmtu;
|
|---|
| 98 | } icmp_hun;
|
|---|
| 99 | #define icmp_pptr icmp_hun.ih_pptr
|
|---|
| 100 | #define icmp_gwaddr icmp_hun.ih_gwaddr
|
|---|
| 101 | #define icmp_id icmp_hun.ih_idseq.icd_id
|
|---|
| 102 | #define icmp_seq icmp_hun.ih_idseq.icd_seq
|
|---|
| 103 | #define icmp_void icmp_hun.ih_void
|
|---|
| 104 | #define icmp_pmvoid icmp_hun.ih_pmtu.ipm_void
|
|---|
| 105 | #define icmp_nextmtu icmp_hun.ih_pmtu.ipm_nextmtu
|
|---|
| 106 | union
|
|---|
| 107 | {
|
|---|
| 108 | struct id_ts
|
|---|
| 109 | {
|
|---|
| 110 | n_time its_otime;
|
|---|
| 111 | n_time its_rtime;
|
|---|
| 112 | n_time its_ttime;
|
|---|
| 113 | } id_ts;
|
|---|
| 114 | struct id_ip
|
|---|
| 115 | {
|
|---|
| 116 | struct ip idi_ip;
|
|---|
| 117 | /* options and then 64 bits of data */
|
|---|
| 118 | } id_ip;
|
|---|
| 119 | uint32_t id_mask;
|
|---|
| 120 | char id_data[1];
|
|---|
| 121 | } icmp_dun;
|
|---|
| 122 | #define icmp_otime icmp_dun.id_ts.its_otime
|
|---|
| 123 | #define icmp_rtime icmp_dun.id_ts.its_rtime
|
|---|
| 124 | #define icmp_ttime icmp_dun.id_ts.its_ttime
|
|---|
| 125 | #define icmp_ip icmp_dun.id_ip.idi_ip
|
|---|
| 126 | #define icmp_mask icmp_dun.id_mask
|
|---|
| 127 | #define icmp_data icmp_dun.id_data
|
|---|
| 128 | };
|
|---|
| 129 | AssertCompileSize(struct icmp, 28);
|
|---|
| 130 |
|
|---|
| 131 | /*
|
|---|
| 132 | * Lower bounds on packet lengths for various types.
|
|---|
| 133 | * For the error advice packets must first insure that the
|
|---|
| 134 | * packet is large enought to contain the returned ip header.
|
|---|
| 135 | * Only then can we do the check to see if 64 bits of packet
|
|---|
| 136 | * data have been returned, since we need to check the returned
|
|---|
| 137 | * ip header length.
|
|---|
| 138 | */
|
|---|
| 139 | #define ICMP_MINLEN 8 /* abs minimum */
|
|---|
| 140 | #define ICMP_TSLEN (8 + 3 * sizeof (n_time)) /* timestamp */
|
|---|
| 141 | #define ICMP_MASKLEN 12 /* address mask */
|
|---|
| 142 | #define ICMP_ADVLENMIN (8 + sizeof (struct ip) + 8) /* min */
|
|---|
| 143 | #define ICMP_ADVLEN(p) (8 + ((p)->icmp_ip.ip_hl << 2) + 8)
|
|---|
| 144 | /* N.B.: must separately check that ip_hl >= 5 */
|
|---|
| 145 |
|
|---|
| 146 | /*
|
|---|
| 147 | * Definition of type and code field values.
|
|---|
| 148 | */
|
|---|
| 149 | #define ICMP_ECHOREPLY 0 /* echo reply */
|
|---|
| 150 | #define ICMP_UNREACH 3 /* dest unreachable, codes: */
|
|---|
| 151 | #define ICMP_UNREACH_NET 0 /* bad net */
|
|---|
| 152 | #define ICMP_UNREACH_HOST 1 /* bad host */
|
|---|
| 153 | #define ICMP_UNREACH_PROTOCOL 2 /* bad protocol */
|
|---|
| 154 | #define ICMP_UNREACH_PORT 3 /* bad port */
|
|---|
| 155 | #define ICMP_UNREACH_NEEDFRAG 4 /* IP_DF caused drop */
|
|---|
| 156 | #define ICMP_UNREACH_SRCFAIL 5 /* src route failed */
|
|---|
| 157 | #define ICMP_UNREACH_NET_UNKNOWN 6 /* unknown net */
|
|---|
| 158 | #define ICMP_UNREACH_HOST_UNKNOWN 7 /* unknown host */
|
|---|
| 159 | #define ICMP_UNREACH_ISOLATED 8 /* src host isolated */
|
|---|
| 160 | #define ICMP_UNREACH_NET_PROHIB 9 /* prohibited access */
|
|---|
| 161 | #define ICMP_UNREACH_HOST_PROHIB 10 /* ditto */
|
|---|
| 162 | #define ICMP_UNREACH_TOSNET 11 /* bad tos for net */
|
|---|
| 163 | #define ICMP_UNREACH_TOSHOST 12 /* bad tos for host */
|
|---|
| 164 | #define ICMP_SOURCEQUENCH 4 /* packet lost, slow down */
|
|---|
| 165 | #define ICMP_REDIRECT 5 /* shorter route, codes: */
|
|---|
| 166 | #define ICMP_REDIRECT_NET 0 /* for network */
|
|---|
| 167 | #define ICMP_REDIRECT_HOST 1 /* for host */
|
|---|
| 168 | #define ICMP_REDIRECT_TOSNET 2 /* for tos and net */
|
|---|
| 169 | #define ICMP_REDIRECT_TOSHOST 3 /* for tos and host */
|
|---|
| 170 | #define ICMP_ECHO 8 /* echo service */
|
|---|
| 171 | #define ICMP_ROUTERADVERT 9 /* router advertisement */
|
|---|
| 172 | #define ICMP_ROUTERSOLICIT 10 /* router solicitation */
|
|---|
| 173 | #define ICMP_TIMXCEED 11 /* time exceeded, code: */
|
|---|
| 174 | #define ICMP_TIMXCEED_INTRANS 0 /* ttl==0 in transit */
|
|---|
| 175 | #define ICMP_TIMXCEED_REASS 1 /* ttl==0 in reass */
|
|---|
| 176 | #define ICMP_PARAMPROB 12 /* ip header bad */
|
|---|
| 177 | #define ICMP_PARAMPROB_OPTABSENT 1 /* req. opt. absent */
|
|---|
| 178 | #define ICMP_TSTAMP 13 /* timestamp request */
|
|---|
| 179 | #define ICMP_TSTAMPREPLY 14 /* timestamp reply */
|
|---|
| 180 | #define ICMP_IREQ 15 /* information request */
|
|---|
| 181 | #define ICMP_IREQREPLY 16 /* information reply */
|
|---|
| 182 | #define ICMP_MASKREQ 17 /* address mask request */
|
|---|
| 183 | #define ICMP_MASKREPLY 18 /* address mask reply */
|
|---|
| 184 |
|
|---|
| 185 | #define ICMP_MAXTYPE 18
|
|---|
| 186 |
|
|---|
| 187 | #define ICMP_INFOTYPE(type) \
|
|---|
| 188 | ((type) == ICMP_ECHOREPLY || (type) == ICMP_ECHO || \
|
|---|
| 189 | (type) == ICMP_ROUTERADVERT || (type) == ICMP_ROUTERSOLICIT || \
|
|---|
| 190 | (type) == ICMP_TSTAMP || (type) == ICMP_TSTAMPREPLY || \
|
|---|
| 191 | (type) == ICMP_IREQ || (type) == ICMP_IREQREPLY || \
|
|---|
| 192 | (type) == ICMP_MASKREQ || (type) == ICMP_MASKREPLY)
|
|---|
| 193 |
|
|---|
| 194 | void icmp_input (PNATState, struct mbuf *, int);
|
|---|
| 195 | void icmp_error (PNATState, struct mbuf *, u_char, u_char, int, const char *);
|
|---|
| 196 | void icmp_reflect (PNATState, struct mbuf *);
|
|---|
| 197 |
|
|---|
| 198 | struct icmp_msg
|
|---|
| 199 | {
|
|---|
| 200 | TAILQ_ENTRY(icmp_msg) im_queue;
|
|---|
| 201 | struct mbuf *im_m;
|
|---|
| 202 | struct socket *im_so;
|
|---|
| 203 | };
|
|---|
| 204 |
|
|---|
| 205 | TAILQ_HEAD(icmp_storage, icmp_msg);
|
|---|
| 206 |
|
|---|
| 207 | int icmp_init (PNATState , int);
|
|---|
| 208 | void icmp_finit (PNATState );
|
|---|
| 209 | struct icmp_msg * icmp_find_original_mbuf (PNATState , struct ip *);
|
|---|
| 210 | void icmp_msg_delete(PNATState, struct icmp_msg *);
|
|---|
| 211 |
|
|---|
| 212 | #ifdef RT_OS_WINDOWS
|
|---|
| 213 | /* Windows ICMP API code in ip_icmpwin.c */
|
|---|
| 214 | int icmpwin_init (PNATState);
|
|---|
| 215 | void icmpwin_finit (PNATState);
|
|---|
| 216 | void icmpwin_ping(PNATState, struct mbuf *, int);
|
|---|
| 217 | void icmpwin_process(PNATState);
|
|---|
| 218 | #endif
|
|---|
| 219 |
|
|---|
| 220 | #endif
|
|---|
