This repository has been archived by the owner on Sep 19, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 477
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4b89afb
commit 27a08f0
Showing
1 changed file
with
3 additions
and
78 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,83 +1,8 @@ | ||
|
||
Android FingerprintDialog Sample | ||
=================================== | ||
================================ | ||
|
||
A sample that demonstrates to use registered fingerprints to authenticate the user in your app | ||
This repo has been migrated to [github.com/android/security][1]. Please check that repo for future updates. Thank you! | ||
|
||
Introduction | ||
------------ | ||
[1]: https://github.com/android/security | ||
|
||
This sample demonstrates how you can use registered fingerprints in your app to authenticate the user | ||
before proceeding some actions such as purchasing an item. | ||
|
||
First you need to create a symmetric key in the Android Key Store using [KeyGenerator][1] | ||
which can be only be used after the user has authenticated with fingerprint and pass | ||
a [KeyGenParameterSpec][2]. | ||
|
||
By setting [KeyGenParameterSpec.Builder.setUserAuthenticationRequired][3] to true, you can permit the | ||
use of the key only after the user authenticate it including when authenticated with the user's | ||
fingerprint. | ||
|
||
Then start listening to a fingerprint on the fingerprint sensor by calling | ||
[FingerprintManager.authenticate][4] with a [Cipher][5] initialized with the symmetric key created. | ||
Or alternatively you can fall back to server-side verified password as an authenticator. | ||
|
||
Once the fingerprint (or password) is verified, the | ||
[FingerprintManager.AuthenticationCallback#onAuthenticationSucceeded()][6] callback is called. | ||
|
||
[1]: https://developer.android.com/reference/javax/crypto/KeyGenerator.html | ||
[2]: https://developer.android.com/reference/android/security/keystore/KeyGenParameterSpec.html | ||
[3]: https://developer.android.com/reference/android/security/keystore/KeyGenParameterSpec.Builder.html#setUserAuthenticationRequired%28boolean%29 | ||
[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 | ||
[5]: https://developer.android.com/reference/javax/crypto/Cipher.html | ||
[6]: https://developer.android.com/reference/android/hardware/fingerprint/FingerprintManager.AuthenticationCallback.html#onAuthenticationSucceeded%28android.hardware.fingerprint.FingerprintManager.AuthenticationResult%29 | ||
|
||
Pre-requisites | ||
-------------- | ||
|
||
- Android SDK 26 | ||
- Android Build Tools v27.0.2 | ||
- Android Support Repository | ||
|
||
Screenshots | ||
------------- | ||
|
||
<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"/> | ||
|
||
Getting Started | ||
--------------- | ||
|
||
This sample uses the Gradle build system. To build this project, use the | ||
"gradlew build" command or use "Import Project" in Android Studio. | ||
|
||
Support | ||
------- | ||
|
||
- Google+ Community: https://plus.google.com/communities/105153134372062985968 | ||
- Stack Overflow: http://stackoverflow.com/questions/tagged/android | ||
|
||
If you've found an error in this sample, please file an issue: | ||
https://github.com/googlesamples/android-FingerprintDialog | ||
|
||
Patches are encouraged, and may be submitted by forking this project and | ||
submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details. | ||
|
||
License | ||
------- | ||
|
||
Copyright 2017 The Android Open Source Project, Inc. | ||
|
||
Licensed to the Apache Software Foundation (ASF) under one or more contributor | ||
license agreements. See the NOTICE file distributed with this work for | ||
additional information regarding copyright ownership. The ASF licenses this | ||
file to you under the Apache License, Version 2.0 (the "License"); you may not | ||
use this file except in compliance with the License. You may obtain a copy of | ||
the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
License for the specific language governing permissions and limitations under | ||
the License. |