Supplicant.h File Reference

This file defines the EFI Supplicant Protocol. More...

#include <ipxe/efi/Protocol/WiFi2.h>

Go to the source code of this file.

Data Structures
struct	EFI_SUPPLICANT_KEY_REFRESH
	EFI_SUPPLICANT_KEY_REFRESH. More...
struct	EFI_SUPPLICANT_KEY
	EFI_SUPPLICANT_KEY. More...
struct	EFI_SUPPLICANT_GTK_LIST
	EFI_SUPPLICANT_GTK_LIST. More...
struct	EFI_SUPPLICANT_FRAGMENT_DATA
	EFI_SUPPLICANT_FRAGMENT_DATA. More...
struct	_EFI_SUPPLICANT_PROTOCOL
	The EFI_SUPPLICANT_PROTOCOL is designed to provide unified place for WIFI and EAP security management. More...

Macros
#define	EFI_SUPPLICANT_SERVICE_BINDING_PROTOCOL_GUID
	The EFI Supplicant Service Binding Protocol is used to locate EFI Supplicant Protocol drivers to create and destroy child of the driver to communicate with other host using Supplicant protocol. More...
#define	EFI_SUPPLICANT_PROTOCOL_GUID
	The EFI Supplicant protocol provides services to process authentication and data encryption/decryption for security management. More...
#define	EFI_MAX_KEY_LEN   64

Typedefs
typedef struct _EFI_SUPPLICANT_PROTOCOL	EFI_SUPPLICANT_PROTOCOL
typedef EFI_STATUS(EFIAPI *	EFI_SUPPLICANT_BUILD_RESPONSE_PACKET) (IN EFI_SUPPLICANT_PROTOCOL *This, IN UINT8 *RequestBuffer OPTIONAL, IN UINTN RequestBufferSize OPTIONAL, OUT UINT8 *Buffer, IN OUT UINTN *BufferSize)
	BuildResponsePacket() is called during STA and AP authentication is in progress. More...
typedef EFI_STATUS(EFIAPI *	EFI_SUPPLICANT_PROCESS_PACKET) (IN EFI_SUPPLICANT_PROTOCOL *This, IN OUT EFI_SUPPLICANT_FRAGMENT_DATA **FragmentTable, IN UINT32 *FragmentCount, IN EFI_SUPPLICANT_CRYPT_MODE CryptMode)
	ProcessPacket() is called to Supplicant driver to encrypt or decrypt the data depending type of authentication type. More...
typedef EFI_STATUS(EFIAPI *	EFI_SUPPLICANT_SET_DATA) (IN EFI_SUPPLICANT_PROTOCOL *This, IN EFI_SUPPLICANT_DATA_TYPE DataType, IN VOID *Data, IN UINTN DataSize)
	Set Supplicant configuration data. More...
typedef EFI_STATUS(EFIAPI *	EFI_SUPPLICANT_GET_DATA) (IN EFI_SUPPLICANT_PROTOCOL *This, IN EFI_SUPPLICANT_DATA_TYPE DataType, OUT UINT8 *Data OPTIONAL, IN OUT UINTN *DataSize)
	Get Supplicant configuration data. More...

Enumerations
enum	EFI_SUPPLICANT_CRYPT_MODE { EfiSupplicantEncrypt, EfiSupplicantDecrypt }
	EFI_SUPPLICANT_CRYPT_MODE. More...
enum	EFI_SUPPLICANT_DATA_TYPE {   EfiSupplicant80211AKMSuite, EfiSupplicant80211GroupDataCipherSuite, EfiSupplicant80211PairwiseCipherSuite, EfiSupplicant80211PskPassword,   EfiSupplicant80211TargetSSIDName, EfiSupplicant80211StationMac, EfiSupplicant80211TargetSSIDMac, EfiSupplicant80211PTK,   EfiSupplicant80211GTK, EfiSupplicantState, EfiSupplicant80211LinkState, EfiSupplicantKeyRefresh,   EfiSupplicant80211SupportedAKMSuites, EfiSupplicant80211SupportedSoftwareCipherSuites, EfiSupplicant80211SupportedHardwareCipherSuites, EfiSupplicant80211IGTK,   EfiSupplicant80211PMK, EfiSupplicantDataTypeMaximum }
	EFI_SUPPLICANT_DATA_TYPE. More...
enum	EFI_80211_LINK_STATE { Ieee80211UnauthenticatedUnassociated, Ieee80211AuthenticatedUnassociated, Ieee80211PendingRSNAuthentication, Ieee80211AuthenticatedAssociated }
	EFI_80211_LINK_STATE. More...
enum	EFI_SUPPLICANT_KEY_TYPE { Group, Pairwise, PeerKey, IGTK }
	EFI_SUPPLICANT_KEY_TYPE (IEEE Std 802.11 Section 6.3.19.1.2) More...
