org.mozilla.jss.crypto

Class Signature

public class Signature extends Object

Deprecated: Use the JCA interface instead (java.security.Signature)

A class for producing and verifying digital signatures. Instances of this class can be obtain from CryptoTokens.

See Also: CryptoToken

Field Summary
protected SignatureAlgorithmalgorithm
protected SignatureSpiengine
Constructor Summary
protected Signature()
Method Summary
protected Objectclone()
Cloning is not supported yet
StringgetAlgorithm()
Returns the name of the algorithm to be used for signing.
SignatureAlgorithmgetAlgorithmID()
Returns the algorithm to be used for signing.
ProvidergetProvider()
This is not supported yet.
voidinitSign(PrivateKey privateKey)
Initialize the signature context for signing.
voidinitVerify(PublicKey publicKey)
Initialize the signature context for verifying.
voidsetParameter(AlgorithmParameterSpec params)
Set parameters for the signing algorithm.
byte[]sign()
Finish a signing operation and return the signature.
intsign(byte[] outbuf, int offset, int len)
Finish a signing operation and store the signature in the provided buffer.
voidupdate(byte b)
Provide more data for a signature or verification operation.
voidupdate(byte[] data)
Provide more data for a signature or verification operation.
voidupdate(byte[] data, int off, int len)
Provide more data for a signature or verification operation.
booleanverify(byte[] signature)
Finish a verification operation.

Field Detail

algorithm

protected SignatureAlgorithm algorithm

engine

protected SignatureSpi engine

Constructor Detail

Signature

protected Signature()

Method Detail

clone

protected Object clone()
Cloning is not supported yet

getAlgorithm

public String getAlgorithm()
Returns the name of the algorithm to be used for signing.

getAlgorithmID

public SignatureAlgorithm getAlgorithmID()
Returns the algorithm to be used for signing.

getProvider

public Provider getProvider()
This is not supported yet.

initSign

public void initSign(PrivateKey privateKey)
Initialize the signature context for signing.

Parameters: privateKey The private key with which to sign.

Throws: InvalidKeyException If the key is the wrong type for the algorithm or does not exist on the token of this signature context. TokenException If an error occurred on the token.

initVerify

public void initVerify(PublicKey publicKey)
Initialize the signature context for verifying.

Parameters: publicKey The public key with which to verify the signature.

Throws: InvalidKeyException If the key is the wrong type for the algorithm. TokenException If an error occurs on the token.

setParameter

public void setParameter(AlgorithmParameterSpec params)
Set parameters for the signing algorithm. This is currently not supported or needed.

Parameters: params Parameters for the signing algorithm.

Throws: InvalidAlgorithmParameterException If there is something wrong with the parameters. TokenException If an error occurs on the token.

sign

public byte[] sign()
Finish a signing operation and return the signature.

Returns: The signature.

Throws: SignatureException If an error occurs with the signing operation. TokenException If an error occurs on the token.

sign

public int sign(byte[] outbuf, int offset, int len)
Finish a signing operation and store the signature in the provided buffer.

Parameters: outbuf Buffer to hold the signature offset Offset in buffer at which to store signature. len Number of bytes of buffer available for signature.

Returns: int The number of bytes placed into outbuf.

Throws: SignatureException If an error occurred while signing, or len was insufficient to contain the signature. TokenException If an error occurred on the token.

update

public void update(byte b)
Provide more data for a signature or verification operation.

Parameters: b A byte to be signed or verified.

Throws: SignatureException If an error occurs in the signature/verifcation. TokenException If an error occurs on the token.

update

public void update(byte[] data)
Provide more data for a signature or verification operation.

Parameters: data An array of bytes to be signed or verified.

Throws: SignatureException If an error occurs in the signature/verifcation. TokenException If an error occurs on the token.

update

public void update(byte[] data, int off, int len)
Provide more data for a signature or verification operation.

Parameters: data An array of bytes, some of which will be signed or verified. off The beginning offset of the bytes to be signed/verified. len The number of bytes to be signed/verified.

Throws: SignatureException If an error occurs in the signature/verifcation. TokenException If an error occurs on the token.

verify

public boolean verify(byte[] signature)
Finish a verification operation.

Parameters: signature The signature to be verified.

Returns: true if the signature is valid, false if it is invalid.

Throws: SignatureException If an error occurred with the verification operation TokenException If an error occurred on the token.