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