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 | */ |
Jim Miller | ebbf205 | 2015-03-31 17:24:34 -0700 | [diff] [blame] | 16 | package android.hardware.fingerprint; |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 17 | |
| 18 | import android.os.Bundle; |
Phil Weaver | 27fcd9c | 2017-01-20 15:57:24 -0800 | [diff] [blame] | 19 | import android.hardware.fingerprint.IFingerprintClientActiveCallback; |
Jim Miller | ebbf205 | 2015-03-31 17:24:34 -0700 | [diff] [blame] | 20 | import android.hardware.fingerprint.IFingerprintServiceReceiver; |
Jorim Jaggi | 3a46478 | 2015-08-28 16:59:13 -0700 | [diff] [blame] | 21 | import android.hardware.fingerprint.IFingerprintServiceLockoutResetCallback; |
Jim Miller | ebbf205 | 2015-03-31 17:24:34 -0700 | [diff] [blame] | 22 | import android.hardware.fingerprint.Fingerprint; |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 23 | import java.util.List; |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 24 | |
| 25 | /** |
| 26 | * Communication channel from client to the fingerprint service. |
| 27 | * @hide |
| 28 | */ |
Jim Miller | ba67aee | 2015-02-20 16:21:26 -0800 | [diff] [blame] | 29 | interface IFingerprintService { |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 30 | // Authenticate the given sessionId with a fingerprint |
Jim Miller | dca15d2 | 2015-06-16 20:55:13 -0700 | [diff] [blame] | 31 | void authenticate(IBinder token, long sessionId, int userId, |
Svetoslav | 4af76a5 | 2015-04-29 15:29:46 -0700 | [diff] [blame] | 32 | IFingerprintServiceReceiver receiver, int flags, String opPackageName); |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 33 | |
| 34 | // Cancel authentication for the given sessionId |
Svetoslav | 4af76a5 | 2015-04-29 15:29:46 -0700 | [diff] [blame] | 35 | void cancelAuthentication(IBinder token, String opPackageName); |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 36 | |
| 37 | // Start fingerprint enrollment |
Jim Miller | fe6439f | 2015-04-11 18:07:57 -0700 | [diff] [blame] | 38 | void enroll(IBinder token, in byte [] cryptoToken, int groupId, IFingerprintServiceReceiver receiver, |
Jim Miller | cb2ce6f | 2016-04-13 20:28:18 -0700 | [diff] [blame] | 39 | int flags, String opPackageName); |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 40 | |
| 41 | // Cancel enrollment in progress |
| 42 | void cancelEnrollment(IBinder token); |
Jim Miller | ba67aee | 2015-02-20 16:21:26 -0800 | [diff] [blame] | 43 | |
Jim Miller | a7596147 | 2014-06-06 15:00:49 -0700 | [diff] [blame] | 44 | // Any errors resulting from this call will be returned to the listener |
Jim Miller | 8f2aca0 | 2016-04-20 13:34:11 -0700 | [diff] [blame] | 45 | void remove(IBinder token, int fingerId, int groupId, int userId, |
| 46 | IFingerprintServiceReceiver receiver); |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 47 | |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 48 | // Rename the fingerprint specified by fingerId and groupId to the given name |
| 49 | void rename(int fingerId, int groupId, String name); |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 50 | |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 51 | // Get a list of enrolled fingerprints in the given group. |
Svetoslav | 4af76a5 | 2015-04-29 15:29:46 -0700 | [diff] [blame] | 52 | List<Fingerprint> getEnrolledFingerprints(int groupId, String opPackageName); |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 53 | |
Jim Miller | ba67aee | 2015-02-20 16:21:26 -0800 | [diff] [blame] | 54 | // Determine if HAL is loaded and ready |
Svetoslav | 4af76a5 | 2015-04-29 15:29:46 -0700 | [diff] [blame] | 55 | boolean isHardwareDetected(long deviceId, String opPackageName); |
Jim Miller | 99d6019 | 2015-03-11 17:41:58 -0700 | [diff] [blame] | 56 | |
Jim Miller | ce7eb6d | 2015-04-03 19:29:13 -0700 | [diff] [blame] | 57 | // Get a pre-enrollment authentication token |
| 58 | long preEnroll(IBinder token); |
| 59 | |
Sasha Levitskiy | e0943cf | 2015-07-08 13:22:20 -0700 | [diff] [blame] | 60 | // Finish an enrollment sequence and invalidate the authentication token |
| 61 | int postEnroll(IBinder token); |
| 62 | |
Jorim Jaggi | 2aad7ee | 2015-04-14 15:25:06 -0700 | [diff] [blame] | 63 | // Determine if a user has at least one enrolled fingerprint |
Svetoslav | 4af76a5 | 2015-04-29 15:29:46 -0700 | [diff] [blame] | 64 | boolean hasEnrolledFingerprints(int groupId, String opPackageName); |
Jorim Jaggi | 2aad7ee | 2015-04-14 15:25:06 -0700 | [diff] [blame] | 65 | |
Jim Miller | 9f0753f | 2015-03-23 23:59:22 -0700 | [diff] [blame] | 66 | // Gets the number of hardware devices |
| 67 | // int getHardwareDeviceCount(); |
| 68 | |
| 69 | // Gets the unique device id for hardware enumerated at i |
| 70 | // long getHardwareDevice(int i); |
| 71 | |
Andres Morales | 4d41a20 | 2015-04-16 14:12:38 -0700 | [diff] [blame] | 72 | // Gets the authenticator ID for fingerprint |
Svetoslav | 4af76a5 | 2015-04-29 15:29:46 -0700 | [diff] [blame] | 73 | long getAuthenticatorId(String opPackageName); |
Jim Miller | e0507bb | 2015-08-12 20:30:34 -0700 | [diff] [blame] | 74 | |
| 75 | // Reset the timeout when user authenticates with strong auth (e.g. PIN, pattern or password) |
| 76 | void resetTimeout(in byte [] cryptoToken); |
Jorim Jaggi | 3a46478 | 2015-08-28 16:59:13 -0700 | [diff] [blame] | 77 | |
| 78 | // Add a callback which gets notified when the fingerprint lockout period expired. |
| 79 | void addLockoutResetCallback(IFingerprintServiceLockoutResetCallback callback); |
Clara Bayarri | d1f722d | 2016-01-07 14:17:39 +0000 | [diff] [blame] | 80 | |
| 81 | // Explicitly set the active user (for enrolling work profile) |
| 82 | void setActiveUser(int uid); |
Jim Miller | 40e4645 | 2016-12-16 18:38:53 -0800 | [diff] [blame] | 83 | |
| 84 | // Enumerate all fingerprints |
| 85 | void enumerate(IBinder token, int userId, IFingerprintServiceReceiver receiver); |
Phil Weaver | 27fcd9c | 2017-01-20 15:57:24 -0800 | [diff] [blame] | 86 | |
| 87 | // Check if a client request is currently being handled |
| 88 | boolean isClientActive(); |
| 89 | |
| 90 | // Add a callback which gets notified when the service starts and stops handling client requests |
| 91 | void addClientActiveCallback(IFingerprintClientActiveCallback callback); |
| 92 | |
| 93 | // Removes a callback set by addClientActiveCallback |
| 94 | void removeClientActiveCallback(IFingerprintClientActiveCallback callback); |
Jim Miller | 08fa40c | 2014-04-29 18:18:47 -0700 | [diff] [blame] | 95 | } |