Класс Cert

Класс управляет действиями по работе с сертификатами.

Метод getCert

Создание запроса на сертификат ключа проверки электронной подписи.

public void getCert(
    @NonNull Context context, 
    @NonNull String kid, 
    int caId, 
    @NonNull String tId, 
    @NonNull Map<String, String> dn, 
    @NonNull final SdkCertificateCallback sdkCertificateCallback)

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
caId	Int	Идентификатор обработчика УЦ
tId	String	Идентификатор шаблона сертификата
dn	[String: String]	Различительное имя субъекта в формате {"OID компонента имени", "Значение компонента имени"}
callback	SdkCertificateCallback	Интерфейс обратного вызова

Возвращаемые параметры:

Параметр	Тип	Описание
cert	Certificate	Сведения о созданном запросе на сертификат или сертификате

Примечание

Метод отображает UI ввода пароля для доступа к ключам аутентификации.

Метод getCertEx

Создание запроса на сертификат ключа проверки электронной подписи.

public void getCertEx(
    @NonNull Context context, 
    @NonNull String kid, 
    int caId, 
    @NonNull String tId, 
    @NonNull Map<String, String> dn, 
    Map<String, String> reqParams,
    @NonNull final SdkCertificateCallback sdkCertificateCallback)

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
caId	Int	Идентификатор обработчика УЦ
tId	String	Идентификатор шаблона сертификата
dn	[String: String]	Различительное имя субъекта в формате {"OID компонента имени", "Значение компонента имени"}
reqParams	[String: String]	Дополнительные параметры запроса на сертификат
callback	SdkCertificateCallback	Интерфейс обратного вызова

Возвращаемые параметры:

Параметр	Тип	Описание
cert	Certificate	Сведения о созданном запросе на сертификат или сертификате

Примечание

Метод отображает UI ввода пароля для доступа к ключам аутентификации.

При создании запроса на сертификат из мобильного приложения расширения, которые требуется добавить в сертификат, должны быть переданы через дополнительные параметры reqParams в ключе ExtensionsData. Описание значения ключа ExtensionsData приведено в разделе Расширения сертификата.

Метод setCert

Установка сертификата ключа проверки электронной подписи.

public void setCert(
        @NonNull Context context, 
        @NonNull String kid, 
        @NonNull String crt, 
        @NonNull final SdkCertificateCallback sdkCallback)

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
сrt	String	Сертификат, закодированный в base64
callback	SdkCertificateCallback	Интерфейс обратного вызова

Возвращаемые параметры:

Параметр	Тип	Описание
cert	Certificate	Сведения о созданном запросе на сертификат

Метод getCertList

Получение списка запросов на сертификаты и списка сертификатов ключей проверки электронной подписи.

public void getCertList(
        @NonNull Context context, 
        @NonNull String kid, 
        @NonNull final SdkCertificateListCallback certCallback)

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя

Возвращаемые параметры:

Параметр	Тип	Описание
certs	[Certificate]	Список сертификатов и запросов на сертификат пользователя

Метод setNameCert

Установка отображаемого имени сертификата ключа проверки электронной подписи.

public void setNameCert(
    @NonNull Context context, 
    @NonNull String kid, 
    @NonNull String cid, 
    @NonNull String friendlyName, 
    @NonNull final SdkCallback sdkCallback)

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
cid	String	Идентификатор сертификата
friendlyName	String	Отображаемое имя сертификата
callback	SdkCallback	Интерфейс обратного вызова

Метод suspendCert

Приостановление действия сертификата ключа проверки электронной подписи.

public void suspendCert(
    @NonNull Context context, 
    @NonNull String kid, 
    @NonNull String cid, 
    long holdDate, 
    long unholdDate, 
    @NonNull final SdkCallback sdkCallback)

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
cid	String	Идентификатор сертификата
holdDate	Int32	Дата приостановления сертификата. 0 — если требуется немедленное приостановление сертификата, конкретная дата — если требуется отложенное приостановление сертификата
unholdDate	Int32	Дата возобновления действия сертификата
callback	SdkCallback	Интерфейс обратного вызова

