module Rodauth

    # File lib/rodauth/features/email_auth.rb
243 def _account_from_email_auth_key(token)
244   account_from_key(token, account_open_status_value){|id| get_email_auth_key(id)}
245 end

    # File lib/rodauth/features/base.rb
697 def _account_from_login(login)
698   ds = account_table_ds.where(login_column=>login)
699   ds = ds.select(*account_select) if account_select
700   ds = ds.where(account_status_column=>[account_unverified_status_value, account_open_status_value]) unless skip_status_checks?
701   ds.first
702 end

    # File lib/rodauth/features/jwt_refresh.rb
111 def _account_from_refresh_token(token)
112   id, token_id, key = _account_refresh_token_split(token)
113 
114   unless key &&
115          (id.to_s == session_value.to_s) &&
116          (actual = get_active_refresh_token(id, token_id)) &&
117          timing_safe_eql?(key, convert_token_key(actual)) &&
118          jwt_refresh_token_match?(key)
119     return
120   end
121 
122   ds = account_ds(id)
123   ds = ds.where(account_session_status_filter) unless skip_status_checks?
124   ds.first
125 end

    # File lib/rodauth/features/reset_password.rb
255 def _account_from_reset_password_key(token)
256   account_from_key(token, account_open_status_value){|id| get_password_reset_key(id)}
257 end

    # File lib/rodauth/features/base.rb
704 def _account_from_session
705   ds = account_ds(session_value)
706   ds = ds.where(account_session_status_filter) unless skip_status_checks?
707   ds.first
708 end

    # File lib/rodauth/features/lockout.rb
299 def _account_from_unlock_key(token)
300   account_from_key(token){|id| account_lockouts_ds(id).get(account_lockouts_key_column)}
301 end

    # File lib/rodauth/features/verify_account.rb
309 def _account_from_verify_account_key(token)
310   account_from_key(token, account_unverified_status_value){|id| get_verify_account_key(id)}
311 end

    # File lib/rodauth/features/verify_login_change.rb
212 def _account_from_verify_login_change_key(token)
213   account_from_key(token) do |id|
214     @verify_login_change_new_login, key = get_verify_login_change_login_and_key(id)
215     key
216   end
217 end

    # File lib/rodauth/features/jwt_refresh.rb
127 def _account_refresh_token_split(token)
128   id, token = split_token(token)
129   id = convert_token_id(id)
130   return unless id && token
131 
132   token_id, key = split_token(token)
133   token_id = convert_token_id(token_id)
134   return unless token_id && key
135 
136   [id, token_id, key]
137 end

    # File lib/rodauth/features/base.rb
510 def _around_rodauth
511   yield
512 end

    # File lib/rodauth/features/email_auth.rb
185 def _email_auth_request
186   if email_auth_email_recently_sent?
187     set_redirect_error_flash email_auth_email_recently_sent_error_flash
188     redirect email_auth_email_recently_sent_redirect
189   end
190 
191   generate_email_auth_key_value
192   transaction do
193     before_email_auth_request
194     create_email_auth_key
195     send_email_auth_email
196     after_email_auth_request
197   end
198 
199   set_notice_flash email_auth_email_sent_notice_flash
200 end

    # File lib/rodauth/features/email_auth.rb
180 def _email_auth_request_and_redirect
181   _email_auth_request
182   redirect email_auth_email_sent_redirect
183 end

    # File lib/rodauth/features/base.rb
716 def _field_attributes(field)
717   nil
718 end

    # File lib/rodauth/features/base.rb
720 def _field_error_attributes(field)
721   " aria-invalid=\"true\" aria-describedby=\"#{field}_error_message\" "
722 end

    # File lib/rodauth/features/base.rb
811 def _filter_links(links)
812   links.select!{|_, link| link}
813   links.sort!
814   links
815 end

    # File lib/rodauth/features/base.rb
724 def _formatted_field_error(field, error)
725   "<span class=\"#{input_field_error_message_class}\" id=\"#{field}_error_message\">#{error}</span>"
726 end

    # File lib/rodauth/features/remember.rb
223 def _get_remember_cookie
224   request.cookies[remember_cookie_key]
225 end

    # File lib/rodauth/features/json.rb
184 def _json_response_body(hash)
185   request.send(:convert_to_json, hash)
186 end

    # File lib/rodauth/features/jwt.rb
110 def _jwt_decode_opts
111   jwt_decode_opts
112 end

    # File lib/rodauth/features/login.rb
154 def _login(auth_type)
155   warn("Deprecated #_login method called, use #login instead.")
156   login(auth_type)
157 end

    # File lib/rodauth/features/login.rb
149 def _login_form_footer
150   return '' if _login_form_footer_links.empty?
151   render('login-form-footer')
152 end

    # File lib/rodauth/features/create_account.rb
117 def _login_form_footer_links
118   super << [10, create_account_path, create_account_link_text]
119 end

    # File lib/rodauth/features/email_auth.rb
170 def _multi_phase_login_forms
171   forms = super
172   forms << [30, email_auth_request_form, :_email_auth_request_and_redirect] if valid_login_entered? && allow_email_auth?
173   forms
174 end

    # File lib/rodauth/features/create_account.rb
121 def _new_account(login)
122   acc = {login_column=>login}
123   unless skip_status_checks?
124     acc[account_status_column] = account_initial_status_value
125   end
126   acc
127 end

    # File lib/rodauth/features/otp.rb
414 def _otp
415   otp_class.new(otp_user_key, :issuer=>otp_issuer, :digits=>otp_digits, :interval=>otp_interval)
416 end

    # File lib/rodauth/features/otp.rb
403 def _otp_add_key(secret)
404   # Uniqueness errors can't be handled here, as we can't be sure the secret provided
405   # is the same as the current secret.
406   otp_key_ds.insert(otp_keys_id_column=>session_value, otp_keys_column=>secret)
407 end

    # File lib/rodauth/features/otp.rb
