4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Password Credential Provider driver header file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Password credential information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Password credential table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// The user information on the password provider.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// HII specific Vendor Device Path definition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PWD_PROVIDER_SIGNATURE SIGNATURE_32 ('P', 'W', 'D', 'P')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Produced protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Enroll a user on a credential provider.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function enrolls a user on this credential provider. If the user exists on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this credential provider, update the user information on this credential provider;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync otherwise delete the user information on credential provider.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of EFI_USER_CREDENTIAL2_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
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync user profile handle. Either the user profile cannot enroll
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync on any user profile or cannot enroll on a user profile
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync other than the current user profile.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED This credential provider does not support enrollment in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the pre-OS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The new credential could not be created because of a device
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
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync user during user identification. The form is the first enabled form in the form-set
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync class 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
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function should return EFI_NOT_FOUND.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_CREDENTIAL2_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
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of pixels specified by Width and Height. If no such bitmap exists, then EFI_NOT_FOUND
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Width On entry, points to the desired bitmap width. If NULL then no
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bitmap information will be returned. On exit, points to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync width of the bitmap returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Height On entry, points to the desired bitmap height. If NULL then no
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bitmap information will be returned. On exit, points to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync height of the 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
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync such string exists, then EFI_NOT_FOUND is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_CREDENTIAL2_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
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync provider. This function is called after the credential-related information has been
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync submitted on a form OR after a call to Default() has returned that this credential is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ready to log on.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] User The user profile handle of the user profile currently being
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync considered by the user identity manager. If NULL, then no user
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync profile is currently 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_INVALID_PARAMETER This is NULL, or Identifier is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND User is not NULL, and the specified user handle can't be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync found in user profile database
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
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AutoLogon returns FALSE, then the user interface will be constructed by the User
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Identity Manager.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] AutoLogon On return, points to the credential provider's capabilities
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync after 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_CREDENTIAL2_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_CREDENTIAL2_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] AutoLogon On return, holds whether the credential provider should be used
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 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_CREDENTIAL2_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
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync exit, holds the user information. If the buffer is too small
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to hold the information, then EFI_BUFFER_TOO_SMALL is returned
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and InfoSize is updated to contain the number of bytes actually
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] InfoSize On entry, points to the size of Info. On return, points to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size of the user 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
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync user information. The size required is returned in *InfoSize.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Info is NULL or InfoSize is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The specified UserInfo does not refer to a valid user info handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Enumerate all of the user informations on the credential provider.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns the next user information record. To retrieve the first user
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information record handle, point UserInfo at a NULL. Each subsequent call will retrieve
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync another user information record handle until there are no more, at which point UserInfo
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will point to NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] UserInfo On entry, points to the previous user information handle or NULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to start enumeration. On exit, points to the next user information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync handle 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 Delete a user on this credential provider.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function deletes a user on this credential provider.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] User The user profile handle to delete.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS User profile was successfully deleted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED Current user profile does not permit deletion on the user profile handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Either the user profile cannot delete on any user profile or cannot delete
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync on a user profile other than the current user profile.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED This credential provider does not support deletion in the pre-OS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The new credential could not be deleted because of a device error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER User does not refer to a valid user profile handle.