Class WeakMessageDigest

• Object
  • dw.crypto.WeakMessageDigest

This API provides access to Deprecated algorithms.

See MessageDigest for full documentation. WeakMessageDigest is simply a drop-in replacement that only supports deprecated algorithms. This is helpful when you need to deal with weak algorithms for backward compatibility purposes, but MessageDigest should always be used for new development and for anything intended to be secure.

Note: this class handles sensitive security-related data. Pay special attention to PCI DSS v3. requirements 2, 4, and 12.

Constants

DIGEST_MD2 : String = "MD2"

Constant representing the MD2 algorithm.

This algorithm is obsolete. Do not use it for any sensitive data

DIGEST_MD5 : String = "MD5"

Constant representing the MD5 algorithm.

This algorithm is obsolete. Do not use it for any sensitive data

DIGEST_SHA : String = "SHA"

Constant representing the SHA algorithm.

This algorithm is obsolete. Do not use it for any sensitive data

DIGEST_SHA_1 : String = "SHA-1"

Constant representing the SHA 1 algorithm.

This algorithm is obsolete. Do not use it for any sensitive data

Properties

Constructor Summary

WeakMessageDigest(algorithm : String)

Construct a MessageDigest with the specified algorithm name.

Method Summary

digest(input : String) : String

Digests the passed string and returns a computed hash value as a string.

digest(algorithm : String, input : Bytes) : Bytes

Computes the hash value for the passed array of bytes.

digest() : Bytes

Completes the hash computation by performing final operations such as padding.

digestBytes(input : Bytes) : Bytes

Computes the hash value for the passed Bytes.

updateBytes(input : Bytes) : void

Updates the digest using the passed Bytes.

Methods inherited from class Object

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Constructor Detail

WeakMessageDigest

publicWeakMessageDigest(algorithm : String)

Construct a MessageDigest with the specified algorithm name.

Parameters:

algorithm - The standard name of the digest algorithm, must not be null and must be a supported algorithm.

Method Detail

digest

digest(input : String) : String

Digests the passed string and returns a computed hash value as a string. The passed String is first encoded into a sequence of bytes using the platform's default encoding. The digest then performs any prerequisite padding, before computing the hash value. The hash is then converted into a string by converting all digits to hexadecimal.

Deprecated:

Deprecated because the conversion of the input to bytes using the default platform encoding and the hex-encoded return value are not generally appropriate.

Parameters:

input - The value to hash as String, must not be null.

Returns:

The resulting hash value as hex-encoded string.

digest

digest(algorithm : String, input : Bytes) : Bytes

Computes the hash value for the passed array of bytes. The algorithm argument is optional. If null, then the algorithm established at construction time is used. The binary representation of the message is typically derived from a string and the resulting hash is typically converted with base64 back into a string. Example: Encoding.toBase64( digest( "MD5", new Bytes( "my password", "UTF-8" ) ) );

Deprecated:

Deprecated because the digest algorithm should be the one set in the constructor.

Parameters:

algorithm - The standard name of the digest algorithm, or null if the algorithm passed at construction time is to be used. The algorithm must be a supported algorithm.

input - The value to hash, must not be null.

Returns:

The resulting hash value.

digest

digest() : Bytes

Completes the hash computation by performing final operations such as padding. The binary representation of the message is typically derived from a string and the resulting hash is typically converted with base64 back into a string. Example: Encoding.toBase64( digest() );

Returns:

The resulting hash value.

digestBytes

digestBytes(input : Bytes) : Bytes

Computes the hash value for the passed Bytes. The binary representation of the message is typically derived from a string and the resulting hash is typically converted with base64 back into a string. Example: Encoding.toBase64( digest( new Bytes( "my password", "UTF-8" ) ) );

Parameters:

input - The value to hash, must not be null.

Returns:

The resulting hash value.

updateBytes

updateBytes(input : Bytes) : void

Updates the digest using the passed Bytes.

Parameters:

input - The value to hash, must not be null.