module Rodauth

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

    # File lib/rodauth/features/base.rb
814 def _account_from_id(id, status_id=nil)
815   ds = account_ds(id)
816   ds = ds.where(account_status_column=>status_id) if status_id && !skip_status_checks?
817   ds.first
818 end

    # File lib/rodauth/features/base.rb
801 def _account_from_login(login)
802   ds = account_table_ds.where(login_column=>login)
803   ds = ds.select(*account_select) if account_select
804   ds = ds.where(account_status_column=>[account_unverified_status_value, account_open_status_value]) unless skip_status_checks?
805   ds.first
806 end

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

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

    # File lib/rodauth/features/base.rb
808 def _account_from_session
809   ds = account_ds(session_value)
810   ds = ds.where(account_session_status_filter) unless skip_status_checks?
811   ds.first
812 end

    # File lib/rodauth/features/lockout.rb
303 def _account_from_unlock_key(token)
304   account_from_key(token){|id| account_lockouts_ds(id).get(account_lockouts_key_column)}
305 end

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

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

    # File lib/rodauth/features/jwt_refresh.rb
132 def _account_refresh_token_split(token)
133   id, token = split_token(token)
134   id = convert_token_id(id)
135   return unless id && token
136 
137   token_id, key = split_token(token)
138   token_id = convert_token_id(token_id)
139   return unless token_id && key
140 
141   [id, token_id, key]
142 end

    # File lib/rodauth/features/base.rb
559 def _around_rodauth
560   yield
561 end

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

    # File lib/rodauth/features/base.rb
833 def _field_attributes(field)
834   nil
835 end

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

    # File lib/rodauth/features/base.rb
928 def _filter_links(links)
929   links.select!{|_, link| link}
930   links.sort!
931   links
932 end

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

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

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

    # File lib/rodauth/features/jwt.rb
104 def _jwt_decode_opts
105   jwt_decode_opts
106 end

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

    # File lib/rodauth/features/login.rb
168 def _login(auth_type)
169   warn("Deprecated #_login method called, use #login instead.")
170   login(auth_type)
171 end

    # File lib/rodauth/features/login.rb
163 def _login_form_footer
164   return '' if _login_form_footer_links.empty?
165   render('login-form-footer')
166 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
148 def _login_response
149   set_notice_flash login_notice_flash
150   redirect(saved_login_redirect || login_redirect)
151 end

    # File lib/rodauth/features/base.rb
979 def _merge_fixed_locals_opts(opts, fixed_locals)
980   if use_template_fixed_locals? && !opts[:locals]
981     fixed_locals_opts = {default_fixed_locals: fixed_locals}
982     fixed_locals_opts.merge!(opts[:template_opts]) if opts[:template_opts]
983     opts[:template_opts] = fixed_locals_opts
984   end
985 end

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

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

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

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

    # File lib/rodauth/features/otp.rb
437 def _otp_key
438   @otp_user_key = nil
439   otp_key_ds.get(otp_keys_column)
440 end

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

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

    # File lib/rodauth/features/otp.rb
428 def _otp_valid_code_for_old_secret
429 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
563 def _process_raw_hmac(hmac)
564   s = [hmac].pack('m')
565   s.chomp!("=\n")
566   s.tr!('+/', '-_')
567   s
568 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
210 def _return_json_response
211   response.status ||= json_response_error_status if json_response_error?
212   response.headers[convert_response_header_key('content-type')] ||= json_response_content_type
213   return_response _json_response_body(json_response)
214 end

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

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

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

    # File lib/rodauth/features/sms_codes.rb
524 def _sms
525   sms_ds.first
526 end

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

    # File lib/rodauth/features/base.rb
989 def _template_opts(opts, page)
990   opts = scope.send(:find_template, scope.send(:parse_template_opts, page, opts))
991   unless File.file?(scope.send(:template_path, opts))
992     opts[:path] = template_path(page)
993   end
994   opts
995 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
248 def _two_factor_auth_response
249   saved_two_factor_auth_redirect = remove_session_value(two_factor_auth_redirect_session_key)
250   set_notice_flash two_factor_auth_notice_flash
251   redirect(saved_two_factor_auth_redirect || two_factor_auth_redirect)
252 end

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

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

    # File lib/rodauth/features/otp.rb
