Skip to content

Latest commit

 

History

History
161 lines (106 loc) · 8.55 KB

README_RU.md

File metadata and controls

161 lines (106 loc) · 8.55 KB
Raw

PIN Authentication Library on Jetpack Compose

Версия на английском языке

Описание

Библиотека для аутентификации пользователей с использованием PIN-кода. Эта библиотека предоставляет удобные и безопасные способы проверки личности пользователей с помощью простого числового PIN-кода. Она может быть использована разработчиками при создании приложений, требующих дополнительного слоя безопасности или идентификации пользователей.

Основные возможности

  1. Простая и интуитивно понятная аутентификация с помощью PIN-кода.
  2. Надежное хранение и защита PIN-кодов пользователей при помощи кодирования.
  3. Возможность настройки требуемой длины и сложности PIN-кода.
  4. Ограничение количества попыток ввода PIN-кода для предотвращения атак брутфорса.
  5. Расширенные опции настройки и уведомлений о событиях.

Инструкция по использованию библиотеки для аутентификации по PIN-коду

Эта инструкция поможет вам ознакомиться с использованием библиотеки для аутентификации по PIN-коду в вашем приложении. Библиотека предоставляет простой и надежный способ защиты доступа к вашему приложению с помощью PIN-кода. Давайте разберемся, как это работает:

Шаг 1: Установка библиотеки

Установка библиотеки для аутентификации по PIN-коду — первый шаг к безопасной защите вашего приложения.

  1. Внесите зависимость в файл build.gradle:
dependencies {
   implementation 'com.github.Khokhlinvladimir:android-pin-authentication:v1.0.4'
}

С этим простым шагом, вы включите мощный инструмент аутентификации в вашем приложении, делая его надежным и безопасным.

  1. Указание репозитория в файле settings.gradle:
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        mavenCentral()
        maven { url 'https://jitpack.io' }
    }
}

Не забудьте добавить эту настройку в ваш файл settings.gradle, чтобы убедиться, что библиотека будет доступна для загрузки.

Шаг 2: Инициализация библиотеки

В вашей активности или фрагменте инициализируйте библиотеку следующим образом:

val pinCodeStateManager = PinCodeStateManager.getInstance()

Шаг 3: Настройка параметров безопасности

Установите параметры безопасности, такие как максимальное количество попыток ввода PIN-кода, длина PIN-кода и активация биометрической аутентификации:

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

Шаг 4: Создание, валидация, изменение и удаление PIN-кода

Библиотека поддерживает четыре основных сценария:

1. Создание PIN-кода

pinCodeStateManager.setScenario(PinCodeScenario.CREATION)

Позволяет пользователю создать новый PIN-код.

2. Валидация PIN-кода

pinCodeStateManager.setScenario(PinCodeScenario.VALIDATION)

Пользователь может войти в приложение, введя свой существующий PIN-код. Библиотека проверит введенный PIN-код на соответствие и, при успешной валидации, предоставит доступ к приложению.

3. Изменение PIN-кода

pinCodeStateManager.setScenario(PinCodeScenario.CHANGE)

Позволяет пользователю изменить свой текущий PIN-код на новый.

4. Удаление PIN-кода

pinCodeStateManager.setScenario(PinCodeScenario.DELETION)

Пользователь может удалить свой текущий PIN-код.

Шаг 5: Обработка событий

Обработайте события, такие как успешное создание, валидация, изменение и удаление PIN-кода, а также исчерпание попыток ввода:

pinCodeStateManager.onCreationSuccess {
    // Обработка успешной установки PIN-кода
}

pinCodeStateManager.onValidationSuccess {
    // Обработка успешной валидации PIN-кода
}

pinCodeStateManager.onLoginAttemptsExpended {
    // Обработка исчерпания попыток ввода PIN-кода
}

// и так далее для других событий

Шаг 6: Интеграция с интерфейсом приложения

Интегрируйте библиотеку с интерфейсом вашего приложения

Surface(
    modifier = Modifier.fillMaxSize(),
    color = MaterialTheme.colorScheme.background
) {
    // Вывести экран для ввода или валидации PIN-кода
    PinCodeScreen()
}

Это основные шаги по использованию библиотеки для аутентификации по PIN-коду в вашем Android-приложении. Настраивайте библиотеку и обрабатывайте события в соответствии с вашими потребностями для создания безопасного и удобного опыта для пользователей.

Технические спецификации:

Минимальная версия SDK (minSdk): 24

Целевая версия SDK (targetSdk): 34

Версия Gradle: 8.5.2

Версия OpenJDK: 17.0.1

Лицензия

Эта библиотека распространяется под лицензией MIT. Подробности можно найти в файле LICENSE.

Автор

Библиотека разработана и поддерживается Khokhlin Vladimir. Вы можете связаться со мной через telegram @vkhokhlin.

Содействие

Если у вас есть предложения по улучшению библиотеки или вы обнаружили ошибку, пожалуйста, создайте issue или отправьте пулл-реквест в репозиторий на GitHub.