Spec-Zone.ru › OpenJDK 8

Класс Mac

  • java.lang.Object
    • javax.crypto.Mac
Все реализованные интерфейсы:
Cloneable

public class Mac
extends Object
implements Cloneable

Этот класс предоставляет функциональность алгоритма "Message Authentication Code" (MAC).

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

Механизм MAC, основанный на криптографических хеш-функциях, называется HMAC. HMAC может использоваться с любой криптографической хеш-функцией, например, SHA256 или SHA384, в сочетании с секретным общим ключом. HMAC определен в RFC 2104.

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

  • HmacMD5
  • HmacSHA1
  • HmacSHA256
Эти алгоритмы описаны в разделе Mac документации по стандартным именам алгоритмов Java Cryptography Architecture. Обратитесь к документации выпуска для вашей реализации, чтобы узнать, какие другие алгоритмы поддерживаются.
С:
1.4

Конструкторы

Модификатор Конструктор и описание
protected Mac(MacSpi macSpi, Provider provider, String algorithm)

Создаёт объект MAC.

Методы

Модификатор и тип Метод и описание
Object clone()

Возвращает клон, если реализация поставщика поддерживает клонирование.

byte[] doFinal()

Завершает операцию MAC.

byte[] doFinal(byte[] input)

Обрабатывает заданный массив байтов и завершает операцию MAC.

void doFinal(byte[] output, int outOffset)

Завершает операцию MAC.

String getAlgorithm()

Возвращает имя алгоритма этого объекта Mac.

static Mac getInstance(String algorithm)

Возвращает объект Mac, который реализует указанный алгоритм MAC.

static Mac getInstance(String algorithm, Provider provider)

Возвращает объект Mac, который реализует указанный алгоритм MAC.

static Mac getInstance(String algorithm, String provider)

Возвращает объект Mac, который реализует указанный алгоритм MAC.

int getMacLength()

Возвращает длину MAC в байтах.

Provider getProvider()

Возвращает поставщика этого объекта Mac.

void init(Key key)

Инициализирует этот объект Mac заданным ключом.

void init(Key key, AlgorithmParameterSpec params)

Инициализирует этот объект Mac заданным ключом и параметрами алгоритма.

void reset()

Сбрасывает этот объект Mac.

void update(byte input)

Обрабатывает заданный байт.

void update(byte[] input)

Обрабатывает заданный массив байтов.

void update(byte[] input, int offset, int len)

Обрабатывает первые len байты в input, начиная с offset.

void update(ByteBuffer input)

Обрабатывает input.remaining() байтов в буфере ByteBuffer input, начиная с input.position().

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

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

Конструкторы

Mac

protected Mac(MacSpi macSpi,
              Provider provider,
              String algorithm)

Создаёт объект MAC.

Параметры:
macSpi - делегат
provider - провайдер
algorithm - алгоритм

Методы

getAlgorithm

public final String getAlgorithm()

Возвращает имя алгоритма этого объекта Mac.

Это то же имя, что было указано в одном из вызовов getInstance, которые создали этот объект Mac.

Возвращает:
имя алгоритма этого объекта Mac.

getInstance

public static final Mac getInstance(String algorithm)
                             throws NoSuchAlgorithmException

Возвращает объект Mac, реализующий указанный алгоритм MAC.

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

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

Параметры:
algorithm - стандартное имя запрашиваемого алгоритма MAC. См. раздел Mac в документации Java Cryptography Architecture по стандартным именам алгоритмов для получения информации о стандартных именах алгоритмов.
Возвращает:
новый объект Mac.
Исключения:
NoSuchAlgorithmException - если ни один поставщик не поддерживает реализацию MacSpi для указанного алгоритма.
См. также:
Provider

getInstance

public static final Mac getInstance(String algorithm,
                                    String provider)
                             throws NoSuchAlgorithmException,
                                    NoSuchProviderException

Возвращает объект Mac, реализующий указанный алгоритм MAC.

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

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

Параметры:
algorithm - стандартное имя запрашиваемого алгоритма MAC. См. раздел Mac в документации Java Cryptography Architecture по стандартным именам алгоритмов для получения информации о стандартных именах алгоритмов.
provider - имя поставщика.
Возвращает:
новый объект Mac.
Исключения:
NoSuchAlgorithmException - если реализация MacSpi для указанного алгоритма недоступна от указанного поставщика.
NoSuchProviderException - если указанный поставщик не зарегистрирован в списке поставщиков безопасности.
IllegalArgumentException - если provider равно null или пустое.
См. также:
Provider

getInstance

public static final Mac getInstance(String algorithm,
                                    Provider provider)
                             throws NoSuchAlgorithmException

Возвращает объект Mac, реализующий указанный алгоритм MAC.

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

Параметры:
algorithm - стандартное имя запрашиваемого алгоритма MAC. См. раздел Mac в документации Java Cryptography Architecture по стандартным именам алгоритмов для получения информации о стандартных именах алгоритмов.
provider - поставщик.
Возвращает:
новый объект Mac.
Исключения:
NoSuchAlgorithmException - если реализация MacSpi для указанного алгоритма недоступна от указанного объекта поставщика.
IllegalArgumentException - если provider равно null.
См. также:
Provider

getProvider

public final Provider getProvider()

Возвращает поставщика этого объекта Mac.

Возвращает:
поставщик этого объекта Mac.

getMacLength

public final int getMacLength()

