Spec-Zone.ru › OpenJDK 17

Класс MessageDigest

java.lang.Object
java.security.MessageDigestSpi
java.security.MessageDigest
public abstract class MessageDigest extends MessageDigestSpi
Этот класс MessageDigest предоставляет приложениям функциональность алгоритма дайджеста сообщения, такого как SHA-1 или SHA-256. Дайджесты сообщений — это безопасные односторонние хеш-функции, которые принимают данные произвольного размера и выдают хеш-значение фиксированной длины.

Объект MessageDigest инициализируется в начальном состоянии. Данные обрабатываются с помощью методов update. В любой момент можно вызвать reset для сброса дайджеста. После того, как все данные, которые необходимо обновить, будут обновлены, следует вызвать один из методов digest для завершения вычисления хеша.

Метод digest может быть вызван один раз для заданного количества обновлений. После вызова digest объект MessageDigest сбрасывается в начальное состояние.

Реализации могут свободно реализовывать интерфейс Cloneable. Клиентские приложения могут проверить клонируемость, попытавшись выполнить клонирование и перехватив исключение CloneNotSupportedException: 


 MessageDigest md = MessageDigest.getInstance("SHA-256");

 try {
     md.update(toChapter1);
     MessageDigest tc1 = md.clone();
     byte[] toChapter1Digest = tc1.digest();
     md.update(toChapter2);
     ...etc.
 } catch (CloneNotSupportedException cnse) {
     throw new DigestException("couldn't make digest of partial content");
 }

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

Обратите внимание, что этот класс является абстрактным и расширяется от MessageDigestSpi по историческим причинам. Разработчики приложений должны обращать внимание только на методы, определенные в этом MessageDigest классе; все методы в суперклассе предназначены для поставщиков криптографических сервисов, которые хотят предоставить собственные реализации алгоритмов дайджеста сообщений.

Каждая реализация Java платформы обязана поддерживать следующие стандартные MessageDigest алгоритмы:

  • SHA-1
  • SHA-256
Эти алгоритмы описаны в разделе MessageDigest спецификации стандартных имен алгоритмов Java Security. Обратитесь к документации выпуска вашей реализации, чтобы узнать, поддерживаются ли какие-либо другие алгоритмы.
Since:
1.1
See Also:
  • DigestInputStream
  • DigestOutputStream

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

MessageDigest(String algorithm)
Модификатор Конструктор Описание
protected
Создаёт дайджест сообщения со заданным именем алгоритма.

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

Модификатор и тип Метод Описание
Object clone()
Возвращает клон, если реализация клонируема.
byte[] digest()
Завершает вычисление хеша, выполняя окончательные операции, такие как заполнение.
byte[] digest(byte[] input)
Выполняет окончательное обновление дайджеста с использованием указанного массива байтов, а затем завершает вычисление дайджеста.
int digest(byte[] buf, int offset, int len)
Завершает вычисление хеша, выполняя окончательные операции, такие как заполнение.
final String getAlgorithm()
Возвращает строку, идентифицирующую алгоритм, независимо от деталей реализации.
final int getDigestLength()
Возвращает длину дайджеста в байтах или 0, если эта операция не поддерживается поставщиком, и реализация не клонируема.
static MessageDigest getInstance(String algorithm)
Возвращает объект MessageDigest, реализующий указанный алгоритм дайджеста.
static MessageDigest getInstance(String algorithm, String provider)
Возвращает объект MessageDigest, реализующий указанный алгоритм дайджеста.
static MessageDigest getInstance(String algorithm, Provider provider)
Возвращает объект MessageDigest, реализующий указанный алгоритм дайджеста.
final Provider getProvider()
Возвращает поставщика этого объекта дайджеста сообщения.
static boolean isEqual(byte[] digesta, byte[] digestb)
Сравнивает два дайджеста на равенство.
void reset()
Сбрасывает дайджест для дальнейшего использования.
String toString()
Возвращает строковое представление этого объекта дайджеста сообщения.
void update(byte input)
Обновляет дайджест, используя указанный байт.
void update(byte[] input)
Обновляет дайджест, используя указанный массив байтов.
void update(byte[] input, int offset, int len)
Обновляет дайджест, используя указанный массив байтов, начиная с указанного смещения.
final void update(ByteBuffer input)
Обновляет дайджест, используя указанный ByteBuffer.

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

