MdePkg/Include/Protocol/EapManagement.h File Reference


Data Structures

struct  _EFI_EAPOL_PORT_INFO
struct  _EFI_EAPOL_SUPPLICANT_PAE_CONFIGURATION
struct  _EFI_EAPOL_SUPPLICANT_PAE_STATISTICS
struct  _EFI_EAP_MANAGEMENT_PROTOCOL

Defines

#define EFI_EAP_MANAGEMENT_PROTOCOL_GUID
#define PAE_SUPPORT_AUTHENTICATOR   0x01
#define PAE_SUPPORT_SUPPLICANT   0x02
#define AUTH_PERIOD_FIELD_VALID   0x01
#define HELD_PERIOD_FIELD_VALID   0x02
#define START_PERIOD_FIELD_VALID   0x04
#define MAX_START_FIELD_VALID   0x08

Typedefs

typedef struct
_EFI_EAP_MANAGEMENT_PROTOCOL 
EFI_EAP_MANAGEMENT_PROTOCOL
typedef struct _EFI_EAPOL_PORT_INFO EFI_EAPOL_PORT_INFO
typedef enum
_EFI_EAPOL_SUPPLICANT_PAE_STATE 
EFI_EAPOL_SUPPLICANT_PAE_STATE
typedef struct
_EFI_EAPOL_SUPPLICANT_PAE_CONFIGURATION 
EFI_EAPOL_SUPPLICANT_PAE_CONFIGURATION
typedef struct
_EFI_EAPOL_SUPPLICANT_PAE_STATISTICS 
EFI_EAPOL_SUPPLICANT_PAE_STATISTICS
typedef EFI_STATUS(EFIAPI * EFI_EAP_GET_SYSTEM_CONFIGURATION )(IN EFI_EAP_MANAGEMENT_PROTOCOL *This, OUT BOOLEAN *SystemAuthControl, OUT EFI_EAPOL_PORT_INFO *PortInfo)
typedef EFI_STATUS(EFIAPI * EFI_EAP_SET_SYSTEM_CONFIGURATION )(IN EFI_EAP_MANAGEMENT_PROTOCOL *This, IN BOOLEAN SystemAuthControl)
typedef EFI_STATUS(EFIAPI * EFI_EAP_INITIALIZE_PORT )(IN EFI_EAP_MANAGEMENT_PROTOCOL *This)
typedef EFI_STATUS(EFIAPI * EFI_EAP_USER_LOGON )(IN EFI_EAP_MANAGEMENT_PROTOCOL *This)
typedef EFI_STATUS(EFIAPI * EFI_EAP_USER_LOGOFF )(IN EFI_EAP_MANAGEMENT_PROTOCOL *This)
typedef EFI_STATUS(EFIAPI * EFI_EAP_GET_SUPPLICANT_STATUS )(IN EFI_EAP_MANAGEMENT_PROTOCOL *This, OUT EFI_EAPOL_SUPPLICANT_PAE_STATE *CurrentState, IN OUT EFI_EAPOL_SUPPLICANT_PAE_CONFIGURATION *Configuration)
typedef EFI_STATUS(EFIAPI * EFI_EAP_SET_SUPPLICANT_CONFIGURATION )(IN EFI_EAP_MANAGEMENT_PROTOCOL *This, IN EFI_EAPOL_SUPPLICANT_PAE_CONFIGURATION *Configuration)
typedef EFI_STATUS(EFIAPI * EFI_EAP_GET_SUPPLICANT_STATISTICS )(IN EFI_EAP_MANAGEMENT_PROTOCOL *This, OUT EFI_EAPOL_SUPPLICANT_PAE_STATISTICS *Statistics)

Enumerations

enum  _EFI_EAPOL_SUPPLICANT_PAE_STATE {
  Logoff, Disconnected, Connecting, Acquired,
  Authenticating, Held, Authenticated, MaxSupplicantPaeState
}

Variables

EFI_GUID gEfiEapManagementProtocolGuid

Detailed Description