Примечание

Метод отображает UI ввода пароля для доступа к ключам аутентификации.

Метод resumeCert

Возобновление действия сертификата ключа проверки электронной подписи.

public void resumeCert(
    @NonNull Context context, 
    @NonNull String kid, 
    @NonNull String cid, 
    @NonNull final SdkCallback sdkCallback)

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
cid	String	Идентификатор сертификата

Примечание

Метод отображает UI ввода пароля для доступа к ключам аутентификации.

Метод revokeCert

Отзыв сертификата ключа проверки электронной подписи.

public void revokeCert(
    @NonNull Context context, 
    @NonNull String kid, 
    @NonNull String cid, 
    int reason, 
    long date, 
    @NonNull final SdkCallback sdkCallback)

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
cid	String	Идентификатор сертификата
reason	CertRevokeReason	Причина отзыва сертификата
date	Int32	Дата отзыва сертификата. 0 - если требуется немедленный отзыв сертификата, конкретная дата - если требуется отложенный отзыв.
callback	SdkCallback	Интерфейс обратного вызова

Примечание

Метод отображает UI ввода пароля для доступа к ключам аутентификации.

Метод setDefaultCert

Метод устанавливает сертификат как сертификат по умолчанию.

public void setDefaultCert(
    @NonNull Context context, 
    @NonNull String kid, 
    @NonNull String cid, 
    boolean _default, 
    @NonNull final SdkCallback sdkCallback)

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
cid	String	Идентификатор сертификата
_default	Bool	Флаг использования сертификата как сертификата по умолчанию
callback	SdkCallback	Интерфейс обратного вызова

Метод deleteCert

Метод удаляет сертификат ключа проверки электронной подписи.

public void deleteCert(
    @NonNull Context context, 
    @NonNull String kid, 
    @Nullable String cid, 
    @Nullable String rid, 
    @NonNull final SdkCallback sdkCallback)

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
cid	String	Идентификатор сертификата
rid	String	Идентификатор запроса на сертификат
callback	SdkCallback	Интерфейс обратного вызова

Примечание

Метод отображает UI ввода пароля для доступа к ключам аутентификации.

Метод getClientCert

Создание неподписанного запроса на сертификат и отправка его на сервер для синхронизации.

public void getClientCert(
    @NonNull Context context, 
    @NonNull String kid, 
    int caId, 
    @NonNull String tId,
    @NonNull Map<String, String> dn, 
    @NonNull final SdkCertificateCallback sdkCertificateCallback)

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
rid	String	Идентификатор запроса на сертификат
caId	Int	Идентификатор обработчика УЦ
tId	String	Идентификатор шаблона сертификата
dn	[String: String]	Различительное имя субъекта в формате {"OID компонента имени", "Значение компонента имени"}
callback	SdkCertificateCallback	Интерфейс обратного вызова

Возвращаемые параметры:

Параметр Описание
Certificate

Метод getClientCertEx

Создание запроса на сертификат ключа проверки электронной подписи.

public void getClientCertEx(
    @NonNull Context context, 
    @NonNull String kid, 
    int caId, 
    @NonNull String tId, 
    @NonNull Map<String, String> dn, 
    Map<String, String> reqParams,
    @NonNull final SdkCertificateCallback sdkCertificateCallback)

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
caId	Int	Идентификатор обработчика УЦ
tId	String	Идентификатор шаблона сертификата
dn	[String: String]	Различительное имя субъекта в формате {"OID компонента имени", "Значение компонента имени"}
reqParams	[String: String]	Дополнительные параметры запроса на сертификат
callback	SdkCertificateCallback	Интерфейс обратного вызова

Возвращаемые параметры:

