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 #include "nx_secure_tls.h"
25 
26 /* Bring in externs for caller checking code.  */
27 
28 NX_SECURE_CALLER_CHECKING_EXTERNS
29 
30 /**************************************************************************/
31 /*                                                                        */
32 /*  FUNCTION                                               RELEASE        */
33 /*                                                                        */
34 /*    _nxe_secure_tls_session_sni_extension_set           PORTABLE C      */
35 /*                                                           6.1          */
36 /*  AUTHOR                                                                */
37 /*                                                                        */
38 /*    Timothy Stapko, Microsoft Corporation                               */
39 /*                                                                        */
40 /*  DESCRIPTION                                                           */
41 /*                                                                        */
42 /*    This function checks for errors when setting the TLS Server Name    */
43 /*    Indication name for a TLS client.                                   */
44 /*                                                                        */
45 /*  INPUT                                                                 */
46 /*                                                                        */
47 /*    tls_session                           TLS control block             */
48 /*    dns_name                              Pointer to the server name    */
49 /*                                                                        */
50 /*  OUTPUT                                                                */
51 /*                                                                        */
52 /*    status                                Completion status             */
53 /*                                                                        */
54 /*  CALLS                                                                 */
55 /*                                                                        */
56 /*    _nx_secure_tls_session_sni_extension_set                            */
57 /*                                          Actual set function           */
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_sni_extension_set(NX_SECURE_TLS_SESSION * tls_session,NX_SECURE_X509_DNS_NAME * dns_name)72 UINT _nxe_secure_tls_session_sni_extension_set(NX_SECURE_TLS_SESSION *tls_session,
73                                                NX_SECURE_X509_DNS_NAME *dns_name)
74 {
75 UINT status;
76 
77 
78     if (tls_session == NX_NULL || dns_name == NX_NULL)
79     {
80         return(NX_PTR_ERROR);
81     }
82 
83     /* Make sure the session is initialized. */
84     if(tls_session -> nx_secure_tls_id != NX_SECURE_TLS_ID)
85     {
86         return(NX_SECURE_TLS_SESSION_UNINITIALIZED);
87     }
88 
89     /* Check for appropriate caller.  */
90     NX_THREADS_ONLY_CALLER_CHECKING
91 
92     /* Set the name in the TLS session. */
93     status = _nx_secure_tls_session_sni_extension_set(tls_session, dns_name);
94 
95     return(status);
96 }
97 
98