| 1 | /** @file
|
|---|
| 2 | This file defines the EFI EAP Management2 protocol.
|
|---|
| 3 |
|
|---|
| 4 | Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
|
|---|
| 5 | SPDX-License-Identifier: BSD-2-Clause-Patent
|
|---|
| 6 |
|
|---|
| 7 | @par Revision Reference:
|
|---|
| 8 | This Protocol is introduced in UEFI Specification 2.5
|
|---|
| 9 |
|
|---|
| 10 | **/
|
|---|
| 11 |
|
|---|
| 12 | #ifndef __EFI_EAP_MANAGEMENT2_PROTOCOL_H__
|
|---|
| 13 | #define __EFI_EAP_MANAGEMENT2_PROTOCOL_H__
|
|---|
| 14 |
|
|---|
| 15 | #include <Protocol/EapManagement.h>
|
|---|
| 16 |
|
|---|
| 17 | ///
|
|---|
| 18 | /// This EFI EAP Management2 protocol provides the ability to configure and control EAPOL
|
|---|
| 19 | /// state machine, and retrieve the information, status and the statistics information of
|
|---|
| 20 | /// EAPOL state machine.
|
|---|
| 21 | ///
|
|---|
| 22 | #define EFI_EAP_MANAGEMENT2_PROTOCOL_GUID \
|
|---|
| 23 | { \
|
|---|
| 24 | 0x5e93c847, 0x456d, 0x40b3, {0xa6, 0xb4, 0x78, 0xb0, 0xc9, 0xcf, 0x7f, 0x20 } \
|
|---|
| 25 | }
|
|---|
| 26 |
|
|---|
| 27 | typedef struct _EFI_EAP_MANAGEMENT2_PROTOCOL EFI_EAP_MANAGEMENT2_PROTOCOL;
|
|---|
| 28 |
|
|---|
| 29 | /**
|
|---|
| 30 | Return key generated through EAP process.
|
|---|
| 31 |
|
|---|
| 32 | The GetKey() function return the key generated through EAP process, so that the 802.11
|
|---|
| 33 | MAC layer driver can use MSK to derive more keys, e.g. PMK (Pairwise Master Key).
|
|---|
| 34 |
|
|---|
| 35 | @param[in] This Pointer to the EFI_EAP_MANAGEMENT2_PROTOCOL instance.
|
|---|
| 36 | @param[in, out] Msk Pointer to MSK (Master Session Key) buffer.
|
|---|
| 37 | @param[in, out] MskSize MSK buffer size.
|
|---|
| 38 | @param[in, out] Emsk Pointer to EMSK (Extended Master Session Key) buffer.
|
|---|
| 39 | @param[in, out] EmskSize EMSK buffer size.
|
|---|
| 40 |
|
|---|
| 41 | @retval EFI_SUCCESS The operation completed successfully.
|
|---|
| 42 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
|
|---|
| 43 | Msk is NULL.
|
|---|
| 44 | MskSize is NULL.
|
|---|
| 45 | Emsk is NULL.
|
|---|
| 46 | EmskSize is NULL.
|
|---|
| 47 | @retval EFI_NOT_READY MSK and EMSK are not generated in current session yet.
|
|---|
| 48 |
|
|---|
| 49 | **/
|
|---|
| 50 | typedef
|
|---|
| 51 | EFI_STATUS
|
|---|
| 52 | (EFIAPI *EFI_EAP_GET_KEY)(
|
|---|
| 53 | IN EFI_EAP_MANAGEMENT2_PROTOCOL *This,
|
|---|
| 54 | IN OUT UINT8 *Msk,
|
|---|
| 55 | IN OUT UINTN *MskSize,
|
|---|
| 56 | IN OUT UINT8 *Emsk,
|
|---|
| 57 | IN OUT UINT8 *EmskSize
|
|---|
| 58 | );
|
|---|
| 59 |
|
|---|
| 60 | ///
|
|---|
| 61 | /// The EFI_EAP_MANAGEMENT2_PROTOCOL
|
|---|
| 62 | /// is used to control, configure and monitor EAPOL state machine on a Port, and return
|
|---|
| 63 | /// information of the Port. EAPOL state machine is built on a per-Port basis. Herein, a
|
|---|
| 64 | /// Port means a NIC. For the details of EAPOL, please refer to IEEE 802.1x
|
|---|
| 65 | /// specification.
|
|---|
| 66 | ///
|
|---|
| 67 | struct _EFI_EAP_MANAGEMENT2_PROTOCOL {
|
|---|
| 68 | EFI_EAP_GET_SYSTEM_CONFIGURATION GetSystemConfiguration;
|
|---|
| 69 | EFI_EAP_SET_SYSTEM_CONFIGURATION SetSystemConfiguration;
|
|---|
| 70 | EFI_EAP_INITIALIZE_PORT InitializePort;
|
|---|
| 71 | EFI_EAP_USER_LOGON UserLogon;
|
|---|
| 72 | EFI_EAP_USER_LOGOFF UserLogoff;
|
|---|
| 73 | EFI_EAP_GET_SUPPLICANT_STATUS GetSupplicantStatus;
|
|---|
| 74 | EFI_EAP_SET_SUPPLICANT_CONFIGURATION SetSupplicantConfiguration;
|
|---|
| 75 | EFI_EAP_GET_SUPPLICANT_STATISTICS GetSupplicantStatistics;
|
|---|
| 76 | EFI_EAP_GET_KEY GetKey;
|
|---|
| 77 | };
|
|---|
| 78 |
|
|---|
| 79 | extern EFI_GUID gEfiEapManagement2ProtocolGuid;
|
|---|
| 80 |
|
|---|
| 81 | #endif
|
|---|
