OLD | NEW |
---|---|
1 // Copyright 2016 The Chromium Authors. All rights reserved. | 1 // Copyright 2016 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 // Use the <code>chrome.quickUnlockPrivate</code> API to change the active quick | 5 // Use the <code>chrome.quickUnlockPrivate</code> API to change the active quick |
6 // unlock modes and to change their respective credentials. | 6 // unlock modes and to change their respective credentials. |
7 // | 7 // |
8 // Quick unlock only supports unlocking an account that has already been signed | 8 // Quick unlock only supports unlocking an account that has already been signed |
9 // in. | 9 // in. |
10 // | 10 // |
11 // The quick unlock authentication facilities are not available through this | 11 // The quick unlock authentication facilities are not available through this |
12 // API; they are built directly into the lock screen. | 12 // API; they are built directly into the lock screen. |
13 | 13 |
14 [platforms=("chromeos"), | 14 [platforms=("chromeos"), |
15 implemented_in="chrome/browser/chromeos/extensions/quick_unlock_private/quick_u nlock_private_api.h"] | 15 implemented_in="chrome/browser/chromeos/extensions/quick_unlock_private/quick_u nlock_private_api.h"] |
16 namespace quickUnlockPrivate { | 16 namespace quickUnlockPrivate { |
17 // TODO(jdufault): Add more quick unlock modes, such as a pattern unlock. | 17 // TODO(jdufault): Add more quick unlock modes, such as a pattern unlock. |
18 enum QuickUnlockMode { | 18 enum QuickUnlockMode { |
19 PIN | 19 PIN |
20 }; | 20 }; |
21 | 21 |
22 // The problems a given PIN might have. | |
23 enum CredentialProblem { | |
24 TOO_SHORT, | |
25 TOO_LONG, | |
26 TOO_WEAK, | |
27 CONTAINS_NONDIGIT | |
28 }; | |
29 | |
30 dictionary CredentialCheck { | |
31 // The given PINs errors. Users cannot proceed with an error. | |
32 CredentialProblem[] errors; | |
33 // THe given PINs warnings. Users can, but are not advised to proceed with | |
34 // a warning. | |
35 CredentialProblem[] warnings; | |
36 // The minimum allowed length for a PIN. | |
37 long minLength; | |
38 // The maximum allowed length for a PIN. A value of 0 indicates no maximum | |
39 // length. | |
40 long maxLength; | |
41 }; | |
stevenjb
2016/11/30 18:13:58
It seems a little awkward to me that we return the
sammiequon
2016/11/30 23:03:42
Done.
| |
42 | |
22 callback BooleanResultCallback = void (boolean value); | 43 callback BooleanResultCallback = void (boolean value); |
23 callback ModesCallback = void (QuickUnlockMode[] modes); | 44 callback ModesCallback = void (QuickUnlockMode[] modes); |
45 callback CredentialCheckCallback = void (CredentialCheck check); | |
24 | 46 |
25 interface Functions { | 47 interface Functions { |
26 // Returns the set of quick unlock modes that are available for the user to | 48 // Returns the set of quick unlock modes that are available for the user to |
27 // use. Some quick unlock modes may be disabled by policy. | 49 // use. Some quick unlock modes may be disabled by policy. |
28 static void getAvailableModes(ModesCallback onComplete); | 50 static void getAvailableModes(ModesCallback onComplete); |
29 | 51 |
30 // Returns the quick unlock modes that are currently enabled and usable on | 52 // Returns the quick unlock modes that are currently enabled and usable on |
31 // the lock screen. | 53 // the lock screen. |
32 static void getActiveModes(ModesCallback onComplete); | 54 static void getActiveModes(ModesCallback onComplete); |
33 | 55 |
56 // Checks if the given credential can be used for the given unlock mode. | |
57 // Enterprise policy can change credential requirements. | |
58 // |mode|: The quick unlock mode that is used. | |
59 // |credential|: The given credential. | |
60 // |onComplete|: Called with a list of warnings and errors the given | |
61 // |credential| has (if any). Allow provides extra information needed to be | |
62 // displayed. | |
63 static void checkCredential(QuickUnlockMode mode, | |
64 DOMString credential, | |
65 CredentialCheckCallback onComplete); | |
66 | |
34 // Update the set of quick unlock modes that are currently active/enabled. | 67 // Update the set of quick unlock modes that are currently active/enabled. |
35 // |accountPassword|: The password associated with the account (e.g. the | 68 // |accountPassword|: The password associated with the account (e.g. the |
36 // GAIA password). This is required to change the quick unlock credentials. | 69 // GAIA password). This is required to change the quick unlock credentials. |
37 // |modes|: The quick unlock modes that should be active. | 70 // |modes|: The quick unlock modes that should be active. |
38 // |credentials|: The associated credential for each mode. To keep | 71 // |credentials|: The associated credential for each mode. To keep |
39 // the credential the same for the associated mode, pass an empty string. | 72 // the credential the same for the associated mode, pass an empty string. |
40 // |onComplete|: Called with true if the quick unlock state was updated, | 73 // |onComplete|: Called with true if the quick unlock state was updated, |
41 // false otherwise. The update is treated as a single atomic operation. | 74 // false otherwise. The update is treated as a single atomic operation. |
42 static void setModes(DOMString accountPassword, | 75 static void setModes(DOMString accountPassword, |
43 QuickUnlockMode[] modes, DOMString[] credentials, | 76 QuickUnlockMode[] modes, DOMString[] credentials, |
44 BooleanResultCallback onComplete); | 77 BooleanResultCallback onComplete); |
45 }; | 78 }; |
46 | 79 |
47 interface Events { | 80 interface Events { |
48 // Called after the active set of quick unlock modes has changed. | 81 // Called after the active set of quick unlock modes has changed. |
49 // |activeModes|: The set of quick unlock modes which are now active. | 82 // |activeModes|: The set of quick unlock modes which are now active. |
50 static void onActiveModesChanged(QuickUnlockMode[] activeModes); | 83 static void onActiveModesChanged(QuickUnlockMode[] activeModes); |
51 }; | 84 }; |
52 }; | 85 }; |
OLD | NEW |