xref: /aosp_15_r20/hardware/interfaces/biometrics/face/1.0/default/BiometricsFace.h (revision 4d7e907c777eeecc4c5bd7cf640a754fac206ff7)
1*4d7e907cSAndroid Build Coastguard Worker /*
2*4d7e907cSAndroid Build Coastguard Worker  * Copyright 2020 The Android Open Source Project
3*4d7e907cSAndroid Build Coastguard Worker  *
4*4d7e907cSAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*4d7e907cSAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*4d7e907cSAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*4d7e907cSAndroid Build Coastguard Worker  *
8*4d7e907cSAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*4d7e907cSAndroid Build Coastguard Worker  *
10*4d7e907cSAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*4d7e907cSAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*4d7e907cSAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*4d7e907cSAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*4d7e907cSAndroid Build Coastguard Worker  * limitations under the License.
15*4d7e907cSAndroid Build Coastguard Worker  */
16*4d7e907cSAndroid Build Coastguard Worker 
17*4d7e907cSAndroid Build Coastguard Worker #pragma once
18*4d7e907cSAndroid Build Coastguard Worker 
19*4d7e907cSAndroid Build Coastguard Worker #include <android/hardware/biometrics/face/1.0/IBiometricsFace.h>
20*4d7e907cSAndroid Build Coastguard Worker #include <hidl/MQDescriptor.h>
21*4d7e907cSAndroid Build Coastguard Worker #include <hidl/Status.h>
22*4d7e907cSAndroid Build Coastguard Worker #include <random>
23*4d7e907cSAndroid Build Coastguard Worker 
24*4d7e907cSAndroid Build Coastguard Worker namespace android::hardware::biometrics::face::implementation {
25*4d7e907cSAndroid Build Coastguard Worker 
26*4d7e907cSAndroid Build Coastguard Worker using ::android::sp;
27*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::hidl_array;
28*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::hidl_memory;
29*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::hidl_string;
30*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::hidl_vec;
31*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::Return;
32*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::Void;
33*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::biometrics::face::V1_0::Feature;
34*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::biometrics::face::V1_0::IBiometricsFaceClientCallback;
35*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::biometrics::face::V1_0::Status;
36*4d7e907cSAndroid Build Coastguard Worker 
37*4d7e907cSAndroid Build Coastguard Worker class BiometricsFace : public V1_0::IBiometricsFace {
38*4d7e907cSAndroid Build Coastguard Worker   public:
39*4d7e907cSAndroid Build Coastguard Worker     BiometricsFace();
40*4d7e907cSAndroid Build Coastguard Worker 
41*4d7e907cSAndroid Build Coastguard Worker     // Methods from ::android::hardware::biometrics::face::V1_0::IBiometricsFace follow.
42*4d7e907cSAndroid Build Coastguard Worker     Return<void> setCallback(const sp<IBiometricsFaceClientCallback>& clientCallback,
43*4d7e907cSAndroid Build Coastguard Worker                              setCallback_cb _hidl_cb) override;
44*4d7e907cSAndroid Build Coastguard Worker 
45*4d7e907cSAndroid Build Coastguard Worker     Return<Status> setActiveUser(int32_t userId, const hidl_string& storePath) override;
46*4d7e907cSAndroid Build Coastguard Worker 
47*4d7e907cSAndroid Build Coastguard Worker     Return<void> generateChallenge(uint32_t challengeTimeoutSec,
48*4d7e907cSAndroid Build Coastguard Worker                                    generateChallenge_cb _hidl_cb) override;
49*4d7e907cSAndroid Build Coastguard Worker 
50*4d7e907cSAndroid Build Coastguard Worker     Return<Status> enroll(const hidl_vec<uint8_t>& hat, uint32_t timeoutSec,
51*4d7e907cSAndroid Build Coastguard Worker                           const hidl_vec<Feature>& disabledFeatures) override;
52*4d7e907cSAndroid Build Coastguard Worker 
53*4d7e907cSAndroid Build Coastguard Worker     Return<Status> revokeChallenge() override;
54*4d7e907cSAndroid Build Coastguard Worker 
55*4d7e907cSAndroid Build Coastguard Worker     Return<Status> setFeature(Feature feature, bool enabled, const hidl_vec<uint8_t>& hat,
56*4d7e907cSAndroid Build Coastguard Worker                               uint32_t faceId) override;
57*4d7e907cSAndroid Build Coastguard Worker 
58*4d7e907cSAndroid Build Coastguard Worker     Return<void> getFeature(Feature feature, uint32_t faceId, getFeature_cb _hidl_cb) override;
59*4d7e907cSAndroid Build Coastguard Worker 
60*4d7e907cSAndroid Build Coastguard Worker     Return<void> getAuthenticatorId(getAuthenticatorId_cb _hidl_cb) override;
61*4d7e907cSAndroid Build Coastguard Worker 
62*4d7e907cSAndroid Build Coastguard Worker     Return<Status> cancel() override;
63*4d7e907cSAndroid Build Coastguard Worker 
64*4d7e907cSAndroid Build Coastguard Worker     Return<Status> enumerate() override;
65*4d7e907cSAndroid Build Coastguard Worker 
66*4d7e907cSAndroid Build Coastguard Worker     Return<Status> remove(uint32_t faceId) override;
67*4d7e907cSAndroid Build Coastguard Worker 
68*4d7e907cSAndroid Build Coastguard Worker     Return<Status> authenticate(uint64_t operationId) override;
69*4d7e907cSAndroid Build Coastguard Worker 
70*4d7e907cSAndroid Build Coastguard Worker     Return<Status> userActivity() override;
71*4d7e907cSAndroid Build Coastguard Worker 
72*4d7e907cSAndroid Build Coastguard Worker     Return<Status> resetLockout(const hidl_vec<uint8_t>& hat) override;
73*4d7e907cSAndroid Build Coastguard Worker 
74*4d7e907cSAndroid Build Coastguard Worker   private:
75*4d7e907cSAndroid Build Coastguard Worker     std::mt19937 mRandom;
76*4d7e907cSAndroid Build Coastguard Worker     int32_t mUserId;
77*4d7e907cSAndroid Build Coastguard Worker     sp<IBiometricsFaceClientCallback> mClientCallback;
78*4d7e907cSAndroid Build Coastguard Worker };
79*4d7e907cSAndroid Build Coastguard Worker 
80*4d7e907cSAndroid Build Coastguard Worker }  // namespace android::hardware::biometrics::face::implementation
81