Класс KeyStoreSpi

java.lang.Object

java.security.KeyStoreSpi

public abstract class KeyStoreSpi extends Object

Этот класс определяет интерфейс поставщика услуг (SPI) для класса KeyStore. Все абстрактные методы в этом классе должны быть реализованы каждым поставщиком криптографических сервисов, желающим предоставить реализацию хранилища ключей для определенного типа хранилища ключей.

Since:

1.2

See Also:

KeyStore

Краткое описание конструкторов

Конструктор	Описание
`KeyStoreSpi()`	Конструктор для вызова подклассами.

Краткое описание методов

Модификатор и тип	Метод	Описание
`abstract Enumeration<String>`	`engineAliases()`	Выводит список всех псевдонимов этого хранилища ключей.
`abstract boolean`	`engineContainsAlias(String alias)`	Проверяет, существует ли данный псевдоним в этом хранилище ключей.
`abstract void`	`engineDeleteEntry(String alias)`	Удаляет запись, идентифицированную данным псевдонимом, из этого хранилища ключей.
`boolean`	`engineEntryInstanceOf(String alias, Class<? extends KeyStore.Entry> entryClass)`	Определяет, является ли хранилище ключей `Entry` для указанного `alias` экземпляром или подклассом указанного `entryClass`.
`abstract Certificate`	`engineGetCertificate(String alias)`	Возвращает сертификат, связанный с данным псевдонимом.
`abstract String`	`engineGetCertificateAlias(Certificate cert)`	Возвращает (псевдоним) имя первой записи хранилища ключей, сертификат которой соответствует данному сертификату.
`abstract Certificate[]`	`engineGetCertificateChain(String alias)`	Возвращает цепочку сертификатов, связанную с данным псевдонимом.
`abstract Date`	`engineGetCreationDate(String alias)`	Возвращает дату создания записи, идентифицированной данным псевдонимом.
`KeyStore.Entry`	`engineGetEntry(String alias, KeyStore.ProtectionParameter protParam)`	Возвращает `KeyStore.Entry` для указанного псевдонима с указанным параметром защиты.
`abstract Key`	`engineGetKey(String alias, char[] password)`	Возвращает ключ, связанный с данным псевдонимом, используя заданный пароль для его восстановления.
`abstract boolean`	`engineIsCertificateEntry(String alias)`	Возвращает true, если запись, идентифицированная данным псевдонимом, была создана вызовом `setCertificateEntry`, или создана вызовом `setEntry` с `TrustedCertificateEntry`.
`abstract boolean`	`engineIsKeyEntry(String alias)`	Возвращает true, если запись, идентифицированная данным псевдонимом, была создана вызовом `setKeyEntry`, или создана вызовом `setEntry` с `PrivateKeyEntry` или `SecretKeyEntry`.
`abstract void`	`engineLoad(InputStream stream, char[] password)`	Загружает хранилище ключей из указанного потока ввода.
`void`	`engineLoad(KeyStore.LoadStoreParameter param)`	Загружает хранилище ключей, используя указанный `KeyStore.LoadStoreParameter`.
`boolean`	`engineProbe(InputStream stream)`	Проверяет указанный поток ввода, чтобы определить, содержит ли он хранилище ключей, поддерживаемое этой реализацией.
`abstract void`	`engineSetCertificateEntry(String alias, Certificate cert)`	Присваивает указанный сертификат указанному псевдониму.
`void`	`engineSetEntry(String alias, KeyStore.Entry entry, KeyStore.ProtectionParameter protParam)`	Сохраняет `KeyStore.Entry` под указанным псевдонимом.
`abstract void`	`engineSetKeyEntry(String alias, byte[] key, Certificate[] chain)`	Присваивает указанный ключ (который уже был защищен) указанному псевдониму.
`abstract void`	`engineSetKeyEntry(String alias, Key key, char[] password, Certificate[] chain)`	Присваивает указанный ключ указанному псевдониму, защищая его указанным паролем.
`abstract int`	`engineSize()`	Возвращает количество записей в этом хранилище ключей.
`abstract void`	`engineStore(OutputStream stream, char[] password)`	Сохраняет это хранилище ключей в указанный поток вывода и защищает его целостность с помощью заданного пароля.
`void`	`engineStore(KeyStore.LoadStoreParameter param)`	Сохраняет это хранилище ключей, используя указанный `KeyStore.LoadStoreParameter`.

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание конструкторов

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)

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