409 def _otp_key
410   @otp_user_key = nil
411   otp_key_ds.get(otp_keys_column)
412 end

    # File lib/rodauth/features/otp.rb
397 def _otp_tmp_key(secret)
398   @otp_tmp_key = true
399   @otp_user_key = nil
400   @otp_key = secret
401 end

    # File lib/rodauth/features/recovery_codes.rb
260 def _recovery_codes
261   recovery_codes_ds.select_map(recovery_codes_column)
262 end

    # File lib/rodauth/features/json.rb
174 def _return_json_response
175   response.status ||= json_response_error_status if json_response[json_response_error_key]
176   response['Content-Type'] ||= json_response_content_type
177   return_response _json_response_body(json_response)
178 end

    # File lib/rodauth/features/lockout.rb
171 def _setup_account_lockouts_hash(account_id, key)
172   hash = {account_lockouts_id_column=>account_id, account_lockouts_key_column=>key}
173   set_deadline_value(hash, account_lockouts_deadline_column, account_lockouts_deadline_interval)
174   hash
175 end

    # File lib/rodauth/features/sms_codes.rb
499 def _sms
500   sms_ds.first
501 end

    # File lib/rodauth/features/base.rb
854 def _template_opts(opts, page)
855   opts = scope.send(:find_template, scope.send(:parse_template_opts, page, opts))
856   unless File.file?(scope.send(:template_path, opts))
857     opts[:path] = template_path(page)
858   end
859   opts
860 end

   # File lib/rodauth/features/confirm_password.rb
79 def _two_factor_auth_links
80   links = (super if defined?(super)) || []
81   if authenticated_by.length == 1 && !authenticated_by.include?('password') && has_password?
82     links << [5, confirm_password_path, confirm_password_link_text]
83   end
84   links
85 end

    # File lib/rodauth/features/otp.rb
353 def _two_factor_remove_all_from_session
354   two_factor_remove_session('totp')
355   super
356 end

    # File lib/rodauth/features/otp.rb
347 def _two_factor_remove_links
348   links = super
349   links << [20, otp_disable_path, otp_disable_link_text] if otp_exists?
350   links
351 end

    # File lib/rodauth/features/otp.rb
341 def _two_factor_setup_links
342   links = super
343   links << [20, otp_setup_path, otp_setup_link_text] unless otp_exists?
344   links
345 end

   # File lib/rodauth/features/change_login.rb
83 def _update_login(login)
84   updated = nil
85   raised = raises_uniqueness_violation?{updated = update_account({login_column=>login}, account_ds.exclude(login_column=>login)) == 1}
86   if raised
87     set_login_requirement_error_message(:already_an_account_with_this_login, already_an_account_with_this_login_message)
88   end
89   updated && !raised
90 end

    # File lib/rodauth/features/base.rb
862 def _view(meth, page)
863   scope.send(meth, _view_opts(page))
864 end

    # File lib/rodauth/features/base.rb
843 def _view_opts(page)
844   opts = template_opts.dup
845   opts[:locals] = opts[:locals] ? opts[:locals].dup : {}
846   opts[:locals][:rodauth] = self
847   opts[:cache] = cache_templates
848   opts[:cache_key] = :"rodauth_#{page}"
849   _template_opts(opts, page)
850 end

    # File lib/rodauth/features/base.rb
358 def account!
359   account || (session_value && account_from_session)
360 end

    # File lib/rodauth/features/account_expiration.rb
104 def account_activity_ds(account_id)
105   db[account_activity_table].
106     where(account_activity_id_column=>account_id)
107 end

    # File lib/rodauth/features/base.rb
736 def account_ds(id=account_id)
737   raise ArgumentError, "invalid account id passed to account_ds" unless id
738   ds = account_table_ds.where(account_id_column=>id)
739   ds = ds.select(*account_select) if account_select
740   ds
741 end

   # File lib/rodauth/features/account_expiration.rb
54 def account_expired?
55   columns = [account_activity_last_activity_column, account_activity_last_login_column, account_activity_expired_column]
56   last_activity, last_login, expired = account_activity_ds(account_id).get(columns)
57   return true if expired
58   timestamp = convert_timestamp(expire_account_on_last_activity? ? last_activity : last_login)
59   return false unless timestamp
60   timestamp < Time.now - expire_account_after
61 end

   # File lib/rodauth/features/account_expiration.rb
35 def account_expired_at
36   get_activity_timestamp(account_id, account_activity_expired_column)
37 end

    # File lib/rodauth/features/email_auth.rb
133 def account_from_email_auth_key(key)
134   @account = _account_from_email_auth_key(key)
135 end

   # File lib/rodauth/features/email_base.rb
65 def account_from_key(token, status_id=nil)
66   id, key = split_token(token)
67   id = convert_token_id(id)
68   return unless id && key
69 
70   return unless actual = yield(id)
71 
72   unless timing_safe_eql?(key, convert_email_token_key(actual))
73     if hmac_secret && allow_raw_email_token?
74       return unless timing_safe_eql?(key, actual)
75     else
76       return
77     end
78   end
79   ds = account_ds(id)
80   ds = ds.where(account_status_column=>status_id) if status_id && !skip_status_checks?
81   ds.first
82 end

    # File lib/rodauth/features/base.rb
260 def account_from_login(login)
261   @account = _account_from_login(login)
262 end

   # File lib/rodauth/features/jwt_refresh.rb
88 def account_from_refresh_token(token)
89   @account = _account_from_refresh_token(token)
90 end

    # File lib/rodauth/features/remember.rb
203 def account_from_remember_cookie
204   unless id = remembered_session_id
205     # Only set expired cookie if there is already a cookie set.
206     forget_login if _get_remember_cookie
207     return
208   end
209 
210   set_session_value(session_key, id)
211   account_from_session
212   remove_session_value(session_key)
213 
214   unless account
215     remove_remember_key(id)
216     forget_login
217     return
218   end
219 
220   account
221 end

   # File lib/rodauth/features/password_expiration.rb
