4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UEFI User Manager Protocol definition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This protocol manages user profiles.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Global ID for the User Manager Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x6fd5b00c, 0xd426, 0x4283, { 0x98, 0x87, 0x6c, 0xf5, 0xcf, 0x1c, 0xb1, 0xfe } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0xbaf1e6de, 0x209e, 0x4adb, { 0x8d, 0x96, 0xfd, 0x8b, 0x71, 0xf3, 0xf6, 0x83 } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The attributes of the user profile information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// User information structure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The user credential identifier associated with this user information or else Nil if the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// information is not associated with any specific credential.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The type of user information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Must be set to 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The attributes of the user profile information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The size of the user information, in bytes, including this header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// User credential class GUIDs
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync { 0x5cf32e68, 0x7660, 0x449b, { 0x80, 0xe6, 0x7e, 0xa3, 0x6e, 0x3, 0xf6, 0xa8 } }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync { 0xf8e5058c, 0xccb6, 0x4714, { 0xb2, 0x20, 0x3f, 0x7e, 0x3a, 0x64, 0xb, 0xd1 } }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync { 0x5f03ba33, 0x8c6b, 0x4c24, { 0xaa, 0x2e, 0x14, 0xa2, 0x65, 0x7b, 0xd4, 0x54 } }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync { 0x32cba21f, 0xf308, 0x4cbc, { 0x9a, 0xb5, 0xf5, 0xa3, 0x69, 0x9f, 0x4, 0x4a } }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync { 0x5917ef16, 0xf723, 0x4bb9, { 0xa6, 0x4b, 0xd8, 0xc5, 0x32, 0xf4, 0xd8, 0xb5 } }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync { 0x8a6b4a83, 0x42fe, 0x45d2, { 0xa2, 0xef, 0x46, 0xf0, 0x6c, 0x7d, 0x98, 0x52 } }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_CREDENTIAL_CAPABILITIES_ENROLL 0x0000000000000001
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Credential logon flags
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_CREDENTIAL_LOGON_FLAG_DEFAULT 0x00000002
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// User information record types
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// No information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Provide the user's name for the enrolled user.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Provides the date and time when the user profile was created.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Provides the date and time when the user profile was selected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Provides the number of times that the user profile has been selected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Provides a unique non-volatile user identifier for each enrolled user.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Specifies the type of a particular credential associated with the user profile.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Specifies the user-readable name of a particular credential type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_USER_INFO_CREDENTIAL_TYPE_NAME_RECORD 0x07
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Specifies the credential provider.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_USER_INFO_CREDENTIAL_PROVIDER_RECORD 0x08
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Specifies the user-readable name of a particular credential's provider.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_USER_INFO_CREDENTIAL_PROVIDER_NAME_RECORD 0x09
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef CHAR16 *EFI_USER_INFO_CREDENTIAL_PROVIDER_NAME;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Provides PKCS#11 credential information from a smart card.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Provides standard biometric information in the format specified by the ISO 19785 (Common
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Biometric Exchange Formats Framework) specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Indicates how close of a match the fingerprint must be in order to be considered a match.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Indicates how many attempts the user has to with a particular credential before the system prevents
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// further attempts.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Provides the user's pre-OS access rights.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Type; ///< Specifies the type of user access control.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Size; ///< Specifies the size of the user access control record, in bytes, including this header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef EFI_USER_INFO_ACCESS_CONTROL EFI_USER_INFO_ACCESS_POLICY;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// User Information access types
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Forbids the user from booting or loading executables from the specified device path or any child
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// device paths.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Permits the user from booting or loading executables from the specified device path or any child
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// device paths.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Note: in-consistency between code and the UEFI 2.3 specification here.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The definition EFI_USER_INFO_ACCESS_PERMIT_BOOT in the specification should be typo and wait for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// spec update.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Presence of this record indicates that a user can update enrollment information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Presence of this record indicates that a user can enroll new users.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_USER_INFO_ACCESS_ENROLL_OTHERS 0x00000004
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Presence of this record indicates that a user can update the user information of any user.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Describes permissions usable when configuring the platform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Standard GUIDs for access to configure the platform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync { 0x85b75607, 0xf7ce, 0x471e, { 0xb7, 0xe4, 0x2a, 0xea, 0x5f, 0x72, 0x32, 0xee } }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync { 0x1db29ae0, 0x9dcb, 0x43bc, { 0x8d, 0x87, 0x5d, 0xa1, 0x49, 0x64, 0xdd, 0xe2 } }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_USER_INFO_ACCESS_SETUP_RESTRICTED_GUID \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync { 0xbdb38125, 0x4d63, 0x49f4, { 0x82, 0x12, 0x61, 0xcf, 0x5a, 0x19, 0xa, 0xf8 } }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Forbids UEFI drivers from being started from the specified device path(s) or any child device paths.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_USER_INFO_ACCESS_FORBID_CONNECT 0x00000007
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Permits UEFI drivers to be started on the specified device path(s) or any child device paths.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_USER_INFO_ACCESS_PERMIT_CONNECT 0x00000008
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Modifies the boot order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_USER_INFO_ACCESS_BOOT_ORDER_MASK 0x0000000F
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Insert new boot options at the beginning of the boot order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_USER_INFO_ACCESS_BOOT_ORDER_INSERT 0x00000000
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Append new boot options to the end of the boot order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_USER_INFO_ACCESS_BOOT_ORDER_APPEND 0x00000001
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Replace the entire boot order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_USER_INFO_ACCESS_BOOT_ORDER_REPLACE 0x00000002
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The Boot Manager will not attempt find a default boot device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// when the default boot order is does not lead to a bootable device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_USER_INFO_ACCESS_BOOT_ORDER_NODEFAULT 0x00000010
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Provides the expression which determines which credentials are required to assert user identity.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Type; ///< Specifies either an operator or a data item.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Length; ///< The length of this block, in bytes, including this header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// User identity policy expression operators.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_USER_INFO_IDENTITY_CREDENTIAL_PROVIDER 0x03
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Provides placeholder for additional user profile information identified by a GUID.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// User information table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// A collection of EFI_USER_INFO records, prefixed with this header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 Size; ///< Total size of the user information table, in bytes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_USER_MANAGER_PROTOCOL EFI_USER_MANAGER_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Create a new user profile.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function creates a new user profile with only a new user identifier attached and returns its
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync handle. The user profile is non-volatile, but the handle User can change across reboots.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] User On return, points to the new user profile handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The user profile handle is unique only during this boot.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS User profile was successfully created.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED Current user does not have sufficient permissions to create a user profile.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED Creation of new user profiles is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The User parameter is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Delete an existing user profile.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] User User profile handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS User profile was successfully deleted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED Current user does not have sufficient permissions to delete a user
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync profile or there is only one user profile.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED Deletion of new user profiles is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER User does not refer to a valid user profile.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Enumerate all of the enrolled users on the platform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns the next enrolled user profile. To retrieve the first user profile handle, point
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync User at a NULL. Each subsequent call will retrieve another user profile handle until there are no
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync more, at which point User will point to NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in,out] User On entry, points to the previous user profile handle or NULL to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync start enumeration. On exit, points to the next user profile handle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or NULL if there are no more user profiles.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Next enrolled user profile successfully returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED Next enrolled user profile was not successfully returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The User parameter is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Return the current user profile handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] CurrentUser On return, points to the current user profile handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Current user profile handle returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The CurrentUser parameter is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Identify a user.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Identify the user and, if authenticated, returns the user handle and changes the current user profile.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync All user information marked as private in a previously selected profile is no longer available for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync inspection.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Whenever the current user profile is changed then the an event with the GUID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_EVENT_GROUP_USER_PROFILE_CHANGED is signaled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] User On return, points to the user profile handle for the current user profile.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS User was successfully identified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED User was not successfully identified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The User parameter is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Find a user using a user information record.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function searches all user profiles for the specified user information record. The search starts
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with the user information record handle following UserInfo and continues until either the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information is found or there are no more user profiles.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync A match occurs when the Info.InfoType field matches the user information record type and the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync user information record data matches the portion of Info.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in,out] User On entry, points to the previously returned user profile handle or NULL to start
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync searching with the first user profile. On return, points to the user profile handle or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL if not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in,out] UserInfo On entry, points to the previously returned user information handle or NULL to start
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync searching with the first. On return, points to the user information handle of the user
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information record or NULL if not found. Can be NULL, in which case only one user
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information record per user can be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Info Points to the buffer containing the user information to be compared to the user
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information record. If the user information record data is empty, then only the user
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information record type is compared.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If InfoSize is 0, then the user information record must be empty.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] InfoSize The size of Info, in bytes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS User information was found. User points to the user profile handle and UserInfo
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync points to the user information handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND User information was not found. User points to NULL and UserInfo points to NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER User is NULL. Or Info is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Called by credential provider to notify of information change.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function allows the credential provider to notify the User Identity Manager when user status
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync has changed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the User Identity Manager doesn't support asynchronous changes in credentials, then this function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync should return EFI_UNSUPPORTED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If current user does not exist, and the credential provider can identify a user, then make the user
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to be current user and signal the EFI_EVENT_GROUP_USER_PROFILE_CHANGED event.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If current user already exists, and the credential provider can identify another user, then switch
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync current user to the newly identified user, and signal the EFI_EVENT_GROUP_USER_PROFILE_CHANGED event.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If current user was identified by this credential provider and now the credential provider cannot identify
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync current user, then logout current user and signal the EFI_EVENT_GROUP_USER_PROFILE_CHANGED event.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Changed Handle on which is installed an instance of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_USER_CREDENTIAL_PROTOCOL where the user has changed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The User Identity Manager has handled the notification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The function was called while the specified credential provider was not selected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The User Identity Manager doesn't support asynchronous notifications.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Return information attached to the user.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns user information. The format of the information is described in User
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Information. The function may return EFI_ACCESS_DENIED if the information is marked private
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and the handle specified by User is not the current user profile. The function may return
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_ACCESS_DENIED if the information is marked protected and the information is associated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with a credential provider for which the user has not been authenticated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] User Handle of the user whose profile will be retrieved.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] UserInfo Handle of the user information data record.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Info On entry, points to a buffer of at least *InfoSize bytes. On exit, holds the user
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information. If the buffer is too small to hold the information, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_BUFFER_TOO_SMALL is returned and InfoSize is updated to contain the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync number of bytes actually required.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in,out] InfoSize On entry, points to the size of Info. On return, points to the size of the user
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Information returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The information about the specified user cannot be accessed by the current user.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL The number of bytes specified by *InfoSize is too small to hold
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the returned data. The actual size required is returned in *InfoSize.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND User does not refer to a valid user profile or UserInfo does not refer to a valid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync user info handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Info is NULL or InfoSize is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Add or update user information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function changes user information. If NULL is pointed to by UserInfo, then a new user
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information record is created and its handle is returned in UserInfo. Otherwise, the existing one is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If EFI_USER_INFO_IDENTITY_POLICY_RECORD is changed, it is the caller's responsibility to keep it to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be synced with the information on credential providers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If EFI_USER_INFO_EXCLUSIVE is specified in Info and a user information record of the same
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync type already exists in the user profile, then EFI_ACCESS_DENIED will be returned and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UserInfo will point to the handle of the existing record.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] User Handle of the user whose profile will be retrieved.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in,out] UserInfo Handle of the user information data record.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Info On entry, points to a buffer of at least *InfoSize bytes. On exit, holds the user
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information. If the buffer is too small to hold the information, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_BUFFER_TOO_SMALL is returned and InfoSize is updated to contain the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync number of bytes actually required.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] InfoSize On entry, points to the size of Info. On return, points to the size of the user
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Information returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The record is exclusive.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SECURITY_VIOLATION The current user does not have permission to change the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync user profile or user information record.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND User does not refer to a valid user profile or UserInfo does not refer to a valid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync user info handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER UserInfo is NULL or Info is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Delete user information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Delete the user information attached to the user profile specified by the UserInfo.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] User Handle of the user whose information will be deleted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] UserInfo Handle of the user information to remove.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS User information deleted successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND User information record UserInfo does not exist in the user profile.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The current user does not have permission to delete this user information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Enumerate user information of all the enrolled users on the platform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns the next user information record. To retrieve the first user information record
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync handle, point UserInfo at a NULL. Each subsequent call will retrieve another user information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync record handle until there are no more, at which point UserInfo will point to NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] User Handle of the user whose information will be deleted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in,out] UserInfo Handle of the user information to remove.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS User information returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND No more user information found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER UserInfo is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This protocol provides the services used to manage user profiles.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncextern EFI_GUID gEfiUserCredentialClassPasswordGuid;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncextern EFI_GUID gEfiUserCredentialClassSmartCardGuid;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncextern EFI_GUID gEfiUserCredentialClassFingerprintGuid;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncextern EFI_GUID gEfiUserCredentialClassHandprintGuid;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncextern EFI_GUID gEfiUserCredentialClassSecureCardGuid;