OLD | NEW |
---|---|
(Empty) | |
1 // Copyright 2017 The Chromium Authors. All rights reserved. | |
2 // Use of this source code is governed by a BSD-style license that can be | |
3 // found in the LICENSE file. | |
4 | |
5 #ifndef CHROMEOS_DBUS_BIOD_BIOMETRICS_MANAGER_CLIENT_H_ | |
6 #define CHROMEOS_DBUS_BIOD_BIOMETRICS_MANAGER_CLIENT_H_ | |
7 | |
8 #include <stdint.h> | |
9 | |
10 #include <unordered_map> | |
11 #include <vector> | |
12 | |
13 #include "base/callback.h" | |
14 #include "base/macros.h" | |
15 #include "base/observer_list.h" | |
16 #include "chromeos/chromeos_export.h" | |
17 #include "chromeos/dbus/dbus_client.h" | |
18 #include "chromeos/dbus/dbus_client_implementation_type.h" | |
19 #include "chromeos/dbus/dbus_method_call_status.h" | |
20 #include "third_party/cros_system_api/dbus/service_constants.h" | |
21 | |
22 namespace chromeos { | |
23 | |
24 // Each time the sensor detects a scan, an object containing all the users, each | |
25 // with the labels of all the matched stored fingerprints is returned. | |
26 using AuthScanMatches = | |
27 std::unordered_map<std::string, std::vector<std::string>>; | |
28 | |
29 // BiodBiometricsManagerClient is used to communicate with the biod dbus | |
Daniel Erat
2017/03/27 18:18:26
nit: D-Bus
sammiequon
2017/03/27 23:21:49
Done.
| |
30 // interface. | |
31 class CHROMEOS_EXPORT BiodBiometricsManagerClient : public DBusClient { | |
32 public: | |
33 // Interface for observing changes from the biometrics. | |
34 class Observer { | |
35 public: | |
36 // Called when biometrics manager powers up or is restarted. | |
37 virtual void ClientRestarted() {} | |
rkc
2017/03/25 00:28:20
This isn't the "client" that is restarting though,
Daniel Erat
2017/03/27 18:18:26
well, biod and chrome are both d-bus clients... bu
sammiequon
2017/03/27 23:21:48
Done.
sammiequon
2017/03/27 23:21:49
Done.
| |
38 | |
39 // Called whenever a user attempts a scan. |scan_result| tells whether the | |
40 // scan was succesful. |is_complete| tells whether enrollment is complete | |
41 // and now over. | |
42 virtual void EnrollScanDoneReceived(uint32_t scan_result, | |
Daniel Erat
2017/03/27 18:18:26
at least from this comment, i have no idea what |s
sammiequon
2017/03/27 23:21:49
Done.
| |
43 bool is_complete) {} | |
44 | |
45 // Called to indicate a bad scan of any kind, or a succesful scan. If scan | |
Daniel Erat
2017/03/27 18:18:26
nit: successful
sammiequon
2017/03/27 23:21:48
Done.
| |
46 // is successful, |matches| will equal all the enrollment IDs that match the | |
47 // scan, and the labels of the matched fingeprints. | |
48 virtual void AuthScanDoneReceived(uint32_t scan_result, | |
Daniel Erat
2017/03/27 18:18:26
as above, please document how to use |scan_result|
sammiequon
2017/03/27 23:21:49
Done.
| |
49 const AuthScanMatches& matches) {} | |
50 | |
51 // Called during either session to indicate a failure. Any enrollment that | |
52 // was underway is thrown away and auth will no longer be happening. | |
53 virtual void SessionFailedReceived() {} | |
54 | |
55 protected: | |
56 virtual ~Observer() {} | |
57 }; | |
58 | |
59 ~BiodBiometricsManagerClient() override; | |
60 | |
61 // Adds and removes the observer. | |
62 virtual void AddObserver(Observer* observer) = 0; | |
63 virtual void RemoveObserver(Observer* observer) = 0; | |
64 | |
65 // Returns true if this object has the given observer. | |
66 virtual bool HasObserver(const Observer* observer) const = 0; | |
67 | |
68 // UserRecordsCallback is used for the GetRecordsForUser method. It receives | |
69 // one argument which contains a list of the stored records object paths for | |
70 // a given user. | |
71 using UserRecordsCallback = | |
72 base::Callback<void(const std::vector<dbus::ObjectPath>&)>; | |
73 | |
74 // BiometricTypeCallback is used for the GetType method. It receives | |
75 // one argument which states the type of biometric. | |
76 using BiometricTypeCallback = base::Callback<void(biod::BiometricType)>; | |
77 | |
78 // Starts the biometric enroll session. |callback| is called with the object | |
79 // path of the current enroll session after the method succeeds. | |
80 virtual void StartEnrollSession(const std::string& user_id, | |
81 const std::string& label, | |
82 const ObjectPathCallback& callback) = 0; | |
83 | |
84 // Gets all the records registered with this biometric. |callback| is called | |
85 // with all the object paths of the records after this method succeeds. | |
86 virtual void GetRecordsForUser(const std::string& user_id, | |
87 const UserRecordsCallback& callback) = 0; | |
88 | |
89 // Irreversibly destroys all records registered with this biometric. | |
90 virtual void DestroyAllRecords() = 0; | |
91 | |
92 // Starts the biometric auth session. |callback| is called with the object | |
93 // path of the auth session after the method succeeds. | |
94 virtual void StartAuthSession(const ObjectPathCallback& callback) = 0; | |
95 | |
96 // Requests the type of biometric. |callback| is called with the biometric | |
97 // type after the method succeeds. | |
98 virtual void RequestType(const BiometricTypeCallback& callback) = 0; | |
99 | |
100 // Creates the instance. | |
101 static BiodBiometricsManagerClient* Create(DBusClientImplementationType type); | |
102 | |
103 protected: | |
104 friend class BiodBiometricsManagerClientTest; | |
105 | |
106 // Create() should be used instead. | |
107 BiodBiometricsManagerClient(); | |
108 | |
109 private: | |
110 DISALLOW_COPY_AND_ASSIGN(BiodBiometricsManagerClient); | |
111 }; | |
112 | |
113 } // namespace chromeos | |
114 | |
115 #endif // CHROMEOS_DBUS_BIOD_BIOMETRICS_MANAGER_CLIENT_H_ | |
OLD | NEW |