TianoCore EDK2 master
EapConfiguration.h File Reference

Go to the source code of this file.

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 EFI_STATUS(EFIAPIEFI_EAP_CONFIGURATION_SET_DATA) (IN EFI_EAP_CONFIGURATION_PROTOCOL *This, IN EFI_EAP_TYPE EapType, IN EFI_EAP_CONFIG_DATA_TYPE DataType, IN VOID *Data, IN UINTN DataSize)
 
typedef EFI_STATUS(EFIAPIEFI_EAP_CONFIGURATION_GET_DATA) (IN EFI_EAP_CONFIGURATION_PROTOCOL *This, IN EFI_EAP_TYPE EapType, IN EFI_EAP_CONFIG_DATA_TYPE DataType, IN OUT VOID *Data, IN OUT UINTN *DataSize)
 

Enumerations

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

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

Definition in file EapConfiguration.h.

Macro Definition Documentation

◆ EFI_EAP_CONFIGURATION_PROTOCOL_GUID

#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.

Definition at line 18 of file EapConfiguration.h.

◆ EFI_EAP_TYPE_ATTRIBUTE [1/2]

#define EFI_EAP_TYPE_ATTRIBUTE   0

Make sure it not conflict with any real EapTypeXXX

Definition at line 66 of file EapConfiguration.h.

◆ EFI_EAP_TYPE_ATTRIBUTE [2/2]

#define EFI_EAP_TYPE_ATTRIBUTE   0

Make sure it not conflict with any real EapTypeXXX

Definition at line 66 of file EapConfiguration.h.

◆ EFI_EAP_TYPE_EAP_EXTENSION

#define EFI_EAP_TYPE_EAP_EXTENSION   33

Definition at line 78 of file EapConfiguration.h.

◆ EFI_EAP_TYPE_EAPSIM

#define EFI_EAP_TYPE_EAPSIM   18

Definition at line 74 of file EapConfiguration.h.

◆ EFI_EAP_TYPE_EAPTLS

#define EFI_EAP_TYPE_EAPTLS   13

Definition at line 73 of file EapConfiguration.h.

◆ EFI_EAP_TYPE_GTC

#define EFI_EAP_TYPE_GTC   6

Definition at line 72 of file EapConfiguration.h.

◆ EFI_EAP_TYPE_IDENTITY

#define EFI_EAP_TYPE_IDENTITY   1

Definition at line 67 of file EapConfiguration.h.

◆ EFI_EAP_TYPE_MD5CHALLENGE

#define EFI_EAP_TYPE_MD5CHALLENGE   4

Definition at line 70 of file EapConfiguration.h.

◆ EFI_EAP_TYPE_MSCHAPV2

#define EFI_EAP_TYPE_MSCHAPV2   26

Definition at line 77 of file EapConfiguration.h.

◆ EFI_EAP_TYPE_NAK

#define EFI_EAP_TYPE_NAK   3

Definition at line 69 of file EapConfiguration.h.

◆ EFI_EAP_TYPE_NOTIFICATION

#define EFI_EAP_TYPE_NOTIFICATION   2

Definition at line 68 of file EapConfiguration.h.

◆ EFI_EAP_TYPE_OTP

#define EFI_EAP_TYPE_OTP   5

Definition at line 71 of file EapConfiguration.h.

◆ EFI_EAP_TYPE_PEAP

#define EFI_EAP_TYPE_PEAP   25

Definition at line 76 of file EapConfiguration.h.

◆ EFI_EAP_TYPE_TTLS

#define EFI_EAP_TYPE_TTLS   21

Definition at line 75 of file EapConfiguration.h.

Typedef Documentation

◆ EFI_EAP_CONFIGURATION_GET_DATA

typedef EFI_STATUS(EFIAPI * EFI_EAP_CONFIGURATION_GET_DATA) (IN EFI_EAP_CONFIGURATION_PROTOCOL *This, IN EFI_EAP_TYPE EapType, IN EFI_EAP_CONFIG_DATA_TYPE DataType, IN OUT VOID *Data, IN OUT UINTN *DataSize)

Get EAP configuration data.

The GetData() function gets EAP configuration.

Parameters
[in]ThisPointer to the EFI_EAP_CONFIGURATION_PROTOCOL instance.
[in]EapTypeEAP type.
[in]DataTypeConfiguration data type.
[in,out]DataPointer to configuration data.
[in,out]DataSizeTotal 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_SUCCESSThe EAP configuration data is got successfully.
EFI_INVALID_PARAMETEROne or more of the following conditions is TRUE: Data is NULL. DataSize is NULL.
EFI_UNSUPPORTEDThe EapType or DataType is unsupported.
EFI_NOT_FOUNDThe EAP configuration data is not found.
EFI_BUFFER_TOO_SMALLThe buffer is too small to hold the buffer.

Definition at line 132 of file EapConfiguration.h.

◆ EFI_EAP_CONFIGURATION_PROTOCOL

◆ EFI_EAP_CONFIGURATION_SET_DATA

typedef EFI_STATUS(EFIAPI * EFI_EAP_CONFIGURATION_SET_DATA) (IN EFI_EAP_CONFIGURATION_PROTOCOL *This, IN EFI_EAP_TYPE EapType, IN EFI_EAP_CONFIG_DATA_TYPE DataType, IN VOID *Data, IN UINTN DataSize)

Set EAP configuration data.

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

Parameters
[in]ThisPointer to the EFI_EAP_CONFIGURATION_PROTOCOL instance.
[in]EapTypeEAP type.
[in]DataTypeConfiguration data type.
[in]DataPointer to configuration data.
[in]DataSizeTotal size of configuration data.
Return values
EFI_SUCCESSThe EAP configuration data is set successfully.
EFI_INVALID_PARAMETEROne or more of the following conditions is TRUE: Data is NULL. DataSize is 0.
EFI_UNSUPPORTEDThe EapType or DataType is unsupported.
EFI_OUT_OF_RESOURCESRequired system resources could not be allocated.

Definition at line 100 of file EapConfiguration.h.

◆ EFI_EAP_TYPE

EFI_EAP_TYPE

Definition at line 65 of file EapConfiguration.h.

Enumeration Type Documentation

◆ EFI_EAP_CONFIG_DATA_TYPE

Enumerator
EfiEapConfigEapAuthMethod 

EFI_EAP_TYPE_ATTRIBUTE

EfiEapConfigIdentityString 

EapTypeIdentity

EfiEapConfigEapTlsCACert 

EapTypeEAPTLS/EapTypePEAP

EfiEapConfigEapMSChapV2Password 

EapTypeMSChapV2

EfiEapConfigEap2ndAuthMethod 

EapTypePEAP

Definition at line 30 of file EapConfiguration.h.