Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 1 | /** |
| 2 | * Copyright (C) 2014 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 | |
Jim Miller | ebbf205 | 2015-03-31 17:24:34 -0700 | [diff] [blame] | 17 | package android.hardware.fingerprint; |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 18 | |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 19 | import android.annotation.NonNull; |
| 20 | import android.annotation.Nullable; |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 21 | import android.annotation.RequiresPermission; |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 22 | import android.app.ActivityManagerNative; |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 23 | import android.content.Context; |
Jim Miller | a7596147 | 2014-06-06 15:00:49 -0700 | [diff] [blame] | 24 | import android.os.Binder; |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 25 | import android.os.CancellationSignal; |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 26 | import android.os.CancellationSignal.OnCancelListener; |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 27 | import android.os.Handler; |
| 28 | import android.os.IBinder; |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 29 | import android.os.Looper; |
Jorim Jaggi | 5e35422 | 2015-09-04 14:17:58 -0700 | [diff] [blame] | 30 | import android.os.PowerManager; |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 31 | import android.os.RemoteException; |
| 32 | import android.os.UserHandle; |
Alex Klyubin | dcdaf87 | 2015-05-13 15:57:09 -0700 | [diff] [blame] | 33 | import android.security.keystore.AndroidKeyStoreProvider; |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 34 | import android.util.Log; |
Jim Miller | a7596147 | 2014-06-06 15:00:49 -0700 | [diff] [blame] | 35 | import android.util.Slog; |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 36 | |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 37 | import java.security.Signature; |
Jim Miller | ba67aee | 2015-02-20 16:21:26 -0800 | [diff] [blame] | 38 | import java.util.List; |
| 39 | |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 40 | import javax.crypto.Cipher; |
Jim Miller | b62dc82 | 2015-04-28 20:05:53 -0700 | [diff] [blame] | 41 | import javax.crypto.Mac; |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 42 | |
Clara Bayarri | 33fd3cf | 2016-02-19 16:54:49 +0000 | [diff] [blame] | 43 | import static android.Manifest.permission.INTERACT_ACROSS_USERS; |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 44 | import static android.Manifest.permission.USE_FINGERPRINT; |
| 45 | import static android.Manifest.permission.MANAGE_FINGERPRINT; |
| 46 | |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 47 | /** |
| 48 | * A class that coordinates access to the fingerprint hardware. |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 49 | * <p> |
| 50 | * Use {@link android.content.Context#getSystemService(java.lang.String)} |
| 51 | * with argument {@link android.content.Context#FINGERPRINT_SERVICE} to get |
| 52 | * an instance of this class. |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 53 | */ |
| 54 | |
| 55 | public class FingerprintManager { |
| 56 | private static final String TAG = "FingerprintManager"; |
Jim Miller | d08c2ac | 2014-05-14 16:30:38 -0700 | [diff] [blame] | 57 | private static final boolean DEBUG = true; |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 58 | private static final int MSG_ENROLL_RESULT = 100; |
Jim Miller | a7596147 | 2014-06-06 15:00:49 -0700 | [diff] [blame] | 59 | private static final int MSG_ACQUIRED = 101; |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 60 | private static final int MSG_AUTHENTICATION_SUCCEEDED = 102; |
| 61 | private static final int MSG_AUTHENTICATION_FAILED = 103; |
| 62 | private static final int MSG_ERROR = 104; |
| 63 | private static final int MSG_REMOVED = 105; |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 64 | |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 65 | // |
| 66 | // Error messages from fingerprint hardware during initilization, enrollment, authentication or |
| 67 | // removal. Must agree with the list in fingerprint.h |
| 68 | // |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 69 | |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 70 | /** |
| 71 | * The hardware is unavailable. Try again later. |
| 72 | */ |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 73 | public static final int FINGERPRINT_ERROR_HW_UNAVAILABLE = 1; |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 74 | |
| 75 | /** |
| 76 | * Error state returned when the sensor was unable to process the current image. |
| 77 | */ |
Jim Miller | a7596147 | 2014-06-06 15:00:49 -0700 | [diff] [blame] | 78 | public static final int FINGERPRINT_ERROR_UNABLE_TO_PROCESS = 2; |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 79 | |
| 80 | /** |
| 81 | * Error state returned when the current request has been running too long. This is intended to |
| 82 | * prevent programs from waiting for the fingerprint sensor indefinitely. The timeout is |
| 83 | * platform and sensor-specific, but is generally on the order of 30 seconds. |
| 84 | */ |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 85 | public static final int FINGERPRINT_ERROR_TIMEOUT = 3; |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 86 | |
| 87 | /** |
| 88 | * Error state returned for operations like enrollment; the operation cannot be completed |
| 89 | * because there's not enough storage remaining to complete the operation. |
| 90 | */ |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 91 | public static final int FINGERPRINT_ERROR_NO_SPACE = 4; |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 92 | |
| 93 | /** |
| 94 | * The operation was canceled because the fingerprint sensor is unavailable. For example, |
| 95 | * this may happen when the user is switched, the device is locked or another pending operation |
| 96 | * prevents or disables it. |
| 97 | */ |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 98 | public static final int FINGERPRINT_ERROR_CANCELED = 5; |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 99 | |
| 100 | /** |
| 101 | * The {@link FingerprintManager#remove(Fingerprint, RemovalCallback)} call failed. Typically |
| 102 | * this will happen when the provided fingerprint id was incorrect. |
| 103 | * |
| 104 | * @hide |
| 105 | */ |
| 106 | public static final int FINGERPRINT_ERROR_UNABLE_TO_REMOVE = 6; |
| 107 | |
Jim Miller | fe6439f | 2015-04-11 18:07:57 -0700 | [diff] [blame] | 108 | /** |
| 109 | * The operation was canceled because the API is locked out due to too many attempts. |
| 110 | */ |
| 111 | public static final int FINGERPRINT_ERROR_LOCKOUT = 7; |
| 112 | |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 113 | /** |
| 114 | * Hardware vendors may extend this list if there are conditions that do not fall under one of |
| 115 | * the above categories. Vendors are responsible for providing error strings for these errors. |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 116 | * @hide |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 117 | */ |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 118 | public static final int FINGERPRINT_ERROR_VENDOR_BASE = 1000; |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 119 | |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 120 | // |
| 121 | // Image acquisition messages. Must agree with those in fingerprint.h |
| 122 | // |
| 123 | |
| 124 | /** |
| 125 | * The image acquired was good. |
| 126 | */ |
Jim Miller | a7596147 | 2014-06-06 15:00:49 -0700 | [diff] [blame] | 127 | public static final int FINGERPRINT_ACQUIRED_GOOD = 0; |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 128 | |
| 129 | /** |
| 130 | * Only a partial fingerprint image was detected. During enrollment, the user should be |
| 131 | * informed on what needs to happen to resolve this problem, e.g. "press firmly on sensor." |
| 132 | */ |
Jim Miller | a7596147 | 2014-06-06 15:00:49 -0700 | [diff] [blame] | 133 | public static final int FINGERPRINT_ACQUIRED_PARTIAL = 1; |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 134 | |
| 135 | /** |
| 136 | * The fingerprint image was too noisy to process due to a detected condition (i.e. dry skin) or |
| 137 | * a possibly dirty sensor (See {@link #FINGERPRINT_ACQUIRED_IMAGER_DIRTY}). |
| 138 | */ |
Jim Miller | a7596147 | 2014-06-06 15:00:49 -0700 | [diff] [blame] | 139 | public static final int FINGERPRINT_ACQUIRED_INSUFFICIENT = 2; |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 140 | |
| 141 | /** |
| 142 | * The fingerprint image was too noisy due to suspected or detected dirt on the sensor. |
| 143 | * For example, it's reasonable return this after multiple |
| 144 | * {@link #FINGERPRINT_ACQUIRED_INSUFFICIENT} or actual detection of dirt on the sensor |
| 145 | * (stuck pixels, swaths, etc.). The user is expected to take action to clean the sensor |
| 146 | * when this is returned. |
| 147 | */ |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 148 | public static final int FINGERPRINT_ACQUIRED_IMAGER_DIRTY = 3; |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 149 | |
| 150 | /** |
| 151 | * The fingerprint image was unreadable due to lack of motion. This is most appropriate for |
| 152 | * linear array sensors that require a swipe motion. |
| 153 | */ |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 154 | public static final int FINGERPRINT_ACQUIRED_TOO_SLOW = 4; |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 155 | |
| 156 | /** |
| 157 | * The fingerprint image was incomplete due to quick motion. While mostly appropriate for |
| 158 | * linear array sensors, this could also happen if the finger was moved during acquisition. |
| 159 | * The user should be asked to move the finger slower (linear) or leave the finger on the sensor |
| 160 | * longer. |
| 161 | */ |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 162 | public static final int FINGERPRINT_ACQUIRED_TOO_FAST = 5; |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 163 | |
| 164 | /** |
| 165 | * Hardware vendors may extend this list if there are conditions that do not fall under one of |
| 166 | * the above categories. Vendors are responsible for providing error strings for these errors. |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 167 | * @hide |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 168 | */ |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 169 | public static final int FINGERPRINT_ACQUIRED_VENDOR_BASE = 1000; |
Jim Miller | a7596147 | 2014-06-06 15:00:49 -0700 | [diff] [blame] | 170 | |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 171 | private IFingerprintService mService; |
Jim Miller | d08c2ac | 2014-05-14 16:30:38 -0700 | [diff] [blame] | 172 | private Context mContext; |
Jim Miller | a7596147 | 2014-06-06 15:00:49 -0700 | [diff] [blame] | 173 | private IBinder mToken = new Binder(); |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 174 | private AuthenticationCallback mAuthenticationCallback; |
| 175 | private EnrollmentCallback mEnrollmentCallback; |
| 176 | private RemovalCallback mRemovalCallback; |
| 177 | private CryptoObject mCryptoObject; |
| 178 | private Fingerprint mRemovalFingerprint; |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 179 | private Handler mHandler; |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 180 | |
| 181 | private class OnEnrollCancelListener implements OnCancelListener { |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 182 | @Override |
| 183 | public void onCancel() { |
Jim Miller | fe6439f | 2015-04-11 18:07:57 -0700 | [diff] [blame] | 184 | cancelEnrollment(); |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 185 | } |
| 186 | } |
| 187 | |
| 188 | private class OnAuthenticationCancelListener implements OnCancelListener { |
| 189 | private CryptoObject mCrypto; |
| 190 | |
| 191 | public OnAuthenticationCancelListener(CryptoObject crypto) { |
| 192 | mCrypto = crypto; |
| 193 | } |
| 194 | |
| 195 | @Override |
| 196 | public void onCancel() { |
| 197 | cancelAuthentication(mCrypto); |
| 198 | } |
| 199 | } |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 200 | |
| 201 | /** |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 202 | * A wrapper class for the crypto objects supported by FingerprintManager. Currently the |
Jim Miller | b62dc82 | 2015-04-28 20:05:53 -0700 | [diff] [blame] | 203 | * framework supports {@link Signature}, {@link Cipher} and {@link Mac} objects. |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 204 | */ |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 205 | public static final class CryptoObject { |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 206 | |
Jim Miller | b62dc82 | 2015-04-28 20:05:53 -0700 | [diff] [blame] | 207 | public CryptoObject(@NonNull Signature signature) { |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 208 | mCrypto = signature; |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 209 | } |
| 210 | |
Jim Miller | b62dc82 | 2015-04-28 20:05:53 -0700 | [diff] [blame] | 211 | public CryptoObject(@NonNull Cipher cipher) { |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 212 | mCrypto = cipher; |
Jim Miller | b62dc82 | 2015-04-28 20:05:53 -0700 | [diff] [blame] | 213 | } |
| 214 | |
| 215 | public CryptoObject(@NonNull Mac mac) { |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 216 | mCrypto = mac; |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 217 | } |
| 218 | |
| 219 | /** |
| 220 | * Get {@link Signature} object. |
| 221 | * @return {@link Signature} object or null if this doesn't contain one. |
| 222 | */ |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 223 | public Signature getSignature() { |
| 224 | return mCrypto instanceof Signature ? (Signature) mCrypto : null; |
| 225 | } |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 226 | |
| 227 | /** |
| 228 | * Get {@link Cipher} object. |
| 229 | * @return {@link Cipher} object or null if this doesn't contain one. |
| 230 | */ |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 231 | public Cipher getCipher() { |
| 232 | return mCrypto instanceof Cipher ? (Cipher) mCrypto : null; |
| 233 | } |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 234 | |
| 235 | /** |
Jim Miller | b62dc82 | 2015-04-28 20:05:53 -0700 | [diff] [blame] | 236 | * Get {@link Mac} object. |
| 237 | * @return {@link Mac} object or null if this doesn't contain one. |
| 238 | */ |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 239 | public Mac getMac() { |
| 240 | return mCrypto instanceof Mac ? (Mac) mCrypto : null; |
| 241 | } |
Jim Miller | b62dc82 | 2015-04-28 20:05:53 -0700 | [diff] [blame] | 242 | |
| 243 | /** |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 244 | * @hide |
| 245 | * @return the opId associated with this object or 0 if none |
| 246 | */ |
| 247 | public long getOpId() { |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 248 | return mCrypto != null ? |
| 249 | AndroidKeyStoreProvider.getKeyStoreOperationHandle(mCrypto) : 0; |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 250 | } |
| 251 | |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 252 | private final Object mCrypto; |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 253 | }; |
| 254 | |
| 255 | /** |
| 256 | * Container for callback data from {@link FingerprintManager#authenticate(CryptoObject, |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 257 | * CancellationSignal, int, AuthenticationCallback, Handler)}. |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 258 | */ |
Jim Miller | 748bc36 | 2015-07-08 19:02:28 -0700 | [diff] [blame] | 259 | public static class AuthenticationResult { |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 260 | private Fingerprint mFingerprint; |
| 261 | private CryptoObject mCryptoObject; |
| 262 | |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 263 | /** |
| 264 | * Authentication result |
| 265 | * |
| 266 | * @param crypto the crypto object |
| 267 | * @param fingerprint the recognized fingerprint data, if allowed. |
| 268 | * @hide |
| 269 | */ |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 270 | public AuthenticationResult(CryptoObject crypto, Fingerprint fingerprint) { |
| 271 | mCryptoObject = crypto; |
| 272 | mFingerprint = fingerprint; |
| 273 | } |
| 274 | |
| 275 | /** |
| 276 | * Obtain the crypto object associated with this transaction |
| 277 | * @return crypto object provided to {@link FingerprintManager#authenticate(CryptoObject, |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 278 | * CancellationSignal, int, AuthenticationCallback, Handler)}. |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 279 | */ |
| 280 | public CryptoObject getCryptoObject() { return mCryptoObject; } |
| 281 | |
| 282 | /** |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 283 | * Obtain the Fingerprint associated with this operation. Applications are strongly |
| 284 | * discouraged from associating specific fingers with specific applications or operations. |
| 285 | * |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 286 | * @hide |
| 287 | */ |
| 288 | public Fingerprint getFingerprint() { return mFingerprint; } |
| 289 | }; |
| 290 | |
| 291 | /** |
| 292 | * Callback structure provided to {@link FingerprintManager#authenticate(CryptoObject, |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 293 | * CancellationSignal, int, AuthenticationCallback, Handler)}. Users of {@link |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 294 | * FingerprintManager#authenticate(CryptoObject, CancellationSignal, |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 295 | * int, AuthenticationCallback, Handler) } must provide an implementation of this for listening to |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 296 | * fingerprint events. |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 297 | */ |
| 298 | public static abstract class AuthenticationCallback { |
| 299 | /** |
| 300 | * Called when an unrecoverable error has been encountered and the operation is complete. |
| 301 | * No further callbacks will be made on this object. |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 302 | * @param errorCode An integer identifying the error message |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 303 | * @param errString A human-readable error string that can be shown in UI |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 304 | */ |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 305 | public void onAuthenticationError(int errorCode, CharSequence errString) { } |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 306 | |
| 307 | /** |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 308 | * Called when a recoverable error has been encountered during authentication. The help |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 309 | * string is provided to give the user guidance for what went wrong, such as |
| 310 | * "Sensor dirty, please clean it." |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 311 | * @param helpCode An integer identifying the error message |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 312 | * @param helpString A human-readable string that can be shown in UI |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 313 | */ |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 314 | public void onAuthenticationHelp(int helpCode, CharSequence helpString) { } |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 315 | |
| 316 | /** |
| 317 | * Called when a fingerprint is recognized. |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 318 | * @param result An object containing authentication-related data |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 319 | */ |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 320 | public void onAuthenticationSucceeded(AuthenticationResult result) { } |
| 321 | |
| 322 | /** |
| 323 | * Called when a fingerprint is valid but not recognized. |
| 324 | */ |
| 325 | public void onAuthenticationFailed() { } |
Jorim Jaggi | 4cfdcf5 | 2015-07-09 12:13:59 -0700 | [diff] [blame] | 326 | |
| 327 | /** |
| 328 | * Called when a fingerprint image has been acquired, but wasn't processed yet. |
| 329 | * |
| 330 | * @param acquireInfo one of FINGERPRINT_ACQUIRED_* constants |
| 331 | * @hide |
| 332 | */ |
| 333 | public void onAuthenticationAcquired(int acquireInfo) {} |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 334 | }; |
| 335 | |
| 336 | /** |
| 337 | * Callback structure provided to {@link FingerprintManager#enroll(long, EnrollmentCallback, |
| 338 | * CancellationSignal, int). Users of {@link #FingerprintManager()} |
| 339 | * must provide an implementation of this to {@link FingerprintManager#enroll(long, |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 340 | * CancellationSignal, int, EnrollmentCallback) for listening to fingerprint events. |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 341 | * |
| 342 | * @hide |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 343 | */ |
| 344 | public static abstract class EnrollmentCallback { |
| 345 | /** |
| 346 | * Called when an unrecoverable error has been encountered and the operation is complete. |
| 347 | * No further callbacks will be made on this object. |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 348 | * @param errMsgId An integer identifying the error message |
| 349 | * @param errString A human-readable error string that can be shown in UI |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 350 | */ |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 351 | public void onEnrollmentError(int errMsgId, CharSequence errString) { } |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 352 | |
| 353 | /** |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 354 | * Called when a recoverable error has been encountered during enrollment. The help |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 355 | * string is provided to give the user guidance for what went wrong, such as |
| 356 | * "Sensor dirty, please clean it" or what they need to do next, such as |
| 357 | * "Touch sensor again." |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 358 | * @param helpMsgId An integer identifying the error message |
| 359 | * @param helpString A human-readable string that can be shown in UI |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 360 | */ |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 361 | public void onEnrollmentHelp(int helpMsgId, CharSequence helpString) { } |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 362 | |
| 363 | /** |
| 364 | * Called as each enrollment step progresses. Enrollment is considered complete when |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 365 | * remaining reaches 0. This function will not be called if enrollment fails. See |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 366 | * {@link EnrollmentCallback#onEnrollmentError(int, CharSequence)} |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 367 | * @param remaining The number of remaining steps |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 368 | */ |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 369 | public void onEnrollmentProgress(int remaining) { } |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 370 | }; |
| 371 | |
| 372 | /** |
| 373 | * Callback structure provided to {@link FingerprintManager#remove(int). Users of |
| 374 | * {@link #FingerprintManager()} may optionally provide an implementation of this to |
| 375 | * {@link FingerprintManager#remove(int, int, RemovalCallback)} for listening to |
| 376 | * fingerprint template removal events. |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 377 | * |
| 378 | * @hide |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 379 | */ |
| 380 | public static abstract class RemovalCallback { |
| 381 | /** |
| 382 | * Called when the given fingerprint can't be removed. |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 383 | * @param fp The fingerprint that the call attempted to remove |
| 384 | * @param errMsgId An associated error message id |
| 385 | * @param errString An error message indicating why the fingerprint id can't be removed |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 386 | */ |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 387 | public void onRemovalError(Fingerprint fp, int errMsgId, CharSequence errString) { } |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 388 | |
| 389 | /** |
| 390 | * Called when a given fingerprint is successfully removed. |
| 391 | * @param fingerprint the fingerprint template that was removed. |
| 392 | */ |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 393 | public void onRemovalSucceeded(Fingerprint fingerprint) { } |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 394 | }; |
| 395 | |
| 396 | /** |
Jorim Jaggi | 3a46478 | 2015-08-28 16:59:13 -0700 | [diff] [blame] | 397 | * @hide |
| 398 | */ |
| 399 | public static abstract class LockoutResetCallback { |
| 400 | |
| 401 | /** |
| 402 | * Called when lockout period expired and clients are allowed to listen for fingerprint |
| 403 | * again. |
| 404 | */ |
| 405 | public void onLockoutReset() { } |
| 406 | }; |
| 407 | |
| 408 | /** |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 409 | * Request authentication of a crypto object. This call warms up the fingerprint hardware |
| 410 | * and starts scanning for a fingerprint. It terminates when |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 411 | * {@link AuthenticationCallback#onAuthenticationError(int, CharSequence)} or |
Jim Miller | 5f69ca3 | 2015-08-19 22:03:43 -0700 | [diff] [blame] | 412 | * {@link AuthenticationCallback#onAuthenticationSucceeded(AuthenticationResult)} is called, at |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 413 | * which point the object is no longer valid. The operation can be canceled by using the |
| 414 | * provided cancel object. |
| 415 | * |
| 416 | * @param crypto object associated with the call or null if none required. |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 417 | * @param cancel an object that can be used to cancel authentication |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 418 | * @param flags optional flags; should be 0 |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 419 | * @param callback an object to receive authentication events |
| 420 | * @param handler an optional handler to handle callback events |
Jim Miller | e4c58e4 | 2015-06-09 13:48:57 -0700 | [diff] [blame] | 421 | * |
| 422 | * @throws IllegalArgumentException if the crypto operation is not supported or is not backed |
| 423 | * by <a href="{@docRoot}training/articles/keystore.html">Android Keystore |
| 424 | * facility</a>. |
| 425 | * @throws IllegalStateException if the crypto primitive is not initialized. |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 426 | */ |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 427 | @RequiresPermission(USE_FINGERPRINT) |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 428 | public void authenticate(@Nullable CryptoObject crypto, @Nullable CancellationSignal cancel, |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 429 | int flags, @NonNull AuthenticationCallback callback, @Nullable Handler handler) { |
| 430 | authenticate(crypto, cancel, flags, callback, handler, UserHandle.myUserId()); |
Jorim Jaggi | ccdfa93 | 2015-04-13 16:29:48 -0700 | [diff] [blame] | 431 | } |
| 432 | |
| 433 | /** |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 434 | * Use the provided handler thread for events. |
| 435 | * @param handler |
| 436 | */ |
| 437 | private void useHandler(Handler handler) { |
| 438 | if (handler != null) { |
| 439 | mHandler = new MyHandler(handler.getLooper()); |
| 440 | } else if (mHandler.getLooper() != mContext.getMainLooper()){ |
| 441 | mHandler = new MyHandler(mContext.getMainLooper()); |
| 442 | } |
| 443 | } |
| 444 | |
| 445 | /** |
| 446 | * Per-user version |
Jorim Jaggi | ccdfa93 | 2015-04-13 16:29:48 -0700 | [diff] [blame] | 447 | * @hide |
| 448 | */ |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 449 | @RequiresPermission(USE_FINGERPRINT) |
Jorim Jaggi | ccdfa93 | 2015-04-13 16:29:48 -0700 | [diff] [blame] | 450 | public void authenticate(@Nullable CryptoObject crypto, @Nullable CancellationSignal cancel, |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 451 | int flags, @NonNull AuthenticationCallback callback, Handler handler, int userId) { |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 452 | if (callback == null) { |
| 453 | throw new IllegalArgumentException("Must supply an authentication callback"); |
| 454 | } |
| 455 | |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 456 | if (cancel != null) { |
| 457 | if (cancel.isCanceled()) { |
| 458 | Log.w(TAG, "authentication already canceled"); |
| 459 | return; |
| 460 | } else { |
| 461 | cancel.setOnCancelListener(new OnAuthenticationCancelListener(crypto)); |
| 462 | } |
| 463 | } |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 464 | |
| 465 | if (mService != null) try { |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 466 | useHandler(handler); |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 467 | mAuthenticationCallback = callback; |
| 468 | mCryptoObject = crypto; |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 469 | long sessionId = crypto != null ? crypto.getOpId() : 0; |
Svetoslav | 4af76a5 | 2015-04-29 15:29:46 -0700 | [diff] [blame] | 470 | mService.authenticate(mToken, sessionId, userId, mServiceReceiver, flags, |
| 471 | mContext.getOpPackageName()); |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 472 | } catch (RemoteException e) { |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 473 | Log.w(TAG, "Remote exception while authenticating: ", e); |
| 474 | if (callback != null) { |
| 475 | // Though this may not be a hardware issue, it will cause apps to give up or try |
| 476 | // again later. |
| 477 | callback.onAuthenticationError(FINGERPRINT_ERROR_HW_UNAVAILABLE, |
| 478 | getErrorString(FINGERPRINT_ERROR_HW_UNAVAILABLE)); |
| 479 | } |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 480 | } |
| 481 | } |
| 482 | |
| 483 | /** |
| 484 | * Request fingerprint enrollment. This call warms up the fingerprint hardware |
| 485 | * and starts scanning for fingerprints. Progress will be indicated by callbacks to the |
| 486 | * {@link EnrollmentCallback} object. It terminates when |
| 487 | * {@link EnrollmentCallback#onEnrollmentError(int, CharSequence)} or |
| 488 | * {@link EnrollmentCallback#onEnrollmentProgress(int) is called with remaining == 0, at |
| 489 | * which point the object is no longer valid. The operation can be canceled by using the |
| 490 | * provided cancel object. |
Jim Miller | fe6439f | 2015-04-11 18:07:57 -0700 | [diff] [blame] | 491 | * @param token a unique token provided by a recent creation or verification of device |
| 492 | * credentials (e.g. pin, pattern or password). |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 493 | * @param cancel an object that can be used to cancel enrollment |
| 494 | * @param flags optional flags |
Clara Bayarri | a5c1a77 | 2016-01-26 16:36:14 +0000 | [diff] [blame] | 495 | * @param userId the user to whom this fingerprint will belong to |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 496 | * @param callback an object to receive enrollment events |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 497 | * @hide |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 498 | */ |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 499 | @RequiresPermission(MANAGE_FINGERPRINT) |
| 500 | public void enroll(byte [] token, CancellationSignal cancel, int flags, |
Clara Bayarri | a5c1a77 | 2016-01-26 16:36:14 +0000 | [diff] [blame] | 501 | int userId, EnrollmentCallback callback) { |
Clara Bayarri | d1f722d | 2016-01-07 14:17:39 +0000 | [diff] [blame] | 502 | if (userId == UserHandle.USER_CURRENT) { |
| 503 | userId = getCurrentUserId(); |
| 504 | } |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 505 | if (callback == null) { |
| 506 | throw new IllegalArgumentException("Must supply an enrollment callback"); |
| 507 | } |
| 508 | |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 509 | if (cancel != null) { |
| 510 | if (cancel.isCanceled()) { |
| 511 | Log.w(TAG, "enrollment already canceled"); |
| 512 | return; |
| 513 | } else { |
Jim Miller | fe6439f | 2015-04-11 18:07:57 -0700 | [diff] [blame] | 514 | cancel.setOnCancelListener(new OnEnrollCancelListener()); |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 515 | } |
| 516 | } |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 517 | |
| 518 | if (mService != null) try { |
| 519 | mEnrollmentCallback = callback; |
Jim Miller | cb2ce6f | 2016-04-13 20:28:18 -0700 | [diff] [blame^] | 520 | mService.enroll(mToken, token, userId, mServiceReceiver, flags, |
| 521 | mContext.getOpPackageName()); |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 522 | } catch (RemoteException e) { |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 523 | Log.w(TAG, "Remote exception in enroll: ", e); |
| 524 | if (callback != null) { |
| 525 | // Though this may not be a hardware issue, it will cause apps to give up or try |
| 526 | // again later. |
| 527 | callback.onEnrollmentError(FINGERPRINT_ERROR_HW_UNAVAILABLE, |
| 528 | getErrorString(FINGERPRINT_ERROR_HW_UNAVAILABLE)); |
| 529 | } |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 530 | } |
| 531 | } |
| 532 | |
| 533 | /** |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 534 | * Requests a pre-enrollment auth token to tie enrollment to the confirmation of |
| 535 | * existing device credentials (e.g. pin/pattern/password). |
| 536 | * @hide |
| 537 | */ |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 538 | @RequiresPermission(MANAGE_FINGERPRINT) |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 539 | public long preEnroll() { |
| 540 | long result = 0; |
| 541 | if (mService != null) try { |
| 542 | result = mService.preEnroll(mToken); |
| 543 | } catch (RemoteException e) { |
Jeff Sharkey | c53962d | 2016-03-01 19:27:23 -0700 | [diff] [blame] | 544 | throw e.rethrowFromSystemServer(); |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 545 | } |
| 546 | return result; |
| 547 | } |
| 548 | |
| 549 | /** |
Sasha Levitskiy | e0943cf | 2015-07-08 13:22:20 -0700 | [diff] [blame] | 550 | * Finishes enrollment and cancels the current auth token. |
| 551 | * @hide |
| 552 | */ |
| 553 | @RequiresPermission(MANAGE_FINGERPRINT) |
| 554 | public int postEnroll() { |
| 555 | int result = 0; |
| 556 | if (mService != null) try { |
| 557 | result = mService.postEnroll(mToken); |
| 558 | } catch (RemoteException e) { |
Jeff Sharkey | c53962d | 2016-03-01 19:27:23 -0700 | [diff] [blame] | 559 | throw e.rethrowFromSystemServer(); |
Sasha Levitskiy | e0943cf | 2015-07-08 13:22:20 -0700 | [diff] [blame] | 560 | } |
| 561 | return result; |
| 562 | } |
| 563 | |
| 564 | /** |
Clara Bayarri | d1f722d | 2016-01-07 14:17:39 +0000 | [diff] [blame] | 565 | * Sets the active user. This is meant to be used to select the current profile for enrollment |
| 566 | * to allow separate enrolled fingers for a work profile |
| 567 | * @param userId |
| 568 | * @hide |
| 569 | */ |
| 570 | @RequiresPermission(MANAGE_FINGERPRINT) |
| 571 | public void setActiveUser(int userId) { |
| 572 | if (mService != null) try { |
| 573 | mService.setActiveUser(userId); |
| 574 | } catch (RemoteException e) { |
Jeff Sharkey | c53962d | 2016-03-01 19:27:23 -0700 | [diff] [blame] | 575 | throw e.rethrowFromSystemServer(); |
Clara Bayarri | d1f722d | 2016-01-07 14:17:39 +0000 | [diff] [blame] | 576 | } |
| 577 | } |
| 578 | |
| 579 | /** |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 580 | * Remove given fingerprint template from fingerprint hardware and/or protected storage. |
| 581 | * @param fp the fingerprint item to remove |
Clara Bayarri | a5c1a77 | 2016-01-26 16:36:14 +0000 | [diff] [blame] | 582 | * @param userId the user who this fingerprint belongs to |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 583 | * @param callback an optional callback to verify that fingerprint templates have been |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 584 | * successfully removed. May be null of no callback is required. |
| 585 | * |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 586 | * @hide |
| 587 | */ |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 588 | @RequiresPermission(MANAGE_FINGERPRINT) |
Clara Bayarri | a5c1a77 | 2016-01-26 16:36:14 +0000 | [diff] [blame] | 589 | public void remove(Fingerprint fp, int userId, RemovalCallback callback) { |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 590 | if (mService != null) try { |
| 591 | mRemovalCallback = callback; |
| 592 | mRemovalFingerprint = fp; |
Clara Bayarri | a5c1a77 | 2016-01-26 16:36:14 +0000 | [diff] [blame] | 593 | mService.remove(mToken, fp.getFingerId(), userId, mServiceReceiver); |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 594 | } catch (RemoteException e) { |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 595 | Log.w(TAG, "Remote exception in remove: ", e); |
| 596 | if (callback != null) { |
| 597 | callback.onRemovalError(fp, FINGERPRINT_ERROR_HW_UNAVAILABLE, |
| 598 | getErrorString(FINGERPRINT_ERROR_HW_UNAVAILABLE)); |
| 599 | } |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 600 | } |
| 601 | } |
| 602 | |
| 603 | /** |
| 604 | * Renames the given fingerprint template |
| 605 | * @param fpId the fingerprint id |
Clara Bayarri | a5c1a77 | 2016-01-26 16:36:14 +0000 | [diff] [blame] | 606 | * @param userId the user who this fingerprint belongs to |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 607 | * @param newName the new name |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 608 | * |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 609 | * @hide |
| 610 | */ |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 611 | @RequiresPermission(MANAGE_FINGERPRINT) |
Clara Bayarri | a5c1a77 | 2016-01-26 16:36:14 +0000 | [diff] [blame] | 612 | public void rename(int fpId, int userId, String newName) { |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 613 | // Renames the given fpId |
| 614 | if (mService != null) { |
| 615 | try { |
Clara Bayarri | a5c1a77 | 2016-01-26 16:36:14 +0000 | [diff] [blame] | 616 | mService.rename(fpId, userId, newName); |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 617 | } catch (RemoteException e) { |
Jeff Sharkey | c53962d | 2016-03-01 19:27:23 -0700 | [diff] [blame] | 618 | throw e.rethrowFromSystemServer(); |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 619 | } |
| 620 | } else { |
| 621 | Log.w(TAG, "rename(): Service not connected!"); |
| 622 | } |
| 623 | } |
| 624 | |
| 625 | /** |
| 626 | * Obtain the list of enrolled fingerprints templates. |
| 627 | * @return list of current fingerprint items |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 628 | * |
| 629 | * @hide |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 630 | */ |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 631 | @RequiresPermission(USE_FINGERPRINT) |
Jorim Jaggi | 2aad7ee | 2015-04-14 15:25:06 -0700 | [diff] [blame] | 632 | public List<Fingerprint> getEnrolledFingerprints(int userId) { |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 633 | if (mService != null) try { |
Svetoslav | 4af76a5 | 2015-04-29 15:29:46 -0700 | [diff] [blame] | 634 | return mService.getEnrolledFingerprints(userId, mContext.getOpPackageName()); |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 635 | } catch (RemoteException e) { |
Jeff Sharkey | c53962d | 2016-03-01 19:27:23 -0700 | [diff] [blame] | 636 | throw e.rethrowFromSystemServer(); |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 637 | } |
| 638 | return null; |
| 639 | } |
| 640 | |
| 641 | /** |
Jorim Jaggi | 2aad7ee | 2015-04-14 15:25:06 -0700 | [diff] [blame] | 642 | * Obtain the list of enrolled fingerprints templates. |
| 643 | * @return list of current fingerprint items |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 644 | * |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 645 | * @hide |
| 646 | */ |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 647 | @RequiresPermission(USE_FINGERPRINT) |
Jorim Jaggi | 2aad7ee | 2015-04-14 15:25:06 -0700 | [diff] [blame] | 648 | public List<Fingerprint> getEnrolledFingerprints() { |
| 649 | return getEnrolledFingerprints(UserHandle.myUserId()); |
| 650 | } |
| 651 | |
| 652 | /** |
| 653 | * Determine if there is at least one fingerprint enrolled. |
| 654 | * |
| 655 | * @return true if at least one fingerprint is enrolled, false otherwise |
| 656 | */ |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 657 | @RequiresPermission(USE_FINGERPRINT) |
Jorim Jaggi | 2aad7ee | 2015-04-14 15:25:06 -0700 | [diff] [blame] | 658 | public boolean hasEnrolledFingerprints() { |
| 659 | if (mService != null) try { |
Clara Bayarri | 33fd3cf | 2016-02-19 16:54:49 +0000 | [diff] [blame] | 660 | return mService.hasEnrolledFingerprints( |
| 661 | UserHandle.myUserId(), mContext.getOpPackageName()); |
| 662 | } catch (RemoteException e) { |
Jeff Sharkey | c53962d | 2016-03-01 19:27:23 -0700 | [diff] [blame] | 663 | throw e.rethrowFromSystemServer(); |
Clara Bayarri | 33fd3cf | 2016-02-19 16:54:49 +0000 | [diff] [blame] | 664 | } |
| 665 | return false; |
| 666 | } |
| 667 | |
| 668 | /** |
| 669 | * @hide |
| 670 | */ |
| 671 | @RequiresPermission(allOf = { |
| 672 | USE_FINGERPRINT, |
| 673 | INTERACT_ACROSS_USERS}) |
| 674 | public boolean hasEnrolledFingerprints(int userId) { |
| 675 | if (mService != null) try { |
| 676 | return mService.hasEnrolledFingerprints(userId, mContext.getOpPackageName()); |
Jorim Jaggi | 2aad7ee | 2015-04-14 15:25:06 -0700 | [diff] [blame] | 677 | } catch (RemoteException e) { |
Jeff Sharkey | c53962d | 2016-03-01 19:27:23 -0700 | [diff] [blame] | 678 | throw e.rethrowFromSystemServer(); |
Jorim Jaggi | 2aad7ee | 2015-04-14 15:25:06 -0700 | [diff] [blame] | 679 | } |
| 680 | return false; |
| 681 | } |
| 682 | |
| 683 | /** |
| 684 | * Determine if fingerprint hardware is present and functional. |
| 685 | * |
| 686 | * @return true if hardware is present and functional, false otherwise. |
| 687 | */ |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 688 | @RequiresPermission(USE_FINGERPRINT) |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 689 | public boolean isHardwareDetected() { |
| 690 | if (mService != null) { |
| 691 | try { |
| 692 | long deviceId = 0; /* TODO: plumb hardware id to FPMS */ |
Svetoslav | 4af76a5 | 2015-04-29 15:29:46 -0700 | [diff] [blame] | 693 | return mService.isHardwareDetected(deviceId, mContext.getOpPackageName()); |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 694 | } catch (RemoteException e) { |
Jeff Sharkey | c53962d | 2016-03-01 19:27:23 -0700 | [diff] [blame] | 695 | throw e.rethrowFromSystemServer(); |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 696 | } |
| 697 | } else { |
| 698 | Log.w(TAG, "isFingerprintHardwareDetected(): Service not connected!"); |
| 699 | } |
| 700 | return false; |
| 701 | } |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 702 | |
Andres Morales | 4d41a20 | 2015-04-16 14:12:38 -0700 | [diff] [blame] | 703 | /** |
| 704 | * Retrieves the authenticator token for binding keys to the lifecycle |
| 705 | * of the current set of fingerprints. Used only by internal clients. |
| 706 | * |
| 707 | * @hide |
| 708 | */ |
| 709 | public long getAuthenticatorId() { |
| 710 | if (mService != null) { |
| 711 | try { |
Svetoslav | 4af76a5 | 2015-04-29 15:29:46 -0700 | [diff] [blame] | 712 | return mService.getAuthenticatorId(mContext.getOpPackageName()); |
Andres Morales | 4d41a20 | 2015-04-16 14:12:38 -0700 | [diff] [blame] | 713 | } catch (RemoteException e) { |
Jeff Sharkey | c53962d | 2016-03-01 19:27:23 -0700 | [diff] [blame] | 714 | throw e.rethrowFromSystemServer(); |
Andres Morales | 4d41a20 | 2015-04-16 14:12:38 -0700 | [diff] [blame] | 715 | } |
| 716 | } else { |
| 717 | Log.w(TAG, "getAuthenticatorId(): Service not connected!"); |
| 718 | } |
| 719 | return 0; |
| 720 | } |
| 721 | |
Jim Miller | e0507bb | 2015-08-12 20:30:34 -0700 | [diff] [blame] | 722 | /** |
| 723 | * Reset the lockout timer when asked to do so by keyguard. |
| 724 | * |
| 725 | * @param token an opaque token returned by password confirmation. |
| 726 | * |
| 727 | * @hide |
| 728 | */ |
| 729 | public void resetTimeout(byte[] token) { |
| 730 | if (mService != null) { |
| 731 | try { |
| 732 | mService.resetTimeout(token); |
| 733 | } catch (RemoteException e) { |
Jeff Sharkey | c53962d | 2016-03-01 19:27:23 -0700 | [diff] [blame] | 734 | throw e.rethrowFromSystemServer(); |
Jim Miller | e0507bb | 2015-08-12 20:30:34 -0700 | [diff] [blame] | 735 | } |
| 736 | } else { |
Jorim Jaggi | 3a46478 | 2015-08-28 16:59:13 -0700 | [diff] [blame] | 737 | Log.w(TAG, "resetTimeout(): Service not connected!"); |
| 738 | } |
| 739 | } |
| 740 | |
| 741 | /** |
| 742 | * @hide |
| 743 | */ |
| 744 | public void addLockoutResetCallback(final LockoutResetCallback callback) { |
| 745 | if (mService != null) { |
| 746 | try { |
Jorim Jaggi | 5e35422 | 2015-09-04 14:17:58 -0700 | [diff] [blame] | 747 | final PowerManager powerManager = mContext.getSystemService(PowerManager.class); |
Jorim Jaggi | 3a46478 | 2015-08-28 16:59:13 -0700 | [diff] [blame] | 748 | mService.addLockoutResetCallback( |
| 749 | new IFingerprintServiceLockoutResetCallback.Stub() { |
| 750 | |
| 751 | @Override |
| 752 | public void onLockoutReset(long deviceId) throws RemoteException { |
Jorim Jaggi | 5e35422 | 2015-09-04 14:17:58 -0700 | [diff] [blame] | 753 | final PowerManager.WakeLock wakeLock = powerManager.newWakeLock( |
| 754 | PowerManager.PARTIAL_WAKE_LOCK, "lockoutResetCallback"); |
| 755 | wakeLock.acquire(); |
Jorim Jaggi | 3a46478 | 2015-08-28 16:59:13 -0700 | [diff] [blame] | 756 | mHandler.post(new Runnable() { |
| 757 | @Override |
| 758 | public void run() { |
Jorim Jaggi | 5e35422 | 2015-09-04 14:17:58 -0700 | [diff] [blame] | 759 | try { |
| 760 | callback.onLockoutReset(); |
| 761 | } finally { |
| 762 | wakeLock.release(); |
| 763 | } |
Jorim Jaggi | 3a46478 | 2015-08-28 16:59:13 -0700 | [diff] [blame] | 764 | } |
| 765 | }); |
| 766 | } |
| 767 | }); |
| 768 | } catch (RemoteException e) { |
Jeff Sharkey | c53962d | 2016-03-01 19:27:23 -0700 | [diff] [blame] | 769 | throw e.rethrowFromSystemServer(); |
Jorim Jaggi | 3a46478 | 2015-08-28 16:59:13 -0700 | [diff] [blame] | 770 | } |
| 771 | } else { |
| 772 | Log.w(TAG, "addLockoutResetCallback(): Service not connected!"); |
Jim Miller | e0507bb | 2015-08-12 20:30:34 -0700 | [diff] [blame] | 773 | } |
| 774 | } |
| 775 | |
Alex Klyubin | 24e9e96 | 2015-04-30 13:30:48 -0700 | [diff] [blame] | 776 | private class MyHandler extends Handler { |
| 777 | private MyHandler(Context context) { |
| 778 | super(context.getMainLooper()); |
| 779 | } |
| 780 | |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 781 | private MyHandler(Looper looper) { |
| 782 | super(looper); |
| 783 | } |
| 784 | |
Jim Miller | e0507bb | 2015-08-12 20:30:34 -0700 | [diff] [blame] | 785 | @Override |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 786 | public void handleMessage(android.os.Message msg) { |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 787 | switch(msg.what) { |
| 788 | case MSG_ENROLL_RESULT: |
| 789 | sendEnrollResult((Fingerprint) msg.obj, msg.arg1 /* remaining */); |
| 790 | break; |
| 791 | case MSG_ACQUIRED: |
| 792 | sendAcquiredResult((Long) msg.obj /* deviceId */, msg.arg1 /* acquire info */); |
| 793 | break; |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 794 | case MSG_AUTHENTICATION_SUCCEEDED: |
| 795 | sendAuthenticatedSucceeded((Fingerprint) msg.obj); |
| 796 | break; |
| 797 | case MSG_AUTHENTICATION_FAILED: |
| 798 | sendAuthenticatedFailed(); |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 799 | break; |
| 800 | case MSG_ERROR: |
| 801 | sendErrorResult((Long) msg.obj /* deviceId */, msg.arg1 /* errMsgId */); |
| 802 | break; |
| 803 | case MSG_REMOVED: |
| 804 | sendRemovedResult((Long) msg.obj /* deviceId */, msg.arg1 /* fingerId */, |
| 805 | msg.arg2 /* groupId */); |
| 806 | } |
| 807 | } |
| 808 | |
| 809 | private void sendRemovedResult(long deviceId, int fingerId, int groupId) { |
| 810 | if (mRemovalCallback != null) { |
| 811 | int reqFingerId = mRemovalFingerprint.getFingerId(); |
| 812 | int reqGroupId = mRemovalFingerprint.getGroupId(); |
Jim Kaye | f8d1e21 | 2015-09-09 08:47:58 -0700 | [diff] [blame] | 813 | if (reqFingerId != 0 && fingerId != reqFingerId) { |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 814 | Log.w(TAG, "Finger id didn't match: " + fingerId + " != " + reqFingerId); |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 815 | } |
Jim Miller | 1adb4a7 | 2015-09-14 18:58:08 -0700 | [diff] [blame] | 816 | if (groupId != reqGroupId) { |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 817 | Log.w(TAG, "Group id didn't match: " + groupId + " != " + reqGroupId); |
| 818 | } |
Ricky Wai | f86f986 | 2016-03-23 12:05:42 +0000 | [diff] [blame] | 819 | mRemovalCallback.onRemovalSucceeded(new Fingerprint(null, groupId, fingerId, |
| 820 | deviceId)); |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 821 | } |
| 822 | } |
| 823 | |
| 824 | private void sendErrorResult(long deviceId, int errMsgId) { |
| 825 | if (mEnrollmentCallback != null) { |
| 826 | mEnrollmentCallback.onEnrollmentError(errMsgId, getErrorString(errMsgId)); |
| 827 | } else if (mAuthenticationCallback != null) { |
| 828 | mAuthenticationCallback.onAuthenticationError(errMsgId, getErrorString(errMsgId)); |
| 829 | } else if (mRemovalCallback != null) { |
| 830 | mRemovalCallback.onRemovalError(mRemovalFingerprint, errMsgId, |
| 831 | getErrorString(errMsgId)); |
| 832 | } |
| 833 | } |
| 834 | |
| 835 | private void sendEnrollResult(Fingerprint fp, int remaining) { |
| 836 | if (mEnrollmentCallback != null) { |
| 837 | mEnrollmentCallback.onEnrollmentProgress(remaining); |
| 838 | } |
| 839 | } |
| 840 | |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 841 | private void sendAuthenticatedSucceeded(Fingerprint fp) { |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 842 | if (mAuthenticationCallback != null) { |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 843 | final AuthenticationResult result = new AuthenticationResult(mCryptoObject, fp); |
| 844 | mAuthenticationCallback.onAuthenticationSucceeded(result); |
| 845 | } |
| 846 | } |
| 847 | |
| 848 | private void sendAuthenticatedFailed() { |
| 849 | if (mAuthenticationCallback != null) { |
| 850 | mAuthenticationCallback.onAuthenticationFailed(); |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 851 | } |
| 852 | } |
| 853 | |
| 854 | private void sendAcquiredResult(long deviceId, int acquireInfo) { |
Jorim Jaggi | 4cfdcf5 | 2015-07-09 12:13:59 -0700 | [diff] [blame] | 855 | if (mAuthenticationCallback != null) { |
| 856 | mAuthenticationCallback.onAuthenticationAcquired(acquireInfo); |
| 857 | } |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 858 | final String msg = getAcquiredString(acquireInfo); |
Jorim Jaggi | 4cfdcf5 | 2015-07-09 12:13:59 -0700 | [diff] [blame] | 859 | if (msg == null) { |
| 860 | return; |
| 861 | } |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 862 | if (mEnrollmentCallback != null) { |
| 863 | mEnrollmentCallback.onEnrollmentHelp(acquireInfo, msg); |
| 864 | } else if (mAuthenticationCallback != null) { |
| 865 | mAuthenticationCallback.onAuthenticationHelp(acquireInfo, msg); |
| 866 | } |
| 867 | } |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 868 | }; |
| 869 | |
Jim Miller | 06e658f | 2014-06-17 15:59:40 -0700 | [diff] [blame] | 870 | /** |
| 871 | * @hide |
| 872 | */ |
Jim Miller | a7596147 | 2014-06-06 15:00:49 -0700 | [diff] [blame] | 873 | public FingerprintManager(Context context, IFingerprintService service) { |
Jim Miller | d08c2ac | 2014-05-14 16:30:38 -0700 | [diff] [blame] | 874 | mContext = context; |
Jim Miller | a7596147 | 2014-06-06 15:00:49 -0700 | [diff] [blame] | 875 | mService = service; |
| 876 | if (mService == null) { |
| 877 | Slog.v(TAG, "FingerprintManagerService was null"); |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 878 | } |
Alex Klyubin | 24e9e96 | 2015-04-30 13:30:48 -0700 | [diff] [blame] | 879 | mHandler = new MyHandler(context); |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 880 | } |
| 881 | |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 882 | private int getCurrentUserId() { |
| 883 | try { |
| 884 | return ActivityManagerNative.getDefault().getCurrentUser().id; |
| 885 | } catch (RemoteException e) { |
Jeff Sharkey | c53962d | 2016-03-01 19:27:23 -0700 | [diff] [blame] | 886 | throw e.rethrowFromSystemServer(); |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 887 | } |
| 888 | } |
| 889 | |
Jim Miller | fe6439f | 2015-04-11 18:07:57 -0700 | [diff] [blame] | 890 | private void cancelEnrollment() { |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 891 | if (mService != null) try { |
| 892 | mService.cancelEnrollment(mToken); |
| 893 | } catch (RemoteException e) { |
Jeff Sharkey | c53962d | 2016-03-01 19:27:23 -0700 | [diff] [blame] | 894 | throw e.rethrowFromSystemServer(); |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 895 | } |
| 896 | } |
Jim Miller | a7596147 | 2014-06-06 15:00:49 -0700 | [diff] [blame] | 897 | |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 898 | private void cancelAuthentication(CryptoObject cryptoObject) { |
| 899 | if (mService != null) try { |
Svetoslav | 4af76a5 | 2015-04-29 15:29:46 -0700 | [diff] [blame] | 900 | mService.cancelAuthentication(mToken, mContext.getOpPackageName()); |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 901 | } catch (RemoteException e) { |
Jeff Sharkey | c53962d | 2016-03-01 19:27:23 -0700 | [diff] [blame] | 902 | throw e.rethrowFromSystemServer(); |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 903 | } |
| 904 | } |
| 905 | |
| 906 | private String getErrorString(int errMsg) { |
| 907 | switch (errMsg) { |
| 908 | case FINGERPRINT_ERROR_UNABLE_TO_PROCESS: |
| 909 | return mContext.getString( |
| 910 | com.android.internal.R.string.fingerprint_error_unable_to_process); |
| 911 | case FINGERPRINT_ERROR_HW_UNAVAILABLE: |
| 912 | return mContext.getString( |
| 913 | com.android.internal.R.string.fingerprint_error_hw_not_available); |
| 914 | case FINGERPRINT_ERROR_NO_SPACE: |
| 915 | return mContext.getString( |
| 916 | com.android.internal.R.string.fingerprint_error_no_space); |
| 917 | case FINGERPRINT_ERROR_TIMEOUT: |
Jim Miller | fe6439f | 2015-04-11 18:07:57 -0700 | [diff] [blame] | 918 | return mContext.getString(com.android.internal.R.string.fingerprint_error_timeout); |
| 919 | case FINGERPRINT_ERROR_CANCELED: |
| 920 | return mContext.getString(com.android.internal.R.string.fingerprint_error_canceled); |
| 921 | case FINGERPRINT_ERROR_LOCKOUT: |
| 922 | return mContext.getString(com.android.internal.R.string.fingerprint_error_lockout); |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 923 | default: |
| 924 | if (errMsg >= FINGERPRINT_ERROR_VENDOR_BASE) { |
| 925 | int msgNumber = errMsg - FINGERPRINT_ERROR_VENDOR_BASE; |
| 926 | String[] msgArray = mContext.getResources().getStringArray( |
| 927 | com.android.internal.R.array.fingerprint_error_vendor); |
| 928 | if (msgNumber < msgArray.length) { |
| 929 | return msgArray[msgNumber]; |
| 930 | } |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 931 | } |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 932 | return null; |
| 933 | } |
| 934 | } |
| 935 | |
| 936 | private String getAcquiredString(int acquireInfo) { |
| 937 | switch (acquireInfo) { |
| 938 | case FINGERPRINT_ACQUIRED_GOOD: |
| 939 | return null; |
| 940 | case FINGERPRINT_ACQUIRED_PARTIAL: |
| 941 | return mContext.getString( |
| 942 | com.android.internal.R.string.fingerprint_acquired_partial); |
| 943 | case FINGERPRINT_ACQUIRED_INSUFFICIENT: |
| 944 | return mContext.getString( |
| 945 | com.android.internal.R.string.fingerprint_acquired_insufficient); |
| 946 | case FINGERPRINT_ACQUIRED_IMAGER_DIRTY: |
| 947 | return mContext.getString( |
| 948 | com.android.internal.R.string.fingerprint_acquired_imager_dirty); |
| 949 | case FINGERPRINT_ACQUIRED_TOO_SLOW: |
| 950 | return mContext.getString( |
| 951 | com.android.internal.R.string.fingerprint_acquired_too_slow); |
| 952 | case FINGERPRINT_ACQUIRED_TOO_FAST: |
| 953 | return mContext.getString( |
| 954 | com.android.internal.R.string.fingerprint_acquired_too_fast); |
| 955 | default: |
| 956 | if (acquireInfo >= FINGERPRINT_ACQUIRED_VENDOR_BASE) { |
| 957 | int msgNumber = acquireInfo - FINGERPRINT_ACQUIRED_VENDOR_BASE; |
| 958 | String[] msgArray = mContext.getResources().getStringArray( |
| 959 | com.android.internal.R.array.fingerprint_acquired_vendor); |
| 960 | if (msgNumber < msgArray.length) { |
| 961 | return msgArray[msgNumber]; |
| 962 | } |
| 963 | } |
| 964 | return null; |
Jim Miller | ba67aee | 2015-02-20 16:21:26 -0800 | [diff] [blame] | 965 | } |
Jim Miller | ba67aee | 2015-02-20 16:21:26 -0800 | [diff] [blame] | 966 | } |
Jim Miller | 99d6019 | 2015-03-11 17:41:58 -0700 | [diff] [blame] | 967 | |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 968 | private IFingerprintServiceReceiver mServiceReceiver = new IFingerprintServiceReceiver.Stub() { |
| 969 | |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 970 | @Override // binder call |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 971 | public void onEnrollResult(long deviceId, int fingerId, int groupId, int remaining) { |
| 972 | mHandler.obtainMessage(MSG_ENROLL_RESULT, remaining, 0, |
| 973 | new Fingerprint(null, groupId, fingerId, deviceId)).sendToTarget(); |
Jim Miller | 99d6019 | 2015-03-11 17:41:58 -0700 | [diff] [blame] | 974 | } |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 975 | |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 976 | @Override // binder call |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 977 | public void onAcquired(long deviceId, int acquireInfo) { |
| 978 | mHandler.obtainMessage(MSG_ACQUIRED, acquireInfo, 0, deviceId).sendToTarget(); |
| 979 | } |
| 980 | |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 981 | @Override // binder call |
| 982 | public void onAuthenticationSucceeded(long deviceId, Fingerprint fp) { |
| 983 | mHandler.obtainMessage(MSG_AUTHENTICATION_SUCCEEDED, fp).sendToTarget(); |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 984 | } |
| 985 | |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 986 | @Override // binder call |
| 987 | public void onAuthenticationFailed(long deviceId) { |
| 988 | mHandler.obtainMessage(MSG_AUTHENTICATION_FAILED).sendToTarget();; |
| 989 | } |
| 990 | |
| 991 | @Override // binder call |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 992 | public void onError(long deviceId, int error) { |
| 993 | mHandler.obtainMessage(MSG_ERROR, error, 0, deviceId).sendToTarget(); |
| 994 | } |
| 995 | |
Jim Miller | f501b58 | 2015-06-03 16:36:31 -0700 | [diff] [blame] | 996 | @Override // binder call |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 997 | public void onRemoved(long deviceId, int fingerId, int groupId) { |
| 998 | mHandler.obtainMessage(MSG_REMOVED, fingerId, groupId, deviceId).sendToTarget(); |
| 999 | } |
| 1000 | }; |
| 1001 | |
Andres Morales | 4d41a20 | 2015-04-16 14:12:38 -0700 | [diff] [blame] | 1002 | } |