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 
25 /* Include necessary system files.  */
26 
27 #include "nx_secure_dtls.h"
28 
29 /* Bring in externs for caller checking code.  */
30 
31 NX_SECURE_CALLER_CHECKING_EXTERNS
32 
33 /**************************************************************************/
34 /*                                                                        */
35 /*  FUNCTION                                               RELEASE        */
36 /*                                                                        */
37 /*    _nxe_secure_dtls_session_receive                    PORTABLE C      */
38 /*                                                           6.1          */
39 /*  AUTHOR                                                                */
40 /*                                                                        */
41 /*    Timothy Stapko, Microsoft Corporation                               */
42 /*                                                                        */
43 /*  DESCRIPTION                                                           */
44 /*                                                                        */
45 /*    This function checks for errors in the DTLS session receive call.   */
46 /*                                                                        */
47 /*  INPUT                                                                 */
48 /*                                                                        */
49 /*    dtls_session                          DTLS session control block    */
50 /*    packet_ptr_ptr                        Pointer to return packet      */
51 /*    wait_option                           Indicates how long the caller */
52 /*                                          should wait for the response  */
53 /*                                                                        */
54 /*  OUTPUT                                                                */
55 /*                                                                        */
56 /*    status                                Completion status             */
57 /*                                                                        */
58 /*  CALLS                                                                 */
59 /*                                                                        */
60 /*    _nx_secure_dtls_session_receive       Actual DTLS session receive   */
61 /*                                            call                        */
62 /*                                                                        */
63 /*  CALLED BY                                                             */
64 /*                                                                        */
65 /*    Application Code                                                    */
66 /*                                                                        */
67 /*  RELEASE HISTORY                                                       */
68 /*                                                                        */
69 /*    DATE              NAME                      DESCRIPTION             */
70 /*                                                                        */
71 /*  05-19-2020     Timothy Stapko           Initial Version 6.0           */
72 /*  09-30-2020     Timothy Stapko           Modified comment(s),          */
73 /*                                            resulting in version 6.1    */
74 /*                                                                        */
75 /**************************************************************************/
_nxe_secure_dtls_session_receive(NX_SECURE_DTLS_SESSION * dtls_session,NX_PACKET ** packet_ptr_ptr,ULONG wait_option)76 UINT _nxe_secure_dtls_session_receive(NX_SECURE_DTLS_SESSION *dtls_session,
77                                       NX_PACKET **packet_ptr_ptr, ULONG wait_option)
78 {
79 #ifdef NX_SECURE_ENABLE_DTLS
80 UINT status;
81 
82     if ((dtls_session == NX_NULL) || (packet_ptr_ptr == NX_NULL))
83     {
84         return(NX_PTR_ERROR);
85     }
86 
87     /* Make sure the session is initialized. */
88     if (dtls_session->nx_secure_dtls_tls_session.nx_secure_tls_id != NX_SECURE_TLS_ID)
89     {
90         return(NX_SECURE_TLS_SESSION_UNINITIALIZED);
91     }
92 
93     status =  _nx_secure_dtls_session_receive(dtls_session, packet_ptr_ptr, wait_option);
94 
95     /* Return completion status.  */
96     return(status);
97 #else
98     NX_PARAMETER_NOT_USED(dtls_session);
99     NX_PARAMETER_NOT_USED(packet_ptr_ptr);
100     NX_PARAMETER_NOT_USED(wait_option);
101 
102     return(NX_NOT_SUPPORTED);
103 #endif /* NX_SECURE_ENABLE_DTLS */
104 }
105 
106