Класс Cert

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

Метод getCert

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

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

Параметры:

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

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

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

Примечание

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

Метод getCertEx

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

public void getCertEx(
    @NotNull Context context, 
    @NotNull String kid, 
    int caId, 
    @NotNull String tId, 
    @NotNull Map<String, String> dn, 
    @Nullable Map<String, String> reqParams,
    @NotNull final SdkResultCallback<Certificate> sdkCertificateCallback)

Параметры:

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

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

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

Примечание

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

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

Метод setCert

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

public void setCert(
        @NotNull Context context, 
        @NotNull String kid, 
        @NotNull String crt, 
        @NotNull final SdkResultCallback<Certificate> sdkCallback)

Параметры:

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

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

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

Метод deleteCert

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

public void deleteCert(
    @NotNull Context context, 
    @NotNull String kid, 
    @Nullable String cid, 
    @Nullable String rid, 
    @NotNull final SdkResultCallback<Boolean> sdkCallback)

Параметры:

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

Примечание

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

Метод getCertList

Получение списка запросов на сертификаты и списка сертификатов пользователя.

public void getCertList(
        @NotNull Context context, 
        @NotNull String kid, 
        @NotNull final SdkResultCallback<List<Certificate>> certCallback)

Параметры:

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

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

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

Метод setNameCert

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

public void setNameCert(
    @NotNull Context context, 
    @NotNull String kid, 
    @NotNull String cid, 
    @NotNull String friendlyName, 
    @NotNull final SdkResultCallback<Boolean> sdkCallback)

Параметры:

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

Метод revokeCert

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

public void revokeCert(
    @NotNull Context context, 
    @NotNull String kid, 
    @NotNull String cid, 
    int reason, 
    long date, 
    @NotNull final SdkResultCallback<Boolean> sdkCallback)

Параметры:

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

Примечание

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

Метод setDefaultCert

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

public void setDefaultCert(
    @NotNull Context context, 
    @NotNull String kid, 
    @NotNull String cid, 
    boolean _default, 
    @NotNull final SdkResultCallback<Boolean> sdkCallback)

Параметры:

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

Метод getClientCert

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

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

Параметры:

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

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

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

Метод getClientCertEx

Создание запроса на сертификат (расширенное использование).

public void getClientCertEx(
    @NotNull Context context, 
    @NotNull String kid, 
    int caId, 
    @NotNull String tId, 
    @NotNull Map<String, String> dn, 
    @Nullable Map<String, String> reqParams,
    @NotNull final SdkResultCallback<Certificate> sdkCertificateCallback)

Параметры:

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

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

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

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

Метод signRequest

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

public void signRequest(
    @NotNull Context context,
    @NotNull String kid,
    @Nullable String pin,
    @NotNull Certificate certificate,
    @Nullable ProviderInfo providerInfo,
    boolean silent,
    @NotNull final SdkResultCallback<Certificate> sdkCertificateCallback)

Параметры:

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

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

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

Примечание

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

Метод createKeyAndSignRequest

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

public void createKeyAndSignRequest(
    @NotNull Context context,
    @Nullable String pin,
    @NotNull String kid,
    @NotNull Certificate certificate,
    @Nullable ProviderInfo providerInfo,
    boolean silent,
    @NotNull final SdkResultCallback<Byte[]> sdkCertificateCallback

Параметры:

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

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

Параметр	Тип	Описание
cert	Certificate	Подписанный сертификат в виде массива байт

Примечание

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

Метод sendSignRequest

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

public void sendSignRequest(
        @NotNull Context context,
        @NotNull String kid,
        @NotNull Certificate certificate,
        byte[] signCertRequest,
        String pin,
        @NotNull ProviderInfo providerInfo,
        @NotNull final SdkResultCallback<Certificate> sdkCertificateCallback

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
certificate	Certificate	Сведения о запросе на сертификат
caId	Int	Идентификатор обработчика УЦ
signCertRequest	byte[]	Подписанный запрос на сертификат, закодированный в Base64
pin	String	ПИН-код на ключевой контейнер
providerInfo	ProviderInfo	Сведения о криптопровайдере
callback	SdkResultCallback<Certificate>	Интерфейс обратного вызова

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

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

Примечание

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

Метод sendSignRequest

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

public void sendSignRequest(
        @NotNull Context context,
        @NotNull String kid,
        @NotNull Certificate certificate,
        byte[] signCertRequest,
        String pin,
        @NotNull ProviderInfo providerInfo,
        @Nullable HashMap<String, String> clientReqParams,
        @NotNull final SdkResultCallback<Certificate> sdkCertificateCallback

Параметры:

Параметр	Тип	Описание
kid	String	Идентификатор набора ключей пользователя
certificate	Certificate	Сведения о запросе на сертификат
caId	Int	Идентификатор обработчика УЦ
signCertRequest	byte[]	Подписанный запрос на сертификат, закодированный в Base64
pin	String	ПИН-код на ключевой контейнер
providerInfo	ProviderInfo	Сведения о криптопровайдере
clientReqParams	HashMap<String, String>	Дополнительные сведения о запросе. Параметр зарезервирован для будущего использования
callback	SdkResultCallback<Certificate>	Интерфейс обратного вызова

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

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

Примечание

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

Метод installCertificate

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

public void installCertificate(
            @NotNull Context context,
            @NotNull Certificate certificate,
            @NotNull byte[] crtBytes,
            @NotNull String pin,
            @NotNull final SdkResultCallback<Boolean> sdkCallback
    )

Параметры:

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

Примечание

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

Метод installCertificateExternal

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

public void installCertificateExternal(
            @NotNull Context context,
            @NotNull String kid,
            @NotNull SigningKeyInfo signingKeyInfo,
            @NotNull String content,
            SdkResultCallback<Certificate> sdkCallback
    )

Параметры:

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

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

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

Примечание

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

Метод checkIfInstalled

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

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

Параметры:

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

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

• True (установлен) / False (не установлен)

Метод checkIfAccessibleOnThisDevice

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

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

Параметры:

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

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

• True/False

Метод changeKeyPin

Смена ПИН-кода ключевого контейнера (внешний носитель USB/NFC).

Внимание!

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

public void changeKeyPin(
        @NotNull Context context, 
        int cid, 
        SdkResultCallback<Boolean> callback)

Параметры:

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

Метод forgetKeyPin

Удаление сохраненного ПИН-кода внешнего носителя (внешний носитель USB/NFC).

Внимание!

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

public void forgetKeyPin(
        @NotNull Context context, 
        int cid, 
        SdkResultCallback<Boolean> callback)

Параметры:

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