EFI EAP Management Protocol Definition The EFI EAP Management Protocol is designed to provide ease of management and ease of test for EAPOL state machine. It is intended for the supplicant side. It conforms to IEEE 802.1x specification. The definitions in this file are defined in UEFI Specification 2.2, which have not been verified by one implementation yet.

Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Revision Reference:
This Protocol is introduced in UEFI Specification 2.2

Define Documentation

#define AUTH_PERIOD_FIELD_VALID   0x01

Definitions for ValidFieldMask

#define EFI_EAP_MANAGEMENT_PROTOCOL_GUID

Value:

{ \
    0xbb62e663, 0x625d, 0x40b2, {0xa0, 0x88, 0xbb, 0xe8, 0x36, 0x23, 0xa2, 0x45 } \
  }

#define HELD_PERIOD_FIELD_VALID   0x02

Definitions for ValidFieldMask

#define MAX_START_FIELD_VALID   0x08

Definitions for ValidFieldMask

#define PAE_SUPPORT_AUTHENTICATOR   0x01

PAE Capabilities

#define PAE_SUPPORT_SUPPLICANT   0x02

PAE Capabilities

#define START_PERIOD_FIELD_VALID   0x04

Definitions for ValidFieldMask


Typedef Documentation

Read the statistical information regarding the operation of the Supplicant associated with the Port.

The GetSupplicantStatistics() function reads the statistical information Statistics regarding the operation of the Supplicant associated with the Port.

If Statistics is NULL, then EFI_INVALID_PARAMETER is returned.

Parameters:
[in] This A pointer to the EFI_EAP_MANAGEMENT_PROTOCOL instance that indicates the calling context.
[out] Statistics Returns the statistical information regarding the operation of the Supplicant for the Port.
Return values:
EFI_SUCCESS The statistical information regarding the operation of the Supplicant for the Port is read successfully.
EFI_INVALID_PARAMETER Statistics is NULL.

Read the status of the Supplicant PAE state machine for the Port, including the current state and the configuration of the operational parameters.

The GetSupplicantStatus() function reads the status of the Supplicant PAE state machine for the Port, including the current state CurrentState and the configuration of the operational parameters Configuration. The configuration of the operational parameters is optional. If Configuration is NULL, then reading the configuration is ignored. The operational parameters in Configuration to be read can also be specified by Configuration.ValidFieldMask.

If CurrentState is NULL, then EFI_INVALID_PARAMETER is returned.

Parameters:
[in] This A pointer to the EFI_EAP_MANAGEMENT_PROTOCOL instance that indicates the calling context.
[out] CurrentState Returns the current state of the Supplicant PAE state machine for the Port.
[in,out] Configuration Returns the configuration of the operational parameters of the Supplicant PAE state machine for the Port as required. This parameter can be NULL to ignore reading the configuration. On input, Configuration.ValidFieldMask specifies the operational parameters to be read. On output, Configuration returns the configuration of the required operational parameters.
Return values:
EFI_SUCCESS The configuration of the operational parameter of the Supplicant PAE state machine for the Port is set successfully.
EFI_INVALID_PARAMETER CurrentState is NULL.

typedef EFI_STATUS(EFIAPI * EFI_EAP_GET_SYSTEM_CONFIGURATION)(IN EFI_EAP_MANAGEMENT_PROTOCOL *This, OUT BOOLEAN *SystemAuthControl, OUT EFI_EAPOL_PORT_INFO *PortInfo)

Read the system configuration information associated with the Port.

The GetSystemConfiguration() function reads the system configuration information associated with the Port, including the value of the SystemAuthControl parameter of the System is returned in SystemAuthControl and the Port's information is returned in the buffer pointed to by PortInfo. The Port's information is optional. If PortInfo is NULL, then reading the Port's information is ignored.

If SystemAuthControl is NULL, then EFI_INVALID_PARAMETER is returned.

