init

hc

2024-03-22 a0752693d998599af469473b8dc239ef973a012f

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
/** @file 
  Provides services to set/verify password and return if the password is set. 
 
  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR> 
  SPDX-License-Identifier: BSD-2-Clause-Patent 
 
**/ 
 
#ifndef __USER_PASSWORD_LIB_H__ 
#define __USER_PASSWORD_LIB_H__ 
 
/** 
  Validate if the password is correct. 
 
  @param[in] Password               The user input password. 
  @param[in] PasswordSize           The size of Password in byte. 
 
  @retval EFI_SUCCESS               The password is correct. 
  @retval EFI_SECURITY_VIOLATION    The password is incorrect. 
  @retval EFI_INVALID_PARAMETER     The password or size is invalid. 
  @retval EFI_OUT_OF_RESOURCES      Insufficient resources to verify the password. 
  @retval EFI_ACCESS_DENIED         Password retry count reach. 
**/ 
EFI_STATUS 
EFIAPI 
VerifyPassword ( 
  IN CHAR16         *Password, 
  IN UINTN          PasswordSize 
  ); 
 
/** 
  Set a new password. 
 
  @param[in] NewPassword            The user input new password. 
                                    NULL means clear password. 
  @param[in] NewPasswordSize        The size of NewPassword in byte. 
  @param[in] OldPassword            The user input old password. 
                                    NULL means no old password. 
  @param[in] OldPasswordSize        The size of OldPassword in byte. 
 
  @retval EFI_SUCCESS               The NewPassword is set successfully. 
  @retval EFI_SECURITY_VIOLATION    The OldPassword is incorrect. 
  @retval EFI_INVALID_PARAMETER     The password or size is invalid. 
  @retval EFI_OUT_OF_RESOURCES      Insufficient resources to set the password. 
  @retval EFI_ACCESS_DENIED         Password retry count reach. 
  @retval EFI_UNSUPPORTED           NewPassword is not strong enough. 
  @retval EFI_ALREADY_STARTED       NewPassword is in history. 
**/ 
EFI_STATUS 
EFIAPI 
SetPassword ( 
  IN CHAR16         *NewPassword,     OPTIONAL 
  IN UINTN          NewPasswordSize, 
  IN CHAR16         *OldPassword,     OPTIONAL 
  IN UINTN          OldPasswordSize 
  ); 
 
/** 
  Return if the password is set. 
 
  @retval TRUE      The password is set. 
  @retval FALSE     The password is not set. 
**/ 
BOOLEAN 
EFIAPI 
IsPasswordInstalled ( 
  VOID 
  ); 
 
#endif