1*d353a188SXin Li 2*d353a188SXin LiAndroid FingerprintDialog Sample 3*d353a188SXin Li=================================== 4*d353a188SXin Li 5*d353a188SXin LiA sample that demonstrates to use registered fingerprints to authenticate the user in your app 6*d353a188SXin Li 7*d353a188SXin LiIntroduction 8*d353a188SXin Li------------ 9*d353a188SXin Li 10*d353a188SXin LiThis sample demonstrates how you can use registered fingerprints in your app to authenticate the user 11*d353a188SXin Libefore proceeding some actions such as purchasing an item. 12*d353a188SXin Li 13*d353a188SXin LiFirst you need to create a symmetric key in the Android Key Store using [KeyGenerator][1] 14*d353a188SXin Liwhich can be only be used after the user has authenticated with fingerprint and pass 15*d353a188SXin Lia [KeyGenParameterSpec][2]. 16*d353a188SXin Li 17*d353a188SXin LiBy setting [KeyGenParameterSpec.Builder.setUserAuthenticationRequired][3] to true, you can permit the 18*d353a188SXin Liuse of the key only after the user authenticate it including when authenticated with the user's 19*d353a188SXin Lifingerprint. 20*d353a188SXin Li 21*d353a188SXin LiThen start listening to a fingerprint on the fingerprint sensor by calling 22*d353a188SXin Li[FingerprintManager.authenticate][4] with a [Cipher][5] initialized with the symmetric key created. 23*d353a188SXin LiOr alternatively you can fall back to server-side verified password as an authenticator. 24*d353a188SXin Li 25*d353a188SXin LiOnce the fingerprint (or password) is verified, the 26*d353a188SXin Li[FingerprintManager.AuthenticationCallback#onAuthenticationSucceeded()][6] callback is called. 27*d353a188SXin Li 28*d353a188SXin Li[1]: https://developer.android.com/reference/javax/crypto/KeyGenerator.html 29*d353a188SXin Li[2]: https://developer.android.com/reference/android/security/keystore/KeyGenParameterSpec.html 30*d353a188SXin Li[3]: https://developer.android.com/reference/android/security/keystore/KeyGenParameterSpec.Builder.html#setUserAuthenticationRequired%28boolean%29 31*d353a188SXin Li[4]: https://developer.android.com/reference/android/hardware/fingerprint/FingerprintManager.html#authenticate%28android.hardware.fingerprint.FingerprintManager.CryptoObject,%20android.os.CancellationSignal,%20int,%20android.hardware.fingerprint.FingerprintManager.AuthenticationCallback,%20android.os.Handler%29 32*d353a188SXin Li[5]: https://developer.android.com/reference/javax/crypto/Cipher.html 33*d353a188SXin Li[6]: https://developer.android.com/reference/android/hardware/fingerprint/FingerprintManager.AuthenticationCallback.html#onAuthenticationSucceeded%28android.hardware.fingerprint.FingerprintManager.AuthenticationResult%29 34*d353a188SXin Li 35*d353a188SXin LiPre-requisites 36*d353a188SXin Li-------------- 37*d353a188SXin Li 38*d353a188SXin Li- Android SDK 26 39*d353a188SXin Li- Android Build Tools v27.0.2 40*d353a188SXin Li- Android Support Repository 41*d353a188SXin Li 42*d353a188SXin LiScreenshots 43*d353a188SXin Li------------- 44*d353a188SXin Li 45*d353a188SXin Li<img src="screenshots/1-purchase-screen.png" height="400" alt="Screenshot"/> <img src="screenshots/2-fingerprint-dialog.png" height="400" alt="Screenshot"/> <img src="screenshots/3-fingerprint-authenticated.png" height="400" alt="Screenshot"/> <img src="screenshots/4-new-fingerprint-enrolled.png" height="400" alt="Screenshot"/> 46*d353a188SXin Li 47*d353a188SXin LiGetting Started 48*d353a188SXin Li--------------- 49*d353a188SXin Li 50*d353a188SXin LiThis sample uses the Gradle build system. To build this project, use the 51*d353a188SXin Li"gradlew build" command or use "Import Project" in Android Studio. 52*d353a188SXin Li 53*d353a188SXin LiSupport 54*d353a188SXin Li------- 55*d353a188SXin Li 56*d353a188SXin Li- Google+ Community: https://plus.google.com/communities/105153134372062985968 57*d353a188SXin Li- Stack Overflow: http://stackoverflow.com/questions/tagged/android 58*d353a188SXin Li 59*d353a188SXin LiIf you've found an error in this sample, please file an issue: 60*d353a188SXin Lihttps://github.com/googlesamples/android-FingerprintDialog 61*d353a188SXin Li 62*d353a188SXin LiPatches are encouraged, and may be submitted by forking this project and 63*d353a188SXin Lisubmitting a pull request through GitHub. Please see CONTRIBUTING.md for more details. 64*d353a188SXin Li 65*d353a188SXin LiLicense 66*d353a188SXin Li------- 67*d353a188SXin Li 68*d353a188SXin LiCopyright 2017 The Android Open Source Project, Inc. 69*d353a188SXin Li 70*d353a188SXin LiLicensed to the Apache Software Foundation (ASF) under one or more contributor 71*d353a188SXin Lilicense agreements. See the NOTICE file distributed with this work for 72*d353a188SXin Liadditional information regarding copyright ownership. The ASF licenses this 73*d353a188SXin Lifile to you under the Apache License, Version 2.0 (the "License"); you may not 74*d353a188SXin Liuse this file except in compliance with the License. You may obtain a copy of 75*d353a188SXin Lithe License at 76*d353a188SXin Li 77*d353a188SXin Lihttp://www.apache.org/licenses/LICENSE-2.0 78*d353a188SXin Li 79*d353a188SXin LiUnless required by applicable law or agreed to in writing, software 80*d353a188SXin Lidistributed under the License is distributed on an "AS IS" BASIS, WITHOUT 81*d353a188SXin LiWARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 82*d353a188SXin LiLicense for the specific language governing permissions and limitations under 83*d353a188SXin Lithe License. 84
