ru.stcrypt.ckey.sdk.v1

Class BaseCertificatesManagerNonQual

java.lang.Object

_CallbackInvoker

ru.stcrypt.ckey.sdk.v1.BaseCertificatesManagerNonQual

Direct Known Subclasses:

CertificatesManagerNonQual

public abstract class BaseCertificatesManagerNonQual
extends _CallbackInvoker

Предоставляет методы для работы с сертификатами в .
Предназначен для использования в режиме неквалифицированной подписи. От этого класса не следует наследоваться, он необходим самой SDK КриптоКлюча.

Constructor Summary

Constructors

Constructor and Description
BaseCertificatesManagerNonQual()

Method Summary

Modifier and Type	Method and Description
static void	createCertificate(User user, int caId, java.lang.String templateId, java.util.Map<java.lang.String,java.lang.String> dn, boolean isClient, CertificateNetworkCallback callback) Создание запроса на сертификат. Перед вызовом метода должно выполняться условие User.isReadyToSign() == true.
static void	createCertificate(User user, int caId, java.lang.String templateId, java.util.Map<java.lang.String,java.lang.String> dn, CertificateNetworkCallback callback) Создание запроса на сертификат, ключи которого хранятся на клиенте. Перед вызовом метода должно выполняться условие User.isReadyToSign() == true.
static void	deletePfx(User user, Certificate certificate, DeletePfxCallback callback) Удаление архивной копии ключей, ранее созданной на сервере .
static void	exportPfx(User user, Certificate certificate, java.lang.String containerPin, java.lang.String pfxPin, ExportPfxCallback callback) Выполняет архивацию (резервное копирование) на сервере ключей подписи, хранящихся на данном мобильном устройстве.
static void	importPfx(User user, Certificate certificate, java.lang.String containerPin, java.lang.String pfxPin, ImportPfxCallback callback) Восстановление ключей подписи на мобильном устройстве из резервной копии, хранимой на сервере . Перед вызовом метода должно выполняться условие User.isReadyToSign() == true.
static void	installCertificate(User user, Certificate certificate, KeyInfo keyInfo, KeysSource keysSource, UserCallback callback) Производит установку сертификата в контейнер.
static void	installCertificate(User user, Certificate certificate, UserCallback callback) Производит установку сертификата в контейнер, содержащий ключ, которым ранее был подписан соответствующий запрос на сертификат
static Error	isCertificateAccessibleOnThisDevice(User user, Certificate certificate) Определяет, возможно ли использовать сертификат для подтверждения операций на этом устройстве
static Error	isCertificateInstalled(User user, Certificate certificate) Определяет, установлен ли сертификат в хранилище
static void	signCertificateRequest(Activity parentActivity, User user, Certificate request, KeysSourceIdentifier keysSourceIdentifier, SignCertificateRequestCallback callback) Выполняет подписание запроса на сертификат, после чего отправляет подписанный запрос на сервер.
static void	signCertificateRequest(User user, Certificate req, KeyInfo keyInfo, KeysSource keysSource, SignCertificateRequestCallback callback) Выполняет подписание запроса на сертификат, после чего отправляет подписанный запрос на сервер Перед вызовом метода должно выполняться условие User.isReadyToSign() == true.
static void	signCertificateRequest(User user, Certificate request, KeysSourceIdentifier keysSourceIdentifier, SignCertificateRequestCallback callback) Выполняет подписание запроса на сертификат, после чего отправляет подписанный запрос на сервер.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseCertificatesManagerNonQual

public BaseCertificatesManagerNonQual()

Method Detail

createCertificate

public static void createCertificate(User user,
                                     int caId,
                                     java.lang.String templateId,
                                     java.util.Map<java.lang.String,java.lang.String> dn,
                                     CertificateNetworkCallback callback)

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

Parameters:

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

caId - Идентификатор УЦ

templateId - Идентификатор шаблона сертификата

dn - Различительное имя субъекта, где в формате OID компонента имени -> Значение компонента имени

callback - Реализация CertificateNetworkCallback для обработки результатов. При успехе возвращается объект Certificate, содержащий данные запроса или сертификата

createCertificate

