Класс подписи

public abstract class Signature
extends SignatureSpi

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

Алгоритм подписи может быть, среди прочих, стандартом NIST DSA, используя DSA и SHA-256. Алгоритм DSA, использующий алгоритм дайджеста сообщений SHA-256, может быть указан как SHA256withDSA. В случае RSA алгоритм подписи может быть указан, например, как SHA256withRSA. Имя алгоритма должно быть указано, так как по умолчанию его нет.

Объект Signature можно использовать для генерации и проверки цифровых подписей.

Существует три фазы использования объекта Signature для подписи данных или проверки подписи:

1. Инициализация с помощью
   • открытого ключа, который инициализирует подпись для проверки (см. initVerify), или
   • закрытого ключа (и необязательно генератора случайных чисел Secure Random), который инициализирует подпись для подписи (см. initSign(PrivateKey) и initSign(PrivateKey, SecureRandom)).
2. Обновление

   В зависимости от типа инициализации, это обновит байты, которые будут подписаны или проверены. См. методы update.

3. Подпись или проверка подписи на всех обновленных байтах. См. методы sign и метод verify.

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

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

• SHA1withDSA
• SHA1withRSA
• SHA256withRSA

Эти алгоритмы описаны в разделе Signature документации стандартных имен алгоритмов архитектуры Java Cryptography. Обратитесь к документации выпуска вашей реализации, чтобы узнать, какие другие алгоритмы поддерживаются.

Поля

НЕИНИЦИАЛИЗИРОВАННЫЙ

protected static final int UNINITIALIZED

Возможная state величина, обозначающая, что этот объект подписи ещё не был инициализирован.

См. также:

Значения постоянных полей

ПОДПИСЬ

protected static final int SIGN

Возможная state величина, обозначающая, что этот объект подписи был инициализирован для подписи.

См. также:

Значения постоянных полей

ПРОВЕРКА

protected static final int VERIFY

Возможная state величина, обозначающая, что этот объект подписи был инициализирован для проверки.

См. также:

Значения постоянных полей

состояние

protected int state

Текущее состояние этого объекта подписи.

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

Signature

protected Signature(String algorithm)

Создаёт объект Signature для указанного алгоритма.

Параметры:

algorithm - стандартное строковое имя алгоритма. См. раздел "Подпись" в документации по стандартным именам алгоритмов Java Cryptography Architecture для получения информации о стандартных именах алгоритмов.

Методы

getInstance

public static Signature getInstance(String algorithm)
                             throws NoSuchAlgorithmException

Параметры:

algorithm - стандартное имя запрашиваемого алгоритма. См. раздел "Подпись" в документации по стандартным именам алгоритмов Java Cryptography Architecture для получения информации о стандартных именах алгоритмов.

Возвращает:

новый объект Signature.

Исключения:

NoSuchAlgorithmException - если ни один поставщик не поддерживает реализацию Signature для указанного алгоритма.

См. также:

Provider

getInstance

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

Параметры:

algorithm - имя запрашиваемого алгоритма. См. раздел "Подпись" в документации по стандартным именам алгоритмов Java Cryptography Architecture для получения информации о стандартных именах алгоритмов.

provider - имя поставщика.

Возвращает:

новый объект Signature.

Исключения:

NoSuchAlgorithmException - если реализация SignatureSpi для указанного алгоритма недоступна от указанного поставщика.

NoSuchProviderException - если указанный поставщик не зарегистрирован в списке поставщиков безопасности.

IllegalArgumentException - если имя поставщика null или пустое.

См. также:

Provider

getInstance

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

Параметры:

algorithm - имя запрашиваемого алгоритма. См. раздел "Подпись" в документации по стандартным именам алгоритмов Java Cryptography Architecture для получения информации о стандартных именах алгоритмов.

provider - поставщик.

Возвращает:

новый объект Signature.

Исключения:

NoSuchAlgorithmException - если реализация SignatureSpi для указанного алгоритма недоступна от указанного объекта Provider.

IllegalArgumentException - если поставщик null.

С тех пор:

1.4

См. также:

Provider

getProvider

public final Provider getProvider()

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

Возвращает:

поставщик этого объекта подписи

initVerify

public final void initVerify(PublicKey publicKey)
                      throws InvalidKeyException

Инициализирует этот объект для проверки. Если этот метод вызывается снова с другим аргументом, он аннулирует действие этого вызова.

Параметры:

publicKey - открытый ключ субъекта, чья подпись будет проверяться.

Исключения:

InvalidKeyException - если ключ некорректен.

initVerify

public final void initVerify(Certificate certificate)
                      throws InvalidKeyException

Параметры:

certificate - сертификат субъекта, чья подпись будет проверяться.

Исключения:

InvalidKeyException - если открытый ключ в сертификате закодирован неправильно или не содержит необходимой информации, или не может быть использован для целей цифровой подписи.

С тех пор:

1.3

initSign

public final void initSign(PrivateKey privateKey)
                    throws InvalidKeyException

Инициализирует этот объект для подписи. Если этот метод вызывается снова с другим аргументом, он аннулирует действие этого вызова.

Параметры:

privateKey - закрытый ключ субъекта, чья подпись будет генерироваться.

Исключения:

InvalidKeyException - если ключ некорректен.

initSign

public final void initSign(PrivateKey privateKey,
                           SecureRandom random)
                    throws InvalidKeyException

Инициализирует этот объект для подписи. Если этот метод вызывается снова с другим аргументом, он аннулирует действие этого вызова.

Параметры:

privateKey - закрытый ключ субъекта, чья подпись будет генерироваться.

random - источник случайности для этой подписи.

Исключения:

InvalidKeyException - если ключ некорректен.

sign

