module SecureHasher

Constants

VERSION

Public Class Methods

documentation_hard?() click to toggle source

# File lib/secure_hasher.rb, line 6
def self.documentation_hard?
  true
end

secure_hash(password: false, salt: 'xx') click to toggle source

Securely apply a one-way cryptographic hash.

@param password [String] Plaintext password. @param salt [String] Password salt. Default: xx @return [String] @raise [ArgumentError] No password provided.

@example Basic Usage

SecureHasher.secure_hash(password: 'mypassword')
# => "xx.sEzWY1w1qk"

@example Advanced Usage

SecureHasher.secure_hash(password: 'mypassword', salt: 'xy')
# => "xyoxiBrqcbujE"

# File lib/secure_hasher/hasher.rb, line 17
def self.secure_hash(password: false, salt: 'xx')
  # Must provide a password.
  raise Error, 'No password provided.' unless password
  # Hash password.
  password.crypt(salt)
end