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
|
/***************************************************************************
* 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) - Generate Session Keys */
/** */
/**************************************************************************/
/**************************************************************************/
#define NX_SECURE_SOURCE_CODE
#include "nx_secure_tls.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_secure_tls_1_3_session_keys_set PORTABLE C */
/* 6.4.3 */
/* AUTHOR */
/* */
/* Timothy Stapko, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function sets the session keys for a TLS 1.3 session when */
/* the keys are needed. The TLS 1.3 handshake is encrypted so we have */
/* to switch over the client and server keys separately. */
/* */
/* Once the keys are set, this function initializes the appropriate */
/* session cipher with the new key set. */
/* */
/* INPUT */
/* */
/* tls_session TLS control block */
/* key_set Remote or local keys */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* [nx_crypto_init] Initialize crypto */
/* */
/* CALLED BY */
/* */
/* _nx_secure_dtls_client_handshake DTLS client state machine */
/* _nx_secure_dtls_server_handshake DTLS server state machine */
/* _nx_secure_tls_client_handshake TLS client state machine */
/* _nx_secure_tls_server_handshake TLS server state machine */
/* _nx_secure_tls_process_changecipherspec */
/* Process ChangeCipherSpec */
/* */
/**************************************************************************/
#define NX_SECURE_SOURCE_CODE
#if (NX_SECURE_TLS_TLS_1_3_ENABLED)
UINT _nx_secure_tls_1_3_session_keys_set(NX_SECURE_TLS_SESSION *tls_session, USHORT key_set)
{
UINT key_size;
UINT iv_size;
UINT status;
UINT is_client;
const NX_CRYPTO_METHOD *session_cipher_method = NX_NULL;
/* The key material should have already been generated by nx_secure_tls_1_3_generate_keys once all
* key generation data was available. This simply switches the appropriate key data over to the active
* key set. */
if (key_set == NX_SECURE_TLS_KEY_SET_LOCAL)
{
tls_session -> nx_secure_tls_local_session_active = 1;
/* Reset the sequence number now that we are switching to new keys. */
NX_SECURE_MEMSET(tls_session -> nx_secure_tls_local_sequence_number, 0, sizeof(tls_session -> nx_secure_tls_local_sequence_number));
}
else
{
tls_session -> nx_secure_tls_remote_session_active = 1;
/* Reset the sequence number now that we are switching to new keys. */
NX_SECURE_MEMSET(tls_session -> nx_secure_tls_remote_sequence_number, 0, sizeof(tls_session -> nx_secure_tls_remote_sequence_number));
}
/* See if we are setting server or client keys. */
if ((key_set == NX_SECURE_TLS_KEY_SET_REMOTE && tls_session -> nx_secure_tls_socket_type == NX_SECURE_TLS_SESSION_TYPE_CLIENT) ||
(key_set == NX_SECURE_TLS_KEY_SET_LOCAL && tls_session -> nx_secure_tls_socket_type == NX_SECURE_TLS_SESSION_TYPE_SERVER))
{
/* Setting remote keys for a client or local keys for a server: we are setting server keys. */
is_client = NX_FALSE;
}
else
{
/* Local client/local keys or local server/remote keys. */
is_client = NX_TRUE;
}
if (tls_session -> nx_secure_tls_session_ciphersuite == NX_NULL)
{
/* Likely internal error since at this point ciphersuite negotiation was theoretically completed. */
return(NX_SECURE_TLS_UNKNOWN_CIPHERSUITE);
}
/* Get our session cipher method so we can get key sizes. */
session_cipher_method = tls_session -> nx_secure_tls_session_ciphersuite -> nx_secure_tls_session_cipher;
key_size = session_cipher_method -> nx_crypto_key_size_in_bits >> 3;
/* IV size for AES-128-GCM is 12 bytes. */
iv_size = 12; //session_cipher_method -> nx_crypto_IV_size_in_bits >> 3;
/* Copy over the keys. Check for non-zero size in the event we are using a NULL cipher (usually for debugging). */
if (key_size > 0)
{
/* Copy new client session key if setting client keys. */
if (is_client)
{
NX_SECURE_MEMCPY(tls_session -> nx_secure_tls_key_material.nx_secure_tls_client_write_key,
tls_session -> nx_secure_tls_key_material.nx_secure_tls_client_next_write_key, key_size); /* Use case of memcpy is verified. */
}
else
{
NX_SECURE_MEMCPY(tls_session -> nx_secure_tls_key_material.nx_secure_tls_server_write_key,
tls_session -> nx_secure_tls_key_material.nx_secure_tls_server_next_write_key, key_size); /* Use case of memcpy is verified. */
}
}
/* Finally, the IVs. Some ciphers don't use IV's so the iv_size may be zero. */
if (iv_size > 0)
{
/* Copy new client IV if setting client keys. */
if (is_client)
{
NX_SECURE_MEMCPY(tls_session -> nx_secure_tls_key_material.nx_secure_tls_client_iv,
tls_session -> nx_secure_tls_key_material.nx_secure_tls_client_next_iv, iv_size); /* Use case of memcpy is verified. */
}
else
{
NX_SECURE_MEMCPY(tls_session -> nx_secure_tls_key_material.nx_secure_tls_server_iv,
tls_session -> nx_secure_tls_key_material.nx_secure_tls_server_next_iv, iv_size); /* Use case of memcpy is verified. */
}
}
/* Initialize the crypto method used in the session cipher. */
if (session_cipher_method -> nx_crypto_init != NULL)
{
/* Set client write key. */
if (is_client)
{
if (tls_session -> nx_secure_tls_session_cipher_client_initialized && session_cipher_method -> nx_crypto_cleanup)
{
status = session_cipher_method -> nx_crypto_cleanup(tls_session -> nx_secure_session_cipher_metadata_area_client);
if (status != NX_CRYPTO_SUCCESS)
{
return(status);
}
tls_session -> nx_secure_tls_session_cipher_client_initialized = 0;
}
status = session_cipher_method -> nx_crypto_init((NX_CRYPTO_METHOD*)session_cipher_method,
tls_session -> nx_secure_tls_key_material.nx_secure_tls_client_write_key,
session_cipher_method -> nx_crypto_key_size_in_bits,
&tls_session -> nx_secure_session_cipher_handler_client,
tls_session -> nx_secure_session_cipher_metadata_area_client,
tls_session -> nx_secure_session_cipher_metadata_size);
tls_session -> nx_secure_tls_session_cipher_client_initialized = 1;
}
else
{
if (tls_session -> nx_secure_tls_session_cipher_server_initialized && session_cipher_method -> nx_crypto_cleanup)
{
status = session_cipher_method -> nx_crypto_cleanup(tls_session -> nx_secure_session_cipher_metadata_area_server);
if (status != NX_CRYPTO_SUCCESS)
{
return(status);
}
tls_session -> nx_secure_tls_session_cipher_server_initialized = 0;
}
/* Set server write key. */
status = session_cipher_method -> nx_crypto_init((NX_CRYPTO_METHOD*)session_cipher_method,
tls_session -> nx_secure_tls_key_material.nx_secure_tls_server_write_key,
session_cipher_method -> nx_crypto_key_size_in_bits,
&tls_session -> nx_secure_session_cipher_handler_server,
tls_session -> nx_secure_session_cipher_metadata_area_server,
tls_session -> nx_secure_session_cipher_metadata_size);
tls_session -> nx_secure_tls_session_cipher_server_initialized = 1;
}
if (status != NX_CRYPTO_SUCCESS)
{
return(status);
}
}
return(NX_SECURE_TLS_SUCCESS);
}
#endif
|
