UserManager.h File Reference

Go to the source code of this file.

Data Structures
struct	EFI_USER_INFO
struct	EFI_USER_INFO_ACCESS_CONTROL
struct	EFI_USER_INFO_IDENTITY_POLICY
struct	EFI_USER_INFO_TABLE
struct	_EFI_USER_MANAGER_PROTOCOL

Macros
#define	EFI_USER_MANAGER_PROTOCOL_GUID
#define	EFI_EVENT_GROUP_USER_PROFILE_CHANGED
#define	EFI_USER_INFO_STORAGE   0x000F
#define	EFI_USER_INFO_STORAGE_VOLATILE   0x0000
#define	EFI_USER_INFO_STORAGE_CREDENTIAL_NV   0x0001
#define	EFI_USER_INFO_STORAGE_PLATFORM_NV   0x0002
#define	EFI_USER_INFO_ACCESS   0x0070
#define	EFI_USER_INFO_PUBLIC   0x0010
#define	EFI_USER_INFO_PRIVATE   0x0020
#define	EFI_USER_INFO_PROTECTED   0x0030
#define	EFI_USER_INFO_EXCLUSIVE   0x0080
#define	EFI_USER_CREDENTIAL_CLASS_UNKNOWN    { 0x5cf32e68, 0x7660, 0x449b, { 0x80, 0xe6, 0x7e, 0xa3, 0x6e, 0x3, 0xf6, 0xa8 } }
#define	EFI_USER_CREDENTIAL_CLASS_PASSWORD    { 0xf8e5058c, 0xccb6, 0x4714, { 0xb2, 0x20, 0x3f, 0x7e, 0x3a, 0x64, 0xb, 0xd1 } }
#define	EFI_USER_CREDENTIAL_CLASS_SMART_CARD    { 0x5f03ba33, 0x8c6b, 0x4c24, { 0xaa, 0x2e, 0x14, 0xa2, 0x65, 0x7b, 0xd4, 0x54 } }
#define	EFI_USER_CREDENTIAL_CLASS_FINGERPRINT    { 0x32cba21f, 0xf308, 0x4cbc, { 0x9a, 0xb5, 0xf5, 0xa3, 0x69, 0x9f, 0x4, 0x4a } }
#define	EFI_USER_CREDENTIAL_CLASS_HANDPRINT    { 0x5917ef16, 0xf723, 0x4bb9, { 0xa6, 0x4b, 0xd8, 0xc5, 0x32, 0xf4, 0xd8, 0xb5 } }
#define	EFI_USER_CREDENTIAL_CLASS_SECURE_CARD    { 0x8a6b4a83, 0x42fe, 0x45d2, { 0xa2, 0xef, 0x46, 0xf0, 0x6c, 0x7d, 0x98, 0x52 } }
#define	EFI_CREDENTIAL_CAPABILITIES_ENROLL   0x0000000000000001
#define	EFI_CREDENTIAL_LOGON_FLAG_AUTO   0x00000001
#define	EFI_CREDENTIAL_LOGON_FLAG_DEFAULT   0x00000002
#define	EFI_USER_INFO_EMPTY_RECORD   0x00
#define	EFI_USER_INFO_NAME_RECORD   0x01
#define	EFI_USER_INFO_CREATE_DATE_RECORD   0x02
#define	EFI_USER_INFO_USAGE_DATE_RECORD   0x03
#define	EFI_USER_INFO_USAGE_COUNT_RECORD   0x04
#define	EFI_USER_INFO_IDENTIFIER_RECORD   0x05
#define	EFI_USER_INFO_CREDENTIAL_TYPE_RECORD   0x06
#define	EFI_USER_INFO_CREDENTIAL_TYPE_NAME_RECORD   0x07
#define	EFI_USER_INFO_CREDENTIAL_PROVIDER_RECORD   0x08
#define	EFI_USER_INFO_CREDENTIAL_PROVIDER_NAME_RECORD   0x09
#define	EFI_USER_INFO_PKCS11_RECORD   0x0A
#define	EFI_USER_INFO_CBEFF_RECORD   0x0B
#define	EFI_USER_INFO_FAR_RECORD   0x0C
#define	EFI_USER_INFO_RETRY_RECORD   0x0D
#define	EFI_USER_INFO_ACCESS_POLICY_RECORD   0x0E
#define	EFI_USER_INFO_ACCESS_FORBID_LOAD   0x00000001
#define	EFI_USER_INFO_ACCESS_PERMIT_LOAD   0x00000002
#define	EFI_USER_INFO_ACCESS_ENROLL_SELF   0x00000003
#define	EFI_USER_INFO_ACCESS_ENROLL_OTHERS   0x00000004
#define	EFI_USER_INFO_ACCESS_MANAGE   0x00000005
#define	EFI_USER_INFO_ACCESS_SETUP   0x00000006
#define	EFI_USER_INFO_ACCESS_SETUP_ADMIN_GUID    { 0x85b75607, 0xf7ce, 0x471e, { 0xb7, 0xe4, 0x2a, 0xea, 0x5f, 0x72, 0x32, 0xee } }
#define	EFI_USER_INFO_ACCESS_SETUP_NORMAL_GUID    { 0x1db29ae0, 0x9dcb, 0x43bc, { 0x8d, 0x87, 0x5d, 0xa1, 0x49, 0x64, 0xdd, 0xe2 } }
#define	EFI_USER_INFO_ACCESS_SETUP_RESTRICTED_GUID    { 0xbdb38125, 0x4d63, 0x49f4, { 0x82, 0x12, 0x61, 0xcf, 0x5a, 0x19, 0xa, 0xf8 } }
#define	EFI_USER_INFO_ACCESS_FORBID_CONNECT   0x00000007
#define	EFI_USER_INFO_ACCESS_PERMIT_CONNECT   0x00000008
#define	EFI_USER_INFO_ACCESS_BOOT_ORDER   0x00000009
#define	EFI_USER_INFO_ACCESS_BOOT_ORDER_MASK   0x0000000F
#define	EFI_USER_INFO_ACCESS_BOOT_ORDER_INSERT   0x00000000
#define	EFI_USER_INFO_ACCESS_BOOT_ORDER_APPEND   0x00000001
#define	EFI_USER_INFO_ACCESS_BOOT_ORDER_REPLACE   0x00000002
#define	EFI_USER_INFO_ACCESS_BOOT_ORDER_NODEFAULT   0x00000010
#define	EFI_USER_INFO_IDENTITY_POLICY_RECORD   0x0F
#define	EFI_USER_INFO_IDENTITY_FALSE   0x00
#define	EFI_USER_INFO_IDENTITY_TRUE   0x01
#define	EFI_USER_INFO_IDENTITY_CREDENTIAL_TYPE   0x02
#define	EFI_USER_INFO_IDENTITY_CREDENTIAL_PROVIDER   0x03
#define	EFI_USER_INFO_IDENTITY_NOT   0x10
#define	EFI_USER_INFO_IDENTITY_AND   0x11
#define	EFI_USER_INFO_IDENTITY_OR   0x12
#define	EFI_USER_INFO_GUID_RECORD   0xFF

