Класс Auth
Метод init
Анонимная регистрация пользователя на сервере (в сценарии с уникальным идентификатором). Создает неподтвержденное мобильное устройство (без привязки) в КриптоПро Ключ с получением вектора аутентификации к нему.
public void init(
@NonNull Context context,
@NonNull DssUser dssUser,
@NonNull RegisterInfo registerInfo,
@NonNull KeyProtectionType keyProtectionType,
@Nullable String password,
@NonNull final SdkDssUserCallback sdkDssUserCallback)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| dssUser | DSSUser | Сведения о пользователе |
| registerInfo | RegisterInfo | Сведения о регистрируемом устройстве пользователя |
| keyProtectionType | ProtectionType | Способ защиты вектора аутентификации |
| password | string | ПИН-код для доступа к вектору аутентификации (только в режиме без UI) |
| callback | SdkDssUserCallback | Интерфейс обратного вызова |
Возвращаемые значения:
- kid - Идентификатор зарегистрированного устройства пользователя.
Примечание
Метод отображает UI для ввода нового пароля для защиты ключей аутентификации.
Метод kinit
Создает неподтвержденное мобильное устройство (без привязки) в КриптоПро Ключ с получением начального вектора аутентификации к нему с использованием QR-кода.
public void kinit(
@NonNull Context context,
@NonNull DssUser dssUser,
@NonNull RegisterInfo registerInfo,
@NonNull KeyProtectionType keyProtectionType,
@Nullable String activationCode,
@Nullable String password,
@NonNull final SdkResultCallback sdkDssUserCallback)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| dssUser | DSSUser | Сведения о пользователе |
| registerInfo | RegisterInfo | Сведения о регистрируемом устройстве пользователя |
| keyProtectionType | ProtectionType | Способ защиты вектора аутентификации |
| password | string | ПИН-код для доступа к вектору аутентификации (только в режиме без UI) |
| activationCode | Код активации QR-кода (опциональный параметр) | |
| callback | SdkResultCallback | Интерфейс обратного вызова |
Возвращаемые значения:
- kid - Идентификатор зарегистрированного устройства пользователя.
Примечание
Метод отображает UI для ввода нового пароля для защиты ключей аутентификации.
Метод addNewDevice
Инициализирует новое устройство пользователя.
public void addNewDevice(
@NonNull Context context,
@NonNull DssUser dssUser,
@NonNull RegisterInfo registerInfo,
@NonNull KeyProtectionType keyProtectionType,
@NonNull String uid,
@Nullable String password,
@NonNull final SdkDssUserCallback authCallback)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| dssUser | DSSUser | Сведения о пользователе |
| registerInfo | RegisterInfo | Сведения о регистрируемом устройстве пользователя |
| keyProtectionType | ProtectionType | Способ защиты вектора аутентификации |
| password | string | ПИН-код для доступа к вектору аутентификации (только в режиме без UI) |
| uid | String | Идентификатор пользователя КриптоПро Ключ, к которому будет привязано мобильное устройство. |
| callback | SdkDssUserCallback | Интерфейс обратного вызова |
Возвращаемые значения:
- kid - Идентификатор зарегистрированного устройства пользователя.
Метод confirm
Подтверждает установку векторов аутентификации. Данный метод всегда необходимо вызывать после выполнения регистрации нового неподтвержденного мобильного устройства в КриптоПро Ключ. Данный метод может быть вызван только для векторов аутентификации, находящихся в состоянии Created.
public void confirm(
@NonNull Context context,
@NonNull String kid,
@NonNull final SdkCallback callback)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| callback | SdkCallback | Интерфейс обратного вызова |
Метод verify
Подтверждает привязку мобильного устройства к учетной записи пользователя. Данный метод может быть вызван только для векторов аутентификации, находящихся в состоянии NotVerified.
Если для данного мобильного устройства требуется осуществлять подтверждение присоединения с использованием nonce, то в этом случае перед отправкой запроса мобильное приложение должно отсканировать QR-код, содержащий значение nonce.
public void verify(
@NonNull Context context,
@NonNull String kid,
boolean silent,
@NonNull final SdkCallback callback)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| silent | Bool | Флаг для скрытия/отображения диалоговых окон SDK. Используется только для создания усиленной неквалифицированной электронной подписи (silent mode). Не используется по умолчанию |
| callback | SdkCallback | Интерфейс обратного вызова |
Примечание
Метод отображает UI с данными учётной записи к которой привязывается мобильное устройство.
Метод setPassAuth
Ввод ПИН-кода на вектор аутентификации.
public void setPassAuth(
@NonNull Context context,
@NonNull String kid,
@Nullable String password,
@NonNull final SdkCallback sdkCallback)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| password | String | ПИН-код для защиты вектора аутентификации |
| callback | SdkCallback | Интерфейс обратного вызова |
Примечание
Метод отображает UI ввода пароля для доступа к ключам аутентификации.
Метод changePassAuth
Изменение ПИН-кода на вектор аутентификации.
public void changePassAuth(
@NonNull Context context,
@NonNull String kid,
@NonNull KeyProtectionType keyProtectionType,
@Nullable String oldPassword,
@Nullable String newPassword,
@NonNull final SdkCallback sdkCallback)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| keyProtectionType | ProtectionType | Способ защиты вектора аутентификации |
| oldPassword | string | существующий ПИН-код для доступа к вектору аутентификации (параметр используется только в silent-режиме и для создания усиленной неквалифицированной электронной подписи) |
| newPassword | string | новый ПИН-код для доступа к вектору аутентификации (параметр используется только в silent-режиме и для создания усиленной неквалифицированной электронной подписи). |
| callback | SdkCallback | Интерфейс обратного вызова |
Метод renameAuth
Переименование устройства пользователя.
public void renameAuth(
@NonNull Context context,
@NonNull String kid,
@NonNull String newName) throws Exception
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| newName | String | Новое отображаемое имя вектора аутентификации |
Метод removeAuth
Удаление устройства пользователя и его вектора аутентификации.
public void removeAuth(
@NonNull Context context,
@NonNull String kid,
@NonNull String deletedKid,
boolean forceDelete,
@NonNull final SdkCallback sdkCallback)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| deletedKid | String | Идентификатор удаляемого устройства пользователя |
| forceDelete | Bool | Удаление устройства (и ключа аутентификации) вне зависимости ответа сервера |
| callback | SdkCallback | Интерфейс обратного вызова |
Примечание
Метод отображает UI ввода пароля для доступа к ключам аутентификации.
Метод removeAuthLocal
Удаление устройства пользователя и его вектора аутентификации без обращения на сервер.
public void removeAuthLocal(
Context context,
@NotNull String kid,
@NonNull final SimpleCallback callback)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
Метод getAuthList
Получение сведений о зарегистрированных пользователях и их устройствах.
public static List<DssUser> getAuthList(@NonNull Context context) throws Exception
Возвращаемые параметры:
| Параметр | Тип | Описание |
|---|---|---|
| dssUser | DSSUser | Сведения о пользователе |
Метод confirmNewDevice
Подтверждение запроса на добавление нового устройства.
public void confirmNewDevice(
@NonNull Context context,
@NonNull String kid,
@NonNull String confirmedKid,
boolean silent,
boolean approve,
@NonNull final SdkCallback callback)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| confirmedKid | String | Идентификатор устройства пользователя, добавление которого требуется подтвердить |
| silent | Bool | Флаг для скрытия/отображения диалоговых окон SDK. Используется только для создания усиленной неквалифицированной электронной подписи (silent mode). Не используется по умолчанию |
| approve | Bool | Флаг для одобрения / отклонения добавления нового устройства |
| callback | SdkCallback | Интерфейс обратного вызова |
Примечание
Метод отображает UI c данными добавляемого нового устройства пользователя и ввода пароля для доступа к ключам аутентификации.
Метод checkStatus
Проверка статуса запроса на добавление нового устройства.
public void checkStatus(
@NonNull Context context,
@NonNull String kid,
boolean showQr,
@NonNull final SdkKeyStateCallback callback)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| showQr | Bool | Флаг для отображения QR-кода |
| callback | SdkKeyStateCallback | Интерфейс обратного вызова |
Примечание
Метод может отображать UI c данными для добавления нового устройства пользователя.
Метод scanQR
Метод сканирования QR-кода .
public void scanQr(
@NonNull Context context,
@Nullable String base64Qr,
@NonNull final SdkQrCallback callback)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| base64Qr | String | Данные, содержащиеся в QR-коде (опциональный) |
| callback | SdkQrCallback | Интерфейс обратного вызова |
Возвращаемое значение:
RawQR - данные содержащиеся в QR-коде.
Примечание
Метод отображает UI для сканирования QR-кода.