45 def account_from_reset_password_key(key)
46   if a = super
47     check_password_change_allowed
48   end
49   a
50 end

    # File lib/rodauth/features/base.rb
362 def account_from_session
363   @account = _account_from_session
364 end

    # File lib/rodauth/features/lockout.rb
222 def account_from_unlock_key(key)
223   @account = _account_from_unlock_key(key)
224 end

    # File lib/rodauth/features/verify_account.rb
203 def account_from_verify_account_key(key)
204   @account = _account_from_verify_account_key(key)
205 end

    # File lib/rodauth/features/verify_login_change.rb
122 def account_from_verify_login_change_key(key)
123   @account = _account_from_verify_login_change_key(key)
124 end

    # File lib/rodauth/features/base.rb
250 def account_id
251   account[account_id_column]
252 end

   # File lib/rodauth/features/verify_account_grace_period.rb
85 def account_in_unverified_grace_period?
86   return false unless account!
87   account[account_status_column] == account_unverified_status_value &&
88     verify_account_grace_period &&
89     !verify_account_ds.where(Sequel.date_add(verification_requested_at_column, :seconds=>verify_account_grace_period) > Sequel::CURRENT_TIMESTAMP).empty?
90 end

    # File lib/rodauth/features/base.rb
354 def account_initial_status_value
355   account_open_status_value
356 end

    # File lib/rodauth/features/lockout.rb
295 def account_lockouts_ds(id=account_id)
296   db[account_lockouts_table].where(account_lockouts_id_column=>id)
297 end

    # File lib/rodauth/features/lockout.rb
291 def account_login_failures_ds
292   db[account_login_failures_table].where(account_login_failures_id_column=>account_id)
293 end

    # File lib/rodauth/features/base.rb
280 def account_password_hash_column
281   nil
282 end

    # File lib/rodauth/features/base.rb
728 def account_session_status_filter
729   {account_status_column=>account_open_status_value}
730 end

    # File lib/rodauth/features/base.rb
743 def account_table_ds
744   db[accounts_table]
745 end

    # File lib/rodauth/features/webauthn.rb
265 def account_webauthn_ids
266   webauthn_keys_ds.select_map(webauthn_keys_webauthn_id_column)
267 end

    # File lib/rodauth/features/webauthn.rb
269 def account_webauthn_usage
270   webauthn_keys_ds.select_hash(webauthn_keys_webauthn_id_column, webauthn_keys_last_use_column)
271 end

    # File lib/rodauth/features/webauthn.rb
273 def account_webauthn_user_id
274   unless webauthn_id = webauthn_user_ids_ds.get(webauthn_user_ids_webauthn_id_column)
275     webauthn_id = WebAuthn.generate_user_id
276     if e = raised_uniqueness_violation do
277           webauthn_user_ids_ds.insert(
278             webauthn_user_ids_account_id_column => webauthn_account_id,
279             webauthn_user_ids_webauthn_id_column => webauthn_id
280           )
281         end
282       # If two requests to create a webauthn user id are sent at the same time and an insert
283       # is attempted for both, one will fail with a unique constraint violation.  In that case
284       # it is safe for the second one to use the webauthn user id inserted by the other request.
285       # If there is still no webauthn user id at this point, then we'll just reraise the
286       # exception.
287       # :nocov:
288       raise e unless webauthn_id = webauthn_user_ids_ds.get(webauthn_user_ids_webauthn_id_column)
289       # :nocov:
290     end
291   end
292 
293   webauthn_id
294 end

    # File lib/rodauth/features/remember.rb
251 def active_remember_key_ds(id=account_id)
252   remember_key_ds(id).where(Sequel.expr(remember_deadline_column) > Sequel::CURRENT_TIMESTAMP)
253 end

    # File lib/rodauth/features/active_sessions.rb
179 def active_sessions_ds
180   db[active_sessions_table].
181     where(active_sessions_account_id_column=>session_value)
182 end

    # File lib/rodauth/features/active_sessions.rb
148 def active_sessions_insert_hash
149   {active_sessions_account_id_column => session_value, active_sessions_session_id_column => compute_hmac(active_sessions_key)}
150 end

    # File lib/rodauth/features/active_sessions.rb
152 def active_sessions_update_hash
153   {active_sessions_last_use_column => Sequel::CURRENT_TIMESTAMP}
154 end

   # File lib/rodauth/features/active_sessions.rb
66 def add_active_session
67   key = generate_active_sessions_key
68   set_session_value(session_id_session_key, key)
69   if e = raises_uniqueness_violation?{active_sessions_ds.insert(active_sessions_insert_hash)}
70     handle_duplicate_active_session_id(e)
71   end
72   nil
73 end

   # File lib/rodauth/features/audit_logging.rb
39 def add_audit_log(account_id, action)
40   if hash = audit_log_insert_hash(account_id, action)
41     audit_log_ds.insert(hash)
42   end
43 end

    # File lib/rodauth/features/base.rb
180 def add_field_error_class(field)
181   if field_error(field)
182     " #{input_field_error_class}"
183   end
184 end

   # File lib/rodauth/features/disallow_password_reuse.rb
25 def add_previous_password_hash(hash) 
26   ds = previous_password_ds
27 
28   unless @dont_check_previous_password
29     keep_before = ds.reverse(previous_password_id_column).
30       limit(nil, previous_passwords_to_check).
31       get(previous_password_id_column)
32 
33     if keep_before
34       ds.where(Sequel.expr(previous_password_id_column) <= keep_before).
35         delete
36     end
37   end
38 
39   # This should never raise uniqueness violations, as it uses a serial primary key
40   ds.insert(previous_password_account_id_column=>account_id, previous_password_hash_column=>hash)
41 end

    # File lib/rodauth/features/recovery_codes.rb