353 def _two_factor_setup_links
354   links = super
355   links << [20, otp_setup_path, otp_setup_link_text] unless otp_exists?
356   links
357 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
 997 def _view(meth, page)
 998   unless scope.respond_to?(meth)
 999     raise ConfigurationError, "attempted to render a built-in view/email template (#{page.inspect}), but rendering is disabled"
1000   end
1001 
1002   scope.send(meth, _view_opts(page))
1003 end

    # File lib/rodauth/features/base.rb
969 def _view_opts(page)
970   opts = template_opts.dup
971   _merge_fixed_locals_opts(opts, '(rodauth: self.rodauth)')
972   opts[:locals] = opts[:locals] ? opts[:locals].dup : {}
973   opts[:locals][:rodauth] = self
974   opts[:cache] = cache_templates
975   opts[:cache_key] = :"rodauth_#{page}"
976   _template_opts(opts, page)
977 end

    # File lib/rodauth/features/base.rb
387 def account!
388   account || (session_value && account_from_session)
389 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
853 def account_ds(id=account_id)
854   raise ArgumentError, "invalid account id passed to account_ds" unless id
855   ds = account_table_ds.where(account_id_column=>id)
856   ds = ds.select(*account_select) if account_select
857   ds
858 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
131 def account_from_email_auth_key(key)
132   @account = _account_from_email_auth_key(key)
133 end

    # File lib/rodauth/features/base.rb
395 def account_from_id(id, status_id=nil)
396   @account = _account_from_id(id, status_id)
397 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
282 def account_from_login(login)
283   @account = _account_from_login(login)
284 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
217 def account_from_remember_cookie
218   unless id = remembered_session_id
219     # Only set expired cookie if there is already a cookie set.
220     forget_login if _get_remember_cookie
221     return
222   end
223 
224   set_session_value(session_key, id)
225   account_from_session
226   remove_session_value(session_key)
227 
228   unless account
229     remove_remember_key(id)
230     forget_login
231     return
232   end
233 
234   account
235 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
391 def account_from_session
392   @account = _account_from_session
393 end

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

    # File lib/rodauth/features/verify_account.rb
196 def account_from_verify_account_key(key)
197   @account = _account_from_verify_account_key(key)
198 end

    # File lib/rodauth/features/verify_login_change.rb
120 def account_from_verify_login_change_key(key)
121   @account = _account_from_verify_login_change_key(key)
122 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
272 def account_id
273   account[account_id_column]
274 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
383 def account_initial_status_value
384   account_open_status_value
385 end

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

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

    # File lib/rodauth/features/base.rb
306 def account_password_hash_column
307   nil
308 end

    # File lib/rodauth/features/base.rb
845 def account_session_status_filter
846   {account_status_column=>account_open_status_value}
847 end

    # File lib/rodauth/features/base.rb
860 def account_table_ds
861   db[accounts_table]
862 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
265 def active_remember_key_ds(id=account_id)
266   remember_key_ds(id).where(Sequel.expr(remember_deadline_column) > Sequel::CURRENT_TIMESTAMP)
267 end

    # File lib/rodauth/features/active_sessions.rb
204 def active_sessions_ds
205   db[active_sessions_table].
206     where(active_sessions_account_id_column=>session_value || account_id)
207 end

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

    # File lib/rodauth/features/active_sessions.rb
171 def active_sessions_update_hash
172   h = {active_sessions_last_use_column => Sequel::CURRENT_TIMESTAMP}
173 
174   if hmac_secret_rotation?
175     h[active_sessions_session_id_column] = compute_hmac(session[session_id_session_key])
176   end
177 
178   h
179 end

   # File lib/rodauth/features/active_sessions.rb
