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 /**************************************************************************/
30 /*                                                                        */
31 /*  FUNCTION                                               RELEASE        */
32 /*                                                                        */
33 /*    _nxe_secure_tls_session_alert_value_get             PORTABLE C      */
34 /*                                                           6.1          */
35 /*  AUTHOR                                                                */
36 /*                                                                        */
37 /*    Timothy Stapko, Microsoft Corporation                               */
38 /*                                                                        */
39 /*  DESCRIPTION                                                           */
40 /*                                                                        */
41 /*    This function checks for errors in the TLS alert value              */
42 /*    informational API.                                                  */
43 /*                                                                        */
44 /*  INPUT                                                                 */
45 /*                                                                        */
46 /*    tls_session                           Pointer to TLS Session        */
47 /*    alert_value                           Return alert value            */
48 /*    alert_level                           Return alert level            */
49 /*                                                                        */
50 /*  OUTPUT                                                                */
51 /*                                                                        */
52 /*    status                                Completion status             */
53 /*                                                                        */
54 /*  CALLS                                                                 */
55 /*                                                                        */
56 /*    _nx_secure_tls_session_alert_value_get                              */
57 /*                                          Actual API call               */
58 /*                                                                        */
59 /*  CALLED BY                                                             */
60 /*                                                                        */
61 /*    Application Code                                                    */
62 /*                                                                        */
63 /*  RELEASE HISTORY                                                       */
64 /*                                                                        */
65 /*    DATE              NAME                      DESCRIPTION             */
66 /*                                                                        */
67 /*  05-19-2020     Timothy Stapko           Initial Version 6.0           */
68 /*  09-30-2020     Timothy Stapko           Modified comment(s),          */
69 /*                                            resulting in version 6.1    */
70 /*                                                                        */
71 /**************************************************************************/
_nxe_secure_tls_session_alert_value_get(NX_SECURE_TLS_SESSION * tls_session,UINT * alert_level,UINT * alert_value)72 UINT  _nxe_secure_tls_session_alert_value_get(NX_SECURE_TLS_SESSION *tls_session,
73                                               UINT *alert_level, UINT *alert_value)
74 {
75 UINT status;
76 
77     if (tls_session == NX_NULL || alert_level == NX_NULL || alert_value == NX_NULL)
78     {
79         return(NX_PTR_ERROR);
80     }
81 
82     /* Make sure the session is initialized. */
83     if(tls_session -> nx_secure_tls_id != NX_SECURE_TLS_ID)
84     {
85         return(NX_SECURE_TLS_SESSION_UNINITIALIZED);
86     }
87 
88     status =  _nx_secure_tls_session_alert_value_get(tls_session, alert_level, alert_value);
89 
90     /* Return completion status.  */
91     return(status);
92 }
93 
94