ru.cryptopro.mykey.sdk.v1

Class UsersManagerNonQual

java.lang.Object

_CallbackInvoker

ru.cryptopro.mykey.sdk.v1.UsersManagerNonQual

public final class UsersManagerNonQual
extends _CallbackInvoker

Класс для управления объектами User (регистрация, подтверждение профиля, установка/смена пароля и т.д.) в режиме неквалифицированной подписи. В отличие от аналогичных методов класса UsersManager никакие методы данного класса не запускают UI-компоненты SDK.

Constructor Summary

Constructors

Constructor and Description
UsersManagerNonQual()

Method Summary

Modifier and Type	Method and Description
static void	acceptAccountChanges(User user, QRCodeVerification qrCodeVerification, UserCallback callback) Подтверждение присоединения мобильного устройства к учётной записи пользователя. Выполнение возможно только при статусе учетной записи Device.DeviceStatus.NotVerified. Перед выполнением необходимо выполнить UsersManager.updateStatus(User, UserCallback) для получения актуального статуса учетной записи пользователя. При успешном выполнении учетная запись пользователя на сервере переводится в статус Device.DeviceStatus.Active. Перед вызовом необходимо проверить, что метод User.isReadyToSign() возвращает true.
static void	changePassword(User user, java.lang.String oldPassword, java.lang.String newPassword, UserCallback callback) Сохранение ключа с новым паролем на "вектор аутентификации".
static void	changePassword(User user, java.lang.String newPassword, UserCallback callback) Deprecated.
static void	checkApprovalStatus(User user, UserCallback callback) Отправляет запрос на получение сведений о статусе регистрации нового устройства пользователя. Может быть вызван только после того, как был вызван метод store(User, String, String, UserCallback).
static void	createBackup(User user, java.lang.String recoveryPassword, UserBackupCallback callback) Экспорт данных пользователя в JSON с шифрованием при помощи указанного пароля. Основная область применения функции — создание резервной копии ключевой информации для возможности последующего восстановления в случае переустановки приложения, смены устройства, утраты ПИН-кода и прочих подобных ситуациях.
static void	createUser(java.lang.String externalId, java.lang.String alias, java.lang.String serviceUrl, java.lang.String deviceName, PushNotificationData pushData, UserCallback callback) Создание "неподтвержденной" учетной записи с получением "вектора аутентификации" к ней Должен использоваться только в режиме УНЭП, не запускает последовательность экранов SDK. После выполнения метода созданная учетная запись имеет статус Device.DeviceStatus.Created, а также выполняется условие User.isReadyToSign() == true.
static void	createUserWithApproval(java.lang.String externalId, java.lang.String alias, java.lang.String serviceUrl, java.lang.String deviceName, PushNotificationData pushData, java.lang.String uid, UserCallback callback) Создание запроса на подключение другого устройства к учётной записи пользователя. Запускает процесс добавления устройства, где в ответ на данный запрос формирует "вектор аутентификации" и передаёт его на данное устройство. Подтверждение с другого устройства выполняется через получение списка устройств методом DevicesManager.listDevices(User, DevicesNetworkCallback), нахождением в списке устройства с заданным kid и вызовом методов DevicesManagerNonQual.approve(User, Device, NetworkCallback) или DevicesManagerNonQual.reject(User, Device, NetworkCallback) для подтверждения или отклонения запроса на регистрацию соответственно. В результате выполнения функции получаем объект User, не сохраненный в БД.
static void	createUserWithInitQR(java.lang.String externalId, java.lang.String alias, QRCodeKinit qrCodeKinit, java.lang.String serviceUrl, java.lang.String deviceName, PushNotificationData pushData, UserCallback callback) Создание "неподтвержденной" учетной записи с получением "вектора аутентификации" к ней. Для запроса используется Kinit, полученный из QR-кода. Должен использоваться только в режиме УНЭП, не запускает последовательность экранов SDK. После выполнения метода созданная учетная запись имеет статус Device.DeviceStatus.Created, а также выполняется условие User.isReadyToSign() == true.
static void	renew(User user, java.lang.String newName, java.lang.String deviceName, java.lang.String password, UserCallback callback) Перерегистрация пользователя на этом же устройстве.
static void	restoreBackup(java.lang.String backup, java.lang.String recoveryPassword, UserCallback callback) Восстановление объекта User из резервной копии
static void	revoke(User user, NetworkCallback callback) Отзыв "вектора аутентификации" на сервере.
static void	store(Activity parentActivity, User user, java.lang.String name, UserCallback callback) Сохранение объекта пользователя в долгосрочную память (Shared Preferences) с запуском пользовательского интерфейса для задания пароля средствами СДК. Device.DeviceStatus.Installed, если устройство регистрировалось методом createUser(String, String, String, String, PushNotificationData, UserCallback) Device.DeviceStatus.NotVerified, если устройство регистрировалось методом createUserWithInitQR(String, String, QRCodeKinit, String, String, PushNotificationData, UserCallback) Device.DeviceStatus.ApproveRequired, если устройство регистрировалось методом createUserWithApproval(String, String, String, String, PushNotificationData, String, UserCallback) Device.DeviceStatus.Active, если объект User был получен из резервной копии методом restoreBackup(String, String, UserCallback)
static void	store(User user, java.lang.String name, java.lang.String password, UserCallback callback) Сохранение объекта пользователя в долгосрочную память (Shared Preferences). После выполнения данной операции, учётная запись пользователя на сервере переводится в статус: Device.DeviceStatus.Installed, если устройство регистрировалось методом createUser(String, String, String, String, PushNotificationData, UserCallback) Device.DeviceStatus.NotVerified, если устройство регистрировалось методом createUserWithInitQR(String, String, QRCodeKinit, String, String, PushNotificationData, UserCallback) Device.DeviceStatus.ApproveRequired, если устройство регистрировалось методом createUserWithApproval(String, String, String, String, PushNotificationData, String, UserCallback) Device.DeviceStatus.Active, если объект User был получен из резервной копии методом restoreBackup(String, String, UserCallback)
static void	store(User user, java.lang.String name, UserCallback callback) Сохранение объекта пользователя в долгосрочную память (Shared Preferences) с запуском пользовательского интерфейса для задания пароля средствами СДК. Device.DeviceStatus.Installed, если устройство регистрировалось методом createUser(String, String, String, String, PushNotificationData, UserCallback) Device.DeviceStatus.NotVerified, если устройство регистрировалось методом createUserWithInitQR(String, String, QRCodeKinit, String, String, PushNotificationData, UserCallback) Device.DeviceStatus.ApproveRequired, если устройство регистрировалось методом createUserWithApproval(String, String, String, String, PushNotificationData, String, UserCallback) Device.DeviceStatus.Active, если объект User был получен из резервной копии методом restoreBackup(String, String, UserCallback)
static void	submitPassword(User user, java.lang.String password, UserCallback callback) Предъявление пароля.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UsersManagerNonQual

