Spec-Zone.ru › OpenJDK 8

Интерфейс Key

Все суперинтерфейсы:
Serializable
Все известные подинтерфейсы:
DHPrivateKey, DHPublicKey, DSAPrivateKey, DSAPublicKey, ECPrivateKey, ECPublicKey, PBEKey, PrivateKey, PublicKey, RSAMultiPrimePrivateCrtKey, RSAPrivateCrtKey, RSAPrivateKey, RSAPublicKey, SecretKey
Все известные реализующие классы:
KerberosKey, SecretKeySpec

public interface Key
extends Serializable

Интерфейс Key является верхним интерфейсом для всех ключей. Он определяет функциональность, общую для всех объектов ключей. Все ключи имеют три характеристики:

  • Алгоритм

    Это алгоритм ключа. Алгоритм ключа обычно является алгоритмом шифрования или асимметричной операции (например, DSA или RSA), который будет работать с этими алгоритмами и с сопутствующими алгоритмами (например, MD5 с RSA, SHA-1 с RSA, Raw 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: Internet X.509 Public Key Infrastructure Certificate and CRL Profile.
  • Формат

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

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

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

См. также:
PublicKey, PrivateKey, KeyPair, KeyPairGenerator, KeyFactory, KeyRep, KeySpec, Identity, Signer

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

Модификатор и тип Поле и описание
static long serialVersionUID

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

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

Модификатор и тип Метод и описание
String getAlgorithm()

Возвращает стандартное имя алгоритма для этого ключа.

byte[] getEncoded()

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

String getFormat()

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

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

serialVersionUID

static final long serialVersionUID

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

См. также:
Значения константных полей

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

getAlgorithm

String getAlgorithm()

Возвращает стандартное имя алгоритма для этого ключа. Например, "DSA" указывает, что этот ключ является ключом DSA. См. Приложение A в Спецификации API архитектуры Java Cryptography и справке для получения информации о стандартных именах алгоритмов.

Возвращает:
имя алгоритма, связанного с этим ключом.

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, 2020, 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.

Spec-Zone.ru

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