Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README with Fingerprint Authentication Feature #26

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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
-----
Expand Down Expand Up @@ -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
Expand Down