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 /*    _nxe_secure_dtls_session_trusted_certificate_add    PORTABLE C      */
31 /*                                                           6.1          */
32 /*  AUTHOR                                                                */
33 /*                                                                        */
34 /*    Timothy Stapko, Microsoft Corporation                               */
35 /*                                                                        */
36 /*  DESCRIPTION                                                           */
37 /*                                                                        */
38 /*    This function checks for errors when adding a trusted certificate   */
39 /*    to a DTLS session instance.                                         */
40 /*                                                                        */
41 /*  INPUT                                                                 */
42 /*                                                                        */
43 /*    dtls_session                          DTLS session control block    */
44 /*    certificate                           Pointer to identity cert      */
45 /*    cert_id                               Numeric ID for cert           */
46 /*                                                                        */
47 /*  OUTPUT                                                                */
48 /*                                                                        */
49 /*    status                                Completion status             */
50 /*                                                                        */
51 /*  CALLS                                                                 */
52 /*                                                                        */
53 /*    _nx_secure_dtls_session_trusted_certificate_add                     */
54 /*                                          Actual function call          */
55 /*                                                                        */
56 /*  CALLED BY                                                             */
57 /*                                                                        */
58 /*    Application Code                                                    */
59 /*                                                                        */
60 /*  RELEASE HISTORY                                                       */
61 /*                                                                        */
62 /*    DATE              NAME                      DESCRIPTION             */
63 /*                                                                        */
64 /*  05-19-2020     Timothy Stapko           Initial Version 6.0           */
65 /*  09-30-2020     Timothy Stapko           Modified comment(s),          */
66 /*                                            resulting in version 6.1    */
67 /*                                                                        */
68 /**************************************************************************/
_nxe_secure_dtls_session_trusted_certificate_add(NX_SECURE_DTLS_SESSION * dtls_session,NX_SECURE_X509_CERT * certificate,UINT cert_id)69 UINT _nxe_secure_dtls_session_trusted_certificate_add(NX_SECURE_DTLS_SESSION *dtls_session,
70                                                      NX_SECURE_X509_CERT *certificate, UINT cert_id)
71 {
72 #ifdef NX_SECURE_ENABLE_DTLS
73 UINT status;
74 
75     if ((dtls_session == NX_NULL) || (certificate == NX_NULL))
76     {
77         return(NX_PTR_ERROR);
78     }
79 
80     /* Make sure the session is initialized. */
81     if (dtls_session->nx_secure_dtls_tls_session.nx_secure_tls_id != NX_SECURE_TLS_ID)
82     {
83         return(NX_SECURE_TLS_SESSION_UNINITIALIZED);
84     }
85 
86     /* We don't want to add certificates without an ID. */
87     if (cert_id == 0)
88     {
89         return(NX_INVALID_PARAMETERS);
90     }
91 
92     /* Add the certificate with the provided ID assigned above.  */
93     status = _nx_secure_dtls_session_trusted_certificate_add(dtls_session, certificate, cert_id);
94 
95     return(status);
96 #else
97     NX_PARAMETER_NOT_USED(dtls_session);
98     NX_PARAMETER_NOT_USED(certificate);
99     NX_PARAMETER_NOT_USED(cert_id);
100 
101     return(NX_NOT_SUPPORTED);
102 #endif /* NX_SECURE_ENABLE_DTLS */
103 }
104