module Rodauth

    # File lib/rodauth/features/email_auth.rb
238 def _account_from_email_auth_key(token)
239   account_from_key(token, account_open_status_value){|id| get_email_auth_key(id)}
240 end

    # File lib/rodauth/features/base.rb
845 def _account_from_id(id, status_id=nil)
846   ds = account_ds(id)
847   ds = ds.where(account_status_column=>status_id) if status_id && !skip_status_checks?
848   ds.first
849 end

    # File lib/rodauth/features/base.rb
832 def _account_from_login(login)
833   ds = account_table_ds.where(login_column=>login)
834   ds = ds.select(*account_select) if account_select
835   ds = ds.where(account_status_column=>[account_unverified_status_value, account_open_status_value]) unless skip_status_checks?
836   ds.first
837 end

    # File lib/rodauth/features/jwt_refresh.rb
118 def _account_from_refresh_token(token)
119   id, token_id, key = _account_refresh_token_split(token)
120 
121   unless key &&
122          (id.to_s == session_value.to_s) &&
123          (actual = get_active_refresh_token(id, token_id)) &&
124          (timing_safe_eql?(key, convert_token_key(actual)) || (hmac_secret_rotation? && timing_safe_eql?(key, compute_old_hmac(actual)))) &&
125          jwt_refresh_token_match?(key)
126     return
127   end
128 
129   ds = account_ds(id)
130   ds = ds.where(account_session_status_filter) unless skip_status_checks?
131   ds.first
132 end

    # File lib/rodauth/features/reset_password.rb
258 def _account_from_reset_password_key(token)
259   account_from_key(token, reset_password_account_status_value){|id| get_password_reset_key(id)}
260 end

    # File lib/rodauth/features/base.rb
839 def _account_from_session
840   ds = account_ds(session_value)
841   ds = ds.where(account_session_status_filter) unless skip_status_checks?
842   ds.first
843 end

    # File lib/rodauth/features/lockout.rb
305 def _account_from_unlock_key(token)
306   account_from_key(token){|id| account_lockouts_ds(id).get(account_lockouts_key_column)}
307 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
134 def _account_refresh_token_split(token)
135   id, token = split_token(token)
136   id = convert_token_id(id)
137   return unless id && token
138 
139   token_id, key = split_token(token)
140   token_id = convert_token_id(token_id)
141   return unless token_id && key
142 
143   [id, token_id, key]
144 end

    # File lib/rodauth/features/base.rb
590 def _around_rodauth
591   yield
592 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   email_auth_email_sent_response
200 end

    # File lib/rodauth/features/base.rb
864 def _field_attributes(field)
865   nil
866 end

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

    # File lib/rodauth/features/base.rb
959 def _filter_links(links)
960   links.select!{|_, link| link}
961   links.sort!
962   links
963 end

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

    # File lib/rodauth/features/remember.rb
239 def _get_remember_cookie
240   request.cookies[remember_cookie_key]
241 end

    # File lib/rodauth/features/base.rb
587 def _initialize_instance_variables
588 end

    # File lib/rodauth/features/json.rb
222 def _json_response_body(hash)
223   request.send(:convert_to_json, hash)
224 end

    # File lib/rodauth/features/jwt.rb
106 def _jwt_decode_opts
107   jwt_decode_opts
108 end

    # File lib/rodauth/features/jwt.rb
111 def _jwt_decode_secrets
112   secrets = [jwt_secret, jwt_old_secret]
113   secrets.compact!
114   secrets
115 end

    # File lib/rodauth/features/login.rb
178 def _login(auth_type)
179   warn("Deprecated #_login method called, use #login instead.")
180   login(auth_type)
181 end

    # File lib/rodauth/features/login.rb
173 def _login_form_footer
174   return '' if _login_form_footer_links.empty?
175   render('login-form-footer')
176 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/login.rb
158 def _login_response
159   set_notice_flash login_notice_flash
160   redirect(saved_login_redirect || login_redirect)
161 end

     # File lib/rodauth/features/base.rb
