Spec-Zone.ru › OpenJDK 21

Класс SecretKeySpec

java.lang.Object
javax.crypto.spec.SecretKeySpec
Все реализованные интерфейсы:
Serializable, Key, KeySpec, SecretKey, Destroyable
public class SecretKeySpec extends Object implements KeySpec, SecretKey
Этот класс определяет секретный ключ независимо от поставщика.

Его можно использовать для создания SecretKey из массива байтов, без необходимости прохождения через (зависимый от поставщика) SecretKeyFactory.

Этот класс полезен только для простых секретных ключей, которые могут быть представлены в виде массива байтов и не имеют связанных с ними параметров ключа, например, ключи DES или Triple DES.

С момента:
1.4
См. также:
  • SecretKey
  • SecretKeyFactory
  • Сериализованная форма

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

Конструктор Описание
SecretKeySpec(byte[] key, int offset, int len, String algorithm)
Создаёт секретный ключ из заданного массива байтов, используя первые len байты key, начиная с offset включительно.
SecretKeySpec(byte[] key, String algorithm)
Создаёт секретный ключ из заданного массива байтов.

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

Модификатор и тип Метод Описание
boolean equals(Object obj)
Проверяет равенство заданного объекта и этого объекта.
String getAlgorithm()
Возвращает имя алгоритма, связанного с этим секретным ключом.
byte[] getEncoded()
Возвращает ключевой материал этого секретного ключа.
String getFormat()
Возвращает имя формата кодирования для этого секретного ключа.
int hashCode()
Вычисляет значение хэш-кода для объекта.

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

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

Методы, объявленные в интерфейсе javax.security.auth.Destroyable

destroy, isDestroyed

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

SecretKeySpec

public SecretKeySpec(byte[] key, String algorithm)
Создаёт секретный ключ из заданного массива байтов.

Этот конструктор не проверяет, действительно ли заданные байты определяют секретный ключ указанного алгоритма. Например, если алгоритм DES, этот конструктор не проверяет, что key имеет длину 8 байт, а также не проверяет слабые или полуслабые ключи. Для выполнения этих проверок следует использовать класс спецификации ключа, специфичный для алгоритма (в данном случае: DESKeySpec).

Параметры:
key - ключевой материал секретного ключа. Содержимое массива копируется для защиты от последующего изменения.
algorithm - имя алгоритма секретного ключа, который следует связать с заданным ключевым материалом. См. документ Java Security Standard Algorithm Names для получения информации о стандартных именах алгоритмов.
Исключения:
IllegalArgumentException - если algorithm равно null или key равно null или пусто.

SecretKeySpec

public SecretKeySpec(byte[] key, int offset, int len, String algorithm)
Создаёт секретный ключ из заданного массива байтов, используя первые len байты key, начиная с offset включительно.

Байты, составляющие секретный ключ, находятся между key[offset] и key[offset+len-1] включительно.

Этот конструктор не проверяет, действительно ли заданные байты определяют секретный ключ указанного алгоритма. Например, если алгоритм DES, этот конструктор не проверяет, что key имеет длину 8 байт, а также не проверяет слабые или полуслабые ключи. Для выполнения этих проверок следует использовать класс спецификации ключа, специфичный для алгоритма (в данном случае: DESKeySpec).

Параметры:
key - ключевой материал секретного ключа. Первые len байты массива, начиная с offset включительно, копируются для защиты от последующего изменения.
offset - смещение в key для начала ключевого материала.
len - длина ключевого материала.
algorithm - имя алгоритма секретного ключа, который следует связать с заданным ключевым материалом. См. документ Java Security Standard Algorithm Names для получения информации о стандартных именах алгоритмов.
Исключения:
IllegalArgumentException - если algorithm равно null или key равно null, пусто или слишком короткое, т.е. key.length-offset<len.
ArrayIndexOutOfBoundsException - вызывается, если offset или len индексируют байты вне key.

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

getAlgorithm

public String getAlgorithm()
Возвращает имя алгоритма, связанного с этим секретным ключом.
Указано в:
getAlgorithm в интерфейсе Key
Возвращает:
алгоритм секретного ключа.

getFormat

public String getFormat()
Возвращает имя формата кодирования для этого секретного ключа.
Указано в:
getFormat в интерфейсе Key
Возвращает:
строку "RAW".

getEncoded

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

hashCode

public int hashCode()
Вычисляет значение хэш-кода для объекта. Объекты, которые равны, также будут иметь одинаковый хэш-код.
Переопределяет:
hashCode в классе Object
Возвращает:
значение хэш-кода для этого объекта.
См. также:
  • Object.equals(java.lang.Object)
  • System.identityHashCode(java.lang.Object)

equals

public boolean equals(Object obj)
Проверяет равенство заданного объекта и этого объекта. Два объекта SecretKeySpec считаются равными, если оба являются экземплярами SecretKey, имеющими одинаковое имя алгоритма (регистронезависимое) и кодирование ключа.
Переопределяет:
equals в классе Object
Параметры:
obj - объект для проверки равенства с этим объектом.
Возвращает:
true, если объекты считаются равными, false, если obj равно null или иным образом.
См. также:
  • Object.hashCode()
  • HashMap

© 1993, 2023, 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/21/docs/api/java.base/javax/crypto/spec/SecretKeySpec.html

Spec-Zone.ru

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