public static void createCertificate(User user,
                                     int caId,
                                     java.lang.String templateId,
                                     java.util.Map<java.lang.String,java.lang.String> dn,
                                     boolean isClient,
                                     CertificateNetworkCallback callback)

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

Parameters:

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

caId - Идентификатор УЦ

templateId - Идентификатор шаблона сертификата

dn - Различительное имя субъекта, где в формате OID компонента имени -> Значение компонента имени

isClient - Тип хранения закрытого ключа сертификата: на сервере или на клиенте (true - закрытый ключ сгенерирован и хранится на данном мобильном устройстве)

callback - Реализация CertificateNetworkCallback для обработки результатов. При успехе возвращается объект Certificate, содержащий данные запроса или сертификата

signCertificateRequest

public static void signCertificateRequest(User user,
                                          Certificate req,
                                          KeyInfo keyInfo,
                                          KeysSource keysSource,
                                          SignCertificateRequestCallback callback)

Выполняет подписание запроса на сертификат, после чего отправляет подписанный запрос на сервер
Перед вызовом метода должно выполняться условие User.isReadyToSign() == true.

Parameters:

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

req - Объект Certificate, содержащий запрос на сертификат

keyInfo - Ключ, которым будет подписан запрос

keysSource - Информация о хранилище ключевой пары

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

installCertificate

public static void installCertificate(User user,
                                      Certificate certificate,
                                      KeyInfo keyInfo,
                                      KeysSource keysSource,
                                      UserCallback callback)

Производит установку сертификата в контейнер. Метод применяется над объектом User со статусом Device.DeviceStatus.Active для установки сертификата. Метод так же применяется над объектом User со статусом Device.DeviceStatus.Installed

Parameters:

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

certificate - Объект Certificate, который необходимо установить. Если статус User равен Device.DeviceStatus.Active, то должно выполняться условия:
1. Certificate.getCertificateId() должен быть означен
2. Certificate.getState() должен быть Certificate.State.active либо Certificate.State.out_of_order
Если статус User равен Device.DeviceStatus.Installed и выполняется сценарий регистрации, то должно выполняться условия:
1. Certificate.getType() должен быть Certificate.Type.Req
2. Certificate.getContent() должен быть означен
3. Certificate.getState() должен быть Certificate.State.pending

keyInfo - Объект KeyInfo, содержащий ссылку на контейнер, куда будет установлен сертификат

keysSource - Информация о хранилище ключей

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

isCertificateInstalled

public static Error isCertificateInstalled(User user,
                                           Certificate certificate)

Определяет, установлен ли сертификат в хранилище

Parameters:

user - Целевой User

certificate - Целевой Certificate

Returns:

Объект Error, у которого getType() равен Error.ERROR_OK если сертификат был установлен, либо ошибку

isCertificateAccessibleOnThisDevice

public static Error isCertificateAccessibleOnThisDevice(User user,
                                                        Certificate certificate)

Определяет, возможно ли использовать сертификат для подтверждения операций на этом устройстве

Parameters:

user - Целевой User

certificate - Целевой Certificate

Returns:

true, если сертификат может быть использован на этом устройстве

exportPfx

public static void exportPfx(User user,
                             Certificate certificate,
                             java.lang.String containerPin,
                             java.lang.String pfxPin,
                             ExportPfxCallback callback)

Выполняет архивацию (резервное копирование) на сервере ключей подписи, хранящихся на данном мобильном устройстве. После выполнения архивации сохранённые на сервере ключи можно восстановить на этом же устройстве, либо выполнить восстановление на другом устройстве при условии, что устройство привязано к той же учётной записи.
Перед вызовом метода должно выполняться условие User.isReadyToSign() == true. Метод может отсутствовать, если нет возможности выполняет архивацию.

Parameters:

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

certificate - Объект Certificate, для которого выполняется архивация. Ключи подписи должны храниться на данном устройстве, а сертификат должен быть установлен и не архивирован ранее. Таким образом, необходимо выполнение каждого из условий:

1. isCertificateInstalled(User, Certificate) == true
2. Certificate.isArchived() == false

