CryptoPkg: Add Null instance of the TlsLib class
[mirror_edk2.git] / CryptoPkg / Library / TlsLibNull / TlsInitNull.c
1 /** @file\r
2   SSL/TLS Initialization Null Library Wrapper Implementation.\r
3 \r
4 Copyright (c) 2016 - 2017, Intel Corporation. All rights reserved.<BR>\r
5 (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
6 SPDX-License-Identifier: BSD-2-Clause-Patent\r
7 \r
8 **/\r
9 \r
10 #include "InternalTlsLib.h"\r
11 \r
12 /**\r
13   Initializes the library.\r
14 \r
15   This function registers ciphers and digests used directly and indirectly\r
16   by SSL/TLS, and initializes the readable error messages.\r
17   This function must be called before any other action takes places.\r
18 \r
19   @retval TRUE   The library has been initialized.\r
20   @retval FALSE  Failed to initialize the library.\r
21 \r
22 **/\r
23 BOOLEAN\r
24 EFIAPI\r
25 TlsInitialize (\r
26   VOID\r
27   )\r
28 {\r
29   ASSERT(FALSE);\r
30   return FALSE;\r
31 }\r
32 \r
33 /**\r
34   Free an allocated SSL_CTX object.\r
35 \r
36   @param[in]  TlsCtx    Pointer to the SSL_CTX object to be released.\r
37 \r
38 **/\r
39 VOID\r
40 EFIAPI\r
41 TlsCtxFree (\r
42   IN   VOID                  *TlsCtx\r
43   )\r
44 {\r
45   ASSERT(FALSE);\r
46   return;\r
47 }\r
48 \r
49 /**\r
50   Creates a new SSL_CTX object as framework to establish TLS/SSL enabled\r
51   connections.\r
52 \r
53   @param[in]  MajorVer    Major Version of TLS/SSL Protocol.\r
54   @param[in]  MinorVer    Minor Version of TLS/SSL Protocol.\r
55 \r
56   @return  Pointer to an allocated SSL_CTX object.\r
57            If the creation failed, TlsCtxNew() returns NULL.\r
58 \r
59 **/\r
60 VOID *\r
61 EFIAPI\r
62 TlsCtxNew (\r
63   IN     UINT8                    MajorVer,\r
64   IN     UINT8                    MinorVer\r
65   )\r
66 {\r
67   ASSERT(FALSE);\r
68   return NULL;\r
69 }\r
70 \r
71 /**\r
72   Free an allocated TLS object.\r
73 \r
74   This function removes the TLS object pointed to by Tls and frees up the\r
75   allocated memory. If Tls is NULL, nothing is done.\r
76 \r
77   @param[in]  Tls    Pointer to the TLS object to be freed.\r
78 \r
79 **/\r
80 VOID\r
81 EFIAPI\r
82 TlsFree (\r
83   IN     VOID                     *Tls\r
84   )\r
85 {\r
86   ASSERT(FALSE);\r
87 }\r
88 \r
89 /**\r
90   Create a new TLS object for a connection.\r
91 \r
92   This function creates a new TLS object for a connection. The new object\r
93   inherits the setting of the underlying context TlsCtx: connection method,\r
94   options, verification setting.\r
95 \r
96   @param[in]  TlsCtx    Pointer to the SSL_CTX object.\r
97 \r
98   @return  Pointer to an allocated SSL object.\r
99            If the creation failed, TlsNew() returns NULL.\r
100 \r
101 **/\r
102 VOID *\r
103 EFIAPI\r
104 TlsNew (\r
105   IN     VOID                     *TlsCtx\r
106   )\r
107 {\r
108   ASSERT(FALSE);\r
109   return NULL;\r
110 }\r
111 \r