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
|
/***************************************************************************
* 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) */
/** */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/* */
/* APPLICATION INTERFACE DEFINITION RELEASE */
/* */
/* nx_secure_tls_api.h PORTABLE C */
/* 6.4.3 */
/* AUTHOR */
/* */
/* Timothy Stapko, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This file defines the basic Application Interface (API) to the */
/* high-performance TLS implementation for the NetXDuo TCP/IP */
/* protocol. */
/* */
/**************************************************************************/
#ifndef SRC_NX_SECURE_TLS_API_H_
#define SRC_NX_SECURE_TLS_API_H_
/* Determine if a C++ compiler is being used. If so, ensure that standard
C is used to process the API information. */
#ifdef __cplusplus
/* Yes, C++ compiler is present. Use standard C. */
extern "C" {
#endif
/* Include the ThreadX and port-specific data type file. */
#include "tx_api.h"
#include "nx_port.h"
#include "nx_api.h"
#include "nx_secure_tls.h"
#ifndef NX_SECURE_SOURCE_CODE
#ifdef NX_SECURE_DISABLE_ERROR_CHECKING
#define nx_secure_tls_active_certificate_set _nx_secure_tls_active_certificate_set
#define nx_secure_tls_initialize _nx_secure_tls_initialize
#define nx_secure_tls_shutdown _nx_secure_tls_shutdown
#define nx_secure_tls_local_certificate_add _nx_secure_tls_local_certificate_add
#define nx_secure_tls_local_certificate_find _nx_secure_tls_local_certificate_find
#define nx_secure_tls_local_certificate_remove _nx_secure_tls_local_certificate_remove
#define nx_secure_tls_metadata_size_calculate _nx_secure_tls_metadata_size_calculate
#define nx_secure_tls_remote_certificate_allocate _nx_secure_tls_remote_certificate_allocate
#define nx_secure_tls_remote_certificate_buffer_allocate _nx_secure_tls_remote_certificate_buffer_allocate
#define nx_secure_tls_remote_certificate_free_all _nx_secure_tls_remote_certificate_free_all
#define nx_secure_tls_server_certificate_add _nx_secure_tls_server_certificate_add
#define nx_secure_tls_server_certificate_find _nx_secure_tls_server_certificate_find
#define nx_secure_tls_server_certificate_remove _nx_secure_tls_server_certificate_remove
#define nx_secure_tls_session_alert_value_get _nx_secure_tls_session_alert_value_get
#define nx_secure_tls_session_certificate_callback_set _nx_secure_tls_session_certificate_callback_set
#define nx_secure_tls_session_client_callback_set _nx_secure_tls_session_client_callback_set
#define nx_secure_tls_session_client_verify_disable _nx_secure_tls_session_client_verify_disable
#define nx_secure_tls_session_client_verify_enable _nx_secure_tls_session_client_verify_enable
#define nx_secure_tls_session_x509_client_verify_configure _nx_secure_tls_session_x509_client_verify_configure
#define nx_secure_tls_session_create _nx_secure_tls_session_create
#define nx_secure_tls_session_delete _nx_secure_tls_session_delete
#define nx_secure_tls_session_end _nx_secure_tls_session_end
#define nx_secure_tls_session_packet_buffer_set _nx_secure_tls_session_packet_buffer_set
#define nx_secure_tls_session_packet_pool_set _nx_secure_tls_session_packet_pool_set
#define nx_secure_tls_session_protocol_version_override _nx_secure_tls_session_protocol_version_override
#define nx_secure_tls_session_receive _nx_secure_tls_session_receive
#define nx_secure_tls_session_renegotiate _nx_secure_tls_session_renegotiate
#define nx_secure_tls_session_renegotiate_callback_set _nx_secure_tls_session_renegotiate_callback_set
#define nx_secure_tls_session_reset _nx_secure_tls_session_reset
#define nx_secure_tls_session_send _nx_secure_tls_session_send
#define nx_secure_tls_session_server_callback_set _nx_secure_tls_session_server_callback_set
#define nx_secure_tls_session_sni_extension_parse _nx_secure_tls_session_sni_extension_parse
#define nx_secure_tls_session_sni_extension_set _nx_secure_tls_session_sni_extension_set
#define nx_secure_tls_session_start _nx_secure_tls_session_start
#define nx_secure_tls_session_time_function_set _nx_secure_tls_session_time_function_set
#define nx_secure_tls_trusted_certificate_add _nx_secure_tls_trusted_certificate_add
#define nx_secure_tls_trusted_certificate_remove _nx_secure_tls_trusted_certificate_remove
#define nx_secure_tls_packet_allocate _nx_secure_tls_packet_allocate
#if defined(NX_SECURE_ENABLE_PSK_CIPHERSUITES) || defined(NX_SECURE_ENABLE_ECJPAKE_CIPHERSUITE)
#define nx_secure_tls_client_psk_set _nx_secure_tls_client_psk_set
#define nx_secure_tls_psk_add _nx_secure_tls_psk_add
#endif /* defined(NX_SECURE_ENABLE_PSK_CIPHERSUITES) || defined(NX_SECURE_ENABLE_ECJPAKE_CIPHERSUITE) */
#else /* !NX_SEURE_DISABLE_ERROR_CHECKING */
#define nx_secure_tls_active_certificate_set _nxe_secure_tls_active_certificate_set
#define nx_secure_tls_initialize _nx_secure_tls_initialize
#define nx_secure_tls_shutdown _nx_secure_tls_shutdown
#define nx_secure_tls_local_certificate_add _nxe_secure_tls_local_certificate_add
#define nx_secure_tls_local_certificate_find _nxe_secure_tls_local_certificate_find
#define nx_secure_tls_local_certificate_remove _nxe_secure_tls_local_certificate_remove
#define nx_secure_tls_metadata_size_calculate _nxe_secure_tls_metadata_size_calculate
#define nx_secure_tls_remote_certificate_allocate _nxe_secure_tls_remote_certificate_allocate
#define nx_secure_tls_remote_certificate_buffer_allocate _nxe_secure_tls_remote_certificate_buffer_allocate
#define nx_secure_tls_remote_certificate_free_all _nxe_secure_tls_remote_certificate_free_all
#define nx_secure_tls_server_certificate_add _nxe_secure_tls_server_certificate_add
#define nx_secure_tls_server_certificate_find _nxe_secure_tls_server_certificate_find
#define nx_secure_tls_server_certificate_remove _nxe_secure_tls_server_certificate_remove
#define nx_secure_tls_session_alert_value_get _nxe_secure_tls_session_alert_value_get
#define nx_secure_tls_session_certificate_callback_set _nxe_secure_tls_session_certificate_callback_set
#define nx_secure_tls_session_client_callback_set _nxe_secure_tls_session_client_callback_set
#define nx_secure_tls_session_client_verify_disable _nxe_secure_tls_session_client_verify_disable
#define nx_secure_tls_session_client_verify_enable _nxe_secure_tls_session_client_verify_enable
#define nx_secure_tls_session_x509_client_verify_configure _nxe_secure_tls_session_x509_client_verify_configure
#define nx_secure_tls_session_create _nxe_secure_tls_session_create
#define nx_secure_tls_session_delete _nxe_secure_tls_session_delete
#define nx_secure_tls_session_end _nxe_secure_tls_session_end
#define nx_secure_tls_session_packet_buffer_set _nxe_secure_tls_session_packet_buffer_set
#define nx_secure_tls_session_packet_pool_set _nxe_secure_tls_session_packet_pool_set
#define nx_secure_tls_session_protocol_version_override _nxe_secure_tls_session_protocol_version_override
#define nx_secure_tls_session_receive _nxe_secure_tls_session_receive
#define nx_secure_tls_session_renegotiate _nxe_secure_tls_session_renegotiate
#define nx_secure_tls_session_renegotiate_callback_set _nxe_secure_tls_session_renegotiate_callback_set
#define nx_secure_tls_session_reset _nxe_secure_tls_session_reset
#define nx_secure_tls_session_send _nxe_secure_tls_session_send
#define nx_secure_tls_session_server_callback_set _nxe_secure_tls_session_server_callback_set
#define nx_secure_tls_session_sni_extension_parse _nxe_secure_tls_session_sni_extension_parse
#define nx_secure_tls_session_sni_extension_set _nxe_secure_tls_session_sni_extension_set
#define nx_secure_tls_session_start _nxe_secure_tls_session_start
#define nx_secure_tls_session_time_function_set _nxe_secure_tls_session_time_function_set
#define nx_secure_tls_trusted_certificate_add _nxe_secure_tls_trusted_certificate_add
#define nx_secure_tls_trusted_certificate_remove _nxe_secure_tls_trusted_certificate_remove
#define nx_secure_tls_packet_allocate _nxe_secure_tls_packet_allocate
#if defined(NX_SECURE_ENABLE_PSK_CIPHERSUITES) || defined(NX_SECURE_ENABLE_ECJPAKE_CIPHERSUITE)
#define nx_secure_tls_client_psk_set _nxe_secure_tls_client_psk_set
#define nx_secure_tls_psk_add _nxe_secure_tls_psk_add
#endif /* defined(NX_SECURE_ENABLE_PSK_CIPHERSUITES) || defined(NX_SECURE_ENABLE_ECJPAKE_CIPHERSUITE) */
#endif /* NX_SECURE_DISABLE_ERROR_CHECKING */
#define nx_secure_crypto_table_self_test _nx_secure_crypto_table_self_test
#define nx_secure_crypto_rng_self_test _nx_secure_crypto_rng_self_test
#ifdef NX_SECURE_ENABLE_ECC_CIPHERSUITE
#define nx_secure_tls_ecc_initialize _nx_secure_tls_ecc_initialize
#endif /* NX_SECURE_ENABLE_ECC_CIPHERSUITE */
UINT nx_secure_crypto_table_self_test(const NX_SECURE_TLS_CRYPTO *crypto_table,
VOID *metadata, UINT metadata_size);
UINT nx_secure_crypto_rng_self_test();
UINT nx_secure_module_hash_compute(NX_CRYPTO_METHOD *hmac_ptr,
UINT start_address,
UINT end_address,
UCHAR *key, UINT key_length,
VOID *metadata, UINT metadata_size,
UCHAR *output_buffer, UINT output_buffer_size, UINT *actual_size);
UINT nx_secure_tls_active_certificate_set(NX_SECURE_TLS_SESSION *tls_session,
NX_SECURE_X509_CERT *certificate);
VOID nx_secure_tls_initialize(VOID);
UINT nx_secure_tls_shutdown(VOID);
UINT nx_secure_tls_local_certificate_add(NX_SECURE_TLS_SESSION *tls_session,
NX_SECURE_X509_CERT *certificate);
UINT nx_secure_tls_local_certificate_find(NX_SECURE_TLS_SESSION *tls_session,
NX_SECURE_X509_CERT **certificate, UCHAR *common_name,
UINT name_length);
UINT nx_secure_tls_local_certificate_remove(NX_SECURE_TLS_SESSION *tls_session, UCHAR *common_name,
UINT common_name_length);
UINT nx_secure_tls_metadata_size_calculate(const NX_SECURE_TLS_CRYPTO *cipher_table,
ULONG *metadata_size);
UINT nx_secure_tls_remote_certificate_allocate(NX_SECURE_TLS_SESSION *tls_session,
NX_SECURE_X509_CERT *certificate,
UCHAR *raw_certificate_buffer, UINT buffer_size);
UINT nx_secure_tls_remote_certificate_buffer_allocate(NX_SECURE_TLS_SESSION *tls_session,
UINT certs_number, VOID *certificate_buffer, ULONG buffer_size);
UINT nx_secure_tls_remote_certificate_free_all(NX_SECURE_TLS_SESSION *tls_session);
UINT nx_secure_tls_server_certificate_add(NX_SECURE_TLS_SESSION *tls_session,
NX_SECURE_X509_CERT *certificate, UINT cert_id);
UINT nx_secure_tls_server_certificate_find(NX_SECURE_TLS_SESSION *tls_session,
NX_SECURE_X509_CERT **certificate, UINT cert_id);
UINT nx_secure_tls_server_certificate_remove(NX_SECURE_TLS_SESSION *tls_session, UINT cert_id);
UINT nx_secure_tls_session_alert_value_get(NX_SECURE_TLS_SESSION *tls_session,
UINT *alert_level, UINT *alert_value);
UINT nx_secure_tls_session_certificate_callback_set(NX_SECURE_TLS_SESSION *tls_session,
ULONG (*func_ptr)(NX_SECURE_TLS_SESSION *session,
NX_SECURE_X509_CERT *certificate));
UINT nx_secure_tls_session_client_callback_set(NX_SECURE_TLS_SESSION *tls_session,
ULONG (*func_ptr)(NX_SECURE_TLS_SESSION *tls_session,
NX_SECURE_TLS_HELLO_EXTENSION *extensions,
UINT num_extensions));
UINT nx_secure_tls_session_client_verify_disable(NX_SECURE_TLS_SESSION *tls_session);
UINT nx_secure_tls_session_client_verify_enable(NX_SECURE_TLS_SESSION *tls_session);
UINT nx_secure_tls_session_x509_client_verify_configure(NX_SECURE_TLS_SESSION *tls_session, UINT certs_number,
VOID *certificate_buffer, ULONG buffer_size);
UINT nx_secure_tls_session_create(NX_SECURE_TLS_SESSION *session_ptr,
const NX_SECURE_TLS_CRYPTO *cipher_table,
VOID *metadata_area,
ULONG metadata_size);
UINT nx_secure_tls_session_delete(NX_SECURE_TLS_SESSION *tls_session);
UINT nx_secure_tls_session_end(NX_SECURE_TLS_SESSION *tls_session, UINT wait_option);
UINT nx_secure_tls_session_packet_buffer_set(NX_SECURE_TLS_SESSION *session_ptr,
UCHAR *buffer_ptr, ULONG buffer_size);
UINT nx_secure_tls_session_packet_pool_set(NX_SECURE_TLS_SESSION *tls_session,
NX_PACKET_POOL *packet_pool);
UINT nx_secure_tls_session_protocol_version_override(NX_SECURE_TLS_SESSION *tls_session,
USHORT protocol_version);
UINT nx_secure_tls_session_receive(NX_SECURE_TLS_SESSION *tls_session, NX_PACKET **packet_ptr_ptr,
ULONG wait_option);
UINT nx_secure_tls_session_renegotiate(NX_SECURE_TLS_SESSION *tls_session, UINT wait_option);
UINT nx_secure_tls_session_renegotiate_callback_set(NX_SECURE_TLS_SESSION *tls_session,
ULONG (*func_ptr)(NX_SECURE_TLS_SESSION *session));
UINT nx_secure_tls_session_reset(NX_SECURE_TLS_SESSION *tls_session);
UINT nx_secure_tls_session_send(NX_SECURE_TLS_SESSION *tls_session, NX_PACKET *packet_ptr,
ULONG wait_option);
UINT nx_secure_tls_session_server_callback_set(NX_SECURE_TLS_SESSION *tls_session,
ULONG (*func_ptr)(NX_SECURE_TLS_SESSION *tls_session,
NX_SECURE_TLS_HELLO_EXTENSION *extensions,
UINT num_extensions));
UINT nx_secure_tls_session_sni_extension_parse(NX_SECURE_TLS_SESSION *tls_session,
NX_SECURE_TLS_HELLO_EXTENSION *extensions,
UINT num_extensions, NX_SECURE_X509_DNS_NAME *dns_name);
UINT nx_secure_tls_session_sni_extension_set(NX_SECURE_TLS_SESSION *tls_session,
NX_SECURE_X509_DNS_NAME *dns_name);
UINT nx_secure_tls_session_start(NX_SECURE_TLS_SESSION *tls_session, NX_TCP_SOCKET *tcp_socket,
UINT wait_option);
UINT nx_secure_tls_session_time_function_set(NX_SECURE_TLS_SESSION *tls_session,
ULONG (*time_func_ptr)(VOID));
UINT nx_secure_tls_trusted_certificate_add(NX_SECURE_TLS_SESSION *tls_session,
NX_SECURE_X509_CERT *certificate);
UINT nx_secure_tls_trusted_certificate_remove(NX_SECURE_TLS_SESSION *tls_session, UCHAR *common_name,
UINT common_name_length);
UINT nx_secure_tls_packet_allocate(NX_SECURE_TLS_SESSION *tls_session, NX_PACKET_POOL *pool_ptr,
NX_PACKET **packet_ptr, ULONG wait_option);
#ifdef NX_SECURE_ENABLE_PSK_CIPHERSUITES
UINT nx_secure_tls_psk_add(NX_SECURE_TLS_SESSION *tls_session, UCHAR *pre_shared_key, UINT psk_length,
UCHAR *psk_identity, UINT identity_length, UCHAR *hint, UINT hint_length);
UINT nx_secure_tls_client_psk_set(NX_SECURE_TLS_SESSION *tls_session, UCHAR *pre_shared_key, UINT psk_length,
UCHAR *psk_identity, UINT identity_length, UCHAR *hint, UINT hint_length);
#endif
#ifdef NX_SECURE_ENABLE_ECC_CIPHERSUITE
UINT nx_secure_tls_ecc_initialize(NX_SECURE_TLS_SESSION *tls_session,
const USHORT *supported_groups, USHORT supported_group_count,
const NX_CRYPTO_METHOD **curves);
#endif /* NX_SECURE_ENABLE_ECC_CIPHERSUITE */
#endif /* NX_SECURE_SOURCE_CODE */
#ifdef __cplusplus
}
#endif
#endif /* SRC_NX_SECURE_TLS_H_ */
|
