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 /**    Transport Layer Security (TLS)                                     */
19 /**                                                                       */
20 /**************************************************************************/
21 /**************************************************************************/
22 
23 #define NX_SECURE_SOURCE_CODE
24 
25 
26 /* Include necessary system files.  */
27 
28 #include "nx_secure_tls.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_tls_session_send                        PORTABLE C      */
39 /*                                                           6.3.0        */
40 /*  AUTHOR                                                                */
41 /*                                                                        */
42 /*    Timothy Stapko, Microsoft Corporation                               */
43 /*                                                                        */
44 /*  DESCRIPTION                                                           */
45 /*                                                                        */
46 /*    This function checks for errors in the TLS session send call.       */
47 /*                                                                        */
48 /*  INPUT                                                                 */
49 /*                                                                        */
50 /*    tls_session                           TLS control block             */
51 /*    packet_ptr                            Pointer to packet data        */
52 /*    wait_option                           Indicates behavior if TCP     */
53 /*                                          socket cannot send packet     */
54 /*                                                                        */
55 /*  OUTPUT                                                                */
56 /*                                                                        */
57 /*    status                                Completion status             */
58 /*                                                                        */
59 /*  CALLS                                                                 */
60 /*                                                                        */
61 /*    _nx_secure_tls_session_send           Actual TLS session send 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 /*  10-31-2023     Yanwu Cai                Modified comment(s), added    */
75 /*                                            record length checking,     */
76 /*                                            resulting in version 6.3.0  */
77 /*                                                                        */
78 /**************************************************************************/
_nxe_secure_tls_session_send(NX_SECURE_TLS_SESSION * tls_session,NX_PACKET * packet_ptr,ULONG wait_option)79 UINT  _nxe_secure_tls_session_send(NX_SECURE_TLS_SESSION *tls_session, NX_PACKET *packet_ptr,
80                                    ULONG wait_option)
81 {
82 UINT status;
83 
84     if (tls_session == NX_NULL)
85     {
86         return(NX_PTR_ERROR);
87     }
88 
89     if (packet_ptr == NX_NULL)
90     {
91         return(NX_PTR_ERROR);
92     }
93 
94     if (tls_session -> nx_secure_tls_tcp_socket == NX_NULL)
95     {
96         return(NX_SECURE_TLS_SESSION_UNINITIALIZED);
97     }
98 
99     /* Make sure the session is initialized. */
100     if (tls_session -> nx_secure_tls_id != NX_SECURE_TLS_ID)
101     {
102         return(NX_SECURE_TLS_SESSION_UNINITIALIZED);
103     }
104 
105     /* Check the plaintext length as the fragmentation is not supported currently. */
106     if (packet_ptr -> nx_packet_length > NX_SECURE_TLS_MAX_PLAINTEXT_LENGTH)
107     {
108         return(NX_SECURE_TLS_RECORD_OVERFLOW);
109     }
110 
111     /* Check for appropriate caller.  */
112     NX_THREADS_ONLY_CALLER_CHECKING
113 
114     status =  _nx_secure_tls_session_send(tls_session, packet_ptr, wait_option);
115 
116     /* Return completion status.  */
117     return(status);
118 }
119 
120