Подпись класса

java.lang.Object

java.security.SignatureSpi

java.security.Signature

public abstract class Signature extends SignatureSpi

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

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

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

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

Инициализация, с использованием либо
- открытого ключа, который инициализирует подпись для проверки (см. initVerify), или
- закрытого ключа (и необязательно генератора случайных чисел Secure Random Number Generator), который инициализирует подпись для подписи (см. initSign(PrivateKey) и initSign(PrivateKey, SecureRandom)).
Обновление
В зависимости от типа инициализации, это обновит байты для подписи или проверки. Смотрите методы update.
Подпись или Проверка подписи на всех обновленных байтах. См. методы sign и метод verify.

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

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

SHA1withDSA
SHA256withDSA
SHA1withRSA
SHA256withRSA

Эти алгоритмы описаны в разделе Раздел подписи спецификации Java Security Standard Algorithm Names. Обратитесь к документации выпуска вашей реализации, чтобы узнать, поддерживаются ли какие-либо другие алгоритмы.

С:: 1.1

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

Модификатор и тип	Поле	Описание
`protected static final int`	`SIGN`	Возможная `state` значение, означающее, что этот объект `Signature` был инициализирован для подписи.
`protected int`	`state`	Текущее состояние этого объекта `Signature`.
`protected static final int`	`UNINITIALIZED`	Возможная `state` значение, означающее, что этот объект `Signature` еще не был инициализирован.
`protected static final int`	`VERIFY`	Возможная `state` значение, означающее, что этот объект `Signature` был инициализирован для проверки.

Поля, объявленные в классе java.security.SignatureSpi

appRandom

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

Signature(String algorithm)

Модификатор	Конструктор	Описание
`protected`	Создает объект `Signature` для указанного алгоритма.

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

Модификатор и тип	Метод	Описание
`Object`	`clone()`	Возвращает клон, если реализация клонируема.
`final String`	`getAlgorithm()`	Возвращает имя алгоритма для этого объекта `Signature`.
`static Signature`	`getInstance(String algorithm)`	Возвращает объект `Signature`, который реализует указанный алгоритм подписи.
`static Signature`	`getInstance(String algorithm, String provider)`	Возвращает объект `Signature`, который реализует указанный алгоритм подписи.
`static Signature`	`getInstance(String algorithm, Provider provider)`	Возвращает объект `Signature`, который реализует указанный алгоритм подписи.
`final Object`	`getParameter(String param)`	Устарело.
`final AlgorithmParameters`	`getParameters()`	Возвращает параметры, используемые с этим объектом `Signature`.
`final Provider`	`getProvider()`	Возвращает поставщика этого объекта `Signature`.
`final void`	`initSign(PrivateKey privateKey)`	Инициализирует этот объект для подписи.
`final void`	`initSign(PrivateKey privateKey, SecureRandom random)`	Инициализирует этот объект для подписи.
`final void`	`initVerify(Certificate certificate)`	Инициализирует этот объект для проверки, используя открытый ключ из данного сертификата.
`final void`	`initVerify(PublicKey publicKey)`	Инициализирует этот объект для проверки.
`final void`	`setParameter(String param, Object value)`	Устарело. Используйте `setParameter`.
`final void`	`setParameter(AlgorithmParameterSpec params)`	Инициализирует этот объект `Signature` с указанными параметрами.
`final byte[]`	`sign()`	Возвращает байты подписи всех обновленных данных.
`final int`	`sign(byte[] outbuf, int offset, int len)`	Завершает операцию подписи и сохраняет полученные байты подписи в предоставленном буфере `outbuf`, начиная с `offset`.
`String`	`toString()`	Возвращает строковое представление этого объекта `Signature`, предоставляя информацию, которая включает состояние объекта и имя используемого алгоритма.
`final void`	`update(byte b)`	Обновляет данные для подписи или проверки байтом.
`final void`	`update(byte[] data)`	Обновляет данные для подписи или проверки, используя указанный массив байтов.
`final void`	`update(byte[] data, int off, int len)`	Обновляет данные для подписи или проверки, используя указанный массив байтов, начиная с указанного смещения.
`final void`	`update(ByteBuffer data)`	Обновляет данные для подписи или проверки, используя указанный ByteBuffer.
`final boolean`	`verify(byte[] signature)`	Проверяет переданную подпись.
`final boolean`	`verify(byte[] signature, int offset, int length)`	Проверяет переданную подпись в указанном массиве байтов, начиная с указанного смещения.

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