Typedefs
typedef VOID *	EFI_USER_PROFILE_HANDLE
typedef VOID *	EFI_USER_INFO_HANDLE
typedef UINT16	EFI_USER_INFO_ATTRIBS
typedef UINT64	EFI_CREDENTIAL_CAPABILITIES
typedef UINT32	EFI_CREDENTIAL_LOGON_FLAGS
typedef CHAR16 *	EFI_USER_INFO_NAME
typedef EFI_TIME	EFI_USER_INFO_CREATE_DATE
typedef EFI_TIME	EFI_USER_INFO_USAGE_DATE
typedef UINT64	EFI_USER_INFO_USAGE_COUNT
typedef UINT8	EFI_USER_INFO_IDENTIFIER[16]
typedef EFI_GUID	EFI_USER_INFO_CREDENTIAL_TYPE
typedef CHAR16 *	EFI_USER_INFO_CREDENTIAL_TYPE_NAME
typedef EFI_GUID	EFI_USER_INFO_CREDENTIAL_PROVIDER
typedef CHAR16 *	EFI_USER_INFO_CREDENTIAL_PROVIDER_NAME
typedef VOID *	EFI_USER_INFO_CBEFF
typedef UINT8	EFI_USER_INFO_FAR
typedef UINT8	EFI_USER_INFO_RETRY
typedef EFI_USER_INFO_ACCESS_CONTROL	EFI_USER_INFO_ACCESS_POLICY
typedef UINT32	EFI_USER_INFO_ACCESS_BOOT_ORDER_HDR
typedef EFI_GUID	EFI_USER_INFO_GUID
typedef struct _EFI_USER_MANAGER_PROTOCOL	EFI_USER_MANAGER_PROTOCOL
typedef EFI_STATUS(EFIAPI *	EFI_USER_PROFILE_CREATE) (IN CONST EFI_USER_MANAGER_PROTOCOL *This, OUT EFI_USER_PROFILE_HANDLE *User)
typedef EFI_STATUS(EFIAPI *	EFI_USER_PROFILE_DELETE) (IN CONST EFI_USER_MANAGER_PROTOCOL *This, IN EFI_USER_PROFILE_HANDLE User)
typedef EFI_STATUS(EFIAPI *	EFI_USER_PROFILE_GET_NEXT) (IN CONST EFI_USER_MANAGER_PROTOCOL *This, IN OUT EFI_USER_PROFILE_HANDLE *User)
typedef EFI_STATUS(EFIAPI *	EFI_USER_PROFILE_CURRENT) (IN CONST EFI_USER_MANAGER_PROTOCOL *This, OUT EFI_USER_PROFILE_HANDLE *CurrentUser)
typedef EFI_STATUS(EFIAPI *	EFI_USER_PROFILE_IDENTIFY) (IN CONST EFI_USER_MANAGER_PROTOCOL *This, OUT EFI_USER_PROFILE_HANDLE *User)
typedef EFI_STATUS(EFIAPI *	EFI_USER_PROFILE_FIND) (IN CONST EFI_USER_MANAGER_PROTOCOL *This, IN OUT EFI_USER_PROFILE_HANDLE *User, IN OUT EFI_USER_INFO_HANDLE *UserInfo OPTIONAL, IN CONST EFI_USER_INFO *Info, IN UINTN InfoSize)
typedef EFI_STATUS(EFIAPI *	EFI_USER_PROFILE_NOTIFY) (IN CONST EFI_USER_MANAGER_PROTOCOL *This, IN EFI_HANDLE Changed)
typedef EFI_STATUS(EFIAPI *	EFI_USER_PROFILE_GET_INFO) (IN CONST EFI_USER_MANAGER_PROTOCOL *This, IN EFI_USER_PROFILE_HANDLE User, IN EFI_USER_INFO_HANDLE UserInfo, OUT EFI_USER_INFO *Info, IN OUT UINTN *InfoSize)
typedef EFI_STATUS(EFIAPI *	EFI_USER_PROFILE_SET_INFO) (IN CONST EFI_USER_MANAGER_PROTOCOL *This, IN EFI_USER_PROFILE_HANDLE User, IN OUT EFI_USER_INFO_HANDLE *UserInfo, IN CONST EFI_USER_INFO *Info, IN UINTN InfoSize)
typedef EFI_STATUS(EFIAPI *	EFI_USER_PROFILE_DELETE_INFO) (IN CONST EFI_USER_MANAGER_PROTOCOL *This, IN EFI_USER_PROFILE_HANDLE User, IN EFI_USER_INFO_HANDLE UserInfo)
typedef EFI_STATUS(EFIAPI *	EFI_USER_PROFILE_GET_NEXT_INFO) (IN CONST EFI_USER_MANAGER_PROTOCOL *This, IN EFI_USER_PROFILE_HANDLE User, IN OUT EFI_USER_INFO_HANDLE *UserInfo)