Параметр	Тип	Описание
cert	Certificate	Сведения о созданном запросе на сертификат или сертификате

При создании запроса на сертификат из мобильного приложения расширения, которые требуется добавить в сертификат, должны быть переданы через дополнительные параметры reqParams в ключе ExtensionsData. Описание значения ключа ExtensionsData приведено в разделе Расширения сертификата.

Метод createKeyAndSignRequest

Создание ключа подписи на мобильном устройстве или внешнем носителе и подписание запроса на сертификат без отправки на сервер.

public void createKeyAndSignRequest(
    @NonNull Context context,
    @Nullable String pin,
    @NotNull String kid,
    @NonNull Certificate certificate,
    @Nullable ProviderInfo providerInfo,
    boolean silent,
    @NonNull final SignCertRequestCallback sdkCertificateCallback)

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
certificate	Certificate	Сведения о созданном неподписанном запросе на сертификат
providerInfo	ProviderInfo	Сведения о криптопровайдере
pin	String	ПИН-код на ключ подписи

Возвращаемые параметры:

Параметр	Тип	Описание
cert	Certificate	Подписанный сертификат (запрос на сертификат для офлайн-режима)

Примечание

Метод отображает UI датчика случайных чисел для создания ключа подписи пользователя и экран ввода пароля для доступа к ключам аутентификации.

Метод signRequest

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

public void signRequest(
    @NonNull Context context,
    @NonNull String kid,
    @Nullable String pin,
    @NonNull Certificate certificate,
    @Nullable ProviderInfo providerInfo,
    boolean silent,
    @NonNull final SdkCertificateCallback sdkCertificateCallback)

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
cert	Certificate	Сведения о созданном неподписанном запросе на сертификат
providerInfo	ProviderInfo	Сведения о криптопровайдере
callback	SdkCertificateCallback	Интерфейс обратного вызова

Возвращаемые параметры:

Параметр	Тип	Описание
Data	Data	Подписанный запрос на сертификат, закодированный в Base64

Примечание

Метод отображает UI датчика случайных чисел для создания ключа подписи пользователя или экран NFC.

Метод sendSignRequest

Отправка подписанного запроса на сертификат на сервер для синхронизации.

public void sendSignRequest(
        @NonNull Context context,
        @NonNull String kid,
        @NonNull Certificate certificate,
        byte[] signCertRequest,
        String pin,
        @NonNull ProviderInfo providerInfo,
        @NonNull final SdkCertificateCallback sdkCertificateCallback)

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
cert	Certificate	Сведения о запросе на сертификат
caId	Int	Идентификатор обработчика УЦ
signCertRequest	byte[]	Подписанный запрос на сертификат, закодированный в Base64
callback	SdkCertificateCallback	Интерфейс обратного вызова

Возвращаемые параметры:

Параметр	Тип	Описание
cert	Certificate	Сведения о подписанном сертификате (запросе на сертификат для офлайн-режима)

Примечание

Метод отображает UI ввода пароля для доступа к ключам аутентификации.

Метод installCertificate

Установка сертификата в ключевой контейнер на мобильном устройстве или внешнем носителе и отправка его на сервер для синхронизации.

public void installCertificate(
            @NonNull Context context,
            @NonNull Certificate certificate,
            @NonNull byte[] crtBytes,
            @NonNull String pin,
            @NonNull final SdkCallback sdkCallback
    )

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
cert	Certificate	Сведения о запросе на сертификат, который требуется установить
crtBytes	byte[]	Сертификат, который требуется установить
pin	String	ПИН-код на контейнер закрытого ключа (опционально)
callback	SdkCallback	Интерфейс обратного вызова

Примечание

Метод отображает UI ввода пароля для доступа к ключам аутентификации.

Метод installCertificateExternal

Установка сертификата в мобильное устройство с внешнего носителя (NFC) и отправка его на сервер для синхронизации.

