\r
This protocol manages user profiles.\r
\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
+ Copyright (c) 2009 - 2018, 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
\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
///\r
typedef struct {\r
///\r
- /// The user credential identifier associated with this user information or else Nil if the \r
+ /// The user credential identifier associated with this user information or else Nil if the\r
/// information is not associated with any specific credential.\r
///\r
EFI_GUID Credential;\r
#define EFI_CREDENTIAL_CAPABILITIES_ENROLL 0x0000000000000001\r
\r
///\r
-/// Credential logon flags \r
+/// Credential logon flags\r
///\r
typedef UINT32 EFI_CREDENTIAL_LOGON_FLAGS;\r
#define EFI_CREDENTIAL_LOGON_FLAG_AUTO 0x00000001\r
///\r
#define EFI_USER_INFO_PKCS11_RECORD 0x0A\r
///\r
-/// Provides standard biometric information in the format specified by the ISO 19785 (Common \r
+/// Provides standard biometric information in the format specified by the ISO 19785 (Common\r
/// Biometric Exchange Formats Framework) specification.\r
///\r
#define EFI_USER_INFO_CBEFF_RECORD 0x0B\r
#define EFI_USER_INFO_FAR_RECORD 0x0C\r
typedef UINT8 EFI_USER_INFO_FAR;\r
///\r
-/// Indicates how many attempts the user has to with a particular credential before the system prevents \r
+/// Indicates how many attempts the user has to with a particular credential before the system prevents\r
/// further attempts.\r
///\r
#define EFI_USER_INFO_RETRY_RECORD 0x0D\r
///\r
\r
///\r
-/// Forbids the user from booting or loading executables from the specified device path or any child \r
+/// Forbids the user from booting or loading executables from the specified device path or any child\r
/// device paths.\r
///\r
#define EFI_USER_INFO_ACCESS_FORBID_LOAD 0x00000001\r
///\r
-/// Permits the user from booting or loading executables from the specified device path or any child \r
+/// Permits the user from booting or loading executables from the specified device path or any child\r
/// device paths.\r
/// Note: in-consistency between code and the UEFI 2.3 specification here.\r
/// The definition EFI_USER_INFO_ACCESS_PERMIT_BOOT in the specification should be typo and wait for\r
///\r
#define EFI_USER_INFO_ACCESS_BOOT_ORDER_REPLACE 0x00000002\r
///\r
-/// The Boot Manager will not attempt find a default boot device \r
+/// The Boot Manager will not attempt find a default boot device\r
/// when the default boot order is does not lead to a bootable device.\r
///\r
#define EFI_USER_INFO_ACCESS_BOOT_ORDER_NODEFAULT 0x00000010\r
#define EFI_USER_INFO_IDENTITY_POLICY_RECORD 0x0F\r
\r
typedef struct {\r
- UINT32 Type; ///< Specifies either an operator or a data item. \r
+ UINT32 Type; ///< Specifies either an operator or a data item.\r
UINT32 Length; ///< The length of this block, in bytes, including this header.\r
} EFI_USER_INFO_IDENTITY_POLICY;\r
\r
/**\r
Create a new user profile.\r
\r
- This function creates a new user profile with only a new user identifier attached and returns its \r
+ This function creates a new user profile with only a new user identifier attached and returns its\r
handle. The user profile is non-volatile, but the handle User can change across reboots.\r
\r
@param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL.\r
- @param[out] User On return, points to the new user profile handle. \r
+ @param[out] User On return, points to the new user profile handle.\r
The user profile handle is unique only during this boot.\r
- \r
+\r
@retval EFI_SUCCESS User profile was successfully created.\r
@retval EFI_ACCESS_DENIED Current user does not have sufficient permissions to create a user profile.\r
@retval EFI_UNSUPPORTED Creation of new user profiles is not supported.\r
Delete an existing user profile.\r
\r
@param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL.\r
- @param[in] User User profile handle. \r
+ @param[in] User User profile handle.\r
\r
@retval EFI_SUCCESS User profile was successfully deleted.\r
@retval EFI_ACCESS_DENIED Current user does not have sufficient permissions to delete a user\r
/**\r
Enumerate all of the enrolled users on the platform.\r
\r
- This function returns the next enrolled user profile. To retrieve the first user profile handle, point \r
- User at a NULL. Each subsequent call will retrieve another user profile handle until there are no \r
- more, at which point User will point to NULL. \r
+ This function returns the next enrolled user profile. To retrieve the first user profile handle, point\r
+ User at a NULL. Each subsequent call will retrieve another user profile handle until there are no\r
+ more, at which point User will point to NULL.\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 previous user profile handle or NULL to \r
+ @param[in,out] User On entry, points to the previous user profile handle or NULL to\r
start enumeration. On exit, points to the next user profile handle\r
or NULL if there are no more user profiles.\r
\r
- @retval EFI_SUCCESS Next enrolled user profile successfully returned. \r
+ @retval EFI_SUCCESS Next enrolled user profile successfully returned.\r
@retval EFI_ACCESS_DENIED Next enrolled user profile was not successfully returned.\r
@retval EFI_INVALID_PARAMETER The User parameter is NULL.\r
**/\r
@param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL.\r
@param[out] CurrentUser On return, points to the current user profile handle.\r
\r
- @retval EFI_SUCCESS Current user profile handle returned successfully. \r
+ @retval EFI_SUCCESS Current user profile handle returned successfully.\r
@retval EFI_INVALID_PARAMETER The CurrentUser parameter is NULL.\r
**/\r
typedef\r
Identify a user.\r
\r
Identify the user and, if authenticated, returns the user handle and changes the current user profile.\r
- All user information marked as private in a previously selected profile is no longer available for \r
- inspection. \r
- Whenever the current user profile is changed then the an event with the GUID \r
+ All user information marked as private in a previously selected profile is no longer available for\r
+ inspection.\r
+ Whenever the current user profile is changed then the an event with the GUID\r
EFI_EVENT_GROUP_USER_PROFILE_CHANGED is signaled.\r
\r
@param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL.\r
/**\r
Find a user using a user information record.\r
\r
- This function searches all user profiles for the specified user information record. The search starts \r
- with the user information record handle following UserInfo and continues until either the \r
+ This function searches all user profiles for the specified user information record. The search starts\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
+ 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.\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
- searching with the first user profile. On return, points to the user profile handle or \r
+ @param[in,out] User On entry, points to the previously returned user profile handle or NULL to start\r
+ searching with the first user profile. On return, points to the user profile handle or\r
NULL if not found.\r
- @param[in,out] UserInfo On entry, points to the previously returned user information handle or NULL to start \r
- searching with the first. On return, points to the user information handle of the user \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 the user information record data is empty, then only the user \r
- information record type is compared. \r
+ @param[in,out] UserInfo On entry, points to the previously returned user information handle or NULL to start\r
+ searching with the first. On return, points to the user information handle of the user\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 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
+ @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 UserInfo\r
points to the user information handle.\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 \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 current user does not exist, and the credential provider can identify a user, then make the user \r
+ If the User Identity Manager doesn't support asynchronous changes in credentials, then this function\r
+ should return EFI_UNSUPPORTED.\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
+ 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
+ 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
/**\r
Return information attached to the user.\r
\r
- This function returns user information. The format of the information is described in User \r
- Information. The function may return EFI_ACCESS_DENIED if the information is marked private \r
- and the handle specified by User is not the current user profile. The function may return \r
- EFI_ACCESS_DENIED if the information is marked protected and the information is associated \r
+ This function returns user information. The format of the information is described in User\r
+ Information. The function may return EFI_ACCESS_DENIED if the information is marked private\r
+ and the handle specified by User is not the current user profile. The function may return\r
+ EFI_ACCESS_DENIED if the information is marked protected and the information is associated\r
with a credential provider for which the user has not been authenticated.\r
\r
@param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL.\r
- @param[in] User Handle of the user whose profile will be retrieved. \r
- @param[in] UserInfo Handle of the user information data record. \r
- @param[out] Info On entry, points to a buffer of at least *InfoSize bytes. On exit, holds the user \r
- information. If the buffer is too small to hold the information, then \r
- EFI_BUFFER_TOO_SMALL is returned and InfoSize is updated to contain the \r
- number of bytes actually required. \r
- @param[in,out] InfoSize On entry, points to the size of Info. On return, points to the size of the user \r
- information. \r
+ @param[in] User Handle of the user whose profile will be retrieved.\r
+ @param[in] UserInfo Handle of the user information data record.\r
+ @param[out] Info On entry, points to a buffer of at least *InfoSize bytes. On exit, holds the user\r
+ information. If the buffer is too small to hold the information, then\r
+ EFI_BUFFER_TOO_SMALL is returned and InfoSize is updated to contain the\r
+ number of bytes actually required.\r
+ @param[in,out] InfoSize On entry, points to the size of Info. On return, points to the size of the user\r
+ information.\r
\r
@retval EFI_SUCCESS Information returned successfully.\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
+ @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
+**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_USER_PROFILE_GET_INFO)(\r
/**\r
Add or update user information.\r
\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
+ 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
+ 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
+ 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
\r
@param[in] This Points to this instance of the EFI_USER_MANAGER_PROTOCOL.\r
- @param[in] User Handle of the user whose profile will be retrieved. \r
- @param[in,out] UserInfo Handle of the user information data record. \r
- @param[in] Info On entry, points to a buffer of at least *InfoSize bytes. On exit, holds the user \r
- information. If the buffer is too small to hold the information, then \r
- EFI_BUFFER_TOO_SMALL is returned and InfoSize is updated to contain the \r
- number of bytes actually required. \r
- @param[in] InfoSize On entry, points to the size of Info. On return, points to the size of the user \r
- information. \r
+ @param[in] User Handle of the user whose profile will be retrieved.\r
+ @param[in,out] UserInfo Handle of the user information data record.\r
+ @param[in] Info On entry, points to a buffer of at least *InfoSize bytes. On exit, holds the user\r
+ information. If the buffer is too small to hold the information, then\r
+ EFI_BUFFER_TOO_SMALL is returned and InfoSize is updated to contain the\r
+ number of bytes actually required.\r
+ @param[in] InfoSize On entry, points to the size of Info. On return, points to the size of the user\r
+ information.\r
\r
@retval EFI_SUCCESS Information returned successfully.\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
+ @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
+ @retval EFI_INVALID_PARAMETER UserInfo is NULL or Info is NULL.\r
+**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_USER_PROFILE_SET_INFO)(\r
\r
@retval EFI_SUCCESS User information deleted successfully.\r
@retval EFI_NOT_FOUND User information record UserInfo does not exist in the user profile.\r
- @retval EFI_ACCESS_DENIED The current user does not have permission to delete this user information. \r
-**/ \r
+ @retval EFI_ACCESS_DENIED The current user does not have permission to delete this user information.\r
+**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_USER_PROFILE_DELETE_INFO)(\r
/**\r
Enumerate user information of all the enrolled users on the platform.\r
\r
- This function returns the next user information record. To retrieve the first user information record \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
+ This function returns the next user information record. To retrieve the first user information record\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
@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
@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
+**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_USER_PROFILE_GET_NEXT_INFO)(\r
projects / mirror_edk2.git / blobdiff