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