enum	EFI_SUPPLICANT_KEY_DIRECTION { Receive, Transmit, Both }
	EFI_SUPPLICANT_KEY_DIRECTION (IEEE Std 802.11 Section 6.3.19.1.2) More...

Functions
	FILE_LICENCE (BSD2_PATENT)

Variables
EFI_GUID	gEfiSupplicantServiceBindingProtocolGuid
EFI_GUID	gEfiSupplicantProtocolGuid

Detailed Description

This file defines the EFI Supplicant Protocol.

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

Revision Reference:

This Protocol is introduced in UEFI Specification 2.6

Definition in file Supplicant.h.

Macro Definition Documentation

EFI_SUPPLICANT_SERVICE_BINDING_PROTOCOL_GUID

#define EFI_SUPPLICANT_SERVICE_BINDING_PROTOCOL_GUID

Value:

{ \
    0x45bcd98e, 0x59ad, 0x4174, { 0x95, 0x46, 0x34, 0x4a, 0x7, 0x48, 0x58, 0x98 } \
  }

The EFI Supplicant Service Binding Protocol is used to locate EFI Supplicant Protocol drivers to create and destroy child of the driver to communicate with other host using Supplicant protocol.

Definition at line 24 of file Supplicant.h.

EFI_SUPPLICANT_PROTOCOL_GUID

#define EFI_SUPPLICANT_PROTOCOL_GUID

Value:

{ \
    0x54fcc43e, 0xaa89, 0x4333, { 0x9a, 0x85, 0xcd, 0xea, 0x24, 0x5, 0x1e, 0x9e } \
  }

The EFI Supplicant protocol provides services to process authentication and data encryption/decryption for security management.

Definition at line 33 of file Supplicant.h.

EFI_MAX_KEY_LEN

#define EFI_MAX_KEY_LEN   64

Definition at line 220 of file Supplicant.h.

Typedef Documentation

EFI_SUPPLICANT_PROTOCOL

typedef struct _EFI_SUPPLICANT_PROTOCOL EFI_SUPPLICANT_PROTOCOL

Definition at line 38 of file Supplicant.h.

EFI_SUPPLICANT_BUILD_RESPONSE_PACKET

typedef EFI_STATUS(EFIAPI * EFI_SUPPLICANT_BUILD_RESPONSE_PACKET) (IN EFI_SUPPLICANT_PROTOCOL *This, IN UINT8 *RequestBuffer OPTIONAL, IN UINTN RequestBufferSize OPTIONAL, OUT UINT8 *Buffer, IN OUT UINTN *BufferSize)

BuildResponsePacket() is called during STA and AP authentication is in progress.

Supplicant derives the PTK or session keys depend on type of authentication is being employed.

Parameters

[in]	This	Pointer to the EFI_SUPPLICANT_PROTOCOL instance.
[in]	RequestBuffer	Pointer to the most recently received EAPOL packet. NULL means the supplicant need initiate the EAP authentication session and send EAPOL-Start message.
[in]	RequestBufferSize	Packet size in bytes for the most recently received EAPOL packet. 0 is only valid when RequestBuffer is NULL.
[out]	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 EAPOL packet is built successfully.
EFI_INVALID_PARAMETER	One or more of the following conditions is TRUE: RequestBuffer is NULL, but RequestSize is NOT 0. RequestBufferSize is 0. Buffer is NULL, but RequestBuffer is NOT 0. BufferSize is NULL.
EFI_BUFFER_TOO_SMALL	BufferSize is too small to hold the response packet.
EFI_NOT_READY	Current EAPOL session state is NOT ready to build ResponsePacket.

Definition at line 338 of file Supplicant.h.

EFI_SUPPLICANT_PROCESS_PACKET

typedef EFI_STATUS(EFIAPI * EFI_SUPPLICANT_PROCESS_PACKET) (IN EFI_SUPPLICANT_PROTOCOL *This, IN OUT EFI_SUPPLICANT_FRAGMENT_DATA **FragmentTable, IN UINT32 *FragmentCount, IN EFI_SUPPLICANT_CRYPT_MODE CryptMode)

ProcessPacket() is called to Supplicant driver to encrypt or decrypt the data depending type of authentication type.

Parameters

[in]	This	Pointer to the EFI_SUPPLICANT_PROTOCOL instance.
[in,out]	FragmentTable	Pointer to a list of fragment. The caller will take responsible to handle the original FragmentTable while it may be reallocated in Supplicant driver.
[in]	FragmentCount	Number of fragment.
[in]	CryptMode	Crypt mode.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_INVALID_PARAMETER	One or more of the following conditions is TRUE: FragmentTable is NULL. FragmentCount is NULL. CryptMode is invalid.
EFI_NOT_READY	Current supplicant state is NOT Authenticated.
EFI_ABORTED	Something wrong decryption the message.
EFI_UNSUPPORTED	This API is not supported.