68 def add_active_session
69   key = generate_active_sessions_key
70   set_session_value(session_id_session_key, key)
71   if e = raises_uniqueness_violation?{active_sessions_ds.insert(active_sessions_insert_hash)}
72     handle_duplicate_active_session_id(e)
73   end
74   nil
75 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
187 def add_field_error_class(field)
188   if field_error(field)
189     " #{input_field_error_class}"
190   end
191 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
159 def add_remember_key
160   hash = {remember_id_column=>account_id, remember_key_column=>remember_key_value}
161   set_deadline_value(hash, remember_deadline_column, remember_deadline_interval)
162 
163   if e = raised_uniqueness_violation{remember_key_ds.insert(hash)}
164     # If inserting into the remember key table causes a violation, we can pull the
165     # existing row from the table.  If there is no invalid row, we can then reraise.
166     raise e unless @remember_key_value = active_remember_key_ds.get(remember_key_column)
167   end
168 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
206 def after_login
207   # Remove the email auth key after any login, even if
208   # it is a password login.  This is done to invalidate
209   # the email login when a user has a password and requests
210   # email authentication, but then remembers their password
211   # and doesn't need the link.  At that point, the link
212   # that allows login access to the account becomes a
213   # security liability, and it is best to remove it.
214   remove_email_auth_key
215   super
216 end

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

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

    # File lib/rodauth/features/remember.rb
241 def after_logout
242   forget_login
243   super if defined?(super)
244 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/otp_modify_email.rb
13 def after_otp_setup
14   super
15   send_otp_setup_email
16 end

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

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

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

    # File lib/rodauth/features/active_sessions.rb
135 def after_refresh_token
136   super if defined?(super)
137   if prev_key = session[session_id_session_key]
138     key = generate_active_sessions_key
139     set_session_value(session_id_session_key, key)
140     active_sessions_ds.
141       where(active_sessions_session_id_column => compute_hmacs(prev_key)).
142       update(active_sessions_session_id_column => compute_hmac(key))
143   end
144 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/webauthn_modify_email.rb
13 def after_webauthn_setup
14   super
15   send_webauthn_authenticator_added_email
16 end

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

    # File lib/rodauth/features/verify_account.rb
163 def allow_resending_verify_account_email?
164   account[account_status_column] == account_unverified_status_value
165 end

    # File lib/rodauth/features/base.rb
314 def already_logged_in
315   nil
316 end

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

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

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

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

   # File lib/rodauth/features/argon2.rb
34 def argon2_salt_option
35   :salt_do_not_supply
36 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
137 def auth_class_eval(&block)
138   auth.class_eval(&block)
139 end

    # File lib/rodauth/features/base.rb
370 def authenticated?
371   logged_in?
372 end

    # File lib/rodauth/features/base.rb
474 def authenticated_by
475   session[authenticated_by_session_key]
476 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
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
217 def autocomplete_for_field?(_param)
218   mark_input_fields_with_autocomplete?
219 end

    # File lib/rodauth/features/base.rb
487 def autologin_session(autologin_type)
488   login_session('autologin')
489   set_session_value(autologin_type_session_key, autologin_type)
490 end

    # File lib/rodauth/features/base.rb
483 def autologin_type
484   session[autologin_type_session_key]
485 end

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

    # File lib/rodauth/features/base.rb
533 def base_url
534   url = String.new("#{request.scheme}://#{domain}")
535   url << ":#{request.port}" if request.port != Rack::Request::DEFAULT_PORTS[request.scheme]
536   url
537 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
254 def before_login_attempt
255   if locked_out?
256     show_lockout_page
257   end
258   super
259 end

    # File lib/rodauth/features/active_sessions.rb
151 def before_logout
152   if param_or_nil(global_logout_param)
153     remove_remember_key(session_value) if respond_to?(:remove_remember_key)
154     remove_all_active_sessions
155   else
156     remove_current_session
157   end
158   super
159 end

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

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

    # File lib/rodauth/features/json.rb
106 def before_two_factor_manage_route
107   super if defined?(super)
108   if use_json?
109     json_response[:setup_links] = two_factor_setup_links.sort.map{|_,link| link}
110     json_response[:remove_links] = two_factor_remove_links.sort.map{|_,link| link}
111     json_response[json_response_success_key] ||= "" if include_success_messages?
112     return_json_response
113   end
114 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
125 def before_view_recovery_codes
126   super if defined?(super)
127   if use_json?
128     json_response[:codes] = recovery_codes
129     json_response[json_response_success_key] ||= "" if include_success_messages?
130   end
131 end

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

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

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

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

    # File lib/rodauth/features/base.rb
