Spec-Zone.ru › OpenJDK 24

Интерфейс Key

Все суперинтерфейсы:
Serializable
Все известные подинтерфейсы:
AsymmetricKey, DHPrivateKey, DHPublicKey, DSAPrivateKey, DSAPublicKey, ECPrivateKey, ECPublicKey, EdECPrivateKey, EdECPublicKey, PBEKey, PrivateKey, PublicKey, RSAMultiPrimePrivateCrtKey, RSAPrivateCrtKey, RSAPrivateKey, RSAPublicKey, SecretKey, XECPrivateKey, XECPublicKey
Все известные реализующие классы:
EncryptionKey, KerberosKey, SecretKeySpec
public interface Key extends Serializable
Интерфейс Key является основным интерфейсом для всех ключей. Он определяет функциональность, общую для всех объектов Key. Все ключи имеют три характеристики:
  • Алгоритм

    Это алгоритм ключа. Алгоритм ключа обычно является алгоритмом шифрования или асимметричной операции (например, DSA или RSA), который будет работать с этими алгоритмами и с родственной алгоритмами (например, MD5 с RSA, SHA-1 с RSA, необработанный DSA и т. д.). Название алгоритма ключа получается с помощью метода getAlgorithm.

  • Кодированная форма

    Это внешняя закодированная форма ключа, используемая, когда требуется стандартное представление ключа вне виртуальной машины Java, например, при передаче ключа другой стороне. Ключ кодируется в соответствии со стандартным форматом (например, X.509 SubjectPublicKeyInfo или PKCS#8) и возвращается с помощью метода getEncoded. Примечание: синтаксис типа ASN.1 SubjectPublicKeyInfo определяется следующим образом:

     SubjectPublicKeyInfo ::= SEQUENCE {
       algorithm AlgorithmIdentifier,
       subjectPublicKey BIT STRING }
    
     AlgorithmIdentifier ::= SEQUENCE {
       algorithm OBJECT IDENTIFIER,
       parameters ANY DEFINED BY algorithm OPTIONAL }
     
    Для получения дополнительной информации см. RFC 5280: Профили сертификатов и CRL инфраструктуры открытых ключей Internet X.509.
  • Формат

    Это имя формата закодированного ключа. Он возвращается методом getFormat.

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

Ключ должен использовать KeyRep в качестве своего сериализованного представления. Обратите внимание, что сериализованный ключ может содержать конфиденциальную информацию, которую не следует раскрывать в незащищенных средах. См. Приложения по безопасности спецификации сериализации объектов Java для получения дополнительной информации.

С:
1.1
Внешние спецификации
  • Спецификация сериализации объектов Java
  • RFC 5280: Профили сертификатов и списков отозванных сертификатов (CRL) инфраструктуры открытых ключей Internet X.509
См. также:
  • PublicKey
  • PrivateKey
  • KeyPair
  • KeyPairGenerator
  • KeyFactory
  • KeyRep
  • KeySpec

Краткое описание полей

Модификатор и тип Поле Описание
static final long serialVersionUID
Устаревшее.
Поле serialVersionUID в интерфейсе неэффективно.

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

Модификатор и тип Метод Описание
String getAlgorithm()
Возвращает стандартное имя алгоритма для данного ключа.
byte[] getEncoded()
Возвращает ключ в его основном формате кодирования или null, если этот ключ не поддерживает кодирование.
String getFormat()
Возвращает имя основного формата кодирования этого ключа или null, если этот ключ не поддерживает кодирование.

Подробное описание полей

serialVersionUID

@Deprecated static final long serialVersionUID
Устаревшее.
Поле serialVersionUID в интерфейсе неэффективно. Не использовать; замена отсутствует.
Отпечаток класса, установленный для указания совместимости сериализации с предыдущей версией класса.
См. также:
  • Постоянные значения полей

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

getAlgorithm

String getAlgorithm()
Возвращает стандартное имя алгоритма для этого ключа. Например, "DSA" указывает, что этот ключ является ключом DSA. См. разделы, связанные с ключами (KeyFactory, KeyGenerator, KeyPairGenerator и SecretKeyFactory) в Спецификации имен стандартных алгоритмов Java Security для получения информации о стандартных именах алгоритмов ключей.
Возвращает:
имя алгоритма, связанного с этим ключом.
Внешние спецификации
  • Имена стандартных алгоритмов Java Security

getFormat

String getFormat()
Возвращает имя основного формата кодирования этого ключа или null, если этот ключ не поддерживает кодирование. Основной формат кодирования называется в терминах соответствующего формата данных ASN.1, если для этого ключа существует спецификация ASN.1. Например, имя формата данных ASN.1 для открытых ключей — SubjectPublicKeyInfo, как определено в стандарте X.509; в этом случае возвращаемый формат — "X.509". Аналогично, имя формата данных ASN.1 для закрытых ключей — PrivateKeyInfo, как определено в стандарте PKCS #8; в этом случае возвращаемый формат — "PKCS#8".
Возвращает:
основной формат кодирования ключа.

getEncoded

byte[] getEncoded()
Возвращает ключ в его основном формате кодирования или null, если этот ключ не поддерживает кодирование.
Возвращает:
закодированный ключ или null, если ключ не поддерживает кодирование.

© 1993, 2025, 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://download.java.net/java/early_access/jdk24/docs/api/java.base/java/security/Key.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API