Signature

SIGN

protected static val SIGN: Int

Possible state value, signifying that this signature object has been initialized for signing.

Value: 2

UNINITIALIZED

protected static val UNINITIALIZED: Int

Possible state value, signifying that this signature object has not yet been initialized.

Value: 0

VERIFY

protected static val VERIFY: Int

Possible state value, signifying that this signature object has been initialized for verification.

Value: 3

Signature

protected Signature(algorithm: String!)

Creates a Signature object for the specified algorithm.

clone

open fun clone(): Any!

Returns a clone if the implementation is cloneable.

getAlgorithm

fun getAlgorithm(): String!

Returns the name of the algorithm for this signature object.

getInstance

open static fun getInstance(algorithm: String!): Signature!

Returns a Signature object that implements the specified signature algorithm.

This method traverses the list of registered security Providers, starting with the most preferred Provider. A new Signature object encapsulating the SignatureSpi implementation from the first Provider that supports the specified algorithm is returned.

Note that the list of registered providers may be retrieved via the Security.getProviders() method.

getInstance

open static fun getInstance(
    algorithm: String!, 
    provider: String!
): Signature!

Returns a Signature object that implements the specified signature algorithm.

A new Signature object encapsulating the SignatureSpi implementation from the specified provider is returned. The specified provider must be registered in the security provider list.

Note that the list of registered providers may be retrieved via the Security.getProviders() method.

getInstance

open static fun getInstance(
    algorithm: String!, 
    provider: Provider!
): Signature!

Returns a Signature object that implements the specified signature algorithm.

A new Signature object encapsulating the SignatureSpi implementation from the specified Provider object is returned. Note that the specified Provider object does not have to be registered in the provider list.

getParameter

fun getParameter(param: String!): Any!

Deprecated: Deprecated.

Gets the value of the specified algorithm parameter. This method supplies a general-purpose mechanism through which it is possible to get the various parameters of this object. A parameter may be any settable parameter for the algorithm, such as a parameter size, or a source of random bits for signature generation (if appropriate), or an indication of whether or not to perform a specific but optional computation. A uniform algorithm-specific naming scheme for each parameter is desirable but left unspecified at this time.

getParameters

fun getParameters(): AlgorithmParameters!

Returns the parameters used with this signature object.

The returned parameters may be the same that were used to initialize this signature, or may contain a combination of default and randomly generated parameter values used by the underlying signature implementation if this signature requires algorithm parameters but was not initialized with any.

getProvider

fun getProvider(): Provider!

Returns the provider of this signature object.

initSign

fun initSign(privateKey: PrivateKey!): Unit

Initialize this object for signing. If this method is called again with a different argument, it negates the effect of this call.

initSign

fun initSign(
    privateKey: PrivateKey!, 
    random: SecureRandom!
): Unit

Initialize this object for signing. If this method is called again with a different argument, it negates the effect of this call.

initVerify

fun initVerify(publicKey: PublicKey!): Unit

Initializes this object for verification. If this method is called again with a different argument, it negates the effect of this call.

initVerify

fun initVerify(certificate: Certificate!): Unit

Initializes this object for verification, using the public key from the given certificate.

If the certificate is of type X.509 and has a key usage extension field marked as critical, and the value of the key usage extension field implies that the public key in the certificate and its corresponding private key are not supposed to be used for digital signatures, an InvalidKeyException is thrown.

setParameter

fun setParameter(
    param: String!, 
    value: Any!
): Unit

Deprecated: Use setParameter.

Sets the specified algorithm parameter to the specified value. This method supplies a general-purpose mechanism through which it is possible to set the various parameters of this object. A parameter may be any settable parameter for the algorithm, such as a parameter size, or a source of random bits for signature generation (if appropriate), or an indication of whether or not to perform a specific but optional computation. A uniform algorithm-specific naming scheme for each parameter is desirable but left unspecified at this time.

setParameter

fun setParameter(params: AlgorithmParameterSpec!): Unit

Initializes this signature engine with the specified parameter set.

sign

fun sign(): ByteArray!

Returns the signature bytes of all the data updated. The format of the signature depends on the underlying signature scheme.

A call to this method resets this signature object to the state it was in when previously initialized for signing via a call to initSign(PrivateKey). That is, the object is reset and available to generate another signature from the same signer, if desired, via new calls to update and sign.

sign

fun sign(
    outbuf: ByteArray!, 
    offset: Int, 
    len: Int
): Int

Finishes the signature operation and stores the resulting signature bytes in the provided buffer outbuf, starting at offset. The format of the signature depends on the underlying signature scheme.

This signature object is reset to its initial state (the state it was in after a call to one of the initSign methods) and can be reused to generate further signatures with the same private key.

toString

open fun toString(): String

Returns a string representation of this signature object, providing information that includes the state of the object and the name of the algorithm used.

update

fun update(b: Byte): Unit

Updates the data to be signed or verified by a byte.

update

fun update(data: ByteArray!): Unit

Updates the data to be signed or verified, using the specified array of bytes.

update

fun update(
    data: ByteArray!, 
    off: Int, 
    len: Int
): Unit

Updates the data to be signed or verified, using the specified array of bytes, starting at the specified offset.

update

fun update(data: ByteBuffer!): Unit

Updates the data to be signed or verified using the specified ByteBuffer. Processes the data.remaining() bytes starting at at data.position(). Upon return, the buffer's position will be equal to its limit; its limit will not have changed.

verify

fun verify(signature: ByteArray!): Boolean

Verifies the passed-in signature.

A call to this method resets this signature object to the state it was in when previously initialized for verification via a call to initVerify(PublicKey). That is, the object is reset and available to verify another signature from the identity whose public key was specified in the call to initVerify.

verify

fun verify(
    signature: ByteArray!, 
    offset: Int, 
    length: Int
): Boolean

Verifies the passed-in signature in the specified array of bytes, starting at the specified offset.

A call to this method resets this signature object to the state it was in when previously initialized for verification via a call to initVerify(PublicKey). That is, the object is reset and available to verify another signature from the identity whose public key was specified in the call to initVerify.

state

protected var state: Int

Current state of this signature object.