424 def button(value, opts={})
425   scope.render(button_opts(value, opts))
426 end

    # File lib/rodauth/features/base.rb
607 def button_fixed_locals
608   '(value:, opts:)'
609 end

    # File lib/rodauth/features/base.rb
415 def button_opts(value, opts)
416   opts = Hash[template_opts].merge!(opts)
417   _merge_fixed_locals_opts(opts, button_fixed_locals)
418   opts[:locals] = {:value=>value, :opts=>opts}
419   opts[:cache] = cache_templates
420   opts[:cache_key] = :rodauth_button
421   _template_opts(opts, 'button')
422 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
707 def catch_error(&block)
708   catch(:rodauth_error, &block)
709 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
136 def change_login_notice_flash
137   change_login_needs_verification_notice_flash
138 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
54 def check_active_session
55   if logged_in? && !currently_active_session?
56     no_longer_active_session
57   end
58 end

    # File lib/rodauth/features/base.rb
310 def check_already_logged_in
311   already_logged_in if logged_in?
312 end

    # File lib/rodauth/features/base.rb
399 def check_csrf
400   scope.check_csrf!(check_csrf_opts, &check_csrf_block)
401 end

    # File lib/rodauth/features/base.rb
769 def check_csrf?
770   scope.opts[:rodauth_route_csrf]
771 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
370 def clear_cached_otp
371   remove_instance_variable(:@otp) if defined?(@otp)
372 end

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

    # File lib/rodauth/features/base.rb
326 def clear_session
327   if use_scope_clear_session?
328     scope.clear_session
329   else
330     session.clear
331   end
332 end

    # File lib/rodauth/features/active_sessions.rb
128 def clear_tokens(reason)
129   super
130   remove_all_active_sessions_except_current
131 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
251 def compute_hmac(data)
252   _process_raw_hmac(compute_raw_hmac(data))
253 end

    # File lib/rodauth/features/base.rb
262 def compute_hmacs(data)
263   hmacs = [compute_hmac(data)]
264 
265   if hmac_old_secret
266     hmacs << compute_old_hmac(data)
267   end
268 
269   hmacs
270 end

    # File lib/rodauth/features/base.rb
256 def compute_old_hmac(data)
257   _process_raw_hmac(compute_raw_hmac_with_secret(data, hmac_old_secret))
258 end

    # File lib/rodauth/features/base.rb
824 def compute_raw_hmac(data)
825   raise ConfigurationError, "hmac_secret not set" unless hmac_secret
826   compute_raw_hmac_with_secret(data, hmac_secret)
827 end

    # File lib/rodauth/features/base.rb
829 def compute_raw_hmac_with_secret(data, secret)
830   OpenSSL::HMAC.digest(OpenSSL::Digest::SHA256.new, secret, data)
831 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
575 def convert_response_header_key(key)
576   key
577 end

    # File lib/rodauth/features/base.rb
686 def convert_session_key(key)
687   key = :"#{session_key_prefix}#{key}" if session_key_prefix
688   normalize_session_or_flash_key(key)
689 end

    # File lib/rodauth/features/base.rb
869 def convert_timestamp(timestamp)
870   timestamp = db.to_application_timestamp(timestamp) if timestamp.is_a?(String)
871   timestamp
872 end

    # File lib/rodauth/features/base.rb
640 def convert_token_id(id)
641   if convert_token_id_to_integer?
642     convert_token_id_to_integer(id)
643   else
644     id
645   end
646 end

    # File lib/rodauth/features/base.rb
648 def convert_token_id_to_integer(id)
649   if id = (Integer(id, 10) rescue nil)
650     if id > 9223372036854775807 || id < -9223372036854775808
651       # Only allow 64-bit signed integer range to avoid problems on PostgreSQL
652       id = nil
653     end
654   end
655 
656   id
657 end

    # File lib/rodauth/features/base.rb
628 def convert_token_key(key)
629   if key && hmac_secret
630     compute_hmac(key)
631   else
632     key
633   end
634 end

    # File lib/rodauth/features/verify_account.rb
216 def create_account_autologin?
217   false
218 end

    # File lib/rodauth/features/verify_account.rb
183 def create_account_notice_flash
184   verify_account_email_sent_notice_flash
185 end