Home | History | Annotate | only in /developers/build/prebuilts/gradle/FingerprintDialog
Up to higher level directory
NameDateSize
.google/05-Oct-2017
Application/05-Oct-2017
build.gradle05-Oct-201711
CONTRIBUTING.md05-Oct-20171.5K
gradle/05-Oct-2017
gradlew05-Oct-20175K
gradlew.bat05-Oct-20172.3K
LICENSE05-Oct-201731.5K
README.md05-Oct-20173.9K
screenshots/05-Oct-2017
settings.gradle05-Oct-201722

README.md

      1 
      2 Android FingerprintDialog Sample
      3 ===================================
      4 
      5 A sample that demonstrates to use registered fingerprints to authenticate the user in your app
      6 
      7 Introduction
      8 ------------
      9 
     10 This sample demonstrates how you can use registered fingerprints in your app to authenticate the user
     11 before proceeding some actions such as purchasing an item.
     12 
     13 First you need to create a symmetric key in the Android Key Store using [KeyGenerator][1]
     14 which can be only be used after the user has authenticated with fingerprint and pass
     15 a [KeyGenParameterSpec][2].
     16 
     17 By setting [KeyGenParameterSpec.Builder.setUserAuthenticationRequired][3] to true, you can permit the
     18 use of the key only after the user authenticate it including when authenticated with the user's
     19 fingerprint.
     20 
     21 Then start listening to a fingerprint on the fingerprint sensor by calling
     22 [FingerprintManager.authenticate][4] with a [Cipher][5] initialized with the symmetric key created.
     23 Or alternatively you can fall back to server-side verified password as an authenticator.
     24 
     25 Once the fingerprint (or password) is verified, the
     26 [FingerprintManager.AuthenticationCallback#onAuthenticationSucceeded()][6] callback is called.
     27 
     28 [1]: https://developer.android.com/reference/javax/crypto/KeyGenerator.html
     29 [2]: https://developer.android.com/reference/android/security/keystore/KeyGenParameterSpec.html
     30 [3]: https://developer.android.com/reference/android/security/keystore/KeyGenParameterSpec.Builder.html#setUserAuthenticationRequired%28boolean%29
     31 [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 [5]: https://developer.android.com/reference/javax/crypto/Cipher.html
     33 [6]: https://developer.android.com/reference/android/hardware/fingerprint/FingerprintManager.AuthenticationCallback.html#onAuthenticationSucceeded%28android.hardware.fingerprint.FingerprintManager.AuthenticationResult%29
     34 
     35 Pre-requisites
     36 --------------
     37 
     38 - Android SDK 24
     39 - Android Build Tools v25.0.3
     40 - Android Support Repository
     41 
     42 Screenshots
     43 -------------
     44 
     45 <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 
     47 Getting Started
     48 ---------------
     49 
     50 This sample uses the Gradle build system. To build this project, use the
     51 "gradlew build" command or use "Import Project" in Android Studio.
     52 
     53 Support
     54 -------
     55 
     56 - Google+ Community: https://plus.google.com/communities/105153134372062985968
     57 - Stack Overflow: http://stackoverflow.com/questions/tagged/android
     58 
     59 If you've found an error in this sample, please file an issue:
     60 https://github.com/googlesamples/android-FingerprintDialog
     61 
     62 Patches are encouraged, and may be submitted by forking this project and
     63 submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
     64 
     65 License
     66 -------
     67 
     68 Copyright 2017 The Android Open Source Project, Inc.
     69 
     70 Licensed to the Apache Software Foundation (ASF) under one or more contributor
     71 license agreements.  See the NOTICE file distributed with this work for
     72 additional information regarding copyright ownership.  The ASF licenses this
     73 file to you under the Apache License, Version 2.0 (the "License"); you may not
     74 use this file except in compliance with the License.  You may obtain a copy of
     75 the License at
     76 
     77 http://www.apache.org/licenses/LICENSE-2.0
     78 
     79 Unless required by applicable law or agreed to in writing, software
     80 distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
     81 WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
     82 License for the specific language governing permissions and limitations under
     83 the License.
     84