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_local_certificate_remove            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 local certificate remove */
46 /*    call.                                                               */
47 /*                                                                        */
48 /*  INPUT                                                                 */
49 /*                                                                        */
50 /*    tls_session                           Pointer to TLS Session        */
51 /*    common_name                           String to match "CN" field    */
52 /*    common_name_length                    Length of name                */
53 /*                                                                        */
54 /*  OUTPUT                                                                */
55 /*                                                                        */
56 /*    status                                Completion status             */
57 /*                                                                        */
58 /*  CALLS                                                                 */
59 /*                                                                        */
60 /*    _nx_secure_tls_local_certificate_remove                             */
61 /*                                          Actual local certificate      */
62 /*                                            remove 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_tls_local_certificate_remove(NX_SECURE_TLS_SESSION * tls_session,UCHAR * common_name,UINT common_name_length)77 UINT  _nxe_secure_tls_local_certificate_remove(NX_SECURE_TLS_SESSION *tls_session,
78                                                UCHAR *common_name, UINT common_name_length)
79 {
80 UINT status;
81 
82     if ((tls_session == NX_NULL) || (common_name == NX_NULL) || (common_name_length == 0))
83     {
84         return(NX_PTR_ERROR);
85     }
86 
87     /* Make sure the session is initialized. */
88     if(tls_session -> nx_secure_tls_id != NX_SECURE_TLS_ID)
89     {
90         return(NX_SECURE_TLS_SESSION_UNINITIALIZED);
91     }
92 
93     /* Check for appropriate caller.  */
94     NX_THREADS_ONLY_CALLER_CHECKING
95 
96     status =  _nx_secure_tls_local_certificate_remove(tls_session, common_name, common_name_length);
97 
98     /* Return completion status.  */
99     return(status);
100 }
101 
102