Variables
EFI_GUID	gEfiUserManagerProtocolGuid
EFI_GUID	gEfiEventUserProfileChangedGuid
EFI_GUID	gEfiUserCredentialClassUnknownGuid
EFI_GUID	gEfiUserCredentialClassPasswordGuid
EFI_GUID	gEfiUserCredentialClassSmartCardGuid
EFI_GUID	gEfiUserCredentialClassFingerprintGuid
EFI_GUID	gEfiUserCredentialClassHandprintGuid
EFI_GUID	gEfiUserCredentialClassSecureCardGuid
EFI_GUID	gEfiUserInfoAccessSetupAdminGuid
EFI_GUID	gEfiUserInfoAccessSetupNormalGuid
EFI_GUID	gEfiUserInfoAccessSetupRestrictedGuid

Detailed Description

UEFI User Manager Protocol definition.

This protocol manages user profiles.

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

Definition in file UserManager.h.

Macro Definition Documentation

EFI_CREDENTIAL_CAPABILITIES_ENROLL

#define EFI_CREDENTIAL_CAPABILITIES_ENROLL   0x0000000000000001

Definition at line 89 of file UserManager.h.

EFI_CREDENTIAL_LOGON_FLAG_AUTO

#define EFI_CREDENTIAL_LOGON_FLAG_AUTO   0x00000001

Definition at line 95 of file UserManager.h.

EFI_CREDENTIAL_LOGON_FLAG_DEFAULT

#define EFI_CREDENTIAL_LOGON_FLAG_DEFAULT   0x00000002

Definition at line 96 of file UserManager.h.

EFI_EVENT_GROUP_USER_PROFILE_CHANGED

#define EFI_EVENT_GROUP_USER_PROFILE_CHANGED

Value:

  { \
    0xbaf1e6de, 0x209e, 0x4adb, { 0x8d, 0x96, 0xfd, 0x8b, 0x71, 0xf3, 0xf6, 0x83 } \
  }

Definition at line 22 of file UserManager.h.

EFI_USER_CREDENTIAL_CLASS_FINGERPRINT

#define EFI_USER_CREDENTIAL_CLASS_FINGERPRINT    { 0x32cba21f, 0xf308, 0x4cbc, { 0x9a, 0xb5, 0xf5, 0xa3, 0x69, 0x9f, 0x4, 0x4a } }

Definition at line 81 of file UserManager.h.

EFI_USER_CREDENTIAL_CLASS_HANDPRINT

#define EFI_USER_CREDENTIAL_CLASS_HANDPRINT    { 0x5917ef16, 0xf723, 0x4bb9, { 0xa6, 0x4b, 0xd8, 0xc5, 0x32, 0xf4, 0xd8, 0xb5 } }

Definition at line 83 of file UserManager.h.

EFI_USER_CREDENTIAL_CLASS_PASSWORD

#define EFI_USER_CREDENTIAL_CLASS_PASSWORD    { 0xf8e5058c, 0xccb6, 0x4714, { 0xb2, 0x20, 0x3f, 0x7e, 0x3a, 0x64, 0xb, 0xd1 } }

Definition at line 77 of file UserManager.h.

EFI_USER_CREDENTIAL_CLASS_SECURE_CARD

#define EFI_USER_CREDENTIAL_CLASS_SECURE_CARD    { 0x8a6b4a83, 0x42fe, 0x45d2, { 0xa2, 0xef, 0x46, 0xf0, 0x6c, 0x7d, 0x98, 0x52 } }

Definition at line 85 of file UserManager.h.

EFI_USER_CREDENTIAL_CLASS_SMART_CARD

#define EFI_USER_CREDENTIAL_CLASS_SMART_CARD    { 0x5f03ba33, 0x8c6b, 0x4c24, { 0xaa, 0x2e, 0x14, 0xa2, 0x65, 0x7b, 0xd4, 0x54 } }

Definition at line 79 of file UserManager.h.

EFI_USER_CREDENTIAL_CLASS_UNKNOWN

#define EFI_USER_CREDENTIAL_CLASS_UNKNOWN    { 0x5cf32e68, 0x7660, 0x449b, { 0x80, 0xe6, 0x7e, 0xa3, 0x6e, 0x3, 0xf6, 0xa8 } }

User credential class GUIDs

Definition at line 75 of file UserManager.h.

EFI_USER_INFO_ACCESS

#define EFI_USER_INFO_ACCESS   0x0070

Definition at line 39 of file UserManager.h.

EFI_USER_INFO_ACCESS_BOOT_ORDER

#define EFI_USER_INFO_ACCESS_BOOT_ORDER   0x00000009

Modifies the boot order.

Definition at line 238 of file UserManager.h.

EFI_USER_INFO_ACCESS_BOOT_ORDER_APPEND

#define EFI_USER_INFO_ACCESS_BOOT_ORDER_APPEND   0x00000001

Append new boot options to the end of the boot order.

Definition at line 249 of file UserManager.h.

EFI_USER_INFO_ACCESS_BOOT_ORDER_INSERT

#define EFI_USER_INFO_ACCESS_BOOT_ORDER_INSERT   0x00000000

Insert new boot options at the beginning of the boot order.

Definition at line 245 of file UserManager.h.

