Tls.h

Go to the documentation of this file.

 
#ifndef __EFI_TLS_PROTOCOL_H__
#define __EFI_TLS_PROTOCOL_H__
 
#define EFI_TLS_SERVICE_BINDING_PROTOCOL_GUID \
  { \
    0x952cb795, 0xff36, 0x48cf, {0xa2, 0x49, 0x4d, 0xf4, 0x86, 0xd6, 0xab, 0x8d } \
  }
 
#define EFI_TLS_PROTOCOL_GUID \
  { \
    0xca959f, 0x6cfa, 0x4db1, {0x95, 0xbc, 0xe4, 0x6c, 0x47, 0x51, 0x43, 0x90 } \
  }
 
typedef struct _EFI_TLS_PROTOCOL EFI_TLS_PROTOCOL;
 
typedef enum {
  EfiTlsVersion,
  EfiTlsConnectionEnd,
  EfiTlsCipherList,
  EfiTlsCompressionMethod,
  EfiTlsExtensionData,
  EfiTlsVerifyMethod,
  EfiTlsSessionID,
  EfiTlsSessionState,
  EfiTlsClientRandom,
  EfiTlsServerRandom,
  EfiTlsKeyMaterial,
  EfiTlsVerifyHost,
 
  EfiTlsSessionDataTypeMaximum
} EFI_TLS_SESSION_DATA_TYPE;
 
typedef struct {
  UINT8    Major;
  UINT8    Minor;
} EFI_TLS_VERSION;
 
typedef enum {
  EfiTlsClient,
  EfiTlsServer,
} EFI_TLS_CONNECTION_END;
 
#pragma pack (1)
typedef struct {
  UINT8    Data1;
  UINT8    Data2;
} EFI_TLS_CIPHER;
#pragma pack ()
 
typedef UINT8 EFI_TLS_COMPRESSION;
 
#pragma pack (1)
typedef struct {
  UINT16    ExtensionType;
  UINT16    Length;
  UINT8     Data[1];
} EFI_TLS_EXTENSION;
#pragma pack ()
 
typedef UINT32 EFI_TLS_VERIFY;
#define EFI_TLS_VERIFY_NONE  0x0
#define EFI_TLS_VERIFY_PEER  0x1
#define EFI_TLS_VERIFY_FAIL_IF_NO_PEER_CERT  0x2
#define EFI_TLS_VERIFY_CLIENT_ONCE  0x4
 
typedef UINT32 EFI_TLS_VERIFY_HOST_FLAG;
#define EFI_TLS_VERIFY_FLAG_NONE  0x00
#define EFI_TLS_VERIFY_FLAG_ALWAYS_CHECK_SUBJECT  0x01
#define EFI_TLS_VERIFY_FLAG_NO_WILDCARDS  0x02
#define EFI_TLS_VERIFY_FLAG_NO_PARTIAL_WILDCARDS  0x04
#define EFI_TLS_VERIFY_FLAG_MULTI_LABEL_WILDCARDS  0x08
#define EFI_TLS_VERIFY_FLAG_SINGLE_LABEL_SUBDOMAINS  0x10
#define EFI_TLS_VERIFY_FLAG_NEVER_CHECK_SUBJECT  0x20
 
#pragma pack (1)
typedef struct {
  EFI_TLS_VERIFY_HOST_FLAG    Flags;
  CHAR8                       *HostName;
} EFI_TLS_VERIFY_HOST;
#pragma pack ()
 
#pragma pack (1)
typedef struct {
  UINT32    GmtUnixTime;
  UINT8     RandomBytes[28];
} EFI_TLS_RANDOM;
#pragma pack ()
 
#pragma pack (1)
typedef struct {
  UINT8    Data[48];
} EFI_TLS_MASTER_SECRET;
#pragma pack ()
 
#define MAX_TLS_SESSION_ID_LENGTH  32
#pragma pack (1)
typedef struct {
  UINT16    Length;
  UINT8     Data[MAX_TLS_SESSION_ID_LENGTH];
} EFI_TLS_SESSION_ID;
#pragma pack ()
 
typedef enum {
  EfiTlsSessionNotStarted,
  EfiTlsSessionHandShaking,
  EfiTlsSessionDataTransferring,
  EfiTlsSessionClosing,
  EfiTlsSessionError,
 
  EfiTlsSessionStateMaximum
} EFI_TLS_SESSION_STATE;
 
typedef struct {
  UINT32    FragmentLength;
  VOID      *FragmentBuffer;
} EFI_TLS_FRAGMENT_DATA;
 
typedef enum {
  EfiTlsEncrypt,
  EfiTlsDecrypt,
} EFI_TLS_CRYPT_MODE;
 
typedef
EFI_STATUS
(EFIAPI *EFI_TLS_SET_SESSION_DATA)(
  IN EFI_TLS_PROTOCOL                *This,
  IN EFI_TLS_SESSION_DATA_TYPE       DataType,
  IN VOID                            *Data,
  IN UINTN                           DataSize
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_TLS_GET_SESSION_DATA)(
  IN EFI_TLS_PROTOCOL                *This,
  IN EFI_TLS_SESSION_DATA_TYPE       DataType,
  IN OUT VOID                        *Data   OPTIONAL,
  IN OUT UINTN                       *DataSize
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_TLS_BUILD_RESPONSE_PACKET)(
  IN EFI_TLS_PROTOCOL                *This,
  IN UINT8                           *RequestBuffer  OPTIONAL,
  IN UINTN                           RequestSize  OPTIONAL,
  OUT UINT8                          *Buffer  OPTIONAL,
  IN OUT UINTN                       *BufferSize
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_TLS_PROCESS_PACKET)(
  IN EFI_TLS_PROTOCOL                *This,
  IN OUT EFI_TLS_FRAGMENT_DATA       **FragmentTable,
  IN UINT32                          *FragmentCount,
  IN EFI_TLS_CRYPT_MODE              CryptMode
  );
 
struct _EFI_TLS_PROTOCOL {
  EFI_TLS_SET_SESSION_DATA         SetSessionData;
  EFI_TLS_GET_SESSION_DATA         GetSessionData;
  EFI_TLS_BUILD_RESPONSE_PACKET    BuildResponsePacket;
  EFI_TLS_PROCESS_PACKET           ProcessPacket;
};
 
extern EFI_GUID  gEfiTlsServiceBindingProtocolGuid;
extern EFI_GUID  gEfiTlsProtocolGuid;
 
#endif // __EFI_TLS_PROTOCOL_H__