public UsersManagerNonQual()

Method Detail

createUser

public static void createUser(java.lang.String externalId,
                              java.lang.String alias,
                              java.lang.String serviceUrl,
                              java.lang.String deviceName,
                              PushNotificationData pushData,
                              UserCallback callback)

Создание "неподтвержденной" учетной записи с получением "вектора аутентификации" к ней
Должен использоваться только в режиме УНЭП, не запускает последовательность экранов SDK.
После выполнения метода созданная учетная запись имеет статус Device.DeviceStatus.Created, а также выполняется условие User.isReadyToSign() == true.

Parameters:

externalId - Желаемое имя пользователя (login), имя пользователя может быть использовано вызывающей системой для управления учётной записью пользователя. Если данный параметр отсутствует в запросе, то его значение будет создано автоматически на стороне сервера

alias - Уникальный человекочитаемый идентификатор, используемый для подтверждения владения МУ пользователем. Если данный параметр отсутствует в запросе, то его значение будет создано автоматически на стороне сервера

serviceUrl - URL для взаимодействия с сервером my

deviceName - Читаемое название устройства

pushData - Данные для получения PUSH-уведомлений

callback - При успешном выполнении возвращает созданный объект пользователя User. Иначе возвращает ошибку типа Error или NetworkError

createUserWithInitQR