187 def add_recovery_code
188   # This should never raise uniqueness violations unless the recovery code is the same, and the odds of that
189   # are 1/256**32 assuming a good random number generator.  Still, attempt to handle that case by retrying
190   # on such a uniqueness violation.
191   retry_on_uniqueness_violation do
192     recovery_codes_ds.insert(recovery_codes_id_column=>session_value, recovery_codes_column=>new_recovery_code)
193   end
194 end

    # File lib/rodauth/features/recovery_codes.rb
177 def add_recovery_codes(number)
178   return if number <= 0
179   transaction do
180     number.times do
181       add_recovery_code
182     end
183   end
184   remove_instance_variable(:@recovery_codes)
185 end

    # File lib/rodauth/features/remember.rb
155 def add_remember_key
156   hash = {remember_id_column=>account_id, remember_key_column=>remember_key_value}
157   set_deadline_value(hash, remember_deadline_column, remember_deadline_interval)
158 
159   if e = raised_uniqueness_violation{remember_key_ds.insert(hash)}
160     # If inserting into the remember key table causes a violation, we can pull the
161     # existing row from the table.  If there is no invalid row, we can then reraise.
162     raise e unless @remember_key_value = active_remember_key_ds.get(remember_key_column)
163   end
164 end

    # File lib/rodauth/features/recovery_codes.rb
151 def add_webauthn_credential(_)
152   super if defined?(super)
153   auto_add_missing_recovery_codes
154 end

   # File lib/rodauth/features/change_password_notify.rb
11 def after_change_password
12   super
13   send_password_changed_email
14 end

    # File lib/rodauth/features/account_expiration.rb
 99 def after_close_account
100   super if defined?(super)
101   account_activity_ds(account_id).delete
102 end

   # File lib/rodauth/features/disallow_password_reuse.rb
87 def after_create_account
88   if account_password_hash_column && !(respond_to?(:verify_account_set_password?) && verify_account_set_password?)
89     add_previous_password_hash(password_hash(param(password_param)))
90   end
91   super if defined?(super)
92 end

    # File lib/rodauth/features/email_auth.rb
208 def after_login
209   # Remove the email auth key after any login, even if
210   # it is a password login.  This is done to invalidate
211   # the email login when a user has a password and requests
212   # email authentication, but then remembers their password
213   # and doesn't need the link.  At that point, the link
214   # that allows login access to the account becomes a
215   # security liability, and it is best to remove it.
216   remove_email_auth_key
217   super
218 end

    # File lib/rodauth/features/email_auth.rb
151 def after_login_entered_during_multi_phase_login
152   # If forcing email auth, just send the email link.
153   _email_auth_request_and_redirect if force_email_auth?
154 
155   super
156 end

    # File lib/rodauth/features/lockout.rb
258 def after_login_failure
259   invalid_login_attempted
260   super
261 end

    # File lib/rodauth/features/remember.rb
227 def after_logout
228   forget_login
229   super if defined?(super)
230 end

    # File lib/rodauth/features/recovery_codes.rb
225 def after_otp_disable
226   super if defined?(super)
227   auto_remove_recovery_codes
228 end

    # File lib/rodauth/features/active_sessions.rb
116 def after_refresh_token
117   super if defined?(super)
118   if prev_key = session[session_id_session_key]
119     key = generate_active_sessions_key
120     set_session_value(session_id_session_key, key)
121     active_sessions_ds.
122       where(active_sessions_session_id_column => compute_hmac(prev_key)).
123       update(active_sessions_session_id_column => compute_hmac(key))
124   end
125 end

   # File lib/rodauth/features/password_grace_period.rb
39 def after_reset_password
40   super if defined?(super)
41   @last_password_entry = Time.now.to_i
42 end

    # File lib/rodauth/features/recovery_codes.rb
230 def after_sms_disable
231   super if defined?(super)
232   auto_remove_recovery_codes
233 end

    # File lib/rodauth/features/recovery_codes.rb
235 def after_webauthn_remove
236   super if defined?(super)
237   auto_remove_recovery_codes
238 end

    # File lib/rodauth/features/email_auth.rb
204 def allow_email_auth?
205   defined?(super) ? super : true
206 end

    # File lib/rodauth/features/verify_account.rb
170 def allow_resending_verify_account_email?
171   account[account_status_column] == account_unverified_status_value
172 end

    # File lib/rodauth/features/base.rb
288 def already_logged_in
289   nil
290 end

   # File lib/rodauth/features/argon2.rb
82 def argon2_hash_algorithm?(hash)
83   hash.start_with?('$argon2id$')
84 end

   # File lib/rodauth/features/argon2.rb
71 def argon2_hash_cost
72   {t_cost: 1, m_cost: 3}
73 end

   # File lib/rodauth/features/argon2.rb
86 def argon2_password_hash_match?(hash, password)
87   ::Argon2::Password.verify_password(password, hash, argon2_secret)
88 end

   # File lib/rodauth/features/argon2.rb
33 def argon2_salt_option
34   :salt_do_not_supply
35 end

   # File lib/rodauth/features/audit_logging.rb
83 def audit_log_ds
84   ds = db[audit_logging_table]
85   # :nocov:
86   if db.database_type == :postgres
87   # :nocov:
88     # For PostgreSQL, use RETURNING NULL. This allows the feature
89     # to be used with INSERT but not SELECT permissions on the
90     # table, useful for audit logging where the database user
91     # the application is running as should not need to read the
92     # logs.
93     ds = ds.returning(nil)
94   end
95   ds
96 end

   # File lib/rodauth/features/audit_logging.rb
45 def audit_log_insert_hash(account_id, action)
46   if message = audit_log_message(action)
47     {
48       audit_logging_account_id_column => account_id,
49       audit_logging_message_column => message,
50       audit_logging_metadata_column => serialize_audit_log_metadata(audit_log_metadata(action))
51     }
52   end
53 end

   # File lib/rodauth/features/audit_logging.rb
63 def audit_log_message(action)
64   meth = :"audit_log_message_for_#{action}"
65   if respond_to?(meth, true)
66     send(meth)
67   else
68     audit_log_message_default(action)
69   end
70 end

   # File lib/rodauth/features/audit_logging.rb