containerPin - Пин-код на ключевой контейнер, который был указан при создании ключевой пары или null, если при создании ключевой пары использовался пин-код по умолчанию

pfxPin - Пин-код для защиты архивированного на сервере PFX. Данный пин-код потребуется при восстановлении ключей из архивированного PFX. Можно указать null, и тогда будет использован пин-код по умолчанию

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

importPfx

public static void importPfx(User user,
                             Certificate certificate,
                             java.lang.String containerPin,
                             java.lang.String pfxPin,
                             ImportPfxCallback callback)

Восстановление ключей подписи на мобильном устройстве из резервной копии, хранимой на сервере .
Перед вызовом метода должно выполняться условие User.isReadyToSign() == true. Метод может отсутствовать, если нет возможности выполнять восстановление.

Parameters:

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

certificate - Объект Certificate, для которого выполняется импорт ключей. При этом импортируемые ключи не должны быть уже сохранены на данном устройстве, а для сертификата должен быть выставлен флаг, что ранее была произведена архивация на сервер. Таким образом, перед импортом ключей необходима поверка следующих условий:

1. isCertificateAccessibleOnThisDevice(User, Certificate) == false
2. Certificate.isArchived() == true

containerPin - Пин-код для защиты создаваемого ключевого контейнера. При указании null будет использован пин-код по умолчанию

pfxPin - Пин-код для расшифрования ранее экспортированного Pfx. Должен совпадать с пин-кодом, указанным в методе exportPfx(User, Certificate, String, String, ExportPfxCallback)

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

deletePfx

public static void deletePfx(User user,
                             Certificate certificate,
                             DeletePfxCallback callback)

Удаление архивной копии ключей, ранее созданной на сервере
. Метод может отсутствовать, если нет возможности выполнять удаление.
Перед вызовом метода должно выполняться условие User.isReadyToSign() == true.

Parameters:

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

certificate - Объект Certificate, для которого необходимо удалить ключи

callback - Реализация интерфейса DeletePfxCallback для обработки результатов

signCertificateRequest

public static void signCertificateRequest(User user,
                                          Certificate request,
                                          KeysSourceIdentifier keysSourceIdentifier,
                                          SignCertificateRequestCallback callback)

Выполняет подписание запроса на сертификат, после чего отправляет подписанный запрос на сервер. Для подписания запроса создаёт новую ключевую пару. Для создания локальной ключевой пары запускается биологический датчик случайных чисел, кроме того, предварительно запрашивается пароль, если не выполняется условие User.isReadyToSign() == true. Если ключевая пара создаётся на внешнем носителе, запрашивается ПИН-код доступа к нему.

Parameters:

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

request - Объект Certificate, содержащий запрос на сертификат

keysSourceIdentifier - Информация о хранилище ключей KeysSourceIdentifier. На текущий момент SDK поддерживает значения KeysSourceIdentifier.localGeneric и KeysSourceIdentifier.rutokenNFC

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

signCertificateRequest

public static void signCertificateRequest(Activity parentActivity,
                                          User user,
                                          Certificate request,
                                          KeysSourceIdentifier keysSourceIdentifier,
                                          SignCertificateRequestCallback callback)

Выполняет подписание запроса на сертификат, после чего отправляет подписанный запрос на сервер. Для подписания запроса создаёт новую ключевую пару. Для создания локальной ключевой пары запускается биологический датчик случайных чисел, кроме того, предварительно запрашивается пароль, если не выполняется условие User.isReadyToSign() == true. Если ключевая пара создаётся на внешнем носителе, запрашивается ПИН-код доступа к нему.

Parameters:

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

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

request - Объект Certificate, содержащий запрос на сертификат

keysSourceIdentifier - Информация о хранилище ключей KeysSourceIdentifier. На текущий момент SDK поддерживает значения KeysSourceIdentifier.localGeneric и KeysSourceIdentifier.rutokenNFC

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

installCertificate

public static void installCertificate(User user,
                                      Certificate certificate,
                                      UserCallback callback)

Производит установку сертификата в контейнер, содержащий ключ, которым ранее был подписан соответствующий запрос на сертификат

Parameters:

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

certificate - Объект Certificate, который необходимо установить.

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