TlsProtocol.c File Reference

#include "TlsImpl.h"

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	TlsSetSessionData (IN EFI_TLS_PROTOCOL *This, IN EFI_TLS_SESSION_DATA_TYPE DataType, IN VOID *Data, IN UINTN DataSize)
EFI_STATUS EFIAPI	TlsGetSessionData (IN EFI_TLS_PROTOCOL *This, IN EFI_TLS_SESSION_DATA_TYPE DataType, IN OUT VOID *Data OPTIONAL, IN OUT UINTN *DataSize)
EFI_STATUS EFIAPI	TlsBuildResponsePacket (IN EFI_TLS_PROTOCOL *This, IN UINT8 *RequestBuffer OPTIONAL, IN UINTN RequestSize OPTIONAL, OUT UINT8 *Buffer OPTIONAL, IN OUT UINTN *BufferSize)
EFI_STATUS EFIAPI	TlsProcessPacket (IN EFI_TLS_PROTOCOL *This, IN OUT EFI_TLS_FRAGMENT_DATA **FragmentTable, IN UINT32 *FragmentCount, IN EFI_TLS_CRYPT_MODE CryptMode)

Variables
EFI_TLS_PROTOCOL	mTlsProtocol

Detailed Description

Implementation of EFI TLS Protocol Interfaces.

Copyright (c) 2016 - 2018, Intel Corporation. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file TlsProtocol.c.

Function Documentation

TlsBuildResponsePacket()

EFI_STATUS EFIAPI TlsBuildResponsePacket	(	IN EFI_TLS_PROTOCOL *	This,
		IN UINT8 *RequestBuffer	OPTIONAL,
		IN UINTN RequestSize	OPTIONAL,
		OUT UINT8 *Buffer	OPTIONAL,
		IN OUT UINTN *	BufferSize
	)

Build response packet according to TLS state machine. This function is only valid for alert, handshake and change_cipher_spec content type.

The BuildResponsePacket() function builds TLS response packet in response to the TLS request packet specified by RequestBuffer and RequestSize. If RequestBuffer is NULL and RequestSize is 0, and TLS session status is EfiTlsSessionNotStarted, the TLS session will be initiated and the response packet needs to be ClientHello. If RequestBuffer is NULL and RequestSize is 0, and TLS session status is EfiTlsSessionClosing, the TLS session will be closed and response packet needs to be CloseNotify. If RequestBuffer is NULL and RequestSize is 0, and TLS session status is EfiTlsSessionError, the TLS session has errors and the response packet needs to be Alert message based on error type.

Parameters

[in]	This	Pointer to the EFI_TLS_PROTOCOL instance.
[in]	RequestBuffer	Pointer to the most recently received TLS packet. NULL means TLS need initiate the TLS session and response packet need to be ClientHello.
[in]	RequestSize	Packet size in bytes for the most recently received TLS packet. 0 is only valid when RequestBuffer is NULL.
[out]	Buffer	Pointer to the buffer to hold the built packet.
[in,out]	BufferSize	Pointer to the buffer size in bytes. On input, it is the buffer size provided by the caller. On output, it is the buffer size in fact needed to contain the packet.

Return values

EFI_SUCCESS	The required TLS packet is built successfully.
EFI_INVALID_PARAMETER	One or more of the following conditions is TRUE: This is NULL. RequestBuffer is NULL but RequestSize is NOT 0. RequestSize is 0 but RequestBuffer is NOT NULL. BufferSize is NULL. Buffer is NULL if *BufferSize is not zero.
EFI_BUFFER_TOO_SMALL	BufferSize is too small to hold the response packet.
EFI_NOT_READY	Current TLS session state is NOT ready to build ResponsePacket.
EFI_ABORTED	Something wrong build response packet.

Definition at line 458 of file TlsProtocol.c.

TlsGetSessionData()

EFI_STATUS EFIAPI TlsGetSessionData	(	IN EFI_TLS_PROTOCOL *	This,
		IN EFI_TLS_SESSION_DATA_TYPE	DataType,
		IN OUT VOID *Data	OPTIONAL,
		IN OUT UINTN *	DataSize
	)

Get TLS session data.

The GetSessionData() function return the TLS session information.

Parameters

