Module: Devise::Models::OtpAuthenticatable
- Extended by:
- ActiveSupport::Concern
- Defined in:
- lib/devise_otp_authenticatable/models/otp_authenticatable.rb
Defined Under Namespace
Modules: ClassMethods
Instance Method Summary collapse
- #disable_otp! ⇒ Object
- #enable_otp! ⇒ Object
- #generate_otp_challenge!(expires = nil) ⇒ Object
- #next_otp_recovery_tokens(number = self.class.otp_recovery_tokens) ⇒ Object
- #otp_challenge_valid? ⇒ Boolean
- #otp_provisioning_identifier ⇒ Object
- #otp_provisioning_uri ⇒ Object
- #recovery_otp ⇒ Object
- #reset_otp_credentials ⇒ Object
- #reset_otp_credentials! ⇒ Object
- #reset_otp_persistence ⇒ Object
- #reset_otp_persistence! ⇒ Object
- #time_based_otp ⇒ Object
- #validate_otp_recovery_token(token) ⇒ Object (also: #valid_otp_recovery_token?)
- #validate_otp_time_token(token) ⇒ Object (also: #valid_otp_time_token?)
- #validate_otp_token(token, recovery = false) ⇒ Object (also: #valid_otp_token?)
Instance Method Details
#disable_otp! ⇒ Object
71 72 73 |
# File 'lib/devise_otp_authenticatable/models/otp_authenticatable.rb', line 71 def disable_otp! update!(otp_enabled: false, otp_enabled_on: nil) end |
#enable_otp! ⇒ Object
63 64 65 66 67 68 69 |
# File 'lib/devise_otp_authenticatable/models/otp_authenticatable.rb', line 63 def enable_otp! if otp_persistence_seed.nil? reset_otp_credentials! end update!(otp_enabled: true, otp_enabled_on: Time.now) end |
#generate_otp_challenge!(expires = nil) ⇒ Object
75 76 77 78 79 |
# File 'lib/devise_otp_authenticatable/models/otp_authenticatable.rb', line 75 def generate_otp_challenge!(expires = nil) update!(otp_session_challenge: SecureRandom.hex, otp_challenge_expires: DateTime.now + (expires || self.class.otp_authentication_timeout)) otp_session_challenge end |
#next_otp_recovery_tokens(number = self.class.otp_recovery_tokens) ⇒ Object
100 101 102 103 104 |
# File 'lib/devise_otp_authenticatable/models/otp_authenticatable.rb', line 100 def next_otp_recovery_tokens(number = self.class.otp_recovery_tokens) (otp_recovery_counter..otp_recovery_counter + number).each_with_object({}) do |index, h| h[index] = recovery_otp.at(index) end end |
#otp_challenge_valid? ⇒ Boolean
81 82 83 |
# File 'lib/devise_otp_authenticatable/models/otp_authenticatable.rb', line 81 def otp_challenge_valid? (otp_challenge_expires.nil? || otp_challenge_expires > Time.now) end |
#otp_provisioning_identifier ⇒ Object
35 36 37 |
# File 'lib/devise_otp_authenticatable/models/otp_authenticatable.rb', line 35 def otp_provisioning_identifier email end |
#otp_provisioning_uri ⇒ Object
31 32 33 |
# File 'lib/devise_otp_authenticatable/models/otp_authenticatable.rb', line 31 def otp_provisioning_uri time_based_otp.provisioning_uri(otp_provisioning_identifier) end |
#recovery_otp ⇒ Object
27 28 29 |
# File 'lib/devise_otp_authenticatable/models/otp_authenticatable.rb', line 27 def recovery_otp @recovery_otp ||= ROTP::HOTP.new(otp_recovery_secret) end |
#reset_otp_credentials ⇒ Object
39 40 41 42 43 44 45 46 47 |
# File 'lib/devise_otp_authenticatable/models/otp_authenticatable.rb', line 39 def reset_otp_credentials @time_based_otp = nil @recovery_otp = nil generate_otp_auth_secret reset_otp_persistence update!(otp_enabled: false, otp_session_challenge: nil, otp_challenge_expires: nil, otp_recovery_counter: 0) end |
#reset_otp_credentials! ⇒ Object
49 50 51 52 |
# File 'lib/devise_otp_authenticatable/models/otp_authenticatable.rb', line 49 def reset_otp_credentials! reset_otp_credentials save! end |
#reset_otp_persistence ⇒ Object
54 55 56 |
# File 'lib/devise_otp_authenticatable/models/otp_authenticatable.rb', line 54 def reset_otp_persistence generate_otp_persistence_seed end |
#reset_otp_persistence! ⇒ Object
58 59 60 61 |
# File 'lib/devise_otp_authenticatable/models/otp_authenticatable.rb', line 58 def reset_otp_persistence! reset_otp_persistence save! end |
#time_based_otp ⇒ Object
23 24 25 |
# File 'lib/devise_otp_authenticatable/models/otp_authenticatable.rb', line 23 def time_based_otp @time_based_otp ||= ROTP::TOTP.new(otp_auth_secret, issuer: (self.class.otp_issuer || Rails.application.class.module_parent_name).to_s) end |
#validate_otp_recovery_token(token) ⇒ Object Also known as: valid_otp_recovery_token?
106 107 108 109 110 111 |
# File 'lib/devise_otp_authenticatable/models/otp_authenticatable.rb', line 106 def validate_otp_recovery_token(token) recovery_otp.verify(token, otp_recovery_counter).tap do self.otp_recovery_counter += 1 save! end end |
#validate_otp_time_token(token) ⇒ Object Also known as: valid_otp_time_token?
94 95 96 97 |
# File 'lib/devise_otp_authenticatable/models/otp_authenticatable.rb', line 94 def validate_otp_time_token(token) return false if token.blank? validate_otp_token_with_drift(token) end |
#validate_otp_token(token, recovery = false) ⇒ Object Also known as: valid_otp_token?
85 86 87 88 89 90 91 |
# File 'lib/devise_otp_authenticatable/models/otp_authenticatable.rb', line 85 def validate_otp_token(token, recovery = false) if recovery validate_otp_recovery_token token else validate_otp_time_token token end end |