Возвращает длину MAC в байтах.

Возвращает:
длину MAC в байтах.

init

public final void init(Key key)
                throws InvalidKeyException

Инициализирует этот объект Mac заданным ключом.

Параметры:
key - ключ.
Исключения:
InvalidKeyException - если заданный ключ не подходит для инициализации этого MAC.

init

public final void init(Key key,
                       AlgorithmParameterSpec params)
                throws InvalidKeyException,
                       InvalidAlgorithmParameterException

Инициализирует этот объект Mac заданным ключом и параметрами алгоритма.

Параметры:
key - ключ.
params - параметры алгоритма.
Исключения:
InvalidKeyException - если заданный ключ не подходит для инициализации этого MAC.
InvalidAlgorithmParameterException - если заданные параметры алгоритма не подходят для этого MAC.

update

public final void update(byte input)
                  throws IllegalStateException

Обрабатывает заданный байт.

Параметры:
input - входной байт для обработки.
Исключения:
IllegalStateException - если этот объект Mac не был инициализирован.

update

public final void update(byte[] input)
                  throws IllegalStateException

Обрабатывает заданный массив байтов.

Параметры:
input - массив байтов для обработки.
Исключения:
IllegalStateException - если этот объект Mac не был инициализирован.

update

public final void update(byte[] input,
                         int offset,
                         int len)
                  throws IllegalStateException

Обрабатывает первые len байтов в input, начиная с offset включительно.

Параметры:
input - входной буфер.
offset - смещение в input, где начинается входной массив.
len - количество байтов для обработки.
Исключения:
IllegalStateException - если этот объект Mac не был инициализирован.

update

public final void update(ByteBuffer input)

Обрабатывает input.remaining() байтов в буфере ByteBuffer input, начиная с input.position(). По возвращении позиция буфера будет равна его пределу; его предел не изменится.

Параметры:
input - ByteBuffer
Исключения:
IllegalStateException - если этот объект Mac не был инициализирован.
С:
1.5

doFinal

public final byte[] doFinal()
                     throws IllegalStateException

Завершает операцию MAC.

Вызов этого метода сбрасывает этот объект Mac до состояния, в котором он находился при предыдущей инициализации с помощью вызова init(Key) или init(Key, AlgorithmParameterSpec). То есть объект сбрасывается и готов сгенерировать другой MAC от того же ключа, если это необходимо, при помощи новых вызовов update и doFinal. (Для повторного использования этого объекта Mac с другим ключом необходимо повторно инициализировать его вызовом init(Key) или init(Key, AlgorithmParameterSpec)).

Возвращает:
результат MAC.
Исключения:
IllegalStateException - если этот объект Mac не был инициализирован.

doFinal

public final void doFinal(byte[] output,
                          int outOffset)
                   throws ShortBufferException,
                          IllegalStateException

Завершает операцию MAC.

Вызов этого метода сбрасывает этот объект Mac до состояния, в котором он находился при предыдущей инициализации с помощью вызова init(Key) или init(Key, AlgorithmParameterSpec). То есть объект сбрасывается и готов сгенерировать другой MAC от того же ключа, если это необходимо, при помощи новых вызовов update и doFinal. (Для повторного использования этого объекта Mac с другим ключом необходимо повторно инициализировать его вызовом init(Key) или init(Key, AlgorithmParameterSpec)).

Результат MAC сохраняется в output, начиная со смещения outOffset включительно.

Параметры:
output - буфер, в котором хранится результат MAC
outOffset - смещение в output, где хранится MAC
Исключения:
ShortBufferException - если заданный выходной буфер слишком мал, чтобы вместить результат
IllegalStateException - если этот объект Mac не был инициализирован.

doFinal

public final byte[] doFinal(byte[] input)
                     throws IllegalStateException

Обрабатывает заданный массив байтов и завершает операцию MAC.

Вызов этого метода сбрасывает этот объект Mac до состояния, в котором он находился при предыдущей инициализации с помощью вызова init(Key) или init(Key, AlgorithmParameterSpec). То есть объект сбрасывается и готов сгенерировать другой MAC от того же ключа, если это необходимо, при помощи новых вызовов update и doFinal. (Для повторного использования этого объекта Mac с другим ключом необходимо повторно инициализировать его вызовом init(Key) или init(Key, AlgorithmParameterSpec)).

Параметры:
input - данные в байтах
Возвращает:
результат MAC.
Исключения:
IllegalStateException - если этот объект Mac не был инициализирован.

reset

public final void reset()

Сбрасывает этот объект Mac.

Вызов этого метода сбрасывает этот объект Mac до состояния, в котором он находился при предыдущей инициализации с помощью вызова init(Key) или init(Key, AlgorithmParameterSpec). То есть объект сбрасывается и готов сгенерировать другой MAC от того же ключа, если это необходимо, при помощи новых вызовов update и doFinal. (Для повторного использования этого объекта Mac с другим ключом необходимо повторно инициализировать его вызовом init(Key) или init(Key, AlgorithmParameterSpec)).

clone

public final Object clone()
                   throws CloneNotSupportedException

Возвращает копию, если реализация поставщика поддерживает клонирование.

Переопределяет:
clone в классе Object
Возвращает:
клонированный экземпляр, если реализация поставщика поддерживает клонирование.
Исключения:
CloneNotSupportedException - если этот метод вызван для делегата, не поддерживающего Cloneable.
См. также:
Cloneable

© 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