59 def audit_log_message_default(action)
60   action.to_s
61 end

   # File lib/rodauth/features/audit_logging.rb
72 def audit_log_metadata(action)
73   meth = :"audit_log_metadata_for_#{action}"
74   if respond_to?(meth, true)
75     send(meth)
76   else
77     audit_log_metadata_default
78   end
79 end

    # File lib/rodauth/features/base.rb
131 def auth_class_eval(&block)
132   auth.class_eval(&block)
133 end

    # File lib/rodauth/features/base.rb
341 def authenticated?
342   logged_in?
343 end

    # File lib/rodauth/features/base.rb
440 def authenticated_by
441   session[authenticated_by_session_key]
442 end

    # File lib/rodauth/features/webauthn.rb
245 def authenticated_webauthn_id
246   session[authenticated_webauthn_id_session_key]
247 end

    # File lib/rodauth/features/recovery_codes.rb
248 def auto_add_missing_recovery_codes
249   if auto_add_recovery_codes?
250     add_recovery_codes(recovery_codes_limit - recovery_codes.length)
251   end
252 end

    # File lib/rodauth/features/recovery_codes.rb
254 def auto_remove_recovery_codes
255   if auto_remove_recovery_codes? && (%w'totp webauthn sms_code' & possible_authentication_methods).empty?
256     recovery_codes_remove
257   end
258 end

    # File lib/rodauth/features/base.rb
210 def autocomplete_for_field?(_param)
211   mark_input_fields_with_autocomplete?
212 end

    # File lib/rodauth/features/base.rb
453 def autologin_session(autologin_type)
454   login_session('autologin')
455   set_session_value(autologin_type_session_key, autologin_type)
456 end

    # File lib/rodauth/features/base.rb
449 def autologin_type
450   session[autologin_type_session_key]
451 end

    # File lib/rodauth/features/otp.rb
392 def base32_encode(data, length)
393   chars = 'abcdefghijklmnopqrstuvwxyz234567'
394   length.times.map{|i|chars[data[i].ord % 32]}.join
395 end

    # File lib/rodauth/features/base.rb
490 def base_url
491   url = String.new("#{request.scheme}://#{domain}")
492   url << ":#{request.port}" if request.port != Rack::Request::DEFAULT_PORTS[request.scheme]
493   url
494 end

   # File lib/rodauth/features/verify_account_grace_period.rb
58 def before_change_login_route
59   unless verified_account?
60     set_redirect_error_flash unverified_change_login_error_flash
61     redirect unverified_change_login_redirect
62   end
63   super if defined?(super)
64 end

   # File lib/rodauth/features/password_expiration.rb
90 def before_change_password_route
91   check_password_change_allowed
92   super
93 end

   # File lib/rodauth/features/disallow_password_reuse.rb
77 def before_create_account_route
78   super if defined?(super)
79   @dont_check_previous_password = true
80 end

    # File lib/rodauth/features/lockout.rb
246 def before_login_attempt
247   if locked_out?
248     show_lockout_page
249   end
250   super
251 end

    # File lib/rodauth/features/active_sessions.rb
132 def before_logout
133   if param_or_nil(global_logout_param)
134     remove_remember_key(session_value) if respond_to?(:remove_remember_key)
135     remove_all_active_sessions
136   else
137     remove_current_session
138   end
139   super
140 end

    # File lib/rodauth/features/json.rb
134 def before_otp_setup_route
135   super if defined?(super)
136   if use_json? && otp_keys_use_hmac? && !param_or_nil(otp_setup_raw_param)
137     _otp_tmp_key(otp_new_secret)
138     json_response[otp_setup_param] = otp_user_key
139     json_response[otp_setup_raw_param] = otp_key
140   end
141 end

   # File lib/rodauth/features/account_expiration.rb
79 def before_reset_password
80   check_account_expiration
81   super if defined?(super)
82 end

   # File lib/rodauth/features/account_expiration.rb
84 def before_reset_password_request
85   check_account_expiration
86   super if defined?(super)
87 end

    # File lib/rodauth/features/json.rb
143 def before_rodauth
144   if json_request?
145     if json_check_accept? && (accept = request.env['HTTP_ACCEPT']) && accept !~ json_accept_regexp
146       response.status = 406
147       json_response[json_response_error_key] = json_not_accepted_error_message
148       _return_json_response
149     end
150 
151     unless request.post?
152       response.status = 405
153       response.headers['Allow'] = 'POST'
154       json_response[json_response_error_key] = json_non_post_error_message
155       return_json_response
156     end
157   elsif only_json?
158     response.status = json_response_error_status
159     return_response non_json_request_error_message
160   end
161 
162   super
163 end

   # File lib/rodauth/features/json.rb
80 def before_two_factor_auth_route
81   super if defined?(super)
82   if use_json?
83     json_response[:auth_links] = two_factor_auth_links.sort.map{|_,link| link}
84     json_response[json_response_success_key] ||= "" if include_success_messages?
85     return_json_response
86   end
87 end

   # File lib/rodauth/features/json.rb
70 def before_two_factor_manage_route
71   super if defined?(super)
72   if use_json?
73     json_response[:setup_links] = two_factor_setup_links.sort.map{|_,link| link}
74     json_response[:remove_links] = two_factor_remove_links.sort.map{|_,link| link}
75     json_response[json_response_success_key] ||= "" if include_success_messages?
76     return_json_response
77   end
78 end

   # File lib/rodauth/features/account_expiration.rb
89 def before_unlock_account
90   check_account_expiration
91   super if defined?(super)
92 end

   # File lib/rodauth/features/account_expiration.rb
94 def before_unlock_account_request
95   check_account_expiration
96   super if defined?(super)
97 end

   # File lib/rodauth/features/webauthn_verify_account.rb
