/** @file\r
- UEFI 2.2 User Manager Protocol definition.\r
+ UEFI User Manager Protocol definition.\r
\r
This protocol manages user profiles.\r
\r
- Copyright (c) 2009 - 2010, Intel Corporation \r
- All rights reserved. This program and the accompanying materials \r
+ Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r
+ This program and the accompanying materials \r
are licensed and made available under the terms and conditions of the BSD License \r
which accompanies this distribution. The full text of the license may be found at \r
http://opensource.org/licenses/bsd-license.php \r
with the user information record handle following UserInfo and continues until either the \r
information is found or there are no more user profiles.\r
A match occurs when the Info.InfoType field matches the user information record type and the \r
- user information record data matches the portion of Info passed the EFI_USER_INFO header.\r
+ user information record data matches the portion of Info.\r
\r
@param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL.\r
@param[in,out] User On entry, points to the previously returned user profile handle or NULL to start \r
information record or NULL if not found. Can be NULL, in which case only one user \r
information record per user can be returned. \r
@param[in] Info Points to the buffer containing the user information to be compared to the user \r
- information record. If NULL, then only the user information record type is compared. \r
+ information record. If the user information record data is empty, then only the user \r
+ information record type is compared. \r
If InfoSize is 0, then the user information record must be empty.\r
\r
@param[in] InfoSize The size of Info, in bytes. \r
\r
- @retval EFI_SUCCESS User information was found. User points to the user profile handle and \r
- UserInfo points to the user information handle.\r
- @retval EFI_NOT_FOUND User information was not found. User points to NULL and UserInfo points to NULL.\r
+ @retval EFI_SUCCESS User information was found. User points to the user profile handle and UserInfo\r
+ points to the user information handle.\r
+ @retval EFI_NOT_FOUND User information was not found. User points to NULL and UserInfo points to NULL.\r
+ @retval EFI_INVALID_PARAMETER User is NULL. Or Info is NULL.\r
**/\r
typedef\r
EFI_STATUS\r
/**\r
Called by credential provider to notify of information change.\r
\r
- This function allows the credential provider to notify the User Identity Manager when user status has \r
- changed while deselected.\r
+ This function allows the credential provider to notify the User Identity Manager when user status \r
+ has changed.\r
If the User Identity Manager doesn't support asynchronous changes in credentials, then this function \r
should return EFI_UNSUPPORTED. \r
- If the User Identity Manager supports this, it will call User() to get the user identifier and then \r
- GetNextInfo() and GetInfo() in the User Credential Protocol to get all of the information \r
- from the credential and add it.\r
+ If current user does not exist, and the credential provider can identify a user, then make the user \r
+ to be current user and signal the EFI_EVENT_GROUP_USER_PROFILE_CHANGED event.\r
+ If current user already exists, and the credential provider can identify another user, then switch \r
+ current user to the newly identified user, and signal the EFI_EVENT_GROUP_USER_PROFILE_CHANGED event.\r
+ If current user was identified by this credential provider and now the credential provider cannot identify \r
+ current user, then logout current user and signal the EFI_EVENT_GROUP_USER_PROFILE_CHANGED event.\r
\r
@param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL.\r
@param[in] Changed Handle on which is installed an instance of the\r
@retval EFI_ACCESS_DENIED The information about the specified user cannot be accessed by the current user.\r
@retval EFI_BUFFER_TOO_SMALL The number of bytes specified by *InfoSize is too small to hold \r
the returned data. The actual size required is returned in *InfoSize.\r
+ @retval EFI_NOT_FOUND User does not refer to a valid user profile or UserInfo does not refer to a valid\r
+ user info handle.\r
+ @retval EFI_INVALID_PARAMETER Info is NULL or InfoSize is NULL.\r
**/ \r
typedef\r
EFI_STATUS\r
This function changes user information. If NULL is pointed to by UserInfo, then a new user \r
information record is created and its handle is returned in UserInfo. Otherwise, the existing one is \r
replaced.\r
+ If EFI_USER_INFO_IDENTITY_POLICY_RECORD is changed, it is the caller's responsibility to keep it to \r
+ be synced with the information on credential providers.\r
If EFI_USER_INFO_EXCLUSIVE is specified in Info and a user information record of the same \r
type already exists in the user profile, then EFI_ACCESS_DENIED will be returned and \r
UserInfo will point to the handle of the existing record.\r
@retval EFI_ACCESS_DENIED The record is exclusive.\r
@retval EFI_SECURITY_VIOLATION The current user does not have permission to change the specified \r
user profile or user information record.\r
+ @retval EFI_NOT_FOUND User does not refer to a valid user profile or UserInfo does not refer to a valid\r
+ user info handle.\r
+ @retval EFI_INVALID_PARAMETER UserInfo is NULL or Info is NULL. \r
**/ \r
typedef\r
EFI_STATUS\r
handle, point UserInfo at a NULL. Each subsequent call will retrieve another user information \r
record handle until there are no more, at which point UserInfo will point to NULL. \r
\r
- Note: in-consistency between code and the UEFI 2.3 specification that the type of the User parameter\r
- is EFI_USER_PROFILE_HANDLE. It should be spec error and wait for spec update.\r
-\r
- @param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL.\r
- @param[in] User Handle of the user whose information will be deleted.\r
- @param[in,out] UserInfo Handle of the user information to remove.\r
+ @param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL.\r
+ @param[in] User Handle of the user whose information will be deleted.\r
+ @param[in,out] UserInfo Handle of the user information to remove.\r
\r
- @retval EFI_SUCCESS User information returned.\r
- @retval EFI_NOT_FOUND No more user information found.\r
+ @retval EFI_SUCCESS User information returned.\r
+ @retval EFI_NOT_FOUND No more user information found.\r
+ @retval EFI_INVALID_PARAMETER UserInfo is NULL.\r
**/ \r
typedef\r
EFI_STATUS\r
projects / mirror_edk2.git / blobdiff