Class: BCrypt::Password

Inherits:
String
  • Object
show all
Defined in:
lib/bcrypt.rb

Overview

A password management class which allows you to safely store users’ passwords and compare them.

Example usage:

include BCrypt

# hash a user's password  
@password = Password.create("my grand secret")
@password #=> "$2a$10$GtKs1Kbsig8ULHZzO1h2TetZfhO4Fmlxphp8bVKnUlZCBYYClPohG"

# store it safely
@user.update_attribute(:password, @password)

# read it back
@user.reload!
@db_password = Password.new(@user.password)

# compare it after retrieval
@db_password == "my grand secret" #=> true
@db_password == "a paltry guess"  #=> false

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(raw_hash) ⇒ Password

Initializes a BCrypt::Password instance with the data from a stored hash.



162
163
164
165
166
167
168
169
 
# File 'lib/bcrypt.rb', line 162

def initialize(raw_hash)
  if valid_hash?(raw_hash)
    self.replace(raw_hash)
    @version, @cost, @salt, @checksum = split_hash(self)
  else
    raise Errors::InvalidHash.new("invalid hash")
  end
end

Instance Attribute Details

#checksum ⇒ Object (readonly)

The hash portion of the stored password hash.



137
138
139
 
# File 'lib/bcrypt.rb', line 137

def checksum
  @checksum
end

#cost ⇒ Object (readonly)

The cost factor used to create the hash.



143
144
145
 
# File 'lib/bcrypt.rb', line 143

def cost
  @cost
end

#salt ⇒ Object (readonly)

The salt of the store password hash (including version and cost).



139
140
141
 
# File 'lib/bcrypt.rb', line 139

def salt
  @salt
end

#version ⇒ Object (readonly)

The version of the bcrypt() algorithm used to create the hash.



141
142
143
 
# File 'lib/bcrypt.rb', line 141

def version
  @version
end

Class Method Details

.create(secret, options = { :cost => BCrypt::Engine::DEFAULT_COST }) ⇒ Object

Hashes a secret, returning a BCrypt::Password instance. Takes an optional :cost option, which is a logarithmic variable which determines how computational expensive the hash is to calculate (a :cost of 4 is twice as much work as a :cost of 3). The higher the :cost the harder it becomes for attackers to try to guess passwords (even if a copy of your database is stolen), but the slower it is to check users’ passwords.

Example:

@password = BCrypt::Password.create("my secret", :cost => 13)

Raises:

  • (ArgumentError) 


155
156
157
158
 
# File 'lib/bcrypt.rb', line 155

def create(secret, options = { :cost => BCrypt::Engine::DEFAULT_COST })
  raise ArgumentError if options[:cost] > 31
  Password.new(BCrypt::Engine.hash_secret(secret, BCrypt::Engine.generate_salt(options[:cost]), options[:cost]))
end

Instance Method Details

#==(secret) ⇒ Object Also known as: is_password?

Compares a potential secret against the hash. Returns true if the secret is the original secret, false otherwise.



172
173
174
 
# File 'lib/bcrypt.rb', line 172

def ==(secret)
  super(BCrypt::Engine.hash_secret(secret, @salt))
end