EFI_USER_INFO_ACCESS_BOOT_ORDER_MASK

#define EFI_USER_INFO_ACCESS_BOOT_ORDER_MASK   0x0000000F

Definition at line 241 of file UserManager.h.

EFI_USER_INFO_ACCESS_BOOT_ORDER_NODEFAULT

#define EFI_USER_INFO_ACCESS_BOOT_ORDER_NODEFAULT   0x00000010

The Boot Manager will not attempt find a default boot device when the default boot order is does not lead to a bootable device.

Definition at line 258 of file UserManager.h.

EFI_USER_INFO_ACCESS_BOOT_ORDER_REPLACE

#define EFI_USER_INFO_ACCESS_BOOT_ORDER_REPLACE   0x00000002

Replace the entire boot order.

Definition at line 253 of file UserManager.h.

EFI_USER_INFO_ACCESS_ENROLL_OTHERS

#define EFI_USER_INFO_ACCESS_ENROLL_OTHERS   0x00000004

Presence of this record indicates that a user can enroll new users.

Definition at line 208 of file UserManager.h.

EFI_USER_INFO_ACCESS_ENROLL_SELF

#define EFI_USER_INFO_ACCESS_ENROLL_SELF   0x00000003

Presence of this record indicates that a user can update enrollment information.

Definition at line 204 of file UserManager.h.

EFI_USER_INFO_ACCESS_FORBID_CONNECT

#define EFI_USER_INFO_ACCESS_FORBID_CONNECT   0x00000007

Forbids UEFI drivers from being started from the specified device path(s) or any child device paths.

Definition at line 230 of file UserManager.h.

EFI_USER_INFO_ACCESS_FORBID_LOAD

#define EFI_USER_INFO_ACCESS_FORBID_LOAD   0x00000001

User Information access types Forbids the user from booting or loading executables from the specified device path or any child device paths.

Definition at line 192 of file UserManager.h.

EFI_USER_INFO_ACCESS_MANAGE

#define EFI_USER_INFO_ACCESS_MANAGE   0x00000005

Presence of this record indicates that a user can update the user information of any user.

Definition at line 212 of file UserManager.h.

EFI_USER_INFO_ACCESS_PERMIT_CONNECT

#define EFI_USER_INFO_ACCESS_PERMIT_CONNECT   0x00000008

Permits UEFI drivers to be started on the specified device path(s) or any child device paths.

Definition at line 234 of file UserManager.h.

EFI_USER_INFO_ACCESS_PERMIT_LOAD

#define EFI_USER_INFO_ACCESS_PERMIT_LOAD   0x00000002

Permits the user from booting or loading executables from the specified device path or any child device paths. Note: in-consistency between code and the UEFI 2.3 specification here. The definition EFI_USER_INFO_ACCESS_PERMIT_BOOT in the specification should be typo and wait for spec update.

Definition at line 200 of file UserManager.h.

EFI_USER_INFO_ACCESS_POLICY_RECORD

#define EFI_USER_INFO_ACCESS_POLICY_RECORD   0x0E

Provides the user's pre-OS access rights.

Definition at line 175 of file UserManager.h.

EFI_USER_INFO_ACCESS_SETUP

#define EFI_USER_INFO_ACCESS_SETUP   0x00000006

Describes permissions usable when configuring the platform.

Definition at line 216 of file UserManager.h.

EFI_USER_INFO_ACCESS_SETUP_ADMIN_GUID

#define EFI_USER_INFO_ACCESS_SETUP_ADMIN_GUID    { 0x85b75607, 0xf7ce, 0x471e, { 0xb7, 0xe4, 0x2a, 0xea, 0x5f, 0x72, 0x32, 0xee } }

Standard GUIDs for access to configure the platform.

Definition at line 220 of file UserManager.h.

EFI_USER_INFO_ACCESS_SETUP_NORMAL_GUID

#define EFI_USER_INFO_ACCESS_SETUP_NORMAL_GUID    { 0x1db29ae0, 0x9dcb, 0x43bc, { 0x8d, 0x87, 0x5d, 0xa1, 0x49, 0x64, 0xdd, 0xe2 } }

Definition at line 222 of file UserManager.h.

EFI_USER_INFO_ACCESS_SETUP_RESTRICTED_GUID

#define EFI_USER_INFO_ACCESS_SETUP_RESTRICTED_GUID    { 0xbdb38125, 0x4d63, 0x49f4, { 0x82, 0x12, 0x61, 0xcf, 0x5a, 0x19, 0xa, 0xf8 } }

Definition at line 224 of file UserManager.h.

EFI_USER_INFO_CBEFF_RECORD

#define EFI_USER_INFO_CBEFF_RECORD   0x0B

Provides standard biometric information in the format specified by the ISO 19785 (Common Biometric Exchange Formats Framework) specification.

Definition at line 159 of file UserManager.h.

EFI_USER_INFO_CREATE_DATE_RECORD

#define EFI_USER_INFO_CREATE_DATE_RECORD   0x02

Provides the date and time when the user profile was created.

Definition at line 114 of file UserManager.h.

EFI_USER_INFO_CREDENTIAL_PROVIDER_NAME_RECORD

#define EFI_USER_INFO_CREDENTIAL_PROVIDER_NAME_RECORD   0x09

Specifies the user-readable name of a particular credential's provider.

Definition at line 149 of file UserManager.h.

EFI_USER_INFO_CREDENTIAL_PROVIDER_RECORD

#define EFI_USER_INFO_CREDENTIAL_PROVIDER_RECORD   0x08

Specifies the credential provider.

Definition at line 144 of file UserManager.h.

EFI_USER_INFO_CREDENTIAL_TYPE_NAME_RECORD

#define EFI_USER_INFO_CREDENTIAL_TYPE_NAME_RECORD   0x07

