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 "nx_secure_tls.h"
26 
27 /* Bring in externs for caller checking code.  */
28 
29 NX_SECURE_CALLER_CHECKING_EXTERNS
30 
31 /**************************************************************************/
32 /*                                                                        */
33 /*  FUNCTION                                               RELEASE        */
34 /*                                                                        */
35 /*    _nxe_secure_tls_session_renegotiate_callback_set    PORTABLE C      */
36 /*                                                           6.1          */
37 /*  AUTHOR                                                                */
38 /*                                                                        */
39 /*    Timothy Stapko, Microsoft Corporation                               */
40 /*                                                                        */
41 /*  DESCRIPTION                                                           */
42 /*                                                                        */
43 /*    This function checks for errors when setting the TLS session        */
44 /*    re-negotiation callback function pointer.                           */
45 /*                                                                        */
46 /*  INPUT                                                                 */
47 /*                                                                        */
48 /*    tls_session                           TLS control block             */
49 /*    func_ptr                              Pointer to callback function  */
50 /*                                                                        */
51 /*  OUTPUT                                                                */
52 /*                                                                        */
53 /*    status                                Completion status             */
54 /*                                                                        */
55 /*  CALLS                                                                 */
56 /*                                                                        */
57 /*    _nx_secure_tls_session_renegotiate_callback_set                     */
58 /*                                          Actual function pointer set   */
59 /*                                                                        */
60 /*  CALLED BY                                                             */
61 /*                                                                        */
62 /*    Application Code                                                    */
63 /*                                                                        */
64 /*  RELEASE HISTORY                                                       */
65 /*                                                                        */
66 /*    DATE              NAME                      DESCRIPTION             */
67 /*                                                                        */
68 /*  05-19-2020     Timothy Stapko           Initial Version 6.0           */
69 /*  09-30-2020     Timothy Stapko           Modified comment(s),          */
70 /*                                            fixed renegotiation bug,    */
71 /*                                            resulting in version 6.1    */
72 /*                                                                        */
73 /**************************************************************************/
74 #ifndef NX_SECURE_TLS_DISABLE_SECURE_RENEGOTIATION
_nxe_secure_tls_session_renegotiate_callback_set(NX_SECURE_TLS_SESSION * tls_session,ULONG (* func_ptr)(NX_SECURE_TLS_SESSION * session))75 UINT _nxe_secure_tls_session_renegotiate_callback_set(NX_SECURE_TLS_SESSION *tls_session,
76                                                       ULONG (*func_ptr)(NX_SECURE_TLS_SESSION *session))
77 {
78 UINT status;
79 
80 
81     if (tls_session == NX_NULL || func_ptr == NX_NULL)
82     {
83         return(NX_PTR_ERROR);
84     }
85 
86     /* Make sure the session is initialized. */
87     if(tls_session -> nx_secure_tls_id != NX_SECURE_TLS_ID)
88     {
89         return(NX_SECURE_TLS_SESSION_UNINITIALIZED);
90     }
91 
92     /* Check for appropriate caller.  */
93     NX_THREADS_ONLY_CALLER_CHECKING
94 
95     /* We want to be able to set the function to NX_NULL to disable it, so don't check for it. */
96     status = _nx_secure_tls_session_renegotiate_callback_set(tls_session, func_ptr);
97 
98     return(status);
99 }
100 #endif /* NX_SECURE_TLS_DISABLE_SECURE_RENEGOTIATION */
101 
102