public static void createUserWithInitQR(java.lang.String externalId,
                                        java.lang.String alias,
                                        QRCodeKinit qrCodeKinit,
                                        java.lang.String serviceUrl,
                                        java.lang.String deviceName,
                                        PushNotificationData pushData,
                                        UserCallback callback)

Создание "неподтвержденной" учетной записи с получением "вектора аутентификации" к ней.
Для запроса используется Kinit, полученный из QR-кода.
Должен использоваться только в режиме УНЭП, не запускает последовательность экранов SDK.
После выполнения метода созданная учетная запись имеет статус Device.DeviceStatus.Created, а также выполняется условие User.isReadyToSign() == true.

Parameters:

externalId - Желаемое имя пользователя (login), имя пользователя может быть использовано вызывающей системой для управления учётной записью пользователя. Если данный параметр отсутствует в запросе, то его значение будет создано автоматически на стороне сервера

alias - Уникальный человекочитаемый идентификатор, используемый для подтверждения владения МУ пользователем. Если данный параметр отсутствует в запросе, то его значение будет создано автоматически на стороне сервера

qrCodeKinit - Значение QR кода

serviceUrl - URL для взаимодействия с my

deviceName - Читаемое название устройства

pushData - Данные для получения PUSH-уведомлений

callback - При успешном выполнении возвращает созданный объект пользователя User. Иначе возвращает ошибку типа Error или NetworkError

createUserWithApproval

public static void createUserWithApproval(java.lang.String externalId,
                                          java.lang.String alias,
                                          java.lang.String serviceUrl,
                                          java.lang.String deviceName,
                                          PushNotificationData pushData,
                                          java.lang.String uid,
                                          UserCallback callback)

Создание запроса на подключение другого устройства к учётной записи пользователя.
Запускает процесс добавления устройства, где в ответ на данный запрос формирует "вектор аутентификации" и передаёт его на данное устройство.
Подтверждение с другого устройства выполняется через получение списка устройств методом DevicesManager.listDevices(User, DevicesNetworkCallback), нахождением в списке устройства с заданным kid и вызовом методов DevicesManagerNonQual.approve(User, Device, NetworkCallback) или DevicesManagerNonQual.reject(User, Device, NetworkCallback) для подтверждения или отклонения запроса на регистрацию соответственно.
В результате выполнения функции получаем объект User, не сохраненный в БД.

Parameters:

externalId - Желаемое имя пользователя (login), имя пользователя может быть использовано вызывающей системой для управления учётной записью пользователя. Если данный параметр отсутствует в запросе, то его значение будет создано автоматически на стороне сервера

alias - Уникальный человекочитаемый идентификатор, используемый для подтверждения владения МУ пользователем. Если данный параметр отсутствует в запросе, то его значение будет создано автоматически на стороне сервера

serviceUrl - URL для взаимодействия с my

deviceName - Читаемое название устройства

pushData - Данные для получения PUSH-уведомлений

uid - Идентификатор добавляемого девайса

callback - При успешном выполнении возвращает созданный объект пользователя User. Иначе возвращает ошибку типа Error или NetworkError

store

public static void store(User user,
                         java.lang.String name,
                         java.lang.String password,
                         UserCallback callback)

Сохранение объекта пользователя в долгосрочную память (Shared Preferences).
После выполнения данной операции, учётная запись пользователя на сервере переводится в статус:

• Device.DeviceStatus.Installed, если устройство регистрировалось методом createUser(String, String, String, String, PushNotificationData, UserCallback)
• Device.DeviceStatus.NotVerified, если устройство регистрировалось методом createUserWithInitQR(String, String, QRCodeKinit, String, String, PushNotificationData, UserCallback)
• Device.DeviceStatus.ApproveRequired, если устройство регистрировалось методом createUserWithApproval(String, String, String, String, PushNotificationData, String, UserCallback)
• Device.DeviceStatus.Active, если объект User был получен из резервной копии методом restoreBackup(String, String, UserCallback)

