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 /*    _nx_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 /*    None                                                                */
57 /*                                                                        */
58 /*  CALLED BY                                                             */
59 /*                                                                        */
60 /*    Application Code                                                    */
61 /*                                                                        */
62 /*  RELEASE HISTORY                                                       */
63 /*                                                                        */
64 /*    DATE              NAME                      DESCRIPTION             */
65 /*                                                                        */
66 /*  05-19-2020     Timothy Stapko           Initial Version 6.0           */
67 /*  09-30-2020     Timothy Stapko           Modified comment(s),          */
68 /*                                            resulting in version 6.1    */
69 /*                                                                        */
70 /**************************************************************************/
_nx_secure_tls_session_alert_value_get(NX_SECURE_TLS_SESSION * tls_session,UINT * alert_level,UINT * alert_value)71 UINT  _nx_secure_tls_session_alert_value_get(NX_SECURE_TLS_SESSION *tls_session,
72                                              UINT *alert_level, UINT *alert_value)
73 {
74 
75     /* Get the protection. */
76     tx_mutex_get(&_nx_secure_tls_protection, TX_WAIT_FOREVER);
77 
78     /* Return the current alert value and level to the caller. */
79     *(alert_value) = tls_session -> nx_secure_tls_received_alert_value;
80     *(alert_level) = tls_session -> nx_secure_tls_received_alert_level;
81 
82     /* Release the protection. */
83     tx_mutex_put(&_nx_secure_tls_protection);
84 
85     /* Return completion status.  */
86     return(NX_SUCCESS);
87 }
88 
89