Definition at line 372 of file Supplicant.h.

EFI_SUPPLICANT_SET_DATA

typedef EFI_STATUS(EFIAPI * EFI_SUPPLICANT_SET_DATA) (IN EFI_SUPPLICANT_PROTOCOL *This, IN EFI_SUPPLICANT_DATA_TYPE DataType, IN VOID *Data, IN UINTN DataSize)

Set Supplicant configuration data.

Parameters

[in]	This	Pointer to the EFI_SUPPLICANT_PROTOCOL instance.
[in]	DataType	The type of data.
[in]	Data	Pointer to the buffer to hold the data.
[in]	DataSize	Pointer to the buffer size in bytes.

Return values

EFI_SUCCESS	The Supplicant 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 DataType is unsupported.
EFI_OUT_OF_RESOURCES	Required system resources could not be allocated.

Definition at line 400 of file Supplicant.h.

EFI_SUPPLICANT_GET_DATA

typedef EFI_STATUS(EFIAPI * EFI_SUPPLICANT_GET_DATA) (IN EFI_SUPPLICANT_PROTOCOL *This, IN EFI_SUPPLICANT_DATA_TYPE DataType, OUT UINT8 *Data OPTIONAL, IN OUT UINTN *DataSize)

Get Supplicant configuration data.

Parameters

[in]	This	Pointer to the EFI_SUPPLICANT_PROTOCOL instance.
[in]	DataType	The type of data.
[out]	Data	Pointer to the buffer to hold the data. Ignored if DataSize is 0.
[in,out]	DataSize	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 Supplicant configuration data is got successfully.
EFI_INVALID_PARAMETER	One or more of the following conditions is TRUE: This is NULL. DataSize is NULL. Data is NULL if *DataSize is not zero.
EFI_UNSUPPORTED	The DataType is unsupported.
EFI_NOT_FOUND	The Supplicant configuration data is not found.
EFI_BUFFER_TOO_SMALL	The size of Data is too small for the specified configuration data and the required size is returned in DataSize.

Definition at line 437 of file Supplicant.h.

Enumeration Type Documentation

EFI_SUPPLICANT_CRYPT_MODE

enum EFI_SUPPLICANT_CRYPT_MODE

EFI_SUPPLICANT_CRYPT_MODE.

Enumerator
EfiSupplicantEncrypt
EfiSupplicantDecrypt

Definition at line 43 of file Supplicant.h.

             {
  //
  // Encrypt data provided in the fragment buffers.
  //
  EfiSupplicantEncrypt,
  //
  // Decrypt data provided in the fragment buffers.
  //
  EfiSupplicantDecrypt,
} EFI_SUPPLICANT_CRYPT_MODE;

EFI_SUPPLICANT_DATA_TYPE

enum EFI_SUPPLICANT_DATA_TYPE

EFI_SUPPLICANT_DATA_TYPE.

Enumerator
EfiSupplicant80211AKMSuite
EfiSupplicant80211GroupDataCipherSuite
EfiSupplicant80211PairwiseCipherSuite
EfiSupplicant80211PskPassword
EfiSupplicant80211TargetSSIDName
EfiSupplicant80211StationMac
EfiSupplicant80211TargetSSIDMac
EfiSupplicant80211PTK
EfiSupplicant80211GTK
EfiSupplicantState
EfiSupplicant80211LinkState
EfiSupplicantKeyRefresh
EfiSupplicant80211SupportedAKMSuites
EfiSupplicant80211SupportedSoftwareCipherSuites
EfiSupplicant80211SupportedHardwareCipherSuites
EfiSupplicant80211IGTK
EfiSupplicant80211PMK
EfiSupplicantDataTypeMaximum

