Module: Devision

Defined in:
lib/devision.rb,
lib/devision/errors.rb,
lib/devision/version.rb,
lib/devision/models/config.rb,
lib/devision/models/lockable.rb,
lib/devision/token_generator.rb,
lib/devision/models/confirmable.rb,
lib/devision/models/recoverable.rb,
lib/devision/models/tokenizable.rb,
lib/devision/models/validatable.rb,
lib/devision/models/rememberable.rb,
lib/devision/configuration_options.rb,
lib/devision/models/authenticatable.rb,
lib/devision/models/database_authenticatable.rb

Defined Under Namespace

Modules: Errors, Lockable, Models, VERSION Classes: CachingKeyGenerator, KeyGenerator, TokenGenerator

Constant Summary collapse

@@authentication_keys = 
[ :email ]
@@reset_password_keys = 
[ :email ]
@@reset_password_within = 
6.hours
@@email_regexp = 
/\A[^@\s]+@([^@\s]+\.)+[^@\s]+\z/
@@password_range = 
6..128
@@remember_for = 
2.weeks
@@extend_remember_period = 
false
@@allow_unconfirmed_access_for = 
0.days
@@confirm_within = 
nil
@@confirmation_keys = 
[ :email ]
@@reconfirmable = 
false
@@lock_strategy = 
:failed_attempts
@@unlock_keys = 
[ :email ]
@@unlock_strategy = 
:both
@@maximum_attempts = 
20
@@unlock_in = 
1.hour
@@token_generator = 
nil
@@secret_key = 
nil
@@stretches = 
10
@@pepper = 
nil

Class Method Summary collapse

Class Method Details

.bcrypt(klass, password) ⇒ Object

Digests a password using bcrypt.



39
40
41
 
# File 'lib/devision.rb', line 39

def self.bcrypt(klass, password)
  ::BCrypt::Password.create("#{password}#{klass.pepper}", cost: klass.stretches).to_s
end

.gem_version ⇒ Object 



16
17
18
 
# File 'lib/devision/version.rb', line 16

def self.gem_version
  VERSION.gem_version
end

.nice_token ⇒ Object

Generate a user friendly ‘nice’ string randomly to be used as token.



24
25
26
 
# File 'lib/devision.rb', line 24

def self.nice_token
  SecureRandom.urlsafe_base64(15).tr('lIO0', 'sxyz')
end

.secure_compare(a, b) ⇒ Object

constant-time comparison algorithm to prevent timing attacks



29
30
31
32
33
34
35
36
 
# File 'lib/devision.rb', line 29

def self.secure_compare(a, b)
  return false if a.blank? || b.blank? || a.bytesize != b.bytesize
  l = a.unpack "C#{a.bytesize}"

  res = 0
  b.each_byte { |byte| res |= byte ^ l.shift }
  res == 0
end

.setup {|_self| ... } ⇒ Object

Default way to setup Devision. Just call this in an initializer

Yields:

  • (_self)

Yield Parameters:

  • _self (Devision) —

    the object that the method was called on



44
45
46
47
 
# File 'lib/devision.rb', line 44

def self.setup
  yield(self)
  self.initialize!
end

.version ⇒ Object 



20
21
22
 
# File 'lib/devision/version.rb', line 20

def self.version
  VERSION::STRING
end