1 /***************************************************************************
2 * Copyright (c) 2024 Microsoft Corporation
3 *
4 * This program and the accompanying materials are made available under the
5 * terms of the MIT License which is available at
6 * https://opensource.org/licenses/MIT.
7 *
8 * SPDX-License-Identifier: MIT
9 **************************************************************************/
10
11
12 /**************************************************************************/
13 /**************************************************************************/
14 /** */
15 /** NetX Secure Component */
16 /** */
17 /** Datagram Transport Layer Security (DTLS) */
18 /** */
19 /**************************************************************************/
20 /**************************************************************************/
21
22 #define NX_SECURE_SOURCE_CODE
23
24 #include "nx_secure_dtls.h"
25
26 /**************************************************************************/
27 /* */
28 /* FUNCTION RELEASE */
29 /* */
30 /* _nxe_secure_dtls_client_session_start PORTABLE C */
31 /* 6.1 */
32 /* AUTHOR */
33 /* */
34 /* Timothy Stapko, Microsoft Corporation */
35 /* */
36 /* DESCRIPTION */
37 /* */
38 /* This function checks for errors in a DTLS client session start call.*/
39 /* */
40 /* INPUT */
41 /* */
42 /* dtls_session DTLS control block */
43 /* udp_socket UDP socket pointer */
44 /* wait_option Suspension option */
45 /* ip_address Address of remote server */
46 /* port Port on remote server */
47 /* */
48 /* OUTPUT */
49 /* */
50 /* status Completion status */
51 /* */
52 /* CALLS */
53 /* */
54 /* _nx_secure_dtls_client_session_start Start the DTLS session */
55 /* */
56 /* CALLED BY */
57 /* */
58 /* Application Code */
59 /* */
60 /* RELEASE HISTORY */
61 /* */
62 /* DATE NAME DESCRIPTION */
63 /* */
64 /* 05-19-2020 Timothy Stapko Initial Version 6.0 */
65 /* 09-30-2020 Timothy Stapko Modified comment(s), */
66 /* resulting in version 6.1 */
67 /* */
68 /**************************************************************************/
_nxe_secure_dtls_client_session_start(NX_SECURE_DTLS_SESSION * dtls_session,NX_UDP_SOCKET * udp_socket,NXD_ADDRESS * ip_address,UINT port,UINT wait_option)69 UINT _nxe_secure_dtls_client_session_start(NX_SECURE_DTLS_SESSION *dtls_session, NX_UDP_SOCKET *udp_socket, NXD_ADDRESS *ip_address, UINT port, UINT wait_option)
70 {
71 #ifdef NX_SECURE_ENABLE_DTLS
72 UINT status;
73
74 /* Check pointers. */
75 if(dtls_session == NX_NULL || udp_socket == NX_NULL || ip_address == NX_NULL)
76 {
77 return(NX_PTR_ERROR);
78 }
79
80 /* Make sure the session is initialized. */
81 if(dtls_session->nx_secure_dtls_tls_session.nx_secure_tls_id != NX_SECURE_TLS_ID)
82 {
83 return(NX_SECURE_TLS_SESSION_UNINITIALIZED);
84 }
85
86 /* Call actual function. */
87 status = _nx_secure_dtls_client_session_start(dtls_session, udp_socket, ip_address, port, wait_option);
88
89 return(status);
90 #else
91 NX_PARAMETER_NOT_USED(dtls_session);
92 NX_PARAMETER_NOT_USED(udp_socket);
93 NX_PARAMETER_NOT_USED(wait_option);
94 NX_PARAMETER_NOT_USED(ip_address);
95 NX_PARAMETER_NOT_USED(port);
96
97 return(NX_NOT_SUPPORTED);
98 #endif /* NX_SECURE_ENABLE_DTLS */
99 }
100
