Module: CryptoHash

Defined in:
lib/object_hash_rb/cryptohash.rb

Overview

@INTERNAL: Please use ObjectHash.hash() instead. Contains functions which cryptographically hash an input string, using a given algorithm. Several common algorithms are implemented, or you can provide your own Digest object.

Constant Summary collapse

ALGORITHMS =

Algorithms which can cryptographically hash an input.

{
  passthrough: lambda do |input|
    # Return the original input with no modification.
    # Useful for debugging and testing.
    input
  end,
  md5: lambda do |input|
    # Return the MD5 hash.
    Digest::MD5.hexdigest(input).upcase
  end,
  sha1: lambda do |input|
    # Return the SHA1 hash.
    Digest::SHA1.hexdigest(input).upcase
  end,
  sha2: lambda do |input|
    # Return the SHA2 hash (256 bit digest).
    Digest::SHA2.new(256).hexdigest(input).upcase
  end,
  sha256: lambda do |input|
    # Return the SHA2 hash (256-bit digest).
    Digest::SHA2.new(256).hexdigest(input).upcase
  end,
  sha384: lambda do |input|
    # Return the SHA2 hash (384-bit digest).
    Digest::SHA2.new(384).hexdigest(input).upcase
  end,
  sha512: lambda do |input|
    # Return the SHA2 hash (512-bit digest).
    Digest::SHA2.new(512).hexdigest(input).upcase
  end,
  rmd160: lambda do |input|
    # Return the RMD160 hash.
    Digest::RMD160.hexdigest(input).upcase
  end
}.freeze

Class Method Summary collapse

Class Method Details

.perform_cryptohash(input, algorithm) ⇒ Object

@INTERNAL: Please use ObjectHash.hash() instead. Call the appropriate algorithm on the input.

Parameters:

  • input —

    A string to hash.

  • algorithm —

    Either a string for an algorithm to use, or a Digest to perform the hash.

Raises:



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/object_hash_rb/cryptohash.rb', line 57

def perform_cryptohash(input, algorithm)
  # Allow users to specify their own Digest object.
  return algorithm.hexdigest(input) if algorithm.respond_to?(:hexdigest)

  alg = algorithm.strip.downcase.to_sym

  # Throw an error if the algorithm is unknown.
  raise UnknownAlgorithmError, algorithm unless ALGORITHMS.key?(alg)

  # Return the result of the algorithm.
  ALGORITHMS[alg].call(input)
end