engineDigest, engineDigest, engineGetDigestLength, engineReset, engineUpdate, engineUpdate, engineUpdate

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

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

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

MessageDigest

protected MessageDigest(String algorithm)
Создаёт объект MessageDigest с указанным алгоритмом.
Параметры:
algorithm - стандартное имя алгоритма дайджеста. См. раздел MessageDigest в спецификации Java Security Standard Algorithm Names для получения информации о стандартных именах алгоритмов.

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

getInstance

public static MessageDigest getInstance(String algorithm) throws NoSuchAlgorithmException
Возвращает объект MessageDigest, реализующий указанный алгоритм дайджеста.

Этот метод перебирает список зарегистрированных поставщиков безопасности, начиная с наиболее предпочтительного. Возвращается новый объект MessageDigest, содержащий реализацию MessageDigestSpi из первого поставщика, поддерживающего указанный алгоритм.

Обратите внимание, что список зарегистрированных поставщиков можно получить с помощью метода Security.getProviders().

Примечание реализации:
Реализация JDK дополнительно использует свойство jdk.security.provider.preferred Security, чтобы определить предпочтительный порядок поставщиков для указанного алгоритма. Это может отличаться от порядка поставщиков, возвращаемого методом Security.getProviders().
Параметры:
algorithm - имя запрашиваемого алгоритма. См. раздел MessageDigest в спецификации Java Security Standard Algorithm Names для получения информации о стандартных именах алгоритмов.
Возвращает:
объект MessageDigest, реализующий указанный алгоритм
Исключения:
NoSuchAlgorithmException - если ни один Provider не поддерживает реализацию MessageDigestSpi для указанного алгоритма
NullPointerException - если algorithm является null
См. также:
  • Provider

getInstance

public static MessageDigest getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException
Возвращает объект MessageDigest, реализующий указанный алгоритм дайджеста.

Возвращается новый объект MessageDigest, содержащий реализацию MessageDigestSpi из указанного поставщика. Указанный поставщик должен быть зарегистрирован в списке поставщиков безопасности.

Обратите внимание, что список зарегистрированных поставщиков можно получить с помощью метода Security.getProviders().

Параметры:
algorithm - имя запрашиваемого алгоритма. См. раздел MessageDigest в спецификации Java Security Standard Algorithm Names для получения информации о стандартных именах алгоритмов.
provider - имя поставщика.
Возвращает:
объект MessageDigest, реализующий указанный алгоритм
Исключения:
IllegalArgumentException - если имя поставщика является null или пустым
NoSuchAlgorithmException - если реализация MessageDigestSpi для указанного алгоритма недоступна от указанного поставщика
NoSuchProviderException - если указанный поставщик не зарегистрирован в списке поставщиков безопасности
NullPointerException - если algorithm является null
См. также:
  • Provider

getInstance

public static MessageDigest getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException
Возвращает объект MessageDigest, реализующий указанный алгоритм дайджеста.

Возвращается новый объект MessageDigest, содержащий реализацию MessageDigestSpi из указанного объекта Provider. Обратите внимание, что указанный объект Provider не обязательно должен быть зарегистрирован в списке поставщиков.

Параметры:
algorithm - имя запрашиваемого алгоритма. См. раздел MessageDigest в спецификации Java Security Standard Algorithm Names для получения информации о стандартных именах алгоритмов.
provider - поставщик.
Возвращает:
объект MessageDigest, реализующий указанный алгоритм
Исключения:
IllegalArgumentException - если указанный поставщик является null
NoSuchAlgorithmException - если реализация MessageDigestSpi для указанного алгоритма недоступна от указанного объекта Provider
NullPointerException - если algorithm является null
С момента:
1.4
См. также:
  • Provider