1010 def _merge_fixed_locals_opts(opts, fixed_locals)
1011   if use_template_fixed_locals? && !opts[:locals]
1012     fixed_locals_opts = {default_fixed_locals: fixed_locals}
1013     fixed_locals_opts.merge!(opts[:template_opts]) if opts[:template_opts]
1014     opts[:template_opts] = fixed_locals_opts
1015   end
1016 end

    # File lib/rodauth/features/email_auth.rb
179 def _multi_phase_login_forms
180   forms = super
181   forms << [30, email_auth_request_form, :_email_auth_request] if valid_login_entered? && allow_email_auth?
182   forms
183 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
448 def _otp
449   _otp_for_key(otp_user_key)
450 end

    # File lib/rodauth/features/otp.rb
433 def _otp_add_key(secret)
434   # Uniqueness errors can't be handled here, as we can't be sure the secret provided
435   # is the same as the current secret.
436   otp_key_ds.insert(otp_keys_id_column=>session_value, otp_keys_column=>secret)
437 end

    # File lib/rodauth/features/otp.rb
444 def _otp_for_key(key)
445   otp_class.new(key, :issuer=>otp_issuer, :digits=>otp_digits, :interval=>otp_interval)
446 end

    # File lib/rodauth/features/otp.rb
425 def _otp_interval
426   otp_interval || 30
427 end

    # File lib/rodauth/features/otp.rb
439 def _otp_key
440   @otp_user_key = nil
441   otp_key_ds.get(otp_keys_column) || false
442 end

    # File lib/rodauth/features/otp.rb
419 def _otp_tmp_key(secret)
420   @otp_tmp_key = true
421   @otp_user_key = nil
422   @otp_key = secret
423 end

    # File lib/rodauth/features/otp.rb
264 def _otp_valid_code?(ot_pass, otp)
265   return false unless otp_exists?
266   ot_pass = ot_pass.gsub(/\s+/, '')
267   if drift = otp_drift
268     if otp.respond_to?(:verify_with_drift)
269       # :nocov:
270       otp.verify_with_drift(ot_pass, drift)
271       # :nocov:
272     else
273       otp.verify(ot_pass, :drift_behind=>drift, :drift_ahead=>drift)
274     end
275   else
276     otp.verify(ot_pass)
277   end
278 end

    # File lib/rodauth/features/otp.rb
430 def _otp_valid_code_for_old_secret
431 end

    # File lib/rodauth/features/webauthn.rb
443 def _override_webauthn_credential_response_verify(webauthn_credential)
444   # no need to override
445 end

    # File lib/rodauth/features/base.rb
594 def _process_raw_hmac(hmac)
595   s = [hmac].pack('m')
596   s.chomp!("=\n")
597   s.tr!('+/', '-_')
598   s
599 end

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

    # File lib/rodauth/features/json.rb
212 def _return_json_response
213   response.status ||= json_response_error_status if json_response_error?
214   response.headers[convert_response_header_key('content-type')] ||= json_response_content_type
215   return_response _json_response_body(json_response)
216 end

   # File lib/rodauth/features/json.rb
82 def _set_otp_unlock_info
83   if use_json?
84     json_response[:num_successes] = otp_unlock_num_successes
85     json_response[:required_successes] = otp_unlock_auths_required
86     json_response[:next_attempt_after] = otp_unlock_next_auth_attempt_after.to_i
87   end
88 end

    # File lib/rodauth/features/remember.rb
188 def _set_remember_cookie(account_id, remember_key_value, deadline)
189   opts = Hash[remember_cookie_options]
190   opts[:value] = "#{account_id}_#{convert_token_key(remember_key_value)}"
191   opts[:expires] = convert_timestamp(deadline)
192   opts[:path] = "/" unless opts.key?(:path)
193   opts[:httponly] = true unless opts.key?(:httponly) || opts.key?(:http_only)
194   opts[:secure] = true unless opts.key?(:secure) || !request.ssl?
195   ::Rack::Utils.set_cookie_header!(response.headers, remember_cookie_key, opts)
196 end

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

    # File lib/rodauth/features/sms_codes.rb
473 def _sms_request_response
474   set_notice_flash sms_request_notice_flash
475   redirect sms_auth_redirect
476 end

     # File lib/rodauth/features/base.rb
