Updated README with Fingerprint Authentication Feature

Author: moksh-mahajan

.travis.yml

@@ -8,8 +8,8 @@ android:
     - extra-google-google_play_services
     - extra-android-m2repository
     - extra-google-m2repository
-    - build-tools-26.0.2
-    - android-26
+    - build-tools-28.0.3
+    - android-28
     - android-22
     - sys-img-armeabi-v7a-android-22
 

README.md

@@ -1,5 +1,6 @@
 # mobile-passcode
-Library for passcode implementation along with an optional additional feature to ask for passcode when your app resumes from background. (Works with minSDK >= 15)
+Library for Passcode and Fingerprint Authentication implementation along with an optional additional
+feature to ask for passcode when your app resumes from background. (Works with minSDK >= 15)
 
 Usage
 -----
@@ -60,10 +61,35 @@ public class PassCodeActivity extends MifosPassCodeActivity {
         return EncryptionUtil.DEFAULT;
     }
 
+    @Override
+    public String getFpDialogTitle() {
+        //Title to be shown for Fingerprint Dialog
+        return getString(R.string.fingerprint_dialog_title);
+    }
 }
 
 ```
 
+## Fingerprint Authentication
+
+ - Mention the title of Fingerprint Dialog by overriding **getFpDialogTitle()** method.
+
+ - If the device supports Fingerprint Authentication, then a dialog will be shown to the user to enable Fingerprint
+   Authentication at first time. If the user chooses "No", then he/she will be prompted to the Passcode Screen.
+
+ - If the user opts for Fingerprint Authentication, then a dialog will appear asking user to "Touch the Sensor" in
+   order to access the app.
+
+ - On **successful** authentication, **startNextActivity()** method will be executed.
+
+ - In case the Authentication **fails**, then after a 1 second delay, the dialog will again ask for Authentication.
+
+ - There is also an option to **cancel** Fingerprint Authentication, if chosen results in the execution of
+   **StartLoginActivity()** method.
+
+ - This feature won't work if the Device doesn't have a fingerprint scanner or if the Android Version is below
+   **Android Marshmallow (Android 6)**. In this case, the user will be directly prompted to the Passcode Screen.
+
 There are 4 different types of encryption methods available with respect to our Android Projects:
  - DEFAULT
  - MOBILE_BANKING

app/build.gradle

@@ -1,6 +1,12 @@
 apply plugin: 'com.android.application'
+apply plugin: 'kotlin-android-extensions'
+apply plugin: 'kotlin-android'
 
 android {
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
     signingConfigs {
         release {
             storeFile file("../default_key_store.jks")
@@ -33,6 +39,11 @@ dependencies {
     testImplementation 'junit:junit:4.12'
     androidTestImplementation 'androidx.test:runner:1.1.2-alpha02'
     androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0-alpha02'
-    //implementation project(':mifos-passcode')
-    implementation 'com.mifos.mobile:mifos-passcode:1.0.0'
+    implementation project(':mifos-passcode')
+    //implementation 'com.mifos.mobile:mifos-passcode:1.0.0'
+    implementation "androidx.core:core-ktx:+"
+    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
+}
+repositories {
+    mavenCentral()
 }

app/src/main/java/com/mifos/passcode/PassCodeActivity.java

@@ -39,4 +39,9 @@ public int getEncryptionType() {
         return EncryptionUtil.DEFAULT;
     }
 
+    @Override
+    public String getFpDialogTitle() {
+        //Title to be shown for Fingerprint Dialog
+        return getString(R.string.fingerprint_dialog_title);
+    }
 }

app/src/main/res/values/strings.xml

@@ -1,3 +1,4 @@
 <resources>
     <string name="app_name">mobile_passcode</string>
+    <string name="fingerprint_dialog_title">Login</string>
 </resources>

build.gradle

@@ -1,7 +1,8 @@
 // Top-level build file where you can add configuration options common to all sub-projects/modules.
 
 buildscript {
-    
+    ext.kotlin_version = '1.3.41'
+
     repositories {
         google()
         jcenter()
@@ -11,6 +12,7 @@ buildscript {
         classpath 'com.android.tools.build:gradle:3.3.2'
         classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.7.3'
         classpath 'com.github.dcendents:android-maven-gradle-plugin:2.1'
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
         // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
     }

mifos-passcode/build.gradle

@@ -1,4 +1,6 @@
 apply plugin: 'com.android.library'
+apply plugin: 'kotlin-android-extensions'
+apply plugin: 'kotlin-android'
 
 ext {
     bintrayRepo = 'maven'
@@ -54,9 +56,12 @@ dependencies {
     testImplementation 'junit:junit:4.12'
     androidTestImplementation 'androidx.test:runner:1.1.2-alpha02'
     androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0-alpha02'
+    implementation "androidx.core:core-ktx:+"
+    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
 }
 
 tasks.withType(Javadoc) {
+    excludes = ['**/*.kt']
     options.addStringOption('Xdoclint:none', '-quiet')
     options.addStringOption('encoding', 'UTF-8')
     options.addStringOption('charSet', 'UTF-8')
@@ -67,6 +72,9 @@ if (project.rootProject.file('local.properties').exists()) {
     apply from: 'https://raw.githubusercontent.com/nuuneoi/JCenter/master/installv1.gradle'
     apply from: 'https://raw.githubusercontent.com/nuuneoi/JCenter/master/bintrayv1.gradle'
 }
+repositories {
+    mavenCentral()
+}
 // Used this article to release the library
 // https://inthecheesefactory.com/blog/how-to-upload-library-to-jcenter-maven-central-as-dependency/en
 

mifos-passcode/src/main/AndroidManifest.xml

@@ -2,5 +2,6 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
     package="com.mifos.mobile.passcode">
     <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+    <uses-permission android:name="android.permission.USE_FINGERPRINT" />
 
 </manifest>

mifos-passcode/src/main/java/com/mifos/mobile/passcode/FpAuthCallback.kt

@@ -0,0 +1,6 @@
+package com.mifos.mobile.passcode
+
+interface FpAuthCallback {
+    fun onFpAuthSuccess()
+    fun onCancel()
+}

mifos-passcode/src/main/java/com/mifos/mobile/passcode/FpAuthDialog.kt

@@ -0,0 +1,108 @@
+package com.mifos.mobile.passcode
+
+import android.app.AlertDialog
+import android.content.Context
+import android.util.Log
+import android.view.LayoutInflater
+import android.widget.TextView
+import android.widget.Toast
+import androidx.appcompat.widget.AppCompatButton
+
+class FpAuthDialog(private val context: Context) {
+    private var dialogTitle = context.getString(R.string.fp_dialog_title)
+    private var dialogMessage = context.getString(R.string.fp_dialog_message)
+    private var dialogCancelText = context.getString(R.string.fp_dialog_cancel)
+
+    private var layoutInflater = LayoutInflater.from(context)
+    private var dialogView = layoutInflater.inflate(R.layout.dialog_fingerprint_auth, null)
+    private var tvDialogTitle = dialogView.findViewById<TextView>(R.id.fingerprint_dialog_title)
+    private var tvDialogMessage = dialogView.findViewById<TextView>(R.id.fingerprint_dialog_message)
+    private var tvDialogStatus = dialogView.findViewById<TextView>(R.id.fingerprint_dialog_status)
+    private var btnCancel = dialogView.findViewById<AppCompatButton>(R.id.fingerprint_dialog_cancel)
+
+    private var dialogBuilder = AlertDialog.Builder(context)
+    private var dialog: AlertDialog? = null
+
+    private var fpAuthCallback: FpAuthCallback = object : FpAuthCallback {
+        override fun onFpAuthSuccess() {
+            Toast.makeText(context, context.getString(R.string.authentication_successful), Toast.LENGTH_SHORT).show()
+        }
+
+        override fun onCancel() {
+            Toast.makeText(context, context.getString(R.string.authentication_cancelled), Toast.LENGTH_SHORT).show()
+        }
+
+    }
+    private var fpAuthHelper = FpAuthHelper(context, fpAuthCallback, this)
+
+    fun setTitle(title: String): FpAuthDialog {
+        dialogTitle = title
+        return this
+    }
+
+    fun setTitle(resTitle: Int): FpAuthDialog {
+        dialogTitle = context.resources.getString(resTitle)
+        return this
+    }
+
+    fun setMessage(message: String): FpAuthDialog {
+        dialogMessage = message
+        return this
+    }
+
+    fun setMessage(resMessage: Int): FpAuthDialog {
+        dialogMessage = context.resources.getString(resMessage)
+        return this
+    }
+
+    fun setCancelText(cancelText: String): FpAuthDialog {
+        dialogCancelText = cancelText
+        return this
+    }
+
+    fun setCancelText(resCancelText: Int): FpAuthDialog {
+        dialogCancelText = context.resources.getString(resCancelText)
+        return this
+    }
+
+    fun setCallback(fpAuthCallback: FpAuthCallback): FpAuthDialog {
+        this.fpAuthCallback = fpAuthCallback
+        fpAuthHelper = FpAuthHelper(context, fpAuthCallback, this)
+        return this
+    }
+
+    internal fun setStatusText(statusText: String) {
+        tvDialogStatus.text = statusText
+    }
+
+    internal fun setStatusIcon(resIcon: Int) {
+        tvDialogStatus.setCompoundDrawablesWithIntrinsicBounds(resIcon, 0, 0, 0)
+    }
+
+    fun dismiss() {
+        fpAuthHelper.stopFpAuth()
+        dialog!!.dismiss()
+    }
+
+    fun show() {
+        if (!FpAuthSupport.checkAvailabiltyAndIfFingerprintRegistered(context)) {
+            Log.e("FingerprintAuth", "Device not Suitable for Fingerprint Authentication")
+            return
+        }
+        tvDialogTitle.text = dialogTitle
+        tvDialogMessage.text = dialogMessage
+        btnCancel.text = dialogCancelText
+
+        dialog = dialogBuilder.setView(dialogView).create()
+        dialog!!.setCancelable(false)
+        dialog!!.show()
+
+        fpAuthHelper.startFpAuth()
+
+        btnCancel.setOnClickListener {
+            fpAuthHelper.stopFpAuth()
+            dialog!!.dismiss()
+            fpAuthCallback.onCancel()
+        }
+    }
+}