W3cubDocs

/Crystal 0.31

class Crypto::Bcrypt::Password

Overview

Generate, read and verify Crypto::Bcrypt hashes.

require "crypto/bcrypt/password"

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

password.verify("wrong secret") # => false
password.verify("super secret") # => true

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

Defined in:

crypto/bcrypt/password.cr

Constructors

Instance Method Summary

Constructor Detail

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

Hashes a password.

require "crypto/bcrypt/password"

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

def self.new(raw_hash : String)Source

Loads a bcrypt hash.

require "crypto/bcrypt/password"

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"

Instance Method Detail

def ==(password : String) : BoolSource

def cost : Int32Source

def digest : StringSource

def inspect(io : IO) : NilSource

Description copied from class Reference

Appends a String representation of this object which includes its class name, its object address and the values of all instance variables.

class Person
  def initialize(@name : String, @age : Int32)
  end
end

Person.new("John", 32).inspect # => #<Person:0x10fd31f20 @name="John", @age=32>

def salt : StringSource

def to_s(io : IO) : NilSource

Description copied from class Reference

Appends a short String representation of this object which includes its class name and its object address.

class Person
  def initialize(@name : String, @age : Int32)
  end
end

Person.new("John", 32).to_s # => #<Person:0x10a199f20>

def verify(password : String) : BoolSource

Verifies a password against the hash.

require "crypto/bcrypt/password"

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

def version : StringSource

© 2012–2019 Manas Technology Solutions.
Licensed under the Apache License, Version 2.0.
https://crystal-lang.org/api/0.31.1/Crypto/Bcrypt/Password.html