Package org.mozilla.jss.pkcs11

Class PK11MessageDigest

java.lang.Object

org.mozilla.jss.crypto.JSSMessageDigest

org.mozilla.jss.pkcs11.PK11MessageDigest

All Implemented Interfaces:

AutoCloseable

public final class PK11MessageDigest
extends JSSMessageDigest
implements AutoCloseable

Message Digesting with PKCS #11.

Field Summary

Fields

Modifier and Type	Field	Description
private DigestAlgorithm	alg
private CipherContextProxy	digestProxy
private PK11SymKey	hmacKey
private PK11Token	token

Constructor Summary

Constructors

Constructor	Description
PK11MessageDigest(PK11Token token, DigestAlgorithm alg)

Method Summary

Modifier and Type	Method	Description
void	close()
int	digest(byte[] outbuf, int offset, int len)	Completes digesting, storing the result into the provided array.
private static int	digest(CipherContextProxy proxy, byte[] outbuf, int offset, int len)
void	finalize()
DigestAlgorithm	getAlgorithm()
private static CipherContextProxy	initDigest(DigestAlgorithm alg)
void	initHMAC(SymmetricKey key)	Initializes an HMAC digest with the given symmetric key.
private static CipherContextProxy	initHMAC(PK11Token token, DigestAlgorithm alg, PK11SymKey key)
void	reset()	Resets this digest for further use.
void	update(byte[] input, int offset, int len)	Updates the digest with a portion of an array.
private static void	update(CipherContextProxy proxy, byte[] inbuf, int offset, int len)

Methods inherited from class org.mozilla.jss.crypto.JSSMessageDigest

digest, digest, getOutputSize, update, update

Methods inherited from class java.lang.Object

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

Field Details

token

private PK11Token token

digestProxy

private CipherContextProxy digestProxy

hmacKey

private PK11SymKey hmacKey

alg

private DigestAlgorithm alg

Constructor Details

PK11MessageDigest

PK11MessageDigest(PK11Token token,
 DigestAlgorithm alg)
           throws NoSuchAlgorithmException,
DigestException

Throws:

NoSuchAlgorithmException

DigestException

Method Details

initHMAC

public void initHMAC(SymmetricKey key)
              throws DigestException,
InvalidKeyException

Description copied from class: JSSMessageDigest

Initializes an HMAC digest with the given symmetric key. This also has the effect of resetting the digest.

Specified by:

initHMAC in class JSSMessageDigest

Parameters:

key - Symmetric key.

Throws:

DigestException - If this algorithm is not an HMAC algorithm.

InvalidKeyException - If the given key is not valid.

update

public void update(byte[] input,
 int offset,
 int len)
            throws DigestException

Description copied from class: JSSMessageDigest

Updates the digest with a portion of an array.

Specified by:

update in class JSSMessageDigest

Parameters:

input - An array from which to update the digest.

offset - The index in the array at which to start digesting.

len - The number of bytes to digest.

Throws:

DigestException - If an error occurs while digesting.

digest

public int digest(byte[] outbuf,
 int offset,
 int len)
           throws DigestException

Description copied from class: JSSMessageDigest

Completes digesting, storing the result into the provided array.

Specified by:

digest in class JSSMessageDigest

Parameters:

outbuf - The buffer in which to place the digest output.

offset - The offset in the buffer at which to store the output.

len - The amount of space available in the buffer for the digest output.

Returns:

The number of bytes actually stored into buf.

Throws:

DigestException - If the provided space is too small for the digest, or an error occurs with the digest.

reset

public void reset()
           throws DigestException

Description copied from class: JSSMessageDigest

Resets this digest for further use. This clears all input and output streams. If this is an HMAC digest, the HMAC key is not cleared.

Specified by:

reset in class JSSMessageDigest

Throws:

DigestException - If an error occurred.

getAlgorithm

public DigestAlgorithm getAlgorithm()

Specified by:

getAlgorithm in class JSSMessageDigest

Returns:

The algorithm that this digest uses.

initDigest

private static CipherContextProxy initDigest(DigestAlgorithm alg)
                                      throws DigestException

Throws:

DigestException

initHMAC

private static CipherContextProxy initHMAC(PK11Token token,
 DigestAlgorithm alg,
 PK11SymKey key)
                                    throws DigestException

Throws:

DigestException

update

private static void update(CipherContextProxy proxy,
 byte[] inbuf,
 int offset,
 int len)

digest

private static int digest(CipherContextProxy proxy,
 byte[] outbuf,
 int offset,
 int len)

finalize

public void finalize()
              throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception