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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
|
/***************************************************************************
* 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 */
/** */
/** Datagram Transport Layer Security (DTLS) */
/** */
/**************************************************************************/
/**************************************************************************/
#define NX_SECURE_SOURCE_CODE
#include "nx_secure_dtls.h"
#ifdef NX_SECURE_ENABLE_DTLS
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* nx_secure_dtls_session_cache_delete PORTABLE C */
/* 6.1.12 */
/* AUTHOR */
/* */
/* Timothy Stapko, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function deletes DTLS session with specific IP address and */
/* port. */
/* */
/* INPUT */
/* */
/* dtls_server DTLS server control block */
/* ip_address IP address to match */
/* remote_port Remote port to match */
/* local_port Local port to match */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* _nx_secure_dtls_session_reset Reset DTLS session */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/**************************************************************************/
VOID nx_secure_dtls_session_cache_delete(NX_SECURE_DTLS_SERVER *dtls_server, NXD_ADDRESS *ip_address, UINT remote_port, UINT local_port)
{
NX_SECURE_DTLS_SESSION *session_array;
UINT num_sessions;
UINT i;
/* Get our session cache information from the DTLS server instance. */
num_sessions = dtls_server->nx_dtls_server_sessions_count;
session_array = dtls_server->nx_dtls_server_sessions;
/* Get the protection. */
tx_mutex_get(&_nx_secure_tls_protection, TX_WAIT_FOREVER);
/* Reset all entries with matching IP address and port. */
for (i = 0; i < num_sessions; ++i)
{
/* If the IP address and port match, then reset the entry. */
if (session_array[i].nx_secure_dtls_remote_port != remote_port ||
session_array[i].nx_secure_dtls_local_port != local_port)
{
continue;
}
if (session_array[i].nx_secure_dtls_remote_ip_address.nxd_ip_version !=
ip_address -> nxd_ip_version)
{
continue;
}
#ifndef NX_DISABLE_IPV4
if (ip_address -> nxd_ip_version == NX_IP_VERSION_V4)
{
if (session_array[i].nx_secure_dtls_remote_ip_address.nxd_ip_address.v4 !=
ip_address -> nxd_ip_address.v4)
{
continue;
}
}
#endif /* !NX_DISABLE_IPV4 */
#ifdef FEATURE_NX_IPV6
if (ip_address -> nxd_ip_version == NX_IP_VERSION_V6)
{
if ((session_array[i].nx_secure_dtls_remote_ip_address.nxd_ip_address.v6[0] != ip_address -> nxd_ip_address.v6[0]) ||
(session_array[i].nx_secure_dtls_remote_ip_address.nxd_ip_address.v6[1] != ip_address -> nxd_ip_address.v6[1]) ||
(session_array[i].nx_secure_dtls_remote_ip_address.nxd_ip_address.v6[2] != ip_address -> nxd_ip_address.v6[2]) ||
(session_array[i].nx_secure_dtls_remote_ip_address.nxd_ip_address.v6[3] != ip_address -> nxd_ip_address.v6[3]))
{
continue;
}
}
#endif /* FEATURE_NX_IPV6 */
/* Release the protection. */
tx_mutex_put(&_nx_secure_tls_protection);
_nx_secure_dtls_session_reset(&session_array[i]);
/* Get the protection. */
tx_mutex_get(&_nx_secure_tls_protection, TX_WAIT_FOREVER);
}
/* Release the protection. */
tx_mutex_put(&_nx_secure_tls_protection);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* nx_secure_dtls_session_cache_get_new PORTABLE C */
/* 6.4.3 */
/* AUTHOR */
/* */
/* Timothy Stapko, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function allows the DTLS implementation to associate a DTLS */
/* session control block with a particular IP Address and Port, */
/* enabling multiple DTLS sessions on a single UDP socket. */
/* */
/* INPUT */
/* */
/* dtls_server DTLS server control block */
/* dtls_session Returned DTLS session */
/* ip_address IP address */
/* remote_port Remote port */
/* local_port Local port */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* _nx_secure_dtls_receive_callback DTLS receive callback function*/
/* */
/**************************************************************************/
UINT nx_secure_dtls_session_cache_get_new(NX_SECURE_DTLS_SERVER *dtls_server, NX_SECURE_DTLS_SESSION **dtls_session, NXD_ADDRESS *ip_address, UINT remote_port, UINT local_port)
{
NX_SECURE_DTLS_SESSION *session_array;
UINT num_sessions;
UINT i;
/* Get our session cache information from the DTLS server instance. */
num_sessions = dtls_server->nx_dtls_server_sessions_count;
session_array = dtls_server->nx_dtls_server_sessions;
/* Get the protection. */
tx_mutex_get(&_nx_secure_tls_protection, TX_WAIT_FOREVER);
/* See if there are any free entries. */
for (i = 0; i < num_sessions; ++i)
{
/* See if there is a session available. */
if (session_array[i].nx_secure_dtls_session_in_use == NX_FALSE)
{
/* Set the IP and port to the passed-in values. */
NX_SECURE_MEMCPY(&session_array[i].nx_secure_dtls_remote_ip_address, ip_address, sizeof(NXD_ADDRESS)); /* Use case of memcpy is verified. */
session_array[i].nx_secure_dtls_local_port = local_port;
session_array[i].nx_secure_dtls_remote_port = remote_port;
session_array[i].nx_secure_dtls_session_in_use = NX_TRUE;
/* Check if ptotocol version is overrided. */
if (dtls_server -> nx_dtls_server_protocol_version_override)
{
_nx_secure_tls_session_protocol_version_override(&(session_array[i].nx_secure_dtls_tls_session), dtls_server -> nx_dtls_server_protocol_version_override);
}
/* Release the protection. */
tx_mutex_put(&_nx_secure_tls_protection);
/* Return the session. */
*dtls_session = &session_array[i];
return(NX_SUCCESS);
}
}
/* Release the protection. */
tx_mutex_put(&_nx_secure_tls_protection);
/* No session found, return NULL and an error. */
*dtls_session = NULL;
return(NX_SECURE_TLS_NO_FREE_DTLS_SESSIONS);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* nx_secure_dtls_session_cache_find PORTABLE C */
/* 6.1.12 */
/* AUTHOR */
/* */
/* Timothy Stapko, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function allows the DTLS implementation to associate a DTLS */
/* session control block with a particular IP Address and Port, */
/* enabling multiple DTLS sessions on a single UDP socket. */
/* */
/* INPUT */
/* */
/* dtls_server DTLS server control block */
/* dtls_session Returned DTLS session */
/* ip_address IP address to match */
/* remote_port Remote port to match */
/* local_port Local port to match */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* _nx_secure_dtls_receive_callback DTLS receive callback function*/
/* */
/**************************************************************************/
UINT nx_secure_dtls_session_cache_find(NX_SECURE_DTLS_SERVER *dtls_server, NX_SECURE_DTLS_SESSION **dtls_session, NXD_ADDRESS *ip_address, UINT remote_port, UINT local_port)
{
NX_SECURE_DTLS_SESSION *session_array;
UINT num_sessions;
UINT i;
/* Get our session cache information from the DTLS server instance. */
num_sessions = dtls_server->nx_dtls_server_sessions_count;
session_array = dtls_server->nx_dtls_server_sessions;
/* Get the protection. */
tx_mutex_get(&_nx_secure_tls_protection, TX_WAIT_FOREVER);
/* See if there are any matches. */
for (i = 0; i < num_sessions; ++i)
{
/* Check remote port. */
if (session_array[i].nx_secure_dtls_remote_port != remote_port)
{
continue;
}
/* Check local port. */
if (session_array[i].nx_secure_dtls_local_port != local_port)
{
continue;
}
/* Check remote IP address version. */
if (session_array[i].nx_secure_dtls_remote_ip_address.nxd_ip_version !=
ip_address -> nxd_ip_version)
{
continue;
}
/* Check actual remote IP address value. */
#ifndef NX_DISABLE_IPV4
if (ip_address -> nxd_ip_version == NX_IP_VERSION_V4)
{
if (session_array[i].nx_secure_dtls_remote_ip_address.nxd_ip_address.v4 ==
ip_address -> nxd_ip_address.v4)
{
/* Release the protection. */
tx_mutex_put(&_nx_secure_tls_protection);
/* Return the session. */
*dtls_session = &session_array[i];
return(NX_SUCCESS);
}
}
#endif /* !NX_DISABLE_IPV4 */
#ifdef FEATURE_NX_IPV6
if (ip_address -> nxd_ip_version == NX_IP_VERSION_V6)
{
if ((session_array[i].nx_secure_dtls_remote_ip_address.nxd_ip_address.v6[0] == ip_address -> nxd_ip_address.v6[0]) &&
(session_array[i].nx_secure_dtls_remote_ip_address.nxd_ip_address.v6[1] == ip_address -> nxd_ip_address.v6[1]) &&
(session_array[i].nx_secure_dtls_remote_ip_address.nxd_ip_address.v6[2] == ip_address -> nxd_ip_address.v6[2]) &&
(session_array[i].nx_secure_dtls_remote_ip_address.nxd_ip_address.v6[3] == ip_address -> nxd_ip_address.v6[3]))
{
/* Release the protection. */
tx_mutex_put(&_nx_secure_tls_protection);
/* Return the session. */
*dtls_session = &session_array[i];
return(NX_SUCCESS);
}
}
#endif /* FEATURE_NX_IPV6 */
}
/* Release the protection. */
tx_mutex_put(&_nx_secure_tls_protection);
/* No session found, return NULL and an error. */
*dtls_session = NULL;
return(NX_SECURE_DTLS_SESSION_NOT_FOUND);
}
#endif /* NX_SECURE_ENABLE_DTLS */
|