Parameters:

user - Объект пользователя для сохранения

name - Уникальное дружественное имя для идентификации объекта в пределах SDK

password - Пароль для сохранения

callback - Реализация UserCallback для обработки результатов. При успехе возвращается объект User, сохранённый в долгосрочную память

store

public static void store(User user,
                         java.lang.String name,
                         UserCallback callback)

Сохранение объекта пользователя в долгосрочную память (Shared Preferences) с запуском пользовательского интерфейса для задания пароля средствами СДК.

• Device.DeviceStatus.Installed, если устройство регистрировалось методом createUser(String, String, String, String, PushNotificationData, UserCallback)
• Device.DeviceStatus.NotVerified, если устройство регистрировалось методом createUserWithInitQR(String, String, QRCodeKinit, String, String, PushNotificationData, UserCallback)
• Device.DeviceStatus.ApproveRequired, если устройство регистрировалось методом createUserWithApproval(String, String, String, String, PushNotificationData, String, UserCallback)
• Device.DeviceStatus.Active, если объект User был получен из резервной копии методом restoreBackup(String, String, UserCallback)

Parameters:

user - Объект пользователя для сохранения

name - Уникальное дружественное имя для идентификации объекта в пределах SDK

callback - Реализация UserCallback для обработки результатов. При успехе возвращается объект User, сохранённый в долгосрочную память

store

public static void store(Activity parentActivity,
                         User user,
                         java.lang.String name,
                         UserCallback callback)

Сохранение объекта пользователя в долгосрочную память (Shared Preferences) с запуском пользовательского интерфейса для задания пароля средствами СДК.

• Device.DeviceStatus.Installed, если устройство регистрировалось методом createUser(String, String, String, String, PushNotificationData, UserCallback)
• Device.DeviceStatus.NotVerified, если устройство регистрировалось методом createUserWithInitQR(String, String, QRCodeKinit, String, String, PushNotificationData, UserCallback)
• Device.DeviceStatus.ApproveRequired, если устройство регистрировалось методом createUserWithApproval(String, String, String, String, PushNotificationData, String, UserCallback)
• Device.DeviceStatus.Active, если объект User был получен из резервной копии методом restoreBackup(String, String, UserCallback)

Parameters:

parentActivity - Экземпляр Activity приложения, с которого будет запущено Activity из SDK. При этом Activity из SDK добавляется в стек той же задачи, в которой запущена parentActivity. Если указать null, то Activity из SDK будет запущена отдельной задачей из контекста приложения, переданного при инициализации

user - Объект пользователя для сохранения

name - Уникальное дружественное имя для идентификации объекта в пределах SDK

callback - Реализация UserCallback для обработки результатов. При успехе возвращается объект User, сохранённый в долгосрочную память

submitPassword

public static void submitPassword(User user,
                                  java.lang.String password,
                                  UserCallback callback)

Предъявление пароля. После успешного выполнения User.isReadyToSign() возвращает true, необходимо вызывать данный метод перед выполнением любых других методов, требующих условия User.isReadyToSign() == true, если на момент вызова условие не выполняется.

Parameters:

user - Объект пользователя, чей "вектор аутентификации" будет расшифрован

password - Пароль

callback - Реализация интерфейса UserCallback для обработки результатов. В случае успеха возвращается обновленный объект User

changePassword

@Deprecated
public static void changePassword(User user,
                                              java.lang.String newPassword,
                                              UserCallback callback)

Deprecated.

Сохранение ключа с новым паролем на "вектор аутентификации". Перед вызовом метода должно выполняться условие User.isReadyToSign() == true.

Parameters:

user - Объект User, для которого необходимо сменить пароль

newPassword - Новый пароль

callback - При успешном выполнении возвращает созданный объект пользователя User. Иначе возвращает ошибку типа Error или NetworkError

changePassword

public static void changePassword(User user,
                                  java.lang.String oldPassword,
                                  java.lang.String newPassword,
                                  UserCallback callback)