Specifies the user-readable name of a particular credential type.

Definition at line 139 of file UserManager.h.

EFI_USER_INFO_CREDENTIAL_TYPE_RECORD

#define EFI_USER_INFO_CREDENTIAL_TYPE_RECORD   0x06

Specifies the type of a particular credential associated with the user profile.

Definition at line 134 of file UserManager.h.

EFI_USER_INFO_EMPTY_RECORD

#define EFI_USER_INFO_EMPTY_RECORD   0x00

User information record types No information.

Definition at line 105 of file UserManager.h.

EFI_USER_INFO_EXCLUSIVE

#define EFI_USER_INFO_EXCLUSIVE   0x0080

Definition at line 43 of file UserManager.h.

EFI_USER_INFO_FAR_RECORD

#define EFI_USER_INFO_FAR_RECORD   0x0C

Indicates how close of a match the fingerprint must be in order to be considered a match.

Definition at line 164 of file UserManager.h.

EFI_USER_INFO_GUID_RECORD

#define EFI_USER_INFO_GUID_RECORD   0xFF

Provides placeholder for additional user profile information identified by a GUID.

Definition at line 284 of file UserManager.h.

EFI_USER_INFO_IDENTIFIER_RECORD

#define EFI_USER_INFO_IDENTIFIER_RECORD   0x05

Provides a unique non-volatile user identifier for each enrolled user.

Definition at line 129 of file UserManager.h.

EFI_USER_INFO_IDENTITY_AND

#define EFI_USER_INFO_IDENTITY_AND   0x11

Definition at line 278 of file UserManager.h.

EFI_USER_INFO_IDENTITY_CREDENTIAL_PROVIDER

#define EFI_USER_INFO_IDENTITY_CREDENTIAL_PROVIDER   0x03

Definition at line 276 of file UserManager.h.

EFI_USER_INFO_IDENTITY_CREDENTIAL_TYPE

#define EFI_USER_INFO_IDENTITY_CREDENTIAL_TYPE   0x02

Definition at line 275 of file UserManager.h.

EFI_USER_INFO_IDENTITY_FALSE

#define EFI_USER_INFO_IDENTITY_FALSE   0x00

User identity policy expression operators.

Definition at line 273 of file UserManager.h.

EFI_USER_INFO_IDENTITY_NOT

#define EFI_USER_INFO_IDENTITY_NOT   0x10

Definition at line 277 of file UserManager.h.

EFI_USER_INFO_IDENTITY_OR

#define EFI_USER_INFO_IDENTITY_OR   0x12

Definition at line 279 of file UserManager.h.

EFI_USER_INFO_IDENTITY_POLICY_RECORD

#define EFI_USER_INFO_IDENTITY_POLICY_RECORD   0x0F

Provides the expression which determines which credentials are required to assert user identity.

Definition at line 263 of file UserManager.h.

EFI_USER_INFO_IDENTITY_TRUE

#define EFI_USER_INFO_IDENTITY_TRUE   0x01

Definition at line 274 of file UserManager.h.

EFI_USER_INFO_NAME_RECORD

#define EFI_USER_INFO_NAME_RECORD   0x01

Provide the user's name for the enrolled user.

Definition at line 109 of file UserManager.h.

EFI_USER_INFO_PKCS11_RECORD

#define EFI_USER_INFO_PKCS11_RECORD   0x0A

Provides PKCS#11 credential information from a smart card.

Definition at line 154 of file UserManager.h.

EFI_USER_INFO_PRIVATE

#define EFI_USER_INFO_PRIVATE   0x0020

Definition at line 41 of file UserManager.h.

EFI_USER_INFO_PROTECTED

#define EFI_USER_INFO_PROTECTED   0x0030

Definition at line 42 of file UserManager.h.

EFI_USER_INFO_PUBLIC

#define EFI_USER_INFO_PUBLIC   0x0010

Definition at line 40 of file UserManager.h.

EFI_USER_INFO_RETRY_RECORD

#define EFI_USER_INFO_RETRY_RECORD   0x0D

Indicates how many attempts the user has to with a particular credential before the system prevents further attempts.

Definition at line 170 of file UserManager.h.

EFI_USER_INFO_STORAGE

#define EFI_USER_INFO_STORAGE   0x000F

Definition at line 34 of file UserManager.h.

EFI_USER_INFO_STORAGE_CREDENTIAL_NV

#define EFI_USER_INFO_STORAGE_CREDENTIAL_NV   0x0001

Definition at line 36 of file UserManager.h.

EFI_USER_INFO_STORAGE_PLATFORM_NV

#define EFI_USER_INFO_STORAGE_PLATFORM_NV   0x0002

Definition at line 37 of file UserManager.h.

EFI_USER_INFO_STORAGE_VOLATILE

#define EFI_USER_INFO_STORAGE_VOLATILE   0x0000

Definition at line 35 of file UserManager.h.

EFI_USER_INFO_USAGE_COUNT_RECORD

#define EFI_USER_INFO_USAGE_COUNT_RECORD   0x04

Provides the number of times that the user profile has been selected.

Definition at line 124 of file UserManager.h.

EFI_USER_INFO_USAGE_DATE_RECORD

#define EFI_USER_INFO_USAGE_DATE_RECORD   0x03

Provides the date and time when the user profile was selected.

Definition at line 119 of file UserManager.h.

EFI_USER_MANAGER_PROTOCOL_GUID

#define EFI_USER_MANAGER_PROTOCOL_GUID

Value:

  { \
    0x6fd5b00c, 0xd426, 0x4283, { 0x98, 0x87, 0x6c, 0xf5, 0xcf, 0x1c, 0xb1, 0xfe } \
  }

Global ID for the User Manager Protocol

Definition at line 17 of file UserManager.h.

Typedef Documentation

EFI_CREDENTIAL_CAPABILITIES

typedef UINT64 EFI_CREDENTIAL_CAPABILITIES

Definition at line 88 of file UserManager.h.

EFI_CREDENTIAL_LOGON_FLAGS

typedef UINT32 EFI_CREDENTIAL_LOGON_FLAGS

Credential logon flags

Definition at line 94 of file UserManager.h.

EFI_USER_INFO_ACCESS_BOOT_ORDER_HDR

typedef UINT32 EFI_USER_INFO_ACCESS_BOOT_ORDER_HDR

Definition at line 239 of file UserManager.h.

EFI_USER_INFO_ACCESS_POLICY

typedef EFI_USER_INFO_ACCESS_CONTROL EFI_USER_INFO_ACCESS_POLICY

Definition at line 182 of file UserManager.h.

EFI_USER_INFO_ATTRIBS

typedef UINT16 EFI_USER_INFO_ATTRIBS

The attributes of the user profile information.

Definition at line 33 of file UserManager.h.

EFI_USER_INFO_CBEFF

typedef VOID* EFI_USER_INFO_CBEFF

Definition at line 160 of file UserManager.h.

EFI_USER_INFO_CREATE_DATE

typedef EFI_TIME EFI_USER_INFO_CREATE_DATE

Definition at line 115 of file UserManager.h.

EFI_USER_INFO_CREDENTIAL_PROVIDER

typedef EFI_GUID EFI_USER_INFO_CREDENTIAL_PROVIDER

Definition at line 145 of file UserManager.h.

EFI_USER_INFO_CREDENTIAL_PROVIDER_NAME

typedef CHAR16* EFI_USER_INFO_CREDENTIAL_PROVIDER_NAME

Definition at line 150 of file UserManager.h.

EFI_USER_INFO_CREDENTIAL_TYPE

typedef EFI_GUID EFI_USER_INFO_CREDENTIAL_TYPE

Definition at line 135 of file UserManager.h.

EFI_USER_INFO_CREDENTIAL_TYPE_NAME

typedef CHAR16* EFI_USER_INFO_CREDENTIAL_TYPE_NAME

Definition at line 140 of file UserManager.h.

EFI_USER_INFO_FAR

typedef UINT8 EFI_USER_INFO_FAR

Definition at line 165 of file UserManager.h.

EFI_USER_INFO_GUID

typedef EFI_GUID EFI_USER_INFO_GUID

Definition at line 285 of file UserManager.h.

EFI_USER_INFO_HANDLE

typedef VOID* EFI_USER_INFO_HANDLE

Definition at line 28 of file UserManager.h.

EFI_USER_INFO_IDENTIFIER

typedef UINT8 EFI_USER_INFO_IDENTIFIER[16]

Definition at line 130 of file UserManager.h.

EFI_USER_INFO_NAME

typedef CHAR16* EFI_USER_INFO_NAME

Definition at line 110 of file UserManager.h.

EFI_USER_INFO_RETRY

typedef UINT8 EFI_USER_INFO_RETRY

Definition at line 171 of file UserManager.h.

EFI_USER_INFO_USAGE_COUNT

typedef UINT64 EFI_USER_INFO_USAGE_COUNT

Definition at line 125 of file UserManager.h.

EFI_USER_INFO_USAGE_DATE

typedef EFI_TIME EFI_USER_INFO_USAGE_DATE

Definition at line 120 of file UserManager.h.

EFI_USER_MANAGER_PROTOCOL

typedef struct _EFI_USER_MANAGER_PROTOCOL EFI_USER_MANAGER_PROTOCOL

Definition at line 295 of file UserManager.h.

EFI_USER_PROFILE_CREATE

typedef EFI_STATUS(EFIAPI * EFI_USER_PROFILE_CREATE) (IN CONST EFI_USER_MANAGER_PROTOCOL *This, OUT EFI_USER_PROFILE_HANDLE *User)

Create a new user profile.

This function creates a new user profile with only a new user identifier attached and returns its handle. The user profile is non-volatile, but the handle User can change across reboots.

Parameters

[in]	This	Points to this instance of the EFI_USER_MANAGER_PROTOCOL.
[out]	User	On return, points to the new user profile handle. The user profile handle is unique only during this boot.

Return values

EFI_SUCCESS	User profile was successfully created.
EFI_ACCESS_DENIED	Current user does not have sufficient permissions to create a user profile.
EFI_UNSUPPORTED	Creation of new user profiles is not supported.
EFI_INVALID_PARAMETER	The User parameter is NULL.

Definition at line 313 of file UserManager.h.

EFI_USER_PROFILE_CURRENT

typedef EFI_STATUS(EFIAPI * EFI_USER_PROFILE_CURRENT) (IN CONST EFI_USER_MANAGER_PROTOCOL *This, OUT EFI_USER_PROFILE_HANDLE *CurrentUser)

Return the current user profile handle.

Parameters

[in]	This	Points to this instance of the EFI_USER_MANAGER_PROTOCOL.
[out]	CurrentUser	On return, points to the current user profile handle.

Return values

EFI_SUCCESS	Current user profile handle returned successfully.
EFI_INVALID_PARAMETER	The CurrentUser parameter is NULL.

Definition at line 371 of file UserManager.h.

EFI_USER_PROFILE_DELETE

typedef EFI_STATUS(EFIAPI * EFI_USER_PROFILE_DELETE) (IN CONST EFI_USER_MANAGER_PROTOCOL *This, IN EFI_USER_PROFILE_HANDLE User)

Delete an existing user profile.

Parameters

[in]	This	Points to this instance of the EFI_USER_MANAGER_PROTOCOL.
[in]	User	User profile handle.

Return values

