MdePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdePkg / Include / Protocol / Tls.h

/** @file\r
  EFI TLS Protocols as defined in UEFI 2.5.\r
\r
  The EFI TLS Service Binding Protocol is used to locate EFI TLS Protocol drivers\r
  to create and destroy child of the driver to communicate with other host using\r
  TLS protocol.\r
  The EFI TLS Protocol provides the ability to manage TLS session.\r
\r
  Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Revision Reference:\r
  This Protocol is introduced in UEFI Specification 2.5\r
\r
**/\r
\r
#ifndef __EFI_TLS_PROTOCOL_H__\r
#define __EFI_TLS_PROTOCOL_H__\r
\r
///\r
/// The EFI TLS Service Binding Protocol is used to locate EFI TLS Protocol drivers to\r
/// create and destroy child of the driver to communicate with other host using TLS\r
/// protocol.\r
///\r
#define EFI_TLS_SERVICE_BINDING_PROTOCOL_GUID \\r
  { \\r
    0x952cb795, 0xff36, 0x48cf, {0xa2, 0x49, 0x4d, 0xf4, 0x86, 0xd6, 0xab, 0x8d } \\r
  }\r
\r
///\r
/// The EFI TLS protocol provides the ability to manage TLS session.\r
///\r
#define EFI_TLS_PROTOCOL_GUID \\r
  { \\r
    0xca959f, 0x6cfa, 0x4db1, {0x95, 0xbc, 0xe4, 0x6c, 0x47, 0x51, 0x43, 0x90 } \\r
  }\r
