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 /** Datagram Transport Layer Security (DTLS) */
18 /** */
19 /**************************************************************************/
20 /**************************************************************************/
21
22 #define NX_SECURE_SOURCE_CODE
23
24 #include "nx_secure_dtls.h"
25
26 /**************************************************************************/
27 /* */
28 /* FUNCTION RELEASE */
29 /* */
30 /* _nx_secure_dtls_session_local_certificate_remove PORTABLE C */
31 /* 6.1 */
32 /* AUTHOR */
33 /* */
34 /* Timothy Stapko, Microsoft Corporation */
35 /* */
36 /* DESCRIPTION */
37 /* */
38 /* This function checks for errors when removing a local identity */
39 /* certificate from a DTLS session. */
40 /* */
41 /* INPUT */
42 /* */
43 /* dtls_session DTLS session control block */
44 /* common_name Certificate common name */
45 /* common_name_length Length of common name string */
46 /* cert_id Numeric ID for certificate */
47 /* */
48 /* OUTPUT */
49 /* */
50 /* status Completion status */
51 /* */
52 /* CALLS */
53 /* */
54 /* _nx_secure_dtls_session_local_certificate_remove */
55 /* Actual function call */
56 /* */
57 /* CALLED BY */
58 /* */
59 /* Application Code */
60 /* */
61 /* RELEASE HISTORY */
62 /* */
63 /* DATE NAME DESCRIPTION */
64 /* */
65 /* 05-19-2020 Timothy Stapko Initial Version 6.0 */
66 /* 09-30-2020 Timothy Stapko Modified comment(s), */
67 /* resulting in version 6.1 */
68 /* */
69 /**************************************************************************/
_nxe_secure_dtls_session_local_certificate_remove(NX_SECURE_DTLS_SESSION * dtls_session,UCHAR * common_name,UINT common_name_length,UINT cert_id)70 UINT _nxe_secure_dtls_session_local_certificate_remove(NX_SECURE_DTLS_SESSION *dtls_session,
71 UCHAR *common_name, UINT common_name_length, UINT cert_id)
72 {
73 #ifdef NX_SECURE_ENABLE_DTLS
74 UINT status;
75
76 /* Check pointers. */
77 if (dtls_session == NX_NULL)
78 {
79 return(NX_PTR_ERROR);
80 }
81
82 /* Make sure the session is initialized. */
83 if (dtls_session->nx_secure_dtls_tls_session.nx_secure_tls_id != NX_SECURE_TLS_ID)
84 {
85 return(NX_SECURE_TLS_SESSION_UNINITIALIZED);
86 }
87
88 /* Remove the local certificate with the given common name. */
89 status = _nx_secure_dtls_session_local_certificate_remove(dtls_session, common_name, common_name_length, cert_id);
90
91 return(status);
92 #else
93 NX_PARAMETER_NOT_USED(dtls_session);
94 NX_PARAMETER_NOT_USED(common_name);
95 NX_PARAMETER_NOT_USED(common_name_length);
96 NX_PARAMETER_NOT_USED(cert_id);
97
98 return(NX_NOT_SUPPORTED);
99 #endif /* NX_SECURE_ENABLE_DTLS */
100 }
101
102
