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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
|
/***************************************************************************
* 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 Secure Component */
/** */
/** Transport Layer Security (TLS) */
/** */
/**************************************************************************/
/**************************************************************************/
#define NX_SECURE_SOURCE_CODE
#include "nx_secure_tls.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_secure_tls_session_receive_records PORTABLE C */
/* 6.4.3 */
/* AUTHOR */
/* */
/* Timothy Stapko, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function receives data from the TCP socket and handles TLS */
/* record processing. It's purpose is to avoid recursion in the */
/* higher-level nx_secure_tls_session_receive service. */
/* */
/* INPUT */
/* */
/* tls_session TLS control block */
/* packet_ptr_ptr Pointer to return packet */
/* wait_option Indicates how long the caller */
/* should wait for the response */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* _nx_secure_tls_map_error_to_alert Map internal error to alert */
/* _nx_secure_tls_packet_allocate Allocate internal TLS packet */
/* _nx_secure_tls_process_record Process TLS record data */
/* _nx_secure_tls_send_alert Send TLS alert */
/* _nx_secure_tls_send_record Send the TLS record */
/* nx_secure_tls_packet_release Release packet */
/* nx_tcp_socket_receive Receive TCP data */
/* tx_mutex_get Get protection mutex */
/* tx_mutex_put Put protection mutex */
/* */
/* CALLED BY */
/* */
/* _nx_secure_tls_handshake_process Process TLS handshake */
/* _nx_secure_tls_session_receive Receive TCP data */
/* _nx_secure_tls_session_renegotiate Renegotiate TLS session */
/* */
/**************************************************************************/
UINT _nx_secure_tls_session_receive_records(NX_SECURE_TLS_SESSION *tls_session,
NX_PACKET **packet_ptr_ptr, ULONG wait_option)
{
UINT status;
NX_PACKET *packet_ptr;
NX_TCP_SOCKET *tcp_socket;
ULONG bytes_processed = 0;
ULONG packet_fragment_length;
NX_PACKET *send_packet = NX_NULL;
UINT error_number;
UINT alert_number;
UINT alert_level;
NX_PACKET *current_packet;
NX_PACKET *previous_packet;
UCHAR handshake_finished = NX_FALSE;
/* Get the protection. */
tx_mutex_get(&_nx_secure_tls_protection, TX_WAIT_FOREVER);
/* Access the internal TCP socket handle in our TLS socket. */
tcp_socket = tls_session -> nx_secure_tls_tcp_socket;
/* Session receive logic:
* 1. Receive incoming packets
* 2. Process records and receive while full record is not yet received.
* 3. If renegotiation inititated, process the renegotiation handshake.
* 3a. Process entire handshake (receive TCP packets, process records)
* 3b. Once handshake processed, receive any new packets, but only if
* the remote host initiated the renegotiation.
*/
status = NX_CONTINUE;
if (tls_session -> nx_secure_record_queue_header)
{
/* Process all records in the packet we received - decrypt, authenticate, and
* strip TLS record header/footer, placing data in the return packet.
*/
status = _nx_secure_tls_process_record(tls_session, NX_NULL, &bytes_processed, wait_option);
}
while (status == NX_CONTINUE)
{
/* Release the protection before suspending on nx_tcp_socket_receive. */
tx_mutex_put(&_nx_secure_tls_protection);
/* Receive a packet over the TCP connection. */
status = nx_tcp_socket_receive(tcp_socket, &packet_ptr, wait_option);
if (status != NX_SUCCESS)
{
return(status);
}
/* Get the protection after nx_tcp_socket_receive. */
tx_mutex_get(&_nx_secure_tls_protection, TX_WAIT_FOREVER);
/* Process all records in the packet we received - decrypt, authenticate, and
* strip TLS record header/footer, placing data in the return packet.
*/
status = _nx_secure_tls_process_record(tls_session, packet_ptr, &bytes_processed, wait_option);
}
/* Cleanup if the record processing was successful or if we have a renegotiation attempt. */
if (status == NX_SUCCESS
#if (NX_SECURE_TLS_TLS_1_3_ENABLED)
|| status == NX_SECURE_TLS_POST_HANDSHAKE_RECEIVED
#endif /* (NX_SECURE_TLS_TLS_1_3_ENABLED) */
)
{
/* Remove processed packets. Data in released packet will be cleared by nx_secure_tls_packet_release. */
tls_session -> nx_secure_record_queue_header -> nx_packet_length -= bytes_processed;
current_packet = tls_session -> nx_secure_record_queue_header;
previous_packet = NX_NULL;
while (current_packet)
{
packet_fragment_length = (ULONG)(current_packet -> nx_packet_append_ptr) - (ULONG)(current_packet -> nx_packet_prepend_ptr);
/* Determine if all data in the current fragment have been processed. */
if (packet_fragment_length <= bytes_processed)
{
bytes_processed -= packet_fragment_length;
}
else
{
current_packet -> nx_packet_prepend_ptr += bytes_processed;
bytes_processed = 0;
break;
}
previous_packet = current_packet;
current_packet = current_packet -> nx_packet_next;
}
if (!current_packet)
{
nx_secure_tls_packet_release(tls_session -> nx_secure_record_queue_header);
tls_session -> nx_secure_record_queue_header = NX_NULL;
}
else if (previous_packet)
{
/* Release trimmed packets. */
/* Packets from tls_session -> nx_secure_record_queue_header till previous_packet can be trimmed. */
previous_packet -> nx_packet_next = NX_NULL;
/* Update the length and last packet of remaining packets. */
current_packet -> nx_packet_length = tls_session -> nx_secure_record_queue_header -> nx_packet_length;
current_packet -> nx_packet_last = tls_session -> nx_secure_record_queue_header -> nx_packet_last;
/* Correct the last packet to be trimmed. */
tls_session -> nx_secure_record_queue_header -> nx_packet_last = previous_packet;
nx_secure_tls_packet_release(tls_session -> nx_secure_record_queue_header);
/* Update the remaining packets. */
tls_session -> nx_secure_record_queue_header = current_packet;
}
if (bytes_processed)
{
/* Release the protection. */
tx_mutex_put(&_nx_secure_tls_protection);
return(NX_SECURE_TLS_INVALID_PACKET);
}
#ifndef NX_SECURE_TLS_CLIENT_DISABLED
if ((tls_session -> nx_secure_tls_socket_type == NX_SECURE_TLS_SESSION_TYPE_CLIENT) &&
(tls_session -> nx_secure_tls_client_state == NX_SECURE_TLS_CLIENT_STATE_HANDSHAKE_FINISHED))
{
handshake_finished = NX_TRUE;
}
#endif /* NX_SECURE_TLS_CLIENT_DISABLED */
#ifndef NX_SECURE_TLS_SERVER_DISABLED
if ((tls_session -> nx_secure_tls_socket_type == NX_SECURE_TLS_SESSION_TYPE_SERVER) &&
(tls_session -> nx_secure_tls_server_state == NX_SECURE_TLS_SERVER_STATE_HANDSHAKE_FINISHED))
{
handshake_finished = NX_TRUE;
}
#endif /* NX_SECURE_TLS_CLIENT_DISABLED */
if (handshake_finished
#if (NX_SECURE_TLS_TLS_1_3_ENABLED)
&& status != NX_SECURE_TLS_POST_HANDSHAKE_RECEIVED
#endif /* (NX_SECURE_TLS_TLS_1_3_ENABLED) */
)
{
if (tls_session -> nx_secure_record_decrypted_packet == NX_NULL)
{
/* Release the protection. */
tx_mutex_put(&_nx_secure_tls_protection);
return(NX_SECURE_TLS_INVALID_PACKET);
}
*packet_ptr_ptr = tls_session -> nx_secure_record_decrypted_packet;
tls_session -> nx_secure_record_decrypted_packet = NX_NULL;
}
}
else
{
/* Error status, send alert back to remote host. */
/* Get our alert number and level from our status. */
error_number = status;
_nx_secure_tls_map_error_to_alert(error_number, &alert_number, &alert_level);
#ifndef NX_SECURE_TLS_SERVER_DISABLED
if (tls_session -> nx_secure_tls_socket_type == NX_SECURE_TLS_SESSION_TYPE_SERVER)
{
tls_session -> nx_secure_tls_server_state = NX_SECURE_TLS_SERVER_STATE_ERROR;
}
#endif
#ifndef NX_SECURE_TLS_CLIENT_DISABLED
if (tls_session -> nx_secure_tls_socket_type == NX_SECURE_TLS_SESSION_TYPE_CLIENT)
{
tls_session -> nx_secure_tls_client_state = NX_SECURE_TLS_CLIENT_STATE_ERROR;
}
#endif
/* If the error was an alert from the remote host, don't do anything. Otherwise, we need
to send an alert of our own. */
if (error_number != NX_SECURE_TLS_ALERT_RECEIVED)
{
/* Release the protection before suspending on nx_packet_allocate. */
tx_mutex_put(&_nx_secure_tls_protection);
status = _nx_secure_tls_packet_allocate(tls_session, tls_session -> nx_secure_tls_packet_pool, &send_packet, wait_option);
/* Get the protection after nx_packet_allocate. */
tx_mutex_get(&_nx_secure_tls_protection, TX_WAIT_FOREVER);
if (status == NX_SUCCESS)
{
_nx_secure_tls_send_alert(tls_session, send_packet, (UCHAR)alert_number, (UCHAR)alert_level);
status = _nx_secure_tls_send_record(tls_session, send_packet, NX_SECURE_TLS_ALERT, wait_option);
/* If we didn't send the alert successfully, we need to release the packet. */
if (status != NX_SUCCESS)
{
nx_secure_tls_packet_release(send_packet);
}
}
/* Make sure we clear keys whenever we enter an error state. Note that if a Fatal alert
was received, the session was reset at that point. */
_nx_secure_tls_session_reset(tls_session);
}
status = error_number;
}
tx_mutex_put(&_nx_secure_tls_protection);
return(status);
}
|
