AuthenticationInfo.h File Reference

Go to the source code of this file.

Classes
struct	AUTH_NODE_HEADER
struct	CHAP_RADIUS_AUTH_NODE
struct	CHAP_LOCAL_AUTH_NODE
struct	_EFI_AUTHENTICATION_INFO_PROTOCOL

Macros
#define	EFI_AUTHENTICATION_INFO_PROTOCOL_GUID
#define	EFI_AUTHENTICATION_CHAP_RADIUS_GUID
#define	EFI_AUTHENTICATION_CHAP_LOCAL_GUID

Typedefs
typedef struct _EFI_AUTHENTICATION_INFO_PROTOCOL	EFI_AUTHENTICATION_INFO_PROTOCOL
typedef EFI_STATUS(EFIAPI *	EFI_AUTHENTICATION_INFO_PROTOCOL_GET) (IN EFI_AUTHENTICATION_INFO_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, OUT VOID **Buffer)
typedef EFI_STATUS(EFIAPI *	EFI_AUTHENTICATION_INFO_PROTOCOL_SET) (IN EFI_AUTHENTICATION_INFO_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN VOID *Buffer)

Variables
EFI_GUID	gEfiAuthenticationInfoProtocolGuid
EFI_GUID	gEfiAuthenticationChapRadiusGuid
EFI_GUID	gEfiAuthenticationChapLocalGuid

Detailed Description

EFI_AUTHENTICATION_INFO_PROTOCOL as defined in UEFI 2.0. This protocol is used on any device handle to obtain authentication information associated with the physical or logical device.

Copyright (c) 2006 - 2018, 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 that 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.

Macro Definition Documentation

EFI_AUTHENTICATION_CHAP_LOCAL_GUID

#define EFI_AUTHENTICATION_CHAP_LOCAL_GUID

Value:

  { \
    0xc280c73e, 0x15ca, 0x11da, {0xb0, 0xca, 0x00, 0x10, 0x83, 0xff, 0xca, 0x4d } \
  }

EFI_AUTHENTICATION_CHAP_RADIUS_GUID

#define EFI_AUTHENTICATION_CHAP_RADIUS_GUID

Value:

  { \
    0xd6062b50, 0x15ca, 0x11da, {0x92, 0x19, 0x00, 0x10, 0x83, 0xff, 0xca, 0x4d } \
  }

EFI_AUTHENTICATION_INFO_PROTOCOL_GUID

#define EFI_AUTHENTICATION_INFO_PROTOCOL_GUID

Value:

  { \
    0x7671d9d0, 0x53db, 0x4173, {0xaa, 0x69, 0x23, 0x27, 0xf2, 0x1f, 0x0b, 0xc7 } \
  }

Typedef Documentation

EFI_AUTHENTICATION_INFO_PROTOCOL

typedef struct _EFI_AUTHENTICATION_INFO_PROTOCOL EFI_AUTHENTICATION_INFO_PROTOCOL

EFI_AUTHENTICATION_INFO_PROTOCOL_GET

typedef EFI_STATUS(EFIAPI * EFI_AUTHENTICATION_INFO_PROTOCOL_GET) (IN EFI_AUTHENTICATION_INFO_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, OUT VOID **Buffer)

Retrieves the authentication information associated with a particular controller handle.

Parameters

[in]	This	The pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL.
[in]	ControllerHandle	The handle to the Controller.
[out]	Buffer	The pointer to the authentication information. This function is responsible for allocating the buffer and it is the caller's responsibility to free buffer when the caller is finished with buffer.

Return values

EFI_SUCCESS	Successfully retrieved authentication information for the given ControllerHandle.
EFI_INVALID_PARAMETER	No matching authentication information found for the given ControllerHandle.
EFI_DEVICE_ERROR	The authentication information could not be retrieved due to a hardware error.

EFI_AUTHENTICATION_INFO_PROTOCOL_SET

typedef EFI_STATUS(EFIAPI * EFI_AUTHENTICATION_INFO_PROTOCOL_SET) (IN EFI_AUTHENTICATION_INFO_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN VOID *Buffer)

Set the authentication information for a given controller handle.

Parameters

[in]	This	The pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL.
[in]	ControllerHandle	The handle to the Controller.
[in]	Buffer	The pointer to the authentication information.

Return values

EFI_SUCCESS	Successfully set authentication information for the given ControllerHandle.
EFI_UNSUPPORTED	If the platform policies do not allow setting of the authentication information.
EFI_DEVICE_ERROR	The authentication information could not be configured due to a hardware error.
EFI_OUT_OF_RESOURCES	Not enough storage is available to hold the data.

Variable Documentation

gEfiAuthenticationChapLocalGuid

EFI_GUID gEfiAuthenticationChapLocalGuid

extern

gEfiAuthenticationChapRadiusGuid

EFI_GUID gEfiAuthenticationChapRadiusGuid

extern

gEfiAuthenticationInfoProtocolGuid

EFI_GUID gEfiAuthenticationInfoProtocolGuid

extern