1020 def _template_opts(opts, page)
1021   opts = scope.send(:find_template, scope.send(:parse_template_opts, page, opts))
1022   unless File.file?(scope.send(:template_path, opts))
1023     opts[:path] = template_path(page)
1024   end
1025   opts
1026 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/two_factor_base.rb
250 def _two_factor_auth_response
251   saved_two_factor_auth_redirect = remove_session_value(two_factor_auth_redirect_session_key)
252   set_notice_flash two_factor_auth_notice_flash
253   redirect(saved_two_factor_auth_redirect || two_factor_auth_redirect)
254 end

    # File lib/rodauth/features/otp.rb
367 def _two_factor_remove_all_from_session
368   two_factor_remove_session('totp')
369   super
370 end

    # File lib/rodauth/features/otp.rb
361 def _two_factor_remove_links
362   links = super
363   links << [20, otp_disable_path, otp_disable_link_text] if otp_exists?
364   links
365 end

    # File lib/rodauth/features/otp.rb
355 def _two_factor_setup_links
356   links = super
357   links << [20, otp_setup_path, otp_setup_link_text] unless otp_exists?
358   links
359 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   change_made = updated && !raised
90   clear_tokens(:change_login) if change_made
91   change_made
92 end

     # File lib/rodauth/features/base.rb
1028 def _view(meth, page)
1029   unless scope.respond_to?(meth)
1030     raise ConfigurationError, "attempted to render a built-in view/email template (#{page.inspect}), but rendering is disabled"
1031   end
1032 
1033   scope.send(meth, _view_opts(page))
1034 end

     # File lib/rodauth/features/base.rb
1000 def _view_opts(page)
1001   opts = template_opts.dup
1002   _merge_fixed_locals_opts(opts, '(rodauth: self.rodauth)')
1003   opts[:locals] = opts[:locals] ? opts[:locals].dup : {}
1004   opts[:locals][:rodauth] = self
1005   opts[:cache] = cache_templates
1006   opts[:cache_key] = :"rodauth_#{page}"
1007   _template_opts(opts, page)
1008 end

    # File lib/rodauth/features/base.rb
415 def account!
416   account || (session_value && account_from_session)
417 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
884 def account_ds(id=account_id)
885   raise ArgumentError, "invalid account id passed to account_ds" unless id
886   ds = account_table_ds.where(account_id_column=>id)
887   ds = ds.select(*account_select) if account_select
888   ds
889 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/base.rb
423 def account_from_id(id, status_id=nil)
424   @account = _account_from_id(id, status_id)
425 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 (hmac_secret && timing_safe_eql?(key, convert_email_token_key(actual))) ||
73      (hmac_secret_rotation? && timing_safe_eql?(key, compute_old_hmac(actual))) ||
74      ((!hmac_secret || allow_raw_email_token?) && timing_safe_eql?(key, actual))
75     return
76   end
77   _account_from_id(id, status_id)
78 end

    # File lib/rodauth/features/base.rb
310 def account_from_login(login)
311   @account = _account_from_login(login)
312 end

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

    # File lib/rodauth/features/remember.rb
219 def account_from_remember_cookie
220   unless id = remembered_session_id
221     # Only set expired cookie if there is already a cookie set.
222     forget_login if _get_remember_cookie
223     return
224   end
225 
226   set_session_value(session_key, id)
227   account_from_session
228   remove_session_value(session_key)
229 
230   unless account
231     remove_remember_key(id)
232     forget_login
233     return
234   end
235 
236   account
237 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
419 def account_from_session
420   @account = _account_from_session
421 end

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

    # File lib/rodauth/features/verify_account.rb
198 def account_from_verify_account_key(key)
199   @account = _account_from_verify_account_key(key)
200 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/webauthn_autofill.rb
45 def account_from_webauthn_login
46   return super if param_or_nil(login_param)
47 
48   credential_id = webauthn_auth_data["id"]
49   account_id = db[webauthn_keys_table]
50     .where(webauthn_keys_webauthn_id_column => credential_id)
51     .get(webauthn_keys_account_id_column)
52 
53   unless account_id
54     throw_error_reason(:invalid_webauthn_id, invalid_field_error_status, webauthn_auth_param, webauthn_invalid_webauthn_id_message)
55   end
56 
57   account_from_id(account_id)
58 end

    # File lib/rodauth/features/base.rb