engineGetParameter, engineGetParameters, engineInitSign, engineInitSign, engineInitVerify, engineSetParameter, engineSetParameter, engineSign, engineSign, engineUpdate, engineUpdate, engineUpdate, engineVerify, engineVerify

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

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

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

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

protected static final int UNINITIALIZED

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

См. также:

SIGN

protected static final int SIGN

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

См. также:

VERIFY

protected static final int VERIFY

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

См. также:

состояние

protected int state

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

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

Signature

protected Signature(String algorithm)

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

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

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

getInstance

public static Signature getInstance(String algorithm) throws NoSuchAlgorithmException

Возвращает Signature объект, реализующий указанный алгоритм подписи.

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

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

Примечание об реализации:

Реализация JDK Reference Implementation также использует свойство jdk.security.provider.preferred Security для определения предпочтительного порядка поставщиков для указанного алгоритма. Это может отличаться от порядка поставщиков, возвращаемого методом Security.getProviders().

Параметры:

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

Возвращает:

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

Исключения:

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

NullPointerException - если algorithm является null

См. также:

getInstance

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

Возвращает Signature объект, реализующий указанный алгоритм подписи.

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

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

Параметры:

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

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

Возвращает:

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

Исключения:

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

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

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

NullPointerException - если algorithm является null

См. также:

getInstance

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

Возвращает Signature объект, реализующий указанный алгоритм подписи.

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

Параметры:

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

Возвращает:

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

Исключения:

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

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

NullPointerException - если algorithm является null

С тех пор:

1.4

См. также:

getProvider

public final Provider getProvider()

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

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

initVerify

public final void initVerify(PublicKey publicKey) throws InvalidKeyException

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

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

initVerify

public final void initVerify(Certificate certificate) throws InvalidKeyException

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

Если сертификат типа X.509 и имеет поле расширения key usage, помеченное как критическое, и значение поля расширения key usage подразумевает, что открытый ключ в сертификате и соответствующий ему закрытый ключ не должны использоваться для цифровых подписей, будет брошено исключение 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 - источник случайных данных для этого Signature объекта
Исключения:: InvalidKeyException - если ключ некорректен.

sign

public final byte[] sign() throws SignatureException

Возвращает байты подписи всех обновлённых данных. Формат подписи зависит от используемого алгоритма подписи.

Вызов этого метода сбрасывает этот Signature объект в состояние, в котором он был при предыдущей инициализации для подписи с помощью вызова initSign(PrivateKey). То есть объект сбрасывается и готов сгенерировать другую подпись от того же подписывающего лица, при необходимости, через новые вызовы update и sign.

Возвращает:: байты подписи результата операции подписи.
Исключение:: SignatureException - если этот Signature объект не проинициализирован должным образом или если алгоритм подписи не может обработать предоставленные входные данные.

sign

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

Завершает операцию подписи и сохраняет полученные байты подписи в предоставленный буфер outbuf, начиная с позиции offset. Формат подписи зависит от используемого алгоритма подписи.

Этот Signature объект сбрасывается в исходное состояние (состояние после вызова одного из методов initSign) и может быть повторно использован для генерации дополнительных подписей с тем же закрытым ключом.