30 def before_verify_account
31   super
32   if features.include?(:json) && use_json? && !param_or_nil(webauthn_setup_param)
33     cred = new_webauthn_credential
34     json_response[webauthn_setup_param] = cred.as_json
35     json_response[webauthn_setup_challenge_param] = cred.challenge
36     json_response[webauthn_setup_challenge_hmac_param] = compute_hmac(cred.challenge)
37   end
38   @webauthn_credential = webauthn_setup_credential_from_form_submission
39   add_webauthn_credential(@webauthn_credential)
40 end

   # File lib/rodauth/features/disallow_password_reuse.rb
82 def before_verify_account_route
83   super if defined?(super)
84   @dont_check_previous_password = true
85 end

   # File lib/rodauth/features/json.rb
89 def before_view_recovery_codes
90   super if defined?(super)
91   if use_json?
92     json_response[:codes] = recovery_codes
93     json_response[json_response_success_key] ||= "" if include_success_messages?
94   end
95 end

    # File lib/rodauth/features/json.rb
107 def before_webauthn_auth_route
108   super if defined?(super)
109   if use_json? && !param_or_nil(webauthn_auth_param)
110     cred = webauthn_credential_options_for_get
111     json_response[webauthn_auth_param] = cred.as_json
112     json_response[webauthn_auth_challenge_param] = cred.challenge
113     json_response[webauthn_auth_challenge_hmac_param] = compute_hmac(cred.challenge)
114   end
115 end

    # File lib/rodauth/features/json.rb
117 def before_webauthn_login_route
118   super if defined?(super)
119   if use_json? && !param_or_nil(webauthn_auth_param) && account_from_login(param(login_param))
120     cred = webauthn_credential_options_for_get
121     json_response[webauthn_auth_param] = cred.as_json
122     json_response[webauthn_auth_challenge_param] = cred.challenge
123     json_response[webauthn_auth_challenge_hmac_param] = compute_hmac(cred.challenge)
124   end
125 end

    # File lib/rodauth/features/json.rb
127 def before_webauthn_remove_route
128   super if defined?(super)
129   if use_json? && !param_or_nil(webauthn_remove_param)
130     json_response[webauthn_remove_param] = account_webauthn_usage
131   end
132 end

    # File lib/rodauth/features/json.rb
 97 def before_webauthn_setup_route
 98   super if defined?(super)
 99   if use_json? && !param_or_nil(webauthn_setup_param)
100     cred = new_webauthn_credential
101     json_response[webauthn_setup_param] = cred.as_json
102     json_response[webauthn_setup_challenge_param] = cred.challenge
103     json_response[webauthn_setup_challenge_hmac_param] = compute_hmac(cred.challenge)
104   end
105 end

    # File lib/rodauth/features/base.rb
390 def button(value, opts={})
391   scope.render(button_opts(value, opts))
392 end

    # File lib/rodauth/features/base.rb
382 def button_opts(value, opts)
383   opts = Hash[template_opts].merge!(opts)
384   opts[:locals] = {:value=>value, :opts=>opts}
385   opts[:cache] = cache_templates
386   opts[:cache_key] = :rodauth_button
387   _template_opts(opts, 'button')
388 end

    # File lib/rodauth/features/recovery_codes.rb
173 def can_add_recovery_codes?
174   recovery_codes.length < recovery_codes_limit
175 end

    # File lib/rodauth/features/base.rb
601 def catch_error(&block)
602   catch(:rodauth_error, &block)
603 end

   # File lib/rodauth/features/change_login.rb
68 def change_login(login)
69   if account_ds.get(login_column).downcase == login.downcase
70     set_login_requirement_error_message(:same_as_current_login, same_as_current_login_message)
71     return false
72   end
73 
74   update_login(login)
75 end

    # File lib/rodauth/features/verify_login_change.rb
138 def change_login_notice_flash
139   change_login_needs_verification_notice_flash
140 end

   # File lib/rodauth/features/change_login.rb
64 def change_login_requires_password?
65   modifications_require_password?
66 end

   # File lib/rodauth/features/change_password.rb
68 def change_password_requires_password?
69   modifications_require_password?
70 end

   # File lib/rodauth/features/account_expiration.rb
63 def check_account_expiration
64   if account_expired?
65     set_expired unless account_expired_at
66     set_redirect_error_flash account_expiration_error_flash
67     redirect account_expiration_redirect
68   end
69   update_last_login
70 end

   # File lib/rodauth/features/active_sessions.rb
52 def check_active_session
53   if logged_in? && !currently_active_session?
54     no_longer_active_session
55   end
56 end

    # File lib/rodauth/features/base.rb
284 def check_already_logged_in
285   already_logged_in if logged_in?
286 end

    # File lib/rodauth/features/base.rb
366 def check_csrf
367   scope.check_csrf!(check_csrf_opts, &check_csrf_block)
368 end

    # File lib/rodauth/features/base.rb
659 def check_csrf?
660   scope.opts[:rodauth_route_csrf]
661 end

   # File lib/rodauth/features/password_expiration.rb
30 def check_password_change_allowed
31   if password_changed_at = get_password_changed_at
32     if password_changed_at > Time.now - allow_password_change_after
33       set_redirect_error_flash password_not_changeable_yet_error_flash
34       redirect password_not_changeable_yet_redirect
35     end
36   end
37 end

   # File lib/rodauth/features/session_expiration.rb
15 def check_session_expiration
16   return unless logged_in?
17 
18   unless session.has_key?(session_last_activity_session_key) && session.has_key?(session_created_session_key)
19     if session_expiration_default
20       expire_session
21     end
22 
23     return
24   end
25 
26   time = Time.now.to_i
27 
28   if session[session_last_activity_session_key] + session_inactivity_timeout < time
29     expire_session
30   end
31   set_session_value(session_last_activity_session_key, time)
32 
33   if session[session_created_session_key] + max_session_lifetime < time
34     expire_session
35   end
36 end

   # File lib/rodauth/features/single_session.rb
51 def check_single_session
52   if logged_in? && !currently_active_session?
53     no_longer_active_session
54   end
55 end

    # File lib/rodauth/features/otp.rb