public void installCertificateExternal(
            @NonNull Context context,
            @NonNull String kid,
            @NonNull SigningKeyInfo signingKeyInfo,
            @NonNull Certificate certificate,
            SdkCertificateCallback sdkCertificateCallback
    )

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
crt	Certificate	Сведения и содержимое сертификата, который требуется установить
keyInfo	SigningKeyInfo	Сведения о ключевом контейнере (ключе подписи), установленном на мобильное устройство
callback	SdkCertificateCallback	Интерфейс обратного вызова

Возвращаемые параметры:

Параметр	Тип	Описание
cert	Certificate	Сведения об установленном сертификате

Примечание

Метод отображает UI ввода пароля для доступа к ключам аутентификации.

Метод changeRutokenPin

Смена ПИН-кода внешнего носителя (Рутокен).

Внимание!

Метод недоступен в silent-режиме.

public void changeKeyPin(
        @NotNull Context context, 
        int cid, 
        SdkCallback callback)

Параметры:

Параметр	Тип	Описание
cid	String	Идентификатор сертификата
callback	SdkCallback	Интерфейс обратного вызова

Метод forgetKeyPin

Удаление сохранённого ПИН-кода внешнего носителя (Рутокен).

Внимание!

Метод недоступен в silent-режиме.

public void forgetKeyPin(
        Context context, 
        int cid, 
        SdkCallback callback)

Параметры:

Параметр	Тип	Описание
cid	String	Идентификатор сертификата
callback	SdkCallback	Интерфейс обратного вызова

Метод checkIfInstalled

Проверка, установлен ли сертификат в ключевой контейнер на мобильном устройстве.

public boolean checkIfInstalled(
        @NonNull Context context, 
        @NonNull Certificate certificate)

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
certificate	Certificate	Сведения о сертификате

Возвращаемые параметры:

• True/False

Метод checkIfAccessibleOnThisDevice

Проверка доступности ключа подписи (существования ключевого контейнера).

public boolean checkIfAccessibleOnThisDevice(
    @NonNull Context context, 
    int cid, 
    int rid)

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
rid	String	Идентификатор запроса на сертификат
cid	String	Идентификатор сертификата

Возвращаемые параметры:

• True/False

Архивирование ключа подписи

Метод deletePFX

Удаление архивного ключа подписи с сервера.

public void deleteArchive(
    Context context, 
    @NonNull String kid, 
    int cid, 
    boolean isSilent, 
    @NonNull String authKeyPwd, 
    SdkCallback sdkCallback)

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
cid	String	Идентификатор сертификата
callback	SdkCallback	Интерфейс обратного вызова

Примечание

Метод отображает UI ввода пароля для доступа к ключам аутентификации.

Метод restoreFromArchive

Импорт архивного ключа подписи с сервера в ключевой контейнер устройства.

public void restoreFromArchive(
    Context context, 
    @NonNull String kid, 
    int cid,
    boolean isSilent, 
    boolean isExportable, 
    @NonNull String authKeyPwd, 
    @Nullable String pin, 
    @Nullable String archivePwd, 
    SdkCallback sdkCallback)

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
cid	String	Идентификатор сертификата
pin	String	ПИН-код архивного ключа подписи
keyContainerType	CryptoKeyContainerType	Тип ключевого контейнера
callback	SdkCallback	Интерфейс обратного вызова

Примечание

Метод отображает UI ввода пароля для доступа к ключам аутентификации.

Метод archive

Архивирование ключа подписи на сервере.

public void archive(
    Context context, 
    @NonNull String kid, 
    int cid, 
    boolean isSilent, 
    @NonNull String authKeyPwd, 
    @Nullable String pin,
    @Nullable String archivePwd, 
    SdkCallback sdkCallback)

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
cid	String	Идентификатор сертификата
pin	String	ПИН-код архивного ключа подписи
callback	SdkCallback	Интерфейс обратного вызова

Примечание

Метод отображает UI ввода пароля для доступа к ключам аутентификации.