300 def account_id
301   account[account_id_column]
302 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
411 def account_initial_status_value
412   account_open_status_value
413 end

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

    # File lib/rodauth/features/lockout.rb
297 def account_login_failures_ds
298   db[account_login_failures_table].where(account_login_failures_id_column=>account_id)
299 end

    # File lib/rodauth/features/base.rb
334 def account_password_hash_column
335   nil
336 end

    # File lib/rodauth/features/base.rb
876 def account_session_status_filter
877   {account_status_column=>account_open_status_value}
878 end

    # File lib/rodauth/features/base.rb
891 def account_table_ds
892   db[accounts_table]
893 end

    # File lib/rodauth/features/webauthn.rb
271 def account_webauthn_ids
272   webauthn_keys_ds.select_map(webauthn_keys_webauthn_id_column)
273 end

    # File lib/rodauth/features/webauthn.rb
275 def account_webauthn_usage
276   webauthn_keys_ds.select_hash(webauthn_keys_webauthn_id_column, webauthn_keys_last_use_column)
277 end

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

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

    # File lib/rodauth/features/active_sessions.rb
236 def active_sessions_ds
237   db[active_sessions_table].
238     where(active_sessions_account_id_column=>session_value || account_id)
239 end

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

    # File lib/rodauth/features/active_sessions.rb
203 def active_sessions_update_hash
204   h = {active_sessions_last_use_column => Sequel::CURRENT_TIMESTAMP}
205 
206   if hmac_secret_rotation?
207     h[active_sessions_session_id_column] = compute_hmac(session[session_id_session_key])
208   end
209 
210   h
211 end

   # File lib/rodauth/features/active_sessions.rb
70 def add_active_session
71   key = generate_active_sessions_key
72   set_session_value(session_id_session_key, key)
73   if e = raises_uniqueness_violation?{active_sessions_ds.insert(active_sessions_insert_hash)}
74     handle_duplicate_active_session_id(e)
75   end
76   nil
77 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
215 def add_field_error_class(field)
216   if field_error(field)
217     " #{input_field_error_class}"
218   end
219 end

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

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

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

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

    # File lib/rodauth/features/recovery_codes.rb
153 def add_webauthn_credential(_)
154   super if defined?(super)
155   auto_add_missing_recovery_codes
156 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
89 def after_create_account
90   if account_password_hash_column && !(respond_to?(:verify_account_set_password?) && verify_account_set_password?)
91     add_previous_password_hash(password_hash(param(password_param)))
92   end
93   super if defined?(super)
94 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 if force_email_auth?
154 
155   super
156 end

    # File lib/rodauth/features/lockout.rb
268 def after_login_failure
269   invalid_login_attempted
270   super
271 end

    # File lib/rodauth/features/remember.rb
243 def after_logout
244   forget_login
245   super if defined?(super)
246 end

   # File lib/rodauth/features/otp_lockout_email.rb
18 def after_otp_authentication_failure
19   super
20 
21   if otp_locked_out? && send_otp_locked_out_email?
22     send_otp_locked_out_email
23   end
24 end

   # File lib/rodauth/features/otp_modify_email.rb
18 def after_otp_disable
19   super
20   send_otp_disabled_email
21 end

    # File lib/rodauth/features/active_sessions.rb
153 def after_otp_setup
154   super if defined?(super)
155   remove_all_active_sessions_except_current if @clear_active_sessions_after_two_factor_setup
156 end

    # File lib/rodauth/features/json.rb
 98 def after_otp_unlock_auth_failure
 99   super if defined?(super)
100   _set_otp_unlock_info
101 end

   # File lib/rodauth/features/json.rb
90 def after_otp_unlock_auth_success
91   super if defined?(super)
92   if otp_locked_out?
93     _set_otp_unlock_info
94     json_response[:deadline] = otp_unlock_deadline.to_i
95   end
96 end

    # File lib/rodauth/features/json.rb
103 def after_otp_unlock_not_yet_available
104   super if defined?(super)
105   _set_otp_unlock_info
106 end

    # File lib/rodauth/features/active_sessions.rb
