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