Clean up the private GUID definition in module Level.
[mirror_edk2.git] / SecurityPkg / UserIdentification / UsbCredentialProviderDxe / UsbCredentialProvider.h
1 /** @file
2 Usb Credential Provider driver header file.
3
4 Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 **/
14
15 #ifndef _USB_CREDENTIAL_PROVIDER_H_
16 #define _USB_CREDENTIAL_PROVIDER_H_
17
18 #include <Uefi.h>
19
20 #include <Guid/GlobalVariable.h>
21 #include <Guid/FileInfo.h>
22 #include <Guid/SecurityPkgTokenSpace.h>
23 #include <Guid/UsbCredentialProviderHii.h>
24
25 #include <Protocol/SimpleFileSystem.h>
26 #include <Protocol/BlockIo.h>
27 #include <Protocol/UserCredential.h>
28 #include <Protocol/UserManager.h>
29
30 #include <Library/UefiRuntimeServicesTableLib.h>
31 #include <Library/UefiBootServicesTableLib.h>
32 #include <Library/MemoryAllocationLib.h>
33 #include <Library/BaseMemoryLib.h>
34 #include <Library/DevicePathLib.h>
35 #include <Library/BaseCryptLib.h>
36 #include <Library/DebugLib.h>
37 #include <Library/UefiLib.h>
38 #include <Library/PrintLib.h>
39 #include <Library/HiiLib.h>
40 #include <Library/PcdLib.h>
41
42 extern UINT8 UsbCredentialProviderStrings[];
43
44 #define USB_TABLE_INC 16
45 #define HASHED_CREDENTIAL_LEN 20
46
47 //
48 // Save the enroll user credential Information.
49 //
50 typedef struct {
51 EFI_USER_INFO_IDENTIFIER UserId;
52 UINT8 Token[HASHED_CREDENTIAL_LEN];
53 } USB_INFO;
54
55 //
56 // USB Credential Table.
57 //
58 typedef struct {
59 UINTN Count;
60 UINTN MaxCount;
61 USB_INFO UserInfo[1];
62 } CREDENTIAL_TABLE;
63
64 //
65 // The user information on the USB provider.
66 //
67 typedef struct {
68 UINTN Count;
69 EFI_USER_INFO *Info[1];
70 } USB_CREDENTIAL_INFO;
71
72 #define USB_PROVIDER_SIGNATURE SIGNATURE_32 ('U', 'S', 'B', 'P')
73
74 typedef struct {
75 UINTN Signature;
76 EFI_HANDLE DriverHandle;
77 EFI_HII_HANDLE HiiHandle;
78 } USB_PROVIDER_CALLBACK_INFO;
79
80 /**
81 Enroll a user on a credential provider.
82
83 This function enrolls and deletes a user profile using this credential provider.
84 If a user profile is successfully enrolled, it calls the User Manager Protocol
85 function Notify() to notify the user manager driver that credential information
86 has changed. If an enrolled user does exist, delete the user on the credential
87 provider.
88
89 @param[in] This Points to this instance of EFI_USER_CREDENTIAL_PROTOCOL.
90 @param[in] User The user profile to enroll.
91
92 @retval EFI_SUCCESS User profile was successfully enrolled.
93 @retval EFI_ACCESS_DENIED Current user profile does not permit enrollment on the
94 user profile handle. Either the user profile cannot enroll
95 on any user profile or cannot enroll on a user profile
96 other than the current user profile.
97 @retval EFI_UNSUPPORTED This credential provider does not support enrollment in
98 the pre-OS.
99 @retval EFI_DEVICE_ERROR The new credential could not be created because of a device
100 error.
101 @retval EFI_INVALID_PARAMETER User does not refer to a valid user profile handle.
102
103 **/
104 EFI_STATUS
105 EFIAPI
106 CredentialEnroll (
107 IN CONST EFI_USER_CREDENTIAL_PROTOCOL *This,
108 IN EFI_USER_PROFILE_HANDLE User
109 );
110
111 /**
112 Returns the user interface information used during user identification.
113
114 This function returns information about the form used when interacting with the
115 user during user identification. The form is the first enabled form in the form-set
116 class EFI_HII_USER_CREDENTIAL_FORMSET_GUID installed on the HII handle HiiHandle. If
117 the user credential provider does not require a form to identify the user, then this
118 function should return EFI_NOT_FOUND.
119
120 @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.
121 @param[out] Hii On return, holds the HII database handle.
122 @param[out] FormSetId On return, holds the identifier of the form set which contains
123 the form used during user identification.
124 @param[out] FormId On return, holds the identifier of the form used during user
125 identification.
126
127 @retval EFI_SUCCESS Form returned successfully.
128 @retval EFI_NOT_FOUND Form not returned.
129 @retval EFI_INVALID_PARAMETER Hii is NULL or FormSetId is NULL or FormId is NULL.
130
131 **/
132 EFI_STATUS
133 EFIAPI
134 CredentialForm (
135 IN CONST EFI_USER_CREDENTIAL_PROTOCOL *This,
136 OUT EFI_HII_HANDLE *Hii,
137 OUT EFI_GUID *FormSetId,
138 OUT EFI_FORM_ID *FormId
139 );
140
141 /**
142 Returns bitmap used to describe the credential provider type.
143
144 This optional function returns a bitmap which is less than or equal to the number
145 of pixels specified by Width and Height. If no such bitmap exists, then EFI_NOT_FOUND
146 is returned.
147
148 @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.
149 @param[in, out] Width On entry, points to the desired bitmap width. If NULL then no
150 bitmap information will be returned. On exit, points to the
151 width of the bitmap returned.
152 @param[in, out] Height On entry, points to the desired bitmap height. If NULL then no
153 bitmap information will be returned. On exit, points to the
154 height of the bitmap returned.
155 @param[out] Hii On return, holds the HII database handle.
156 @param[out] Image On return, holds the HII image identifier.
157
158 @retval EFI_SUCCESS Image identifier returned successfully.
159 @retval EFI_NOT_FOUND Image identifier not returned.
160 @retval EFI_INVALID_PARAMETER Hii is NULL or Image is NULL.
161
162 **/
163 EFI_STATUS
164 EFIAPI
165 CredentialTile (
166 IN CONST EFI_USER_CREDENTIAL_PROTOCOL *This,
167 IN OUT UINTN *Width,
168 IN OUT UINTN *Height,
169 OUT EFI_HII_HANDLE *Hii,
170 OUT EFI_IMAGE_ID *Image
171 );
172
173 /**
174 Returns string used to describe the credential provider type.
175
176 This function returns a string which describes the credential provider. If no
177 such string exists, then EFI_NOT_FOUND is returned.
178
179 @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.
180 @param[out] Hii On return, holds the HII database handle.
181 @param[out] String On return, holds the HII string identifier.
182
183 @retval EFI_SUCCESS String identifier returned successfully.
184 @retval EFI_NOT_FOUND String identifier not returned.
185 @retval EFI_INVALID_PARAMETER Hii is NULL or String is NULL.
186
187 **/
188 EFI_STATUS
189 EFIAPI
190 CredentialTitle (
191 IN CONST EFI_USER_CREDENTIAL_PROTOCOL *This,
192 OUT EFI_HII_HANDLE *Hii,
193 OUT EFI_STRING_ID *String
194 );
195
196 /**
197 Return the user identifier associated with the currently authenticated user.
198
199 This function returns the user identifier of the user authenticated by this credential
200 provider. This function is called after the credential-related information has been
201 submitted on a form OR after a call to Default() has returned that this credential is
202 ready to log on.
203
204 @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.
205 @param[in] User The user profile handle of the user profile currently being
206 considered by the user identity manager. If NULL, then no user
207 profile is currently under consideration.
208 @param[out] Identifier On return, points to the user identifier.
209
210 @retval EFI_SUCCESS User identifier returned successfully.
211 @retval EFI_NOT_READY No user identifier can be returned.
212 @retval EFI_ACCESS_DENIED The user has been locked out of this user credential.
213 @retval EFI_INVALID_PARAMETER This is NULL, or Identifier is NULL.
214 @retval EFI_NOT_FOUND User is not NULL, and the specified user handle can't be
215 found in user profile database.
216
217 **/
218 EFI_STATUS
219 EFIAPI
220 CredentialUser (
221 IN CONST EFI_USER_CREDENTIAL_PROTOCOL *This,
222 IN EFI_USER_PROFILE_HANDLE User,
223 OUT EFI_USER_INFO_IDENTIFIER *Identifier
224 );
225
226 /**
227 Indicate that user interface interaction has begun for the specified credential.
228
229 This function is called when a credential provider is selected by the user. If
230 AutoLogon returns FALSE, then the user interface will be constructed by the User
231 Identity Manager.
232
233 @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.
234 @param[out] AutoLogon On return, points to the credential provider's capabilities
235 after the credential provider has been selected by the user.
236
237 @retval EFI_SUCCESS Credential provider successfully selected.
238 @retval EFI_INVALID_PARAMETER AutoLogon is NULL.
239
240 **/
241 EFI_STATUS
242 EFIAPI
243 CredentialSelect (
244 IN CONST EFI_USER_CREDENTIAL_PROTOCOL *This,
245 OUT EFI_CREDENTIAL_LOGON_FLAGS *AutoLogon
246 );
247
248 /**
249 Indicate that user interface interaction has ended for the specified credential.
250
251 This function is called when a credential provider is deselected by the user.
252
253 @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.
254
255 @retval EFI_SUCCESS Credential provider successfully deselected.
256
257 **/
258 EFI_STATUS
259 EFIAPI
260 CredentialDeselect (
261 IN CONST EFI_USER_CREDENTIAL_PROTOCOL *This
262 );
263
264 /**
265 Return the default logon behavior for this user credential.
266
267 This function reports the default login behavior regarding this credential provider.
268
269 @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.
270 @param[out] AutoLogon On return, holds whether the credential provider should be used
271 by default to automatically log on the user.
272
273 @retval EFI_SUCCESS Default information successfully returned.
274 @retval EFI_INVALID_PARAMETER AutoLogon is NULL.
275
276 **/
277 EFI_STATUS
278 EFIAPI
279 CredentialDefault (
280 IN CONST EFI_USER_CREDENTIAL_PROTOCOL *This,
281 OUT EFI_CREDENTIAL_LOGON_FLAGS *AutoLogon
282 );
283
284 /**
285 Return information attached to the credential provider.
286
287 This function returns user information.
288
289 @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.
290 @param[in] UserInfo Handle of the user information data record.
291 @param[out] Info On entry, points to a buffer of at least *InfoSize bytes. On
292 exit, holds the user information. If the buffer is too small
293 to hold the information, then EFI_BUFFER_TOO_SMALL is returned
294 and InfoSize is updated to contain the number of bytes actually
295 required.
296 @param[in, out] InfoSize On entry, points to the size of Info. On return, points to the
297 size of the user information.
298
299 @retval EFI_SUCCESS Information returned successfully.
300 @retval EFI_BUFFER_TOO_SMALL The size specified by InfoSize is too small to hold all of the
301 user information. The size required is returned in *InfoSize.
302 @retval EFI_INVALID_PARAMETER Info is NULL or InfoSize is NULL.
303 @retval EFI_NOT_FOUND The specified UserInfo does not refer to a valid user info handle.
304
305 **/
306 EFI_STATUS
307 EFIAPI
308 CredentialGetInfo (
309 IN CONST EFI_USER_CREDENTIAL_PROTOCOL *This,
310 IN EFI_USER_INFO_HANDLE UserInfo,
311 OUT EFI_USER_INFO *Info,
312 IN OUT UINTN *InfoSize
313 );
314
315 /**
316 Enumerate all of the user informations on the credential provider.
317
318 This function returns the next user information record. To retrieve the first user
319 information record handle, point UserInfo at a NULL. Each subsequent call will retrieve
320 another user information record handle until there are no more, at which point UserInfo
321 will point to NULL.
322
323 @param[in] This Points to this instance of the EFI_USER_CREDENTIAL_PROTOCOL.
324 @param[in, out] UserInfo On entry, points to the previous user information handle or NULL
325 to start enumeration. On exit, points to the next user information
326 handle or NULL if there is no more user information.
327
328 @retval EFI_SUCCESS User information returned.
329 @retval EFI_NOT_FOUND No more user information found.
330 @retval EFI_INVALID_PARAMETER UserInfo is NULL.
331
332 **/
333 EFI_STATUS
334 EFIAPI
335 CredentialGetNextInfo (
336 IN CONST EFI_USER_CREDENTIAL_PROTOCOL *This,
337 IN OUT EFI_USER_INFO_HANDLE *UserInfo
338 );
339
340 #endif