blob: 64b248e16554dc10ec4eed92f6298e57742b8d60 [file] [log] [blame]
/*
* Copyright (C) 2014 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 com.android.server.biometrics.fingerprint;
import static android.Manifest.permission.INTERACT_ACROSS_USERS;
import static android.Manifest.permission.MANAGE_FINGERPRINT;
import static android.Manifest.permission.RESET_FINGERPRINT_LOCKOUT;
import static android.Manifest.permission.USE_BIOMETRIC;
import static android.Manifest.permission.USE_FINGERPRINT;
import android.app.ActivityManager;
import android.app.AppOpsManager;
import android.content.Context;
import android.content.pm.PackageManager;
import android.content.pm.UserInfo;
import android.hardware.biometrics.BiometricAuthenticator;
import android.hardware.biometrics.BiometricConstants;
import android.hardware.biometrics.IBiometricPromptReceiver;
import android.hardware.biometrics.IBiometricServiceLockoutResetCallback;
import android.hardware.biometrics.fingerprint.V2_1.IBiometricsFingerprint;
import android.hardware.biometrics.fingerprint.V2_1.IBiometricsFingerprintClientCallback;
import android.hardware.fingerprint.Fingerprint;
import android.hardware.fingerprint.IFingerprintClientActiveCallback;
import android.hardware.fingerprint.IFingerprintService;
import android.hardware.fingerprint.IFingerprintServiceReceiver;
import android.os.Binder;
import android.os.Build;
import android.os.Bundle;
import android.os.Environment;
import android.os.IBinder;
import android.os.PowerManager;
import android.os.RemoteException;
import android.os.SELinux;
import android.os.ServiceManager;
import android.os.UserHandle;
import android.os.UserManager;
import android.util.Slog;
import android.util.proto.ProtoOutputStream;
import com.android.internal.annotations.GuardedBy;
import com.android.internal.logging.MetricsLogger;
import com.android.internal.statusbar.IStatusBarService;
import com.android.internal.util.DumpUtils;
import com.android.server.SystemServerInitThreadPool;
import com.android.server.biometrics.common.BiometricService;
import com.android.server.biometrics.common.BiometricUtils;
import com.android.server.biometrics.common.ClientMonitor;
import com.android.server.biometrics.common.EnumerateClient;
import com.android.server.biometrics.common.Metrics;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import java.io.File;
import java.io.FileDescriptor;
import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;
/**
* A service to manage multiple clients that want to access the fingerprint HAL API.
* The service is responsible for maintaining a list of clients and dispatching all
* fingerprint-related events.
*
* @hide
*/
public class FingerprintService extends BiometricService {
protected static final String TAG = "FingerprintService";
private static final boolean DEBUG = true;
private static final boolean CLEANUP_UNUSED_FP = true;
private static final String FP_DATA_DIR = "fpdata";
private static final String ACTION_LOCKOUT_RESET =
"com.android.server.biometrics.fingerprint.ACTION_LOCKOUT_RESET";
private static final int MAX_FAILED_ATTEMPTS_LOCKOUT_TIMED = 5;
private static final int MAX_FAILED_ATTEMPTS_LOCKOUT_PERMANENT = 20;
// TODO: This should be refactored into BiometricService
private final class UserFingerprint {
Fingerprint f;
int userId;
public UserFingerprint(Fingerprint f, int userId) {
this.f = f;
this.userId = userId;
}
}
/**
* Receives the incoming binder calls from FingerprintManager.
*/
private final class FingerprintServiceWrapper extends IFingerprintService.Stub {
/**
* The following methods contain common code which is shared in biometrics/common.
*/
@Override // Binder call
public long preEnroll(IBinder token) {
checkPermission(MANAGE_FINGERPRINT);
return startPreEnroll(token);
}
@Override // Binder call
public int postEnroll(IBinder token) {
checkPermission(MANAGE_FINGERPRINT);
return startPostEnroll(token);
}
@Override // Binder call
public void enroll(final IBinder token, final byte[] cryptoToken, final int userId,
final IFingerprintServiceReceiver receiver, final int flags,
final String opPackageName) {
checkPermission(MANAGE_FINGERPRINT);
final boolean restricted = isRestricted();
final int groupId = userId; // default group for fingerprint enrollment
final EnrollClientImpl client = new EnrollClientImpl(getContext(), mDaemonWrapper,
mHalDeviceId, token, new ServiceListenerImpl(receiver), mCurrentUserId, groupId,
cryptoToken, restricted, opPackageName);
enrollInternal(client, userId);
}
@Override // Binder call
public void cancelEnrollment(final IBinder token) {
checkPermission(MANAGE_FINGERPRINT);
cancelEnrollmentInternal(token);
}
@Override // Binder call
public void authenticate(final IBinder token, final long opId, final int groupId,
final IFingerprintServiceReceiver receiver, final int flags,
final String opPackageName, final Bundle bundle,
final IBiometricPromptReceiver dialogReceiver) {
final boolean restricted = isRestricted();
final AuthenticationClientImpl client = new AuthenticationClientImpl(getContext(),
mDaemonWrapper, mHalDeviceId, token, new ServiceListenerImpl(receiver),
mCurrentUserId, groupId, opId, restricted, opPackageName, bundle,
dialogReceiver, mStatusBarService);
authenticateInternal(client, opId, opPackageName);
}
@Override // Binder call
public void cancelAuthentication(final IBinder token, final String opPackageName) {
cancelAuthenticationInternal(token, opPackageName);
}
@Override // Binder call
public void setActiveUser(final int userId) {
checkPermission(MANAGE_FINGERPRINT);
setActiveUserInternal(userId);
}
@Override // Binder call
public void remove(final IBinder token, final int fingerId, final int groupId,
final int userId, final IFingerprintServiceReceiver receiver) {
checkPermission(MANAGE_FINGERPRINT);
if (token == null) {
Slog.w(TAG, "remove(): token is null");
return;
}
final boolean restricted = isRestricted();
final RemovalClientImpl client = new RemovalClientImpl(getContext(), mDaemonWrapper,
mHalDeviceId, token, new ServiceListenerImpl(receiver), fingerId, groupId,
userId, restricted, token.toString());
client.setShouldNotifyUserActivity(true);
removeInternal(client);
}
@Override // Binder call
public void enumerate(final IBinder token, final int userId,
final IFingerprintServiceReceiver receiver) {
checkPermission(MANAGE_FINGERPRINT);
final boolean restricted = isRestricted();
final EnumerateClientImpl client = new EnumerateClientImpl(getContext(), mDaemonWrapper,
mHalDeviceId, token, new ServiceListenerImpl(receiver), userId, userId,
restricted, getContext().getOpPackageName());
enumerateInternal(client);
}
@Override
public void addLockoutResetCallback(final IBiometricServiceLockoutResetCallback callback)
throws RemoteException {
FingerprintService.super.addLockoutResetCallback(callback);
}
@Override // Binder call
protected void dump(FileDescriptor fd, PrintWriter pw, String[] args) {
if (!DumpUtils.checkDumpPermission(getContext(), TAG, pw)) {
return;
}
final long ident = Binder.clearCallingIdentity();
try {
if (args.length > 0 && "--proto".equals(args[0])) {
dumpProto(fd);
} else {
dumpInternal(pw);
}
} finally {
Binder.restoreCallingIdentity(ident);
}
}
/**
* The following methods don't use any common code from BiometricService
*/
// TODO: refactor out common code here
@Override // Binder call
public boolean isHardwareDetected(long deviceId, String opPackageName) {
if (!canUseBiometric(opPackageName, false /* foregroundOnly */,
Binder.getCallingUid(), Binder.getCallingPid(),
UserHandle.getCallingUserId())) {
return false;
}
final long token = Binder.clearCallingIdentity();
try {
IBiometricsFingerprint daemon = getFingerprintDaemon();
return daemon != null && mHalDeviceId != 0;
} finally {
Binder.restoreCallingIdentity(token);
}
}
@Override // Binder call
public void rename(final int fingerId, final int groupId, final String name) {
checkPermission(MANAGE_FINGERPRINT);
if (!isCurrentUserOrProfile(groupId)) {
return;
}
mHandler.post(new Runnable() {
@Override
public void run() {
getBiometricUtils().renameBiometricForUser(getContext(), groupId,
fingerId, name);
}
});
}
@Override // Binder call
public List<Fingerprint> getEnrolledFingerprints(int userId, String opPackageName) {
if (!canUseBiometric(opPackageName, false /* foregroundOnly */,
Binder.getCallingUid(), Binder.getCallingPid(),
UserHandle.getCallingUserId())) {
return Collections.emptyList();
}
return FingerprintService.this.getEnrolledFingerprints(userId);
}
@Override // Binder call
public boolean hasEnrolledFingerprints(int userId, String opPackageName) {
if (!canUseBiometric(opPackageName, false /* foregroundOnly */,
Binder.getCallingUid(), Binder.getCallingPid(),
UserHandle.getCallingUserId())) {
return false;
}
return FingerprintService.this.hasEnrolledBiometrics(userId);
}
@Override // Binder call
public long getAuthenticatorId(String opPackageName) {
// In this method, we're not checking whether the caller is permitted to use fingerprint
// API because current authenticator ID is leaked (in a more contrived way) via Android
// Keystore (android.security.keystore package): the user of that API can create a key
// which requires fingerprint authentication for its use, and then query the key's
// characteristics (hidden API) which returns, among other things, fingerprint
// authenticator ID which was active at key creation time.
//
// Reason: The part of Android Keystore which runs inside an app's process invokes this
// method in certain cases. Those cases are not always where the developer demonstrates
// explicit intent to use fingerprint functionality. Thus, to avoiding throwing an
// unexpected SecurityException this method does not check whether its caller is
// permitted to use fingerprint API.
//
// The permission check should be restored once Android Keystore no longer invokes this
// method from inside app processes.
return FingerprintService.super.getAuthenticatorId(opPackageName);
}
@Override // Binder call
public void resetTimeout(byte [] token) {
checkPermission(RESET_FINGERPRINT_LOCKOUT);
// TODO: confirm security token when we move timeout management into the HAL layer.
mHandler.post(mResetFailedAttemptsForCurrentUserRunnable);
}
@Override
public boolean isClientActive() {
checkPermission(MANAGE_FINGERPRINT);
synchronized(FingerprintService.this) {
return (getCurrentClient() != null) || (getPendingClient() != null);
}
}
@Override
public void addClientActiveCallback(IFingerprintClientActiveCallback callback) {
checkPermission(MANAGE_FINGERPRINT);
mClientActiveCallbacks.add(callback);
}
@Override
public void removeClientActiveCallback(IFingerprintClientActiveCallback callback) {
checkPermission(MANAGE_FINGERPRINT);
mClientActiveCallbacks.remove(callback);
}
}
/**
* Receives callbacks from the ClientMonitor implementations. The results are forwarded to
* the FingerprintManager.
*/
private class ServiceListenerImpl implements ServiceListener {
private IFingerprintServiceReceiver mFingerprintServiceReceiver;
public ServiceListenerImpl(IFingerprintServiceReceiver receiver) {
mFingerprintServiceReceiver = receiver;
}
@Override
public void onEnrollResult(BiometricAuthenticator.Identifier identifier, int remaining)
throws RemoteException {
if (mFingerprintServiceReceiver != null) {
// TODO: Pass up the fp directly instead
final Fingerprint fp = (Fingerprint) identifier;
mFingerprintServiceReceiver.onEnrollResult(fp.getDeviceId(), fp.getBiometricId(),
fp.getGroupId(), remaining);
}
}
@Override
public void onAcquired(long deviceId, int acquiredInfo, int vendorCode)
throws RemoteException {
if (mFingerprintServiceReceiver != null) {
mFingerprintServiceReceiver.onAcquired(deviceId, acquiredInfo, vendorCode);
}
}
@Override
public void onAuthenticationSucceeded(long deviceId,
BiometricAuthenticator.Identifier biometric, int userId)
throws RemoteException {
if (mFingerprintServiceReceiver != null) {
if (biometric == null || biometric instanceof Fingerprint) {
mFingerprintServiceReceiver
.onAuthenticationSucceeded(deviceId, (Fingerprint) biometric, userId);
} else {
Slog.e(TAG, "onAuthenticationSucceeded received non-fingerprint biometric");
}
}
}
@Override
public void onAuthenticationFailed(long deviceId) throws RemoteException {
if (mFingerprintServiceReceiver != null) {
mFingerprintServiceReceiver.onAuthenticationFailed(deviceId);
}
}
@Override
public void onError(long deviceId, int error, int vendorCode) throws RemoteException {
if (mFingerprintServiceReceiver != null) {
mFingerprintServiceReceiver.onError(deviceId, error, vendorCode);
}
}
@Override
public void onRemoved(BiometricAuthenticator.Identifier identifier, int remaining)
throws RemoteException {
if (mFingerprintServiceReceiver != null) {
// TODO: Pass up the fp directly instead
final Fingerprint fp = (Fingerprint) identifier;
mFingerprintServiceReceiver.onRemoved(fp.getDeviceId(), fp.getBiometricId(),
fp.getGroupId(), remaining);
}
}
@Override
public void onEnumerated(BiometricAuthenticator.Identifier identifier, int remaining)
throws RemoteException {
if (mFingerprintServiceReceiver != null) {
final Fingerprint fp = (Fingerprint) identifier;
mFingerprintServiceReceiver.onEnumerated(fp.getDeviceId(), fp.getBiometricId(),
fp.getGroupId(), remaining);
}
}
}
/**
* An internal class to help clean up unknown fingerprints in the hardware and software.
*/
private final class InternalEnumerateClient extends BiometricService.EnumerateClientImpl {
private List<Fingerprint> mEnrolledList;
private List<Fingerprint> mUnknownFingerprints = new ArrayList<>(); // list of fp to delete
public InternalEnumerateClient(Context context, DaemonWrapper daemon, long halDeviceId,
IBinder token, ServiceListener listener, int groupId, int userId,
boolean restricted, String owner, List<Fingerprint> enrolledList) {
super(context, daemon, halDeviceId, token, listener, groupId, userId, restricted,
owner);
mEnrolledList = enrolledList;
}
private void handleEnumeratedFingerprint(
BiometricAuthenticator.Identifier identifier, int remaining) {
boolean matched = false;
for (int i = 0; i < mEnrolledList.size(); i++) {
if (mEnrolledList.get(i).getBiometricId() == identifier.getBiometricId()) {
mEnrolledList.remove(i);
matched = true;
break;
}
}
// fingerId 0 means no fingerprints are in hardware
if (!matched && identifier.getBiometricId() != 0) {
mUnknownFingerprints.add((Fingerprint) identifier);
}
}
private void doFingerprintCleanup() {
if (mEnrolledList == null) {
return;
}
for (Fingerprint f : mEnrolledList) {
Slog.e(TAG, "doFingerprintCleanup(): Removing dangling enrolled fingerprint: "
+ f.getName() + " " + f.getBiometricId() + " " + f.getGroupId()
+ " " + f.getDeviceId());
FingerprintUtils.getInstance().removeBiometricForUser(getContext(),
getTargetUserId(), f.getBiometricId());
}
mEnrolledList.clear();
}
public List<Fingerprint> getUnknownFingerprints() {
return mUnknownFingerprints;
}
@Override
public boolean onEnumerationResult(BiometricAuthenticator.Identifier identifier,
int remaining) {
handleEnumeratedFingerprint(identifier, remaining);
if (remaining == 0) {
doFingerprintCleanup();
}
return remaining == 0;
}
}
/**
* An internal class to help clean up unknown fingerprints in hardware and software.
*/
private final class InternalRemovalClient extends BiometricService.RemovalClientImpl {
public InternalRemovalClient(Context context,
DaemonWrapper daemon, long halDeviceId, IBinder token,
ServiceListener listener, int fingerId, int groupId, int userId, boolean restricted,
String owner) {
super(context, daemon, halDeviceId, token, listener, fingerId, groupId, userId,
restricted,
owner);
}
}
private final FingerprintMetrics mFingerprintMetrics = new FingerprintMetrics();
private final CopyOnWriteArrayList<IFingerprintClientActiveCallback> mClientActiveCallbacks =
new CopyOnWriteArrayList<>();
@GuardedBy("this")
private IBiometricsFingerprint mDaemon;
private long mHalDeviceId;
private IStatusBarService mStatusBarService;
private IBinder mToken = new Binder(); // used for internal FingerprintService enumeration
private ArrayList<UserFingerprint> mUnknownFingerprints = new ArrayList<>(); // hw fingerprints
/**
* Receives callbacks from the HAL.
*/
private IBiometricsFingerprintClientCallback mDaemonCallback =
new IBiometricsFingerprintClientCallback.Stub() {
@Override
public void onEnrollResult(final long deviceId, final int fingerId, final int groupId,
final int remaining) {
mHandler.post(() -> {
final Fingerprint fingerprint =
new Fingerprint(getBiometricUtils().getUniqueName(getContext(), groupId),
groupId, fingerId, deviceId);
FingerprintService.super.handleEnrollResult(fingerprint, remaining);
});
}
@Override
public void onAcquired(final long deviceId, final int acquiredInfo, final int vendorCode) {
mHandler.post(() -> {
FingerprintService.super.handleAcquired(deviceId, acquiredInfo, vendorCode);
});
}
@Override
public void onAuthenticated(final long deviceId, final int fingerId, final int groupId,
ArrayList<Byte> token) {
mHandler.post(() -> {
Fingerprint fp = new Fingerprint("", groupId, fingerId, deviceId);
FingerprintService.super.handleAuthenticated(fp, token);
});
}
@Override
public void onError(final long deviceId, final int error, final int vendorCode) {
mHandler.post(() -> {
ClientMonitor client = getCurrentClient();
if (client instanceof InternalRemovalClient
|| client instanceof InternalEnumerateClient) {
clearEnumerateState();
}
FingerprintService.super.handleError(deviceId, error, vendorCode);
// TODO: this chunk of code should be common to all biometric services
if (error == BiometricConstants.BIOMETRIC_ERROR_HW_UNAVAILABLE) {
// If we get HW_UNAVAILABLE, try to connect again later...
Slog.w(TAG, "Got ERROR_HW_UNAVAILABLE; try reconnecting next client.");
synchronized (this) {
mDaemon = null;
mHalDeviceId = 0;
mCurrentUserId = UserHandle.USER_NULL;
}
}
});
}
@Override
public void onRemoved(final long deviceId, final int fingerId, final int groupId,
final int remaining) {
mHandler.post(() -> {
ClientMonitor client = getCurrentClient();
final Fingerprint fp = new Fingerprint("", groupId, fingerId, deviceId);
FingerprintService.super.handleRemoved(fp, remaining);
if (client instanceof InternalRemovalClient && !mUnknownFingerprints.isEmpty()) {
cleanupUnknownFingerprints();
} else if (client instanceof InternalRemovalClient){
clearEnumerateState();
}
});
}
@Override
public void onEnumerate(final long deviceId, final int fingerId, final int groupId,
final int remaining) {
mHandler.post(() -> {
// TODO: factor out common enumerate logic if possible
final Fingerprint fp = new Fingerprint("", groupId, fingerId, deviceId);
FingerprintService.this.handleEnumerate(fp, remaining);
});
}
};
/**
* Wraps the HAL-specific code and is passed to the ClientMonitor implementations so that they
* can be shared between the multiple biometric services.
*/
private final DaemonWrapper mDaemonWrapper = new DaemonWrapper() {
@Override
public int authenticate(long operationId, int groupId) throws RemoteException {
IBiometricsFingerprint daemon = getFingerprintDaemon();
if (daemon == null) {
Slog.w(TAG, "authenticate(): no fingerprint HAL!");
return ERROR_ESRCH;
}
return daemon.authenticate(operationId, groupId);
}
@Override
public int cancel() throws RemoteException {
IBiometricsFingerprint daemon = getFingerprintDaemon();
if (daemon == null) {
Slog.w(TAG, "cancel(): no fingerprint HAL!");
return ERROR_ESRCH;
}
return daemon.cancel();
}
@Override
public int remove(int groupId, int biometricId) throws RemoteException {
IBiometricsFingerprint daemon = getFingerprintDaemon();
if (daemon == null) {
Slog.w(TAG, "remove(): no fingerprint HAL!");
return ERROR_ESRCH;
}
return daemon.remove(groupId, biometricId);
}
@Override
public int enumerate() throws RemoteException {
IBiometricsFingerprint daemon = getFingerprintDaemon();
if (daemon == null) {
Slog.w(TAG, "enumerate(): no fingerprint HAL!");
return ERROR_ESRCH;
}
return daemon.enumerate();
}
@Override
public int enroll(byte[] cryptoToken, int groupId, int timeout) throws RemoteException {
IBiometricsFingerprint daemon = getFingerprintDaemon();
if (daemon == null) {
Slog.w(TAG, "enroll(): no fingerprint HAL!");
return ERROR_ESRCH;
}
return daemon.enroll(cryptoToken, groupId, timeout);
}
};
public FingerprintService(Context context) {
super(context);
// TODO: can this be retrieved from AuthenticationClient, or BiometricService?
mStatusBarService = IStatusBarService.Stub.asInterface(
ServiceManager.getService(Context.STATUS_BAR_SERVICE));
}
@Override
public void onStart() {
super.onStart();
publishBinderService(Context.FINGERPRINT_SERVICE, new FingerprintServiceWrapper());
SystemServerInitThreadPool.get().submit(this::getFingerprintDaemon, TAG + ".onStart");
}
@Override
protected String getTag() {
return TAG;
}
@Override
protected BiometricUtils getBiometricUtils() {
return FingerprintUtils.getInstance();
}
@Override
protected int getFailedAttemptsLockoutTimed() {
return MAX_FAILED_ATTEMPTS_LOCKOUT_TIMED;
}
@Override
protected int getFailedAttemptsLockoutPermanent() {
return MAX_FAILED_ATTEMPTS_LOCKOUT_PERMANENT;
}
@Override
protected Metrics getMetrics() {
return mFingerprintMetrics;
}
@Override
protected boolean hasReachedEnrollmentLimit(int userId) {
final int limit = getContext().getResources().getInteger(
com.android.internal.R.integer.config_fingerprintMaxTemplatesPerUser);
final int enrolled = FingerprintService.this.getEnrolledFingerprints(userId).size();
if (enrolled >= limit) {
Slog.w(TAG, "Too many fingerprints registered");
return true;
}
return false;
}
@Override
protected void updateActiveGroup(int userId, String clientPackage) {
IBiometricsFingerprint daemon = getFingerprintDaemon();
if (daemon != null) {
try {
userId = getUserOrWorkProfileId(clientPackage, userId);
if (userId != mCurrentUserId) {
int firstSdkInt = Build.VERSION.FIRST_SDK_INT;
if (firstSdkInt < Build.VERSION_CODES.BASE) {
Slog.e(TAG, "First SDK version " + firstSdkInt + " is invalid; must be " +
"at least VERSION_CODES.BASE");
}
File baseDir;
if (firstSdkInt <= Build.VERSION_CODES.O_MR1) {
baseDir = Environment.getUserSystemDirectory(userId);
} else {
baseDir = Environment.getDataVendorDeDirectory(userId);
}
File fpDir = new File(baseDir, FP_DATA_DIR);
if (!fpDir.exists()) {
if (!fpDir.mkdir()) {
Slog.v(TAG, "Cannot make directory: " + fpDir.getAbsolutePath());
return;
}
// Calling mkdir() from this process will create a directory with our
// permissions (inherited from the containing dir). This command fixes
// the label.
if (!SELinux.restorecon(fpDir)) {
Slog.w(TAG, "Restorecons failed. Directory will have wrong label.");
return;
}
}
daemon.setActiveGroup(userId, fpDir.getAbsolutePath());
mCurrentUserId = userId;
}
mAuthenticatorIds.put(userId,
hasEnrolledBiometrics(userId) ? daemon.getAuthenticatorId() : 0L);
} catch (RemoteException e) {
Slog.e(TAG, "Failed to setActiveGroup():", e);
}
}
}
@Override
protected String getLockoutResetIntent() {
return ACTION_LOCKOUT_RESET;
}
@Override
protected String getLockoutBroadcastPermission() {
return RESET_FINGERPRINT_LOCKOUT;
}
@Override
protected long getHalDeviceId() {
return mHalDeviceId;
}
@Override
protected void handleUserSwitching(int userId) {
if (getCurrentClient() instanceof InternalRemovalClient
|| getCurrentClient() instanceof InternalEnumerateClient) {
Slog.w(TAG, "User switched while performing cleanup");
removeClient(getCurrentClient());
clearEnumerateState();
}
updateActiveGroup(userId, null);
doFingerprintCleanupForUser(userId);
}
@Override
protected boolean hasEnrolledBiometrics(int userId) {
if (userId != UserHandle.getCallingUserId()) {
checkPermission(INTERACT_ACROSS_USERS);
}
return getBiometricUtils().getBiometricsForUser(getContext(), userId).size() > 0;
}
@Override
protected String getManageBiometricPermission() {
return MANAGE_FINGERPRINT;
}
@Override
protected void checkUseBiometricPermission() {
if (getContext().checkCallingPermission(USE_FINGERPRINT)
!= PackageManager.PERMISSION_GRANTED) {
checkPermission(USE_BIOMETRIC);
}
}
@Override
protected int getAppOp() {
return AppOpsManager.OP_USE_FINGERPRINT;
}
@Override
protected void notifyClientActiveCallbacks(boolean isActive) {
List<IFingerprintClientActiveCallback> callbacks = mClientActiveCallbacks;
for (int i = 0; i < callbacks.size(); i++) {
try {
callbacks.get(i).onClientActiveChanged(isActive);
} catch (RemoteException re) {
// If the remote is dead, stop notifying it
mClientActiveCallbacks.remove(callbacks.get(i));
}
}
}
/** Gets the fingerprint daemon */
private synchronized IBiometricsFingerprint getFingerprintDaemon() {
if (mDaemon == null) {
Slog.v(TAG, "mDaemon was null, reconnect to fingerprint");
try {
mDaemon = IBiometricsFingerprint.getService();
} catch (java.util.NoSuchElementException e) {
// Service doesn't exist or cannot be opened. Logged below.
} catch (RemoteException e) {
Slog.e(TAG, "Failed to get biometric interface", e);
}
if (mDaemon == null) {
Slog.w(TAG, "fingerprint HIDL not available");
return null;
}
mDaemon.asBinder().linkToDeath(this, 0);
try {
mHalDeviceId = mDaemon.setNotify(mDaemonCallback);
} catch (RemoteException e) {
Slog.e(TAG, "Failed to open fingerprint HAL", e);
mDaemon = null; // try again later!
}
if (DEBUG) Slog.v(TAG, "Fingerprint HAL id: " + mHalDeviceId);
if (mHalDeviceId != 0) {
loadAuthenticatorIds();
updateActiveGroup(ActivityManager.getCurrentUser(), null);
doFingerprintCleanupForUser(ActivityManager.getCurrentUser());
} else {
Slog.w(TAG, "Failed to open Fingerprint HAL!");
MetricsLogger.count(getContext(), "fingerprintd_openhal_error", 1);
mDaemon = null;
}
}
return mDaemon;
}
/**
* This method should be called upon connection to the daemon, and when user switches.
* @param userId
*/
private void doFingerprintCleanupForUser(int userId) {
if (CLEANUP_UNUSED_FP) {
enumerateUser(userId);
}
}
private void clearEnumerateState() {
if (DEBUG) Slog.v(TAG, "clearEnumerateState()");
mUnknownFingerprints.clear();
}
private void enumerateUser(int userId) {
if (DEBUG) Slog.v(TAG, "Enumerating user(" + userId + ")");
final boolean restricted = !hasPermission(MANAGE_FINGERPRINT);
final List<Fingerprint> enrolledList = getEnrolledFingerprints(userId);
InternalEnumerateClient client = new InternalEnumerateClient(getContext(), mDaemonWrapper,
mHalDeviceId, mToken, new ServiceListenerImpl(null), userId, userId, restricted,
getContext().getOpPackageName(), enrolledList);
enumerateInternal(client);
}
// Remove unknown fingerprints from hardware
private void cleanupUnknownFingerprints() {
if (!mUnknownFingerprints.isEmpty()) {
UserFingerprint uf = mUnknownFingerprints.get(0);
mUnknownFingerprints.remove(uf);
boolean restricted = !hasPermission(MANAGE_FINGERPRINT);
InternalRemovalClient client = new InternalRemovalClient(getContext(), mDaemonWrapper,
mHalDeviceId, mToken, new ServiceListenerImpl(null), uf.f.getBiometricId(),
uf.f.getGroupId(), uf.userId, restricted, getContext().getOpPackageName());
removeInternal(client);
} else {
clearEnumerateState();
}
}
private void handleEnumerate(Fingerprint fingerprint, int remaining) {
ClientMonitor client = getCurrentClient();
if ( !(client instanceof InternalRemovalClient) && !(client instanceof EnumerateClient) ) {
return;
}
client.onEnumerationResult(fingerprint, remaining);
// All fingerprints in hardware for this user were enumerated
if (remaining == 0) {
if (client instanceof InternalEnumerateClient) {
List<Fingerprint> unknownFingerprints =
((InternalEnumerateClient) client).getUnknownFingerprints();
if (!unknownFingerprints.isEmpty()) {
Slog.w(TAG, "Adding " + unknownFingerprints.size() +
" fingerprints for deletion");
}
for (Fingerprint f : unknownFingerprints) {
mUnknownFingerprints.add(new UserFingerprint(f, client.getTargetUserId()));
}
removeClient(client);
cleanupUnknownFingerprints();
} else {
removeClient(client);
}
}
}
private long startPreEnroll(IBinder token) {
IBiometricsFingerprint daemon = getFingerprintDaemon();
if (daemon == null) {
Slog.w(TAG, "startPreEnroll: no fingerprint HAL!");
return 0;
}
try {
return daemon.preEnroll();
} catch (RemoteException e) {
Slog.e(TAG, "startPreEnroll failed", e);
}
return 0;
}
private int startPostEnroll(IBinder token) {
IBiometricsFingerprint daemon = getFingerprintDaemon();
if (daemon == null) {
Slog.w(TAG, "startPostEnroll: no fingerprint HAL!");
return 0;
}
try {
return daemon.postEnroll();
} catch (RemoteException e) {
Slog.e(TAG, "startPostEnroll failed", e);
}
return 0;
}
private List<Fingerprint> getEnrolledFingerprints(int userId) {
return getBiometricUtils().getBiometricsForUser(getContext(), userId);
}
private void dumpInternal(PrintWriter pw) {
JSONObject dump = new JSONObject();
try {
dump.put("service", "Fingerprint Manager");
JSONArray sets = new JSONArray();
for (UserInfo user : UserManager.get(getContext()).getUsers()) {
final int userId = user.getUserHandle().getIdentifier();
final int N = getBiometricUtils().getBiometricsForUser(getContext(), userId).size();
PerformanceStats stats = mPerformanceMap.get(userId);
PerformanceStats cryptoStats = mCryptoPerformanceMap.get(userId);
JSONObject set = new JSONObject();
set.put("id", userId);
set.put("count", N);
set.put("accept", (stats != null) ? stats.accept : 0);
set.put("reject", (stats != null) ? stats.reject : 0);
set.put("acquire", (stats != null) ? stats.acquire : 0);
set.put("lockout", (stats != null) ? stats.lockout : 0);
set.put("permanentLockout", (stats != null) ? stats.permanentLockout : 0);
// cryptoStats measures statistics about secure fingerprint transactions
// (e.g. to unlock password storage, make secure purchases, etc.)
set.put("acceptCrypto", (cryptoStats != null) ? cryptoStats.accept : 0);
set.put("rejectCrypto", (cryptoStats != null) ? cryptoStats.reject : 0);
set.put("acquireCrypto", (cryptoStats != null) ? cryptoStats.acquire : 0);
set.put("lockoutCrypto", (cryptoStats != null) ? cryptoStats.lockout : 0);
set.put("permanentLockoutCrypto",
(cryptoStats != null) ? cryptoStats.permanentLockout : 0);
sets.put(set);
}
dump.put("prints", sets);
} catch (JSONException e) {
Slog.e(TAG, "dump formatting failure", e);
}
pw.println(dump);
}
private void dumpProto(FileDescriptor fd) {
final ProtoOutputStream proto = new ProtoOutputStream(fd);
for (UserInfo user : UserManager.get(getContext()).getUsers()) {
final int userId = user.getUserHandle().getIdentifier();
final long userToken = proto.start(FingerprintServiceDumpProto.USERS);
proto.write(FingerprintUserStatsProto.USER_ID, userId);
proto.write(FingerprintUserStatsProto.NUM_FINGERPRINTS,
getBiometricUtils().getBiometricsForUser(getContext(), userId).size());
// Normal fingerprint authentications (e.g. lockscreen)
final PerformanceStats normal = mPerformanceMap.get(userId);
if (normal != null) {
final long countsToken = proto.start(FingerprintUserStatsProto.NORMAL);
proto.write(PerformanceStatsProto.ACCEPT, normal.accept);
proto.write(PerformanceStatsProto.REJECT, normal.reject);
proto.write(PerformanceStatsProto.ACQUIRE, normal.acquire);
proto.write(PerformanceStatsProto.LOCKOUT, normal.lockout);
proto.write(PerformanceStatsProto.PERMANENT_LOCKOUT, normal.permanentLockout);
proto.end(countsToken);
}
// Statistics about secure fingerprint transactions (e.g. to unlock password
// storage, make secure purchases, etc.)
final PerformanceStats crypto = mCryptoPerformanceMap.get(userId);
if (crypto != null) {
final long countsToken = proto.start(FingerprintUserStatsProto.CRYPTO);
proto.write(PerformanceStatsProto.ACCEPT, crypto.accept);
proto.write(PerformanceStatsProto.REJECT, crypto.reject);
proto.write(PerformanceStatsProto.ACQUIRE, crypto.acquire);
proto.write(PerformanceStatsProto.LOCKOUT, crypto.lockout);
proto.write(PerformanceStatsProto.PERMANENT_LOCKOUT, crypto.permanentLockout);
proto.end(countsToken);
}
proto.end(userToken);
}
proto.flush();
mPerformanceMap.clear();
mCryptoPerformanceMap.clear();
}
}