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