CardReader

ML Kit, Scan Kit and Fido kit are most widely used in Business & Office category apps. An app can use ML kit Card Recognition feature to recognize bank cards, general visiting cards etc... Scan kit is most widely used to generate QR code or to scan the QR code.Fido kit is used for user authentication using Fingerprint or FaceRecognition.

Service Scenario Description

CardReader App will give insight about how HMS ML kit, Scan kit, and Fido kit can be used for Business&Office purpose category and how we can make the card scanning easy. This app demonstrate on how end user can scan the Bank Cards, General Cards(Business, PAN Card and Adhaar Card) and save it in the app. Whenver required User can open the app and see the stored card details. As a Safety purpose the Details of the card can only be seen after authentication using PIN Lock or FingerPrint or 3D-FaceRecognition.
In this code lab we are implementing below features with HMS kits.

Features	HMS Kits
Bank Card recognition	ML Kit
General Card recognition	ML Kit
Convert the card details to QR Code	Scan Kit
Authenticate using Fingerprint/FaceRecognition	Fido

What You Will Create

In this code lab, you will create a CardReader Demo project and use the APIs of HUAWEI ML, Scan and Fido. We are going to create a end to end prototype for scanning the different type of cards (General, Bank cards) and store it in the app.

Recognizing bank cards and general cards using ML Kit
Generate QR code and share
PIN/Fingerprint/Face Authentication using FIDO kit

The Below are the screenshots of the CardReader Application ,the application opens with first Splash Screen the user has to agree the Terms and Conditions for Agreement page
The below is the screenshort of the Dashboard Module of General ID cards and Bank Cards
The below is the screenshort of the General ID Cards and Aadhar Card Results
The below is the screenshort of the List of saved Cards
List of Cards-> Displays list of saved cards.
User Authentication-> If User want to view saved cards we have to authenticate using Pinlock or fingerprint or face-recognition for security reason.
Once user has done Authentication ,user can able to view and share using QR code to share as shown in below screenshorts

Note: To maintain the user confidentiality, we have blurred the portion of the screenshots wherever the user personal information is exposed throughout this document

Process:

What You Will Learn

In this code lab, you will learn how to:

Integrate HUAWEI ML Kit to recognize bank card and general visiting cards.
Integrate Scan Kit to generate QR code.
Integrate Fido Kit to Authenticate using Fingerprint/FaceRecognition.

Hardware Requirements

A computer (desktop or laptop) that runs the Windows 10 operating system
A Huawei phone with HMS Core (APK) 5.0.0.300 or later installed

Software Requirements

Android Studio 3.X
JDK 1.8 and later
SDK Platform 23 and later
Gradle 4.6 and later

Use the below link for preparing for the integration

https://developer.huawei.com/consumer/en/codelab/HMSPreparation/index.html#0

Enable HUAWEI Service(s) in AGC console:
To integrate HMS Core kits, you must complete the following preparations:

Create an app in AppGallery Connect.
Create an Android Studio project.
Generate a signing certificate.
Generate a signing certificate fingerprint.
Configure the signing certificate fingerprint.
Add the app package name and save the configuration file.
Add the AppGallery Connect plug-in and Maven repository in the project-level build.gradle file.
Configure the signing certificate in Android Studio.

For details, please refer to Preparations for Integrating HUAWEI HMS Core.
Enable the API permission for below kits from Project Setting > Manage APIs and enable the API permission.

ML Kit
Fido Kit
Scan Kit (is a standalone sdk, no need of any configuration in AGC)

Integration of HMS FIDO Kit

Fido BioAuthentication service provides local fingerprint and 3D facial authentication capabilities. Using BioAuthentication services, we can confirm whether the current user of a device is the device owner.

Step 1 : Enable the FIDO service in AGC as explained in previous steps.

Add the following dependancies


implementation'com.huawei.hms:fido-bioauthn-androidx:<FIDO_KIT_VERSION>'

Import required classes for FIDO Kit


import com.huawei.hms.support.api.fido.bioauthn.BioAuthnManager;
import com.huawei.hms.support.api.fido.bioauthn.FaceManager;

Step 2 : Check Device Configuration.

If device is already configured for PIN LOCK or FingerPrint or Face Recognition, display the Agreement page to user saying that, the current Application uses Authentications services.

In JAVA
AgreementPageView.java


private void init() {
    BioAuthUtils.checkAuthenticationType(this);
    …
}

BioAuthUtils.java


public static void checkAuthenticationType(Context context) {
    isKeyguardSecure = checkIsKeyguardSecured(context);
    isFingerPrintSecure = checkIsFingerprintSecured(context);
    isFaceRecognitionSecure = checkIsFaceRecognitionSecured(context);
}

public static boolean checkIsKeyguardSecured(Context context) {

    try {
        KeyguardManager mKeyguardManager = (KeyguardManager) context.getSystemService(Context.KEYGUARD_SERVICE);
        if (mKeyguardManager.isKeyguardSecure()) {
            isDeviceAuthenticated = true;
            return true;
        }
        return false;
    } catch (Exception e) {
        return false;
    }
}

