Класс Cert
Класс управляет действиями по работе с сертификатами.
Метод getCert
Создание запроса на сертификат ключа проверки электронной подписи.
fun getCert(
context: Context,
kid: String,
caId: Int,
tId: String,
dn: Map<String, String>,
sdkCertificateCallback: SdkResultCallback<Certificate>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| caId | Int | Идентификатор обработчика УЦ |
| tId | String | Идентификатор шаблона сертификата |
| dn | [String: String] | Различительное имя субъекта в формате {"OID компонента имени", "Значение компонента имени"} |
| callback | SdkResultCallback<Certificate> | Интерфейс обратного вызова |
Возвращаемые параметры:
| Параметр | Тип | Описание |
|---|---|---|
| cert | Certificate | Сведения о созданном запросе на сертификат или сертификате |
Примечание
Метод отображает UI ввода пароля для доступа к ключам аутентификации.
Метод getCert (suspend)
Создание запроса на сертификат ключа проверки электронной подписи.
suspend fun getCert(
context: Context,
kid: String,
caId: Int,
tId: String,
dn: Map<String, String>
): Certificate
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| caId | Int | Идентификатор обработчика УЦ |
| tId | String | Идентификатор шаблона сертификата |
| dn | [String: String] | Различительное имя субъекта в формате {"OID компонента имени", "Значение компонента имени"} |
Возвращаемые параметры:
| Параметр | Тип | Описание |
|---|---|---|
| cert | Certificate | Сведения о созданном запросе на сертификат или сертификате |
Примечание
Метод отображает UI ввода пароля для доступа к ключам аутентификации.
Метод getCertEx
Создание запроса на сертификат ключа проверки электронной подписи.
fun getCertEx(
context: Context,
kid: String,
caId: Int,
tId: String,
dn: Map<String, String>,
reqParams: Map<String, String>?,
sdkCertificateCallback: SdkResultCallback<Certificate>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| caId | Int | Идентификатор обработчика УЦ |
| tId | String | Идентификатор шаблона сертификата |
| dn | Map<String, String> | Различительное имя субъекта в формате {"OID компонента имени", "Значение компонента имени"} |
| reqParams | Map<String, String>? | Дополнительные параметры запроса на сертификат |
| callback | SdkResultCallback<Certificate> | Интерфейс обратного вызова |
Возвращаемые параметры:
| Параметр | Тип | Описание |
|---|---|---|
| cert | Certificate | Сведения о созданном запросе на сертификат или сертификате |
Примечание
Метод отображает UI ввода пароля для доступа к ключам аутентификации.
При создании запроса на сертификат из мобильного приложения расширения, которые требуется добавить в сертификат, должны быть переданы через
дополнительные параметры reqParams в ключе ExtensionsData. Описание значения ключа ExtensionsData приведено в разделе
Расширения сертификата.
Метод getCertEx (suspend)
Создание запроса на сертификат ключа проверки электронной подписи.
suspend fun getCertEx(
context: Context,
kid: String,
caId: Int,
tId: String,
dn: Map<String, String>,
reqParams: Map<String, String>?
): Certificate
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| caId | Int | Идентификатор обработчика УЦ |
| tId | String | Идентификатор шаблона сертификата |
| dn | Map<String, String> | Различительное имя субъекта в формате {"OID компонента имени", "Значение компонента имени"} |
| reqParams | Map<String, String>? | Дополнительные параметры запроса на сертификат |
Возвращаемые параметры:
| Параметр | Тип | Описание |
|---|---|---|
| cert | Certificate | Сведения о созданном запросе на сертификат или сертификате |
Примечание
Метод отображает UI ввода пароля для доступа к ключам аутентификации.
При создании запроса на сертификат из мобильного приложения расширения, которые требуется добавить в сертификат, должны быть переданы через
дополнительные параметры reqParams в ключе ExtensionsData. Описание значения ключа ExtensionsData приведено в разделе
Расширения сертификата.
Метод setCert
Установка сертификата ключа проверки электронной подписи.
fun setCert(
context: Context,
kid: String,
crt: String,
sdkCallback: SdkResultCallback<Certificate>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| сrt | String | Сертификат, закодированный в base64 |
| callback | SdkResultCallback<Certificate> | Интерфейс обратного вызова |
Возвращаемые параметры:
| Параметр | Тип | Описание |
|---|---|---|
| cert | Certificate | Сведения о созданном запросе на сертификат |
Метод setCert (suspend)
Установка сертификата ключа проверки электронной подписи.
suspend fun setCert(context: Context, kid: String, crt: String): Certificate
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| сrt | String | Сертификат, закодированный в base64 |
Возвращаемые параметры:
| Параметр | Тип | Описание |
|---|---|---|
| cert | Certificate | Сведения о созданном запросе на сертификат |
Метод deleteCert
Метод удаляет сертификат ключа проверки электронной подписи.
fun deleteCert(
context: Context,
kid: String,
cid: String?,
rid: String?,
sdkCallback: SdkResultCallback<Unit>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| cid | String? | Идентификатор сертификата |
| rid | String? | Идентификатор запроса на сертификат |
| callback | SdkResultCallback<Unit> | Интерфейс обратного вызова |
Примечание
Метод отображает UI ввода пароля для доступа к ключам аутентификации.
Метод deleteCert (suspend)
Метод удаляет сертификат ключа проверки электронной подписи.
suspend fun deleteCert(
context: Context,
kid: String,
cid: String?,
rid: String?
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| cid | String? | Идентификатор сертификата |
| rid | String? | Идентификатор запроса на сертификат |
Примечание
Метод отображает UI ввода пароля для доступа к ключам аутентификации.
Метод getCertList
Получение списка запросов на сертификаты и списка сертификатов пользователя.
fun getCertList(
context: Context,
kid: String,
certCallback: SdkResultCallback<List<Certificate>>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| callback | SdkResultCallback<List<Certificate>> | Интерфейс обратного вызова |
Возвращаемые параметры:
| Параметр | Тип | Описание |
|---|---|---|
| certs | List<Certificate> | Список сертификатов и запросов на сертификат пользователя |
Метод getCertList (suspend)
Получение списка запросов на сертификаты и списка сертификатов пользователя.
suspend fun getCertList(context: Context, kid: String): List<Certificate>
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
Возвращаемые параметры:
| Параметр | Тип | Описание |
|---|---|---|
| certs | List<Certificate> | Список сертификатов и запросов на сертификат пользователя |
Метод getCertListOffline
Получение списка сертификатов пользователя, подходящих для работы в офлайн-режиме.
fun getCertListOffline(
context: Context,
kid: String,
certCallback: SdkResultCallback<List<Certificate>>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| callback | SdkResultCallback<List<Certificate>> | Интерфейс обратного вызова |
Возвращаемые параметры:
| Параметр | Тип | Описание |
|---|---|---|
| certs | List<Certificate> | Список офлайн-сертификатов пользователя |
Метод getCertListOffline (suspend)
Получение списка сертификатов пользователя, подходящих для работы в офлайн-режиме.
suspend fun getCertListOffline(context: Context, kid: String): List<Certificate>
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
Возвращаемые параметры:
| Параметр | Тип | Описание |
|---|---|---|
| certs | List<Certificate> | Список офлайн-сертификатов пользователя |
Метод setNameCert
Установка отображаемого имени сертификата ключа проверки электронной подписи.
fun setNameCert(
context: Context,
kid: String,
cid: String,
friendlyName: String,
sdkCallback: SdkResultCallback<Unit>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| cid | String | Идентификатор сертификата |
| friendlyName | String | Отображаемое имя сертификата |
| callback | SdkResultCallback<Unit> | Интерфейс обратного вызова |
Метод setNameCert (suspend)
Установка отображаемого имени сертификата ключа проверки электронной подписи.
suspend fun setNameCert(
context: Context,
kid: String,
cid: String,
friendlyName: String
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| cid | String | Идентификатор сертификата |
| friendlyName | String | Отображаемое имя сертификата |
Метод revokeCert
Отзыв сертификата ключа проверки электронной подписи.
fun revokeCert(
context: Context,
kid: String,
cid: String,
reason: Int,
date: Long,
sdkCallback: SdkResultCallback<Unit>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| cid | String | Идентификатор сертификата |
| reason | CertRevokeReason | Причина отзыва сертификата |
| date | Long | Дата отзыва сертификата. 0 - если требуется немедленный отзыв сертификата, конкретная дата - если требуется отложенный отзыв. |
| callback | SdkResultCallback<Unit> | Интерфейс обратного вызова |
Примечание
Метод отображает UI ввода пароля для доступа к ключам аутентификации.
Метод revokeCert (suspend)
Отзыв сертификата ключа проверки электронной подписи.
suspend fun revokeCert(
context: Context,
kid: String,
cid: String,
reason: Int,
date: Long
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| cid | String | Идентификатор сертификата |
| reason | CertRevokeReason | Причина отзыва сертификата |
| date | Long | Дата отзыва сертификата. 0 - если требуется немедленный отзыв сертификата, конкретная дата - если требуется отложенный отзыв. |
Примечание
Метод отображает UI ввода пароля для доступа к ключам аутентификации.
Метод setDefaultCert
Метод устанавливает сертификат как сертификат по умолчанию.
fun setDefaultCert(
context: Context,
kid: String,
cid: String,
isDefault: Boolean,
sdkCallback: SdkResultCallback<Unit>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| cid | String | Идентификатор сертификата |
| isDefault | Boolean | Флаг использования сертификата как сертификата по умолчанию |
| callback | SdkResultCallback<Unit> | Интерфейс обратного вызова |
Метод setDefaultCert (suspend)
Метод устанавливает сертификат как сертификат по умолчанию.
suspend fun setDefaultCert(
context: Context,
kid: String,
cid: String,
isDefault: Boolean
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| cid | String | Идентификатор сертификата |
| isDefault | Boolean | Флаг использования сертификата как сертификата по умолчанию |
Метод getClientCert
Создание неподписанного запроса на сертификат и отправка его на сервер для синхронизации.
fun getClientCert(
context: Context,
kid: String,
caId: Int,
tId: String,
dn: Map<String, String>,
sdkCertificateCallback: SdkResultCallback<Certificate>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| caId | Int | Идентификатор обработчика УЦ |
| tId | String | Идентификатор шаблона сертификата |
| dn | [String: String] | Различительное имя субъекта в формате {"OID компонента имени", "Значение компонента имени"} |
| callback | SdkResultCallback<Certificate> | Интерфейс обратного вызова |
Возвращаемые параметры:
| Параметр | Описание |
|---|---|
| Certificate | Сведения о созданном запросе на сертификат |
Метод getClientCert (suspend)
Создание неподписанного запроса на сертификат и отправка его на сервер для синхронизации.
suspend fun getClientCert(
context: Context,
kid: String,
caId: Int,
tId: String,
dn: Map<String, String>
): Certificate
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| caId | Int | Идентификатор обработчика УЦ |
| tId | String | Идентификатор шаблона сертификата |
| dn | [String: String] | Различительное имя субъекта в формате {"OID компонента имени", "Значение компонента имени"} |
Возвращаемые параметры:
| Параметр | Описание |
|---|---|
| Certificate | Сведения о созданном запросе на сертификат |
Метод getClientCertEx
Создание запроса на сертификат (расширенное использование).
fun getClientCertEx(
context: Context,
kid: String,
caId: Int,
tId: String,
dn: Map<String, String>,
reqParams: Map<String, String>?,
sdkCertificateCallback: SdkResultCallback<Certificate>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| caId | Int | Идентификатор обработчика УЦ |
| tId | String | Идентификатор шаблона сертификата |
| dn | [String: String] | Различительное имя субъекта в формате {"OID компонента имени", "Значение компонента имени"} |
| reqParams | [String: String] | Дополнительные параметры запроса на сертификат |
| callback | SdkResultCallback<Certificate> | Интерфейс обратного вызова |
Возвращаемые параметры:
| Параметр | Тип | Описание |
|---|---|---|
| cert | Certificate | Сведения о созданном запросе на сертификат или сертификате |
При создании запроса на сертификат из мобильного приложения расширения, которые требуется добавить в сертификат, должны быть переданы через
дополнительные параметры reqParams в ключе ExtensionsData. Описание значения ключа ExtensionsData приведено в разделе
Расширения сертификата.
Метод getClientCertEx (suspend)
Создание запроса на сертификат (расширенное использование).
suspend fun getClientCertEx(
context: Context,
kid: String,
caId: Int,
tId: String,
dn: Map<String, String>,
reqParams: Map<String, String>?
): Certificate
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| caId | Int | Идентификатор обработчика УЦ |
| tId | String | Идентификатор шаблона сертификата |
| dn | [String: String] | Различительное имя субъекта в формате {"OID компонента имени", "Значение компонента имени"} |
| reqParams | [String: String] | Дополнительные параметры запроса на сертификат |
Возвращаемые параметры:
| Параметр | Тип | Описание |
|---|---|---|
| cert | Certificate | Сведения о созданном запросе на сертификат или сертификате |
При создании запроса на сертификат из мобильного приложения расширения, которые требуется добавить в сертификат, должны быть переданы через
дополнительные параметры reqParams в ключе ExtensionsData. Описание значения ключа ExtensionsData приведено в разделе
Расширения сертификата.
Метод signRequest
Создание ключа подписи на мобильном устройстве или внешнем носителе, подписание запроса на сертификат и отправка подписанного запроса на сервер для синхронизации.
fun signRequest(
context: Context,
kid: String,
pin: String?,
certificate: Certificate,
providerInfo: ProviderInfo?,
silent: Boolean,
sdkCertificateCallback: SdkResultCallback<Certificate>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| pin | String? | ПИН-код на контейнер сертификата (опционально) |
| certificate | Certificate | Сведения о созданном неподписанном запросе на сертификат |
| providerInfo | ProviderInfo? | Сведения о криптопровайдере |
| silent | Boolean | Флаг для скрытия/отображения диалоговых окон SDK. Используется только для создания усиленной неквалифицированной электронной подписи (silent mode). Не используется по умолчанию |
| callback | SdkResultCallback<Certificate> | Интерфейс обратного вызова |
Возвращаемые параметры:
| Параметр | Тип | Описание |
|---|---|---|
| cert | Certificate | Сведения о созданном запросе на сертификат или сертификате |
Примечание
Метод отображает UI датчика случайных чисел для создания ключа подписи пользователя или экран NFC.
Метод signRequest (suspend)
Создание ключа подписи на мобильном устройстве или внешнем носителе, подписание запроса на сертификат и отправка подписанного запроса на сервер для синхронизации.
suspend fun signRequest(
context: Context,
kid: String,
pin: String?,
certificate: Certificate,
providerInfo: ProviderInfo?,
silent: Boolean
): Certificate
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| pin | String? | ПИН-код на контейнер сертификата (опционально) |
| certificate | Certificate | Сведения о созданном неподписанном запросе на сертификат |
| providerInfo | ProviderInfo? | Сведения о криптопровайдере |
| silent | Boolean | Флаг для скрытия/отображения диалоговых окон SDK. Используется только для создания усиленной неквалифицированной электронной подписи (silent mode). Не используется по умолчанию |
Возвращаемые параметры:
| Параметр | Тип | Описание |
|---|---|---|
| cert | Certificate | Сведения о созданном запросе на сертификат или сертификате |
Примечание
Метод отображает UI датчика случайных чисел для создания ключа подписи пользователя или экран NFC.
Метод createKeyAndSignRequest
Создание ключа подписи на мобильном устройстве или внешнем носителе и подписание запроса на сертификат без отправки на сервер.
fun createKeyAndSignRequest(
context: Context,
pin: String?,
certificate: Certificate,
providerInfo: ProviderInfo?,
kid: String,
silent: Boolean,
sdkCertificateCallback: SdkResultCallback<Array<Byte>>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| certificate | Certificate | Сведения о созданном неподписанном запросе на сертификат |
| providerInfo | ProviderInfo? | Сведения о криптопровайдере |
| pin | String | ПИН-код на ключевой контейнер |
| silent | Boolean | Флаг для скрытия/отображения диалоговых окон SDK. Используется только для создания усиленной неквалифицированной электронной подписи (silent mode). Не используется по умолчанию |
| callback | SdkResultCallback<Array<Byte>> | Интерфейс обратного вызова |
Возвращаемые параметры:
| Параметр | Тип | Описание |
|---|---|---|
| cert | Certificate | Подписанный сертификат в виде массива байт |
Примечание
Метод отображает UI датчика случайных чисел для создания ключа подписи пользователя и экран ввода пароля для доступа к ключам аутентификации.
Метод createKeyAndSignRequest (suspend)
Создание ключа подписи на мобильном устройстве или внешнем носителе и подписание запроса на сертификат без отправки на сервер.
suspend fun createKeyAndSignRequest(
context: Context,
pin: String?,
certificate: Certificate,
providerInfo: ProviderInfo?,
kid: String,
silent: Boolean
): Array<Byte>
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| certificate | Certificate | Сведения о созданном неподписанном запросе на сертификат |
| providerInfo | ProviderInfo? | Сведения о криптопровайдере |
| pin | String | ПИН-код на ключевой контейнер |
| silent | Boolean | Флаг для скрытия/отображения диалоговых окон SDK. Используется только для создания усиленной неквалифицированной электронной подписи (silent mode). Не используется по умолчанию |
Возвращаемые параметры:
| Параметр | Тип | Описание |
|---|---|---|
| cert | Certificate | Подписанный сертификат в виде массива байт |
Примечание
Метод отображает UI датчика случайных чисел для создания ключа подписи пользователя и экран ввода пароля для доступа к ключам аутентификации.
Метод sendSignRequest
Отправка подписанного запроса на сертификат на сервер для синхронизации.
fun sendSignRequest(
context: Context,
kid: String,
certificate: Certificate,
signCertRequest: ByteArray?,
pin: String?,
providerInfo: ProviderInfo,
sdkCertificateCallback: SdkResultCallback<Certificate>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| certificate | Certificate | Сведения о запросе на сертификат |
| signCertRequest | ByteArray? | Подписанный запрос на сертификат, закодированный в Base64 |
| pin | String? | ПИН-код на ключевой контейнер |
| providerInfo | ProviderInfo | Сведения о криптопровайдере |
| callback | SdkResultCallback<Certificate> | Интерфейс обратного вызова |
Возвращаемые параметры:
| Параметр | Тип | Описание |
|---|---|---|
| cert | Certificate | Сведения о подписанном сертификате (запросе на сертификат) |
Примечание
Метод отображает UI ввода пароля для доступа к ключам аутентификации.
Метод sendSignRequest (suspend)
Отправка подписанного запроса на сертификат на сервер для синхронизации.
suspend fun sendSignRequest(
context: Context,
kid: String,
certificate: Certificate,
signCertRequest: ByteArray?,
pin: String?,
providerInfo: ProviderInfo
): Certificate
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| certificate | Certificate | Сведения о запросе на сертификат |
| signCertRequest | ByteArray? | Подписанный запрос на сертификат, закодированный в Base64 |
| pin | String? | ПИН-код на ключевой контейнер |
| providerInfo | ProviderInfo | Сведения о криптопровайдере |
Возвращаемые параметры:
| Параметр | Тип | Описание |
|---|---|---|
| cert | Certificate | Сведения о подписанном сертификате (запросе на сертификат) |
Примечание
Метод отображает UI ввода пароля для доступа к ключам аутентификации.
Метод sendSignRequestEx
Отправка подписанного запроса на сертификат на сервер для синхронизации с возможностью передачи дополнительных параметров.
fun sendSignRequestEx(
context: Context,
kid: String,
certificate: Certificate,
signCertRequest: ByteArray?,
pin: String?,
providerInfo: ProviderInfo,
clientReqParams: HashMap<String, String>?,
sdkCertificateCallback: SdkResultCallback<Certificate>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| certificate | Certificate | Сведения о запросе на сертификат |
| signCertRequest | ByteArray? | Подписанный запрос на сертификат, закодированный в Base64 |
| pin | String? | ПИН-код на ключевой контейнер |
| providerInfo | ProviderInfo | Сведения о криптопровайдере |
| clientReqParams | HashMap<String, String>? | Дополнительные сведения о запросе. Параметр зарезервирован для будущего использования |
| callback | SdkResultCallback<Certificate> | Интерфейс обратного вызова |
Возвращаемые параметры:
| Параметр | Тип | Описание |
|---|---|---|
| cert | Certificate | Сведения о подписанном сертификате (запросе на сертификат) |
Примечание
Метод отображает UI ввода пароля для доступа к ключам аутентификации.
Метод sendSignRequestEx (suspend)
Отправка подписанного запроса на сертификат на сервер для синхронизации с возможностью передачи дополнительных параметров.
suspend fun sendSignRequestEx(
context: Context,
kid: String,
certificate: Certificate,
signCertRequest: ByteArray?,
pin: String?,
providerInfo: ProviderInfo,
clientReqParams: HashMap<String, String>?
): Certificate
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| certificate | Certificate | Сведения о запросе на сертификат |
| signCertRequest | ByteArray? | Подписанный запрос на сертификат, закодированный в Base64 |
| pin | String? | ПИН-код на ключевой контейнер |
| providerInfo | ProviderInfo | Сведения о криптопровайдере |
| clientReqParams | HashMap<String, String>? | Дополнительные сведения о запросе. Параметр зарезервирован для будущего использования |
Возвращаемые параметры:
| Параметр | Тип | Описание |
|---|---|---|
| cert | Certificate | Сведения о подписанном сертификате (запросе на сертификат) |
Примечание
Метод отображает UI ввода пароля для доступа к ключам аутентификации.
Метод installCertificate
Установка сертификата в ключевой контейнер на мобильном устройстве или внешнем носителе и отправка его на сервер для синхронизации.
fun installCertificate(
context: Context,
certificate: Certificate,
crtBytes: ByteArray,
pin: String,
sdkCallback: SdkResultCallback<Unit>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| certificate | Certificate | Сведения о запросе на сертификат, который требуется установить |
| crtBytes | byte[] | Сертификат, который требуется установить |
| pin | String | ПИН-код на контейнер закрытого ключа (опционально) |
| callback | SdkResultCallback<Unit> | Интерфейс обратного вызова |
Примечание
Метод отображает UI ввода пароля для доступа к ключам аутентификации.
Метод installCertificate (suspend)
Установка сертификата в ключевой контейнер на мобильном устройстве или внешнем носителе и отправка его на сервер для синхронизации.
suspend fun installCertificate(
context: Context,
certificate: Certificate,
crtBytes: ByteArray,
pin: String
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| certificate | Certificate | Сведения о запросе на сертификат, который требуется установить |
| crtBytes | byte[] | Сертификат, который требуется установить |
| pin | String | ПИН-код на контейнер закрытого ключа (опционально) |
Примечание
Метод отображает UI ввода пароля для доступа к ключам аутентификации.
Метод installCertificateExternal
Установка сертификата в мобильное устройство с внешнего носителя (NFC/USB) и отправка его на сервер для синхронизации.
fun installCertificateExternal(
context: Context,
kid: String,
signingKeyInfo: SigningKeyInfo,
content: String,
sdkCallback: SdkResultCallback<Certificate>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| signingKeyInfo | SigningKeyInfo | Сведения о ключевом контейнере (ключе подписи), установленном на мобильное устройство |
| content | String | Содержимое сертификата в строковом представлении (Base64) |
| callback | SdkResultCallback<Certificate> | Интерфейс обратного вызова |
Возвращаемые параметры:
| Параметр | Тип | Описание |
|---|---|---|
| cert | Certificate | Сведения об установленном сертификате |
Примечание
Метод отображает UI ввода пароля для доступа к ключам аутентификации.
Метод installCertificateExternal (suspend)
Установка сертификата в мобильное устройство с внешнего носителя (NFC/USB) и отправка его на сервер для синхронизации.
suspend fun installCertificateExternal(
context: Context,
kid: String,
signingKeyInfo: SigningKeyInfo,
content: String
): Certificate
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| signingKeyInfo | SigningKeyInfo | Сведения о ключевом контейнере (ключе подписи), установленном на мобильное устройство |
| content | String | Содержимое сертификата в строковом представлении (Base64) |
Возвращаемые параметры:
| Параметр | Тип | Описание |
|---|---|---|
| cert | Certificate | Сведения об установленном сертификате |
Примечание
Метод отображает UI ввода пароля для доступа к ключам аутентификации.
Метод checkIfInstalled
Проверка, установлен ли сертификат в ключевой контейнер на мобильном устройстве.
fun checkIfInstalled(context: Context, certificate: Certificate)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| certificate | Certificate | Сведения о сертификате |
Возвращаемые параметры:
- True (установлен) / False (не установлен)
Метод checkIfAccessibleOnThisDevice (для обратной совместимости)
Проверка доступности ключа подписи (существования ключевого контейнера).
fun checkIfAccessibleOnThisDevice(
signingKeyInfoList: List<SigningKeyInfo>,
cid: Int,
rid: Int
): Boolean
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| rid | String | Идентификатор запроса на сертификат |
| cid | Int | Идентификатор сертификата |
| signingKeyInfoList | List<SigningKeyInfo> | Список ключей подписи. Параметр можно использовать в случаях, если нужно произвести проверку доступности ключа подписи в ранее полученном списке контейнеров |
Возвращаемые параметры:
- True/False
Метод checkIfAccessibleOnThisDevice
Проверка доступности ключа подписи (существования ключевого контейнера).
fun checkIfAccessibleOnThisDevice(context: Context, cid: Int, rid: Int): Boolean
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| rid | String | Идентификатор запроса на сертификат |
| cid | Int | Идентификатор сертификата |
Возвращаемые параметры:
- True/False
Метод changeKeyPin
Смена ПИН-кода ключевого контейнера (внешний носитель USB/NFC).
Внимание!
Метод недоступен в silent-режиме.
fun changeKeyPin(context: Context, cid: Int, callback: SdkResultCallback<Unit>)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| cid | Int | Идентификатор сертификата |
| callback | SdkResultCallback<Unit> | Интерфейс обратного вызова |
Метод changeKeyPin (suspend)
Смена ПИН-кода ключевого контейнера (внешний носитель USB/NFC).
Внимание!
Метод недоступен в silent-режиме.
suspend fun changeKeyPin(
context: Context,
cid: Int
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| cid | Int | Идентификатор сертификата |
Метод forgetKeyPin
Удаление сохраненного ПИН-кода внешнего носителя (внешний носитель USB/NFC).
Внимание!
Метод недоступен в silent-режиме.
fun forgetKeyPin(context: Context, cid: Int, sdkCallback: SdkResultCallback<Unit>)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| cid | Int | Идентификатор сертификата |
| callback | SdkResultCallback<Unit> | Интерфейс обратного вызова |
Метод forgetKeyPin (suspend)
Удаление сохраненного ПИН-кода внешнего носителя (внешний носитель USB/NFC).
Внимание!
Метод недоступен в silent-режиме.
suspend fun forgetKeyPin(context: Context, cid: Int)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| cid | Int | Идентификатор сертификата |