Класс SigningKey
Получение сведений о ключах
Метод listKeys
Получение списка ключей подписи, установленных на данном мобильном устройстве.
fun listKeys(checkAllContainers: Boolean): List<SigningKeyInfo>
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| checkAllContainers | Boolean | Флаг, указывающий проверять все контейнеры (в случае значения false будут проверены только контейнеры, созданные с помощью SDK) |
Возвращаемые параметры:
| Тип | Описание |
|---|---|
| List[SigningKeyInfo] | Массив сведений о ключах подписи (ключевых контейнерах), установленных на мобильном устройстве |
Метод listExternalKeys
Получение списка ключей подписи, установленных на внешнем носителе (NFC/USB).
fun listExternalKeys(
context: Context,
sdkResultCallback: SdkResultCallback<Map<SigningKeyInfo, Certificate>>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| callback | SdkResultCallback<Map<SigningKeyInfo, Certificate>> | Интерфейс обратного вызова |
Возвращаемые параметры:
- Map[SigningKeyInfo, Certificate] - Массив сведений о ключах подписи, установленных на внешний носитель
Метод listExternalKeys (suspend)
Получение списка ключей подписи, установленных на внешнем носителе (NFC/USB).
suspend fun listExternalKeys(context: Context): Map<SigningKeyInfo, Certificate>
Возвращаемые параметры:
- Map[SigningKeyInfo, Certificate] - Массив сведений о ключах подписи, установленных на внешний носитель
Удаление ключей
Метод deleteKeyPair
Удаление ключа подписи, соответствующего определенному сертификату или запросу на сертификат.
fun deleteKeyPair(
providerInfo: ProviderInfo,
callback: SdkResultCallback<Unit>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| providerInfo | ProviderInfo | Сведения о криптопровайдере (ключевом контейнере) |
| callback | SdkResultCallback<Unit> | Интерфейс обратного вызова |
Метод deleteKeyPair (suspend)
Удаление ключа подписи, соответствующего определенному сертификату или запросу на сертификат.
suspend fun deleteKeyPair(providerInfo: ProviderInfo)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| providerInfo | ProviderInfo | Сведения о криптопровайдере (ключевом контейнере) |
Метод deleteSigningKeyInfo
Удаление ключа подписи из определенного ключевого контейнера.
fun deleteSigningKeyInfo(
containerName: String,
sdkResultCallback: SdkResultCallback<Unit>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| containerName | String | имя ключевого контейнера |
| callback | SdkResultCallback<Unit> | Интерфейс обратного вызова |
Метод deleteSigningKeyInfo (suspend)
Удаление ключа подписи из определенного ключевого контейнера.
suspend fun deleteSigningKeyInfo(containerName: String)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| containerName | String | имя ключевого контейнера |
Метод deleteAllSigningKeyInfoByUid
Локальное удаление ключа подписи (без удаления ключевого контейнера) по идентификатору набора ключей пользователя.
fun deleteAllSigningKeyInfoByUid(
context: Context,
kid: String,
sdkResultCallback: SdkResultCallback<Unit>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| callback | SdkResultCallback<Unit> | Интерфейс обратного вызова |
Метод deleteAllSigningKeyInfoByUid (suspend)
Локальное удаление ключа подписи (без удаления ключевого контейнера) по идентификатору набора ключей пользователя.
suspend fun deleteAllSigningKeyInfoByUid(context: Context, kid: String)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
Метод deleteAllSigningKeyInfoByKid
Локальное удаление ключа подписи (без удаления ключевого контейнера) по идентификатору пользователя.
fun deleteAllSigningKeyInfoByKid(
context: Context,
kid: String,
sdkResultCallback: SdkResultCallback<Unit>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| callback | SdkResultCallback<Unit> | Интерфейс обратного вызова |
Метод deleteAllSigningKeyInfoByKid (suspend)
Локальное удаление ключа подписи (без удаления ключевого контейнера) по идентификатору пользователя.
suspend fun deleteAllSigningKeyInfoByKid(context: Context, kid: String)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |