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
|
/***************************************************************************
* 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"
static UCHAR generated_hash[NX_SECURE_TLS_MAX_HASH_SIZE];
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_secure_tls_process_finished PORTABLE C */
/* 6.4.3 */
/* AUTHOR */
/* */
/* Timothy Stapko, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function processes an incoming Finished message by generating */
/* a hash of the received handshake messages (up to this point) and */
/* comparing the result to the hash received from the remote host. */
/* If the generated hash and the received hash do not match, it */
/* indicates that the handshake messages were corrupted in some way. */
/* */
/* INPUT */
/* */
/* tls_session TLS control block */
/* packet_buffer Pointer to received data */
/* message_length Length of received data */
/* */
/* OUTPUT */
/* */
/* status Result of hash comparison */
/* */
/* CALLS */
/* */
/* _nx_secure_tls_finished_hash_generate Generate Finished hash */
/* */
/* 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 */
/* */
/**************************************************************************/
UINT _nx_secure_tls_process_finished(NX_SECURE_TLS_SESSION *tls_session, UCHAR *packet_buffer,
UINT message_length)
{
UCHAR *finished_label;
UINT compare_result, status;
#if (NX_SECURE_TLS_TLS_1_3_ENABLED)
UINT hash_size = 0;
UINT is_server;
#endif
#if (NX_SECURE_TLS_TLS_1_3_ENABLED)
/* Make sure the length is what we expect. */
if(tls_session -> nx_secure_tls_1_3)
{
/* TLS 1.3 Finished messages are different from earlier versions
and require specific processing. */
/* Check if the Finished is from server. */
is_server = (tls_session -> nx_secure_tls_socket_type == NX_SECURE_TLS_SESSION_TYPE_CLIENT);
/* Verify Finished hash. */
status = _nx_secure_tls_1_3_finished_hash_generate(tls_session, is_server, &hash_size, generated_hash, sizeof(generated_hash));
if ((hash_size > message_length) || (hash_size > sizeof(generated_hash)))
{
/* Size error. */
compare_result = 1;
}
else
{
/* Compare to see if the Finished hash matches the received hash. */
compare_result = (UINT)NX_SECURE_MEMCMP(generated_hash, packet_buffer, hash_size);
}
#ifdef NX_SECURE_KEY_CLEAR
NX_SECURE_MEMSET(generated_hash, 0, sizeof(generated_hash));
#endif /* NX_SECURE_KEY_CLEAR */
}
else
#endif
{
/* TLS 1.2 and earlier use the same Finished hash construction. */
if (message_length != NX_SECURE_TLS_FINISHED_HASH_SIZE)
{
return(NX_SECURE_TLS_INCORRECT_MESSAGE_LENGTH);
}
/* If we received a Finished message but the session is not active, error! */
if (!tls_session -> nx_secure_tls_remote_session_active)
{
return(NX_SECURE_TLS_UNEXPECTED_MESSAGE);
}
/* If we have not received credentials from the remote host, we
cannot validate the handshake under any circumstances. */
if (!tls_session -> nx_secure_tls_received_remote_credentials)
{
return(NX_SECURE_TLS_HANDSHAKE_FAILURE);
}
/* Select our label for generating the finished hash expansion - we are comparing against
the remote hosts hash, so use the opposite label. */
if (tls_session -> nx_secure_tls_socket_type == NX_SECURE_TLS_SESSION_TYPE_SERVER)
{
finished_label = (UCHAR *)"client finished";
}
else
{
finished_label = (UCHAR *)"server finished";
}
/* Finally, generate the verification data required by TLS - 12 bytes using the PRF and the data
we have collected. */
status = _nx_secure_tls_finished_hash_generate(tls_session, finished_label, generated_hash);
if(status != NX_SUCCESS)
{
return(status);
}
#ifndef NX_SECURE_TLS_DISABLE_SECURE_RENEGOTIATION
/* If we are doing secure renegotiation as per RFC 5746, we need to save off the generated
verify data now. For TLS 1.0-1.2 this is 12 bytes. If SSLv3 is ever used, it will be 36 bytes. */
NX_SECURE_MEMCPY(tls_session -> nx_secure_tls_remote_verify_data, generated_hash, NX_SECURE_TLS_FINISHED_HASH_SIZE); /* Use case of memcpy is verified. lgtm[cpp/banned-api-usage-required-any] */
#endif /* NX_SECURE_TLS_DISABLE_SECURE_RENEGOTIATION */
/* The finished verify data is always 12 bytes (*except for SSLv3) - compare to see if the Finished hash matches the received hash. */
compare_result = (UINT)NX_SECURE_MEMCMP(generated_hash, packet_buffer, NX_SECURE_TLS_FINISHED_HASH_SIZE);
}
if (compare_result != 0)
{
return(NX_SECURE_TLS_FINISHED_HASH_FAILURE);
}
/* If the comparison was OK, set the state appropriately. */
#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;
}
#endif
#ifndef NX_SECURE_DISABLE_X509
/* Now that we are done with the handshake, free all remote certificates - we don't need them anymore. */
status = _nx_secure_tls_remote_certificate_free_all(tls_session);
if (status != NX_SUCCESS)
{
return(status);
}
#endif
return(NX_SECURE_TLS_SUCCESS);
}
|
