Overview

The Digest object provides cryptographic hash functions for generating message digests. These functions are useful for creating checksums, verifying data integrity, and generating unique identifiers from input data. All digest methods return hexadecimal string representations of the hash values.

md5

Description:

Calculates the MD5 (Message Digest Algorithm 5) digest and returns the value as a 32-character hexadecimal string.

Syntax:

Digest.md5(value)

Parameters:

• value - The input string to hash

Returns: A 32-character hexadecimal string representing the MD5 hash

Example:

Digest.md5("alpha")

Result:

2c1743a391305fbf367df8e4f069f9f9

sha1

Description:

Calculates the SHA-1 (Secure Hash Algorithm 1) digest and returns the value as a hexadecimal string.

Syntax:

Digest.sha1(value)

Parameters:

• value - The input string to hash

Returns: A 40-character hexadecimal string representing the SHA-1 hash

Example:

Digest.sha1("alpha")

Result:

be76331b95dfc399cd776d2fc68021e0db03cc4f

sha256

Description:

Calculates the SHA-256 (Secure Hash Algorithm 256-bit) digest and returns the value as a hexadecimal string. SHA-256 is part of the SHA-2 family and is currently considered secure for most applications.

Syntax:

Digest.sha256(value)

Parameters:

• value - The input string to hash

Returns: A 64-character hexadecimal string representing the SHA-256 hash

Example:

Digest.sha256("alpha")

Result:

8ed3f6ad685b959ead7022518e1af76cd816f8e8ec7ccdda1ed4018e8f2223f8

Common Use Cases

Data Integrity Verification:

// Generate checksum for data validation
Digest.sha256($documentContent)

Creating Unique Identifiers:

// Generate unique ID from multiple fields
Digest.md5($firstName + $lastName + $email)

Cache Keys:

// Create cache key from request parameters
"cache_" + Digest.sha256($endpoint + $queryParams)

Deduplication:

// Identify duplicate records
Digest.sha256($record.toString())

Best Practices

• Choose the Right Algorithm: Use SHA-256 for security-critical applications. MD5 and SHA-1 are acceptable for non-security use cases like generating cache keys or checksums where collision resistance is less critical.
• Consistent Input: Ensure consistent input formatting when generating digests for comparison, as even minor differences (whitespace, case) will produce completely different hashes.
• Performance: Digest operations are computationally intensive. For large datasets, consider whether hashing is necessary or if it can be done once and cached.
• Deterministic Output: The same input will always produce the same digest, making these functions ideal for creating unique identifiers.
• Non-Reversible: Remember that digest functions are one-way. You cannot retrieve the original value from the hash.

Security Considerations

• Password Hashing: Do not use these digest functions for password hashing. Use dedicated password hashing algorithms with salt.
• Collision Attacks: MD5 and SHA-1 are vulnerable to collision attacks where two different inputs can produce the same hash. Use SHA-256 for security-sensitive applications.
• Rainbow Tables: Simple hashes without salt are vulnerable to rainbow table attacks. Add unique salt values when hashing sensitive data.
• Timing Attacks: When comparing digest values for security purposes, use constant-time comparison to prevent timing attacks.

Algorithm Comparison