1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
/***************************************************************************
* Copyright (c) 2024 Microsoft Corporation
* Copyright (c) 2025-present Eclipse ThreadX Contributors
*
* This program and the accompanying materials are made available under the
* terms of the MIT License which is available at
* https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: MIT
**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** NetX Component */
/** */
/** Internet Control Message Protocol (ICMP) */
/** */
/**************************************************************************/
/**************************************************************************/
#define NX_SOURCE_CODE
/* Include necessary system files. */
#include "nx_api.h"
#include "nx_packet.h"
#include "nx_ip.h"
#include "nx_icmp.h"
#ifdef NX_IPSEC_ENABLE
#include "nx_ipsec.h"
#endif /* NX_IPSEC_ENABLE */
#ifndef NX_DISABLE_IPV4
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_icmpv4_process_echo_request PORTABLE C */
/* 6.4.3 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This internal function processes incoming echo request message. */
/* It validates the echo request and sends an echo reply back to the */
/* sender. */
/* */
/* INPUT */
/* */
/* ip_ptr Pointer to IP control block */
/* packet_ptr ICMP packet pointer */
/* */
/* OUTPUT */
/* */
/* None */
/* */
/* CALLS */
/* */
/* _nx_ip_route_find Find a suitable outgoing */
/* interface. */
/* _nx_ip_packet_send Send ICMP packet out */
/* _nx_packet_release Release packet to packet pool */
/* */
/* CALLED BY */
/* */
/* _nx_icmpv4_packet_process Main ICMP packet pocess */
/* */
/**************************************************************************/
VOID _nx_icmpv4_process_echo_request(NX_IP *ip_ptr, NX_PACKET *packet_ptr)
{
NX_ICMPV4_HEADER *header_ptr;
ULONG checksum;
ULONG old_m;
#if defined(NX_DISABLE_ICMPV4_TX_CHECKSUM) || defined(NX_ENABLE_INTERFACE_CAPABILITY) || defined(NX_IPSEC_ENABLE)
ULONG compute_checksum = 1;
#endif /* defined(NX_DISABLE_ICMPV4_TX_CHECKSUM) || defined(NX_ENABLE_INTERFACE_CAPABILITY) || defined(NX_IPSEC_ENABLE) */
NX_IPV4_HEADER *ipv4_header;
ULONG next_hop_address = NX_NULL;
#ifdef NX_IPSEC_ENABLE
ULONG data_offset;
VOID *sa = NX_NULL;
NXD_ADDRESS src_addr;
NXD_ADDRESS dest_addr;
UINT ret;
#endif /* NX_IPSEC_ENABLE */
/* Add debug information. */
NX_PACKET_DEBUG(__FILE__, __LINE__, packet_ptr);
/* Point to the ICMP message header. */
/*lint -e{927} -e{826} suppress cast of pointer to pointer, since it is necessary */
header_ptr = (NX_ICMPV4_HEADER *)packet_ptr -> nx_packet_prepend_ptr;
/* Pickup the return IP address. */
/*lint -e{927} -e{826} suppress cast of pointer to pointer, since it is necessary */
ipv4_header = (NX_IPV4_HEADER *)packet_ptr -> nx_packet_ip_header;
#ifndef NX_DISABLE_ICMP_INFO
/* Increment the ICMP pings received count. */
ip_ptr -> nx_ip_pings_received++;
#endif
/* Change the type to Echo Reply and send back the message to the caller. */
header_ptr -> nx_icmpv4_header_type = NX_ICMP_ECHO_REPLY_TYPE;
#ifdef NX_IPSEC_ENABLE
src_addr.nxd_ip_version = NX_IP_VERSION_V4;
src_addr.nxd_ip_address.v4 = packet_ptr -> nx_packet_address.nx_packet_interface_ptr -> nx_interface_ip_address;
dest_addr.nxd_ip_version = NX_IP_VERSION_V4;
dest_addr.nxd_ip_address.v4 = ipv4_header -> nx_ip_header_source_ip;
/* Check if IPsec is enabled. */
if (ip_ptr -> nx_ip_packet_egress_sa_lookup != NX_NULL)
{
/* Check for possible SA match. */
ret = ip_ptr -> nx_ip_packet_egress_sa_lookup(ip_ptr, /* IP ptr */
&src_addr, /* src_addr */
&dest_addr, /* dest_addr */
NX_PROTOCOL_ICMP, /* protocol */
0, /* port, not used. */
0, /* port, not used. */
&data_offset, &sa, (NX_ICMP_ECHO_REPLY_TYPE << 8));
/* Do the IPSec SA rules permit this packet to be sent? */
if (ret == NX_IPSEC_TRAFFIC_PROTECT)
{
/* Yes; make sure the outgoing packet has enough space for IPsec header info. */
if ((ULONG)(packet_ptr -> nx_packet_prepend_ptr - packet_ptr -> nx_packet_data_start) <
(NX_IPv4_PACKET + data_offset))
{
/* Not enough space. Release the packet and return. */
_nx_packet_release(packet_ptr);
return;
}
/* Save the SA to the packet. */
packet_ptr -> nx_packet_ipsec_sa_ptr = sa;
}
else if (ret == NX_IPSEC_TRAFFIC_DROP || ret == NX_IPSEC_TRAFFIC_PENDING_IKEV2)
{
/* No; Drop the packet and return. */
_nx_packet_release(packet_ptr);
return;
}
else
{
/* SA rules indicate to bypass IPSec processing. Zero out the
SA information. */
packet_ptr -> nx_packet_ipsec_sa_ptr = NX_NULL;
}
}
#endif /* NX_IPSEC_ENABLE */
#ifdef NX_DISABLE_ICMPV4_TX_CHECKSUM
compute_checksum = 0;
#endif /* NX_DISABLE_ICMPV4_TX_CHECKSUM */
#ifdef NX_ENABLE_INTERFACE_CAPABILITY
if (packet_ptr -> nx_packet_address.nx_packet_interface_ptr -> nx_interface_capability_flag & NX_INTERFACE_CAPABILITY_ICMPV4_TX_CHECKSUM)
{
compute_checksum = 0;
}
#endif /* NX_ENABLE_INTERFACE_CAPABILITY */
#ifdef NX_IPSEC_ENABLE
if ((sa != NX_NULL) && (((NX_IPSEC_SA *)sa) -> nx_ipsec_sa_encryption_method != NX_CRYPTO_NONE))
{
compute_checksum = 1;
}
#endif /* NX_IPSEC_ENABLE */
#if defined(NX_DISABLE_ICMPV4_TX_CHECKSUM) || defined(NX_ENABLE_INTERFACE_CAPABILITY) || defined(NX_IPSEC_ENABLE)
if (compute_checksum)
#endif /* defined(NX_DISABLE_ICMPV4_TX_CHECKSUM) || defined(NX_ENABLE_INTERFACE_CAPABILITY) || defined(NX_IPSEC_ENABLE) */
{
/* Update the checksum, according to the RFC1624 page2, Eqn.3.
HC - old checksum in header
HC' - new checksum in header
m - old value of a 16-bit field
m' - new value of a 16-bit field
HC' = ~(C + (-m) + m')
= ~(~HC + ~m + m') */
/* Endian swapping logic. */
NX_CHANGE_USHORT_ENDIAN(header_ptr -> nx_icmpv4_header_checksum);
/* Get the old checksum (HC) in header. */
checksum = header_ptr -> nx_icmpv4_header_checksum;
/* Get the old type(m). */
old_m = (ULONG)(NX_ICMP_ECHO_REQUEST_TYPE << 8);
/* Update the checksum, get the new checksum(HC'). */
/* The m' is value of echo reply type. It is zero so can be ignored. */
checksum = ((~checksum) & 0xFFFF) + ((~old_m) & 0xFFFF);
/* Fold a 4-byte value into a two byte value */
checksum = (checksum >> 16) + (checksum & 0xFFFF);
/* Do it again in case previous operation generates an overflow */
checksum = (checksum >> 16) + (checksum & 0xFFFF);
/* Store the checksum. */
header_ptr -> nx_icmpv4_header_checksum = (~checksum & NX_LOWER_16_MASK);
/* If NX_LITTLE_ENDIAN is defined, the header need to be swapped back
for output (network byte order). */
NX_CHANGE_USHORT_ENDIAN(header_ptr -> nx_icmpv4_header_checksum);
}
#if defined(NX_DISABLE_ICMPV4_TX_CHECKSUM) || defined(NX_ENABLE_INTERFACE_CAPABILITY)
else
{
/* Clear the checksum. */
header_ptr -> nx_icmpv4_header_checksum = 0;
#ifdef NX_ENABLE_INTERFACE_CAPABILITY
packet_ptr -> nx_packet_interface_capability_flag |= NX_INTERFACE_CAPABILITY_ICMPV4_TX_CHECKSUM;
#endif /* NX_ENABLE_INTERFACE_CAPABILITY */
}
#endif
/* Figure out the best interface to send the ICMP packet on. */
_nx_ip_route_find(ip_ptr, ipv4_header -> nx_ip_header_source_ip,
&packet_ptr -> nx_packet_address.nx_packet_interface_ptr,
&next_hop_address);
/* If trace is enabled, insert this event into the trace buffer. */
NX_TRACE_IN_LINE_INSERT(NX_TRACE_INTERNAL_ICMP_RECEIVE, ip_ptr, ipv4_header -> nx_ip_header_source_ip, packet_ptr, 0, NX_TRACE_INTERNAL_EVENTS, 0, 0);
#ifndef NX_DISABLE_ICMP_INFO
/* Increment the ICMP pings responded to count. */
ip_ptr -> nx_ip_pings_responded_to++;
#endif
/* Send the ICMP packet to the IP component. */
/*lint -e{644} suppress variable might not be initialized, since "next_hop_address" was initialized in _nx_ip_route_find. */
_nx_ip_packet_send(ip_ptr, packet_ptr, ipv4_header -> nx_ip_header_source_ip,
NX_IP_NORMAL, NX_IP_TIME_TO_LIVE, NX_IP_ICMP, NX_FRAGMENT_OKAY, next_hop_address);
}
#endif /* !NX_DISABLE_IPV4 */
|