public final byte[] sign()
                  throws SignatureException

Возвращает:

байты подписи результата операции подписи.

Исключения:

SignatureException - если этот объект подписи не инициализирован должным образом или если этот алгоритм подписи не может обработать предоставленные входные данные.

sign

public final int sign(byte[] outbuf,
                      int offset,
                      int len)
               throws SignatureException

Параметры:

outbuf - буфер для результата подписи.

offset - смещение в outbuf, где хранится подпись.

len - количество байтов в outbuf, выделенных для подписи.

Возвращает:

количество байтов, помещенных в outbuf.

Исключения:

SignatureException - если этот объект подписи не инициализирован должным образом, если этот алгоритм подписи не может обработать предоставленные входные данные или если len меньше фактической длины подписи.

С тех пор:

1.2

verify

public final boolean verify(byte[] signature)
                     throws SignatureException

Параметры:

signature - байты подписи для проверки.

Возвращает:

true, если подпись проверена, false — если нет.

Исключения:

SignatureException - если этот объект подписи не инициализирован должным образом, переданная подпись закодирована неправильно или имеет неправильный тип, если этот алгоритм подписи не может обработать предоставленные входные данные и т.д.

verify

public final boolean verify(byte[] signature,
                            int offset,
                            int length)
                     throws SignatureException

Параметры:

signature - байты подписи для проверки.

offset - смещение для начала в массиве байтов.

length - количество байтов для использования, начиная со смещения.

Возвращает:

true, если подпись была проверена, false — если нет.

Выбрасывает:

SignatureException - если объект подписи не инициализирован должным образом, переданная подпись закодирована неправильно или имеет неправильный тип, если алгоритм подписи не может обработать предоставленные входные данные и т. п.

IllegalArgumentException - если массив байтов signature null, или offset или length меньше 0, или сумма offset и length больше длины массива байтов signature.

С:

1.4

update

public final void update(byte b)
                  throws SignatureException

Обновляет данные для подписи или проверки с помощью байта.

Параметры:

b - байт для использования при обновлении.

Выбрасывает:

SignatureException - если объект подписи не инициализирован должным образом.

update

public final void update(byte[] data)
                  throws SignatureException

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

Параметры:

data - массив байтов для использования при обновлении.

Выбрасывает:

SignatureException - если объект подписи не инициализирован должным образом.

update

public final void update(byte[] data,
                         int off,
                         int len)
                  throws SignatureException

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

Параметры:

data - массив байтов.

off - смещение для начала в массиве байтов.

len - количество байтов для использования, начиная со смещения.

Выбрасывает:

SignatureException - если объект подписи не инициализирован должным образом.

update

public final void update(ByteBuffer data)
                  throws SignatureException

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

Параметры:

data - ByteBuffer

Выбрасывает:

SignatureException - если объект подписи не инициализирован должным образом.

С:

1.5

getAlgorithm

public final String getAlgorithm()

Возвращает имя алгоритма для данного объекта подписи.

Возвращает:

имя алгоритма для данного объекта подписи.

toString

public String toString()

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

Переопределяет:

toString в классе Object

Возвращает:

строковое представление объекта подписи.

setParameter

@Deprecated
public final void setParameter(String param,
                                           Object value)
                                    throws InvalidParameterException

Устарело. Используйте setParameter.

Устанавливает указанный параметр алгоритма в указанное значение. Этот метод предоставляет общий механизм для установки различных параметров этого объекта. Параметр может быть любым настраиваемым параметром алгоритма, таким как размер параметра или источник случайных битов для генерации подписи (при необходимости), или указание выполнять или не выполнять определённое, но необязательное вычисление. Желательно использовать единую схему именования параметров, специфичных для алгоритма, но она не определена в данный момент.

Параметры:

param - строковый идентификатор параметра.

value - значение параметра.

Выбрасывает:

InvalidParameterException - если param является недопустимым параметром для данного алгоритма шифрования, параметр уже установлен и не может быть повторно установлен, возникает исключение безопасности и т. п.

См. также:

getParameter(java.lang.String)

setParameter

public final void setParameter(AlgorithmParameterSpec params)
                        throws InvalidAlgorithmParameterException

Инициализирует этот движок подписи указанным набором параметров.

Параметры:

params - параметры

Выбрасывает:

InvalidAlgorithmParameterException - если заданные параметры неприемлемы для данного движка подписи

См. также:

getParameters()

getParameters

public final AlgorithmParameters getParameters()

Возвращает:

используемые параметры подписи, или null

С:

1.4

См. также:

setParameter(AlgorithmParameterSpec)

getParameter

@Deprecated
public final Object getParameter(String param)
                                      throws InvalidParameterException

Устарело.

Возвращает значение указанного параметра алгоритма. Этот метод предоставляет общий механизм для получения различных параметров этого объекта. Параметр может быть любым настраиваемым параметром алгоритма, таким как размер параметра, или источник случайных битов для генерации подписи (если применимо), или указание выполнить или не выполнять определённое, но необязательное вычисление. Желательно использовать единую схему именования параметров, специфичных для алгоритма, но она не определена в данный момент.

Параметры:

param - строковое имя параметра.

Возвращает:

объект, представляющий значение параметра, или null , если его нет.

Выбрасывает:

InvalidParameterException - если param является недопустимым параметром для этого движка, или при попытке получить этот параметр возникает другое исключение.

См. также:

setParameter(String, Object)

clone

public Object clone()
             throws CloneNotSupportedException

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

Переопределяет:

clone в классе SignatureSpi

Возвращает:

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

Выбрасывает:

CloneNotSupportedException - если этот метод вызывается для реализации, которая не поддерживает Cloneable.

См. также:

Cloneable