137 def after_refresh_token
138   super if defined?(super)
139   if prev_key = session[session_id_session_key]
140     key = generate_active_sessions_key
141     set_session_value(session_id_session_key, key)
142     active_sessions_ds.
143       where(active_sessions_session_id_column => compute_hmacs(prev_key)).
144       update(active_sessions_session_id_column => compute_hmac(key))
145   end
146 end

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

    # File lib/rodauth/features/active_sessions.rb
158 def after_sms_confirm
159   super if defined?(super)
160   remove_all_active_sessions_except_current if @clear_active_sessions_after_two_factor_setup
161 end

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

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

    # File lib/rodauth/features/active_sessions.rb
163 def after_webauthn_setup
164   super if defined?(super)
165   remove_all_active_sessions_except_current if @clear_active_sessions_after_two_factor_setup
166 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
165 def allow_resending_verify_account_email?
166   account[account_status_column] == account_unverified_status_value
167 end

    # File lib/rodauth/features/base.rb
342 def already_logged_in
343   nil
344 end

    # File lib/rodauth/features/argon2.rb
107 def argon2_hash_algorithm?(hash)
108   hash.start_with?('$argon2id$')
109 end

   # File lib/rodauth/features/argon2.rb
78 def argon2_hash_cost
79   { t_cost: 1, m_cost: 5, p_cost: 1 }
80 end

    # File lib/rodauth/features/argon2.rb
111 def argon2_password_hash_match?(hash, password)
112   ret = ::Argon2::Password.verify_password(password, hash, argon2_secret)
113 
114   if ret == false && argon2_old_secret != argon2_secret && (ret = ::Argon2::Password.verify_password(password, hash, argon2_old_secret))
115     @update_password_hash = true
116   end
117 
118   ret
119 end

   # File lib/rodauth/features/argon2.rb
62 def argon2_password_hash_using_salt_and_secret(password, salt, secret)
63   argon2_params = Hash[extract_password_hash_cost(salt)]
64   argon2_params[argon2_salt_option] = salt.split('$').last.unpack("m")[0]
65   argon2_params[:secret] = secret
66   ::Argon2::Password.new(argon2_params).create(password)
67 end

   # File lib/rodauth/features/argon2.rb
36 def argon2_salt_option
37   :salt_do_not_supply
38 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
150 def auth_class_eval(&block)
151   auth.class_eval(&block)
152 end

    # File lib/rodauth/features/base.rb
398 def authenticated?
399   logged_in?
400 end

    # File lib/rodauth/features/base.rb
502 def authenticated_by
503   session[authenticated_by_session_key]
504 end

    # File lib/rodauth/features/webauthn.rb
251 def authenticated_webauthn_id
252   session[authenticated_webauthn_id_session_key]
253 end

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

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

    # File lib/rodauth/features/base.rb
245 def autocomplete_for_field?(_param)
246   mark_input_fields_with_autocomplete?
247 end

    # File lib/rodauth/features/base.rb
515 def autologin_session(autologin_type)
516   login_session('autologin')
517   set_session_value(autologin_type_session_key, autologin_type)
518 end

    # File lib/rodauth/features/base.rb
511 def autologin_type
512   session[autologin_type_session_key]
513 end

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

    # File lib/rodauth/features/base.rb
561 def base_url
562   url = String.new("#{request.scheme}://#{domain}")
563   url << ":#{request.port}" if request.port != Rack::Request::DEFAULT_PORTS[request.scheme]
564   url
565 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
79 def before_create_account_route
80   super if defined?(super)
81   @dont_check_previous_password = true
82 end

    # File lib/rodauth/features/lockout.rb
256 def before_login_attempt
257   if locked_out?
258     show_lockout_page
259   end
260   super
261 end

    # File lib/rodauth/features/active_sessions.rb
168 def before_logout
169   if param_or_nil(global_logout_param)
170     remove_remember_key(session_value) if respond_to?(:remove_remember_key)
171     remove_all_active_sessions
172   else
173     remove_current_session
174   end
175   super
176 end

    # File lib/rodauth/features/active_sessions.rb
178 def before_otp_setup
179   @clear_active_sessions_after_two_factor_setup = !two_factor_authentication_setup?
180   super if defined?(super)
181 end

    # File lib/rodauth/features/json.rb