358 def clear_cached_otp
359   remove_instance_variable(:@otp) if defined?(@otp)
360 end

    # File lib/rodauth/features/lockout.rb
167 def clear_invalid_login_attempts
168   unlock_account
169 end

    # File lib/rodauth/features/base.rb
300 def clear_session
301   if scope.respond_to?(:clear_session)
302     scope.clear_session
303   else
304     session.clear
305   end
306 end

   # File lib/rodauth/features/close_account.rb
66 def close_account
67   unless skip_status_checks?
68     update_account(account_status_column=>account_closed_status_value)
69   end
70 
71   unless account_password_hash_column
72     password_hash_ds.delete
73   end
74 end

   # File lib/rodauth/features/close_account.rb
62 def close_account_requires_password?
63   modifications_require_password?
64 end

    # File lib/rodauth/features/base.rb
244 def compute_hmac(data)
245   s = [compute_raw_hmac(data)].pack('m').chomp!("=\n")
246   s.tr!('+/', '-_')
247   s
248 end

    # File lib/rodauth/features/base.rb
710 def compute_raw_hmac(data)
711   raise ArgumentError, "hmac_secret not set" unless hmac_secret
712 
713   OpenSSL::HMAC.digest(OpenSSL::Digest::SHA256.new, hmac_secret, data)
714 end

   # File lib/rodauth/features/confirm_password.rb
63 def confirm_password
64   authenticated_by.delete('autologin')
65   authenticated_by.delete('remember')
66   authenticated_by.delete('email_auth')
67   authenticated_by.delete('password')
68   authenticated_by.unshift("password")
69   remove_session_value(autologin_type_session_key)
70   nil
71 end

   # File lib/rodauth/features/confirm_password.rb
73 def confirm_password_redirect
74   remove_session_value(confirm_password_redirect_session_key) || default_redirect
75 end

   # File lib/rodauth/features/email_base.rb
61 def convert_email_token_key(key)
62   convert_token_key(key)
63 end

    # File lib/rodauth/features/base.rb
580 def convert_session_key(key)
581   key = :"#{session_key_prefix}#{key}" if session_key_prefix
582   normalize_session_or_flash_key(key)
583 end

    # File lib/rodauth/features/base.rb
752 def convert_timestamp(timestamp)
753   timestamp = db.to_application_timestamp(timestamp) if timestamp.is_a?(String)
754   timestamp
755 end

    # File lib/rodauth/features/base.rb
534 def convert_token_id(id)
535   if convert_token_id_to_integer?
536     convert_token_id_to_integer(id)
537   else
538     id
539   end
540 end

    # File lib/rodauth/features/base.rb
542 def convert_token_id_to_integer(id)
543   if id = (Integer(id, 10) rescue nil)
544     if id > 9223372036854775807 || id < -9223372036854775808
545       # Only allow 64-bit signed integer range to avoid problems on PostgreSQL
546       id = nil
547     end
548   end
549 
550   id
551 end

    # File lib/rodauth/features/base.rb
522 def convert_token_key(key)
523   if key && hmac_secret
524     compute_hmac(key)
525   else
526     key
527   end
528 end

    # File lib/rodauth/features/verify_account.rb
223 def create_account_autologin?
224   false
225 end

    # File lib/rodauth/features/verify_account.rb
190 def create_account_notice_flash
191   verify_account_email_sent_notice_flash
192 end

    # File lib/rodauth/features/verify_account.rb
227 def create_account_set_password?
228   return false if verify_account_set_password?
229   super
230 end

   # File lib/rodauth/features/email_base.rb
40 def create_email(subject, body)
41   create_email_to(email_to, subject, body)
42 end

    # File lib/rodauth/features/email_auth.rb
104 def create_email_auth_key
105   transaction do
106     if email_auth_key_value = get_email_auth_key(account_id)
107       set_email_auth_email_last_sent
108       @email_auth_key_value = email_auth_key_value
109     elsif e = raised_uniqueness_violation{email_auth_ds.insert(email_auth_key_insert_hash)}
110       # If inserting into the email auth table causes a violation, we can pull the
111       # existing email auth key from the table, or reraise.
112       raise e unless @email_auth_key_value = get_email_auth_key(account_id)
113     end
114   end
115 end

   # File lib/rodauth/features/email_base.rb
44 def create_email_to(to, subject, body)
45   m = Mail.new
46   m.from = email_from
47   m.to = to
48   m.subject = "#{email_subject_prefix}#{subject}"
49   m.body = body
50   m
51 end

    # File lib/rodauth/features/reset_password.rb
166 def create_reset_password_key
167   transaction do
168     if reset_password_key_value = get_password_reset_key(account_id)
169       set_reset_password_email_last_sent
170       @reset_password_key_value = reset_password_key_value
171     elsif e = raised_uniqueness_violation{password_reset_ds.insert(reset_password_key_insert_hash)}
172       # If inserting into the reset password table causes a violation, we can pull the
173       # existing reset password key from the table, or reraise.
174       raise e unless @reset_password_key_value = get_password_reset_key(account_id)
175     end
176   end
177 end

    # File lib/rodauth/features/verify_account.rb
288 def create_verify_account_key
289   ds = verify_account_ds
290   transaction do
291     if ds.empty?
292       if e = raised_uniqueness_violation{ds.insert(verify_account_key_insert_hash)}
293         # If inserting into the verify account table causes a violation, we can pull the
294         # key from the verify account table, or reraise.
295         raise e unless @verify_account_key_value = get_verify_account_key(account_id)
296       end
297     end
298   end
299 end

    # File lib/rodauth/features/verify_login_change.rb
200 def create_verify_login_change_email(login)
201   create_email_to(login, verify_login_change_email_subject, verify_login_change_email_body)
202 end

    # File lib/rodauth/features/verify_login_change.rb