\r
typedef struct _EFI_TLS_PROTOCOL EFI_TLS_PROTOCOL;\r
\r
///\r
/// EFI_TLS_SESSION_DATA_TYPE\r
///\r
typedef enum {\r
  ///\r
  /// Session Configuration\r
  ///\r
\r
  ///\r
  /// TLS session Version. The corresponding Data is of type EFI_TLS_VERSION.\r
  ///\r
  EfiTlsVersion,\r
  ///\r
  /// TLS session as client or as server. The corresponding Data is of\r
  /// EFI_TLS_CONNECTION_END.\r
  ///\r
  EfiTlsConnectionEnd,\r
  ///\r
  /// A priority list of preferred algorithms for the TLS session.\r
  /// The corresponding Data is a list of EFI_TLS_CIPHER.\r
  ///\r
  EfiTlsCipherList,\r
  ///\r
  /// TLS session compression method.\r
  /// The corresponding Data is of type EFI_TLS_COMPRESSION.\r
  ///\r
  EfiTlsCompressionMethod,\r
  ///\r
  /// TLS session extension data.\r
  /// The corresponding Data is a list of type EFI_TLS_EXTENSION .\r
  ///\r
  EfiTlsExtensionData,\r
  ///\r
  /// TLS session verify method.\r
  /// The corresponding Data is of type EFI_TLS_VERIFY.\r
  ///\r
  EfiTlsVerifyMethod,\r
  ///\r
  /// TLS session data session ID.\r
  /// For SetSessionData(), it is TLS session ID used for session resumption.\r
  /// For GetSessionData(), it is the TLS session ID used for current session.\r
  /// The corresponding Data is of type EFI_TLS_SESSION_ID.\r
  ///\r
  EfiTlsSessionID,\r
  ///\r
  /// TLS session data session state.\r
  /// The corresponding Data is of type EFI_TLS_SESSION_STATE.\r
  ///\r
  EfiTlsSessionState,\r
\r
  ///\r
  /// Session information\r
  ///\r
\r
  ///\r
  /// TLS session data client random.\r
  /// The corresponding Data is of type EFI_TLS_RANDOM.\r
  ///\r
  EfiTlsClientRandom,\r
  ///\r
  /// TLS session data server random.\r
  /// The corresponding Data is of type EFI_TLS_RANDOM.\r
  ///\r
  EfiTlsServerRandom,\r
  ///\r
  /// TLS session data key material.\r
  /// The corresponding Data is of type EFI_TLS_MASTER_SECRET.\r
  ///\r
  EfiTlsKeyMaterial,\r
\r
  EfiTlsSessionDataTypeMaximum\r
\r
} EFI_TLS_SESSION_DATA_TYPE;\r
\r
///\r
/// EFI_TLS_VERSION\r
/// Note: The TLS version definition is from SSL3.0 to the latest TLS (e.g. 1.2).\r
///       SSL2.0 is obsolete and should not be used.\r
///\r
typedef struct {\r
  UINT8                         Major;\r
  UINT8                         Minor;\r
} EFI_TLS_VERSION;\r
\r
///\r
/// EFI_TLS_CONNECTION_END to define TLS session as client or server.\r
///\r
typedef enum {\r
  EfiTlsClient,\r
  EfiTlsServer,\r
} EFI_TLS_CONNECTION_END;\r
\r
///\r
/// EFI_TLS_CIPHER\r
/// Note: The definition of EFI_TLS_CIPHER definition is from "RFC 5246, A.4.1.\r
///       Hello Messages". The value of EFI_TLS_CIPHER is from TLS Cipher\r
///       Suite Registry of IANA.\r
///\r
#pragma pack (1)\r
typedef struct {\r
  UINT8                         Data1;\r
  UINT8                         Data2;\r
} EFI_TLS_CIPHER;\r
#pragma pack ()\r
\r
///\r
/// EFI_TLS_COMPRESSION\r
/// Note: The value of EFI_TLS_COMPRESSION definition is from "RFC 3749".\r
///\r
typedef UINT8 EFI_TLS_COMPRESSION;\r
\r
///\r
/// EFI_TLS_EXTENSION\r
/// Note: The definition of EFI_TLS_EXTENSION if from "RFC 5246 A.4.1.\r
///       Hello Messages".\r
///\r
#pragma pack (1)\r
typedef struct {\r
  UINT16                        ExtensionType;\r
  UINT16                        Length;\r
  UINT8                         Data[1];\r
} EFI_TLS_EXTENSION;\r
#pragma pack ()\r
\r
///\r
/// EFI_TLS_VERIFY\r
/// Use either EFI_TLS_VERIFY_NONE or EFI_TLS_VERIFY_PEER, the last two options\r
/// are 'ORed' with EFI_TLS_VERIFY_PEER if they are desired.\r
///\r
typedef UINT32  EFI_TLS_VERIFY;\r
///\r
/// No certificates will be sent or the TLS/SSL handshake will be continued regardless\r
/// of the certificate verification result.\r
///\r
#define EFI_TLS_VERIFY_NONE                  0x0\r
///\r
/// The TLS/SSL handshake is immediately terminated with an alert message containing\r
/// the reason for the certificate verification failure.\r
///\r
#define EFI_TLS_VERIFY_PEER                  0x1\r
///\r
/// TLS session will fail peer certificate is absent.\r
///\r
#define EFI_TLS_VERIFY_FAIL_IF_NO_PEER_CERT  0x2\r
///\r
/// TLS session only verify client once, and doesn't request certificate during\r
/// re-negotiation.\r
///\r
#define EFI_TLS_VERIFY_CLIENT_ONCE           0x4\r
\r
///\r
/// EFI_TLS_RANDOM\r
/// Note: The definition of EFI_TLS_RANDOM is from "RFC 5246 A.4.1.\r
///       Hello Messages".\r
///\r
#pragma pack (1)\r
typedef struct {\r
  UINT32                        GmtUnixTime;\r
  UINT8                         RandomBytes[28];\r
} EFI_TLS_RANDOM;\r
#pragma pack ()\r
\r
///\r
/// EFI_TLS_MASTER_SECRET\r
/// Note: The definition of EFI_TLS_MASTER_SECRET is from "RFC 5246 8.1.\r
///       Computing the Master Secret".\r
///\r
#pragma pack (1)\r
typedef struct {\r
  UINT8                         Data[48];\r
} EFI_TLS_MASTER_SECRET;\r
#pragma pack ()\r
\r
///\r
/// EFI_TLS_SESSION_ID\r
/// Note: The definition of EFI_TLS_SESSION_ID is from "RFC 5246 A.4.1. Hello Messages".\r
///\r
#define MAX_TLS_SESSION_ID_LENGTH  32\r
#pragma pack (1)\r
typedef struct {\r
  UINT16                        Length;\r
  UINT8                         Data[MAX_TLS_SESSION_ID_LENGTH];\r
} EFI_TLS_SESSION_ID;\r
#pragma pack ()\r
\r
///\r
/// EFI_TLS_SESSION_STATE\r
///\r
typedef enum {\r
  ///\r
  /// When a new child of TLS protocol is created, the initial state of TLS session\r
  /// is EfiTlsSessionNotStarted.\r
  ///\r
  EfiTlsSessionNotStarted,\r
  ///\r
  /// The consumer can call BuildResponsePacket() with NULL to get ClientHello to\r
  /// start the TLS session. Then the status is EfiTlsSessionHandShaking.\r
  ///\r
  EfiTlsSessionHandShaking,\r
  ///\r
  /// During handshake, the consumer need call BuildResponsePacket() with input\r
  /// data from peer, then get response packet and send to peer. After handshake\r
  /// finish, the TLS session status becomes EfiTlsSessionDataTransferring, and\r
  /// consumer can use ProcessPacket() for data transferring.\r
  ///\r
  EfiTlsSessionDataTransferring,\r
  ///\r
  /// Finally, if consumer wants to active close TLS session, consumer need\r
  /// call SetSessionData to set TLS session state to EfiTlsSessionClosing, and\r
  /// call BuildResponsePacket() with NULL to get CloseNotify alert message,\r
  /// and sent it out.\r
  ///\r
  EfiTlsSessionClosing,\r
  ///\r
  /// If any error happen during parsing ApplicationData content type, EFI_ABORT\r
  /// will be returned by ProcessPacket(), and TLS session state will become\r
  /// EfiTlsSessionError. Then consumer need call BuildResponsePacket() with\r
  /// NULL to get alert message and sent it out.\r
  ///\r
  EfiTlsSessionError,\r
\r
  EfiTlsSessionStateMaximum\r
\r
} EFI_TLS_SESSION_STATE;\r
\r
///\r
/// EFI_TLS_FRAGMENT_DATA\r
///\r
typedef struct {\r
  ///\r
  /// Length of data buffer in the fragment.\r
  ///\r
  UINT32                        FragmentLength;\r
  ///\r
  /// Pointer to the data buffer in the fragment.\r
  ///\r
  VOID                          *FragmentBuffer;\r
} EFI_TLS_FRAGMENT_DATA;\r
\r
///\r
/// EFI_TLS_CRYPT_MODE\r
///\r
typedef enum {\r
  ///\r
  /// Encrypt data provided in the fragment buffers.\r
  ///\r
  EfiTlsEncrypt,\r
  ///\r
  /// Decrypt data provided in the fragment buffers.\r
  ///\r
  EfiTlsDecrypt,\r
} EFI_TLS_CRYPT_MODE;\r
\r
/**\r
  Set TLS session data.\r
\r
  The SetSessionData() function set data for a new TLS session. All session data should\r
  be set before BuildResponsePacket() invoked.\r
\r
  @param[in]  This                Pointer to the EFI_TLS_PROTOCOL instance.\r
  @param[in]  DataType            TLS session data type.\r
  @param[in]  Data                Pointer to session data.\r
  @param[in]  DataSize            Total size of session data.\r
\r
  @retval EFI_SUCCESS             The TLS session data is set successfully.\r
  @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:\r
                                  This is NULL.\r
                                  Data is NULL.\r
                                  DataSize is 0.\r
  @retval EFI_UNSUPPORTED         The DataType is unsupported.\r
  @retval EFI_ACCESS_DENIED       If the DataType is one of below:\r
                                  EfiTlsClientRandom\r
                                  EfiTlsServerRandom\r
                                  EfiTlsKeyMaterial\r
  @retval EFI_NOT_READY           Current TLS session state is NOT\r
                                  EfiTlsSessionStateNotStarted.\r
  @retval EFI_OUT_OF_RESOURCES    Required system resources could not be allocated.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TLS_SET_SESSION_DATA) (\r
  IN EFI_TLS_PROTOCOL                *This,\r
  IN EFI_TLS_SESSION_DATA_TYPE       DataType,\r
  IN VOID                            *Data,\r
  IN UINTN                           DataSize\r
  );\r
\r
/**\r
  Get TLS session data.\r
\r
  The GetSessionData() function return the TLS session information.\r
\r
  @param[in]       This           Pointer to the EFI_TLS_PROTOCOL instance.\r
  @param[in]       DataType       TLS session data type.\r
  @param[in, out]  Data           Pointer to session data.\r
  @param[in, out]  DataSize       Total size of session data. On input, it means\r
                                  the size of Data buffer. On output, it means the size\r
                                  of copied Data buffer if EFI_SUCCESS, and means the\r
                                  size of desired Data buffer if EFI_BUFFER_TOO_SMALL.\r
\r
  @retval EFI_SUCCESS             The TLS session data is got successfully.\r
  @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:\r
                                  This is NULL.\r
                                  DataSize is NULL.\r
                                  Data is NULL if *DataSize is not zero.\r
  @retval EFI_UNSUPPORTED         The DataType is unsupported.\r
  @retval EFI_NOT_FOUND           The TLS session data is not found.\r
  @retval EFI_NOT_READY           The DataType is not ready in current session state.\r
  @retval EFI_BUFFER_TOO_SMALL    The buffer is too small to hold the data.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TLS_GET_SESSION_DATA) (\r
  IN EFI_TLS_PROTOCOL                *This,\r
  IN EFI_TLS_SESSION_DATA_TYPE       DataType,\r
  IN OUT VOID                        *Data,  OPTIONAL\r
  IN OUT UINTN                       *DataSize\r
  );\r
\r
/**\r
  Build response packet according to TLS state machine. This function is only valid for\r
  alert, handshake and change_cipher_spec content type.\r
\r
  The BuildResponsePacket() function builds TLS response packet in response to the TLS\r
  request packet specified by RequestBuffer and RequestSize. If RequestBuffer is NULL and\r
  RequestSize is 0, and TLS session status is EfiTlsSessionNotStarted, the TLS session\r
  will be initiated and the response packet needs to be ClientHello. If RequestBuffer is\r
  NULL and RequestSize is 0, and TLS session status is EfiTlsSessionClosing, the TLS\r
  session will be closed and response packet needs to be CloseNotify. If RequestBuffer is\r
  NULL and RequestSize is 0, and TLS session status is EfiTlsSessionError, the TLS\r
  session has errors and the response packet needs to be Alert message based on error\r
  type.\r
\r
  @param[in]       This           Pointer to the EFI_TLS_PROTOCOL instance.\r
  @param[in]       RequestBuffer  Pointer to the most recently received TLS packet. NULL\r
                                  means TLS need initiate the TLS session and response\r
                                  packet need to be ClientHello.\r
  @param[in]       RequestSize    Packet size in bytes for the most recently received TLS\r
                                  packet. 0 is only valid when RequestBuffer is NULL.\r
  @param[out]      Buffer         Pointer to the buffer to hold the built packet.\r
  @param[in, out]  BufferSize     Pointer to the buffer size in bytes. On input, it is\r
                                  the buffer size provided by the caller. On output, it\r
                                  is the buffer size in fact needed to contain the\r
                                  packet.\r
\r
  @retval EFI_SUCCESS             The required TLS packet is built successfully.\r
  @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:\r
                                  This is NULL.\r
                                  RequestBuffer is NULL but RequestSize is NOT 0.\r
                                  RequestSize is 0 but RequestBuffer is NOT NULL.\r
                                  BufferSize is NULL.\r
                                  Buffer is NULL if *BufferSize is not zero.\r
  @retval EFI_BUFFER_TOO_SMALL    BufferSize is too small to hold the response packet.\r
  @retval EFI_NOT_READY           Current TLS session state is NOT ready to build\r
                                  ResponsePacket.\r
  @retval EFI_ABORTED             Something wrong build response packet.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TLS_BUILD_RESPONSE_PACKET) (\r
  IN EFI_TLS_PROTOCOL                *This,\r
  IN UINT8                           *RequestBuffer, OPTIONAL\r
  IN UINTN                           RequestSize, OPTIONAL\r
  OUT UINT8                          *Buffer, OPTIONAL\r
  IN OUT UINTN                       *BufferSize\r
  );\r
\r
/**\r
  Decrypt or encrypt TLS packet during session. This function is only valid after\r
  session connected and for application_data content type.\r
\r
  The ProcessPacket () function process each inbound or outbound TLS APP packet.\r
\r
  @param[in]       This           Pointer to the EFI_TLS_PROTOCOL instance.\r
  @param[in, out]  FragmentTable  Pointer to a list of fragment. The caller will take\r
                                  responsible to handle the original FragmentTable while\r
                                  it may be reallocated in TLS driver. If CryptMode is\r
                                  EfiTlsEncrypt, on input these fragments contain the TLS\r
                                  header and plain text TLS APP payload; on output these\r
                                  fragments contain the TLS header and cipher text TLS\r
                                  APP payload. If CryptMode is EfiTlsDecrypt, on input\r
                                  these fragments contain the TLS header and cipher text\r
                                  TLS APP payload; on output these fragments contain the\r
                                  TLS header and plain text TLS APP payload.\r
  @param[in]       FragmentCount  Number of fragment.\r
  @param[in]       CryptMode      Crypt mode.\r
\r
  @retval EFI_SUCCESS             The operation completed successfully.\r
  @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:\r
                                  This is NULL.\r
                                  FragmentTable is NULL.\r
                                  FragmentCount is NULL.\r
                                  CryptoMode is invalid.\r
  @retval EFI_NOT_READY           Current TLS session state is NOT\r
                                  EfiTlsSessionDataTransferring.\r
  @retval EFI_ABORTED             Something wrong decryption the message. TLS session\r
                                  status will become EfiTlsSessionError. The caller need\r
                                  call BuildResponsePacket() to generate Error Alert\r
                                  message and send it out.\r
  @retval EFI_OUT_OF_RESOURCES    No enough resource to finish the operation.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_TLS_PROCESS_PACKET) (\r
  IN EFI_TLS_PROTOCOL                *This,\r
  IN OUT EFI_TLS_FRAGMENT_DATA       **FragmentTable,\r
  IN UINT32                          *FragmentCount,\r
  IN EFI_TLS_CRYPT_MODE              CryptMode\r
  );\r
\r
///\r
/// The EFI_TLS_PROTOCOL is used to create, destroy and manage TLS session.\r
/// For detail of TLS, please refer to TLS related RFC.\r
///\r
struct _EFI_TLS_PROTOCOL {\r
  EFI_TLS_SET_SESSION_DATA           SetSessionData;\r
  EFI_TLS_GET_SESSION_DATA           GetSessionData;\r
  EFI_TLS_BUILD_RESPONSE_PACKET      BuildResponsePacket;\r
  EFI_TLS_PROCESS_PACKET             ProcessPacket;\r
};\r
\r
extern EFI_GUID gEfiTlsServiceBindingProtocolGuid;\r
extern EFI_GUID gEfiTlsProtocolGuid;\r
\r
#endif  // __EFI_TLS_PROTOCOL_H__\r
\r