172 def before_otp_setup_route
173   super if defined?(super)
174   if use_json? && otp_keys_use_hmac? && !param_or_nil(otp_setup_raw_param)
175     _otp_tmp_key(otp_new_secret)
176     json_response[otp_setup_param] = otp_user_key
177     json_response[otp_setup_raw_param] = otp_key
178   end
179 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
181 def before_rodauth
182   if json_request?
183     if json_check_accept? && (accept = request.env['HTTP_ACCEPT']) && accept !~ json_accept_regexp
184       response.status = 406
185       json_response[json_response_error_key] = json_not_accepted_error_message
186       _return_json_response
187     end
188 
189     unless request.post?
190       response.status = 405
191       set_response_header('allow', 'POST')
192       json_response[json_response_error_key] = json_non_post_error_message
193       return_json_response
194     end
195   elsif only_json?
196     response.status = json_response_error_status
197     return_response non_json_request_error_message
198   end
199 
200   super
201 end

    # File lib/rodauth/features/active_sessions.rb
183 def before_sms_confirm
184   @clear_active_sessions_after_two_factor_setup = !two_factor_authentication_setup?
185   super if defined?(super)
186 end

    # File lib/rodauth/features/json.rb
118 def before_two_factor_auth_route
119   super if defined?(super)
120   if use_json?
121     json_response[:auth_links] = two_factor_auth_links.sort.map{|_,link| link}
122     json_response[json_response_success_key] ||= "" if include_success_messages?
123     return_json_response
124   end
125 end

    # File lib/rodauth/features/json.rb
108 def before_two_factor_manage_route
109   super if defined?(super)
110   if use_json?
111     json_response[:setup_links] = two_factor_setup_links.sort.map{|_,link| link}
112     json_response[:remove_links] = two_factor_remove_links.sort.map{|_,link| link}
113     json_response[json_response_success_key] ||= "" if include_success_messages?
114     return_json_response
115   end
116 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
32 def before_verify_account
33   super
34   if features.include?(:json) && use_json? && !param_or_nil(webauthn_setup_param)
35     cred = new_webauthn_credential
36     json_response[webauthn_setup_param] = cred.as_json
37     json_response[webauthn_setup_challenge_param] = cred.challenge
38     json_response[webauthn_setup_challenge_hmac_param] = compute_hmac(cred.challenge)
39   end
40   @webauthn_credential = webauthn_setup_credential_from_form_submission
41   add_webauthn_credential(@webauthn_credential)
42 end

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

    # File lib/rodauth/features/json.rb
127 def before_view_recovery_codes
128   super if defined?(super)
129   if use_json?
130     json_response[:codes] = recovery_codes
131     json_response[json_response_success_key] ||= "" if include_success_messages?
132   end
133 end

    # File lib/rodauth/features/json.rb
145 def before_webauthn_auth_route
146   super if defined?(super)
147   if use_json? && !param_or_nil(webauthn_auth_param)
148     cred = webauthn_credential_options_for_get
149     json_response[webauthn_auth_param] = cred.as_json
150     json_response[webauthn_auth_challenge_param] = cred.challenge
151     json_response[webauthn_auth_challenge_hmac_param] = compute_hmac(cred.challenge)
152   end
153 end

    # File lib/rodauth/features/json.rb
155 def before_webauthn_login_route
156   super if defined?(super)
157   if use_json? && !param_or_nil(webauthn_auth_param) && webauthn_login_options?
158     cred = webauthn_credential_options_for_get
159     json_response[webauthn_auth_param] = cred.as_json
160     json_response[webauthn_auth_challenge_param] = cred.challenge
161     json_response[webauthn_auth_challenge_hmac_param] = compute_hmac(cred.challenge)
162   end
163 end

    # File lib/rodauth/features/json.rb
165 def before_webauthn_remove_route
166   super if defined?(super)
167   if use_json? && !param_or_nil(webauthn_remove_param)
168     json_response[webauthn_remove_param] = account_webauthn_usage
169   end
170 end

    # File lib/rodauth/features/active_sessions.rb
