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 /**    Transport Layer Security (TLS)                                     */
18 /**                                                                       */
19 /**************************************************************************/
20 /**************************************************************************/
21 
22 #define NX_SECURE_SOURCE_CODE
23 
24 
25 /* Include necessary system files.  */
26 
27 #include "nx_secure_tls.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_tls_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 TLS session receive call.    */
46 /*                                                                        */
47 /*  INPUT                                                                 */
48 /*                                                                        */
49 /*    tls_session                           TLS 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_tls_session_receive        Actual TLS 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_tls_session_receive(NX_SECURE_TLS_SESSION * tls_session,NX_PACKET ** packet_ptr_ptr,ULONG wait_option)76 UINT  _nxe_secure_tls_session_receive(NX_SECURE_TLS_SESSION *tls_session,
77                                       NX_PACKET **packet_ptr_ptr, ULONG wait_option)
78 {
79 UINT status;
80 
81     if ((tls_session == NX_NULL) || (packet_ptr_ptr == NX_NULL))
82     {
83         return(NX_PTR_ERROR);
84     }
85 
86     /* Make sure the session is initialized. */
87     if(tls_session -> nx_secure_tls_id != NX_SECURE_TLS_ID)
88     {
89         return(NX_SECURE_TLS_SESSION_UNINITIALIZED);
90     }
91 
92     if (tls_session -> nx_secure_tls_tcp_socket == NX_NULL)
93     {
94         return(NX_SECURE_TLS_SESSION_UNINITIALIZED);
95     }
96 
97     /* Check for appropriate caller.  */
98     NX_THREADS_ONLY_CALLER_CHECKING
99 
100     status =  _nx_secure_tls_session_receive(tls_session, packet_ptr_ptr, wait_option);
101 
102     /* Return completion status.  */
103     return(status);
104 }
105 
106