Параметры:: outbuf - буфер для результата подписи.; offset - смещение в outbuf, где хранится подпись.; len - количество байтов в outbuf, выделенных для подписи.
Возвращает:: количество байтов, помещённых в outbuf.
Исключение:: SignatureException - если этот Signature объект не проинициализирован должным образом, если алгоритм подписи не может обработать предоставленные входные данные или если len меньше фактической длины подписи.; IllegalArgumentException - если outbuf равно null, или offset или len меньше 0, или сумма offset и len больше длины outbuf.
С:: 1.2

verify

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

Проверяет предоставленную подпись.

Вызов этого метода сбрасывает этот Signature объект в состояние, в котором он был при предыдущей инициализации для проверки с помощью вызова initVerify(PublicKey). То есть объект сбрасывается и готов проверить другую подпись от субъекта, чей открытый ключ был указан в вызове initVerify.

Параметры:: signature - байты подписи для проверки.
Возвращает:: true, если подпись проверена, false, если нет.
Исключение:: SignatureException - если этот Signature объект не проинициализирован должным образом, предоставленная подпись имеет неправильный формат или тип, если алгоритм подписи не может обработать входные данные и т. д.

verify

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

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

Параметры:: signature - байты подписи для проверки.; offset - смещение для начала в массиве байтов.; length - количество байтов для использования, начиная со смещения.
Возвращает:: true, если подпись проверена, false, если нет.
Исключение:: SignatureException - если этот Signature объект не проинициализирован должным образом, предоставленная подпись имеет неправильный формат или тип, если алгоритм подписи не может обработать входные данные и т. д.; IllegalArgumentException - если массив байтов signature является null, или offset или length меньше 0, или сумма offset и length больше длины массива байтов signature.
С:: 1.4

update

public final void update(byte b) throws SignatureException

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

Параметры:: b - байт для обновления.
Исключение:: SignatureException - если этот Signature объект не проинициализирован должным образом.

update

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

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

Параметры:: data - массив байтов для обновления.
Исключение:: SignatureException - если этот Signature объект не проинициализирован должным образом.

update

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

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

Параметры:: data - массив байтов.; off - смещение для начала в массиве байтов.; len - количество байтов для использования, начиная со смещения.
Исключение:: SignatureException - если этот Signature объект не проинициализирован должным образом.; IllegalArgumentException - если data равно null, или off или len меньше 0, или сумма off и len больше длины data.

update

public final void update(ByteBuffer data) throws SignatureException

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

Параметры:: data - ByteBuffer
Исключение:: SignatureException - если этот Signature объект не проинициализирован должным образом.
С:: 1.5

getAlgorithm

public final String getAlgorithm()

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

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

toString

public String toString()

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

Переопределяет:: toString в классе Object
Возвращает:: строковое представление этого объекта Signature.

setParameter

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

Устарело.

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

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

Параметры:

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

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

Исключение:

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

См. также:

setParameter

public final void setParameter(AlgorithmParameterSpec params) throws InvalidAlgorithmParameterException

Инициализирует этот объект Signature с указанными значениями параметров.

Параметры:

params - значения параметров

Исключение:

InvalidAlgorithmParameterException - если заданные значения параметров неподходящие для этого объекта Signature

См. также:

END_OF_DOCUMENT_MARKER

getParameters

public final AlgorithmParameters getParameters()

Возвращает параметры, используемые с этим объектом Signature.

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

Однако, если схема подписи не поддерживает возврат параметров в виде AlgorithmParameters, всегда возвращается null.

Возвращает:

параметры, используемые с этим объектом Signature, или null

Имеет исключения:

UnsupportedOperationException - если поставщик не поддерживает этот метод

С:

1.4

См. также:

getParameter

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

Устарело.

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

Параметры:

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

Возвращает:

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

Имеет исключения:

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

См. также:

clone

public Object clone() throws CloneNotSupportedException

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

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

clone в классе SignatureSpi

Возвращает:

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

Имеет исключения:

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

См. также:

© 1993, 2025, 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://download.java.net/java/early_access/jdk24/docs/api/java.base/java/security/Signature.html