4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UEFI 2.2 User Credential Protocol definition.It has been removed from UEFI 2.3.1 and replaced
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by EFI_USER_CREDENTIAL2_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Attached to a device handle, this protocol identifies a single means of identifying the user.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2009 - 2010, 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 0x71ee5e94, 0x65b9, 0x45d5, { 0x82, 0x1a, 0x3a, 0x4d, 0x86, 0xcf, 0xe6, 0xbe } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_USER_CREDENTIAL_PROTOCOL EFI_USER_CREDENTIAL_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Enroll a user on a credential provider.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function enrolls and deletes a user profile using this credential provider. If a user profile
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is successfully enrolled, it calls the User Manager Protocol function Notify() to notify the user
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync manager driver that credential information has changed. If an enrolled user does exist, delete the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync user on the credential provider.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] User The user profile to enroll.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS User profile was successfully enrolled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED Current user profile does not permit enrollment on the user profile
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync handle. Either the user profile cannot enroll on any user profile or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync cannot enroll on a user profile other than the current user profile.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED This credential provider does not support enrollment in the pre-OS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The new credential could not be created because of a device error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER User does not refer to a valid user profile handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns the user interface information used during user identification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns information about the form used when interacting with the user during user
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync identification. The form is the first enabled form in the form-set class
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HII_USER_CREDENTIAL_FORMSET_GUID installed on the HII handle HiiHandle. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the user credential provider does not require a form to identify the user, then this function should
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_NOT_FOUND.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Hii On return, holds the HII database handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] FormSetId On return, holds the identifier of the form set which contains
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the form used during user identification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] FormId On return, holds the identifier of the form used during user
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync identification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Form returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND Form not returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Hii is NULL or FormSetId is NULL or FormId is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns bitmap used to describe the credential provider type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This optional function returns a bitmap which is less than or equal to the number of pixels specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by Width and Height. If no such bitmap exists, then EFI_NOT_FOUND is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Width On entry, points to the desired bitmap width. If NULL then no bitmap
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information will be returned. On exit, points to the width of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bitmap returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Height On entry, points to the desired bitmap height. If NULL then no bitmap
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information will be returned. On exit, points to the height of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bitmap returned
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Hii On return, holds the HII database handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Image On return, holds the HII image identifier.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Image identifier returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND Image identifier not returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Hii is NULL or Image is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns string used to describe the credential provider type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns a string which describes the credential provider. If no such string exists, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_NOT_FOUND is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Hii On return, holds the HII database handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] String On return, holds the HII string identifier.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS String identifier returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND String identifier not returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Hii is NULL or String is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Return the user identifier associated with the currently authenticated user.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns the user identifier of the user authenticated by this credential provider. This
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function is called after the credential-related information has been submitted on a form OR after a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync call to Default() has returned that this credential is ready to log on.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] User The user profile handle of the user profile currently being considered
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by the user identity manager. If NULL, then no user profile is currently
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync under consideration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Identifier On return, points to the user identifier.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS User identifier returned successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY No user identifier can be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The user has been locked out of this user credential.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND User is not NULL, and the specified user handle can't be found in user
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync profile database
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Identifier is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Indicate that user interface interaction has begun for the specified credential.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is called when a credential provider is selected by the user. If AutoLogon returns
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FALSE, then the user interface will be constructed by the User Identity Manager.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] AutoLogon On return, points to the credential provider's capabilities after
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the credential provider has been selected by the user.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Credential provider successfully selected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER AutoLogon is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Indicate that user interface interaction has ended for the specified credential.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is called when a credential provider is deselected by the user.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Credential provider successfully deselected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Return the default logon behavior for this user credential.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function reports the default login behavior regarding this credential provider.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] AutoLogon On return, holds whether the credential provider should be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync used by default to automatically log on the user.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Default information successfully returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER AutoLogon is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Return information attached to the credential provider.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns user information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.
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_BUFFER_TOO_SMALL The size specified by InfoSize is too small to hold all of the user
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information. The size required is returned in *InfoSize.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The specified UserInfo does not refer to a valid user info handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Info is NULL or InfoSize is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Enumerate all of the user information records on the credential provider.
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_CREDENTIAL_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in,out] UserInfo On entry, points to the previous user information handle or NULL to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync start enumeration. On exit, points to the next user information handle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or NULL if there is no more user information.
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 support for a single class of credentials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_GUID Identifier; ///< Uniquely identifies this credential provider.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_GUID Type; ///< Identifies this class of User Credential Provider.