net.rim.device.api.crypto
Class DSASignatureSigner

java.lang.Object
  net.rim.device.api.crypto.DSASignatureSigner

All Implemented Interfaces:

SignatureSigner

public final class DSASignatureSigner
extends Object
implements SignatureSigner

Signs a message using the DSA signature scheme.

The Digital Signature Algorithm ( DSA ) is defined in FIPS 186.

For information on cryptographic algorithms, see Crypto Algorithms.

See Also:

DSASignatureVerifier

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

Constructor Summary
	DSASignatureSigner(DSAPrivateKey key) Constructs a DSASignatureSigner object which uses SHA-1 to compute the signature.
	DSASignatureSigner(DSAPrivateKey key, Digest digest) Constructs a DSASignatureSigner object which uses digest to compute the signature.

Method Summary
	String	getAlgorithm() Returns the name of this signing algorithm ( "DSA/" + digest.getAlgorithm() ).
	String	getDigestAlgorithm() Returns the name of the digest algorithm used, eg "SHA1", etc.
	int	getRLength() Returns the length of r.
	int	getSLength() Returns the length of s.
	void	reset() Reinitializes the signer, preparing it to generate another signature.
	void	sign(byte[] r, int rOffset, byte[] s, int sOffset) Performs the signing operation for the DSA algorithm.
	void	update(byte[] data) Adds additional message data to the signature.
	void	update(byte[] data, int offset, int length) Adds additional message data to the signature.
	void	update(int data) Adds additional message data to the signature.

Methods inherited from class java.lang.Object

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

Constructor Detail

DSASignatureSigner

public DSASignatureSigner(DSAPrivateKey key)
                   throws CryptoTokenException,
                          CryptoUnsupportedOperationException

Constructs a DSASignatureSigner object which uses SHA-1 to compute the signature.

Parameters:

key - The private key to use.

Throws:

CryptoTokenException - Thrown if an error occurs with the crypto token or the crypto token is invalid.

CryptoUnsupportedOperationException - Thrown if a call is made to an unsupported operation.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

DSASignatureSigner

public DSASignatureSigner(DSAPrivateKey key,
                          Digest digest)
                   throws CryptoTokenException,
                          CryptoUnsupportedOperationException

Constructs a DSASignatureSigner object which uses digest to compute the signature.

NOTE: If the digest has any state information in it when it is given to the signature signer, this information will be incorparated into the signature. If you don't want this information included, call the reset routine for the signature signer to delete it. A newly created digest, which no update calls have been made too, has no state information in it by default.

Parameters:

key - The private key to use.

digest - An instance of the digest algorithm to use.

Throws:

CryptoTokenException - Thrown if an error occurs with the crypto token or the crypto token is invalid.

CryptoUnsupportedOperationException - Thrown if a call is made to an unsupported operation.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

Method Detail

getAlgorithm

public String getAlgorithm()

Returns the name of this signing algorithm ( "DSA/" + digest.getAlgorithm() ).

Specified by:

getAlgorithm in interface SignatureSigner

Returns:

A String that represents the name of the algorithm.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

getDigestAlgorithm

public String getDigestAlgorithm()

Returns the name of the digest algorithm used, eg "SHA1", etc.

Specified by:

getDigestAlgorithm in interface SignatureSigner

Returns:

A String that represents the name of the algorithm.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

reset

public void reset()

Description copied from interface: SignatureSigner

Reinitializes the signer, preparing it to generate another signature.

Specified by:

reset in interface SignatureSigner

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

update

public void update(int data)

Description copied from interface: SignatureSigner

Adds additional message data to the signature.

Specified by:

update in interface SignatureSigner

Parameters:

data - The byte to be hashed.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

update

public void update(byte[] data)

Description copied from interface: SignatureSigner

Adds additional message data to the signature.

Specified by:

update in interface SignatureSigner

Parameters:

data - The message data to hash.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

update

public void update(byte[] data,
                   int offset,
                   int length)

Description copied from interface: SignatureSigner

Adds additional message data to the signature.

Specified by:

update in interface SignatureSigner

Parameters:

data - The message data to hash.

offset - The offset, or the initial position to start reading in the data.

length - How much data to read.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

getRLength

public int getRLength()

Returns the length of r.

Returns:

An integer representing the length of r.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

getSLength

public int getSLength()

Returns the length of s.

Returns:

An integer representing the length of s.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

sign

public void sign(byte[] r,
                 int rOffset,
                 byte[] s,
                 int sOffset)
          throws CryptoTokenException,
                 CryptoUnsupportedOperationException

Performs the signing operation for the DSA algorithm.

Parameters:

r - A byte array containing the r component of the signature.

rOffset - The starting offset in the r byte array.

s - A byte array containing the s component of the signature.

sOffset - The starting offset in the s byte array.

Throws:

CryptoTokenException - Thrown if an error occurs with the crypto token or the crypto token is invalid.

CryptoUnsupportedOperationException - Thrown if a call is made to an unsupported operation.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0