Если заданное имя псевдонима идентифицирует запись, созданную вызовом setCertificateEntry, или созданную вызовом setEntry с TrustedCertificateEntry, то возвращается доверенный сертификат, содержащийся в этой записи.

Если заданное имя псевдонима идентифицирует запись, созданную вызовом setKeyEntry, или созданную вызовом setEntry с PrivateKeyEntry, то возвращается первый элемент цепочки сертификатов в этой записи (если такая цепочка существует).

Параметры:: 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

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

Если заданный ключ является типа java.security.PrivateKey, он должен быть сопровождаться цепочкой сертификатов, подтверждающих соответствующий открытый ключ.

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

Параметры:: alias - имя псевдонима; key - ключ, который нужно связать с псевдонимом; password - пароль для защиты ключа; chain - цепочка сертификатов для соответствующего открытого ключа (требуется только если заданный ключ является типа java.security.PrivateKey).
Исключения:: KeyStoreException - если заданный ключ не может быть защищен или эта операция не удалась по какой-либо другой причине.

engineSetKeyEntry

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

Присваивает заданный ключ (уже защищенный) заданному псевдониму.

Если защищенный ключ является типа java.security.PrivateKey, он должен быть сопровождаться цепочкой сертификатов, подтверждающих соответствующий открытый ключ.

Параметры:: alias - имя псевдонима; key - ключ (в защищенном формате) для связывания с псевдонимом; chain - цепочка сертификатов для соответствующего открытого ключа (полезно только если защищенный ключ является типа java.security.PrivateKey).
Исключения:: KeyStoreException - если эта операция не удалась.

engineSetCertificateEntry

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

Присваивает заданный сертификат заданному псевдониму.

Если заданный псевдоним идентифицирует существующую запись, созданную вызовом setCertificateEntry, или созданную вызовом setEntry с TrustedCertificateEntry, доверенный сертификат в существующей записи перезаписывается заданным сертификатом.

Параметры:: 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)

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

Этот метод пытается сопоставить заданный сертификат с каждой записью хранилища ключей. Если рассматриваемая запись была создана вызовом setCertificateEntry, или создана вызовом setEntry с TrustedCertificateEntry, то заданный сертификат сравнивается с сертификатом этой записи.

Если рассматриваемая запись была создана вызовом setKeyEntry, или создана вызовом setEntry с PrivateKeyEntry, то заданный сертификат сравнивается с первым элементом цепочки сертификатов этой записи.

Параметры:: 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.LoadStoreParameter.

Требования к реализации:: В стандартной реализации выбрасывается исключение UnsupportedOperationException.
Параметры:: param - KeyStore.LoadStoreParameter что определяет, как сохранить хранилище ключей, которое может быть null
Исключения:: IllegalArgumentException - если заданный ввод KeyStore.LoadStoreParameter не распознан; IOException - если возникла проблема ввода-вывода с данными; NoSuchAlgorithmException - если не был найден соответствующий алгоритм целостности данных; CertificateException - если какой-либо из сертификатов, включенных в данные хранилища ключей, не удалось сохранить; UnsupportedOperationException - если реализация не поддерживает эту операцию
С:: 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

Загружает хранилище ключей с использованием заданного KeyStore.LoadStoreParameter.

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

Требования к реализации:: Стандартная реализация анализирует 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

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

Сохраняет KeyStore.Entry под указанным псевдонимом. Заданный параметр защиты используется для защиты Entry.

Если для указанного псевдонима уже существует запись, она перезаписывается.

Параметры:: 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

engineProbe

public boolean engineProbe(InputStream stream) throws IOException

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

Требования к реализации:: Этот метод по умолчанию возвращает false. Реализации хранилища ключей должны переопределять этот метод, чтобы непосредственно просмотреть поток данных или использовать другие механизмы обнаружения содержимого.
Параметры:: stream - данные хранилища ключей для проверки
Возвращает:: true, если данные хранилища ключей поддерживаются, иначе false
Исключения:: IOException - если возникла проблема ввода-вывода с данными хранилища ключей.; NullPointerException - если поток null.
С:: 9

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/security/KeyStoreSpi.html