docs » hs.hash

Calculates a binary MD5 hash

• this function is provided for backwards compatibility with a previous version of this module and is functionally equivalent to: hs.hash.new("MD5"):append(data):finish():value(true)

Calculates a binary SHA1 hash

• this function is provided for backwards compatibility with a previous version of this module and is functionally equivalent to: hs.hash.new("SHA1"):append(data):finish():value(true)

Calculates a binary SHA256 hash

• this function is provided for backwards compatibility with a previous version of this module and is functionally equivalent to: hs.hash.new("SHA256"):append(data):finish():value(true)

Calculates a binary SHA512 hash

• this function is provided for backwards compatibility with a previous version of this module and is functionally equivalent to: hs.hash.new("SHA512"):append(data):finish():value(true)

Calculates an HMAC using a key and an MD5 hash

• this function is provided for backwards compatibility with a previous version of this module and is functionally equivalent to: hs.hash.new("hmacMD5", key):append(data):finish():value()

Calculates an HMAC using a key and a SHA1 hash

• this function is provided for backwards compatibility with a previous version of this module and is functionally equivalent to: hs.hash.new("hmacSHA1", key):append(data):finish():value()

Calculates an HMAC using a key and a SHA256 hash

• this function is provided for backwards compatibility with a previous version of this module and is functionally equivalent to: hs.hash.new("hmacSHA256", key):append(data):finish():value()

Calculates an HMAC using a key and a SHA512 hash

• this function is provided for backwards compatibility with a previous version of this module and is functionally equivalent to: hs.hash.new("hmacSHA512", key):append(data):finish():value()

Calculates an MD5 hash

• this function is provided for backwards compatibility with a previous version of this module and is functionally equivalent to: hs.hash.new("MD5"):append(data):finish():value()

Calculates an SHA1 hash

• this function is provided for backwards compatibility with a previous version of this module and is functionally equivalent to: hs.hash.new("SHA1"):append(data):finish():value()

Calculates an SHA256 hash

• this function is provided for backwards compatibility with a previous version of this module and is functionally equivalent to: hs.hash.new("SHA256"):append(data):finish():value()

Calculates an SHA512 hash

• this function is provided for backwards compatibility with a previous version of this module and is functionally equivalent to: hs.hash.new("SHA512"):append(data):finish():value()

A tale containing the names of the hashing algorithms supported by this module.

At present, this module supports the following hash functions:

• CRC32 - Technically a checksum, not a hash, but often used for similar purposes, like verifying file integrity. Produces a 32bit value.
• MD5 - A message digest algorithm producing a 128bit hash value. MD5 is no longer consider secure for cryptographic purposes, but is still widely used to verify file integrity and other non cryptographic uses.
• SHA1 - A message digest algorithm producing a 160bit hash value. SHA-1 is no longer consider secure for cryptographic purposes, but is still widely used to verify file integrity and other non cryptographic uses.
• SHA256 - A cryptographic hash function that produces a 256bit hash value. While there has been some research into attack vectors on the SHA-2 family of algorithms, this is still considered sufficiently secure for many cryptographic purposes and for data validation and verification.
• SHA512 - A cryptographic hash function that produces a 512bit hash value. While there has been some research into attack vectors on the SHA-2 family of algorithms, this is still considered sufficiently secure for many cryptographic purposes and for data validation and verification.
• hmacMD5 - Combines the MD5 hash algorithm with a hash-based message authentication code, or pre-shared secret.
• hmacSHA1 - Combines the SHA1 hash algorithm with a hash-based message authentication code, or pre-shared secret.
• hmacSHA256 - Combines the SHA-2 256bit hash algorithm with a hash-based message authentication code, or pre-shared secret.
• hmacSHA512 - Combines the SHA-2 512bit hash algorithm with a hash-based message authentication code, or pre-shared secret.
• SHA3_224 - A SHA3 based cryptographic hash function that produces a 224bit hash value. The SHA3 family of algorithms use a different process than that which is used in the MD5, SHA1 and SHA2 families of algorithms and is considered the most cryptographically secure at present, though at the cost of additional computational complexity.
• SHA3_256 - A SHA3 based cryptographic hash function that produces a 256bit hash value. The SHA3 family of algorithms use a different process than that which is used in the MD5, SHA1 and SHA2 families of algorithms and is considered the most cryptographically secure at present, though at the cost of additional computational complexity.
• SHA3_384 - A SHA3 based cryptographic hash function that produces a 384bit hash value. The SHA3 family of algorithms use a different process than that which is used in the MD5, SHA1 and SHA2 families of algorithms and is considered the most cryptographically secure at present, though at the cost of additional computational complexity.
• SHA3_512 - A SHA3 based cryptographic hash function that produces a 512bit hash value. The SHA3 family of algorithms use a different process than that which is used in the MD5, SHA1 and SHA2 families of algorithms and is considered the most cryptographically secure at present, though at the cost of additional computational complexity.

Converts a string containing a binary hash value to its equivalent hexadecimal digits.

• input - a string containing the binary hash value you wish to convert into its equivalent hexadecimal digits.

• a string containing the equivalent hash as a string of hexadecimal digits

• this is a convenience function for use when you already have a binary hash value that you wish to convert to its hexadecimal equivalent -- the value is not actually validated as the actual hash value for anything specific.

Converts a string containing a hash value as a string of hexadecimal digits into its binary equivalent.

• input - a string containing the hash value you wish to convert into its binary equivalent. The string must be a sequence of hexadecimal digits with an even number of characters.

• a string containing the equivalent binary hash

• this is a convenience function for use when you already have a hash value that you wish to convert to its binary equivalent. Beyond checking that the input string contains only hexadecimal digits and is an even length, the value is not actually validated as the actual hash value for anything specific.

Calculates the specified hash value for the file at the given path.

• hash - the name of the type of hash to calculate. This must be one of the string values found in the hs.hash.types constant.
• secret - an optional string specifying the shared secret to prepare the hmac hash function with. For all other hash types this field is ignored. Leaving this parameter off when specifying an hmac hash function is equivalent to specifying an empty secret or a secret composed solely of null values.
• path - the path to the file to calculate the hash value for.

• a string containing the hexadecimal version of the calculated hash for the specified file.

• this is a convenience function that performs the equivalent of hs.new.hash(hash, [secret]):appendFile(path):finish():value().

Creates a new context for the specified hash function.

• hash - a string specifying the name of the hash function to use. This must be one of the string values found in the hs.hash.types constant.
• secret - an optional string specifying the shared secret to prepare the hmac hash function with. For all other hash types this field is ignored. Leaving this parameter off when specifying an hmac hash function is equivalent to specifying an empty secret or a secret composed solely of null values.

• the new hash object

Adds the provided data to the input of the hash function currently in progress for the hashObject.

• data - a string containing the data to add to the hash functions input.

• the hash object, or if the hash has already been calculated (finished), nil and an error string

Adds the contents of the file at the specified path to the input of the hash function currently in progress for the hashObject.

• path - a string containing the path of the file to add to the hash functions input.

• the hash object

Finalizes the hash and computes the resulting value.

• None

• the hash object

• a hash that has been finished can no longer have data appended to it.

Returns the name of the hash type the object refers to

• None

• a string containing the hash type name.

Returns the value of a completed hash, or nil if it is still in progress.

• binary - an optional boolean, default false, specifying whether or not the value should be provided as raw binary bytes (true) or as a string of hexadecimal numbers (false).

• a string containing the hash value or nil if the hash has not been finished.