PIN Authentication Library on Jetpack Compose

Версия на русском языке

Description

Library for user authentication using PIN code. This library provides convenient and secure ways to verify users' identities using a simple numeric PIN. It can be used by developers when creating applications that require an additional layer of security or user authentication.

Main features

1. Simple and intuitive PIN authentication.
2. Reliable storage and protection of user PIN codes using encryption.
3. Ability to customize the required length and complexity of the PIN code.
4. Limit the number of attempts to enter a PIN code to prevent brute force attacks.
5. Advanced configuration options and event notifications.

Instructions for using the library for PIN code authentication

This tutorial will help you become familiar with using the PIN authentication library in your application. The library provides a simple and reliable way to protect access to your application using a PIN code. Let's figure out how it works:

Step 1: Installing the library

Installing a PIN authentication library is the first step to securely protecting your application.

1. Add the dependency to your build.gradle file:

dependencies {
    implementation 'com.github.Khokhlinvladimir:android-pin-authentication:v1.0.5'
}

With this simple step, you will enable a powerful authentication tool in your application, making it reliable and secure.

2. Specifying the repository in the settings.gradle file:

dependencyResolutionManagement {
     repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
     repositories {
         mavenCentral()
         maven { url 'https://jitpack.io' }
     }
}

Don't forget to add this setting to your settings.gradle file to ensure the library will be available for download.

Step 2: Initialize the library

In your activity or fragment, initialize the library like this:

val pinCodeStateManager = PinCodeStateManager.getInstance()

Step 3: Configure Security Settings

Set security options such as maximum number of PIN attempts, PIN length, and biometric authentication activation:

pinCodeStateManager.setMaxPinAttempts(maxAttempts = 4, application = application)
pinCodeStateManager.setPinLength(pinLength = 4, application = application)
pinCodeStateManager.setBiometricEnabled(enabled = true, application = application)
pinCodeStateManager.autoLaunchBiometricEnabled(enabled = true,application = application)

Step 4: Create, validate, change and delete PIN code

The library supports four main scenarios:

1. Create a PIN code

pinCodeStateManager.setScenario(PinCodeScenario.CREATION)

Allows the user to create a new PIN.

2. PIN code validation

pinCodeStateManager.setScenario(PinCodeScenario.VALIDATION)

The user can log into the application by entering their existing PIN. The library will check the entered PIN code for compliance and, if validated successfully, will provide access to the application.

3. Change PIN code

pinCodeStateManager.setScenario(PinCodeScenario.CHANGE)

Allows the user to change their current PIN to a new one.

4. Removing the PIN code

pinCodeStateManager.setScenario(PinCodeScenario.DELETION)

The user can delete their current PIN.

Step 5: Event Handling

Handle events such as successful PIN creation, validation, change, and deletion, as well as input attempts exhaustion:

pinCodeStateManager.onCreationSuccess {
     // Handle successful PIN setting
}

pinCodeStateManager.onValidationSuccess {
     // Handle successful PIN validation
}

pinCodeStateManager.onLoginAttemptsExpended {
     // Handle exhaustion of PIN entry attempts
}

// and so on for other events

Step 6: Integration with the application interface

Integrate the library with your application's interface

Surface(
     modifier = Modifier.fillMaxSize(),
     color = MaterialTheme.colorScheme.background
) {
     // Display a screen for entering or validating a PIN code
     PinCodeScreen()
}

These are the basic steps to use the library for PIN authentication in your Android application. Customize the library and handle events according to your needs to create a secure and seamless user experience.

Technical specifications:

Minimum SDK version (minSdk): 24

Target SDK version (targetSdk): 34

Gradle version: 8.5.2

OpenJDK Version: 17.0.1

License

This library is distributed under the MIT license. Details can be found in the LICENSE file.

Author

The library is developed and maintained by Khokhlin Vladimir. You can contact me via telegram @vkhokhlin.

Assistance

If you have suggestions for improving the library or find a bug, please create an issue or send a pull request to the GitHub repository.