Parameters:
[in] This A pointer to the EFI_EAP_MANAGEMENT_PROTOCOL instance that indicates the calling context.
[out] SystemAuthControl Returns the value of the SystemAuthControl parameter of the System. TRUE means Enabled. FALSE means Disabled.
[out] PortInfo Returns EFI_EAPOL_PORT_INFO structure to describe the Port's information. This parameter can be NULL to ignore reading the Port's information.
Return values:
EFI_SUCCESS The system configuration information of the Port is read successfully.
EFI_INVALID_PARAMETER SystemAuthControl is NULL.

typedef EFI_STATUS(EFIAPI * EFI_EAP_INITIALIZE_PORT)(IN EFI_EAP_MANAGEMENT_PROTOCOL *This)

Cause the EAPOL state machines for the Port to be initialized.

The InitializePort() function causes the EAPOL state machines for the Port.

Parameters:
[in] This A pointer to the EFI_EAP_MANAGEMENT_PROTOCOL instance that indicates the calling context.
Return values:
EFI_SUCCESS The Port is initialized successfully.

Set the configuration of the operational parameter of the Supplicant PAE state machine for the Port.

The SetSupplicantConfiguration() function sets the configuration of the operational Parameter of the Supplicant PAE state machine for the Port to Configuration. The operational parameters in Configuration to be set can be specified by Configuration.ValidFieldMask.

If Configuration is NULL, then EFI_INVALID_PARAMETER is returned.

Parameters:
[in] This A pointer to the EFI_EAP_MANAGEMENT_PROTOCOL instance that indicates the calling context.
[in] Configuration The desired configuration of the operational parameters of the Supplicant PAE state machine for the Port as required.
Return values:
EFI_SUCCESS The configuration of the operational parameter of the Supplicant PAE state machine for the Port is set successfully.
EFI_INVALID_PARAMETER Configuration is NULL.

typedef EFI_STATUS(EFIAPI * EFI_EAP_SET_SYSTEM_CONFIGURATION)(IN EFI_EAP_MANAGEMENT_PROTOCOL *This, IN BOOLEAN SystemAuthControl)

Set the system configuration information associated with the Port.

The SetSystemConfiguration() function sets the value of the SystemAuthControl parameter of the System to SystemAuthControl.

Parameters:
[in] This A pointer to the EFI_EAP_MANAGEMENT_PROTOCOL instance that indicates the calling context.
[in] SystemAuthControl The desired value of the SystemAuthControl parameter of the System. TRUE means Enabled. FALSE means Disabled.
Return values:
EFI_SUCCESS The system configuration information of the Port is set successfully.

typedef EFI_STATUS(EFIAPI * EFI_EAP_USER_LOGOFF)(IN EFI_EAP_MANAGEMENT_PROTOCOL *This)

Notify the EAPOL state machines for the Port that the user of the System has logged off.

The UserLogoff() function notifies the EAPOL state machines for the Port.

Parameters:
[in] This A pointer to the EFI_EAP_MANAGEMENT_PROTOCOL instance that indicates the calling context.
Return values:
EFI_SUCCESS The Port is notified successfully.

typedef EFI_STATUS(EFIAPI * EFI_EAP_USER_LOGON)(IN EFI_EAP_MANAGEMENT_PROTOCOL *This)

Notify the EAPOL state machines for the Port that the user of the System has logged on.

The UserLogon() function notifies the EAPOL state machines for the Port.

Parameters:
[in] This A pointer to the EFI_EAP_MANAGEMENT_PROTOCOL instance that indicates the calling context.
Return values:
EFI_SUCCESS The Port is notified successfully.

EFI_EAPOL_PORT_INFO

EFI_EAPOL_SUPPLICANT_PAE_CONFIGURATION

Supplicant PAE state machine (IEEE Std 802.1X Section 8.5.10)

Supplicant Statistics (IEEE Std 802.1X Section 9.5.2)


Enumeration Type Documentation

Supplicant PAE state machine (IEEE Std 802.1X Section 8.5.10)

Enumerator:
Logoff 
Disconnected 
Connecting 
Acquired 
Authenticating 
Held 
Authenticated 
MaxSupplicantPaeState 


Variable Documentation


Generated on Wed Sep 23 16:24:23 2015 for MdePkg[ALL] by  doxygen 1.5.7.1