com.entrust.toolkit.security.crypto.digest

Class Ssl3ShaMd5Capi

java.lang.Object

java.security.MessageDigestSpi

java.security.MessageDigest

com.entrust.toolkit.security.crypto.digest.CapiDigest

com.entrust.toolkit.security.crypto.digest.Ssl3ShaMd5Capi

public final class Ssl3ShaMd5Capi
extends CapiDigest

An MS-CAPI based implementation of the SSL3-SHAMD5 message digest algorithm used in SSLv3.

An instance of this algorithm can be obtained using the Java Cryptography Architecture (JCA), by requesting an 'SSL3-SHAMD5CAPI' message digest from the Entrust cryptographic service provider. This can be done using the following call:

MessageDigest.getInstance("SSL3-SHAMD5CAPI", "Entrust");

FIPS 140-2:

This class is part of the Toolkit's FIPS 140-2 cryptographic module and contains APIs that are considered part of the logical interface to the Toolkit's FIPS 140-2 cryptographic module; refer to the API documentation for further details

Since:

7.0

Constructor Summary

Constructors

Constructor and Description
Ssl3ShaMd5Capi() The constructor; creates a new instance of the SSL3-SHAMD5 message digest algorithm.

Method Summary

Modifier and Type	Method and Description
void	closeHash() Closes any open handles to native CAPI objects referenced by this hash object.
void	createCapiHash(CryptProvider provider) Create the internal native CAPI hasher.
protected byte[]	engineDigest() Completes the hash computation by performing final operations such as padding.
protected void	engineReset() Resets the digest for further use.
protected void	engineUpdate(byte input) Updates the digest using the specified byte.
protected void	engineUpdate(byte[] input, int offset, int length) Updates the digest using the specified array of bytes, starting at the specified offset.

Methods inherited from class com.entrust.toolkit.security.crypto.digest.CapiDigest

engineGetDigestLength, getHash

Methods inherited from class java.security.MessageDigest

clone, digest, digest, digest, getAlgorithm, getDigestLength, getInstance, getInstance, getInstance, getProvider, isEqual, reset, toString, update, update, update, update

Methods inherited from class java.security.MessageDigestSpi

engineDigest, engineUpdate

Methods inherited from class java.lang.Object

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

Constructor Detail

Ssl3ShaMd5Capi

public Ssl3ShaMd5Capi()

The constructor; creates a new instance of the SSL3-SHAMD5 message digest algorithm.

Applications should not use this constructor, instead the message digest algorithm should be requested from the appropriate JCA/JCE cryptographic service provider as follows: MessageDigest.getInstance("SSL3-SHAMD5CAPI", "Entrust").

FIPS 140-2:

FIPS Service: Modify Object

This API is part of the logical interface to the Toolkit's FIPS 140-2 cryptographic module; use of this API causes the caller to assume the FIPS 140-2 user role and accesses the following FIPS 140-2 logical interfaces:

• control input interface (API call)
• status output interface (exceptions)

Method Detail

closeHash

public void closeHash()

Description copied from class: CapiDigest

Closes any open handles to native CAPI objects referenced by this hash object.

FIPS 140-2:

FIPS Service: Modify Object

This API is part of the logical interface to the Toolkit's FIPS 140-2 cryptographic module; use of this API causes the caller to assume the FIPS 140-2 user role and accesses the following FIPS 140-2 logical interfaces:

• control input interface (API call)
• status output interface (exceptions)

Overrides:

closeHash in class CapiDigest

createCapiHash

public void createCapiHash(CryptProvider provider)
                    throws CapiException

Description copied from class: CapiDigest

Create the internal native CAPI hasher. This method MUST be called before any of the engine methods, or a NullPointerException will be thrown.

FIPS 140-2:

FIPS Service: Modify Object

This API is part of the logical interface to the Toolkit's FIPS 140-2 cryptographic module; use of this API causes the caller to assume the FIPS 140-2 user role and accesses the following FIPS 140-2 logical interfaces:

• control input interface (API call, parameters)
• status output interface (exceptions)

Overrides:

createCapiHash in class CapiDigest

Parameters:

provider - [FIPS 140-2 control output] the CAPI CSP which will provide the native hashing capability.

Throws:

CapiException - [FIPS 140-2 status output] if the hashing algorithm is not SHA1 or MD5, or if the CSP does not support the hash algorithm.

engineUpdate

protected void engineUpdate(byte input)

Description copied from class: CapiDigest

Updates the digest using the specified byte.

FIPS 140-2:

FIPS Service: Hash Generation

This API is part of the logical interface to the Toolkit's FIPS 140-2 cryptographic module; use of this API causes the caller to assume the FIPS 140-2 user role and accesses the following FIPS 140-2 logical interfaces:

• control input interface (API call)
• data input interface (parameters)
• status output interface (exceptions)

Overrides:

engineUpdate in class CapiDigest

Parameters:

input - [FIPS 140-2 data input] the byte to use for the update.

engineUpdate

protected void engineUpdate(byte[] input,
                            int offset,
                            int length)

Description copied from class: CapiDigest

Updates the digest using the specified array of bytes, starting at the specified offset.

FIPS 140-2:

FIPS Service: Hash Generation

This API is part of the logical interface to the Toolkit's FIPS 140-2 cryptographic module; use of this API causes the caller to assume the FIPS 140-2 user role and accesses the following FIPS 140-2 logical interfaces:

• control input interface (API call)
• data input interface (parameters)
• status output interface (exceptions)

Overrides:

engineUpdate in class CapiDigest

Parameters:

input - [FIPS 140-2 data input] the array of bytes to use for the update.

offset - [FIPS 140-2 data input] the offset to start from in the array of bytes.

length - [FIPS 140-2 data input] the number of bytes to use, starting at offset.

engineDigest

protected final byte[] engineDigest()

Description copied from class: CapiDigest

Completes the hash computation by performing final operations such as padding. Once engineDigest has been called, the engine should be reset (see engineReset). Resetting is the responsibility of the engine implementor.

FIPS 140-2:

FIPS Service: Hash Generation

This API is part of the logical interface to the Toolkit's FIPS 140-2 cryptographic module; use of this API causes the caller to assume the FIPS 140-2 user role and accesses the following FIPS 140-2 logical interfaces:

• control input interface (API call)
• data output interface (return value)
• status output interface (exceptions)

Overrides:

engineDigest in class CapiDigest

Returns:

[FIPS 140-2 data output] the array of bytes for the resulting hash value.

engineReset

protected void engineReset()

Description copied from class: CapiDigest

Resets the digest for further use.

FIPS 140-2:

FIPS Service: Modify Object

This API is part of the logical interface to the Toolkit's FIPS 140-2 cryptographic module; use of this API causes the caller to assume the FIPS 140-2 user role and accesses the following FIPS 140-2 logical interfaces:

• control input interface (API call)
• status output interface (exceptions)

Overrides:

engineReset in class CapiDigest