]>
git.proxmox.com Git - mirror_edk2.git/blob - CryptoPkg/Library/TlsLibNull/TlsConfigNull.c
2 SSL/TLS Configuration Null Library Wrapper Implementation.
4 Copyright (c) 2016 - 2017, Intel Corporation. All rights reserved.<BR>
5 (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
6 SPDX-License-Identifier: BSD-2-Clause-Patent
10 #include "InternalTlsLib.h"
13 Set a new TLS/SSL method for a particular TLS object.
15 This function sets a new TLS/SSL method for a particular TLS object.
17 @param[in] Tls Pointer to a TLS object.
18 @param[in] MajorVer Major Version of TLS/SSL Protocol.
19 @param[in] MinorVer Minor Version of TLS/SSL Protocol.
21 @retval EFI_SUCCESS The TLS/SSL method was set successfully.
22 @retval EFI_INVALID_PARAMETER The parameter is invalid.
23 @retval EFI_UNSUPPORTED Unsupported TLS/SSL method.
35 return EFI_UNSUPPORTED
;
39 Set TLS object to work in client or server mode.
41 This function prepares a TLS object to work in client or server mode.
43 @param[in] Tls Pointer to a TLS object.
44 @param[in] IsServer Work in server mode.
46 @retval EFI_SUCCESS The TLS/SSL work mode was set successfully.
47 @retval EFI_INVALID_PARAMETER The parameter is invalid.
48 @retval EFI_UNSUPPORTED Unsupported TLS/SSL work mode.
59 return EFI_UNSUPPORTED
;
63 Set the ciphers list to be used by the TLS object.
65 This function sets the ciphers for use by a specified TLS object.
67 @param[in] Tls Pointer to a TLS object.
68 @param[in] CipherId Array of UINT16 cipher identifiers. Each UINT16
69 cipher identifier comes from the TLS Cipher Suite
70 Registry of the IANA, interpreting Byte1 and Byte2
71 in network (big endian) byte order.
72 @param[in] CipherNum The number of cipher in the list.
74 @retval EFI_SUCCESS The ciphers list was set successfully.
75 @retval EFI_INVALID_PARAMETER The parameter is invalid.
76 @retval EFI_UNSUPPORTED No supported TLS cipher was found in CipherId.
77 @retval EFI_OUT_OF_RESOURCES Memory allocation failed.
89 return EFI_UNSUPPORTED
;
93 Set the compression method for TLS/SSL operations.
95 This function handles TLS/SSL integrated compression methods.
97 @param[in] CompMethod The compression method ID.
99 @retval EFI_SUCCESS The compression method for the communication was
101 @retval EFI_UNSUPPORTED Unsupported compression method.
106 TlsSetCompressionMethod (
111 return EFI_UNSUPPORTED
;
115 Set peer certificate verification mode for the TLS connection.
117 This function sets the verification mode flags for the TLS connection.
119 @param[in] Tls Pointer to the TLS object.
120 @param[in] VerifyMode A set of logically or'ed verification mode flags.
134 Set the specified host name to be verified.
136 @param[in] Tls Pointer to the TLS object.
137 @param[in] Flags The setting flags during the validation.
138 @param[in] HostName The specified host name to be verified.
140 @retval EFI_SUCCESS The HostName setting was set successfully.
141 @retval EFI_INVALID_PARAMETER The parameter is invalid.
142 @retval EFI_ABORTED Invalid HostName setting.
154 return EFI_UNSUPPORTED
;
158 Sets a TLS/SSL session ID to be used during TLS/SSL connect.
160 This function sets a session ID to be used when the TLS/SSL connection is
163 @param[in] Tls Pointer to the TLS object.
164 @param[in] SessionId Session ID data used for session resumption.
165 @param[in] SessionIdLen Length of Session ID in bytes.
167 @retval EFI_SUCCESS Session ID was set successfully.
168 @retval EFI_INVALID_PARAMETER The parameter is invalid.
169 @retval EFI_UNSUPPORTED No available session for ID setting.
177 IN UINT16 SessionIdLen
181 return EFI_UNSUPPORTED
;
185 Adds the CA to the cert store when requesting Server or Client authentication.
187 This function adds the CA certificate to the list of CAs when requesting
188 Server or Client authentication for the chosen TLS connection.
190 @param[in] Tls Pointer to the TLS object.
191 @param[in] Data Pointer to the data buffer of a DER-encoded binary
192 X.509 certificate or PEM-encoded X.509 certificate.
193 @param[in] DataSize The size of data buffer in bytes.
195 @retval EFI_SUCCESS The operation succeeded.
196 @retval EFI_INVALID_PARAMETER The parameter is invalid.
197 @retval EFI_OUT_OF_RESOURCES Required resources could not be allocated.
198 @retval EFI_ABORTED Invalid X.509 certificate.
203 TlsSetCaCertificate (
210 return EFI_UNSUPPORTED
;
214 Loads the local public certificate into the specified TLS object.
216 This function loads the X.509 certificate into the specified TLS object
219 @param[in] Tls Pointer to the TLS object.
220 @param[in] Data Pointer to the data buffer of a DER-encoded binary
221 X.509 certificate or PEM-encoded X.509 certificate.
222 @param[in] DataSize The size of data buffer in bytes.
224 @retval EFI_SUCCESS The operation succeeded.
225 @retval EFI_INVALID_PARAMETER The parameter is invalid.
226 @retval EFI_OUT_OF_RESOURCES Required resources could not be allocated.
227 @retval EFI_ABORTED Invalid X.509 certificate.
232 TlsSetHostPublicCert (
239 return EFI_UNSUPPORTED
;
243 Adds the local private key to the specified TLS object.
245 This function adds the local private key (DER-encoded or PEM-encoded or PKCS#8 private
246 key) into the specified TLS object for TLS negotiation.
248 @param[in] Tls Pointer to the TLS object.
249 @param[in] Data Pointer to the data buffer of a DER-encoded or PEM-encoded
250 or PKCS#8 private key.
251 @param[in] DataSize The size of data buffer in bytes.
252 @param[in] Password Pointer to NULL-terminated private key password, set it to NULL
253 if private key not encrypted.
255 @retval EFI_SUCCESS The operation succeeded.
256 @retval EFI_UNSUPPORTED This function is not supported.
257 @retval EFI_ABORTED Invalid private key data.
262 TlsSetHostPrivateKeyEx (
266 IN VOID
*Password OPTIONAL
270 return EFI_UNSUPPORTED
;
274 Adds the local private key to the specified TLS object.
276 This function adds the local private key (DER-encoded or PEM-encoded or PKCS#8 private
277 key) into the specified TLS object for TLS negotiation.
279 @param[in] Tls Pointer to the TLS object.
280 @param[in] Data Pointer to the data buffer of a DER-encoded or PEM-encoded
281 or PKCS#8 private key.
282 @param[in] DataSize The size of data buffer in bytes.
284 @retval EFI_SUCCESS The operation succeeded.
285 @retval EFI_UNSUPPORTED This function is not supported.
286 @retval EFI_ABORTED Invalid private key data.
291 TlsSetHostPrivateKey (
298 return EFI_UNSUPPORTED
;
302 Adds the CA-supplied certificate revocation list for certificate validation.
304 This function adds the CA-supplied certificate revocation list data for
305 certificate validity checking.
307 @param[in] Data Pointer to the data buffer of a DER-encoded CRL data.
308 @param[in] DataSize The size of data buffer in bytes.
310 @retval EFI_SUCCESS The operation succeeded.
311 @retval EFI_UNSUPPORTED This function is not supported.
312 @retval EFI_ABORTED Invalid CRL data.
317 TlsSetCertRevocationList (
323 return EFI_UNSUPPORTED
;
327 Set the signature algorithm list to used by the TLS object.
329 This function sets the signature algorithms for use by a specified TLS object.
331 @param[in] Tls Pointer to a TLS object.
332 @param[in] Data Array of UINT8 of signature algorithms. The array consists of
333 pairs of the hash algorithm and the signature algorithm as defined
335 @param[in] DataSize The length the SignatureAlgoList. Must be divisible by 2.
337 @retval EFI_SUCCESS The signature algorithm list was set successfully.
338 @retval EFI_INVALID_PARAMETER The parameters are invalid.
339 @retval EFI_UNSUPPORTED No supported TLS signature algorithm was found in SignatureAlgoList
340 @retval EFI_OUT_OF_RESOURCES Memory allocation failed.
345 TlsSetSignatureAlgoList (
352 return EFI_UNSUPPORTED
;
356 Set the EC curve to be used for TLS flows
358 This function sets the EC curve to be used for TLS flows.
360 @param[in] Tls Pointer to a TLS object.
361 @param[in] Data An EC named curve as defined in section 5.1.1 of RFC 4492.
362 @param[in] DataSize Size of Data, it should be sizeof (UINT32)
364 @retval EFI_SUCCESS The EC curve was set successfully.
365 @retval EFI_INVALID_PARAMETER The parameters are invalid.
366 @retval EFI_UNSUPPORTED The requested TLS EC curve is not supported
378 return EFI_UNSUPPORTED
;
382 Gets the protocol version used by the specified TLS connection.
384 This function returns the protocol version used by the specified TLS
387 If Tls is NULL, then ASSERT().
389 @param[in] Tls Pointer to the TLS object.
391 @return The protocol version of the specified TLS connection.
405 Gets the connection end of the specified TLS connection.
407 This function returns the connection end (as client or as server) used by
408 the specified TLS connection.
410 If Tls is NULL, then ASSERT().
412 @param[in] Tls Pointer to the TLS object.
414 @return The connection end used by the specified TLS connection.
419 TlsGetConnectionEnd (
428 Gets the cipher suite used by the specified TLS connection.
430 This function returns current cipher suite used by the specified
433 @param[in] Tls Pointer to the TLS object.
434 @param[in,out] CipherId The cipher suite used by the TLS object.
436 @retval EFI_SUCCESS The cipher suite was returned successfully.
437 @retval EFI_INVALID_PARAMETER The parameter is invalid.
438 @retval EFI_UNSUPPORTED Unsupported cipher suite.
443 TlsGetCurrentCipher (
445 IN OUT UINT16
*CipherId
449 return EFI_UNSUPPORTED
;
453 Gets the compression methods used by the specified TLS connection.
455 This function returns current integrated compression methods used by
456 the specified TLS connection.
458 @param[in] Tls Pointer to the TLS object.
459 @param[in,out] CompressionId The current compression method used by
462 @retval EFI_SUCCESS The compression method was returned successfully.
463 @retval EFI_INVALID_PARAMETER The parameter is invalid.
464 @retval EFI_ABORTED Invalid Compression method.
465 @retval EFI_UNSUPPORTED This function is not supported.
470 TlsGetCurrentCompressionId (
472 IN OUT UINT8
*CompressionId
476 return EFI_UNSUPPORTED
;
480 Gets the verification mode currently set in the TLS connection.
482 This function returns the peer verification mode currently set in the
483 specified TLS connection.
485 If Tls is NULL, then ASSERT().
487 @param[in] Tls Pointer to the TLS object.
489 @return The verification mode set in the specified TLS connection.
503 Gets the session ID used by the specified TLS connection.
505 This function returns the TLS/SSL session ID currently used by the
506 specified TLS connection.
508 @param[in] Tls Pointer to the TLS object.
509 @param[in,out] SessionId Buffer to contain the returned session ID.
510 @param[in,out] SessionIdLen The length of Session ID in bytes.
512 @retval EFI_SUCCESS The Session ID was returned successfully.
513 @retval EFI_INVALID_PARAMETER The parameter is invalid.
514 @retval EFI_UNSUPPORTED Invalid TLS/SSL session.
521 IN OUT UINT8
*SessionId
,
522 IN OUT UINT16
*SessionIdLen
526 return EFI_UNSUPPORTED
;
530 Gets the client random data used in the specified TLS connection.
532 This function returns the TLS/SSL client random data currently used in
533 the specified TLS connection.
535 @param[in] Tls Pointer to the TLS object.
536 @param[in,out] ClientRandom Buffer to contain the returned client
537 random data (32 bytes).
544 IN OUT UINT8
*ClientRandom
551 Gets the server random data used in the specified TLS connection.
553 This function returns the TLS/SSL server random data currently used in
554 the specified TLS connection.
556 @param[in] Tls Pointer to the TLS object.
557 @param[in,out] ServerRandom Buffer to contain the returned server
558 random data (32 bytes).
565 IN OUT UINT8
*ServerRandom
572 Gets the master key data used in the specified TLS connection.
574 This function returns the TLS/SSL master key material currently used in
575 the specified TLS connection.
577 @param[in] Tls Pointer to the TLS object.
578 @param[in,out] KeyMaterial Buffer to contain the returned key material.
580 @retval EFI_SUCCESS Key material was returned successfully.
581 @retval EFI_INVALID_PARAMETER The parameter is invalid.
582 @retval EFI_UNSUPPORTED Invalid TLS/SSL session.
589 IN OUT UINT8
*KeyMaterial
593 return EFI_UNSUPPORTED
;
597 Gets the CA Certificate from the cert store.
599 This function returns the CA certificate for the chosen
602 @param[in] Tls Pointer to the TLS object.
603 @param[out] Data Pointer to the data buffer to receive the CA
604 certificate data sent to the client.
605 @param[in,out] DataSize The size of data buffer in bytes.
607 @retval EFI_SUCCESS The operation succeeded.
608 @retval EFI_UNSUPPORTED This function is not supported.
609 @retval EFI_BUFFER_TOO_SMALL The Data is too small to hold the data.
614 TlsGetCaCertificate (
617 IN OUT UINTN
*DataSize
621 return EFI_UNSUPPORTED
;
625 Gets the local public Certificate set in the specified TLS object.
627 This function returns the local public certificate which was currently set
628 in the specified TLS object.
630 @param[in] Tls Pointer to the TLS object.
631 @param[out] Data Pointer to the data buffer to receive the local
633 @param[in,out] DataSize The size of data buffer in bytes.
635 @retval EFI_SUCCESS The operation succeeded.
636 @retval EFI_INVALID_PARAMETER The parameter is invalid.
637 @retval EFI_NOT_FOUND The certificate is not found.
638 @retval EFI_BUFFER_TOO_SMALL The Data is too small to hold the data.
643 TlsGetHostPublicCert (
646 IN OUT UINTN
*DataSize
650 return EFI_UNSUPPORTED
;
654 Gets the local private key set in the specified TLS object.
656 This function returns the local private key data which was currently set
657 in the specified TLS object.
659 @param[in] Tls Pointer to the TLS object.
660 @param[out] Data Pointer to the data buffer to receive the local
662 @param[in,out] DataSize The size of data buffer in bytes.
664 @retval EFI_SUCCESS The operation succeeded.
665 @retval EFI_UNSUPPORTED This function is not supported.
666 @retval EFI_BUFFER_TOO_SMALL The Data is too small to hold the data.
671 TlsGetHostPrivateKey (
674 IN OUT UINTN
*DataSize
678 return EFI_UNSUPPORTED
;
682 Gets the CA-supplied certificate revocation list data set in the specified
685 This function returns the CA-supplied certificate revocation list data which
686 was currently set in the specified TLS object.
688 @param[out] Data Pointer to the data buffer to receive the CRL data.
689 @param[in,out] DataSize The size of data buffer in bytes.
691 @retval EFI_SUCCESS The operation succeeded.
692 @retval EFI_UNSUPPORTED This function is not supported.
693 @retval EFI_BUFFER_TOO_SMALL The Data is too small to hold the data.
698 TlsGetCertRevocationList (
700 IN OUT UINTN
*DataSize
704 return EFI_UNSUPPORTED
;
708 Derive keying material from a TLS connection.
710 This function exports keying material using the mechanism described in RFC
713 @param[in] Tls Pointer to the TLS object
714 @param[in] Label Description of the key for the PRF function
715 @param[in] Context Optional context
716 @param[in] ContextLen The length of the context value in bytes
717 @param[out] KeyBuffer Buffer to hold the output of the TLS-PRF
718 @param[in] KeyBufferLen The length of the KeyBuffer
720 @retval EFI_SUCCESS The operation succeeded.
721 @retval EFI_INVALID_PARAMETER The TLS object is invalid.
722 @retval EFI_PROTOCOL_ERROR Some other error occurred.
729 IN CONST VOID
*Label
,
730 IN CONST VOID
*Context
,
733 IN UINTN KeyBufferLen
737 return EFI_UNSUPPORTED
;