public static boolean checkIsFingerprintSecured(Context context) {
    try {
        BioAuthnManager bioAuthnManager = new BioAuthnManager(context);
        int errorCode = bioAuthnManager.canAuth();

        if (errorCode != 0) {
            Toast.makeText(context, context.getString(R.string.FP_AUTH_CHECK) + errorCode, Toast.LENGTH_LONG).show();
            return false;
        }
        isDeviceAuthenticated = true;
        return true;

    } catch (Exception e) {
        Toast.makeText(context, R.string.FP_DEVICE_SUPPORT_ERROR, Toast.LENGTH_LONG).show();
        return false;
    }
}

public static boolean checkIsFaceRecognitionSecured(Context context) {
    int errorCode;
    try {
        FaceManager faceManager = new FaceManager(context);
        errorCode = faceManager.canAuth();
    } catch (Exception e) {
        Toast.makeText(context, R.string.FACEREC_SUPPORT_ERROR, Toast.LENGTH_LONG).show();
        return false;
    }

    if (errorCode != 0) {
        Toast.makeText(context, context.getString(R.string.FACEREC_AUTH_CHECK) + errorCode, Toast.LENGTH_LONG).show();
        return false;
    }
    isDeviceAuthenticated = true;
    return true;
}

In Kotlin
AgreementPageView.kt


private void init() {
    BioAuthUtils.checkAuthenticationType(this);
    …
}

BioAuthUtils.kt


public class BioAuthUtils {
    public static void checkAuthenticationType(Context context) {
        isKeyguardSecure = checkIsKeyguardSecured(context);
        isFingerPrintSecure = checkIsFingerprintSecured(context);
        isFaceRecognitionSecure = checkIsFaceRecognitionSecured(context);
    }


    public static boolean checkIsFaceRecognitionSecured(Context context) {
        int errorCode;
        try {
            FaceManager faceManager = new FaceManager(context);
            errorCode = faceManager.canAuth();
        } catch (NullPointerException e) {
            Toast.makeText(context, R.string.FACEREC_SUPPORT_ERROR, Toast.LENGTH_LONG).show();
            return false;
        }

        if (errorCode != 0) {
            Toast.makeText(context, context.getString(R.string.FACEREC_AUTH_CHECK) +
                    errorCode, Toast.LENGTH_LONG)
                    .show();
            return false;
        }
        setIsDeviceAuthenticated(true);
        return true;
    }


    public static boolean checkIsFingerprintSecured(Context context) {
        try {
            BioAuthnManager bioAuthnManager = new BioAuthnManager(context);
            int errorCode = bioAuthnManager.canAuth();

            if (errorCode != 0) {
                Toast.makeText(context, context.getString(R.string.FP_AUTH_CHECK) +
                        errorCode, Toast.LENGTH_LONG)
                        .show();
                return false;
            }
            setIsDeviceAuthenticated(true);
            return true;
        } catch (NullPointerException e) {
            Toast.makeText(context, R.string.FP_DEVICE_SUPPORT_ERROR, Toast.LENGTH_LONG).show();
            return false;
        }
    }

    public static boolean checkIsKeyguardSecured(Context context) {
        try {
            KeyguardManager mKeyguardManager = (KeyguardManager) context.getSystemService
                    (Context.KEYGUARD_SERVICE);
            if (mKeyguardManager.isKeyguardSecure()) {
                setIsDeviceAuthenticated(true);
                return true;
            } else {
                showToast(context, context.getString(R.string.PINLOCK_SUGGESTION_MSG));
            }
            return false;
        } catch (NullPointerException e) {
            return false;
        }
    }
}

Step 3: If user doesn't click on Agree, show message to user to click on agree button.

If User Click agree, then proceed to the dashboard screen.

In JAVA
AgreementPageView.java


private void init() {
    BioAuthUtils.checkAuthenticationType(this);
    FloatingActionButton fab = findViewById(R.id.fab);
    fab.setOnClickListener(view -> {
        if (isAgreeChecked && BioAuthUtils.isDeviceAuthenticated()) {
            Intent i = new Intent(AgreementPageView.this, DashboardActivity.class
            );
            startActivity(i);
            finish();
        } else if (!isAgreeChecked) {
            BioAuthUtils.showGuide(view, R.string.AGREE_TO_PROCEED);
        } else {
            BioAuthUtils.showGuide(view, R.string.AUTH_SUGGESTION_MSG
            );
        }
    });
}

In Kotlin
AgreementPageView.kt


private fun init() {
    checkAuthenticationType(this)
    val fab = findViewById(R.id.fab)
    fab.setOnClickListener { view: View? ->
        if (isAgreeChecked && isDeviceAuthenticated) {
            val i = Intent(this@AgreementPageView, DashboardActivity::class.java)
            startActivity(i)
            finish()
        } else if (!isAgreeChecked) {
            showGuide(view, R.string.AGREE_TO_PROCEED)
        } else {
            showGuide(view, R.string.AUTH_SUGGESTION_MSG)
        }
    }
}