getProvider

public final Provider getProvider()
Возвращает поставщика данного объекта message digest.
Возвращает:
поставщик данного объекта message digest

update

public void update(byte input)
Обновляет дайджест с использованием указанного байта.
Параметры:
input - байт, используемый для обновления дайджеста.

update

public void update(byte[] input, int offset, int len)
Обновляет дайджест с использованием указанного массива байтов, начиная с указанного смещения.
Параметры:
input - массив байтов.
offset - смещение для начала в массиве байтов.
len - количество байтов для использования, начиная со смещения offset.

update

public void update(byte[] input)
Обновляет дайджест с использованием указанного массива байтов.
Параметры:
input - массив байтов.

update

public final void update(ByteBuffer input)
Обновляет дайджест с использованием указанного буфера ByteBuffer. Дайджест обновляется с использованием input.remaining() байтов, начиная со смещения input.position(). По завершении метод установит позицию буфера равной его пределу; предел буфера не изменится.
Параметры:
input - буфер ByteBuffer
С момента:
1.5

digest

public byte[] digest()
Завершает вычисление хэша, выполняя заключительные операции, такие как заполнение. Дайджест сбрасывается после вызова этого метода.
Возвращает:
массив байтов для результирующего значения хэша.

digest

public int digest(byte[] buf, int offset, int len) throws DigestException
Завершает вычисление хэша, выполняя заключительные операции, такие как заполнение. Дайджест сбрасывается после вызова этого метода.
Параметры:
buf - буфер вывода для вычисленного дайджеста
offset - смещение в буфере вывода для начала сохранения дайджеста
len - количество байтов в буфере buf, выделенных для дайджеста
Возвращает:
количество байтов, помещенных в buf
Исключения:
DigestException - если произошла ошибка.

digest

public byte[] digest(byte[] input)
Выполняет окончательное обновление дайджеста с использованием указанного массива байтов, затем завершает вычисление дайджеста. То есть, этот метод сначала вызывает update(input), передавая массив input методу update, затем вызывает digest().
Параметры:
input - входные данные для обновления перед завершением вычисления дайджеста.
Возвращает:
массив байтов для результирующего значения хэша.

toString

public String toString()
Возвращает строковое представление объекта message digest.
Переопределяет:
toString в классе Object
Возвращает:
строковое представление объекта.

isEqual

public static boolean isEqual(byte[] digesta, byte[] digestb)
Сравнивает два дайджеста на равенство. Два дайджеста равны, если они имеют одинаковую длину и все байты в соответствующих позициях равны.
Примечание реализации:
Все байты в digesta проверяются на равенство. Время вычисления зависит только от длины digesta. Оно не зависит от длины digestb или содержимого digesta и digestb.
Параметры:
digesta - один из дайджестов для сравнения.
digestb - другой дайджест для сравнения.
Возвращает:
true, если дайджесты равны, false в противном случае.

reset

public void reset()
Сбрасывает дайджест для дальнейшего использования.

getAlgorithm

public final String getAlgorithm()
Возвращает строку, идентифицирующую алгоритм независимо от деталей реализации. Имя должно быть стандартным именем Java Security (например, "SHA-256"). См. раздел MessageDigest в спецификации Java Security Standard Algorithm Names для получения информации о стандартных именах алгоритмов.
Возвращает:
название алгоритма

getDigestLength

public final int getDigestLength()
Возвращает длину дайджеста в байтах или 0, если операция не поддерживается поставщиком, и реализация не клонируема.
Возвращает:
длину дайджеста в байтах или 0, если операция не поддерживается поставщиком, и реализация не клонируема.
С:
1.2

clone

public Object clone() throws CloneNotSupportedException
Возвращает копию, если реализация клонируема.
Переопределяет:
clone в классе MessageDigestSpi
Возвращает:
копию, если реализация клонируема.
Изначает:
CloneNotSupportedException - если это вызывается на реализации, которая не поддерживает Cloneable.
См. также:
  • Cloneable

© 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/MessageDigest.html

Spec-Zone.ru

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