Класс KeyStoreSpi

public KeyStoreSpi()

public abstract Key engineGetKey(String alias, char[] password) throws NoSuchAlgorithmException, UnrecoverableKeyException

Параметры:

alias — имя псевдонима

password — пароль для восстановления ключа

Возвращает:

запрошенный ключ или null, если указанный псевдоним не существует или не указывает на запись, связанную с ключом.

Вызывает исключение:

NoSuchAlgorithmException — если алгоритм для восстановления ключа не найден

UnrecoverableKeyException — если ключ не удаётся восстановить (например, если указан неверный пароль).

public abstract Certificate[] engineGetCertificateChain(String alias)

Параметры:

alias — имя псевдонима

Возвращает:

цепочку сертификатов (упорядоченную так, что сертификат пользователя находится первым, а корневой центр сертификации — последним) или null, если указанный псевдоним * не существует или не содержит цепочку сертификатов

public abstract Certificate engineGetCertificate(String alias)

Параметры:

alias — имя псевдонима

Возвращает:

сертификат или null, если указанный псевдоним не существует или не содержит сертификат.

public abstract Date engineGetCreationDate(String alias)

Параметры:

alias — имя псевдонима

Возвращает:

дату создания этой записи или null, если указанный псевдоним не существует

public abstract void engineSetKeyEntry(String alias, Key key, char[] password, Certificate[] chain) throws KeyStoreException

Параметры:

alias — имя псевдонима

key — ключ, который нужно связать с псевдонимом

password — пароль для защиты ключа

chain — цепочка сертификатов для соответствующего открытого ключа (требуется только в том случае, если заданный ключ имеет тип java.security.PrivateKey).

Вызывает исключение:

KeyStoreException — если заданный ключ не удаётся защитить или операция завершается неудачно по другой причине

public abstract void engineSetKeyEntry(String alias, byte[] key, Certificate[] chain) throws KeyStoreException

Параметры:

alias — имя псевдонима

key — ключ (в защищённом формате), который нужно связать с псевдонимом

chain — цепочка сертификатов для соответствующего открытого ключа (имеет смысл только в том случае, если защищённый ключ имеет тип java.security.PrivateKey).

Вызывает исключение:

KeyStoreException — если эта операция завершается неудачно.

public abstract void engineSetCertificateEntry(String alias, Certificate cert) throws KeyStoreException

Параметры:

alias — имя псевдонима

cert — сертификат

Вызывает исключение:

KeyStoreException — если указанный псевдоним уже существует и не указывает на запись, содержащую доверенный сертификат, или операция завершается неудачно по другой причине.

public abstract void engineDeleteEntry(String alias) throws KeyStoreException

Параметры:

alias — имя псевдонима

Вызывает исключение:

KeyStoreException — если запись не удаётся удалить.

public abstract Enumeration<String> engineAliases()

Возвращает:

перечисление имён псевдонимов

public abstract boolean engineContainsAlias(String alias)

Параметры:

alias — имя псевдонима

Возвращает:

true, если псевдоним существует; в противном случае — false

public abstract int engineSize()

Возвращает:

количество записей в этом хранилище ключей

public abstract boolean engineIsKeyEntry(String alias)

Параметры:

alias — псевдоним записи хранилища ключей, которую нужно проверить

Возвращает:

true, если запись, указанная заданным псевдонимом, связана с ключом; в противном случае — false.

public abstract boolean engineIsCertificateEntry(String alias)

Параметры:

alias — псевдоним записи хранилища ключей, которую нужно проверить

Возвращает:

true, если запись, указанная заданным псевдонимом, содержит доверенный сертификат; в противном случае — false.

public abstract String engineGetCertificateAlias(Certificate cert)

Параметры:

cert — сертификат для сопоставления.

Возвращает:

имя псевдонима первой записи с совпадающим сертификатом или null, если в этом хранилище ключей такой записи нет.

public abstract void engineStore(OutputStream stream, char[] password) throws IOException, NoSuchAlgorithmException, CertificateException

Параметры:

stream — выходной поток, в который записывается это хранилище ключей.

password — пароль для создания контрольной суммы целостности хранилища ключей. Может быть null, если хранилище ключей не поддерживает или не требует проверки целостности.

Вызывает исключение:

IOException — если при работе с данными возникла ошибка ввода-вывода

NoSuchAlgorithmException — если не удалось найти подходящий алгоритм проверки целостности данных

CertificateException — если не удалось сохранить какой-либо из сертификатов, включённых в данные хранилища ключей

public void engineStore(KeyStore.LoadStoreParameter param) throws IOException, NoSuchAlgorithmException, CertificateException

Требования к реализации:

Реализация по умолчанию выбрасывает исключение UnsupportedOperationException.

Параметры:

param — KeyStore.LoadStoreParameter, указывающий способ сохранения хранилища ключей; может быть null

Вызывает исключение:

IllegalArgumentException — если указанный входной параметр KeyStore.LoadStoreParameter не распознан

IOException — если при работе с данными возникла ошибка ввода-вывода

NoSuchAlgorithmException — если не удалось найти подходящий алгоритм проверки целостности данных

CertificateException — если не удалось сохранить какой-либо из сертификатов, включённых в данные хранилища ключей

