Класс 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 Instant engineGetCreationInstant(String alias)

Примечание к API:

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

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

Реализация по умолчанию вызывает engineGetCreationDate(alias) и возвращает результат как значение типа Instant.

Параметры:

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

Возвращает:

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

С версии:

27

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