https://github.com/omaraflak/fingerprint
Android library that simplifies the process of fingerprint authentications.
https://github.com/omaraflak/fingerprint
android android-library authentication cipher dialog fingerprint fingerprint-dialog library
Last synced: 11 months ago
JSON representation
Android library that simplifies the process of fingerprint authentications.
- Host: GitHub
- URL: https://github.com/omaraflak/fingerprint
- Owner: omaraflak
- License: mit
- Created: 2017-07-02T15:43:04.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2019-04-28T11:55:55.000Z (about 7 years ago)
- Last Synced: 2025-04-12T14:22:57.450Z (about 1 year ago)
- Topics: android, android-library, authentication, cipher, dialog, fingerprint, fingerprint-dialog, library
- Language: Java
- Homepage:
- Size: 2.17 MB
- Stars: 68
- Watchers: 6
- Forks: 29
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Fingerprint [](https://bintray.com/omaflak/maven/fingerprint/_latestVersion)
**Fingerprint** is an Android library that simplifies the process of fingerprint authentications. The library provides a fingerprint view that you can use like regulars xml views. Furthermore, it can display **dialogs** to perform fingerprint authentication very easily.
In both cases the Fingerprint library implements in a simple way the use of a CryptoObject.
# Gradle Dependency
```groovy
implementation 'me.aflak.libraries:fingerprint:2.5.3'
```
# Fingerprint View
The library provides a `Fingerprint` object which is a view that you can display the way you want and use for authentications. Customizations are at the end of the README.
```xml
```
## Without CryptoObject
You only want to check if the user's fingerprint is enrolled in the phone.
```java
Fingerprint fingerprint = findViewById(R.id.fingerprint);
fingerprint.callback(new FingerprintCallback(...));
fingerprint.authenticate();
```
[**EXAMPLE**](https://github.com/OmarAflak/Fingerprint/blob/master/app/src/main/java/me/aflak/fingerprintdialoglibrary/SimpleView.java)
## With CryptoObject
Check if the user's fingerprint is enrolled in the phone and detect if a new fingerprint was added since last time authentication was used.
```java
Fingerprint fingerprint = findViewById(R.id.fingerprint);
fingerprint.callback(new FingerprintDialogSecureCallback(...), "Key");
fingerprint.authenticate();
```
[**EXAMPLE**](https://github.com/OmarAflak/Fingerprint/blob/master/app/src/main/java/me/aflak/fingerprintdialoglibrary/SecureView.java)
# Fingerprint Dialog
## Without CryptoObject
You only want to check if the user's fingerprint is enrolled in the phone.
```java
FingerprintDialog.initialize(this)
.title(R.string.title)
.message(R.string.message)
.callback(new FingerprintDialogCallback(...))
.show();
```
[**EXAMPLE**](https://github.com/OmarAflak/Fingerprint/blob/master/app/src/main/java/me/aflak/fingerprintdialoglibrary/SimpleDialog.java)
## With CryptoObject
Check if the user's fingerprint is enrolled in the phone and detect if a new fingerprint was added since last time authentication was used.
```java
FingerprintDialog.initialize(this)
.title(R.string.title)
.message(R.string.message)
.callback(new FingerprintDialogSecureCallback(...), "Key")
.show();
```
[**EXAMPLE**](https://github.com/OmarAflak/Fingerprint/blob/master/app/src/main/java/me/aflak/fingerprintdialoglibrary/SecureDialog.java)
# Secure a CryptoObject via authentication
CryptoObject can be used to perform cryptographic operations on Android. You can set the CryptoObject to be valid only if the user has authenticated via fingerprint before. You have to use `setUserAuthenticationRequired(true)` when creating the CryptoObject.
```java
FingerprintManager.CryptoObject cryptoObject;
// cryptoObject = ...
if(FingerprintDialog.isAvailable(this)) {
FingerprintDialog.initialize(this)
.title(R.string.fingerprint_title)
.message(R.string.fingerprint_message)
.callback(new FingerprintCallback(...))
.cryptoObject(cryptoObject)
.show();
}
```
# Customization
You can customize the fingerprint view directly from the xml.
```xml
```
Several functions are also available to customize your dialog.
```java
FingerprintDialog.initialize(this)
.title(R.string.fingerprint_title)
.message(R.string.fingerprint_message)
.enterAnimation(DialogAnimation.Enter.RIGHT)
.exitAnimation(DialogAnimation.Exit.RIGHT)
.circleScanningColor(R.color.colorAccent)
.callback(this)
.show();
```
# Rendering
# License
```
MIT License
Copyright (c) 2017 Michel Omar Aflak
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```