Definition at line 57 of file Supplicant.h.

             {
  //
  // Session Configuration
  //

  //
  // Current authentication type in use. The corresponding Data is of type
  // EFI_80211_AKM_SUITE_SELECTOR.
  //
  EfiSupplicant80211AKMSuite,
  //
  // Group data encryption type in use. The corresponding Data is of type
  // EFI_SUPPLICANT_CIPHER_SUITE_SELECTOR.
  //
  EfiSupplicant80211GroupDataCipherSuite,
  //
  // Pairwise encryption type in use. The corresponding Data is of type
  // EFI_80211_CIPHER_SUITE_SELECTOR.
  //
  EfiSupplicant80211PairwiseCipherSuite,
  //
  // PSK password. The corresponding Data is a NULL-terminated ASCII string.
  //
  EfiSupplicant80211PskPassword,
  //
  // Target SSID name. The corresponding Data is of type EFI_80211_SSID.
  //
  EfiSupplicant80211TargetSSIDName,
  //
  // Station MAC address. The corresponding Data is of type
  // EFI_80211_MAC_ADDRESS.
  //
  EfiSupplicant80211StationMac,
  //
  // Target SSID MAC address. The corresponding Data is 6 bytes MAC address.
  //
  EfiSupplicant80211TargetSSIDMac,

  //
  // Session Information
  //

  //
  // 802.11 PTK. The corresponding Data is of type EFI_SUPPLICANT_KEY.
  //
  EfiSupplicant80211PTK,
  //
  // 802.11 GTK. The corresponding Data is of type EFI_SUPPLICANT_GTK_LIST.
  //
  EfiSupplicant80211GTK,
  //
  // Supplicant state. The corresponding Data is
  // EFI_EAPOL_SUPPLICANT_PAE_STATE.
  //
  EfiSupplicantState,
  //
  // 802.11 link state. The corresponding Data is EFI_80211_LINK_STATE.
  //
  EfiSupplicant80211LinkState,
  //
  // Flag indicates key is refreshed. The corresponding Data is
  // EFI_SUPPLICANT_KEY_REFRESH.
  //
  EfiSupplicantKeyRefresh,

  //
  // Session Configuration
  //

  //
  // Supported authentication types. The corresponding Data is of type
  // EFI_80211_AKM_SUITE_SELECTOR.
  //
  EfiSupplicant80211SupportedAKMSuites,
  //
  // Supported software encryption types provided by supplicant driver. The
  // corresponding Data is of type EFI_80211_CIPHER_SUITE_SELECTOR.
  //
  EfiSupplicant80211SupportedSoftwareCipherSuites,
  //
  // Supported hardware encryption types provided by wireless UNDI driver. The
  // corresponding Data is of type EFI_80211_CIPHER_SUITE_SELECTOR.
  //
  EfiSupplicant80211SupportedHardwareCipherSuites,

  //
  // Session Information
  //

  //
  // 802.11 Integrity GTK. The corresponding Data is of type
  // EFI_SUPPLICANT_GTK_LIST.
  //
  EfiSupplicant80211IGTK,
  //
  // 802.11 PMK. The corresponding Data is 32 bytes pairwise master key.
  //
  EfiSupplicant80211PMK,
  EfiSupplicantDataTypeMaximum
} EFI_SUPPLICANT_DATA_TYPE;

EFI_80211_LINK_STATE

enum EFI_80211_LINK_STATE

EFI_80211_LINK_STATE.

Enumerator
Ieee80211UnauthenticatedUnassociated
Ieee80211AuthenticatedUnassociated
Ieee80211PendingRSNAuthentication
Ieee80211AuthenticatedAssociated

Definition at line 161 of file Supplicant.h.

             {
  //
  // Indicates initial start state, unauthenticated, unassociated.
  //
  Ieee80211UnauthenticatedUnassociated,
  //
  // Indicates authenticated, unassociated.
  //
  Ieee80211AuthenticatedUnassociated,
  //
  // Indicates authenticated and associated, but pending RSN authentication.
  //
  Ieee80211PendingRSNAuthentication,
  //
  // Indicates authenticated and associated.
  //
  Ieee80211AuthenticatedAssociated
} EFI_80211_LINK_STATE;

EFI_SUPPLICANT_KEY_TYPE

enum EFI_SUPPLICANT_KEY_TYPE

EFI_SUPPLICANT_KEY_TYPE (IEEE Std 802.11 Section 6.3.19.1.2)

Enumerator
Group
Pairwise
PeerKey
IGTK

Definition at line 183 of file Supplicant.h.

             {
  Group,
  Pairwise,
  PeerKey,
  IGTK
} EFI_SUPPLICANT_KEY_TYPE;

EFI_SUPPLICANT_KEY_DIRECTION

enum EFI_SUPPLICANT_KEY_DIRECTION

EFI_SUPPLICANT_KEY_DIRECTION (IEEE Std 802.11 Section 6.3.19.1.2)

Enumerator
Receive
Transmit
Both

Definition at line 193 of file Supplicant.h.

             {
  //
  // Indicates that the keys are being installed for the receive direction.
  //
  Receive,
  //
  // Indicates that the keys are being installed for the transmit direction.
  //
  Transmit,
  //
  // Indicates that the keys are being installed for both the receive and
  // transmit directions.
  //
  Both
} EFI_SUPPLICANT_KEY_DIRECTION;

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

BSD2_PATENT

)

Variable Documentation

gEfiSupplicantServiceBindingProtocolGuid

EFI_GUID gEfiSupplicantServiceBindingProtocolGuid

gEfiSupplicantProtocolGuid

EFI_GUID gEfiSupplicantProtocolGuid