SecurityPkg/UserIdentification/UsbCredentialProviderDxe/UsbCredentialProvider.c File Reference


Functions

CHAR16 * GetStringById (IN EFI_STRING_ID Id)
VOID ExpandTableSize (VOID)
EFI_STATUS ModifyTable (IN UINTN Index, IN USB_INFO *Info)
EFI_STATUS InitCredentialTable (VOID)
EFI_STATUS GetFileData (IN CHAR16 *FileName, OUT VOID **Buffer, OUT UINTN *BufferSize)
BOOLEAN GenerateCredential (IN UINT8 *Buffer, IN UINTN BufferSize, OUT UINT8 *Credential)
EFI_STATUS GetToken (OUT UINT8 *Token)
EFI_STATUS FindUserInfoByType (IN EFI_USER_PROFILE_HANDLE User, IN UINT8 InfoType, OUT EFI_USER_INFO **Info)
EFI_STATUS InitFormBrowser (VOID)
EFI_STATUS EFIAPI CredentialEnroll (IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *This, IN EFI_USER_PROFILE_HANDLE User)
EFI_STATUS EFIAPI CredentialForm (IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *This, OUT EFI_HII_HANDLE *Hii, OUT EFI_GUID *FormSetId, OUT EFI_FORM_ID *FormId)
EFI_STATUS EFIAPI CredentialTile (IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *This, IN OUT UINTN *Width, IN OUT UINTN *Height, OUT EFI_HII_HANDLE *Hii, OUT EFI_IMAGE_ID *Image)
EFI_STATUS EFIAPI CredentialTitle (IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *This, OUT EFI_HII_HANDLE *Hii, OUT EFI_STRING_ID *String)
EFI_STATUS EFIAPI CredentialUser (IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *This, IN EFI_USER_PROFILE_HANDLE User, OUT EFI_USER_INFO_IDENTIFIER *Identifier)
EFI_STATUS EFIAPI CredentialSelect (IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *This, OUT EFI_CREDENTIAL_LOGON_FLAGS *AutoLogon)
EFI_STATUS EFIAPI CredentialDeselect (IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *This)
EFI_STATUS EFIAPI CredentialDefault (IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *This, OUT EFI_CREDENTIAL_LOGON_FLAGS *AutoLogon)
EFI_STATUS EFIAPI CredentialGetInfo (IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *This, IN EFI_USER_INFO_HANDLE UserInfo, OUT EFI_USER_INFO *Info, IN OUT UINTN *InfoSize)
EFI_STATUS EFIAPI CredentialGetNextInfo (IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *This, IN OUT EFI_USER_INFO_HANDLE *UserInfo)
EFI_STATUS EFIAPI CredentialDelete (IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *This, IN EFI_USER_PROFILE_HANDLE User)
EFI_STATUS EFIAPI UsbProviderInit (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables

CREDENTIAL_TABLEmUsbTable = NULL
USB_PROVIDER_CALLBACK_INFOmCallbackInfo = NULL
USB_CREDENTIAL_INFOmUsbInfoHandle = NULL
EFI_USER_CREDENTIAL2_PROTOCOL gUsbCredentialProviderDriver

Detailed Description

Usb Credential Provider driver implemenetation.

Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Function Documentation

EFI_STATUS EFIAPI CredentialDefault ( IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *  This,
OUT EFI_CREDENTIAL_LOGON_FLAGS *  AutoLogon 
)

Return the default logon behavior for this user credential.

This function reports the default login behavior regarding this credential provider.

Parameters:
[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL.
[out] AutoLogon On return, holds whether the credential provider should be used by default to automatically log on the user.
Return values:
EFI_SUCCESS Default information successfully returned.
EFI_INVALID_PARAMETER AutoLogon is NULL.

EFI_STATUS EFIAPI CredentialDelete ( IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *  This,
IN EFI_USER_PROFILE_HANDLE  User 
)

Delete a user on this credential provider.

This function deletes a user on this credential provider.

Parameters:
[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL.
[in] User The user profile handle to delete.
Return values:
EFI_SUCCESS User profile was successfully deleted.
EFI_ACCESS_DENIED Current user profile does not permit deletion on the user profile handle. Either the user profile cannot delete on any user profile or cannot delete on a user profile other than the current user profile.
EFI_UNSUPPORTED This credential provider does not support deletion in the pre-OS.
EFI_DEVICE_ERROR The new credential could not be deleted because of a device error.
EFI_INVALID_PARAMETER User does not refer to a valid user profile handle.

References CREDENTIAL_TABLE::Count, EFI_STATUS(), FindUserInfoByType(), ModifyTable(), UINTN(), PASSWORD_INFO::UserId, and CREDENTIAL_TABLE::UserInfo.

EFI_STATUS EFIAPI CredentialDeselect ( IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *  This  ) 

Indicate that user interface interaction has ended for the specified credential.

This function is called when a credential provider is deselected by the user.

Parameters:
[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL.
Return values:
EFI_SUCCESS Credential provider successfully deselected.

EFI_STATUS EFIAPI CredentialEnroll ( IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *  This,
IN EFI_USER_PROFILE_HANDLE  User 
)

Enroll a user on a credential provider.

This function enrolls a user on this credential provider. If the user exists on this credential provider, update the user information on this credential provider; otherwise add the user information on credential provider.

Parameters:
[in] This Points to this instance of EFI_USER_CREDENTIAL2_PROTOCOL.
[in] User The user profile to enroll.
Return values:
EFI_SUCCESS User profile was successfully enrolled.
EFI_ACCESS_DENIED Current user profile does not permit enrollment on the user profile handle. Either the user profile cannot enroll on any user profile or cannot enroll on a user profile other than the current user profile.
EFI_UNSUPPORTED This credential provider does not support enrollment in the pre-OS.
EFI_DEVICE_ERROR The new credential could not be created because of a device error.
EFI_INVALID_PARAMETER User does not refer to a valid user profile handle.

References CREDENTIAL_TABLE::Count, CREDENTIAL_LEN, EFI_STATUS(), FindUserInfoByType(), GetPassword(), GetStringById(), GetToken(), ModifyTable(), PASSWORD_INFO::Password, USB_INFO::Token, TRUE, UINTN(), USB_INFO::UserId, PASSWORD_INFO::UserId, and CREDENTIAL_TABLE::UserInfo.

EFI_STATUS EFIAPI CredentialForm ( IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *  This,
OUT EFI_HII_HANDLE *  Hii,
OUT EFI_GUID *  FormSetId,
OUT EFI_FORM_ID *  FormId 
)

Returns the user interface information used during user identification.

This function returns information about the form used when interacting with the user during user identification. The form is the first enabled form in the form-set class EFI_HII_USER_CREDENTIAL_FORMSET_GUID installed on the HII handle HiiHandle. If the user credential provider does not require a form to identify the user, then this function should return EFI_NOT_FOUND.

Parameters:
[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL.
[out] Hii On return, holds the HII database handle.
[out] FormSetId On return, holds the identifier of the form set which contains the form used during user identification.
[out] FormId On return, holds the identifier of the form used during user identification.
Return values:
EFI_SUCCESS Form returned successfully.
EFI_NOT_FOUND Form not returned.
EFI_INVALID_PARAMETER Hii is NULL or FormSetId is NULL or FormId is NULL.

References FORMID_GET_PASSWORD_FORM, gPwdCredentialProviderGuid, and PWD_PROVIDER_CALLBACK_INFO::HiiHandle.

EFI_STATUS EFIAPI CredentialGetInfo ( IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *  This,
IN EFI_USER_INFO_HANDLE  UserInfo,
OUT EFI_USER_INFO *  Info,
IN OUT UINTN *  InfoSize 
)

Return information attached to the credential provider.

This function returns user information.

Parameters:
[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL.
[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_BUFFER_TOO_SMALL The size specified by InfoSize is too small to hold all of the user information. The size required is returned in *InfoSize.
EFI_INVALID_PARAMETER Info is NULL or InfoSize is NULL.
EFI_NOT_FOUND The specified UserInfo does not refer to a valid user info handle.

References USB_CREDENTIAL_INFO::Count, PASSWORD_CREDENTIAL_INFO::Count, USB_CREDENTIAL_INFO::Info, PASSWORD_CREDENTIAL_INFO::Info, and UINTN().

EFI_STATUS EFIAPI CredentialGetNextInfo ( IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *  This,
IN OUT EFI_USER_INFO_HANDLE *  UserInfo 
)

Enumerate all of the user informations on the credential provider.

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_CREDENTIAL2_PROTOCOL.
[in,out] UserInfo On entry, points to the previous user information handle or NULL to start enumeration. On exit, points to the next user information handle or NULL if there is no more user information.
Return values:
EFI_SUCCESS User information returned.
EFI_NOT_FOUND No more user information found.
EFI_INVALID_PARAMETER UserInfo is NULL.

References USB_CREDENTIAL_INFO::Count, PASSWORD_CREDENTIAL_INFO::Count, GetStringById(), gPwdCredentialProviderGuid, gUsbCredentialProviderGuid, USB_CREDENTIAL_INFO::Info, PASSWORD_CREDENTIAL_INFO::Info, and UINTN().

EFI_STATUS EFIAPI CredentialSelect ( IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *  This,
OUT EFI_CREDENTIAL_LOGON_FLAGS *  AutoLogon 
)

Indicate that user interface interaction has begun for the specified credential.

This function is called when a credential provider is selected by the user. If AutoLogon returns FALSE, then the user interface will be constructed by the User Identity Manager.

Parameters:
[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL.
[out] AutoLogon On return, points to the credential provider's capabilities after the credential provider has been selected by the user.
Return values:
EFI_SUCCESS Credential provider successfully selected.
EFI_INVALID_PARAMETER AutoLogon is NULL.

EFI_STATUS EFIAPI CredentialTile ( IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *  This,
IN OUT UINTN *  Width,
IN OUT UINTN *  Height,
OUT EFI_HII_HANDLE *  Hii,
OUT EFI_IMAGE_ID *  Image 
)

Returns bitmap used to describe the credential provider type.

This optional function returns a bitmap which is less than or equal to the number of pixels specified by Width and Height. If no such bitmap exists, then EFI_NOT_FOUND is returned.

Parameters:
[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL.
[in,out] Width On entry, points to the desired bitmap width. If NULL then no bitmap information will be returned. On exit, points to the width of the bitmap returned.
[in,out] Height On entry, points to the desired bitmap height. If NULL then no bitmap information will be returned. On exit, points to the height of the bitmap returned.
[out] Hii On return, holds the HII database handle.
[out] Image On return, holds the HII image identifier.
Return values:
EFI_SUCCESS Image identifier returned successfully.
EFI_NOT_FOUND Image identifier not returned.
EFI_INVALID_PARAMETER Hii is NULL or Image is NULL.

EFI_STATUS EFIAPI CredentialTitle ( IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *  This,
OUT EFI_HII_HANDLE *  Hii,
OUT EFI_STRING_ID *  String 
)

Returns string used to describe the credential provider type.

This function returns a string which describes the credential provider. If no such string exists, then EFI_NOT_FOUND is returned.

Parameters:
[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL.
[out] Hii On return, holds the HII database handle.
[out] String On return, holds the HII string identifier.
Return values:
EFI_SUCCESS String identifier returned successfully.
EFI_NOT_FOUND String identifier not returned.
EFI_INVALID_PARAMETER Hii is NULL or String is NULL.

References USB_PROVIDER_CALLBACK_INFO::HiiHandle, and PWD_PROVIDER_CALLBACK_INFO::HiiHandle.

EFI_STATUS EFIAPI CredentialUser ( IN CONST EFI_USER_CREDENTIAL2_PROTOCOL *  This,
IN EFI_USER_PROFILE_HANDLE  User,
OUT EFI_USER_INFO_IDENTIFIER *  Identifier 
)

Return the user identifier associated with the currently authenticated user.

This function returns the user identifier of the user authenticated by this credential provider. This function is called after the credential-related information has been submitted on a form OR after a call to Default() has returned that this credential is ready to log on.

Parameters:
[in] This Points to this instance of the EFI_USER_CREDENTIAL2_PROTOCOL.
[in] User The user profile handle of the user profile currently being considered by the user identity manager. If NULL, then no user profile is currently under consideration.
[out] Identifier On return, points to the user identifier.
Return values:
EFI_SUCCESS User identifier returned successfully.
EFI_NOT_READY No user identifier can be returned.
EFI_ACCESS_DENIED The user has been locked out of this user credential.
EFI_INVALID_PARAMETER This is NULL, or Identifier is NULL.
EFI_NOT_FOUND User is not NULL, and the specified user handle can't be found in user profile database.

References CREDENTIAL_TABLE::Count, CREDENTIAL_LEN, EFI_STATUS(), FindUserInfoByType(), GetStringById(), GetToken(), HASHED_CREDENTIAL_LEN, PASSWORD_INFO::Password, UINTN(), PASSWORD_INFO::UserId, CREDENTIAL_TABLE::UserInfo, and CREDENTIAL_TABLE::ValidIndex.

VOID ExpandTableSize ( VOID   ) 

EFI_STATUS FindUserInfoByType ( IN EFI_USER_PROFILE_HANDLE  User,
IN UINT8  InfoType,
OUT EFI_USER_INFO **  Info 
)

Find a user infomation record by the information record type.

This function searches all user information records of User from beginning until either the information is found or there are no more user infomation record. A match occurs when a Info.InfoType field matches the user information record type.

Parameters:
[in] User Points to the user profile record to search.
[in] InfoType The infomation type to be searched.
[out] Info Points to the user info found, the caller is responsible to free.
Return values:
EFI_SUCCESS Find the user information successfully.
Others Fail to find the user information.

References EFI_STATUS(), TRUE, and UINTN().

BOOLEAN GenerateCredential ( IN UINT8 *  Buffer,
IN UINTN  BufferSize,
OUT UINT8 *  Credential 
)

Hash the data to get credential.

Parameters:
[in] Buffer Points to the data buffer
[in] BufferSize The size of data in buffer, in bytes.
[out] Credential Points to the hashed result
Return values:
TRUE Hash the data successfully.
FALSE Failed to hash the data.

References BOOLEAN(), and UINTN().

EFI_STATUS GetFileData ( IN CHAR16 *  FileName,
OUT VOID **  Buffer,
OUT UINTN *  BufferSize 
)

Read the specified file by FileName in the Usb key and return the file size in BufferSize and file content in Buffer. Note: the caller is responsible to free the buffer memory.

Parameters:
FileName File to read.
Buffer Returned with data read from the file.
BufferSize Size of the data buffer.
Return values:
EFI_SUCCESS The command completed successfully.
EFI_OUT_OF_RESOURCES Resource allocation failed.
EFI_NOT_FOUND File not found.
EFI_DEVICE_ERROR Device I/O error.

References EFI_STATUS(), FileInfo(), and UINTN().

Referenced by GetToken().

CHAR16* GetStringById ( IN EFI_STRING_ID  Id  ) 

Get string by string id from HII Interface.

Parameters:
[in] Id String ID to get the string from.
Return values:
CHAR16 * String from ID.
NULL If error occurs.

References USB_PROVIDER_CALLBACK_INFO::HiiHandle.

EFI_STATUS GetToken ( OUT UINT8 *  Token  ) 

Read the token file, and default the Token is saved at the begining of the file.

Parameters:
[out] Token Token read from a Token file.
Return values:
EFI_SUCCESS Read a Token successfully.
Others Fails to read a Token.

References EFI_STATUS(), GenerateCredential(), GetFileData(), and UINTN().

Referenced by CredentialEnroll(), and CredentialUser().

EFI_STATUS InitCredentialTable ( VOID   ) 

Create a credential table

Return values:
EFI_SUCCESS Create a credential table successfully.
Others Failed to create a password.

References CREDENTIAL_TABLE::Count, EFI_STATUS(), gUsbCredentialProviderGuid, CREDENTIAL_TABLE::MaxCount, UINTN(), USB_TABLE_INC, and CREDENTIAL_TABLE::UserInfo.

EFI_STATUS InitFormBrowser ( VOID   ) 

This function initialize the data mainly used in form browser.

Return values:
EFI_SUCCESS Initialize form data successfully.
Others Fail to Initialize form data.

References USB_PROVIDER_CALLBACK_INFO::DriverHandle, gUsbCredentialProviderGuid, USB_PROVIDER_CALLBACK_INFO::HiiHandle, and UsbCredentialProviderStrings.

EFI_STATUS ModifyTable ( IN UINTN  Index,
IN USB_INFO Info 
)

Add, update or delete info in table, and sync with NV variable.

Parameters:
[in] Index The index of the password in table. If index is found in table, update the info, else add the into to table.
[in] Info The new credential info to add into table. If Info is NULL, delete the info by Index.
Return values:
EFI_INVALID_PARAMETER Info is NULL when save the info.
EFI_SUCCESS Modify the table successfully.
Others Failed to modify the table.

References CREDENTIAL_TABLE::Count, EFI_STATUS(), ExpandTableSize(), gUsbCredentialProviderGuid, CREDENTIAL_TABLE::MaxCount, and CREDENTIAL_TABLE::UserInfo.

EFI_STATUS EFIAPI UsbProviderInit ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE *  SystemTable 
)

Main entry for this driver.

Parameters:
ImageHandle Image handle this driver.
SystemTable Pointer to SystemTable.
Return values:
EFI_SUCESS This function always complete successfully.

References USB_PROVIDER_CALLBACK_INFO::DriverHandle, EFI_STATUS(), gUsbCredentialProviderDriver, InitCredentialTable(), and InitFormBrowser().


Variable Documentation

EFI_USER_CREDENTIAL2_PROTOCOL gUsbCredentialProviderDriver


Generated on Thu Sep 24 23:44:24 2015 for SecurityPkg[ALL] by  doxygen 1.5.7.1