class Crypto::Bcrypt::Password

Overview

Generate, read and verify Crypto::Bcrypt hashes.

password = Crypto::Bcrypt::Password.create("super secret", cost: 10)
# => $2a$10$rI4xRiuAN2fyiKwynO6PPuorfuoM4L2PVv6hlnVJEmNLjqcibAfHq

password == "wrong secret" # => false
password == "super secret" # => true

See Crypto::Bcrypt for hints to select the cost when generating hashes.

Defined in:

crypto/bcrypt/password.cr

Class Method Summary

Instance Method Summary

Instance methods inherited from class Reference

==(other)
==(other : self) ==, hash hash, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, same?(other : Reference)
same?(other : Nil) same?, to_s(io : IO) : Nil to_s

Instance methods inherited from class Object

!=(other) !=, !~(other) !~, ==(other) ==, ===(other)
===(other : YAML::Any)
===(other : JSON::Any) ===, =~(other) =~, class class, clone clone, crystal_type_id crystal_type_id, dup dup, hash hash, inspect
inspect(io : IO) inspect, itself itself, not_nil! not_nil!, tap(&block) tap, to_json to_json, to_pretty_json(io : IO)
to_pretty_json to_pretty_json, to_s
to_s(io : IO) to_s, to_yaml(io : IO)
to_yaml to_yaml, try(&block) try

Class methods inherited from class Object

==(other : Class) ==, ===(other) ===, cast(other) : self cast, from_json(string_or_io) : self from_json, from_yaml(string : String) : self from_yaml, hash hash, inspect(io) inspect, name : String name, to_s(io) to_s, |(other : U.class) |

Class Method Detail

def self.create(password, cost = DEFAULT_COST) : self #

Hashes a password.

password = Crypto::Bcrypt::Password.create("super secret", cost: 10)
# => $2a$10$rI4xRiuAN2fyiKwynO6PPuorfuoM4L2PVv6hlnVJEmNLjqcibAfHq

[View source]
def self.new(raw_hash : String) #

Loads a bcrypt hash.

password = Crypto::Bcrypt::Password.new("$2a$10$X6rw/jDiLBuzHV./JjBNXe8/Po4wTL0fhdDNdAdjcKN/Fup8tGCya")
password.version # => "2a"
password.salt    # => X6rw/jDiLBuzHV./JjBNXe
password.digest  # => 8/Po4wTL0fhdDNdAdjcKN/Fup8tGCya

[View source]

Instance Method Detail

def ==(password) #

Verifies a password against the hash.

password = Crypto::Bcrypt::Password.create("super secret")
password == "wrong secret" # => false
password == "super secret" # => true

[View source]
def cost : Int32 #

[View source]
def digest : String #

[View source]
def inspect(io) #

[View source]
def salt : String #

[View source]
def to_s(io) #

[View source]
def version : String #

[View source]