Сохранение ключа с новым паролем на "вектор аутентификации". Перед вызовом метода должно выполняться условие User.isReadyToSign() == true.

Parameters:

user - Объект User, для которого необходимо сменить пароль

oldPassword - Старый пароль

newPassword - Новый пароль

callback - При успешном выполнении возвращает созданный объект пользователя User. Иначе возвращает ошибку типа Error или NetworkError

acceptAccountChanges

public static void acceptAccountChanges(User user,
                                        QRCodeVerification qrCodeVerification,
                                        UserCallback callback)

Подтверждение присоединения мобильного устройства к учётной записи пользователя.
Выполнение возможно только при статусе учетной записи Device.DeviceStatus.NotVerified.
Перед выполнением необходимо выполнить UsersManager.updateStatus(User, UserCallback) для получения актуального статуса учетной записи пользователя.
При успешном выполнении учетная запись пользователя на сервере переводится в статус Device.DeviceStatus.Active.
Перед вызовом необходимо проверить, что метод User.isReadyToSign() возвращает true.

Parameters:

user - Целевой объект User

qrCodeVerification - Данные QR-кода для подтверждения изменений. Если при подтверждении изменения данных профиля не требуется сканировать QR-код (метод User.qRVerificationRequired() возвращает false), необходимо передать null

callback - Реализация UserCallback для обработки результатов. При успехе возвращается объект User со статусом Device.DeviceStatus.Active

checkApprovalStatus

public static void checkApprovalStatus(User user,
                                       UserCallback callback)

Отправляет запрос на получение сведений о статусе регистрации нового устройства пользователя.
Может быть вызван только после того, как был вызван метод store(User, String, String, UserCallback).

Parameters:

user - Объект User, для которого нужно проверить, был ли одобрен запрос на присоединение данного устройства на другом устройстве

callback - Реализация UserCallback для обработки результатов. При успехе возвращается объект User с обновленным статусом

revoke

public static void revoke(User user,
                          NetworkCallback callback)

Отзыв "вектора аутентификации" на сервере. Делает вектор недействительным.
Перед вызовом метода должно выполняться условие User.isReadyToSign() == true.

Parameters:

user - Объект пользователя чей "вектора аутентификации" будет отозван

callback - Реализация NetworkCallback для обработки результатов

createBackup

public static void createBackup(User user,
                                java.lang.String recoveryPassword,
                                UserBackupCallback callback)

Экспорт данных пользователя в JSON с шифрованием при помощи указанного пароля.
Основная область применения функции — создание резервной копии ключевой информации для возможности последующего восстановления в случае переустановки приложения, смены устройства, утраты ПИН-кода и прочих подобных ситуациях. Перед вызовом метода должно выполняться условие User.isReadyToSign() == true.

Parameters:

user - Объект User, данные которого сохраняются

recoveryPassword - Пароль, при помощи которого будет осуществлено шифрование экспортируемых данных. Данный пароль потребуется при восстановлении объекта User

callback - Реализация UserBackupCallback для обработки результатов

restoreBackup

public static void restoreBackup(java.lang.String backup,
                                 java.lang.String recoveryPassword,
                                 UserCallback callback)

Восстановление объекта User из резервной копии

Parameters:

backup - Резервная копия ключа, созданная функцией createBackup(User, String, UserBackupCallback)

recoveryPassword - Пароль для восстановления. Должен совпадать с паролем, использованным при создании резервной копии

callback - Реализация UserCallback для обработки результатов

renew

public static void renew(User user,
                         java.lang.String newName,
                         java.lang.String deviceName,
                         java.lang.String password,
                         UserCallback callback)

Перерегистрация пользователя на этом же устройстве.

Parameters:

user - Объект пользователя

newName - Новое имя ключа для использования внутри приложения (не передаётся на сервер) Если null, то будет использовано имя из объекта пользователя User

deviceName - Читаемое название устройства

password - Текущий пароль пользователя

callback - При успешном выполнении возвращает созданный объект пользователя User. Иначе возвращает ошибку типа Error или NetworkError