[in]	This	Pointer to the EFI_TLS_PROTOCOL instance.
[in]	DataType	TLS session data type.
[in,out]	Data	Pointer to session data.
[in,out]	DataSize	Total size of session data. On input, it means the size of Data buffer. On output, it means the size of copied Data buffer if EFI_SUCCESS, and means the size of desired Data buffer if EFI_BUFFER_TOO_SMALL.

Return values

EFI_SUCCESS	The TLS session data is got successfully.
EFI_INVALID_PARAMETER	One or more of the following conditions is TRUE: This is NULL. DataSize is NULL. Data is NULL if *DataSize is not zero.
EFI_UNSUPPORTED	The DataType is unsupported.
EFI_NOT_FOUND	The TLS session data is not found.
EFI_NOT_READY	The DataType is not ready in current session state.
EFI_BUFFER_TOO_SMALL	The buffer is too small to hold the data.

Definition at line 261 of file TlsProtocol.c.

TlsProcessPacket()

EFI_STATUS EFIAPI TlsProcessPacket	(	IN EFI_TLS_PROTOCOL *	This,
		IN OUT EFI_TLS_FRAGMENT_DATA **	FragmentTable,
		IN UINT32 *	FragmentCount,
		IN EFI_TLS_CRYPT_MODE	CryptMode
	)

Decrypt or encrypt TLS packet during session. This function is only valid after session connected and for application_data content type.

The ProcessPacket () function process each inbound or outbound TLS APP packet.

Parameters

[in]	This	Pointer to the EFI_TLS_PROTOCOL instance.
[in,out]	FragmentTable	Pointer to a list of fragment. The caller will take responsible to handle the original FragmentTable while it may be reallocated in TLS driver. If CryptMode is EfiTlsEncrypt, on input these fragments contain the TLS header and plain text TLS APP payload; on output these fragments contain the TLS header and cipher text TLS APP payload. If CryptMode is EfiTlsDecrypt, on input these fragments contain the TLS header and cipher text TLS APP payload; on output these fragments contain the TLS header and plain text TLS APP payload.
[in]	FragmentCount	Number of fragment.
[in]	CryptMode	Crypt mode.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_INVALID_PARAMETER	One or more of the following conditions is TRUE: This is NULL. FragmentTable is NULL. FragmentCount is NULL. CryptoMode is invalid.
EFI_NOT_READY	Current TLS session state is NOT EfiTlsSessionDataTransferring.
EFI_ABORTED	Something wrong decryption the message. TLS session status will become EfiTlsSessionError. The caller need call BuildResponsePacket() to generate Error Alert message and send it out.
EFI_OUT_OF_RESOURCES	No enough resource to finish the operation.

Definition at line 643 of file TlsProtocol.c.

TlsSetSessionData()

EFI_STATUS EFIAPI TlsSetSessionData	(	IN EFI_TLS_PROTOCOL *	This,
		IN EFI_TLS_SESSION_DATA_TYPE	DataType,
		IN VOID *	Data,
		IN UINTN	DataSize
	)

Set TLS session data.

The SetSessionData() function set data for a new TLS session. All session data should be set before BuildResponsePacket() invoked.

Parameters

[in]	This	Pointer to the EFI_TLS_PROTOCOL instance.
[in]	DataType	TLS session data type.
[in]	Data	Pointer to session data.
[in]	DataSize	Total size of session data.

Return values

EFI_SUCCESS	The TLS session data is set successfully.
EFI_INVALID_PARAMETER	One or more of the following conditions is TRUE: This is NULL. Data is NULL. DataSize is 0. DataSize is invalid for DataType.
EFI_UNSUPPORTED	The DataType is unsupported.
EFI_ACCESS_DENIED	If the DataType is one of below: EfiTlsClientRandom EfiTlsServerRandom EfiTlsKeyMaterial
EFI_NOT_READY	Current TLS session state is NOT EfiTlsSessionStateNotStarted.
EFI_OUT_OF_RESOURCES	Required system resources could not be allocated.

Definition at line 47 of file TlsProtocol.c.

Variable Documentation

mTlsProtocol

EFI_TLS_PROTOCOL mTlsProtocol

Initial value:

= {
  TlsSetSessionData,
  TlsGetSessionData,
  TlsBuildResponsePacket,
  TlsProcessPacket
}

Definition at line 12 of file TlsProtocol.c.