178 def create_verify_login_change_key(login)
179   ds = verify_login_change_ds
180   transaction do
181     ds.where((Sequel::CURRENT_TIMESTAMP > verify_login_change_deadline_column) | ~Sequel.expr(verify_login_change_login_column=>login)).delete
182     if e = raised_uniqueness_violation{ds.insert(verify_login_change_key_insert_hash(login))}
183       old_login, key = get_verify_login_change_login_and_key(account_id)
184       # If inserting into the verify login change table causes a violation, we can pull the
185       # key from the verify login change table if the logins match, or reraise.
186       @verify_login_change_key_value = if old_login.downcase == login.downcase
187         key
188       end
189       raise e unless @verify_login_change_key_value
190     end
191   end
192 end

    # File lib/rodauth/features/base.rb
370 def csrf_tag(path=request.path)
371   return unless scope.respond_to?(:csrf_tag)
372 
373   if use_request_specific_csrf_tokens?
374     scope.csrf_tag(path)
375   else
376     # :nocov:
377     scope.csrf_tag
378     # :nocov:
379   end
380 end

   # File lib/rodauth/features/active_sessions.rb
38 def currently_active_session?
39   return false unless session_id = session[session_id_session_key]
40 
41   remove_inactive_sessions
42   ds = active_sessions_ds.
43     where(active_sessions_session_id_column => compute_hmac(session_id))
44 
45   if update_current_session?
46     ds.update(active_sessions_update_hash) == 1
47   else
48     ds.count == 1
49   end
50 end

    # File lib/rodauth/features/base.rb
514 def database_function_password_match?(name, hash_id, password, salt)
515   db.get(Sequel.function(function_name(name), hash_id, password_hash_using_salt(password, salt)))
516 end

    # File lib/rodauth/features/base.rb
268 def db
269   Sequel::DATABASES.first or raise "Sequel database connection is missing"
270 end

   # File lib/rodauth/features/close_account.rb
76 def delete_account
77   account_ds.delete
78 end

   # File lib/rodauth/features/close_account.rb
80 def delete_account_on_close?
81   skip_status_checks?
82 end

    # File lib/rodauth/features/remember.rb
151 def disable_remember_login
152   remove_remember_key
153 end

    # File lib/rodauth/features/base.rb
496 def domain
497   request.host
498 end

    # File lib/rodauth/features/email_auth.rb
239 def email_auth_ds(id=account_id)
240   db[email_auth_table].where(email_auth_id_column=>id)
241 end

    # File lib/rodauth/features/email_auth.rb
137 def email_auth_email_link
138   token_link(email_auth_route, email_auth_key_param, email_auth_key_value)
139 end

    # File lib/rodauth/features/email_auth.rb
176 def email_auth_email_recently_sent?
177   (email_last_sent = get_email_auth_email_last_sent) && (Time.now - email_last_sent < email_auth_skip_resend_email_within)
178 end

    # File lib/rodauth/features/email_auth.rb
233 def email_auth_key_insert_hash
234   hash = {email_auth_id_column=>account_id, email_auth_key_column=>email_auth_key_value}
235   set_deadline_value(hash, email_auth_deadline_column, email_auth_deadline_interval)
236   hash
237 end

    # File lib/rodauth/features/email_auth.rb
147 def email_auth_request_form
148   render('email-auth-request-form')
149 end

   # File lib/rodauth/features/email_base.rb
26 def email_from
27   "webmaster@#{domain}"
28 end

   # File lib/rodauth/features/email_base.rb
30 def email_to
31   account[login_column]
32 end

   # File lib/rodauth/features/session_expiration.rb
38 def expire_session
39   clear_session
40   set_redirect_error_status session_expiration_error_status
41   set_error_reason :session_expired
42   set_redirect_error_flash session_expiration_error_flash
43   redirect session_expiration_redirect
44 end

    # File lib/rodauth/features/remember.rb
198 def extend_remember_deadline
199   active_remember_key_ds.update(remember_deadline_column=>Sequel.date_add(Sequel::CURRENT_TIMESTAMP, remember_period))
200   remember_login
201 end

    # File lib/rodauth/features/remember.rb
186 def extend_remember_deadline_while_logged_in?
187   return false unless extend_remember_deadline?
188 
189   if extended_at = session[remember_deadline_extended_session_key]
190     extended_at + extend_remember_deadline_period < Time.now.to_i
191   elsif logged_in_via_remember_key?
192     # Handle existing sessions before the change to extend remember deadline
193     # while logged in.
194     true
195   end
196 end

   # File lib/rodauth/features/argon2.rb
63 def extract_password_hash_cost(hash)
64   return super unless argon2_hash_algorithm?(hash )
65 
66   /\A\$argon2id\$v=\d+\$m=(\d+),t=(\d+)/ =~ hash
67   { t_cost: $2.to_i, m_cost: Math.log2($1.to_i).to_i }
68 end

    # File lib/rodauth/features/base.rb
143 def features
144   self.class.features
145 end

    # File lib/rodauth/features/base.rb
218 def field_attributes(field)
219   _field_attributes(field) || default_field_attributes
220 end

    # File lib/rodauth/features/base.rb
175 def field_error(field)
176   return nil unless @field_errors
177   @field_errors[field]
178 end

    # File lib/rodauth/features/base.rb
222 def field_error_attributes(field)
223   if field_error(field)
224     _field_error_attributes(field)
225   end
226 end

    # File lib/rodauth/features/base.rb
159 def flash
160   scope.flash
161 end

    # File lib/rodauth/features/remember.rb
134 def forget_login
135   opts = Hash[remember_cookie_options]
136   opts[:path] = "/" unless opts.key?(:path)
137   ::Rack::Utils.delete_cookie_header!(response.headers, remember_cookie_key, opts)
138 end

    # File lib/rodauth/features/base.rb
228 def formatted_field_error(field)
229   if error = field_error(field)
230     _formatted_field_error(field, error)
231   end
232 end

    # File lib/rodauth/features/base.rb
663 def function_name(name)
664   if db.database_type == :mssql
665     # :nocov:
666     "dbo.#{name}"
667     # :nocov:
668   else
669     name
670   end
671 end