Eap.h File Reference

Go to the source code of this file.

Data Structures
struct	_EFI_EAP_PROTOCOL

Macros
#define	EFI_EAP_PROTOCOL_GUID
#define	EFI_EAP_TYPE_MD5   4
#define	EFI_EAP_TYPE_OTP   5
#define	EFI_EAP_TYPE_TOKEN_CARD   6
#define	EFI_EAP_TYPE_TLS   13
	REQUIRED - RFC 5216.

Typedefs
typedef struct _EFI_EAP_PROTOCOL	EFI_EAP_PROTOCOL
typedef VOID *	EFI_PORT_HANDLE
typedef EFI_STATUS(EFIAPI *	EFI_EAP_BUILD_RESPONSE_PACKET) (IN EFI_PORT_HANDLE PortNumber, IN UINT8 *RequestBuffer, IN UINTN RequestSize, IN UINT8 *Buffer, IN OUT UINTN *BufferSize)
typedef EFI_STATUS(EFIAPI *	EFI_EAP_SET_DESIRED_AUTHENTICATION_METHOD) (IN EFI_EAP_PROTOCOL *This, IN UINT8 EapAuthType)
typedef EFI_STATUS(EFIAPI *	EFI_EAP_REGISTER_AUTHENTICATION_METHOD) (IN EFI_EAP_PROTOCOL *This, IN UINT8 EapAuthType, IN EFI_EAP_BUILD_RESPONSE_PACKET Handler)

Variables
EFI_GUID	gEfiEapProtocolGuid

Detailed Description

EFI EAP(Extended Authenticaton Protocol) Protocol Definition The EFI EAP Protocol is used to abstract the ability to configure and extend the EAP framework. The definitions in this file are defined in UEFI Specification 2.3.1B, which have not been verified by one implementation yet.

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

Revision Reference:

This Protocol is introduced in UEFI Specification 2.2

Definition in file Eap.h.

Macro Definition Documentation

EFI_EAP_PROTOCOL_GUID

#define EFI_EAP_PROTOCOL_GUID

Value:

  { \
    0x5d9f96db, 0xe731, 0x4caa, {0xa0, 0xd, 0x72, 0xe1, 0x87, 0xcd, 0x77, 0x62 } \
  }

Definition at line 19 of file Eap.h.

EFI_EAP_TYPE_MD5

#define EFI_EAP_TYPE_MD5   4

Definition at line 42 of file Eap.h.

EFI_EAP_TYPE_OTP

#define EFI_EAP_TYPE_OTP   5

Definition at line 43 of file Eap.h.

EFI_EAP_TYPE_TLS

#define EFI_EAP_TYPE_TLS   13

REQUIRED - RFC 5216.

EAP Authentication Method Type (RFC 3748)

Definition at line 35 of file Eap.h.

EFI_EAP_TYPE_TOKEN_CARD

#define EFI_EAP_TYPE_TOKEN_CARD   6

Definition at line 44 of file Eap.h.

Typedef Documentation

EFI_EAP_BUILD_RESPONSE_PACKET

typedef EFI_STATUS(EFIAPI * EFI_EAP_BUILD_RESPONSE_PACKET) (IN EFI_PORT_HANDLE PortNumber, IN UINT8 *RequestBuffer, IN UINTN RequestSize, IN UINT8 *Buffer, IN OUT UINTN *BufferSize)

One user provided EAP authentication method.

Build EAP response packet in response to the EAP request packet specified by (RequestBuffer, RequestSize).

Parameters

[in]	PortNumber	Specified the Port where the EAP request packet comes.
[in]	RequestBuffer	Pointer to the most recently received EAP- Request packet.
[in]	RequestSize	Packet size in bytes for the most recently received EAP-Request packet.
[in]	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 EAP response packet is built successfully.
others	Failures are encountered during the packet building process.

Definition at line 67 of file Eap.h.

EFI_EAP_PROTOCOL

typedef struct _EFI_EAP_PROTOCOL EFI_EAP_PROTOCOL

Definition at line 24 of file Eap.h.

EFI_EAP_REGISTER_AUTHENTICATION_METHOD

typedef EFI_STATUS(EFIAPI * EFI_EAP_REGISTER_AUTHENTICATION_METHOD) (IN EFI_EAP_PROTOCOL *This, IN UINT8 EapAuthType, IN EFI_EAP_BUILD_RESPONSE_PACKET Handler)

Register an EAP authentication method.

The RegisterAuthMethod() function registers the user provided EAP authentication method, the type of which is EapAuthType and the handler of which is Handler.

If EapAuthType is an invalid EAP authentication type, then EFI_INVALID_PARAMETER is returned. If there is not enough system memory to perform the registration, then EFI_OUT_OF_RESOURCES is returned.

Parameters

[in]	This	A pointer to the EFI_EAP_PROTOCOL instance that indicates the calling context.
[in]	EapAuthType	The type of the EAP authentication method to register. It should be the type value defined by RFC. See RFC 2284 for details.
[in]	Handler	The handler of the EAP authentication method to register.

Return values

EFI_SUCCESS	The EAP authentication method of EapAuthType is registered successfully.
EFI_INVALID_PARAMETER	EapAuthType is an invalid EAP authentication type.
EFI_OUT_OF_RESOURCES	There is not enough system memory to perform the registration.

Definition at line 133 of file Eap.h.

EFI_EAP_SET_DESIRED_AUTHENTICATION_METHOD

typedef EFI_STATUS(EFIAPI * EFI_EAP_SET_DESIRED_AUTHENTICATION_METHOD) (IN EFI_EAP_PROTOCOL *This, IN UINT8 EapAuthType)

Set the desired EAP authentication method for the Port.

The SetDesiredAuthMethod() function sets the desired EAP authentication method indicated by EapAuthType for the Port.

If EapAuthType is an invalid EAP authentication type, then EFI_INVALID_PARAMETER is returned. If the EAP authentication method of EapAuthType is unsupported by the Ports, then it will return EFI_UNSUPPORTED. The cryptographic strength of EFI_EAP_TYPE_TLS shall be at least of hash strength SHA-256 and RSA key length of at least 2048 bits.

Parameters

[in]	This	A pointer to the EFI_EAP_PROTOCOL instance that indicates the calling context.
[in]	EapAuthType	The type of the EAP authentication method to register. It should be the type value defined by RFC. See RFC 2284 for details.
[in]	Handler	The handler of the EAP authentication method to register.

Return values

EFI_SUCCESS	The EAP authentication method of EapAuthType is registered successfully.
EFI_INVALID_PARAMETER	EapAuthType is an invalid EAP authentication type.
EFI_UNSUPPORTED	The EAP authentication method of EapAuthType is unsupported by the Port.

Definition at line 103 of file Eap.h.

EFI_PORT_HANDLE

typedef VOID* EFI_PORT_HANDLE

Type for the identification number assigned to the Port by the System in which the Port resides.

Definition at line 30 of file Eap.h.