Jim Miller | cb2ce6f | 2016-04-13 20:28:18 -0700 | [diff] [blame] | 1 | /** |
| 2 | * Copyright (C) 2016 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package com.android.server.fingerprint; |
| 18 | |
| 19 | import android.content.Context; |
Jim Miller | 40e4645 | 2016-12-16 18:38:53 -0800 | [diff] [blame] | 20 | import android.hardware.biometrics.fingerprint.V2_1.IBiometricsFingerprint; |
Jim Miller | cb2ce6f | 2016-04-13 20:28:18 -0700 | [diff] [blame] | 21 | import android.hardware.fingerprint.FingerprintManager; |
Jim Miller | cb2ce6f | 2016-04-13 20:28:18 -0700 | [diff] [blame] | 22 | import android.hardware.fingerprint.IFingerprintServiceReceiver; |
| 23 | import android.os.IBinder; |
| 24 | import android.os.RemoteException; |
| 25 | import android.util.Slog; |
| 26 | |
| 27 | import com.android.internal.logging.MetricsLogger; |
Tamas Berghammer | 383db5eb | 2016-06-22 15:21:38 +0100 | [diff] [blame] | 28 | import com.android.internal.logging.nano.MetricsProto.MetricsEvent; |
Jim Miller | cb2ce6f | 2016-04-13 20:28:18 -0700 | [diff] [blame] | 29 | |
| 30 | import java.util.Arrays; |
| 31 | |
| 32 | /** |
| 33 | * A class to keep track of the enrollment state for a given client. |
| 34 | */ |
| 35 | public abstract class EnrollClient extends ClientMonitor { |
| 36 | private static final long MS_PER_SEC = 1000; |
| 37 | private static final int ENROLLMENT_TIMEOUT_MS = 60 * 1000; // 1 minute |
| 38 | private byte[] mCryptoToken; |
| 39 | |
| 40 | public EnrollClient(Context context, long halDeviceId, IBinder token, |
| 41 | IFingerprintServiceReceiver receiver, int userId, int groupId, byte [] cryptoToken, |
| 42 | boolean restricted, String owner) { |
| 43 | super(context, halDeviceId, token, receiver, userId, groupId, restricted, owner); |
| 44 | mCryptoToken = Arrays.copyOf(cryptoToken, cryptoToken.length); |
| 45 | } |
| 46 | |
| 47 | @Override |
| 48 | public boolean onEnrollResult(int fingerId, int groupId, int remaining) { |
Tony Mak | ff715ac | 2016-04-19 20:44:12 +0100 | [diff] [blame] | 49 | if (groupId != getGroupId()) { |
| 50 | Slog.w(TAG, "groupId != getGroupId(), groupId: " + groupId + |
| 51 | " getGroupId():" + getGroupId()); |
| 52 | } |
Jim Miller | cb2ce6f | 2016-04-13 20:28:18 -0700 | [diff] [blame] | 53 | if (remaining == 0) { |
Jim Miller | c12eca8 | 2016-04-28 15:12:53 -0700 | [diff] [blame] | 54 | FingerprintUtils.getInstance().addFingerprintForUser(getContext(), fingerId, |
| 55 | getTargetUserId()); |
Jim Miller | cb2ce6f | 2016-04-13 20:28:18 -0700 | [diff] [blame] | 56 | } |
| 57 | return sendEnrollResult(fingerId, groupId, remaining); |
| 58 | } |
| 59 | |
| 60 | /* |
| 61 | * @return true if we're done. |
| 62 | */ |
| 63 | private boolean sendEnrollResult(int fpId, int groupId, int remaining) { |
| 64 | IFingerprintServiceReceiver receiver = getReceiver(); |
| 65 | if (receiver == null) |
| 66 | return true; // client not listening |
| 67 | |
Michael Wright | 6726fd5 | 2017-06-27 00:41:45 +0100 | [diff] [blame] | 68 | vibrateSuccess(); |
Jim Miller | cb2ce6f | 2016-04-13 20:28:18 -0700 | [diff] [blame] | 69 | MetricsLogger.action(getContext(), MetricsEvent.ACTION_FINGERPRINT_ENROLL); |
| 70 | try { |
| 71 | receiver.onEnrollResult(getHalDeviceId(), fpId, groupId, remaining); |
| 72 | return remaining == 0; |
| 73 | } catch (RemoteException e) { |
| 74 | Slog.w(TAG, "Failed to notify EnrollResult:", e); |
| 75 | return true; |
| 76 | } |
| 77 | } |
| 78 | |
| 79 | @Override |
| 80 | public int start() { |
Jim Miller | 40e4645 | 2016-12-16 18:38:53 -0800 | [diff] [blame] | 81 | IBiometricsFingerprint daemon = getFingerprintDaemon(); |
Jim Miller | cb2ce6f | 2016-04-13 20:28:18 -0700 | [diff] [blame] | 82 | if (daemon == null) { |
Kevin Chyn | 80e40cc | 2017-03-14 12:31:17 -0700 | [diff] [blame] | 83 | Slog.w(TAG, "enroll: no fingerprint HAL!"); |
Jim Miller | cb2ce6f | 2016-04-13 20:28:18 -0700 | [diff] [blame] | 84 | return ERROR_ESRCH; |
| 85 | } |
| 86 | final int timeout = (int) (ENROLLMENT_TIMEOUT_MS / MS_PER_SEC); |
| 87 | try { |
| 88 | final int result = daemon.enroll(mCryptoToken, getGroupId(), timeout); |
| 89 | if (result != 0) { |
| 90 | Slog.w(TAG, "startEnroll failed, result=" + result); |
Jim Miller | c57c8d9 | 2016-09-30 17:17:59 -0700 | [diff] [blame] | 91 | MetricsLogger.histogram(getContext(), "fingerprintd_enroll_start_error", result); |
Jim Miller | 40e4645 | 2016-12-16 18:38:53 -0800 | [diff] [blame] | 92 | onError(FingerprintManager.FINGERPRINT_ERROR_HW_UNAVAILABLE, 0 /* vendorCode */); |
Jim Miller | cb2ce6f | 2016-04-13 20:28:18 -0700 | [diff] [blame] | 93 | return result; |
| 94 | } |
| 95 | } catch (RemoteException e) { |
| 96 | Slog.e(TAG, "startEnroll failed", e); |
| 97 | } |
| 98 | return 0; // success |
| 99 | } |
| 100 | |
| 101 | @Override |
| 102 | public int stop(boolean initiatedByClient) { |
Kevin Chyn | 3736858 | 2017-05-19 17:15:38 -0700 | [diff] [blame] | 103 | if (mAlreadyCancelled) { |
| 104 | Slog.w(TAG, "stopEnroll: already cancelled!"); |
| 105 | return 0; |
| 106 | } |
Jim Miller | 40e4645 | 2016-12-16 18:38:53 -0800 | [diff] [blame] | 107 | IBiometricsFingerprint daemon = getFingerprintDaemon(); |
Jim Miller | cb2ce6f | 2016-04-13 20:28:18 -0700 | [diff] [blame] | 108 | if (daemon == null) { |
Kevin Chyn | 80e40cc | 2017-03-14 12:31:17 -0700 | [diff] [blame] | 109 | Slog.w(TAG, "stopEnrollment: no fingerprint HAL!"); |
Jim Miller | cb2ce6f | 2016-04-13 20:28:18 -0700 | [diff] [blame] | 110 | return ERROR_ESRCH; |
| 111 | } |
| 112 | try { |
Jim Miller | 40e4645 | 2016-12-16 18:38:53 -0800 | [diff] [blame] | 113 | final int result = daemon.cancel(); |
Jim Miller | cb2ce6f | 2016-04-13 20:28:18 -0700 | [diff] [blame] | 114 | if (result != 0) { |
| 115 | Slog.w(TAG, "startEnrollCancel failed, result = " + result); |
| 116 | return result; |
| 117 | } |
| 118 | } catch (RemoteException e) { |
| 119 | Slog.e(TAG, "stopEnrollment failed", e); |
| 120 | } |
| 121 | if (initiatedByClient) { |
Jim Miller | 40e4645 | 2016-12-16 18:38:53 -0800 | [diff] [blame] | 122 | onError(FingerprintManager.FINGERPRINT_ERROR_CANCELED, 0 /* vendorCode */); |
Jim Miller | cb2ce6f | 2016-04-13 20:28:18 -0700 | [diff] [blame] | 123 | } |
Kevin Chyn | 3736858 | 2017-05-19 17:15:38 -0700 | [diff] [blame] | 124 | mAlreadyCancelled = true; |
Jim Miller | cb2ce6f | 2016-04-13 20:28:18 -0700 | [diff] [blame] | 125 | return 0; |
| 126 | } |
| 127 | |
| 128 | @Override |
Jim Miller | 40e4645 | 2016-12-16 18:38:53 -0800 | [diff] [blame] | 129 | public boolean onRemoved(int fingerId, int groupId, int remaining) { |
Jim Miller | cb2ce6f | 2016-04-13 20:28:18 -0700 | [diff] [blame] | 130 | if (DEBUG) Slog.w(TAG, "onRemoved() called for enroll!"); |
| 131 | return true; // Invalid for EnrollClient |
| 132 | } |
| 133 | |
| 134 | @Override |
Jim Miller | 40e4645 | 2016-12-16 18:38:53 -0800 | [diff] [blame] | 135 | public boolean onEnumerationResult(int fingerId, int groupId, int remaining) { |
Jim Miller | cb2ce6f | 2016-04-13 20:28:18 -0700 | [diff] [blame] | 136 | if (DEBUG) Slog.w(TAG, "onEnumerationResult() called for enroll!"); |
| 137 | return true; // Invalid for EnrollClient |
| 138 | } |
| 139 | |
| 140 | @Override |
| 141 | public boolean onAuthenticated(int fingerId, int groupId) { |
| 142 | if (DEBUG) Slog.w(TAG, "onAuthenticated() called for enroll!"); |
| 143 | return true; // Invalid for EnrollClient |
| 144 | } |
| 145 | |
| 146 | } |