EFI_SUCCESS	User profile was successfully deleted.
EFI_ACCESS_DENIED	Current user does not have sufficient permissions to delete a user profile or there is only one user profile.
EFI_UNSUPPORTED	Deletion of new user profiles is not supported.
EFI_INVALID_PARAMETER	User does not refer to a valid user profile.

Definition at line 332 of file UserManager.h.

EFI_USER_PROFILE_DELETE_INFO

typedef EFI_STATUS(EFIAPI * EFI_USER_PROFILE_DELETE_INFO) (IN CONST EFI_USER_MANAGER_PROTOCOL *This, IN EFI_USER_PROFILE_HANDLE User, IN EFI_USER_INFO_HANDLE UserInfo)

Delete user information.

Delete the user information attached to the user profile specified by the UserInfo.

Parameters

[in]	This	Points to this instance of the EFI_USER_MANAGER_PROTOCOL.
[in]	User	Handle of the user whose information will be deleted.
[in]	UserInfo	Handle of the user information to remove.

Return values

EFI_SUCCESS	User information deleted successfully.
EFI_NOT_FOUND	User information record UserInfo does not exist in the user profile.
EFI_ACCESS_DENIED	The current user does not have permission to delete this user information.

Definition at line 559 of file UserManager.h.

EFI_USER_PROFILE_FIND

typedef EFI_STATUS(EFIAPI * EFI_USER_PROFILE_FIND) (IN CONST EFI_USER_MANAGER_PROTOCOL *This, IN OUT EFI_USER_PROFILE_HANDLE *User, IN OUT EFI_USER_INFO_HANDLE *UserInfo OPTIONAL, IN CONST EFI_USER_INFO *Info, IN UINTN InfoSize)

Find a user using a user information record.

This function searches all user profiles for the specified user information record. The search starts with the user information record handle following UserInfo and continues until either the information is found or there are no more user profiles. A match occurs when the Info.InfoType field matches the user information record type and the user information record data matches the portion of Info.

Parameters

[in]	This	Points to this instance of the EFI_USER_MANAGER_PROTOCOL.
[in,out]	User	On entry, points to the previously returned user profile handle or NULL to start searching with the first user profile. On return, points to the user profile handle or NULL if not found.
[in,out]	UserInfo	On entry, points to the previously returned user information handle or NULL to start searching with the first. On return, points to the user information handle of the user information record or NULL if not found. Can be NULL, in which case only one user information record per user can be returned.
[in]	Info	Points to the buffer containing the user information to be compared to the user information record. If the user information record data is empty, then only the user information record type is compared. If InfoSize is 0, then the user information record must be empty.
[in]	InfoSize	The size of Info, in bytes.

Return values

EFI_SUCCESS	User information was found. User points to the user profile handle and UserInfo points to the user information handle.
EFI_NOT_FOUND	User information was not found. User points to NULL and UserInfo points to NULL.
EFI_INVALID_PARAMETER	User is NULL. Or Info is NULL.

Definition at line 430 of file UserManager.h.

EFI_USER_PROFILE_GET_INFO

typedef EFI_STATUS(EFIAPI * EFI_USER_PROFILE_GET_INFO) (IN CONST EFI_USER_MANAGER_PROTOCOL *This, IN EFI_USER_PROFILE_HANDLE User, IN EFI_USER_INFO_HANDLE UserInfo, OUT EFI_USER_INFO *Info, IN OUT UINTN *InfoSize)

Return information attached to the user.

This function returns user information. The format of the information is described in User Information. The function may return EFI_ACCESS_DENIED if the information is marked private and the handle specified by User is not the current user profile. The function may return EFI_ACCESS_DENIED if the information is marked protected and the information is associated with a credential provider for which the user has not been authenticated.

Parameters

[in]	This	Points to this instance of the EFI_USER_MANAGER_PROTOCOL.
[in]	User	Handle of the user whose profile will be retrieved.
[in]	UserInfo	Handle of the user information data record.
[out]	Info	On entry, points to a buffer of at least *InfoSize bytes. On exit, holds the user information. If the buffer is too small to hold the information, then EFI_BUFFER_TOO_SMALL is returned and InfoSize is updated to contain the number of bytes actually required.
[in,out]	InfoSize	On entry, points to the size of Info. On return, points to the size of the user information.

Return values

EFI_SUCCESS	Information returned successfully.
EFI_ACCESS_DENIED	The information about the specified user cannot be accessed by the current user.
EFI_BUFFER_TOO_SMALL	The number of bytes specified by *InfoSize is too small to hold the returned data. The actual size required is returned in *InfoSize.
EFI_NOT_FOUND	User does not refer to a valid user profile or UserInfo does not refer to a valid user info handle.
EFI_INVALID_PARAMETER	Info is NULL or InfoSize is NULL.

Definition at line 496 of file UserManager.h.

EFI_USER_PROFILE_GET_NEXT

typedef EFI_STATUS(EFIAPI * EFI_USER_PROFILE_GET_NEXT) (IN CONST EFI_USER_MANAGER_PROTOCOL *This, IN OUT EFI_USER_PROFILE_HANDLE *User)

Enumerate all of the enrolled users on the platform.

This function returns the next enrolled user profile. To retrieve the first user profile handle, point User at a NULL. Each subsequent call will retrieve another user profile handle until there are no more, at which point User will point to NULL.

Parameters

[in]	This	Points to this instance of the EFI_USER_MANAGER_PROTOCOL.
[in,out]	User	On entry, points to the previous user profile handle or NULL to start enumeration. On exit, points to the next user profile handle or NULL if there are no more user profiles.

Return values

EFI_SUCCESS	Next enrolled user profile successfully returned.
EFI_ACCESS_DENIED	Next enrolled user profile was not successfully returned.
EFI_INVALID_PARAMETER	The User parameter is NULL.