188 def before_webauthn_setup
189   @clear_active_sessions_after_two_factor_setup = !two_factor_authentication_setup?
190   super if defined?(super)
191 end

    # File lib/rodauth/features/json.rb
135 def before_webauthn_setup_route
136   super if defined?(super)
137   if use_json? && !param_or_nil(webauthn_setup_param)
138     cred = new_webauthn_credential
139     json_response[webauthn_setup_param] = cred.as_json
140     json_response[webauthn_setup_challenge_param] = cred.challenge
141     json_response[webauthn_setup_challenge_hmac_param] = compute_hmac(cred.challenge)
142   end
143 end

    # File lib/rodauth/features/base.rb
452 def button(value, opts={})
453   scope.render(button_opts(value, opts))
454 end

    # File lib/rodauth/features/base.rb
638 def button_fixed_locals
639   '(value:, opts:)'
640 end

    # File lib/rodauth/features/base.rb
443 def button_opts(value, opts)
444   opts = Hash[template_opts].merge!(opts)
445   _merge_fixed_locals_opts(opts, button_fixed_locals)
446   opts[:locals] = {:value=>value, :opts=>opts}
447   opts[:cache] = cache_templates
448   opts[:cache_key] = :rodauth_button
449   _template_opts(opts, 'button')
450 end

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

    # File lib/rodauth/features/base.rb
738 def catch_error(&block)
739   catch(:rodauth_error, &block)
740 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
56 def check_active_session
57   if logged_in? && !currently_active_session?
58     no_longer_active_session
59   end
60 end

    # File lib/rodauth/features/base.rb
338 def check_already_logged_in
339   already_logged_in if logged_in?
340 end

    # File lib/rodauth/features/base.rb
427 def check_csrf
428   scope.check_csrf!(check_csrf_opts, &check_csrf_block)
429 end

    # File lib/rodauth/features/base.rb
800 def check_csrf?
801   scope.opts[:rodauth_route_csrf]
802 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
52 def check_single_session
53   if logged_in? && !currently_active_session?
54     no_longer_active_session
55   end
56 end

    # File lib/rodauth/features/otp.rb
372 def clear_cached_otp
373   @otp = nil
374 end

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

    # File lib/rodauth/features/base.rb
354 def clear_session
355   if use_scope_clear_session?
356     scope.clear_session
357   else
358     session.clear
359   end
360 end

    # File lib/rodauth/features/active_sessions.rb
130 def clear_tokens(reason)
131   super
132   remove_all_active_sessions_except_current
133 end

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

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

    # File lib/rodauth/features/base.rb
279 def compute_hmac(data)
280   _process_raw_hmac(compute_raw_hmac(data))
281 end

    # File lib/rodauth/features/base.rb
290 def compute_hmacs(data)
291   hmacs = [compute_hmac(data)]
292 
293   if hmac_old_secret
294     hmacs << compute_old_hmac(data)
295   end
296 
297   hmacs
298 end

    # File lib/rodauth/features/base.rb
284 def compute_old_hmac(data)
285   _process_raw_hmac(compute_raw_hmac_with_secret(data, hmac_old_secret))
286 end

    # File lib/rodauth/features/base.rb
855 def compute_raw_hmac(data)
856   raise ConfigurationError, "hmac_secret not set" unless hmac_secret
857   compute_raw_hmac_with_secret(data, hmac_secret)
858 end

    # File lib/rodauth/features/base.rb
860 def compute_raw_hmac_with_secret(data, secret)
861   OpenSSL::HMAC.digest(OpenSSL::Digest::SHA256.new, secret, data)
862 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
606 def convert_response_header_key(key)
607   key
608 end

    # File lib/rodauth/features/base.rb
717 def convert_session_key(key)
718   key = :"#{session_key_prefix}#{key}" if session_key_prefix
719   normalize_session_or_flash_key(key)
720 end

    # File lib/rodauth/features/base.rb
900 def convert_timestamp(timestamp)
901   timestamp = db.to_application_timestamp(timestamp) if timestamp.is_a?(String)
902   timestamp
903 end

    # File lib/rodauth/features/base.rb
671 def convert_token_id(id)
672   if convert_token_id_to_integer?
673     convert_token_id_to_integer(id)
674   else
675     id
676   end
677 end