UnsupportedOperationException — если реализация не поддерживает эту операцию

Начиная с версии:

1.5

public abstract void engineLoad(InputStream stream, char[] password) throws IOException, NoSuchAlgorithmException, CertificateException

Параметры:

stream — входной поток, из которого загружается хранилище ключей, или null

password — пароль для проверки целостности хранилища ключей, пароль для разблокировки хранилища ключей или null

Вызывает исключение:

IOException — если возникла ошибка ввода-вывода или ошибка формата данных хранилища ключей, если требуется пароль, но он не указан, либо если задан неверный пароль. Если ошибка вызвана неверным паролем, значением cause для IOException должно быть UnrecoverableKeyException

NoSuchAlgorithmException — если не удалось найти алгоритм, используемый для проверки целостности хранилища ключей

CertificateException — если не удалось загрузить какой-либо из сертификатов в хранилище ключей

public void engineLoad(KeyStore.LoadStoreParameter param) throws IOException, NoSuchAlgorithmException, CertificateException

Требования к реализации:

Реализация по умолчанию анализирует KeyStore.LoadStoreParameter, извлекает пароль и передаёт его в engineLoad(InputStream, char[]) вместе с null InputStream.

Если KeyStore.LoadStoreParameter имеет значение null, параметр пароля также будет иметь значение null. В противном случае KeyStore.ProtectionParameter объекта KeyStore.LoadStoreParameter должен быть либо KeyStore.PasswordProtection, либо KeyStore.CallbackHandlerProtection, поддерживающим PasswordCallback, чтобы можно было извлечь пароль. Если KeyStore.ProtectionParameter не является ни одним из этих классов, выбрасывается NoSuchAlgorithmException.

Параметры:

param — KeyStore.LoadStoreParameter, указывающий способ загрузки хранилища ключей; может быть null

Вызывает исключение:

IllegalArgumentException — если указанный входной параметр KeyStore.LoadStoreParameter не распознан

IOException — если возникла ошибка ввода-вывода или ошибка формата данных хранилища ключей. Если ошибка вызвана неверным ProtectionParameter (например, неверным паролем), значением cause для IOException должно быть UnrecoverableKeyException

NoSuchAlgorithmException — если не удалось найти алгоритм, используемый для проверки целостности хранилища ключей

CertificateException — если не удалось загрузить какой-либо из сертификатов в хранилище ключей

Начиная с версии:

1.5

public Set<KeyStore.Entry.Attribute> engineGetAttributes(String alias)

Требования к реализации:

Реализация по умолчанию возвращает пустой Set. Реализациям KeyStoreSpi, поддерживающим атрибуты, следует переопределить этот метод.

Параметры:

alias — имя псевдонима

Возвращает:

неизменяемый Set атрибутов. Это множество пусто, если указанный псевдоним не существует или с ним не связаны атрибуты. Оно также может быть пустым для записей PrivateKeyEntry или SecretKeyEntry, содержащих защищённые атрибуты. Эти защищённые атрибуты должны быть включены в результат, возвращаемый методом engineGetEntry(String, KeyStore.ProtectionParameter), и их можно получить вызовом метода KeyStore.Entry.getAttributes().

Начиная с версии:

18

public KeyStore.Entry engineGetEntry(String alias, KeyStore.ProtectionParameter protParam) throws KeyStoreException, NoSuchAlgorithmException, UnrecoverableEntryException

Параметры:

alias — получить KeyStore.Entry для этого псевдонима

protParam — ProtectionParameter, используемый для защиты Entry; может быть null

Возвращает:

KeyStore.Entry для указанного псевдонима или null, если такой записи нет

Вызывает исключение:

KeyStoreException — если операция завершилась неудачно

NoSuchAlgorithmException — если не удалось найти алгоритм для восстановления записи

UnrecoverableEntryException — если указанные protParam недостаточны или недействительны

UnrecoverableKeyException — если запись является PrivateKeyEntry или SecretKeyEntry, а указанный protParam не содержит сведений, необходимых для восстановления ключа (например, указан неверный пароль)

Начиная с версии:

1.5

public void engineSetEntry(String alias, KeyStore.Entry entry, KeyStore.ProtectionParameter protParam) throws KeyStoreException

Параметры:

alias — сохранить KeyStore.Entry под этим псевдонимом

entry — Entry для сохранения

protParam — ProtectionParameter, используемый для защиты Entry; может быть null

Вызывает исключение:

KeyStoreException — если эта операция завершается неудачно

Начиная с версии:

1.5

public boolean engineEntryInstanceOf(String alias, Class<? extends KeyStore.Entry> entryClass)

Параметры:

alias — имя псевдонима

entryClass — класс записи

Возвращает:

true, если Entry хранилища ключей для указанного alias является экземпляром указанного entryClass или его подклассом; в противном случае — false

Начиная с версии:

1.5

public boolean engineProbe(InputStream stream) throws IOException

Требования к реализации:

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

Параметры:

stream — данные хранилища ключей для проверки

Возвращает:

true, если данные хранилища ключей поддерживаются; в противном случае — false

Вызывает исключение:

IOException — если при работе с данными хранилища ключей возникла ошибка ввода-вывода.

NullPointerException — если поток равен null.

Начиная с версии:

9