EapConfiguration.h File Reference

Data Structures
struct	_EFI_EAP_CONFIGURATION_PROTOCOL

Macros
#define	EFI_EAP_CONFIGURATION_PROTOCOL_GUID
#define	EFI_EAP_TYPE_ATTRIBUTE   0
#define	EFI_EAP_TYPE_ATTRIBUTE   0
#define	EFI_EAP_TYPE_IDENTITY   1
#define	EFI_EAP_TYPE_NOTIFICATION   2
#define	EFI_EAP_TYPE_NAK   3
#define	EFI_EAP_TYPE_MD5CHALLENGE   4
#define	EFI_EAP_TYPE_OTP   5
#define	EFI_EAP_TYPE_GTC   6
#define	EFI_EAP_TYPE_EAPTLS   13
#define	EFI_EAP_TYPE_EAPSIM   18
#define	EFI_EAP_TYPE_TTLS   21
#define	EFI_EAP_TYPE_PEAP   25
#define	EFI_EAP_TYPE_MSCHAPV2   26
#define	EFI_EAP_TYPE_EAP_EXTENSION   33

Typedefs
typedef struct _EFI_EAP_CONFIGURATION_PROTOCOL	EFI_EAP_CONFIGURATION_PROTOCOL
typedef UINT8	EFI_EAP_TYPE
typedef IN EFI_EAP_TYPE	EapType
typedef IN EFI_EAP_TYPE IN EFI_EAP_CONFIG_DATA_TYPE	DataType
typedef IN EFI_EAP_TYPE IN EFI_EAP_CONFIG_DATA_TYPE IN VOID *	Data
typedef IN EFI_EAP_TYPE IN EFI_EAP_CONFIG_DATA_TYPE IN VOID IN UINTN	DataSize

Enumerations
enum	EFI_EAP_CONFIG_DATA_TYPE {   EfiEapConfigEapAuthMethod, EfiEapConfigEapSupportedAuthMethod, EfiEapConfigIdentityString, EfiEapConfigEapTlsCACert,   EfiEapConfigEapTlsClientCert, EfiEapConfigEapTlsClientPrivateKeyFile, EfiEapConfigEapTlsClientPrivateKeyFilePassword, EfiEapConfigEapTlsCipherSuite,   EfiEapConfigEapTlsSupportedCipherSuite, EfiEapConfigEapMSChapV2Password, EfiEapConfigEap2ndAuthMethod }

Functions
typedef	EFI_STATUS (EFIAPI *EFI_EAP_CONFIGURATION_SET_DATA)(IN EFI_EAP_CONFIGURATION_PROTOCOL *This

Variables
EFI_GUID	gEfiEapConfigurationProtocolGuid

Detailed Description

This file defines the EFI EAP Configuration protocol.

Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Revision Reference:

This Protocol is introduced in UEFI Specification 2.5

Macro Definition Documentation

#define EFI_EAP_CONFIGURATION_PROTOCOL_GUID

Value:

{ \
    0xe5b58dbb, 0x7688, 0x44b4, {0x97, 0xbf, 0x5f, 0x1d, 0x4b, 0x7c, 0xc8, 0xdb } \
  }

EFI EAP Configuration protocol provides a way to set and get EAP configuration.

#define EFI_EAP_TYPE_ATTRIBUTE   0

Make sure it not conflict with any real EapTypeXXX

#define EFI_EAP_TYPE_ATTRIBUTE   0

Make sure it not conflict with any real EapTypeXXX

#define EFI_EAP_TYPE_EAP_EXTENSION   33

#define EFI_EAP_TYPE_EAPSIM   18

#define EFI_EAP_TYPE_EAPTLS   13

#define EFI_EAP_TYPE_GTC   6

#define EFI_EAP_TYPE_IDENTITY   1

#define EFI_EAP_TYPE_MD5CHALLENGE   4

#define EFI_EAP_TYPE_MSCHAPV2   26

#define EFI_EAP_TYPE_NAK   3

#define EFI_EAP_TYPE_NOTIFICATION   2

#define EFI_EAP_TYPE_OTP   5

#define EFI_EAP_TYPE_PEAP   25

#define EFI_EAP_TYPE_TTLS   21

Typedef Documentation

typedef IN EFI_EAP_TYPE IN EFI_EAP_CONFIG_DATA_TYPE IN OUT VOID* Data

typedef IN EFI_EAP_TYPE IN EFI_EAP_CONFIG_DATA_TYPE IN OUT VOID IN OUT UINTN* DataSize

typedef IN EFI_EAP_TYPE IN EFI_EAP_CONFIG_DATA_TYPE DataType

typedef IN EFI_EAP_TYPE EapType

typedef struct _EFI_EAP_CONFIGURATION_PROTOCOL EFI_EAP_CONFIGURATION_PROTOCOL

typedef UINT8 EFI_EAP_TYPE

EFI_EAP_TYPE

Enumeration Type Documentation

enum EFI_EAP_CONFIG_DATA_TYPE

Enumerator
EfiEapConfigEapAuthMethod	EFI_EAP_TYPE_ATTRIBUTE
EfiEapConfigEapSupportedAuthMethod
EfiEapConfigIdentityString	EapTypeIdentity
EfiEapConfigEapTlsCACert	EapTypeEAPTLS/EapTypePEAP
EfiEapConfigEapTlsClientCert
EfiEapConfigEapTlsClientPrivateKeyFile
EfiEapConfigEapTlsClientPrivateKeyFilePassword
EfiEapConfigEapTlsCipherSuite
EfiEapConfigEapTlsSupportedCipherSuite
EfiEapConfigEapMSChapV2Password	EapTypeMSChapV2
EfiEapConfigEap2ndAuthMethod	EapTypePEAP

Function Documentation

typedef EFI_STATUS

(

EFIAPI *

EFI_EAP_CONFIGURATION_GET_DATA

)

Set EAP configuration data.

The SetData() function sets EAP configuration to non-volatile storage or volatile storage.

Parameters

[in]	This	Pointer to the EFI_EAP_CONFIGURATION_PROTOCOL instance.
[in]	EapType	EAP type.
[in]	DataType	Configuration data type.
[in]	Data	Pointer to configuration data.
[in]	DataSize	Total size of configuration data.

Return values

EFI_SUCCESS	The EAP configuration data is set successfully.
EFI_INVALID_PARAMETER	One or more of the following conditions is TRUE: Data is NULL. DataSize is 0.
EFI_UNSUPPORTED	The EapType or DataType is unsupported.
EFI_OUT_OF_RESOURCES	Required system resources could not be allocated.

Get EAP configuration data.

The GetData() function gets EAP configuration.

Parameters

[in]	This	Pointer to the EFI_EAP_CONFIGURATION_PROTOCOL instance.
[in]	EapType	EAP type.
[in]	DataType	Configuration data type.
[in,out]	Data	Pointer to configuration data.
[in,out]	DataSize	Total size of configuration 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 EAP configuration data is got successfully.
EFI_INVALID_PARAMETER	One or more of the following conditions is TRUE: Data is NULL. DataSize is NULL.
EFI_UNSUPPORTED	The EapType or DataType is unsupported.
EFI_NOT_FOUND	The EAP configuration data is not found.
EFI_BUFFER_TOO_SMALL	The buffer is too small to hold the buffer.

Variable Documentation

EFI_GUID gEfiEapConfigurationProtocolGuid