| /* |
| * Copyright (C) 2018 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package android.hardware.biometrics; |
| |
| import android.os.Bundle; |
| import android.hardware.biometrics.IBiometricEnabledOnKeyguardCallback; |
| import android.hardware.biometrics.IBiometricServiceReceiver; |
| import android.hardware.biometrics.IBiometricAuthenticator; |
| |
| /** |
| * Communication channel from AuthService to BiometricService. |
| * @hide |
| */ |
| interface IBiometricService { |
| // Requests authentication. The service choose the appropriate biometric to use, and show |
| // the corresponding BiometricDialog. |
| void authenticate(IBinder token, long sessionId, int userId, |
| IBiometricServiceReceiver receiver, String opPackageName, in Bundle bundle, |
| int callingUid, int callingPid, int callingUserId); |
| |
| // Cancel authentication for the given session. |
| void cancelAuthentication(IBinder token, String opPackageName, int callingUid, int callingPid, |
| int callingUserId); |
| |
| // Checks if biometrics can be used. |
| int canAuthenticate(String opPackageName, int userId, int callingUserId, int authenticators); |
| |
| // Checks if any biometrics are enrolled. |
| boolean hasEnrolledBiometrics(int userId, String opPackageName); |
| |
| // Registers an authenticator (e.g. face, fingerprint, iris). |
| // Id must be unique, whereas strength and modality don't need to be. |
| // TODO(b/123321528): Turn strength and modality into enums. |
| void registerAuthenticator(int id, int modality, int strength, |
| IBiometricAuthenticator authenticator); |
| |
| // Register callback for when keyguard biometric eligibility changes. |
| void registerEnabledOnKeyguardCallback(IBiometricEnabledOnKeyguardCallback callback, |
| int callingUserId); |
| |
| // Explicitly set the active user. |
| void setActiveUser(int userId); |
| |
| // Notify BiometricService when <Biometric>Service is ready to start the prepared client. |
| // Client lifecycle is still managed in <Biometric>Service. |
| void onReadyForAuthentication(int cookie, boolean requireConfirmation, int userId); |
| |
| // Reset the lockout when user authenticates with strong auth (e.g. PIN, pattern or password) |
| void resetLockout(in byte [] token); |
| } |