Fingerprint

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

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.

<me.aflak.libraries.view.Fingerprint
    android:id="@+id/fingerprint"
    android:layout_width="200dp"
    android:layout_height="200dp"/>

Without CryptoObject

You only want to check if the user's fingerprint is enrolled in the phone.

Fingerprint fingerprint = findViewById(R.id.fingerprint);
fingerprint.callback(new FingerprintCallback(...));
fingerprint.authenticate();

EXAMPLE

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.

Fingerprint fingerprint = findViewById(R.id.fingerprint);
fingerprint.callback(new FingerprintDialogSecureCallback(...), "Key");
fingerprint.authenticate();

EXAMPLE

Fingerprint Dialog

Without CryptoObject

You only want to check if the user's fingerprint is enrolled in the phone.

FingerprintDialog.initialize(this)
    .title(R.string.title)
    .message(R.string.message)
    .callback(new FingerprintDialogCallback(...))
    .show();

EXAMPLE

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.

FingerprintDialog.initialize(this)
    .title(R.string.title)
    .message(R.string.message)
    .callback(new FingerprintDialogSecureCallback(...), "Key")
    .show();

EXAMPLE

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.

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.

<me.aflak.libraries.view.Fingerprint
    xmlns:fingerprint="http://schemas.android.com/apk/res-auto"
    fingerprint:circleScanningColor="@android:color/black"
    fingerprint:fingerprintScanningColor="@color/colorAccent"
    android:id="@+id/fingerprint"
    android:layout_width="200dp"
    android:layout_height="200dp" />

Several functions are also available to customize your dialog.

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.