Definition at line 355 of file UserManager.h.

EFI_USER_PROFILE_GET_NEXT_INFO

typedef EFI_STATUS(EFIAPI * EFI_USER_PROFILE_GET_NEXT_INFO) (IN CONST EFI_USER_MANAGER_PROTOCOL *This, IN EFI_USER_PROFILE_HANDLE User, IN OUT EFI_USER_INFO_HANDLE *UserInfo)

Enumerate user information of all the enrolled users on the platform.

This function returns the next user information record. To retrieve the first user information record handle, point UserInfo at a NULL. Each subsequent call will retrieve another user information record handle until there are no more, at which point UserInfo will point to NULL.

Parameters

[in]	This	Points to this instance of the EFI_USER_MANAGER_PROTOCOL.
[in]	User	Handle of the user whose information will be deleted.
[in,out]	UserInfo	Handle of the user information to remove.

Return values

EFI_SUCCESS	User information returned.
EFI_NOT_FOUND	No more user information found.
EFI_INVALID_PARAMETER	UserInfo is NULL.

Definition at line 582 of file UserManager.h.

EFI_USER_PROFILE_HANDLE

typedef VOID* EFI_USER_PROFILE_HANDLE

Definition at line 27 of file UserManager.h.

EFI_USER_PROFILE_IDENTIFY

typedef EFI_STATUS(EFIAPI * EFI_USER_PROFILE_IDENTIFY) (IN CONST EFI_USER_MANAGER_PROTOCOL *This, OUT EFI_USER_PROFILE_HANDLE *User)

Identify a user.

Identify the user and, if authenticated, returns the user handle and changes the current user profile. All user information marked as private in a previously selected profile is no longer available for inspection. Whenever the current user profile is changed then the an event with the GUID EFI_EVENT_GROUP_USER_PROFILE_CHANGED is signaled.

Parameters

[in]	This	Points to this instance of the EFI_USER_MANAGER_PROTOCOL.
[out]	User	On return, points to the user profile handle for the current user profile.

Return values

EFI_SUCCESS	User was successfully identified.
EFI_ACCESS_DENIED	User was not successfully identified.
EFI_INVALID_PARAMETER	The User parameter is NULL.

Definition at line 394 of file UserManager.h.

EFI_USER_PROFILE_NOTIFY

typedef EFI_STATUS(EFIAPI * EFI_USER_PROFILE_NOTIFY) (IN CONST EFI_USER_MANAGER_PROTOCOL *This, IN EFI_HANDLE Changed)

Called by credential provider to notify of information change.

This function allows the credential provider to notify the User Identity Manager when user status has changed. If the User Identity Manager doesn't support asynchronous changes in credentials, then this function should return EFI_UNSUPPORTED. If current user does not exist, and the credential provider can identify a user, then make the user to be current user and signal the EFI_EVENT_GROUP_USER_PROFILE_CHANGED event. If current user already exists, and the credential provider can identify another user, then switch current user to the newly identified user, and signal the EFI_EVENT_GROUP_USER_PROFILE_CHANGED event. If current user was identified by this credential provider and now the credential provider cannot identify current user, then logout current user and signal the EFI_EVENT_GROUP_USER_PROFILE_CHANGED event.

Parameters

[in]	This	Points to this instance of the EFI_USER_MANAGER_PROTOCOL.
[in]	Changed	Handle on which is installed an instance of the EFI_USER_CREDENTIAL_PROTOCOL where the user has changed.

Return values

EFI_SUCCESS	The User Identity Manager has handled the notification.
EFI_NOT_READY	The function was called while the specified credential provider was not selected.
EFI_UNSUPPORTED	The User Identity Manager doesn't support asynchronous notifications.

Definition at line 462 of file UserManager.h.

EFI_USER_PROFILE_SET_INFO

typedef EFI_STATUS(EFIAPI * EFI_USER_PROFILE_SET_INFO) (IN CONST EFI_USER_MANAGER_PROTOCOL *This, IN EFI_USER_PROFILE_HANDLE User, IN OUT EFI_USER_INFO_HANDLE *UserInfo, IN CONST EFI_USER_INFO *Info, IN UINTN InfoSize)

Add or update user information.

This function changes user information. If NULL is pointed to by UserInfo, then a new user information record is created and its handle is returned in UserInfo. Otherwise, the existing one is replaced. If EFI_USER_INFO_IDENTITY_POLICY_RECORD is changed, it is the caller's responsibility to keep it to be synced with the information on credential providers. If EFI_USER_INFO_EXCLUSIVE is specified in Info and a user information record of the same type already exists in the user profile, then EFI_ACCESS_DENIED will be returned and UserInfo will point to the handle of the existing record.

Parameters

[in]	This	Points to this instance of the EFI_USER_MANAGER_PROTOCOL.
[in]	User	Handle of the user whose profile will be retrieved.
[in,out]	UserInfo	Handle of the user information data record.
[in]	Info	On entry, points to a buffer of at least *InfoSize bytes. On exit, holds the user information. If the buffer is too small to hold the information, then EFI_BUFFER_TOO_SMALL is returned and InfoSize is updated to contain the number of bytes actually required.
[in]	InfoSize	On entry, points to the size of Info. On return, points to the size of the user information.

Return values

EFI_SUCCESS	Information returned successfully.
EFI_ACCESS_DENIED	The record is exclusive.
EFI_SECURITY_VIOLATION	The current user does not have permission to change the specified user profile or user information record.
EFI_NOT_FOUND	User does not refer to a valid user profile or UserInfo does not refer to a valid user info handle.
EFI_INVALID_PARAMETER	UserInfo is NULL or Info is NULL.

Definition at line 536 of file UserManager.h.