Класс KeyStoreSpi

public abstract class KeyStoreSpi
extends Object

Конструкторы

KeyStoreSpi

public KeyStoreSpi()

Методы

engineGetKey

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

Возвращает ключ, связанный с заданным псевдонимом, используя указанный пароль для его восстановления. Ключ должен быть связан с псевдонимом вызовом setKeyEntry, или вызовом setEntry с PrivateKeyEntry или SecretKeyEntry.

Параметры:

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

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

Возвращает:

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

Исключение:

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

UnrecoverableKeyException - если ключ не может быть восстановлен (например, указанный пароль неверный).

engineGetCertificateChain

public abstract Certificate[] engineGetCertificateChain(String alias)

Возвращает цепочку сертификатов, связанную с заданным псевдонимом. Цепочка сертификатов должна быть связана с псевдонимом вызовом setKeyEntry, или вызовом setEntry с PrivateKeyEntry.

Параметры:

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

Возвращает:

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

engineGetCertificate

public abstract Certificate engineGetCertificate(String alias)

Параметры:

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

Возвращает:

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

engineGetCreationDate

public abstract Date engineGetCreationDate(String alias)

Возвращает дату создания записи, идентифицированной заданным псевдонимом.

Параметры:

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

Возвращает:

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

engineSetKeyEntry

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

Параметры:

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

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

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

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

Исключение:

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

engineSetKeyEntry

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

Параметры:

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

key - ключ (в защищенном формате) для связи с псевдонимом

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

Исключение:

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

engineSetCertificateEntry

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

Параметры:

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

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

Исключение:

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

engineDeleteEntry

public abstract void engineDeleteEntry(String alias)
                                throws KeyStoreException

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

Параметры:

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

Исключение:

KeyStoreException - если запись не может быть удалена.

engineAliases

public abstract Enumeration<String> engineAliases()

Перечисляет все имена псевдонимов этого хранилища ключей.

Возвращает:

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

engineContainsAlias

public abstract boolean engineContainsAlias(String alias)

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

Параметры:

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

Возвращает:

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

engineSize

public abstract int engineSize()

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

Возвращает:

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

engineIsKeyEntry

public abstract boolean engineIsKeyEntry(String alias)

Возвращает true, если запись, идентифицированная заданным псевдонимом, была создана вызовом setKeyEntry, или создана вызовом setEntry с PrivateKeyEntry или SecretKeyEntry.

Параметры:

alias - псевдоним для проверяемой записи хранилища ключей

Возвращает:

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

engineIsCertificateEntry

public abstract boolean engineIsCertificateEntry(String alias)

Возвращает true, если запись, идентифицированная заданным псевдонимом, была создана вызовом setCertificateEntry, или создана вызовом setEntry с TrustedCertificateEntry.

Параметры:

alias - псевдоним для проверяемой записи хранилища ключей

Возвращает:

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

engineGetCertificateAlias

public abstract String engineGetCertificateAlias(Certificate cert)

Параметры:

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

Возвращает:

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

engineStore

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

Сохраняет это хранилище ключей в заданный выходной поток и защищает его целостность заданным паролем.

Параметры:

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

password - пароль для проверки целостности хранилища ключей

Исключение:

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

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

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

engineStore

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

Сохраняет это хранилище ключей, используя заданные KeyStore.LoadStoreParmeter.

Параметры:

param - KeyStore.LoadStoreParmeter, определяющий, как сохранить хранилище ключей, которое может быть null

Исключение:

IllegalArgumentException - если заданный KeyStore.LoadStoreParmeter вход не распознан

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

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

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

Since:

1.5

engineLoad

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

Параметры:

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

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

Исключение:

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

NoSuchAlgorithmException - если алгоритм проверки целостности хранилища ключей не найден

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

engineLoad

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

Параметры:

param - KeyStore.LoadStoreParameter для загрузки хранилища ключей, который может быть null

Исключения:

IllegalArgumentException - если заданный KeyStore.LoadStoreParameter вход не распознан

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

NoSuchAlgorithmException - если алгоритм проверки целостности хранилища ключей не найден

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

С:

1.5

engineGetEntry

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

Возвращает KeyStore.Entry для указанного псевдонима с указанным параметром защиты.

Параметры:

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

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

Возвращает:

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

Исключения:

KeyStoreException - если операция не удалась

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

UnrecoverableEntryException - если указанные protParam были недостаточными или неверными

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

С:

1.5

engineSetEntry

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

engineEntryInstanceOf

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

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

Параметры:

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

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

Возвращает:

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

С:

1.5