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_server_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 server session start call.*/
39 /*                                                                        */
40 /*  INPUT                                                                 */
41 /*                                                                        */
42 /*    dtls_session                          DTLS control block            */
43 /*    wait_option                           Suspension option             */
44 /*                                                                        */
45 /*  OUTPUT                                                                */
46 /*                                                                        */
47 /*    status                                Completion status             */
48 /*                                                                        */
49 /*  CALLS                                                                 */
50 /*                                                                        */
51 /*    _nx_secure_dtls_server_session_start  Start the DTLS session        */
52 /*                                                                        */
53 /*  CALLED BY                                                             */
54 /*                                                                        */
55 /*    Application Code                                                    */
56 /*                                                                        */
57 /*  RELEASE HISTORY                                                       */
58 /*                                                                        */
59 /*    DATE              NAME                      DESCRIPTION             */
60 /*                                                                        */
61 /*  05-19-2020     Timothy Stapko           Initial Version 6.0           */
62 /*  09-30-2020     Timothy Stapko           Modified comment(s),          */
63 /*                                            resulting in version 6.1    */
64 /*                                                                        */
65 /**************************************************************************/
_nxe_secure_dtls_server_session_start(NX_SECURE_DTLS_SESSION * dtls_session,UINT wait_option)66 UINT _nxe_secure_dtls_server_session_start(NX_SECURE_DTLS_SESSION *dtls_session, UINT wait_option)
67 {
68 #ifdef NX_SECURE_ENABLE_DTLS
69 UINT status;
70 
71     /* Check pointers. */
72     if (dtls_session == NX_NULL)
73     {
74         return(NX_PTR_ERROR);
75     }
76 
77     /* This API requires that the UDP socket already be assigned. */
78     if (dtls_session->nx_secure_dtls_udp_socket == NX_NULL ||
79         (!dtls_session -> nx_secure_dtls_session_in_use) ||
80         dtls_session->nx_secure_dtls_tls_session.nx_secure_tls_id != NX_SECURE_TLS_ID)
81     {
82         return(NX_SECURE_TLS_SESSION_UNINITIALIZED);
83     }
84 
85     /* Call actual function. */
86     status = _nx_secure_dtls_server_session_start(dtls_session, wait_option);
87 
88     return(status);
89 #else
90     NX_PARAMETER_NOT_USED(dtls_session);
91     NX_PARAMETER_NOT_USED(wait_option);
92 
93     return(NX_NOT_SUPPORTED);
94 #endif /* NX_SECURE_ENABLE_DTLS */
95 }
96