module Rodauth

  1. lib/rodauth.rb
  2. lib/rodauth/features/account_expiration.rb
  3. lib/rodauth/features/active_sessions.rb
  4. lib/rodauth/features/argon2.rb
  5. lib/rodauth/features/audit_logging.rb
  6. lib/rodauth/features/base.rb
  7. lib/rodauth/features/change_login.rb
  8. lib/rodauth/features/change_password.rb
  9. lib/rodauth/features/change_password_notify.rb
  10. lib/rodauth/features/close_account.rb
  11. lib/rodauth/features/confirm_password.rb
  12. lib/rodauth/features/create_account.rb
  13. lib/rodauth/features/disallow_common_passwords.rb
  14. lib/rodauth/features/disallow_password_reuse.rb
  15. lib/rodauth/features/email_auth.rb
  16. lib/rodauth/features/email_base.rb
  17. lib/rodauth/features/http_basic_auth.rb
  18. lib/rodauth/features/internal_request.rb
  19. lib/rodauth/features/json.rb
  20. lib/rodauth/features/jwt.rb
  21. lib/rodauth/features/jwt_cors.rb
  22. lib/rodauth/features/jwt_refresh.rb
  23. lib/rodauth/features/lockout.rb
  24. lib/rodauth/features/login.rb
  25. lib/rodauth/features/login_password_requirements_base.rb
  26. lib/rodauth/features/logout.rb
  27. lib/rodauth/features/otp.rb
  28. lib/rodauth/features/password_complexity.rb
  29. lib/rodauth/features/password_expiration.rb
  30. lib/rodauth/features/password_grace_period.rb
  31. lib/rodauth/features/password_pepper.rb
  32. lib/rodauth/features/path_class_methods.rb
  33. lib/rodauth/features/recovery_codes.rb
  34. lib/rodauth/features/remember.rb
  35. lib/rodauth/features/reset_password.rb
  36. lib/rodauth/features/reset_password_notify.rb
  37. lib/rodauth/features/session_expiration.rb
  38. lib/rodauth/features/single_session.rb
  39. lib/rodauth/features/sms_codes.rb
  40. lib/rodauth/features/two_factor_base.rb
  41. lib/rodauth/features/update_password_hash.rb
  42. lib/rodauth/features/verify_account.rb
  43. lib/rodauth/features/verify_account_grace_period.rb
  44. lib/rodauth/features/verify_login_change.rb
  45. lib/rodauth/features/webauthn.rb
  46. lib/rodauth/features/webauthn_autofill.rb
  47. lib/rodauth/features/webauthn_login.rb
  48. lib/rodauth/features/webauthn_verify_account.rb
  49. lib/rodauth/migrations.rb
  50. lib/rodauth/version.rb
  51. show all

:nocov:

Methods

Public Class

  1. configure
  2. create_database_authentication_functions
  3. create_database_previous_password_check_functions
  4. drop_database_authentication_functions
  5. drop_database_previous_password_check_functions
  6. lib
  7. load_dependencies
  8. new
  9. version

Public Instance

  1. _account_from_email_auth_key
  2. _account_from_login
  3. _account_from_refresh_token
  4. _account_from_reset_password_key
  5. _account_from_session
  6. _account_from_unlock_key
  7. _account_from_verify_account_key
  8. _account_from_verify_login_change_key
  9. _account_refresh_token_split
  10. _around_rodauth
  11. _email_auth_request
  12. _field_attributes
  13. _field_error_attributes
  14. _filter_links
  15. _formatted_field_error
  16. _get_remember_cookie
  17. _json_response_body
  18. _jwt_decode_opts
  19. _jwt_decode_secrets
  20. _login
  21. _login_form_footer
  22. _login_form_footer_links
  23. _login_response
  24. _multi_phase_login_forms
  25. _new_account
  26. _otp
  27. _otp_add_key
  28. _otp_for_key
  29. _otp_key
  30. _otp_tmp_key
  31. _otp_valid_code?
  32. _otp_valid_code_for_old_secret
  33. _process_raw_hmac
  34. _recovery_codes
  35. _return_json_response
  36. _set_remember_cookie
  37. _setup_account_lockouts_hash
  38. _sms
  39. _sms_request_response
  40. _template_opts
  41. _two_factor_auth_links
  42. _two_factor_auth_response
  43. _two_factor_remove_all_from_session
  44. _two_factor_remove_links
  45. _two_factor_setup_links
  46. _update_login
  47. _view
  48. _view_opts
  49. account!
  50. account_activity_ds
  51. account_ds
  52. account_expired?
  53. account_expired_at
  54. account_from_email_auth_key
  55. account_from_key
  56. account_from_login
  57. account_from_refresh_token
  58. account_from_remember_cookie
  59. account_from_reset_password_key
  60. account_from_session
  61. account_from_unlock_key
  62. account_from_verify_account_key
  63. account_from_verify_login_change_key
  64. account_from_webauthn_login
  65. account_id
  66. account_in_unverified_grace_period?
  67. account_initial_status_value
  68. account_lockouts_ds
  69. account_login_failures_ds
  70. account_password_hash_column
  71. account_session_status_filter
  72. account_table_ds
  73. account_webauthn_ids
  74. account_webauthn_usage
  75. account_webauthn_user_id
  76. active_remember_key_ds
  77. active_sessions_ds
  78. active_sessions_insert_hash
  79. active_sessions_update_hash
  80. add_active_session
  81. add_audit_log
  82. add_field_error_class
  83. add_previous_password_hash
  84. add_recovery_code
  85. add_recovery_codes
  86. add_remember_key
  87. add_webauthn_credential
  88. after_change_password
  89. after_close_account
  90. after_create_account
  91. after_login
  92. after_login_entered_during_multi_phase_login
  93. after_login_failure
  94. after_logout
  95. after_otp_disable
  96. after_refresh_token
  97. after_reset_password
  98. after_sms_disable
  99. after_webauthn_remove
  100. allow_email_auth?
  101. allow_resending_verify_account_email?
  102. already_logged_in
  103. argon2_hash_algorithm?
  104. argon2_hash_cost
  105. argon2_password_hash_match?
  106. argon2_password_hash_using_salt_and_secret
  107. argon2_salt_option
  108. audit_log_ds
  109. audit_log_insert_hash
  110. audit_log_message
  111. audit_log_message_default
  112. audit_log_metadata
  113. auth_class_eval
  114. authenticated?
  115. authenticated_by
  116. authenticated_webauthn_id
  117. auto_add_missing_recovery_codes
  118. auto_remove_recovery_codes
  119. autocomplete_for_field?
  120. autologin_session
  121. autologin_type
  122. base32_encode
  123. base_url
  124. before_change_login_route
  125. before_change_password_route
  126. before_create_account_route
  127. before_login_attempt
  128. before_logout
  129. before_otp_setup_route
  130. before_reset_password
  131. before_reset_password_request
  132. before_rodauth
  133. before_two_factor_auth_route
  134. before_two_factor_manage_route
  135. before_unlock_account
  136. before_unlock_account_request
  137. before_verify_account
  138. before_verify_account_route
  139. before_view_recovery_codes
  140. before_webauthn_auth_route
  141. before_webauthn_login_route
  142. before_webauthn_remove_route
  143. before_webauthn_setup_route
  144. button
  145. button_opts
  146. can_add_recovery_codes?
  147. catch_error
  148. change_login
  149. change_login_notice_flash
  150. change_login_requires_password?
  151. change_password_requires_password?
  152. check_account_expiration
  153. check_active_session
  154. check_already_logged_in
  155. check_csrf
  156. check_csrf?
  157. check_password_change_allowed
  158. check_session_expiration
  159. check_single_session
  160. clear_cached_otp
  161. clear_invalid_login_attempts
  162. clear_session
  163. close_account
  164. close_account_requires_password?
  165. compute_hmac
  166. compute_hmacs
  167. compute_old_hmac
  168. compute_raw_hmac
  169. compute_raw_hmac_with_secret
  170. confirm_password
  171. confirm_password_redirect
  172. convert_email_token_key
  173. convert_session_key
  174. convert_timestamp
  175. convert_token_id
  176. convert_token_id_to_integer
  177. convert_token_key
  178. create_account_autologin?
  179. create_account_notice_flash
  180. create_account_set_password?
  181. create_email
  182. create_email_auth_key
  183. create_email_to
  184. create_reset_password_key
  185. create_verify_account_key
  186. create_verify_login_change_email
  187. create_verify_login_change_key
  188. csrf_tag
  189. currently_active_session?
  190. database_function_password_match?
  191. db
  192. delete_account
  193. delete_account_on_close?
  194. disable_remember_login
  195. domain
  196. email_auth_ds
  197. email_auth_email_link
  198. email_auth_email_recently_sent?
  199. email_auth_key_insert_hash
  200. email_auth_request_form
  201. email_from
  202. email_to
  203. expire_session
  204. extend_remember_deadline
  205. extend_remember_deadline_while_logged_in?
  206. extract_password_hash_cost
  207. features
  208. field_attributes
  209. field_error
  210. field_error_attributes
  211. flash
  212. forget_login
  213. formatted_field_error
  214. function_name
  215. generate_active_sessions_key
  216. generate_email_auth_key_value
  217. generate_refresh_token
  218. generate_remember_key_value
  219. generate_reset_password_key_value
  220. generate_unlock_account_key
  221. generate_verify_account_key_value
  222. generate_verify_login_change_key_value
  223. get_active_refresh_token
  224. get_activity_timestamp
  225. get_email_auth_email_last_sent
  226. get_email_auth_key
  227. get_password_changed_at
  228. get_password_hash
  229. get_password_reset_key
  230. get_remember_key
  231. get_reset_password_email_last_sent
  232. get_unlock_account_email_last_sent
  233. get_unlock_account_key
  234. get_verify_account_email_last_sent
  235. get_verify_account_key
  236. get_verify_login_change_login_and_key
  237. handle_duplicate_active_session_id
  238. handle_webauthn_sign_count_verification_error
  239. has_password?
  240. hmac_secret_rotation?
  241. hook_action
  242. http_basic_auth
  243. inactive_session_cond
  244. include_success_messages?
  245. input_field_string
  246. inputmode_for_field?
  247. internal_request?
  248. internal_request_configuration
  249. invalid_login_attempted
  250. invalid_previous_password_message
  251. json_request?
  252. json_response
  253. json_response_error?
  254. jwt_cors_allow?
  255. jwt_payload
  256. jwt_refresh_token_account_ds
  257. jwt_refresh_token_account_token_ds
  258. jwt_refresh_token_ds
  259. jwt_refresh_token_insert_hash
  260. jwt_refresh_token_match?
  261. jwt_secret
  262. jwt_session_hash
  263. jwt_token
  264. last_account_activity_at
  265. last_account_login_at
  266. load_memory
  267. loaded_templates
  268. locked_out?
  269. logged_in_via_remember_key?
  270. login
  271. login_confirm_label
  272. login_does_not_meet_requirements_message
  273. login_failed_reset_password_request_form
  274. login_field_autocomplete_value
  275. login_form_footer_links
  276. login_hidden_field
  277. login_input_type
  278. login_meets_email_requirements?
  279. login_meets_length_requirements?
  280. login_meets_requirements?
  281. login_required
  282. login_return_to_requested_location_path
  283. login_session
  284. login_too_long_message
  285. login_too_many_bytes_message
  286. login_too_short_message
  287. login_uses_email?
  288. login_valid_email?
  289. logout
  290. logout_additional_form_tags
  291. modifications_require_password?
  292. new_account
  293. new_recovery_code
  294. new_webauthn_credential
  295. no_longer_active_session
  296. normalize_session_or_flash_key
  297. null_byte_parameter_value
  298. only_json?
  299. open_account?
  300. otp_add_key
  301. otp_available?
  302. otp_exists?
  303. otp_hmac_old_secret
  304. otp_hmac_secret
  305. otp_issuer
  306. otp_key_ds
  307. otp_keys_use_hmac?
  308. otp_last_use
  309. otp_locked_out?
  310. otp_new_secret
  311. otp_provisioning_name
  312. otp_provisioning_uri
  313. otp_qr_code
  314. otp_record_authentication_failure
  315. otp_remove
  316. otp_remove_auth_failures
  317. otp_tmp_key
  318. otp_update_last_use
  319. otp_user_key
  320. otp_valid_code?
  321. otp_valid_key?
  322. over_max_bytesize_param_value
  323. param
  324. param_or_nil
  325. password_confirm_label
  326. password_does_not_contain_null_byte?
  327. password_does_not_meet_requirements_message
  328. password_doesnt_match_previous_password?
  329. password_expiration_ds
  330. password_expired?
  331. password_field_autocomplete_value
  332. password_has_enough_character_groups?
  333. password_has_no_invalid_pattern?
  334. password_hash
  335. password_hash_cost
  336. password_hash_ds
  337. password_hash_match?
  338. password_hash_using_salt
  339. password_match?
  340. password_meets_length_requirements?
  341. password_meets_requirements?
  342. password_not_in_dictionary?
  343. password_not_one_of_the_most_common?
  344. password_not_too_many_repeating_characters?
  345. password_one_of_most_common?
  346. password_recently_entered?
  347. password_reset_ds
  348. password_too_long_message
  349. password_too_many_bytes_message
  350. password_too_short_message
  351. possible_authentication_methods
  352. post_configure
  353. previous_password_ds
  354. raises_uniqueness_violation?
  355. random_key
  356. raw_param
  357. recovery_code_match?
  358. recovery_codes_available?
  359. recovery_codes_ds
  360. recovery_codes_primary?
  361. recovery_codes_remove
  362. redirect
  363. remember_key_ds
  364. remember_login
  365. remembered_session_id
  366. remove_active_session
  367. remove_all_active_sessions
  368. remove_all_webauthn_keys_and_user_ids
  369. remove_current_session
  370. remove_email_auth_key
  371. remove_inactive_sessions
  372. remove_jwt_refresh_token_key
  373. remove_lockout_metadata
  374. remove_remember_key
  375. remove_reset_password_key
  376. remove_session_value
  377. remove_verify_account_key
  378. remove_verify_login_change_key
  379. remove_webauthn_key
  380. render
  381. render_multi_phase_login_forms
  382. request
  383. require_account
  384. require_account_session
  385. require_authentication
  386. require_current_password
  387. require_http_basic_auth
  388. require_login
  389. require_login_confirmation?
  390. require_otp_setup
  391. require_password_authentication
  392. require_password_authentication?
  393. require_response
  394. require_sms_available
  395. require_sms_not_setup
  396. require_sms_setup
  397. require_two_factor_authenticated
  398. require_two_factor_not_authenticated
  399. require_two_factor_setup
  400. require_webauthn_setup
  401. rescue_jwt_payload
  402. reset_password_email_link
  403. reset_password_email_recently_sent?
  404. reset_password_key_insert_hash
  405. reset_single_session_key
  406. response
  407. retry_on_uniqueness_violation
  408. return_json_response
  409. return_response
  410. route!
  411. route_path
  412. route_url
  413. save_account
  414. send_email
  415. send_verify_login_change_email
  416. serialize_audit_log_metadata
  417. session
  418. session_inactivity_deadline_condition
  419. session_jwt
  420. session_lifetime_deadline_condition
  421. session_value
  422. set_deadline_value
  423. set_deadline_values?
  424. set_email_auth_email_last_sent
  425. set_error_flash
  426. set_error_reason
  427. set_expired
  428. set_field_error
  429. set_http_basic_auth_error_response
  430. set_jwt
  431. set_jwt_refresh_token_hmac_session_key
  432. set_jwt_token
  433. set_last_password_entry
  434. set_login_requirement_error_message
  435. set_new_account_password
  436. set_notice_flash
  437. set_notice_now_flash
  438. set_password
  439. set_password_requirement_error_message
  440. set_redirect_error_flash
  441. set_redirect_error_status
  442. set_remember_cookie
  443. set_reset_password_email_last_sent
  444. set_response_error_reason_status
  445. set_response_error_status
  446. set_session_value
  447. set_single_session_key
  448. set_title
  449. set_unlock_account_email_last_sent
  450. set_verify_account_email_last_sent
  451. setup_account_verification
  452. show_lockout_page
  453. single_session_ds
  454. skip_login_field_on_login?
  455. skip_password_field_on_login?
  456. skip_status_checks?
  457. sms_auth_message
  458. sms_available?
  459. sms_code
  460. sms_code_issued_at
  461. sms_code_match?
  462. sms_codes_primary?
  463. sms_confirm
  464. sms_confirm_failure
  465. sms_confirm_message
  466. sms_confirmation_match?
  467. sms_current_auth?
  468. sms_disable
  469. sms_ds
  470. sms_failures
  471. sms_locked_out?
  472. sms_needs_confirmation?
  473. sms_needs_confirmation_notice_flash
  474. sms_new_auth_code
  475. sms_new_confirm_code
  476. sms_normalize_phone
  477. sms_phone
  478. sms_record_failure
  479. sms_remove_expired_confirm_code
  480. sms_remove_failures
  481. sms_send
  482. sms_send_auth_code
  483. sms_send_confirm_code
  484. sms_set_code
  485. sms_setup
  486. sms_setup?
  487. sms_valid_phone?
  488. split_token
  489. template_path
  490. throw_basic_auth_error
  491. throw_error
  492. throw_error_reason
  493. throw_error_status
  494. timing_safe_eql?
  495. token_link
  496. token_param_value
  497. transaction
  498. translate
  499. two_factor_auth_links
  500. two_factor_authenticate
  501. two_factor_authenticated?
  502. two_factor_authentication_setup?
  503. two_factor_login_type_match?
  504. two_factor_modifications_require_password?
  505. two_factor_password_match?
  506. two_factor_remove
  507. two_factor_remove_auth_failures
  508. two_factor_remove_links
  509. two_factor_remove_session
  510. two_factor_setup_links
  511. two_factor_update_session
  512. unique_constraint_violation_class
  513. unlock_account
  514. unlock_account_email_link
  515. unlock_account_email_recently_sent?
  516. unverified_grace_period_expired?
  517. update_account
  518. update_activity
  519. update_current_session?
  520. update_hash_ds
  521. update_last_activity
  522. update_last_login
  523. update_login
  524. update_password_changed_at
  525. update_password_hash?
  526. update_session
  527. update_single_session_key
  528. update_sms
  529. use_database_authentication_functions?
  530. use_date_arithmetic?
  531. use_json?
  532. use_jwt?
  533. use_multi_phase_login?
  534. use_request_specific_csrf_tokens?
  535. uses_two_factor_authentication?
  536. valid_jwt?
  537. valid_login_entered?
  538. valid_new_webauthn_credential?
  539. valid_webauthn_credential_auth?
  540. verified_account?
  541. verify_account
  542. verify_account_check_already_logged_in
  543. verify_account_ds
  544. verify_account_email_link
  545. verify_account_email_recently_sent?
  546. verify_account_email_resend
  547. verify_account_key_insert_hash
  548. verify_account_set_password?
  549. verify_account_view
  550. verify_login_change
  551. verify_login_change_ds
  552. verify_login_change_email_body
  553. verify_login_change_email_link
  554. verify_login_change_key_insert_hash
  555. verify_login_change_old_login
  556. view
  557. webauthn_account_id
  558. webauthn_allow
  559. webauthn_auth_additional_form_tags
  560. webauthn_auth_credential_from_form_submission
  561. webauthn_auth_data
  562. webauthn_auth_form_path
  563. webauthn_authenticator_selection
  564. webauthn_credential_options_for_get
  565. webauthn_extensions
  566. webauthn_key_insert_hash
  567. webauthn_keys_ds
  568. webauthn_login_options?
  569. webauthn_login_verification_factor?
  570. webauthn_origin
  571. webauthn_remove_authenticated_session
  572. webauthn_rp_id
  573. webauthn_rp_name
  574. webauthn_setup?
  575. webauthn_setup_credential_from_form_submission
  576. webauthn_setup_data
  577. webauthn_update_session
  578. webauthn_user_ids_ds
  579. webauthn_user_name
  580. webauthn_user_verification

Constants

FEATURES = {}  
INVALID_DOMAIN = "invalidurl @@.com"  
MAJOR = 2  

The major version of Rodauth, updated only for major changes that are likely to require modification to apps using Rodauth.

MINOR = 33  

The minor version of Rodauth, updated for new feature releases of Rodauth.

TINY = 0  

The patch version of Rodauth, updated only for bug fixes from the last feature release.

VERSION = "#{MAJOR}.#{MINOR}.#{TINY}".freeze  

The full version of Rodauth as a string

VERSION_NUMBER = MAJOR*10000 + MINOR*100 + TINY  

The full version of Rodauth as a number (1.17.0 => 11700)

Public Instance Aliases

account_session_value -> account_id
ignore_uniqueness_violation -> raises_uniqueness_violation?

If you just want to ignore uniqueness violations, this alias makes more sense.

logged_in? -> session_value
raised_uniqueness_violation -> raises_uniqueness_violation?

If you would like to operate/reraise the exception, this alias makes more sense.

Public Class methods

configure(app, opts={}, &block)
[show source]
   # File lib/rodauth.rb
46 def self.configure(app, opts={}, &block)
47   json_opt = app.opts[:rodauth_json] = opts.fetch(:json, app.opts[:rodauth_json])
48   csrf = app.opts[:rodauth_csrf] = opts.fetch(:csrf, app.opts[:rodauth_csrf])
49   app.opts[:rodauth_route_csrf] = case csrf
50   when false, :rack_csrf
51     false
52   else
53     json_opt != :only
54   end
55   auth_class = (app.opts[:rodauths] ||= {})[opts[:name]] ||= opts[:auth_class] || Class.new(Auth)
56   if !auth_class.roda_class
57     auth_class.roda_class = app
58   elsif auth_class.roda_class != app
59     auth_class = app.opts[:rodauths][opts[:name]] = Class.new(auth_class)
60     auth_class.roda_class = app
61   end
62   auth_class.class_eval{@configuration_name = opts[:name] unless defined?(@configuration_name)}
63   auth_class.configure(&block) if block
64   auth_class.allocate.post_configure if auth_class.method_defined?(:post_configure)
65 end
create_database_authentication_functions(db, opts={})
[show source]
    # File lib/rodauth/migrations.rb
  4   def self.create_database_authentication_functions(db, opts={})
  5     table_name = opts[:table_name] || :account_password_hashes
  6     get_salt_name = opts[:get_salt_name] || :rodauth_get_salt
  7     valid_hash_name = opts[:valid_hash_name] || :rodauth_valid_password_hash
  8     argon2 = opts[:argon2]
  9 
 10     case db.database_type
 11     when :postgres
 12       search_path = opts[:search_path] || 'public, pg_temp'
 13       primary_key_type =
 14         case db.schema(table_name).find { |row| row.first == :id }[1][:db_type]
 15         when 'uuid' then :uuid
 16         else :int8
 17         end
 18       table_name = db.literal(table_name) unless table_name.is_a?(String)
 19 
 20       argon_sql = <<END
 21 CASE
 22     WHEN password_hash ~ '^\\$argon2id'
 23       THEN substring(password_hash from '\\$argon2id\\$v=\\d+\\$m=\\d+,t=\\d+,p=\\d+\\$.+\\$')
 24     ELSE substr(password_hash, 0, 30)
 25   END INTO salt
 26 END
 27       db.run <<END
 28 CREATE OR REPLACE FUNCTION #{get_salt_name}(acct_id #{primary_key_type}) RETURNS text AS $$
 29 DECLARE salt text;
 30 BEGIN
 31 SELECT
 32 #{argon2 ? argon_sql : "substr(password_hash, 0, 30) INTO salt"}
 33 FROM #{table_name}
 34 WHERE acct_id = id;
 35 RETURN salt;
 36 END;
 37 $$ LANGUAGE plpgsql
 38 SECURITY DEFINER
 39 SET search_path = #{search_path};
 40 END
 41 
 42       db.run <<END
 43 CREATE OR REPLACE FUNCTION #{valid_hash_name}(acct_id #{primary_key_type}, hash text) RETURNS boolean AS $$
 44 DECLARE valid boolean;
 45 BEGIN
 46 SELECT password_hash = hash INTO valid 
 47 FROM #{table_name}
 48 WHERE acct_id = id;
 49 RETURN valid;
 50 END;
 51 $$ LANGUAGE plpgsql
 52 SECURITY DEFINER
 53 SET search_path = #{search_path};
 54 END
 55     when :mysql
 56       argon_sql = <<END
 57 CASE
 58   WHEN password_hash REGEXP '^.argon2id'
 59     THEN left(password_hash, CHAR_LENGTH(password_hash) - INSTR(REVERSE(password_hash), '$'))
 60   ELSE substr(password_hash, 1, 30)
 61   END
 62 END
 63       db.run <<END
 64 CREATE FUNCTION #{get_salt_name}(acct_id int8) RETURNS varchar(255)
 65 SQL SECURITY DEFINER
 66 READS SQL DATA
 67 BEGIN
 68 RETURN (SELECT
 69 #{argon2 ? argon_sql : "substr(password_hash, 1, 30)"}
 70 FROM #{table_name}
 71 WHERE acct_id = id);
 72 END;
 73 END
 74 
 75       db.run <<END
 76 CREATE FUNCTION #{valid_hash_name}(acct_id int8, hash varchar(255)) RETURNS tinyint(1)
 77 SQL SECURITY DEFINER
 78 READS SQL DATA
 79 BEGIN
 80 DECLARE valid tinyint(1);
 81 DECLARE csr CURSOR FOR 
 82 SELECT password_hash = hash
 83 FROM #{table_name}
 84 WHERE acct_id = id;
 85 OPEN csr;
 86 FETCH csr INTO valid;
 87 CLOSE csr;
 88 RETURN valid;
 89 END;
 90 END
 91     when :mssql
 92       argon_sql = <<END
 93 CASE
 94   WHEN password_hash LIKE '[$]argon2id%'
 95     THEN left(password_hash, len(password_hash) - charindex('$', reverse(password_hash)))
 96   ELSE substring(password_hash, 0, 30)
 97   END
 98 END
 99       db.run <<END
100 CREATE FUNCTION #{get_salt_name}(@account_id bigint) RETURNS nvarchar(255)
101 WITH EXECUTE AS OWNER
102 AS
103 BEGIN
104 DECLARE @salt nvarchar(255);
105 SELECT @salt =
106 #{argon2 ? argon_sql : "substring(password_hash, 0, 30)"}
107 FROM #{table_name}
108 WHERE id = @account_id;
109 RETURN @salt;
110 END;
111 END
112 
113       db.run <<END
114 CREATE FUNCTION #{valid_hash_name}(@account_id bigint, @hash nvarchar(255)) RETURNS bit
115 WITH EXECUTE AS OWNER
116 AS
117 BEGIN
118 DECLARE @valid bit;
119 DECLARE @ph nvarchar(255);
120 SELECT @ph = password_hash
121 FROM #{table_name}
122 WHERE id = @account_id;
123 IF(@hash = @ph)
124   SET @valid = 1;
125 ELSE
126   SET @valid = 0
127 RETURN @valid;
128 END;
129 END
130     end
131   end
create_database_previous_password_check_functions(db, opts={})
[show source]
    # File lib/rodauth/migrations.rb
153 def self.create_database_previous_password_check_functions(db, opts={})
154   create_database_authentication_functions(db, {:table_name=>:account_previous_password_hashes, :get_salt_name=>:rodauth_get_previous_salt, :valid_hash_name=>:rodauth_previous_password_hash_match}.merge(opts))
155 end
drop_database_authentication_functions(db, opts={})
[show source]
    # File lib/rodauth/migrations.rb
133 def self.drop_database_authentication_functions(db, opts={})
134   table_name = opts[:table_name] || :account_password_hashes
135   get_salt_name = opts[:get_salt_name] || :rodauth_get_salt
136   valid_hash_name = opts[:valid_hash_name] || :rodauth_valid_password_hash
137 
138   case db.database_type
139   when :postgres
140     primary_key_type =
141       case db.schema(table_name).find { |row| row.first == :id }[1][:db_type]
142       when 'uuid' then :uuid
143       else :int8
144       end
145     db.run "DROP FUNCTION #{get_salt_name}(#{primary_key_type})"
146     db.run "DROP FUNCTION #{valid_hash_name}(#{primary_key_type}, text)"
147   when :mysql, :mssql
148     db.run "DROP FUNCTION #{get_salt_name}"
149     db.run "DROP FUNCTION #{valid_hash_name}"
150   end
151 end
drop_database_previous_password_check_functions(db, opts={})
[show source]
    # File lib/rodauth/migrations.rb
157 def self.drop_database_previous_password_check_functions(db, opts={})
158   drop_database_authentication_functions(db, {:table_name=>:account_previous_password_hashes, :get_salt_name=>:rodauth_get_previous_salt, :valid_hash_name=>:rodauth_previous_password_hash_match}.merge(opts))
159 end
lib(opts={}, &block)
[show source]
   # File lib/rodauth.rb
 6 def self.lib(opts={}, &block) 
 7   require 'roda'
 8   c = Class.new(Roda)
 9   c.plugin(:rodauth, opts) do
10     enable :internal_request
11     instance_exec(&block)
12   end
13   c.freeze
14   c.rodauth
15 end
load_dependencies(app, opts={})
[show source]
   # File lib/rodauth.rb
17 def self.load_dependencies(app, opts={})
18   json_opt = opts.fetch(:json, app.opts[:rodauth_json])
19   if json_opt
20     app.plugin :json
21     app.plugin :json_parser
22   end
23 
24   unless json_opt == :only
25     unless opts[:render] == false
26       require 'tilt/string'
27       app.plugin :render
28     end
29 
30     case opts.fetch(:csrf, app.opts[:rodauth_csrf])
31     when false
32       # nothing
33     when :rack_csrf
34       # :nocov:
35       app.plugin :csrf
36       # :nocov:
37     else
38       app.plugin :route_csrf
39     end
40 
41     app.plugin :flash unless opts[:flash] == false
42     app.plugin :h
43   end
44 end
new(scope)
[show source]
    # File lib/rodauth/features/base.rb
140 def initialize(scope)
141   @scope = scope
142 end
version()
[show source]
   # File lib/rodauth/version.rb
21 def self.version
22   VERSION
23 end

Public Instance methods

_account_from_email_auth_key(token)
[show source]
    # 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
_account_from_login(login)
[show source]
    # File lib/rodauth/features/base.rb
724 def _account_from_login(login)
725   ds = account_table_ds.where(login_column=>login)
726   ds = ds.select(*account_select) if account_select
727   ds = ds.where(account_status_column=>[account_unverified_status_value, account_open_status_value]) unless skip_status_checks?
728   ds.first
729 end
_account_from_refresh_token(token)
[show source]
    # 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)) || (hmac_secret_rotation? && timing_safe_eql?(key, compute_old_hmac(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
_account_from_reset_password_key(token)
[show source]
    # File lib/rodauth/features/reset_password.rb
253 def _account_from_reset_password_key(token)
254   account_from_key(token, account_open_status_value){|id| get_password_reset_key(id)}
255 end
_account_from_session()
[show source]
    # File lib/rodauth/features/base.rb
731 def _account_from_session
732   ds = account_ds(session_value)
733   ds = ds.where(account_session_status_filter) unless skip_status_checks?
734   ds.first
735 end
_account_from_unlock_key(token)
[show source]
    # File lib/rodauth/features/lockout.rb
297 def _account_from_unlock_key(token)
298   account_from_key(token){|id| account_lockouts_ds(id).get(account_lockouts_key_column)}
299 end
_account_from_verify_account_key(token)
[show source]
    # File lib/rodauth/features/verify_account.rb
302 def _account_from_verify_account_key(token)
303   account_from_key(token, account_unverified_status_value){|id| get_verify_account_key(id)}
304 end
_account_from_verify_login_change_key(token)
[show source]
    # 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
_account_refresh_token_split(token)
[show source]
    # 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
_around_rodauth()
[show source]
    # File lib/rodauth/features/base.rb
530 def _around_rodauth
531   yield
532 end
_email_auth_request()
[show source]
    # File lib/rodauth/features/email_auth.rb
178 def _email_auth_request
179   if email_auth_email_recently_sent?
180     set_redirect_error_flash email_auth_email_recently_sent_error_flash
181     redirect email_auth_email_recently_sent_redirect
182   end
183 
184   generate_email_auth_key_value
185   transaction do
186     before_email_auth_request
187     create_email_auth_key
188     send_email_auth_email
189     after_email_auth_request
190   end
191 
192   email_auth_email_sent_response
193 end
_field_attributes(field)
[show source]
    # File lib/rodauth/features/base.rb
750 def _field_attributes(field)
751   nil
752 end
_field_error_attributes(field)
[show source]
    # File lib/rodauth/features/base.rb
754 def _field_error_attributes(field)
755   " aria-invalid=\"true\" aria-describedby=\"#{field}_error_message\" "
756 end
_formatted_field_error(field, error)
[show source]
    # File lib/rodauth/features/base.rb
758 def _formatted_field_error(field, error)
759   "<span class=\"#{input_field_error_message_class}\" id=\"#{field}_error_message\">#{error}</span>"
760 end
_json_response_body(hash)
[show source]
    # File lib/rodauth/features/json.rb
189 def _json_response_body(hash)
190   request.send(:convert_to_json, hash)
191 end
_jwt_decode_opts()
[show source]
    # File lib/rodauth/features/jwt.rb
112 def _jwt_decode_opts
113   jwt_decode_opts
114 end
_jwt_decode_secrets()
[show source]
    # File lib/rodauth/features/jwt.rb
117 def _jwt_decode_secrets
118   secrets = [jwt_secret, jwt_old_secret]
119   secrets.compact!
120   secrets
121 end
_login(auth_type)
[show source]
    # File lib/rodauth/features/login.rb
163 def _login(auth_type)
164   warn("Deprecated #_login method called, use #login instead.")
165   login(auth_type)
166 end
_login_response()
[show source]
    # File lib/rodauth/features/login.rb
143 def _login_response
144   set_notice_flash login_notice_flash
145   redirect(saved_login_redirect || login_redirect)
146 end
_multi_phase_login_forms()
[show source]
    # File lib/rodauth/features/email_auth.rb
168 def _multi_phase_login_forms
169   forms = super
170   forms << [30, email_auth_request_form, :_email_auth_request] if valid_login_entered? && allow_email_auth?
171   forms
172 end
_new_account(login)
[show source]
    # 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
_otp()
[show source]
    # File lib/rodauth/features/otp.rb
442 def _otp
443   _otp_for_key(otp_user_key)
444 end
_otp_add_key(secret)
[show source]
    # File lib/rodauth/features/otp.rb
427 def _otp_add_key(secret)
428   # Uniqueness errors can't be handled here, as we can't be sure the secret provided
429   # is the same as the current secret.
430   otp_key_ds.insert(otp_keys_id_column=>session_value, otp_keys_column=>secret)
431 end
_otp_for_key(key)
[show source]
    # File lib/rodauth/features/otp.rb
438 def _otp_for_key(key)
439   otp_class.new(key, :issuer=>otp_issuer, :digits=>otp_digits, :interval=>otp_interval)
440 end
_otp_key()
[show source]
    # File lib/rodauth/features/otp.rb
433 def _otp_key
434   @otp_user_key = nil
435   otp_key_ds.get(otp_keys_column)
436 end
_otp_tmp_key(secret)
[show source]
    # 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
_otp_valid_code?(ot_pass, otp)
[show source]
    # 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
_otp_valid_code_for_old_secret()

Called for valid OTP codes for old secrets

[show source]
    # File lib/rodauth/features/otp.rb
424 def _otp_valid_code_for_old_secret
425 end
_process_raw_hmac(hmac)
[show source]
    # File lib/rodauth/features/base.rb
534 def _process_raw_hmac(hmac)
535   s = [hmac].pack('m')
536   s.chomp!("=\n")
537   s.tr!('+/', '-_')
538   s
539 end
_recovery_codes()
[show source]
    # File lib/rodauth/features/recovery_codes.rb
260 def _recovery_codes
261   recovery_codes_ds.select_map(recovery_codes_column)
262 end
_return_json_response()
[show source]
    # File lib/rodauth/features/json.rb
179 def _return_json_response
180   response.status ||= json_response_error_status if json_response_error?
181   response['Content-Type'] ||= json_response_content_type
182   return_response _json_response_body(json_response)
183 end
_setup_account_lockouts_hash(account_id, key)
[show source]
    # File lib/rodauth/features/lockout.rb
169 def _setup_account_lockouts_hash(account_id, key)
170   hash = {account_lockouts_id_column=>account_id, account_lockouts_key_column=>key}
171   set_deadline_value(hash, account_lockouts_deadline_column, account_lockouts_deadline_interval)
172   hash
173 end
_sms()
[show source]
    # File lib/rodauth/features/sms_codes.rb
524 def _sms
525   sms_ds.first
526 end
_sms_request_response()
[show source]
    # 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
_template_opts(opts, page)

Set the template path only if there isn’t an overridden template in the application. Result should replace existing template opts.

[show source]
    # File lib/rodauth/features/base.rb
893 def _template_opts(opts, page)
894   opts = scope.send(:find_template, scope.send(:parse_template_opts, page, opts))
895   unless File.file?(scope.send(:template_path, opts))
896     opts[:path] = template_path(page)
897   end
898   opts
899 end
_two_factor_auth_response()
[show source]
    # File lib/rodauth/features/two_factor_base.rb
255 def _two_factor_auth_response
256   saved_two_factor_auth_redirect = remove_session_value(two_factor_auth_redirect_session_key)
257   set_notice_flash two_factor_auth_notice_flash
258   redirect(saved_two_factor_auth_redirect || two_factor_auth_redirect)
259 end
_two_factor_remove_all_from_session()
[show source]
    # File lib/rodauth/features/otp.rb
365 def _two_factor_remove_all_from_session
366   two_factor_remove_session('totp')
367   super
368 end
_update_login(login)
[show source]
   # 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
_view(meth, page)
[show source]
    # File lib/rodauth/features/base.rb
901 def _view(meth, page)
902   scope.send(meth, _view_opts(page))
903 end
_view_opts(page)
[show source]
    # File lib/rodauth/features/base.rb
882 def _view_opts(page)
883   opts = template_opts.dup
884   opts[:locals] = opts[:locals] ? opts[:locals].dup : {}
885   opts[:locals][:rodauth] = self
886   opts[:cache] = cache_templates
887   opts[:cache_key] = :"rodauth_#{page}"
888   _template_opts(opts, page)
889 end
account!()
[show source]
    # File lib/rodauth/features/base.rb
378 def account!
379   account || (session_value && account_from_session)
380 end
account_activity_ds(account_id)
[show source]
    # 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
account_ds(id=account_id)
[show source]
    # File lib/rodauth/features/base.rb
770 def account_ds(id=account_id)
771   raise ArgumentError, "invalid account id passed to account_ds" unless id
772   ds = account_table_ds.where(account_id_column=>id)
773   ds = ds.select(*account_select) if account_select
774   ds
775 end
account_expired?()
[show source]
   # 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
account_expired_at()
[show source]
   # File lib/rodauth/features/account_expiration.rb
35 def account_expired_at
36   get_activity_timestamp(account_id, account_activity_expired_column)
37 end
account_from_email_auth_key(key)
[show source]
    # 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
account_from_key(token, status_id=nil)
[show source]
   # 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   ds = account_ds(id)
78   ds = ds.where(account_status_column=>status_id) if status_id && !skip_status_checks?
79   ds.first
80 end
account_from_login(login)
[show source]
    # File lib/rodauth/features/base.rb
276 def account_from_login(login)
277   @account = _account_from_login(login)
278 end
account_from_refresh_token(token)
[show source]
   # File lib/rodauth/features/jwt_refresh.rb
88 def account_from_refresh_token(token)
89   @account = _account_from_refresh_token(token)
90 end
account_from_reset_password_key(key)
[show source]
   # 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
account_from_session()
[show source]
    # File lib/rodauth/features/base.rb
382 def account_from_session
383   @account = _account_from_session
384 end
account_from_unlock_key(key)
[show source]
    # File lib/rodauth/features/lockout.rb
220 def account_from_unlock_key(key)
221   @account = _account_from_unlock_key(key)
222 end
account_from_verify_account_key(key)
[show source]
    # 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
account_from_verify_login_change_key(key)
[show source]
    # 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
account_from_webauthn_login()
[show source]
   # File lib/rodauth/features/webauthn_autofill.rb
44 def account_from_webauthn_login
45   return super if param_or_nil(login_param)
46 
47   credential_id = webauthn_auth_data["id"]
48   account_id = db[webauthn_keys_table]
49     .where(webauthn_keys_webauthn_id_column => credential_id)
50     .get(webauthn_keys_account_id_column)
51 
52   unless account_id
53     throw_error_reason(:invalid_webauthn_id, invalid_field_error_status, webauthn_auth_param, webauthn_invalid_webauthn_id_message)
54   end
55 
56   @account = account_ds(account_id).first
57 end
account_id()
[show source]
    # File lib/rodauth/features/base.rb
266 def account_id
267   account[account_id_column]
268 end
account_in_unverified_grace_period?()
[show source]
   # 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
account_initial_status_value()
[show source]
    # File lib/rodauth/features/base.rb
374 def account_initial_status_value
375   account_open_status_value
376 end
account_lockouts_ds(id=account_id)
[show source]
    # File lib/rodauth/features/lockout.rb
293 def account_lockouts_ds(id=account_id)
294   db[account_lockouts_table].where(account_lockouts_id_column=>id)
295 end
account_login_failures_ds()
[show source]
    # File lib/rodauth/features/lockout.rb
289 def account_login_failures_ds
290   db[account_login_failures_table].where(account_login_failures_id_column=>account_id)
291 end
account_password_hash_column()

If the account_password_hash_column is set, the password hash is verified in ruby, it will not use a database function to do so, it will check the password hash using bcrypt.

[show source]
    # File lib/rodauth/features/base.rb
300 def account_password_hash_column
301   nil
302 end
account_session_status_filter()
[show source]
    # File lib/rodauth/features/base.rb
762 def account_session_status_filter
763   {account_status_column=>account_open_status_value}
764 end
account_table_ds()
[show source]
    # File lib/rodauth/features/base.rb
777 def account_table_ds
778   db[accounts_table]
779 end
account_webauthn_ids()
[show source]
    # File lib/rodauth/features/webauthn.rb
271 def account_webauthn_ids
272   webauthn_keys_ds.select_map(webauthn_keys_webauthn_id_column)
273 end
account_webauthn_usage()
[show source]
    # 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
account_webauthn_user_id()
[show source]
    # 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
active_remember_key_ds(id=account_id)
[show source]
    # File lib/rodauth/features/remember.rb
259 def active_remember_key_ds(id=account_id)
260   remember_key_ds(id).where(Sequel.expr(remember_deadline_column) > Sequel::CURRENT_TIMESTAMP)
261 end
active_sessions_ds()
[show source]
    # File lib/rodauth/features/active_sessions.rb
185 def active_sessions_ds
186   db[active_sessions_table].
187     where(active_sessions_account_id_column=>session_value)
188 end
active_sessions_insert_hash()
[show source]
    # 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
active_sessions_update_hash()
[show source]
    # File lib/rodauth/features/active_sessions.rb
152 def active_sessions_update_hash
153   h = {active_sessions_last_use_column => Sequel::CURRENT_TIMESTAMP}
154 
155   if hmac_secret_rotation?
156     h[active_sessions_session_id_column] = compute_hmac(session[session_id_session_key])
157   end
158 
159   h
160 end
add_active_session()
[show source]
   # 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
add_audit_log(account_id, action)
[show source]
   # 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
add_field_error_class(field)
[show source]
    # File lib/rodauth/features/base.rb
181 def add_field_error_class(field)
182   if field_error(field)
183     " #{input_field_error_class}"
184   end
185 end
add_previous_password_hash(hash)
[show source]
   # 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
add_recovery_code()
[show source]
    # 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
add_recovery_codes(number)
[show source]
    # 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
add_remember_key()
[show source]
    # 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
add_webauthn_credential(_)
[show source]
    # 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
after_change_password()
[show source]
   # File lib/rodauth/features/change_password_notify.rb
11 def after_change_password
12   super
13   send_password_changed_email
14 end
after_close_account()
[show source]
    # 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
after_create_account()
[show source]
   # 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
after_login()
[show source]
    # File lib/rodauth/features/email_auth.rb
201 def after_login
202   # Remove the email auth key after any login, even if
203   # it is a password login.  This is done to invalidate
204   # the email login when a user has a password and requests
205   # email authentication, but then remembers their password
206   # and doesn't need the link.  At that point, the link
207   # that allows login access to the account becomes a
208   # security liability, and it is best to remove it.
209   remove_email_auth_key
210   super
211 end
after_login_entered_during_multi_phase_login()
[show source]
    # 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
after_login_failure()
[show source]
    # File lib/rodauth/features/lockout.rb
256 def after_login_failure
257   invalid_login_attempted
258   super
259 end
after_logout()
[show source]
    # File lib/rodauth/features/remember.rb
235 def after_logout
236   forget_login
237   super if defined?(super)
238 end
after_otp_disable()
[show source]
    # File lib/rodauth/features/recovery_codes.rb
225 def after_otp_disable
226   super if defined?(super)
227   auto_remove_recovery_codes
228 end
after_refresh_token()
[show source]
    # 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_hmacs(prev_key)).
123       update(active_sessions_session_id_column => compute_hmac(key))
124   end
125 end
after_reset_password()
[show source]
   # 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
after_sms_disable()
[show source]
    # File lib/rodauth/features/recovery_codes.rb
230 def after_sms_disable
231   super if defined?(super)
232   auto_remove_recovery_codes
233 end
after_webauthn_remove()
[show source]
    # File lib/rodauth/features/recovery_codes.rb
235 def after_webauthn_remove
236   super if defined?(super)
237   auto_remove_recovery_codes
238 end
allow_email_auth?()
[show source]
    # File lib/rodauth/features/email_auth.rb
197 def allow_email_auth?
198   defined?(super) ? super : true
199 end
allow_resending_verify_account_email?()
[show source]
    # 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
already_logged_in()
[show source]
    # File lib/rodauth/features/base.rb
308 def already_logged_in
309   nil
310 end
argon2_hash_algorithm?(hash)

:nocov:

[show source]
    # File lib/rodauth/features/argon2.rb
105 def argon2_hash_algorithm?(hash)
106   hash.start_with?('$argon2id$')
107 end
argon2_hash_cost()
[show source]
   # File lib/rodauth/features/argon2.rb
76 def argon2_hash_cost
77   { t_cost: 1, m_cost: 5, p_cost: 1 }
78 end
argon2_password_hash_match?(hash, password)
[show source]
    # 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
argon2_password_hash_using_salt_and_secret(password, salt, secret)
[show source]
   # 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
argon2_salt_option()
[show source]
   # File lib/rodauth/features/argon2.rb
34 def argon2_salt_option
35   :salt_do_not_supply
36 end
audit_log_ds()
[show source]
   # 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
audit_log_insert_hash(account_id, action)
[show source]
   # 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
audit_log_message(action)
[show source]
   # 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
audit_log_message_default(action)
[show source]
   # File lib/rodauth/features/audit_logging.rb
59 def audit_log_message_default(action)
60   action.to_s
61 end
audit_log_metadata(action)
[show source]
   # 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
auth_class_eval(&block)
[show source]
    # File lib/rodauth/features/base.rb
132 def auth_class_eval(&block)
133   auth.class_eval(&block)
134 end
authenticated?()
[show source]
    # File lib/rodauth/features/base.rb
361 def authenticated?
362   logged_in?
363 end
authenticated_by()
[show source]
    # File lib/rodauth/features/base.rb
460 def authenticated_by
461   session[authenticated_by_session_key]
462 end
authenticated_webauthn_id()
[show source]
    # File lib/rodauth/features/webauthn.rb
251 def authenticated_webauthn_id
252   session[authenticated_webauthn_id_session_key]
253 end
auto_add_missing_recovery_codes()
[show source]
    # 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
auto_remove_recovery_codes()
[show source]
    # 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
autocomplete_for_field?(_param)
[show source]
    # File lib/rodauth/features/base.rb
211 def autocomplete_for_field?(_param)
212   mark_input_fields_with_autocomplete?
213 end
autologin_session(autologin_type)
[show source]
    # File lib/rodauth/features/base.rb
473 def autologin_session(autologin_type)
474   login_session('autologin')
475   set_session_value(autologin_type_session_key, autologin_type)
476 end
autologin_type()
[show source]
    # File lib/rodauth/features/base.rb
469 def autologin_type
470   session[autologin_type_session_key]
471 end
base32_encode(data, length)
[show source]
    # 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
base_url()
[show source]
    # File lib/rodauth/features/base.rb
510 def base_url
511   url = String.new("#{request.scheme}://#{domain}")
512   url << ":#{request.port}" if request.port != Rack::Request::DEFAULT_PORTS[request.scheme]
513   url
514 end
before_change_login_route()
[show source]
   # 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
before_change_password_route()
[show source]
   # File lib/rodauth/features/password_expiration.rb
90 def before_change_password_route
91   check_password_change_allowed
92   super
93 end
before_create_account_route()
[show source]
   # 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
before_login_attempt()
[show source]
    # File lib/rodauth/features/lockout.rb
244 def before_login_attempt
245   if locked_out?
246     show_lockout_page
247   end
248   super
249 end
before_logout()
[show source]
    # 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
before_otp_setup_route()
[show source]
    # File lib/rodauth/features/json.rb
139 def before_otp_setup_route
140   super if defined?(super)
141   if use_json? && otp_keys_use_hmac? && !param_or_nil(otp_setup_raw_param)
142     _otp_tmp_key(otp_new_secret)
143     json_response[otp_setup_param] = otp_user_key
144     json_response[otp_setup_raw_param] = otp_key
145   end
146 end
before_reset_password()
[show source]
   # File lib/rodauth/features/account_expiration.rb
79 def before_reset_password
80   check_account_expiration
81   super if defined?(super)
82 end
before_reset_password_request()
[show source]
   # File lib/rodauth/features/account_expiration.rb
84 def before_reset_password_request
85   check_account_expiration
86   super if defined?(super)
87 end
before_rodauth()
[show source]
    # File lib/rodauth/features/json.rb
148 def before_rodauth
149   if json_request?
150     if json_check_accept? && (accept = request.env['HTTP_ACCEPT']) && accept !~ json_accept_regexp
151       response.status = 406
152       json_response[json_response_error_key] = json_not_accepted_error_message
153       _return_json_response
154     end
155 
156     unless request.post?
157       response.status = 405
158       response.headers['Allow'] = 'POST'
159       json_response[json_response_error_key] = json_non_post_error_message
160       return_json_response
161     end
162   elsif only_json?
163     response.status = json_response_error_status
164     return_response non_json_request_error_message
165   end
166 
167   super
168 end
before_two_factor_auth_route()
[show source]
   # File lib/rodauth/features/json.rb
85 def before_two_factor_auth_route
86   super if defined?(super)
87   if use_json?
88     json_response[:auth_links] = two_factor_auth_links.sort.map{|_,link| link}
89     json_response[json_response_success_key] ||= "" if include_success_messages?
90     return_json_response
91   end
92 end
before_two_factor_manage_route()
[show source]
   # File lib/rodauth/features/json.rb
75 def before_two_factor_manage_route
76   super if defined?(super)
77   if use_json?
78     json_response[:setup_links] = two_factor_setup_links.sort.map{|_,link| link}
79     json_response[:remove_links] = two_factor_remove_links.sort.map{|_,link| link}
80     json_response[json_response_success_key] ||= "" if include_success_messages?
81     return_json_response
82   end
83 end
before_unlock_account()
[show source]
   # File lib/rodauth/features/account_expiration.rb
89 def before_unlock_account
90   check_account_expiration
91   super if defined?(super)
92 end
before_unlock_account_request()
[show source]
   # File lib/rodauth/features/account_expiration.rb
94 def before_unlock_account_request
95   check_account_expiration
96   super if defined?(super)
97 end
before_verify_account()
[show source]
   # 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
before_verify_account_route()
[show source]
   # 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
before_view_recovery_codes()
[show source]
    # File lib/rodauth/features/json.rb
 94 def before_view_recovery_codes
 95   super if defined?(super)
 96   if use_json?
 97     json_response[:codes] = recovery_codes
 98     json_response[json_response_success_key] ||= "" if include_success_messages?
 99   end
100 end
before_webauthn_auth_route()
[show source]
    # File lib/rodauth/features/json.rb
112 def before_webauthn_auth_route
113   super if defined?(super)
114   if use_json? && !param_or_nil(webauthn_auth_param)
115     cred = webauthn_credential_options_for_get
116     json_response[webauthn_auth_param] = cred.as_json
117     json_response[webauthn_auth_challenge_param] = cred.challenge
118     json_response[webauthn_auth_challenge_hmac_param] = compute_hmac(cred.challenge)
119   end
120 end
before_webauthn_login_route()
[show source]
    # File lib/rodauth/features/json.rb
122 def before_webauthn_login_route
123   super if defined?(super)
124   if use_json? && !param_or_nil(webauthn_auth_param) && webauthn_login_options?
125     cred = webauthn_credential_options_for_get
126     json_response[webauthn_auth_param] = cred.as_json
127     json_response[webauthn_auth_challenge_param] = cred.challenge
128     json_response[webauthn_auth_challenge_hmac_param] = compute_hmac(cred.challenge)
129   end
130 end
before_webauthn_remove_route()
[show source]
    # File lib/rodauth/features/json.rb
132 def before_webauthn_remove_route
133   super if defined?(super)
134   if use_json? && !param_or_nil(webauthn_remove_param)
135     json_response[webauthn_remove_param] = account_webauthn_usage
136   end
137 end
before_webauthn_setup_route()
[show source]
    # File lib/rodauth/features/json.rb
102 def before_webauthn_setup_route
103   super if defined?(super)
104   if use_json? && !param_or_nil(webauthn_setup_param)
105     cred = new_webauthn_credential
106     json_response[webauthn_setup_param] = cred.as_json
107     json_response[webauthn_setup_challenge_param] = cred.challenge
108     json_response[webauthn_setup_challenge_hmac_param] = compute_hmac(cred.challenge)
109   end
110 end
button(value, opts={})
[show source]
    # File lib/rodauth/features/base.rb
410 def button(value, opts={})
411   scope.render(button_opts(value, opts))
412 end
button_opts(value, opts)
[show source]
    # File lib/rodauth/features/base.rb
402 def button_opts(value, opts)
403   opts = Hash[template_opts].merge!(opts)
404   opts[:locals] = {:value=>value, :opts=>opts}
405   opts[:cache] = cache_templates
406   opts[:cache_key] = :rodauth_button
407   _template_opts(opts, 'button')
408 end
can_add_recovery_codes?()
[show source]
    # File lib/rodauth/features/recovery_codes.rb
173 def can_add_recovery_codes?
174   recovery_codes.length < recovery_codes_limit
175 end
catch_error(&block)
[show source]
    # File lib/rodauth/features/base.rb
628 def catch_error(&block)
629   catch(:rodauth_error, &block)
630 end
change_login(login)
[show source]
   # 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
change_login_notice_flash()
[show source]
    # File lib/rodauth/features/verify_login_change.rb
136 def change_login_notice_flash
137   change_login_needs_verification_notice_flash
138 end
change_login_requires_password?()
[show source]
   # File lib/rodauth/features/change_login.rb
64 def change_login_requires_password?
65   modifications_require_password?
66 end
change_password_requires_password?()
[show source]
   # File lib/rodauth/features/change_password.rb
68 def change_password_requires_password?
69   modifications_require_password?
70 end
check_account_expiration()
[show source]
   # 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
check_active_session()
[show source]
   # 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
check_already_logged_in()
[show source]
    # File lib/rodauth/features/base.rb
304 def check_already_logged_in
305   already_logged_in if logged_in?
306 end
check_csrf()
[show source]
    # File lib/rodauth/features/base.rb
386 def check_csrf
387   scope.check_csrf!(check_csrf_opts, &check_csrf_block)
388 end
check_csrf?()
[show source]
    # File lib/rodauth/features/base.rb
686 def check_csrf?
687   scope.opts[:rodauth_route_csrf]
688 end
check_password_change_allowed()
[show source]
   # 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
check_session_expiration()
[show source]
   # 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
check_single_session()
[show source]
   # 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
clear_cached_otp()
[show source]
    # File lib/rodauth/features/otp.rb
370 def clear_cached_otp
371   remove_instance_variable(:@otp) if defined?(@otp)
372 end
clear_invalid_login_attempts()
[show source]
    # File lib/rodauth/features/lockout.rb
165 def clear_invalid_login_attempts
166   unlock_account
167 end
clear_session()
[show source]
    # File lib/rodauth/features/base.rb
320 def clear_session
321   if scope.respond_to?(:clear_session)
322     scope.clear_session
323   else
324     session.clear
325   end
326 end
close_account()
[show source]
   # 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
close_account_requires_password?()
[show source]
   # File lib/rodauth/features/close_account.rb
62 def close_account_requires_password?
63   modifications_require_password?
64 end
compute_hmac(data)

Return urlsafe base64 HMAC for data, assumes hmac_secret is set.

[show source]
    # File lib/rodauth/features/base.rb
245 def compute_hmac(data)
246   _process_raw_hmac(compute_raw_hmac(data))
247 end
compute_hmacs(data)

Return array of hmacs. Array has two strings if hmac_old_secret is set, or one string otherwise.

[show source]
    # File lib/rodauth/features/base.rb
256 def compute_hmacs(data)
257   hmacs = [compute_hmac(data)]
258 
259   if hmac_old_secret
260     hmacs << compute_old_hmac(data)
261   end
262 
263   hmacs
264 end
compute_old_hmac(data)

Return urlsafe base64 HMAC for data using hmac_old_secret, assumes hmac_old_secret is set.

[show source]
    # File lib/rodauth/features/base.rb
250 def compute_old_hmac(data)
251   _process_raw_hmac(compute_raw_hmac_with_secret(data, hmac_old_secret))
252 end
compute_raw_hmac(data)
[show source]
    # File lib/rodauth/features/base.rb
741 def compute_raw_hmac(data)
742   raise ArgumentError, "hmac_secret not set" unless hmac_secret
743   compute_raw_hmac_with_secret(data, hmac_secret)
744 end
compute_raw_hmac_with_secret(data, secret)
[show source]
    # File lib/rodauth/features/base.rb
746 def compute_raw_hmac_with_secret(data, secret)
747   OpenSSL::HMAC.digest(OpenSSL::Digest::SHA256.new, secret, data)
748 end
confirm_password()
[show source]
   # 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
confirm_password_redirect()
[show source]
   # 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
convert_email_token_key(key)
[show source]
   # File lib/rodauth/features/email_base.rb
61 def convert_email_token_key(key)
62   convert_token_key(key)
63 end
convert_session_key(key)
[show source]
    # File lib/rodauth/features/base.rb
607 def convert_session_key(key)
608   key = :"#{session_key_prefix}#{key}" if session_key_prefix
609   normalize_session_or_flash_key(key)
610 end
convert_timestamp(timestamp)

This is needed for jdbc/sqlite, which returns timestamp columns as strings

[show source]
    # File lib/rodauth/features/base.rb
786 def convert_timestamp(timestamp)
787   timestamp = db.to_application_timestamp(timestamp) if timestamp.is_a?(String)
788   timestamp
789 end
convert_token_id(id)
[show source]
    # File lib/rodauth/features/base.rb
561 def convert_token_id(id)
562   if convert_token_id_to_integer?
563     convert_token_id_to_integer(id)
564   else
565     id
566   end
567 end
convert_token_id_to_integer(id)
[show source]
    # File lib/rodauth/features/base.rb
569 def convert_token_id_to_integer(id)
570   if id = (Integer(id, 10) rescue nil)
571     if id > 9223372036854775807 || id < -9223372036854775808
572       # Only allow 64-bit signed integer range to avoid problems on PostgreSQL
573       id = nil
574     end
575   end
576 
577   id
578 end
convert_token_key(key)
[show source]
    # File lib/rodauth/features/base.rb
549 def convert_token_key(key)
550   if key && hmac_secret
551     compute_hmac(key)
552   else
553     key
554   end
555 end
create_account_autologin?()
[show source]
    # File lib/rodauth/features/verify_account.rb
216 def create_account_autologin?
217   false
218 end
create_account_notice_flash()
[show source]
    # File lib/rodauth/features/verify_account.rb
183 def create_account_notice_flash
184   verify_account_email_sent_notice_flash
185 end
create_account_set_password?()
[show source]
    # File lib/rodauth/features/verify_account.rb
220 def create_account_set_password?
221   return false if verify_account_set_password?
222   super
223 end
create_email(subject, body)
[show source]
   # File lib/rodauth/features/email_base.rb
40 def create_email(subject, body)
41   create_email_to(email_to, subject, body)
42 end
create_email_auth_key()
[show source]
    # File lib/rodauth/features/email_auth.rb
102 def create_email_auth_key
103   transaction do
104     if email_auth_key_value = get_email_auth_key(account_id)
105       set_email_auth_email_last_sent
106       @email_auth_key_value = email_auth_key_value
107     elsif e = raised_uniqueness_violation{email_auth_ds.insert(email_auth_key_insert_hash)}
108       # If inserting into the email auth table causes a violation, we can pull the
109       # existing email auth key from the table, or reraise.
110       raise e unless @email_auth_key_value = get_email_auth_key(account_id)
111     end
112   end
113 end
create_email_to(to, subject, body)
[show source]
   # 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
create_reset_password_key()
[show source]
    # File lib/rodauth/features/reset_password.rb
164 def create_reset_password_key
165   transaction do
166     if reset_password_key_value = get_password_reset_key(account_id)
167       set_reset_password_email_last_sent
168       @reset_password_key_value = reset_password_key_value
169     elsif e = raised_uniqueness_violation{password_reset_ds.insert(reset_password_key_insert_hash)}
170       # If inserting into the reset password table causes a violation, we can pull the
171       # existing reset password key from the table, or reraise.
172       raise e unless @reset_password_key_value = get_password_reset_key(account_id)
173     end
174   end
175 end
create_verify_account_key()
[show source]
    # File lib/rodauth/features/verify_account.rb
281 def create_verify_account_key
282   ds = verify_account_ds
283   transaction do
284     if ds.empty?
285       if e = raised_uniqueness_violation{ds.insert(verify_account_key_insert_hash)}
286         # If inserting into the verify account table causes a violation, we can pull the
287         # key from the verify account table, or reraise.
288         raise e unless @verify_account_key_value = get_verify_account_key(account_id)
289       end
290     end
291   end
292 end
create_verify_login_change_email(login)
[show source]
    # File lib/rodauth/features/verify_login_change.rb
198 def create_verify_login_change_email(login)
199   create_email_to(login, verify_login_change_email_subject, verify_login_change_email_body)
200 end
create_verify_login_change_key(login)
[show source]
    # File lib/rodauth/features/verify_login_change.rb
176 def create_verify_login_change_key(login)
177   ds = verify_login_change_ds
178   transaction do
179     ds.where((Sequel::CURRENT_TIMESTAMP > verify_login_change_deadline_column) | ~Sequel.expr(verify_login_change_login_column=>login)).delete
180     if e = raised_uniqueness_violation{ds.insert(verify_login_change_key_insert_hash(login))}
181       old_login, key = get_verify_login_change_login_and_key(account_id)
182       # If inserting into the verify login change table causes a violation, we can pull the
183       # key from the verify login change table if the logins match, or reraise.
184       @verify_login_change_key_value = if old_login.downcase == login.downcase
185         key
186       end
187       raise e unless @verify_login_change_key_value
188     end
189   end
190 end
csrf_tag(path=request.path)
[show source]
    # File lib/rodauth/features/base.rb
390 def csrf_tag(path=request.path)
391   return unless scope.respond_to?(:csrf_tag)
392 
393   if use_request_specific_csrf_tokens?
394     scope.csrf_tag(path)
395   else
396     # :nocov:
397     scope.csrf_tag
398     # :nocov:
399   end
400 end
currently_active_session?()
[show source]
   # 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_hmacs(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
database_function_password_match?(name, hash_id, password, salt)
[show source]
    # File lib/rodauth/features/argon2.rb
119 def database_function_password_match?(name, hash_id, password, salt)
120   return true if super
121 
122   if use_argon2? && argon2_hash_algorithm?(salt) && argon2_old_secret != argon2_secret && (ret = db.get(Sequel.function(function_name(name), hash_id, argon2_password_hash_using_salt_and_secret(password, salt, argon2_old_secret))))
123     @update_password_hash = true
124   end
125 
126   !!ret
127 end
db()
[show source]
    # File lib/rodauth/features/base.rb
284 def db
285   Sequel::DATABASES.first or raise "Sequel database connection is missing"
286 end
delete_account()
[show source]
   # File lib/rodauth/features/close_account.rb
76 def delete_account
77   account_ds.delete
78 end
delete_account_on_close?()
[show source]
   # File lib/rodauth/features/close_account.rb
80 def delete_account_on_close?
81   skip_status_checks?
82 end
disable_remember_login()
[show source]
    # File lib/rodauth/features/remember.rb
155 def disable_remember_login
156   remove_remember_key
157 end
domain()
[show source]
    # File lib/rodauth/features/base.rb
516 def domain
517   request.host
518 end
email_auth_ds(id=account_id)
[show source]
    # File lib/rodauth/features/email_auth.rb
232 def email_auth_ds(id=account_id)
233   db[email_auth_table].where(email_auth_id_column=>id)
234 end
email_auth_email_recently_sent?()
[show source]
    # File lib/rodauth/features/email_auth.rb
174 def email_auth_email_recently_sent?
175   (email_last_sent = get_email_auth_email_last_sent) && (Time.now - email_last_sent < email_auth_skip_resend_email_within)
176 end
email_auth_key_insert_hash()
[show source]
    # File lib/rodauth/features/email_auth.rb
226 def email_auth_key_insert_hash
227   hash = {email_auth_id_column=>account_id, email_auth_key_column=>email_auth_key_value}
228   set_deadline_value(hash, email_auth_deadline_column, email_auth_deadline_interval)
229   hash
230 end
email_auth_request_form()
[show source]
    # File lib/rodauth/features/email_auth.rb
145 def email_auth_request_form
146   render('email-auth-request-form')
147 end
email_from()
[show source]
   # File lib/rodauth/features/email_base.rb
26 def email_from
27   "webmaster@#{domain}"
28 end
email_to()
[show source]
   # File lib/rodauth/features/email_base.rb
30 def email_to
31   account[login_column]
32 end
expire_session()
[show source]
   # 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
extend_remember_deadline()
[show source]
    # File lib/rodauth/features/remember.rb
206 def extend_remember_deadline
207   active_remember_key_ds.update(remember_deadline_column=>Sequel.date_add(Sequel::CURRENT_TIMESTAMP, remember_period))
208   remember_login
209 end
extend_remember_deadline_while_logged_in?()
[show source]
    # File lib/rodauth/features/remember.rb
194 def extend_remember_deadline_while_logged_in?
195   return false unless extend_remember_deadline?
196 
197   if extended_at = session[remember_deadline_extended_session_key]
198     extended_at + extend_remember_deadline_period < Time.now.to_i
199   elsif logged_in_via_remember_key?
200     # Handle existing sessions before the change to extend remember deadline
201     # while logged in.
202     true
203   end
204 end
extract_password_hash_cost(hash)
[show source]
   # File lib/rodauth/features/argon2.rb
68 def extract_password_hash_cost(hash)
69   return super unless argon2_hash_algorithm?(hash)
70 
71   /\A\$argon2id\$v=\d+\$m=(\d+),t=(\d+),p=(\d+)/ =~ hash
72   { t_cost: $2.to_i, m_cost: Math.log2($1.to_i).to_i, p_cost: $3.to_i }
73 end
features()
[show source]
    # File lib/rodauth/features/base.rb
144 def features
145   self.class.features
146 end
field_attributes(field)
[show source]
    # File lib/rodauth/features/base.rb
219 def field_attributes(field)
220   _field_attributes(field) || default_field_attributes
221 end
field_error(field)
[show source]
    # File lib/rodauth/features/base.rb
176 def field_error(field)
177   return nil unless @field_errors
178   @field_errors[field]
179 end
field_error_attributes(field)
[show source]
    # File lib/rodauth/features/base.rb
223 def field_error_attributes(field)
224   if field_error(field)
225     _field_error_attributes(field)
226   end
227 end
flash()
[show source]
    # File lib/rodauth/features/base.rb
160 def flash
161   scope.flash
162 end
forget_login()
[show source]
    # File lib/rodauth/features/remember.rb
138 def forget_login
139   opts = Hash[remember_cookie_options]
140   opts[:path] = "/" unless opts.key?(:path)
141   ::Rack::Utils.delete_cookie_header!(response.headers, remember_cookie_key, opts)
142 end
formatted_field_error(field)
[show source]
    # File lib/rodauth/features/base.rb
229 def formatted_field_error(field)
230   if error = field_error(field)
231     _formatted_field_error(field, error)
232   end
233 end
function_name(name)
[show source]
    # File lib/rodauth/features/base.rb
690 def function_name(name)
691   if db.database_type == :mssql
692     # :nocov:
693     "dbo.#{name}"
694     # :nocov:
695   else
696     name
697   end
698 end
generate_active_sessions_key()
[show source]
    # File lib/rodauth/features/active_sessions.rb
144 def generate_active_sessions_key
145   @active_sessions_key = random_key
146 end
generate_email_auth_key_value()
[show source]
    # File lib/rodauth/features/email_auth.rb
218 def generate_email_auth_key_value
219   @email_auth_key_value = random_key
220 end
generate_refresh_token()
[show source]
    # File lib/rodauth/features/jwt_refresh.rb
185 def generate_refresh_token
186   hash = jwt_refresh_token_insert_hash
187   [account_id, jwt_refresh_token_ds.insert(hash), convert_token_key(hash[jwt_refresh_token_key_column])].join(token_separator)
188 end
generate_remember_key_value()
[show source]
    # File lib/rodauth/features/remember.rb
247 def generate_remember_key_value
248   @remember_key_value = random_key
249 end
generate_reset_password_key_value()
[show source]
    # File lib/rodauth/features/reset_password.rb
231 def generate_reset_password_key_value
232   @reset_password_key_value = random_key
233 end
generate_unlock_account_key()
[show source]
    # File lib/rodauth/features/lockout.rb
266 def generate_unlock_account_key
267   random_key
268 end
generate_verify_account_key_value()
[show source]
    # File lib/rodauth/features/verify_account.rb
277 def generate_verify_account_key_value
278   @verify_account_key_value = random_key
279 end
generate_verify_login_change_key_value()
[show source]
    # File lib/rodauth/features/verify_login_change.rb
172 def generate_verify_login_change_key_value
173   @verify_login_change_key_value = random_key
174 end
get_active_refresh_token(account_id, token_id)
[show source]
    # File lib/rodauth/features/jwt_refresh.rb
158 def get_active_refresh_token(account_id, token_id)
159   jwt_refresh_token_account_ds(account_id).
160     where(Sequel::CURRENT_TIMESTAMP > jwt_refresh_token_deadline_column).
161     delete
162 
163   jwt_refresh_token_account_token_ds(account_id, token_id).
164     get(jwt_refresh_token_key_column)
165 end
get_activity_timestamp(account_id, column)
[show source]
    # File lib/rodauth/features/account_expiration.rb
109 def get_activity_timestamp(account_id, column)
110   convert_timestamp(account_activity_ds(account_id).get(column))
111 end
get_email_auth_email_last_sent()
[show source]
    # File lib/rodauth/features/email_auth.rb
119 def get_email_auth_email_last_sent
120   if column = email_auth_email_last_sent_column
121     if ts = email_auth_ds.get(column)
122       convert_timestamp(ts)
123     end
124   end
125 end
get_email_auth_key(id)
[show source]
    # File lib/rodauth/features/email_auth.rb
139 def get_email_auth_key(id)
140   ds = email_auth_ds(id)
141   ds.where(Sequel::CURRENT_TIMESTAMP > email_auth_deadline_column).delete
142   ds.get(email_auth_key_column)
143 end
get_password_changed_at()
[show source]
   # File lib/rodauth/features/password_expiration.rb
26 def get_password_changed_at
27   convert_timestamp(password_expiration_ds.get(password_expiration_changed_at_column))
28 end
get_password_hash()

Get the password hash for the user. When using database authentication functions, note that only the salt is returned.

[show source]
    # File lib/rodauth/features/base.rb
712 def get_password_hash
713   if account_password_hash_column
714     account![account_password_hash_column]
715   elsif use_database_authentication_functions?
716     db.get(Sequel.function(function_name(:rodauth_get_salt), account ? account_id : session_value))
717   else
718     # :nocov:
719     password_hash_ds.get(password_hash_column)
720     # :nocov:
721   end
722 end
get_password_reset_key(id)
[show source]
    # File lib/rodauth/features/reset_password.rb
189 def get_password_reset_key(id)
190   ds = password_reset_ds(id)
191   ds.where(Sequel::CURRENT_TIMESTAMP > reset_password_deadline_column).delete
192   ds.get(reset_password_key_column)
193 end
get_remember_key()
[show source]
    # File lib/rodauth/features/remember.rb
144 def get_remember_key
145   unless @remember_key_value = active_remember_key_ds.get(remember_key_column)
146    generate_remember_key_value
147    transaction do
148      remove_remember_key
149      add_remember_key
150    end
151   end
152   nil
153 end
get_reset_password_email_last_sent()
[show source]
    # File lib/rodauth/features/reset_password.rb
199 def get_reset_password_email_last_sent
200   if column = reset_password_email_last_sent_column
201     if ts = password_reset_ds.get(column)
202       convert_timestamp(ts)
203     end
204   end
205 end
get_unlock_account_email_last_sent()
[show source]
    # File lib/rodauth/features/lockout.rb
228 def get_unlock_account_email_last_sent
229   if column = account_lockouts_email_last_sent_column
230     if ts = account_lockouts_ds.get(column)
231       convert_timestamp(ts)
232     end
233   end
234 end
get_unlock_account_key()
[show source]
    # File lib/rodauth/features/lockout.rb
216 def get_unlock_account_key
217   account_lockouts_ds.get(account_lockouts_key_column)
218 end
get_verify_account_email_last_sent()
[show source]
    # File lib/rodauth/features/verify_account.rb
229 def get_verify_account_email_last_sent
230   if column = verify_account_email_last_sent_column
231     if ts = verify_account_ds.get(column)
232       convert_timestamp(ts)
233     end
234   end
235 end
get_verify_account_key(id)
[show source]
    # File lib/rodauth/features/verify_account.rb
208 def get_verify_account_key(id)
209   verify_account_ds(id).get(verify_account_key_column)
210 end
get_verify_login_change_login_and_key(id)
[show source]
    # File lib/rodauth/features/verify_login_change.rb
132 def get_verify_login_change_login_and_key(id)
133   verify_login_change_ds(id).get([verify_login_change_login_column, verify_login_change_key_column])
134 end
handle_duplicate_active_session_id(_e)
[show source]
   # File lib/rodauth/features/active_sessions.rb
75 def handle_duplicate_active_session_id(_e)
76   # Do nothing by default as session is already tracked.  This will result in
77   # the current session and the existing session with the same id
78   # being tracked together, so that a logout of one will logout
79   # the other, and updating the last use on one will update the other,
80   # but this should be acceptable.  However, this can be overridden if different
81   # behavior is desired.
82 end
handle_webauthn_sign_count_verification_error()
[show source]
    # File lib/rodauth/features/webauthn.rb
357 def handle_webauthn_sign_count_verification_error
358   throw_error_reason(:invalid_webauthn_sign_count, invalid_field_error_status, webauthn_auth_param, webauthn_invalid_sign_count_message) 
359 end
has_password?()
[show source]
    # File lib/rodauth/features/base.rb
700 def has_password?
701   return @has_password if defined?(@has_password)
702   return false unless account || session_value
703   @has_password = !!get_password_hash
704 end
hmac_secret_rotation?()
[show source]
    # File lib/rodauth/features/base.rb
737 def hmac_secret_rotation?
738   hmac_secret && hmac_old_secret && hmac_secret != hmac_old_secret
739 end
hook_action(hook_type, action)
[show source]
   # File lib/rodauth/features/audit_logging.rb
31 def hook_action(hook_type, action)
32   super
33   # In after_logout, session is already cleared, so use before_logout in that case
34   if (hook_type == :after || action == :logout) && (id = account ? account_id : session_value)
35     add_audit_log(id, action)
36   end
37 end
http_basic_auth()
[show source]
   # File lib/rodauth/features/http_basic_auth.rb
34 def http_basic_auth
35   return @checked_http_basic_auth if defined?(@checked_http_basic_auth)
36 
37   @checked_http_basic_auth = nil
38   return unless token = ((v = request.env['HTTP_AUTHORIZATION']) && v[/\A *Basic (.*)\Z/, 1])
39 
40   username, password = token.unpack("m*").first.split(/:/, 2)
41   return unless username && password
42 
43   catch_error do
44     unless account_from_login(username)
45       throw_basic_auth_error(login_param, no_matching_login_message)
46     end
47 
48     before_login_attempt
49 
50     unless open_account?
51       throw_basic_auth_error(login_param, no_matching_login_message)
52     end
53 
54     unless password_match?(password)
55       after_login_failure
56       throw_basic_auth_error(password_param, invalid_password_message)
57     end
58 
59     transaction do
60       before_login
61       login_session('password')
62       after_login
63     end
64 
65     @checked_http_basic_auth = true
66     return true
67   end
68 
69   nil
70 end
inactive_session_cond()
[show source]
    # File lib/rodauth/features/active_sessions.rb
174 def inactive_session_cond
175   cond = session_inactivity_deadline_condition
176   cond2 = session_lifetime_deadline_condition
177   return false unless cond || cond2
178   Sequel.|(*[cond, cond2].compact)
179 end
include_success_messages?()
[show source]
    # File lib/rodauth/features/json.rb
185 def include_success_messages?
186   !json_response_success_key.nil?
187 end
input_field_string(param, id, opts={})
[show source]
    # File lib/rodauth/features/base.rb
187 def input_field_string(param, id, opts={})
188   type = opts.fetch(:type, "text")
189 
190   unless type == "password"
191     value = opts.fetch(:value){scope.h param(param)}
192   end
193 
194   field_class = opts.fetch(:class, "form-control")
195 
196   if autocomplete_for_field?(param) && opts[:autocomplete]
197     autocomplete = "autocomplete=\"#{opts[:autocomplete]}\""
198   end
199 
200   if inputmode_for_field?(param) && opts[:inputmode]
201     inputmode = "inputmode=\"#{opts[:inputmode]}\""
202   end
203 
204   if mark_input_fields_as_required? && opts[:required] != false
205     required = "required=\"required\""
206   end
207 
208   "<input #{opts[:attr]} #{autocomplete} #{inputmode} #{required} #{field_attributes(param)} #{field_error_attributes(param)} type=\"#{type}\" class=\"#{field_class}#{add_field_error_class(param)}\" name=\"#{param}\" id=\"#{id}\" value=\"#{value}\"/> #{formatted_field_error(param) unless opts[:skip_error_message]}"
209 end
inputmode_for_field?(_param)
[show source]
    # File lib/rodauth/features/base.rb
215 def inputmode_for_field?(_param)
216   mark_input_fields_with_inputmode?
217 end
internal_request?()
[show source]
    # File lib/rodauth/features/base.rb
851 def internal_request?
852   false
853 end
internal_request_configuration(&block)
[show source]
    # File lib/rodauth/features/internal_request.rb
375 def internal_request_configuration(&block)
376   @auth.instance_exec do
377     (@internal_request_configuration_blocks ||= []) << block
378   end
379 end
invalid_login_attempted()
[show source]
    # File lib/rodauth/features/lockout.rb
175 def invalid_login_attempted
176   ds = account_login_failures_ds.
177       where(account_login_failures_id_column=>account_id)
178 
179   number = if db.database_type == :postgres
180     ds.returning(account_login_failures_number_column).
181       with_sql(:update_sql, account_login_failures_number_column=>Sequel.expr(account_login_failures_number_column)+1).
182       single_value
183   else
184     # :nocov:
185     if ds.update(account_login_failures_number_column=>Sequel.expr(account_login_failures_number_column)+1) > 0
186       ds.get(account_login_failures_number_column)
187     end
188     # :nocov:
189   end
190 
191   unless number
192     # Ignoring the violation is safe here.  It may allow slightly more than max_invalid_logins invalid logins before
193     # lockout, but allowing a few extra is OK if the race is lost.
194     ignore_uniqueness_violation{account_login_failures_ds.insert(account_login_failures_id_column=>account_id)}
195     number = 1
196   end
197 
198   if number >= max_invalid_logins
199     @unlock_account_key_value = generate_unlock_account_key
200     hash = _setup_account_lockouts_hash(account_id, unlock_account_key_value)
201 
202     if e = raised_uniqueness_violation{account_lockouts_ds.insert(hash)}
203       # If inserting into the lockout table raises a violation, we should just be able to pull the already inserted
204       # key out of it.  If that doesn't return a valid key, we should reraise the error.
205       raise e unless @unlock_account_key_value = account_lockouts_ds.get(account_lockouts_key_column)
206 
207       after_account_lockout
208       show_lockout_page
209     else
210       after_account_lockout
211       e
212     end
213   end
214 end
invalid_previous_password_message()
[show source]
   # File lib/rodauth/features/change_password.rb
72 def invalid_previous_password_message
73   invalid_password_message
74 end
json_request?()
[show source]
   # File lib/rodauth/features/json.rb
55 def json_request?
56   return @json_request if defined?(@json_request)
57   @json_request = request.content_type =~ json_request_content_type_regexp
58 end
json_response()
[show source]
    # File lib/rodauth/features/json.rb
193 def json_response
194   @json_response ||= {}
195 end
json_response_error?()
[show source]
   # File lib/rodauth/features/json.rb
69 def json_response_error?
70   !!json_response[json_response_error_key]
71 end
jwt_cors_allow?()
[show source]
   # File lib/rodauth/features/jwt_cors.rb
15 def jwt_cors_allow?
16   return false unless origin = request.env['HTTP_ORIGIN']
17 
18   case allowed = jwt_cors_allow_origin
19   when String
20     timing_safe_eql?(origin, allowed)
21   when Array
22     allowed.any?{|s| timing_safe_eql?(origin, s)}
23   when Regexp
24     allowed =~ origin
25   when true
26     true
27   else
28     false
29   end
30 end
jwt_payload()
[show source]
    # File lib/rodauth/features/jwt.rb
130 def jwt_payload
131   return @jwt_payload if defined?(@jwt_payload)
132   @jwt_payload = JWT.decode(jwt_token, _jwt_decode_secrets, true, _jwt_decode_opts.merge(:algorithm=>jwt_algorithm))[0]
133 rescue JWT::DecodeError => e
134   rescue_jwt_payload(e)
135 end
jwt_refresh_token_account_ds(account_id)
[show source]
    # File lib/rodauth/features/jwt_refresh.rb
167 def jwt_refresh_token_account_ds(account_id)
168   jwt_refresh_token_ds.where(jwt_refresh_token_account_id_column => account_id)
169 end
jwt_refresh_token_account_token_ds(account_id, token_id)
[show source]
    # File lib/rodauth/features/jwt_refresh.rb
171 def jwt_refresh_token_account_token_ds(account_id, token_id)
172   jwt_refresh_token_account_ds(account_id).
173     where(jwt_refresh_token_id_column=>token_id)
174 end
jwt_refresh_token_ds()
[show source]
    # File lib/rodauth/features/jwt_refresh.rb
176 def jwt_refresh_token_ds
177   db[jwt_refresh_token_table]
178 end
jwt_refresh_token_insert_hash()
[show source]
    # File lib/rodauth/features/jwt_refresh.rb
190 def jwt_refresh_token_insert_hash
191   hash = {jwt_refresh_token_account_id_column => account_id, jwt_refresh_token_key_column => random_key}
192   set_deadline_value(hash, jwt_refresh_token_deadline_column, jwt_refresh_token_deadline_interval)
193   hash
194 end
jwt_refresh_token_match?(key)
[show source]
    # File lib/rodauth/features/jwt_refresh.rb
147 def jwt_refresh_token_match?(key)
148   # We don't need to match tokens if we are requiring a valid current access token
149   return true unless allow_refresh_with_expired_jwt_access_token?
150 
151   # If allowing with expired jwt access token, check the expired session contains
152   # hmac matching submitted and active refresh token.
153   s = session[jwt_refresh_token_hmac_session_key].to_s
154   h = session[jwt_refresh_token_data_session_key].to_s + key
155   timing_safe_eql?(compute_hmac(h), s) || (hmac_secret_rotation? && timing_safe_eql?(compute_old_hmac(h), s))
156 end
jwt_secret()
[show source]
   # File lib/rodauth/features/jwt.rb
69 def jwt_secret
70   raise ArgumentError, "jwt_secret not set"
71 end
jwt_session_hash()
[show source]
   # File lib/rodauth/features/jwt.rb
73 def jwt_session_hash
74   jwt_session_key ? {jwt_session_key=>session} : session
75 end
jwt_token()
[show source]
   # File lib/rodauth/features/jwt.rb
81 def jwt_token
82   return @jwt_token if defined?(@jwt_token)
83 
84   if (v = request.env['HTTP_AUTHORIZATION']) && v !~ jwt_authorization_ignore
85     @jwt_token = v.sub(jwt_authorization_remove, '')
86   end
87 end
last_account_activity_at()
[show source]
   # File lib/rodauth/features/account_expiration.rb
27 def last_account_activity_at
28   get_activity_timestamp(session_value, account_activity_last_activity_column)
29 end
last_account_login_at()
[show source]
   # File lib/rodauth/features/account_expiration.rb
31 def last_account_login_at
32   get_activity_timestamp(session_value, account_activity_last_login_column)
33 end
load_memory()
[show source]
    # File lib/rodauth/features/remember.rb
114 def load_memory
115   if logged_in?
116     if extend_remember_deadline_while_logged_in?
117       if account_from_session
118         extend_remember_deadline
119       else
120         forget_login
121         clear_session
122       end
123     end
124   elsif account_from_remember_cookie
125     before_load_memory
126     login_session('remember')
127     extend_remember_deadline if extend_remember_deadline?
128     after_load_memory
129   end
130 end
loaded_templates()
[show source]
    # File lib/rodauth/features/base.rb
791 def loaded_templates
792   []
793 end
locked_out?()
[show source]
    # File lib/rodauth/features/lockout.rb
146 def locked_out?
147   if t = convert_timestamp(account_lockouts_ds.get(account_lockouts_deadline_column))
148     if Time.now < t
149       true
150     else
151       unlock_account
152       false
153     end
154   else
155     false
156   end
157 end
logged_in_via_remember_key?()
[show source]
    # File lib/rodauth/features/remember.rb
174 def logged_in_via_remember_key?
175   authenticated_by.include?('remember')
176 end
login(auth_type)
[show source]
   # File lib/rodauth/features/login.rb
86 def login(auth_type)
87   @saved_login_redirect = remove_session_value(login_redirect_session_key)
88   transaction do
89     before_login
90     login_session(auth_type)
91     yield if block_given?
92     after_login
93   end
94   require_response(:_login_response)
95 end
login_confirm_label()
[show source]
   # File lib/rodauth/features/login_password_requirements_base.rb
46 def login_confirm_label
47   "Confirm #{login_label}"
48 end
login_does_not_meet_requirements_message()
[show source]
    # File lib/rodauth/features/login_password_requirements_base.rb
108 def login_does_not_meet_requirements_message
109   "invalid login#{", #{login_requirement_message}" if login_requirement_message}"
110 end
login_failed_reset_password_request_form()
[show source]
    # File lib/rodauth/features/reset_password.rb
235 def login_failed_reset_password_request_form
236   render("reset-password-request")
237 end
login_field_autocomplete_value()
[show source]
    # File lib/rodauth/features/base.rb
288 def login_field_autocomplete_value
289   login_uses_email? ? "email" : "on"
290 end
login_hidden_field()
[show source]
    # File lib/rodauth/features/login.rb
129 def login_hidden_field
130   "<input type='hidden' name=\"#{login_param}\" value=\"#{scope.h param(login_param)}\" />"
131 end
login_input_type()
[show source]
    # File lib/rodauth/features/base.rb
312 def login_input_type
313   login_uses_email? ? 'email' : 'text'
314 end
login_meets_email_requirements?(login)
[show source]
    # File lib/rodauth/features/login_password_requirements_base.rb
144 def login_meets_email_requirements?(login)
145   return true unless require_email_address_logins?
146   return true if login_valid_email?(login)
147   set_login_requirement_error_message(:login_not_valid_email, login_not_valid_email_message)
148   return false
149 end
login_meets_length_requirements?(login)
[show source]
    # File lib/rodauth/features/login_password_requirements_base.rb
129 def login_meets_length_requirements?(login)
130   if login_minimum_length > login.length
131     set_login_requirement_error_message(:login_too_short, login_too_short_message)
132     false
133   elsif login_maximum_length < login.length
134     set_login_requirement_error_message(:login_too_long, login_too_long_message)
135     false
136   elsif login_maximum_bytes < login.bytesize
137     set_login_requirement_error_message(:login_too_many_bytes, login_too_many_bytes_message)
138     false
139   else
140     true
141   end
142 end
login_meets_requirements?(login)
[show source]
   # File lib/rodauth/features/login_password_requirements_base.rb
54 def login_meets_requirements?(login)
55   login_meets_length_requirements?(login) && \
56     login_meets_email_requirements?(login)
57 end
login_required()
[show source]
    # File lib/rodauth/features/base.rb
328 def login_required
329   set_redirect_error_status(login_required_error_status)
330   set_error_reason :login_required
331   set_redirect_error_flash require_login_error_flash
332   redirect require_login_redirect
333 end
login_return_to_requested_location_path()
[show source]
    # File lib/rodauth/features/login.rb
104 def login_return_to_requested_location_path
105   request.fullpath if request.get?
106 end
login_session(auth_type)
[show source]
    # File lib/rodauth/features/base.rb
464 def login_session(auth_type)
465   update_session
466   set_session_value(authenticated_by_session_key, [auth_type])
467 end
login_too_long_message()
[show source]
    # File lib/rodauth/features/login_password_requirements_base.rb
112 def login_too_long_message
113   "maximum #{login_maximum_length} characters"
114 end
login_too_many_bytes_message()
[show source]
    # File lib/rodauth/features/login_password_requirements_base.rb
116 def login_too_many_bytes_message
117   "maximum #{login_maximum_bytes} bytes"
118 end
login_too_short_message()
[show source]
    # File lib/rodauth/features/login_password_requirements_base.rb
120 def login_too_short_message
121   "minimum #{login_minimum_length} characters"
122 end
login_uses_email?()
[show source]
    # File lib/rodauth/features/base.rb
316 def login_uses_email?
317   login_column == :email
318 end
login_valid_email?(login)
[show source]
    # File lib/rodauth/features/login_password_requirements_base.rb
151 def login_valid_email?(login)
152   login =~ login_email_regexp
153 end
logout()
[show source]
   # File lib/rodauth/features/logout.rb
34 def logout
35   clear_session
36 end
logout_additional_form_tags()
[show source]
    # File lib/rodauth/features/active_sessions.rb
104 def logout_additional_form_tags
105   super.to_s + render('global-logout-field')
106 end
modifications_require_password?()
[show source]
    # File lib/rodauth/features/base.rb
520 def modifications_require_password?
521   has_password?
522 end
new_account(login)
[show source]
   # File lib/rodauth/features/create_account.rb
96 def new_account(login)
97   @account = _new_account(login)
98 end
new_recovery_code()
[show source]
    # File lib/rodauth/features/recovery_codes.rb
240 def new_recovery_code
241   random_key
242 end
new_webauthn_credential()
[show source]
    # File lib/rodauth/features/webauthn.rb
302 def new_webauthn_credential
303   WebAuthn::Credential.options_for_create(
304     :timeout => webauthn_setup_timeout,
305     :rp => {:name=>webauthn_rp_name, :id=>webauthn_rp_id},
306     :user => {:id=>account_webauthn_user_id, :name=>webauthn_user_name},
307     :authenticator_selection => webauthn_authenticator_selection,
308     :attestation => webauthn_attestation,
309     :extensions => webauthn_extensions,
310     :exclude => account_webauthn_ids,
311   )
312 end
no_longer_active_session()
[show source]
   # File lib/rodauth/features/active_sessions.rb
58 def no_longer_active_session
59   clear_session
60   set_redirect_error_status inactive_session_error_status
61   set_error_reason :inactive_session
62   set_redirect_error_flash active_sessions_error_flash
63   redirect active_sessions_redirect
64 end
normalize_session_or_flash_key(key)
[show source]
    # File lib/rodauth/features/base.rb
612 def normalize_session_or_flash_key(key)
613   scope.opts[:sessions_convert_symbols] ? key.to_s : key
614 end
null_byte_parameter_value(key, value)

Return nil by default for values with null bytes

[show source]
    # File lib/rodauth/features/base.rb
502 def null_byte_parameter_value(key, value)
503   nil
504 end
only_json?()
[show source]
    # File lib/rodauth/features/base.rb
423 def only_json?
424   scope.class.opts[:rodauth_json] == :only
425 end
open_account?()
[show source]
    # File lib/rodauth/features/base.rb
280 def open_account?
281   skip_status_checks? || account[account_status_column] == account_open_status_value 
282 end
otp_add_key()
[show source]
    # File lib/rodauth/features/otp.rb
283 def otp_add_key
284   _otp_add_key(otp_key)
285   super if defined?(super)
286 end
otp_available?()
[show source]
    # File lib/rodauth/features/otp.rb
243 def otp_available?
244   otp_exists? && !otp_locked_out?
245 end
otp_exists?()
[show source]
    # File lib/rodauth/features/otp.rb
247 def otp_exists?
248   !otp_key.nil?
249 end
otp_hmac_old_secret(key)
[show source]
    # File lib/rodauth/features/otp.rb
383 def otp_hmac_old_secret(key)
384   base32_encode(compute_raw_hmac_with_secret(ROTP::Base32.decode(key), hmac_old_secret), key.bytesize)
385 end
otp_hmac_secret(key)
[show source]
    # File lib/rodauth/features/otp.rb
379 def otp_hmac_secret(key)
380   base32_encode(compute_raw_hmac(ROTP::Base32.decode(key)), key.bytesize)
381 end
otp_issuer()
[show source]
    # File lib/rodauth/features/otp.rb
314 def otp_issuer
315   domain
316 end
otp_key_ds()
[show source]
    # File lib/rodauth/features/otp.rb
446 def otp_key_ds
447   db[otp_keys_table].where(otp_keys_id_column=>session_value)
448 end
otp_keys_use_hmac?()
[show source]
    # File lib/rodauth/features/otp.rb
335 def otp_keys_use_hmac?
336   !!hmac_secret
337 end
otp_last_use()
[show source]
    # File lib/rodauth/features/otp.rb
294 def otp_last_use
295   convert_timestamp(otp_key_ds.get(otp_keys_last_use_column))
296 end
otp_locked_out?()
[show source]
    # File lib/rodauth/features/otp.rb
306 def otp_locked_out?
307   otp_key_ds.get(otp_keys_failures_column) >= otp_auth_failures_limit
308 end
otp_new_secret()
[show source]
    # File lib/rodauth/features/otp.rb
401 def otp_new_secret
402   ROTP::Base32.random_base32.downcase
403 end
otp_provisioning_name()
[show source]
    # File lib/rodauth/features/otp.rb
318 def otp_provisioning_name
319   account[login_column]
320 end
otp_provisioning_uri()
[show source]
    # File lib/rodauth/features/otp.rb
310 def otp_provisioning_uri
311   otp.provisioning_uri(otp_provisioning_name)
312 end
otp_qr_code()
[show source]
    # File lib/rodauth/features/otp.rb
322 def otp_qr_code
323   svg = RQRCode::QRCode.new(otp_provisioning_uri).as_svg(:module_size=>8, :viewbox=>true, :use_path=>true, :fill=>"fff")
324   svg.sub(/\A<\?xml version="1\.0" standalone="yes"\?>/, '')
325 end
otp_record_authentication_failure()
[show source]
    # File lib/rodauth/features/otp.rb
298 def otp_record_authentication_failure
299   otp_key_ds.update(otp_keys_failures_column=>Sequel.identifier(otp_keys_failures_column) + 1)
300 end
otp_remove()
[show source]
    # File lib/rodauth/features/otp.rb
278 def otp_remove
279   otp_key_ds.delete
280   @otp_key = nil
281 end
otp_remove_auth_failures()
[show source]
    # File lib/rodauth/features/otp.rb
302 def otp_remove_auth_failures
303   otp_key_ds.update(otp_keys_failures_column=>0)
304 end
otp_tmp_key(secret)
[show source]
    # File lib/rodauth/features/otp.rb
374 def otp_tmp_key(secret)
375   _otp_tmp_key(secret)
376   clear_cached_otp
377 end
otp_update_last_use()
[show source]
    # File lib/rodauth/features/otp.rb
288 def otp_update_last_use
289   otp_key_ds.
290     where(Sequel.date_add(otp_keys_last_use_column, :seconds=>(otp_interval||30)) < Sequel::CURRENT_TIMESTAMP).
291     update(otp_keys_last_use_column=>Sequel::CURRENT_TIMESTAMP) == 1
292 end
otp_user_key()
[show source]
    # File lib/rodauth/features/otp.rb
327 def otp_user_key
328   @otp_user_key ||= if otp_keys_use_hmac?
329     otp_hmac_secret(otp_key)
330   else
331     otp_key
332   end
333 end
otp_valid_code?(ot_pass)
[show source]
    # File lib/rodauth/features/otp.rb
251 def otp_valid_code?(ot_pass)
252   if _otp_valid_code?(ot_pass, otp)
253     true
254   elsif hmac_secret_rotation? && _otp_valid_code?(ot_pass, _otp_for_key(otp_hmac_old_secret(otp_key)))
255     _otp_valid_code_for_old_secret
256     true
257   else
258     false
259   end
260 end
otp_valid_key?(secret)
[show source]
    # File lib/rodauth/features/otp.rb
387 def otp_valid_key?(secret)
388   return false unless secret =~ /\A([a-z2-7]{16}|[a-z2-7]{32})\z/
389   if otp_keys_use_hmac?
390     # Purposely do not allow creating new OTPs with old secrets,
391     # since OTP rotation is difficult.  The user will get shown
392     # the same page with an updated secret, which they can submit
393     # to setup OTP.
394     timing_safe_eql?(otp_hmac_secret(param(otp_setup_raw_param)), secret)
395   else
396     true
397   end
398 end
over_max_bytesize_param_value(key, value)

Return nil by default for values over maximum bytesize.

[show source]
    # File lib/rodauth/features/base.rb
497 def over_max_bytesize_param_value(key, value)
498   nil
499 end
param(key)

Return a string for the parameter name. This will be an empty string if the parameter doesn’t exist.

[show source]
    # File lib/rodauth/features/base.rb
480 def param(key)
481   param_or_nil(key).to_s
482 end
param_or_nil(key)

Return a string for the parameter name, or nil if there is no parameter with that name.

[show source]
    # File lib/rodauth/features/base.rb
486 def param_or_nil(key)
487   value = raw_param(key)
488   unless value.nil?
489     value = value.to_s
490     value = over_max_bytesize_param_value(key, value) if max_param_bytesize && value.bytesize > max_param_bytesize
491     value = null_byte_parameter_value(key, value) if value && value.include?("\0")
492   end
493   value
494 end
password_confirm_label()
[show source]
   # File lib/rodauth/features/login_password_requirements_base.rb
50 def password_confirm_label
51   "Confirm #{password_label}"
52 end
password_does_not_contain_null_byte?(password)
[show source]
    # File lib/rodauth/features/login_password_requirements_base.rb
170 def password_does_not_contain_null_byte?(password)
171   return true unless password.include?("\0")
172   set_password_requirement_error_message(:password_contains_null_byte, contains_null_byte_message)
173   false
174 end
password_does_not_meet_requirements_message()
[show source]
   # File lib/rodauth/features/login_password_requirements_base.rb
87 def password_does_not_meet_requirements_message
88   "invalid password, does not meet requirements#{" (#{password_requirement_message})" if password_requirement_message}"
89 end
password_doesnt_match_previous_password?(password)
[show source]
   # File lib/rodauth/features/disallow_password_reuse.rb
50 def password_doesnt_match_previous_password?(password)
51   match = if use_database_authentication_functions?
52     salts = previous_password_ds.
53       select_map([previous_password_id_column, Sequel.function(function_name(:rodauth_get_previous_salt), previous_password_id_column).as(:salt)])
54     return true if salts.empty?
55 
56     salts.any? do |hash_id, salt|
57       database_function_password_match?(:rodauth_previous_password_hash_match, hash_id, password, salt)
58     end
59   else
60     # :nocov:
61     previous_password_ds.select_map(previous_password_hash_column).any? do |hash|
62       password_hash_match?(hash, password)
63     end
64     # :nocov:
65   end
66 
67   return true unless match
68   set_password_requirement_error_message(:password_same_as_previous_password, password_same_as_previous_password_message)
69   false
70 end
password_expiration_ds()
[show source]
    # File lib/rodauth/features/password_expiration.rb
107 def password_expiration_ds
108   db[password_expiration_table].where(password_expiration_id_column=>account_id)
109 end
password_expired?()
[show source]
   # File lib/rodauth/features/password_expiration.rb
68 def password_expired?
69   if password_changed_at = session[password_changed_at_session_key]
70     return password_changed_at + require_password_change_after < Time.now.to_i
71   end
72 
73   account_from_session
74   if password_changed_at = get_password_changed_at
75     set_session_value(password_changed_at_session_key, password_changed_at.to_i)
76     password_changed_at + require_password_change_after < Time.now
77   else
78     set_session_value(password_changed_at_session_key, password_expiration_default ? 0 : 2147483647)
79     password_expiration_default
80   end
81 end
password_field_autocomplete_value()
[show source]
    # File lib/rodauth/features/base.rb
292 def password_field_autocomplete_value
293   @password_field_autocomplete_value || 'current-password'
294 end
password_has_enough_character_groups?(password)
[show source]
   # File lib/rodauth/features/password_complexity.rb
54 def password_has_enough_character_groups?(password)
55   return true if password.length > password_max_length_for_groups_check
56   return true if password_character_groups.select{|re| password =~ re}.length >= password_min_groups
57   set_password_requirement_error_message(:not_enough_character_groups_in_password, password_not_enough_character_groups_message)
58   false
59 end
password_has_no_invalid_pattern?(password)
[show source]
   # File lib/rodauth/features/password_complexity.rb
61 def password_has_no_invalid_pattern?(password)
62   return true unless password_invalid_pattern
63   return true if password !~ password_invalid_pattern
64   set_password_requirement_error_message(:invalid_password_pattern, password_invalid_pattern_message)
65   false
66 end
password_hash(password)
[show source]
   # File lib/rodauth/features/argon2.rb
19 def password_hash(password)
20   return super unless use_argon2?
21 
22   if secret = argon2_secret
23     argon2_params = Hash[password_hash_cost]
24     argon2_params[:secret] = secret
25   else
26     argon2_params = password_hash_cost
27   end
28   ::Argon2::Password.new(argon2_params).create(password)
29 end
password_hash_cost()
[show source]
   # File lib/rodauth/features/argon2.rb
45 def password_hash_cost
46   return super unless use_argon2?
47   argon2_hash_cost
48 end
password_hash_ds()
[show source]
    # File lib/rodauth/features/base.rb
781 def password_hash_ds
782   db[password_hash_table].where(password_hash_id_column=>account ? account_id : session_value)
783 end
password_hash_match?(hash, password)
[show source]
   # File lib/rodauth/features/argon2.rb
50 def password_hash_match?(hash, password)
51   return super unless argon2_hash_algorithm?(hash)
52   argon2_password_hash_match?(hash, password)
53 end
password_hash_using_salt(password, salt)
[show source]
   # File lib/rodauth/features/argon2.rb
55 def password_hash_using_salt(password, salt)
56   return super unless argon2_hash_algorithm?(salt)
57   argon2_password_hash_using_salt_and_secret(password, salt, argon2_secret)
58 end
password_match?(password)
[show source]
    # File lib/rodauth/features/base.rb
445 def password_match?(password)
446   if hash = get_password_hash
447     if account_password_hash_column || !use_database_authentication_functions?
448       password_hash_match?(hash, password)
449     else
450       database_function_password_match?(:rodauth_valid_password_hash, account_id, password, hash)
451     end 
452   end
453 end
password_meets_length_requirements?(password)
[show source]
    # File lib/rodauth/features/login_password_requirements_base.rb
155 def password_meets_length_requirements?(password)
156   if password_minimum_length > password.length
157     set_password_requirement_error_message(:password_too_short, password_too_short_message)
158     false
159   elsif password_maximum_length && password_maximum_length < password.length
160     set_password_requirement_error_message(:password_too_long, password_too_long_message)
161     false
162   elsif password_maximum_bytes && password_maximum_bytes < password.bytesize
163     set_password_requirement_error_message(:password_too_many_bytes, password_too_many_bytes_message)
164     false
165   else
166     true
167   end
168 end
password_meets_requirements?(password)
[show source]
   # File lib/rodauth/features/disallow_common_passwords.rb
13 def password_meets_requirements?(password)
14   super && password_not_one_of_the_most_common?(password)
15 end
password_not_in_dictionary?(password)
[show source]
   # File lib/rodauth/features/password_complexity.rb
75 def password_not_in_dictionary?(password)
76   return true unless dict = password_dictionary
77   return true unless password =~ /\A(?:\d*)([A-Za-z!@$+|][A-Za-z!@$+|0134578]+[A-Za-z!@$+|])(?:\d*)\z/
78   word = $1.downcase.tr('!@$+|0134578', 'iastloleastb')
79   return true if !dict.include?(word)
80   set_password_requirement_error_message(:password_in_dictionary, password_in_dictionary_message)
81   false
82 end
password_not_one_of_the_most_common?(password)
[show source]
   # File lib/rodauth/features/disallow_common_passwords.rb
33 def password_not_one_of_the_most_common?(password)
34   return true unless password_one_of_most_common?(password)
35   set_password_requirement_error_message(:password_is_one_of_the_most_common, password_is_one_of_the_most_common_message)
36   false
37 end
password_not_too_many_repeating_characters?(password)
[show source]
   # File lib/rodauth/features/password_complexity.rb
68 def password_not_too_many_repeating_characters?(password)
69   return true if password_max_repeating_characters < 2
70   return true if password !~ /(.)(\1){#{password_max_repeating_characters-1}}/ 
71   set_password_requirement_error_message(:too_many_repeating_characters_in_password, password_too_many_repeating_characters_message)
72   false
73 end
password_one_of_most_common?(password)
[show source]
   # File lib/rodauth/features/disallow_common_passwords.rb
27 def password_one_of_most_common?(password)
28   most_common_passwords.include?(password)
29 end
password_recently_entered?()
[show source]
   # File lib/rodauth/features/password_grace_period.rb
22 def password_recently_entered?
23   return false unless last_password_entry = session[last_password_entry_session_key]
24   last_password_entry + password_grace_period > Time.now.to_i
25 end
password_reset_ds(id=account_id)
[show source]
    # File lib/rodauth/features/reset_password.rb
249 def password_reset_ds(id=account_id)
250   db[reset_password_table].where(reset_password_id_column=>id)
251 end
password_too_long_message()
[show source]
   # File lib/rodauth/features/login_password_requirements_base.rb
91 def password_too_long_message
92   "maximum #{password_maximum_length} characters"
93 end
password_too_many_bytes_message()
[show source]
   # File lib/rodauth/features/login_password_requirements_base.rb
95 def password_too_many_bytes_message
96   "maximum #{password_maximum_bytes} bytes"
97 end
password_too_short_message()
[show source]
    # File lib/rodauth/features/login_password_requirements_base.rb
 99 def password_too_short_message
100   "minimum #{password_minimum_length} characters"
101 end
possible_authentication_methods()
[show source]
    # File lib/rodauth/features/base.rb
524 def possible_authentication_methods
525   has_password? ? ['password'] : []
526 end
post_configure()
[show source]
    # File lib/rodauth/features/base.rb
427 def post_configure
428   require 'bcrypt' if require_bcrypt?
429   db.extension :date_arithmetic if use_date_arithmetic?
430 
431   if convert_token_id_to_integer?.nil? && (db rescue false) && db.table_exists?(accounts_table) && db.schema(accounts_table).find{|col, v| break v[:type] == :integer if col == account_id_column}
432     self.class.send(:define_method, :convert_token_id_to_integer?){true}
433   end
434 
435   route_hash= {}
436   self.class.routes.each do |meth|
437     route_meth = "#{meth.to_s.sub(/\Ahandle_/, '')}_route"
438     if route = send(route_meth)
439       route_hash["/#{route}"] = meth
440     end
441   end
442   self.class.route_hash = route_hash.freeze
443 end
previous_password_ds()
[show source]
   # File lib/rodauth/features/disallow_password_reuse.rb
94 def previous_password_ds
95   db[previous_password_hash_table].where(previous_password_account_id_column=>account_id)
96 end
raises_uniqueness_violation?(&block)

In cases where retrying on uniqueness violations cannot work, this will detect whether a uniqueness violation is raised by the block and return the exception if so. This method should be used if you don’t care about the exception itself.

[show source]
    # File lib/rodauth/features/base.rb
810 def raises_uniqueness_violation?(&block)
811   transaction(:savepoint=>:only, &block)
812   false
813 rescue unique_constraint_violation_class => e
814   e
815 end
random_key()
[show source]
    # File lib/rodauth/features/base.rb
603 def random_key
604   SecureRandom.urlsafe_base64(32)
605 end
raw_param(key)
[show source]
    # File lib/rodauth/features/base.rb
506 def raw_param(key)
507   request.params[key]
508 end
recovery_code_match?(code)
[show source]
    # File lib/rodauth/features/recovery_codes.rb
160 def recovery_code_match?(code)
161   recovery_codes.each do |s|
162     if timing_safe_eql?(code, s)
163       recovery_codes_ds.where(recovery_codes_column=>code).delete
164       if recovery_codes_primary?
165         add_recovery_code
166       end
167       return true
168     end
169   end
170   false
171 end
recovery_codes_available?()
[show source]
    # File lib/rodauth/features/recovery_codes.rb
196 def recovery_codes_available?
197   !recovery_codes_ds.empty?
198 end
recovery_codes_ds()
[show source]
    # File lib/rodauth/features/recovery_codes.rb
264 def recovery_codes_ds
265   db[recovery_codes_table].where(recovery_codes_id_column=>session_value)
266 end
recovery_codes_primary?()
[show source]
    # File lib/rodauth/features/recovery_codes.rb
244 def recovery_codes_primary?
245   (features & [:otp, :sms_codes, :webauthn]).empty?
246 end
recovery_codes_remove()
[show source]
    # File lib/rodauth/features/recovery_codes.rb
156 def recovery_codes_remove
157   recovery_codes_ds.delete
158 end
redirect(path)
[show source]
    # File lib/rodauth/features/base.rb
580 def redirect(path)
581   request.redirect(path)
582 end
remember_key_ds(id=account_id)
[show source]
    # File lib/rodauth/features/remember.rb
255 def remember_key_ds(id=account_id)
256   db[remember_table].where(remember_id_column=>id)
257 end
remember_login()
[show source]
    # File lib/rodauth/features/remember.rb
132 def remember_login
133   get_remember_key
134   set_remember_cookie
135   set_session_value(remember_deadline_extended_session_key, Time.now.to_i) if extend_remember_deadline?
136 end
remembered_session_id()
[show source]
    # File lib/rodauth/features/remember.rb
 91 def remembered_session_id
 92   return unless cookie = _get_remember_cookie
 93   id, key = cookie.split('_', 2)
 94   return unless id && key
 95 
 96   actual, deadline = active_remember_key_ds(id).get([remember_key_column, remember_deadline_column])
 97   return unless actual
 98 
 99   if hmac_secret && !(valid = timing_safe_eql?(key, compute_hmac(actual)))
100     if hmac_secret_rotation? && (valid = timing_safe_eql?(key, compute_old_hmac(actual)))
101       _set_remember_cookie(id, actual, deadline)
102     elsif !(raw_remember_token_deadline && raw_remember_token_deadline > convert_timestamp(deadline))
103       return
104     end
105   end
106 
107   unless valid || timing_safe_eql?(key, actual)
108     return
109   end
110 
111   id
112 end
remove_active_session(session_id)
[show source]
   # File lib/rodauth/features/active_sessions.rb
90 def remove_active_session(session_id)
91   active_sessions_ds.where(active_sessions_session_id_column=>session_id).delete
92 end
remove_all_active_sessions()
[show source]
   # File lib/rodauth/features/active_sessions.rb
94 def remove_all_active_sessions
95   active_sessions_ds.delete
96 end
remove_all_webauthn_keys_and_user_ids()
[show source]
    # File lib/rodauth/features/webauthn.rb
391 def remove_all_webauthn_keys_and_user_ids
392   webauthn_user_ids_ds.delete
393   webauthn_keys_ds.delete
394 end
remove_current_session()
[show source]
   # File lib/rodauth/features/active_sessions.rb
84 def remove_current_session
85   if session_id = session[session_id_session_key]
86     remove_active_session(compute_hmacs(session_id))
87   end
88 end
remove_email_auth_key()
[show source]
    # File lib/rodauth/features/email_auth.rb
127 def remove_email_auth_key
128   email_auth_ds.delete
129 end
remove_inactive_sessions()
[show source]
    # File lib/rodauth/features/active_sessions.rb
 98 def remove_inactive_sessions
 99   if cond = inactive_session_cond
100     active_sessions_ds.where(cond).delete
101   end
102 end
remove_jwt_refresh_token_key(token)
[show source]
    # File lib/rodauth/features/jwt_refresh.rb
180 def remove_jwt_refresh_token_key(token)
181   account_id, token_id, _ = _account_refresh_token_split(token)
182   jwt_refresh_token_account_token_ds(account_id, token_id).delete
183 end
remove_lockout_metadata()
[show source]
    # File lib/rodauth/features/lockout.rb
270 def remove_lockout_metadata
271   account_login_failures_ds.delete
272   account_lockouts_ds.delete
273 end
remove_remember_key(id=account_id)
[show source]
    # File lib/rodauth/features/remember.rb
170 def remove_remember_key(id=account_id)
171   remember_key_ds(id).delete
172 end
remove_reset_password_key()
[show source]
    # File lib/rodauth/features/reset_password.rb
177 def remove_reset_password_key
178   password_reset_ds.delete
179 end
remove_session_value(key)
[show source]
    # File lib/rodauth/features/base.rb
864 def remove_session_value(key)
865   session.delete(key)
866 end
remove_verify_account_key()
[show source]
    # File lib/rodauth/features/verify_account.rb
167 def remove_verify_account_key
168   verify_account_ds.delete
169 end
remove_verify_login_change_key()
[show source]
    # File lib/rodauth/features/verify_login_change.rb
108 def remove_verify_login_change_key
109   verify_login_change_ds.delete
110 end
remove_webauthn_key(webauthn_id)
[show source]
    # File lib/rodauth/features/webauthn.rb
387 def remove_webauthn_key(webauthn_id)
388   webauthn_keys_ds.where(webauthn_keys_webauthn_id_column=>webauthn_id).delete == 1
389 end
render(page)
[show source]
    # File lib/rodauth/features/base.rb
419 def render(page)
420   _view(:render, page)
421 end
render_multi_phase_login_forms()
[show source]
    # File lib/rodauth/features/login.rb
137 def render_multi_phase_login_forms
138   multi_phase_login_forms.sort.map{|_, form, _| form}.join("\n")
139 end
request()
[show source]
    # File lib/rodauth/features/base.rb
148 def request
149   scope.request
150 end
require_account()
[show source]
    # File lib/rodauth/features/base.rb
369 def require_account
370   require_authentication
371   require_account_session
372 end
require_account_session()
[show source]
    # File lib/rodauth/features/base.rb
621 def require_account_session
622   unless account_from_session
623     clear_session
624     login_required
625   end
626 end
require_authentication()
[show source]
    # File lib/rodauth/features/base.rb
365 def require_authentication
366   require_login
367 end
require_current_password()
[show source]
   # File lib/rodauth/features/password_expiration.rb
61 def require_current_password
62   if authenticated? && password_expired? && password_change_needed_redirect != request.path_info
63     set_redirect_error_flash password_expiration_error_flash
64     redirect password_change_needed_redirect
65   end
66 end
require_http_basic_auth()
[show source]
   # File lib/rodauth/features/http_basic_auth.rb
27 def require_http_basic_auth
28   unless http_basic_auth
29     set_http_basic_auth_error_response
30     return_response
31   end
32 end
require_login()
[show source]
    # File lib/rodauth/features/base.rb
357 def require_login
358   login_required unless logged_in?
359 end
require_login_confirmation?()
[show source]
    # File lib/rodauth/features/verify_account.rb
159 def require_login_confirmation?
160   false
161 end
require_otp_setup()
[show source]
    # File lib/rodauth/features/otp.rb
234 def require_otp_setup
235   unless otp_exists?
236     set_redirect_error_status(two_factor_not_setup_error_status)
237     set_error_reason :two_factor_not_setup
238     set_redirect_error_flash two_factor_not_setup_error_flash
239     redirect two_factor_need_setup_redirect
240   end
241 end
require_password_authentication()
[show source]
   # File lib/rodauth/features/confirm_password.rb
51 def require_password_authentication
52   require_login
53 
54   if require_password_authentication? && has_password?
55     set_redirect_error_status(password_authentication_required_error_status)
56     set_error_reason :password_authentication_required
57     set_redirect_error_flash password_authentication_required_error_flash
58     set_session_value(confirm_password_redirect_session_key, request.fullpath)
59     redirect password_authentication_required_redirect
60   end
61 end
require_password_authentication?()
[show source]
   # File lib/rodauth/features/confirm_password.rb
87 def require_password_authentication?
88   return true if defined?(super) && super
89   !authenticated_by.include?('password')
90 end
require_response(meth)
[show source]
    # File lib/rodauth/features/base.rb
855 def require_response(meth)
856   send(meth)
857   raise RuntimeError, "#{meth.to_s.sub(/\A_/, '')} overridden without returning a response (should use redirect or request.halt). This is a bug in your Rodauth configuration, not a bug in Rodauth itself."
858 end
require_sms_available()
[show source]
    # File lib/rodauth/features/sms_codes.rb
337 def require_sms_available
338   require_sms_setup
339 
340   if sms_locked_out?
341     set_redirect_error_status(lockout_error_status)
342     set_error_reason :sms_locked_out
343     set_redirect_error_flash sms_lockout_error_flash
344     redirect sms_lockout_redirect
345   end
346 end
require_sms_not_setup()
[show source]
    # File lib/rodauth/features/sms_codes.rb
328 def require_sms_not_setup
329   if sms_setup?
330     set_redirect_error_status(sms_already_setup_error_status)
331     set_error_reason :sms_already_setup
332     set_redirect_error_flash sms_already_setup_error_flash
333     redirect sms_already_setup_redirect
334   end
335 end
require_sms_setup()
[show source]
    # File lib/rodauth/features/sms_codes.rb
319 def require_sms_setup
320   unless sms_setup?
321     set_redirect_error_status(two_factor_not_setup_error_status)
322     set_error_reason :sms_not_setup
323     set_redirect_error_flash sms_not_setup_error_flash
324     redirect sms_needs_setup_redirect
325   end
326 end
require_two_factor_authenticated()
[show source]
    # File lib/rodauth/features/two_factor_base.rb
167 def require_two_factor_authenticated
168   unless two_factor_authenticated?
169     if two_factor_auth_return_to_requested_location?
170       set_session_value(two_factor_auth_redirect_session_key, request.fullpath)
171     end
172     set_redirect_error_status(two_factor_need_authentication_error_status)
173     set_error_reason :two_factor_need_authentication
174     set_redirect_error_flash two_factor_need_authentication_error_flash
175     redirect two_factor_auth_required_redirect
176   end
177 end
require_two_factor_not_authenticated(auth_type = nil)
[show source]
    # File lib/rodauth/features/two_factor_base.rb
158 def require_two_factor_not_authenticated(auth_type = nil)
159   if two_factor_authenticated? || (auth_type && two_factor_login_type_match?(auth_type))
160     set_redirect_error_status(two_factor_already_authenticated_error_status)
161     set_error_reason :two_factor_already_authenticated
162     set_redirect_error_flash two_factor_already_authenticated_error_flash
163     redirect two_factor_already_authenticated_redirect
164   end
165 end
require_two_factor_setup()
[show source]
    # File lib/rodauth/features/two_factor_base.rb
146 def require_two_factor_setup
147   # Avoid database query if already authenticated via 2nd factor
148   return if two_factor_authenticated?
149 
150   return if uses_two_factor_authentication?
151 
152   set_redirect_error_status(two_factor_not_setup_error_status)
153   set_error_reason :two_factor_not_setup
154   set_redirect_error_flash two_factor_not_setup_error_flash
155   redirect two_factor_need_setup_redirect
156 end
require_webauthn_setup()
[show source]
    # File lib/rodauth/features/webauthn.rb
400 def require_webauthn_setup
401   unless webauthn_setup?
402     set_redirect_error_status(webauthn_not_setup_error_status)
403     set_error_reason :webauthn_not_setup
404     set_redirect_error_flash webauthn_not_setup_error_flash
405     redirect two_factor_need_setup_redirect
406   end
407 end
rescue_jwt_payload(_)
[show source]
    # File lib/rodauth/features/jwt.rb
137 def rescue_jwt_payload(_)
138   @jwt_payload = false
139 end
reset_password_email_recently_sent?()
[show source]
    # File lib/rodauth/features/reset_password.rb
213 def reset_password_email_recently_sent?
214   (email_last_sent = get_reset_password_email_last_sent) && (Time.now - email_last_sent < reset_password_skip_resend_email_within)
215 end
reset_password_key_insert_hash()
[show source]
    # File lib/rodauth/features/reset_password.rb
243 def reset_password_key_insert_hash
244   hash = {reset_password_id_column=>account_id, reset_password_key_column=>reset_password_key_value}
245   set_deadline_value(hash, reset_password_deadline_column, reset_password_deadline_interval)
246   hash
247 end
reset_single_session_key()
[show source]
   # File lib/rodauth/features/single_session.rb
22 def reset_single_session_key
23   if logged_in?
24     single_session_ds.update(single_session_key_column=>random_key)
25   end
26 end
response()
[show source]
    # File lib/rodauth/features/base.rb
152 def response
153   scope.response
154 end
retry_on_uniqueness_violation(&block)

This is used to avoid race conditions when using the pattern of inserting when an update affects no rows. In such cases, if a row is inserted between the update and the insert, the insert will fail with a uniqueness error, but retrying will work. It is possible for it to fail again, but only if the row is deleted before the update and readded before the insert, which is very unlikely to happen. In such cases, raising an exception is acceptable.

[show source]
    # File lib/rodauth/features/base.rb
801 def retry_on_uniqueness_violation(&block)
802   if raises_uniqueness_violation?(&block)
803     yield
804   end
805 end
return_json_response()
[show source]
    # File lib/rodauth/features/json.rb
175 def return_json_response
176   _return_json_response
177 end
return_response(body=nil)
[show source]
    # File lib/rodauth/features/base.rb
584 def return_response(body=nil)
585   response.write(body) if body
586   request.halt
587 end
route!()
[show source]
    # File lib/rodauth/features/base.rb
164 def route!
165   if meth = self.class.route_hash[request.remaining_path]
166     send(meth)
167   end
168 
169   nil
170 end
route_path(route, opts={})
[show source]
    # File lib/rodauth/features/base.rb
589 def route_path(route, opts={})
590   path  = "#{prefix}/#{route}"
591   path += "?#{Rack::Utils.build_nested_query(opts)}" unless opts.empty?
592   path
593 end
route_url(route, opts={})
[show source]
    # File lib/rodauth/features/base.rb
595 def route_url(route, opts={})
596   "#{base_url}#{route_path(route, opts)}"
597 end
save_account()
[show source]
    # File lib/rodauth/features/create_account.rb
100 def save_account
101   id = nil
102   raised = raises_uniqueness_violation?{id = db[accounts_table].insert(account)}
103 
104   if raised
105     set_login_requirement_error_message(:already_an_account_with_this_login, already_an_account_with_this_login_message)
106   end
107 
108   if id
109     account[account_id_column] ||= id
110   end
111 
112   id && !raised
113 end
send_email(email)
[show source]
   # File lib/rodauth/features/email_base.rb
36 def send_email(email)
37   email.deliver!
38 end
send_verify_login_change_email(login)
[show source]
    # File lib/rodauth/features/verify_login_change.rb
124 def send_verify_login_change_email(login)
125   send_email(create_verify_login_change_email(login))
126 end
serialize_audit_log_metadata(metadata)
[show source]
   # File lib/rodauth/features/audit_logging.rb
55 def serialize_audit_log_metadata(metadata)
56   metadata.to_json unless metadata.nil?
57 end
session()
[show source]
    # File lib/rodauth/features/base.rb
156 def session
157   scope.session
158 end
session_inactivity_deadline_condition()
[show source]
    # File lib/rodauth/features/active_sessions.rb
162 def session_inactivity_deadline_condition
163   if deadline = session_inactivity_deadline
164     Sequel[active_sessions_last_use_column] < Sequel.date_sub(Sequel::CURRENT_TIMESTAMP, seconds: deadline)
165   end
166 end
session_jwt()
[show source]
   # File lib/rodauth/features/jwt.rb
77 def session_jwt
78   JWT.encode(jwt_session_hash, jwt_secret, jwt_algorithm)
79 end
session_lifetime_deadline_condition()
[show source]
    # File lib/rodauth/features/active_sessions.rb
168 def session_lifetime_deadline_condition
169   if deadline = session_lifetime_deadline
170     Sequel[active_sessions_created_at_column] < Sequel.date_sub(Sequel::CURRENT_TIMESTAMP, seconds: deadline)
171   end
172 end
session_value()
[show source]
    # File lib/rodauth/features/base.rb
271 def session_value
272   session[session_key]
273 end
set_deadline_value(hash, column, interval)

This is needed on MySQL, which doesn’t support non constant defaults other than CURRENT_TIMESTAMP.

[show source]
    # File lib/rodauth/features/base.rb
837 def set_deadline_value(hash, column, interval)
838   if set_deadline_values?
839     # :nocov:
840     hash[column] = Sequel.date_add(Sequel::CURRENT_TIMESTAMP, interval)
841     # :nocov:
842   end
843 end
set_deadline_values?()
[show source]
    # File lib/rodauth/features/base.rb
667 def set_deadline_values?
668   db.database_type == :mysql
669 end
set_email_auth_email_last_sent()
[show source]
    # File lib/rodauth/features/email_auth.rb
115 def set_email_auth_email_last_sent
116    email_auth_ds.update(email_auth_email_last_sent_column=>Sequel::CURRENT_TIMESTAMP) if email_auth_email_last_sent_column
117 end
set_error_flash(message)
[show source]
    # File lib/rodauth/features/base.rb
341 def set_error_flash(message)
342   flash.now[flash_error_key] = message
343 end
set_error_reason(reason)
[show source]
    # File lib/rodauth/features/base.rb
655 def set_error_reason(reason)
656 end
set_expired()
[show source]
   # File lib/rodauth/features/account_expiration.rb
49 def set_expired
50   update_activity(account_id, account_activity_expired_column)
51   after_account_expiration
52 end
set_field_error(field, error)
[show source]
    # File lib/rodauth/features/base.rb
172 def set_field_error(field, error)
173   (@field_errors ||= {})[field] = error
174 end
set_http_basic_auth_error_response()
[show source]
   # File lib/rodauth/features/http_basic_auth.rb
74 def set_http_basic_auth_error_response
75   response.status = 401
76   response.headers["WWW-Authenticate"] = "Basic realm=\"#{http_basic_auth_realm}\""
77 end
set_jwt()
[show source]
    # File lib/rodauth/features/jwt.rb
158 def set_jwt
159   set_jwt_token(session_jwt)
160 end
set_jwt_refresh_token_hmac_session_key(token)
[show source]
    # File lib/rodauth/features/jwt_refresh.rb
196 def set_jwt_refresh_token_hmac_session_key(token)
197   if allow_refresh_with_expired_jwt_access_token?
198     key = _account_refresh_token_split(token).last
199     data = random_key
200     set_session_value(jwt_refresh_token_data_session_key, data)
201     set_session_value(jwt_refresh_token_hmac_session_key, compute_hmac(data + key))
202   end
203 end
set_jwt_token(token)
[show source]
   # File lib/rodauth/features/jwt.rb
89 def set_jwt_token(token)
90   response.headers['Authorization'] = token
91 end
set_last_password_entry()
[show source]
   # File lib/rodauth/features/password_grace_period.rb
44 def set_last_password_entry
45   set_session_value(last_password_entry_session_key, Time.now.to_i)
46 end
set_login_requirement_error_message(reason, message)
[show source]
    # File lib/rodauth/features/login_password_requirements_base.rb
124 def set_login_requirement_error_message(reason, message)
125   set_error_reason(reason)
126   @login_requirement_message = message
127 end
set_new_account_password(password)
[show source]
   # File lib/rodauth/features/create_account.rb
92 def set_new_account_password(password)
93   account[account_password_hash_column] = password_hash(password)
94 end
set_notice_flash(message)
[show source]
    # File lib/rodauth/features/base.rb
349 def set_notice_flash(message)
350   flash[flash_notice_key] = message
351 end
set_notice_now_flash(message)
[show source]
    # File lib/rodauth/features/base.rb
353 def set_notice_now_flash(message)
354   flash.now[flash_notice_key] = message
355 end
set_password(password)
[show source]
   # File lib/rodauth/features/disallow_password_reuse.rb
19 def set_password(password)
20   hash = super
21   add_previous_password_hash(hash)
22   hash
23 end
set_password_requirement_error_message(reason, message)
[show source]
    # File lib/rodauth/features/login_password_requirements_base.rb
103 def set_password_requirement_error_message(reason, message)
104   set_error_reason(reason)
105   @password_requirement_message = message
106 end
set_redirect_error_flash(message)
[show source]
    # File lib/rodauth/features/base.rb
345 def set_redirect_error_flash(message)
346   flash[flash_error_key] = message
347 end
set_redirect_error_status(status)

Don’t set an error status when redirecting in an error case, as a redirect status is needed.

[show source]
    # File lib/rodauth/features/base.rb
633 def set_redirect_error_status(status)
634 end
set_reset_password_email_last_sent()
[show source]
    # File lib/rodauth/features/reset_password.rb
195 def set_reset_password_email_last_sent
196    password_reset_ds.update(reset_password_email_last_sent_column=>Sequel::CURRENT_TIMESTAMP) if reset_password_email_last_sent_column
197 end
set_response_error_reason_status(reason, status)
[show source]
    # File lib/rodauth/features/base.rb
640 def set_response_error_reason_status(reason, status)
641   set_error_reason(reason)
642   set_response_error_status(status)
643 end
set_response_error_status(status)
[show source]
    # File lib/rodauth/features/base.rb
636 def set_response_error_status(status)
637   response.status = status
638 end
set_session_value(key, value)
[show source]
    # File lib/rodauth/features/base.rb
860 def set_session_value(key, value)
861   session[key] = value
862 end
set_single_session_key(data)
[show source]
   # File lib/rodauth/features/single_session.rb
94 def set_single_session_key(data)
95   data = compute_hmac(data) if hmac_secret
96   set_session_value(single_session_session_key, data)
97 end
set_title(title)
[show source]
    # File lib/rodauth/features/base.rb
335 def set_title(title)
336   if title_instance_variable
337     scope.instance_variable_set(title_instance_variable, title)
338   end
339 end
set_unlock_account_email_last_sent()
[show source]
    # File lib/rodauth/features/lockout.rb
236 def set_unlock_account_email_last_sent
237   account_lockouts_ds.update(account_lockouts_email_last_sent_column=>Sequel::CURRENT_TIMESTAMP) if account_lockouts_email_last_sent_column
238 end
set_verify_account_email_last_sent()
[show source]
    # File lib/rodauth/features/verify_account.rb
225 def set_verify_account_email_last_sent
226    verify_account_ds.update(verify_account_email_last_sent_column=>Sequel::CURRENT_TIMESTAMP) if verify_account_email_last_sent_column
227 end
setup_account_verification()
[show source]
    # File lib/rodauth/features/verify_account.rb
237 def setup_account_verification
238   generate_verify_account_key_value
239   create_verify_account_key
240   send_verify_account_email
241 end
show_lockout_page()
[show source]
    # File lib/rodauth/features/lockout.rb
275 def show_lockout_page
276   set_response_error_reason_status(:account_locked_out, lockout_error_status)
277   set_error_flash login_lockout_error_flash
278   return_response unlock_account_request_view
279 end
single_session_ds()
[show source]
    # File lib/rodauth/features/single_session.rb
 99 def single_session_ds
100   db[single_session_table].
101     where(single_session_id_column=>session_value)
102 end
skip_login_field_on_login?()
[show source]
    # File lib/rodauth/features/login.rb
115 def skip_login_field_on_login?
116   return false unless use_multi_phase_login?
117   valid_login_entered?
118 end
skip_password_field_on_login?()
[show source]
    # File lib/rodauth/features/login.rb
120 def skip_password_field_on_login?
121   return false unless use_multi_phase_login?
122   !valid_login_entered?
123 end
skip_status_checks?()
[show source]
   # File lib/rodauth/features/close_account.rb
84 def skip_status_checks?
85   false
86 end
sms_auth_message(code)
[show source]
    # File lib/rodauth/features/sms_codes.rb
399 def sms_auth_message(code)
400   "SMS authentication code for #{domain} is #{code}"
401 end
sms_available?()
[show source]
    # File lib/rodauth/features/sms_codes.rb
452 def sms_available?
453   sms_setup? && !sms_locked_out?
454 end
sms_code()
[show source]
    # File lib/rodauth/features/sms_codes.rb
431 def sms_code
432   sms[sms_code_column]
433 end
sms_code_issued_at()
[show source]
    # File lib/rodauth/features/sms_codes.rb
435 def sms_code_issued_at
436   convert_timestamp(sms[sms_issued_at_column])
437 end
sms_code_match?(code)
[show source]
    # File lib/rodauth/features/sms_codes.rb
348 def sms_code_match?(code)
349   return false unless sms_current_auth?
350   timing_safe_eql?(code, sms_code)
351 end
sms_codes_primary?()
[show source]
    # File lib/rodauth/features/sms_codes.rb
500 def sms_codes_primary?
501   (features & [:otp, :webauthn]).empty?
502 end
sms_confirm()
[show source]
    # File lib/rodauth/features/recovery_codes.rb
146 def sms_confirm
147   super if defined?(super)
148   auto_add_missing_recovery_codes
149 end
sms_confirm_failure()
[show source]
    # File lib/rodauth/features/sms_codes.rb
362 def sms_confirm_failure
363   sms_ds.delete
364 end
sms_confirm_message(code)
[show source]
    # File lib/rodauth/features/sms_codes.rb
403 def sms_confirm_message(code)
404   "SMS confirmation code for #{domain} is #{code}"
405 end
sms_confirmation_match?(code)
[show source]
    # File lib/rodauth/features/sms_codes.rb
353 def sms_confirmation_match?(code)
354   sms_needs_confirmation? && sms_code_match?(code)
355 end
sms_current_auth?()
[show source]
    # File lib/rodauth/features/sms_codes.rb
460 def sms_current_auth?
461   sms_code && sms_code_issued_at + sms_code_allowed_seconds > Time.now
462 end
sms_disable()
[show source]
    # File lib/rodauth/features/sms_codes.rb
357 def sms_disable
358   sms_ds.delete
359   @sms = nil
360 end
sms_ds()
[show source]
    # File lib/rodauth/features/sms_codes.rb
528 def sms_ds
529   db[sms_codes_table].where(sms_id_column=>session_value)
530 end
sms_failures()
[show source]
    # File lib/rodauth/features/sms_codes.rb
439 def sms_failures
440   sms[sms_failures_column]
441 end
sms_locked_out?()
[show source]
    # File lib/rodauth/features/sms_codes.rb
456 def sms_locked_out?
457   sms_failures >= sms_failure_limit
458 end
sms_needs_confirmation?()
[show source]
    # File lib/rodauth/features/sms_codes.rb
448 def sms_needs_confirmation?
449   sms && sms_failures.nil?
450 end
sms_needs_confirmation_notice_flash()
[show source]
    # File lib/rodauth/features/sms_codes.rb
407 def sms_needs_confirmation_notice_flash
408   sms_needs_confirmation_error_flash
409 end
sms_new_auth_code()
[show source]
    # File lib/rodauth/features/sms_codes.rb
508 def sms_new_auth_code
509   SecureRandom.random_number(10**sms_auth_code_length).to_s.rjust(sms_auth_code_length, "0")
510 end
sms_new_confirm_code()
[show source]
    # File lib/rodauth/features/sms_codes.rb
512 def sms_new_confirm_code
513   SecureRandom.random_number(10**sms_confirm_code_length).to_s.rjust(sms_confirm_code_length, "0")
514 end
sms_normalize_phone(phone)
[show source]
    # File lib/rodauth/features/sms_codes.rb
504 def sms_normalize_phone(phone)
505   phone.to_s.gsub(/\D+/, '')
506 end
sms_phone()
[show source]
    # File lib/rodauth/features/sms_codes.rb
427 def sms_phone
428   sms[sms_phone_column]
429 end
sms_record_failure()
[show source]
    # File lib/rodauth/features/sms_codes.rb
422 def sms_record_failure
423   update_sms(sms_failures_column=>Sequel.expr(sms_failures_column)+1)
424   sms[sms_failures_column] = sms_ds.get(sms_failures_column)
425 end
sms_remove_expired_confirm_code()
[show source]
    # File lib/rodauth/features/sms_codes.rb
415 def sms_remove_expired_confirm_code
416   db[sms_codes_table].
417     where(sms_id_column=>session_value, sms_failures_column => nil).
418     where(Sequel[sms_issued_at_column] < Sequel.date_sub(Sequel::CURRENT_TIMESTAMP, seconds: sms_confirm_deadline)).
419     delete
420 end
sms_remove_failures()
[show source]
    # File lib/rodauth/features/sms_codes.rb
373 def sms_remove_failures
374   return if sms_needs_confirmation?
375   update_hash_ds(sms, sms_ds.exclude(sms_failures_column => nil), sms_failures_column => 0, sms_code_column => nil)
376 end
sms_send(phone, message)
[show source]
    # File lib/rodauth/features/sms_codes.rb
516 def sms_send(phone, message)
517   raise NotImplementedError, "sms_send needs to be defined in the Rodauth configuration for SMS sending to work"
518 end
sms_send_auth_code()
[show source]
    # File lib/rodauth/features/sms_codes.rb
383 def sms_send_auth_code
384   code = sms_new_auth_code
385   sms_set_code(code)
386   sms_send(sms_phone, sms_auth_message(code))
387 end
sms_send_confirm_code()
[show source]
    # File lib/rodauth/features/sms_codes.rb
389 def sms_send_confirm_code
390   code = sms_new_confirm_code
391   sms_set_code(code)
392   sms_send(sms_phone, sms_confirm_message(code))
393 end
sms_set_code(code)
[show source]
    # File lib/rodauth/features/sms_codes.rb
411 def sms_set_code(code)
412  update_sms(sms_code_column=>code, sms_issued_at_column=>Sequel::CURRENT_TIMESTAMP)
413 end
sms_setup(phone_number)
[show source]
    # File lib/rodauth/features/sms_codes.rb
366 def sms_setup(phone_number)
367   # Cannot handle uniqueness violation here, as the phone number given may not match the
368   # one in the table.
369   sms_ds.insert(sms_id_column=>session_value, sms_phone_column=>phone_number, sms_failures_column => nil)
370   remove_instance_variable(:@sms) if instance_variable_defined?(:@sms)
371 end
sms_setup?()
[show source]
    # File lib/rodauth/features/sms_codes.rb
443 def sms_setup?
444   return false unless sms
445   !sms_needs_confirmation?
446 end
sms_valid_phone?(phone)
[show source]
    # File lib/rodauth/features/sms_codes.rb
395 def sms_valid_phone?(phone)
396   phone.length >= sms_phone_min_length
397 end
split_token(token)
[show source]
    # File lib/rodauth/features/base.rb
557 def split_token(token)
558   token.split(token_separator, 2)
559 end
template_path(page)
[show source]
    # File lib/rodauth/features/base.rb
766 def template_path(page)
767   File.join(File.dirname(__FILE__), '../../../templates', "#{page}.str")
768 end
throw_basic_auth_error(*args)
[show source]
   # File lib/rodauth/features/http_basic_auth.rb
79 def throw_basic_auth_error(*args)
80   set_http_basic_auth_error_response
81   throw_error(*args) 
82 end
throw_error(field, error)
[show source]
    # File lib/rodauth/features/base.rb
645 def throw_error(field, error)
646   set_field_error(field, error)
647   throw :rodauth_error
648 end
throw_error_reason(reason, status, field, message)
[show source]
    # File lib/rodauth/features/base.rb
658 def throw_error_reason(reason, status, field, message)
659   set_error_reason(reason)
660   throw_error_status(status, field, message)
661 end
throw_error_status(status, field, error)
[show source]
    # File lib/rodauth/features/base.rb
650 def throw_error_status(status, field, error)
651   set_response_error_status(status)
652   throw_error(field, error)
653 end
timing_safe_eql?(provided, actual)
[show source]
    # File lib/rodauth/features/base.rb
616 def timing_safe_eql?(provided, actual)
617   provided = provided.to_s
618   Rack::Utils.secure_compare(provided.ljust(actual.length), actual) && provided.length == actual.length
619 end
token_param_value(key)
[show source]
   # File lib/rodauth/features/email_base.rb
57 def token_param_value(key)
58   "#{account_id}#{token_separator}#{convert_email_token_key(key)}"
59 end
transaction(opts={}, &block)
[show source]
    # File lib/rodauth/features/base.rb
599 def transaction(opts={}, &block)
600   db.transaction(opts, &block)
601 end
translate(_key, default)
[show source]
    # File lib/rodauth/features/base.rb
239 def translate(_key, default)
240   # do not attempt to translate by default
241   default
242 end
two_factor_authenticate(type)
[show source]
    # File lib/rodauth/features/two_factor_base.rb
248 def two_factor_authenticate(type)
249   two_factor_update_session(type)
250   two_factor_remove_auth_failures
251   after_two_factor_authentication
252   require_response(:_two_factor_auth_response)
253 end
two_factor_authenticated?()
[show source]
    # File lib/rodauth/features/two_factor_base.rb
191 def two_factor_authenticated?
192   authenticated_by && authenticated_by.length >= 2
193 end
two_factor_authentication_setup?()
[show source]
    # File lib/rodauth/features/two_factor_base.rb
195 def two_factor_authentication_setup?
196   possible_authentication_methods.length >= 2
197 end
two_factor_login_type_match?(type)
[show source]
    # File lib/rodauth/features/two_factor_base.rb
205 def two_factor_login_type_match?(type)
206   authenticated_by && authenticated_by.include?(type)
207 end
two_factor_modifications_require_password?()
[show source]
    # File lib/rodauth/features/two_factor_base.rb
122 def two_factor_modifications_require_password?
123   modifications_require_password?
124 end
two_factor_password_match?(password)
[show source]
    # File lib/rodauth/features/two_factor_base.rb
183 def two_factor_password_match?(password)
184   if two_factor_modifications_require_password?
185     password_match?(password)
186   else
187     true
188   end
189 end
two_factor_remove()
[show source]
    # File lib/rodauth/features/otp.rb
224 def two_factor_remove
225   super
226   otp_remove
227 end
two_factor_remove_auth_failures()
[show source]
    # File lib/rodauth/features/otp.rb
229 def two_factor_remove_auth_failures
230   super
231   otp_remove_auth_failures
232 end
two_factor_remove_session(type)
[show source]
    # File lib/rodauth/features/two_factor_base.rb
261 def two_factor_remove_session(type)
262   authenticated_by.delete(type)
263   remove_session_value(two_factor_setup_session_key)
264   if authenticated_by.empty?
265     clear_session
266   end
267 end
two_factor_update_session(auth_type)
[show source]
    # File lib/rodauth/features/two_factor_base.rb
269 def two_factor_update_session(auth_type)
270   authenticated_by << auth_type
271   set_session_value(two_factor_setup_session_key, true)
272 end
unique_constraint_violation_class()

Work around jdbc/sqlite issue where it only raises ConstraintViolation and not UniqueConstraintViolation.

[show source]
    # File lib/rodauth/features/base.rb
819 def unique_constraint_violation_class
820   if db.adapter_scheme == :jdbc && db.database_type == :sqlite
821     # :nocov:
822     Sequel::ConstraintViolation
823     # :nocov:
824   else
825     Sequel::UniqueConstraintViolation
826   end
827 end
unlock_account()
[show source]
    # File lib/rodauth/features/lockout.rb
159 def unlock_account
160   transaction do
161     remove_lockout_metadata
162   end
163 end
unlock_account_email_recently_sent?()
[show source]
    # File lib/rodauth/features/lockout.rb
281 def unlock_account_email_recently_sent?
282   (email_last_sent = get_unlock_account_email_last_sent) && (Time.now - email_last_sent < unlock_account_skip_resend_email_within)
283 end
unverified_grace_period_expired?()
[show source]
   # File lib/rodauth/features/verify_account_grace_period.rb
92 def unverified_grace_period_expired?
93   return false unless expires_at = session[unverified_account_session_key]
94   expires_at.is_a?(Integer) && Time.now.to_i > expires_at
95 end
update_account(values, ds=account_ds)
[show source]
    # File lib/rodauth/features/base.rb
878 def update_account(values, ds=account_ds)
879   update_hash_ds(account, ds, values)
880 end
update_activity(account_id, *columns)
[show source]
    # File lib/rodauth/features/account_expiration.rb
113 def update_activity(account_id, *columns)
114   ds = account_activity_ds(account_id)
115   hash = {}
116   columns.each do |c|
117     hash[c] = Sequel::CURRENT_TIMESTAMP
118   end
119   if ds.update(hash) == 0
120     hash[account_activity_id_column] = account_id
121     hash[account_activity_last_activity_column] ||= Sequel::CURRENT_TIMESTAMP
122     hash[account_activity_last_login_column] ||= Sequel::CURRENT_TIMESTAMP
123     # It is safe to ignore uniqueness violations here, as a concurrent insert would also use current timestamps.
124     ignore_uniqueness_violation{ds.insert(hash)}
125   end
126 end
update_current_session?()
[show source]
    # File lib/rodauth/features/active_sessions.rb
181 def update_current_session?
182   !!session_inactivity_deadline
183 end
update_hash_ds(hash, ds, values)
[show source]
    # File lib/rodauth/features/base.rb
868 def update_hash_ds(hash, ds, values)
869   num = ds.update(values)
870   if num == 1
871     values.each do |k, v|
872       hash[k] = Sequel::CURRENT_TIMESTAMP == v ? Time.now : v
873     end
874   end
875   num
876 end
update_last_activity()
[show source]
   # File lib/rodauth/features/account_expiration.rb
43 def update_last_activity
44   if session_value
45     update_activity(session_value, account_activity_last_activity_column)
46   end
47 end
update_last_login()
[show source]
   # File lib/rodauth/features/account_expiration.rb
39 def update_last_login
40   update_activity(account_id, account_activity_last_login_column, account_activity_last_activity_column)
41 end
update_login(login)
[show source]
   # File lib/rodauth/features/change_login.rb
79 def update_login(login)
80   _update_login(login)
81 end
update_password_changed_at()
[show source]
   # File lib/rodauth/features/password_expiration.rb
52 def update_password_changed_at
53   ds = password_expiration_ds
54   if ds.update(password_expiration_changed_at_column=>Sequel::CURRENT_TIMESTAMP) == 0
55     # Ignoring the violation is safe here, since a concurrent insert would also set it to the
56     # current timestamp.
57     ignore_uniqueness_violation{ds.insert(password_expiration_id_column=>account_id)}
58   end
59 end
update_password_hash?()
[show source]
   # File lib/rodauth/features/update_password_hash.rb
18 def update_password_hash?
19   password_hash_cost != @current_password_hash_cost || @update_password_hash
20 end
update_session()
[show source]
   # File lib/rodauth/features/account_expiration.rb
72 def update_session
73   check_account_expiration
74   super
75 end
update_single_session_key()
[show source]
   # File lib/rodauth/features/single_session.rb
66 def update_single_session_key
67   key = random_key
68   set_single_session_key(key)
69   if single_session_ds.update(single_session_key_column=>key) == 0
70     # Don't handle uniqueness violations here.  While we could get the stored key from the
71     # database, it could lead to two sessions sharing the same key, which this feature is
72     # designed to prevent.
73     single_session_ds.insert(single_session_id_column=>session_value, single_session_key_column=>key)
74   end
75 end
update_sms(values)
[show source]
    # File lib/rodauth/features/sms_codes.rb
520 def update_sms(values)
521   update_hash_ds(sms, sms_ds, values)
522 end
use_database_authentication_functions?()
[show source]
    # File lib/rodauth/features/base.rb
671 def use_database_authentication_functions?
672   case db.database_type
673   when :postgres, :mysql, :mssql
674     true
675   else
676     # :nocov:
677     false
678     # :nocov:
679   end
680 end
use_date_arithmetic?()
[show source]
    # File lib/rodauth/features/active_sessions.rb
190 def use_date_arithmetic?
191   true
192 end
use_json?()
[show source]
   # File lib/rodauth/features/json.rb
60 def use_json?
61   json_request? || only_json?
62 end
use_jwt?()
[show source]
   # File lib/rodauth/features/jwt.rb
93 def use_jwt?
94   use_json?
95 end
use_multi_phase_login?()
[show source]
    # File lib/rodauth/features/email_auth.rb
156 def use_multi_phase_login?
157   true
158 end
use_request_specific_csrf_tokens?()
[show source]
    # File lib/rodauth/features/base.rb
682 def use_request_specific_csrf_tokens?
683   scope.opts[:rodauth_route_csrf] && scope.use_request_specific_csrf_tokens?
684 end
uses_two_factor_authentication?()
[show source]
    # File lib/rodauth/features/two_factor_base.rb
199 def uses_two_factor_authentication?
200   return false unless logged_in?
201   set_session_value(two_factor_setup_session_key, two_factor_authentication_setup?) unless session.has_key?(two_factor_setup_session_key)
202   session[two_factor_setup_session_key]
203 end
valid_jwt?()
[show source]
    # File lib/rodauth/features/jwt.rb
101 def valid_jwt?
102   !!(jwt_token && jwt_payload)
103 end
valid_login_entered?()
[show source]
    # File lib/rodauth/features/login.rb
125 def valid_login_entered?
126   @valid_login_entered
127 end
valid_new_webauthn_credential?(webauthn_credential)
[show source]
    # File lib/rodauth/features/webauthn.rb
314 def valid_new_webauthn_credential?(webauthn_credential)
315   # Hack around inability to override expected_origin
316   origin = webauthn_origin
317   webauthn_credential.response.define_singleton_method(:verify) do |expected_challenge, expected_origin = nil, **kw|
318     super(expected_challenge, expected_origin || origin, **kw)
319   end
320 
321   (challenge = param_or_nil(webauthn_setup_challenge_param)) &&
322     (hmac = param_or_nil(webauthn_setup_challenge_hmac_param)) &&
323     (timing_safe_eql?(compute_hmac(challenge), hmac) || (hmac_secret_rotation? && timing_safe_eql?(compute_old_hmac(challenge), hmac))) &&
324     webauthn_credential.verify(challenge)
325 end
valid_webauthn_credential_auth?(webauthn_credential)
[show source]
    # File lib/rodauth/features/webauthn.rb
367 def valid_webauthn_credential_auth?(webauthn_credential)
368   ds = webauthn_keys_ds.where(webauthn_keys_webauthn_id_column => webauthn_credential.id)
369   pub_key, sign_count = ds.get([webauthn_keys_public_key_column, webauthn_keys_sign_count_column])
370 
371   # Hack around inability to override expected_origin
372   origin = webauthn_origin
373   webauthn_credential.response.define_singleton_method(:verify) do |expected_challenge, expected_origin = nil, **kw|
374     super(expected_challenge, expected_origin || origin, **kw)
375   end
376 
377   (challenge = param_or_nil(webauthn_auth_challenge_param)) &&
378     (hmac = param_or_nil(webauthn_auth_challenge_hmac_param)) &&
379     (timing_safe_eql?(compute_hmac(challenge), hmac) || (hmac_secret_rotation? && timing_safe_eql?(compute_old_hmac(challenge), hmac))) &&
380     webauthn_credential.verify(challenge, public_key: pub_key, sign_count: sign_count) &&
381     ds.update(
382       webauthn_keys_sign_count_column => Integer(webauthn_credential.sign_count),
383       webauthn_keys_last_use_column => Sequel::CURRENT_TIMESTAMP
384     ) == 1
385 end
verified_account?()
[show source]
   # File lib/rodauth/features/verify_account_grace_period.rb
17 def verified_account?
18   logged_in? && !session[unverified_account_session_key]
19 end
verify_account()
[show source]
    # File lib/rodauth/features/verify_account.rb
171 def verify_account
172   update_account(account_status_column=>account_open_status_value) == 1
173 end
verify_account_check_already_logged_in()
[show source]
    # File lib/rodauth/features/verify_account.rb
273 def verify_account_check_already_logged_in
274   check_already_logged_in
275 end
verify_account_ds(id=account_id)
[show source]
    # File lib/rodauth/features/verify_account.rb
298 def verify_account_ds(id=account_id)
299   db[verify_account_table].where(verify_account_id_column=>id)
300 end
verify_account_email_recently_sent?()
[show source]
    # File lib/rodauth/features/verify_account.rb
253 def verify_account_email_recently_sent?
254   (email_last_sent = get_verify_account_email_last_sent) && (Time.now - email_last_sent < verify_account_skip_resend_email_within)
255 end
verify_account_email_resend()
[show source]
    # File lib/rodauth/features/verify_account.rb
175 def verify_account_email_resend
176   if @verify_account_key_value = get_verify_account_key(account_id)
177     set_verify_account_email_last_sent
178     send_verify_account_email
179     true
180   end
181 end
verify_account_key_insert_hash()
[show source]
    # File lib/rodauth/features/verify_account.rb
294 def verify_account_key_insert_hash
295   {verify_account_id_column=>account_id, verify_account_key_column=>verify_account_key_value}
296 end
verify_account_set_password?()
[show source]
   # File lib/rodauth/features/verify_account_grace_period.rb
29 def verify_account_set_password?
30   false
31 end
verify_account_view()
[show source]
  # File lib/rodauth/features/webauthn_verify_account.rb
7 def verify_account_view
8   webauthn_setup_view
9 end
verify_login_change()
[show source]
    # File lib/rodauth/features/verify_login_change.rb
112 def verify_login_change
113   unless res = _update_login(verify_login_change_new_login)
114     remove_verify_login_change_key
115   end
116 
117   res
118 end
verify_login_change_ds(id=account_id)
[show source]
    # File lib/rodauth/features/verify_login_change.rb
206 def verify_login_change_ds(id=account_id)
207   db[verify_login_change_table].where(verify_login_change_id_column=>id)
208 end
verify_login_change_email_body()
[show source]
    # File lib/rodauth/features/verify_login_change.rb
202 def verify_login_change_email_body
203   render('verify-login-change-email')
204 end
verify_login_change_key_insert_hash(login)
[show source]
    # File lib/rodauth/features/verify_login_change.rb
192 def verify_login_change_key_insert_hash(login)
193   hash = {verify_login_change_id_column=>account_id, verify_login_change_key_column=>verify_login_change_key_value, verify_login_change_login_column=>login}
194   set_deadline_value(hash, verify_login_change_deadline_column, verify_login_change_deadline_interval)
195   hash
196 end
verify_login_change_old_login()
[show source]
    # File lib/rodauth/features/verify_login_change.rb
140 def verify_login_change_old_login
141   account_ds.get(login_column)
142 end
view(page, title)
[show source]
    # File lib/rodauth/features/base.rb
414 def view(page, title)
415   set_title(title)
416   _view(:view, page)
417 end
webauthn_account_id()
[show source]
    # File lib/rodauth/features/webauthn.rb
453 def webauthn_account_id
454   session_value
455 end
webauthn_allow()
[show source]
    # File lib/rodauth/features/webauthn.rb
345 def webauthn_allow
346   account_webauthn_ids
347 end
webauthn_auth_additional_form_tags()
[show source]
   # File lib/rodauth/features/webauthn_login.rb
43 def webauthn_auth_additional_form_tags
44   if @webauthn_login
45     super.to_s + login_hidden_field
46   else
47     super
48   end
49 end
webauthn_auth_credential_from_form_submission()
[show source]
    # File lib/rodauth/features/webauthn.rb
465 def webauthn_auth_credential_from_form_submission
466   begin
467     webauthn_credential = WebAuthn::Credential.from_get(webauthn_auth_data)
468     unless valid_webauthn_credential_auth?(webauthn_credential)
469       throw_error_reason(:invalid_webauthn_auth_param, invalid_key_error_status, webauthn_auth_param, webauthn_invalid_auth_param_message)
470     end
471   rescue WebAuthn::SignCountVerificationError
472     handle_webauthn_sign_count_verification_error
473   rescue WebAuthn::Error, RuntimeError, NoMethodError
474     throw_error_reason(:invalid_webauthn_auth_param, invalid_field_error_status, webauthn_auth_param, webauthn_invalid_auth_param_message) 
475   end
476 
477   webauthn_credential
478 end
webauthn_auth_data()
[show source]
    # File lib/rodauth/features/webauthn.rb
480 def webauthn_auth_data
481   case auth_data = raw_param(webauthn_auth_param)
482   when String
483     begin
484       JSON.parse(auth_data)
485     rescue
486       throw_error_reason(:invalid_webauthn_auth_param, invalid_field_error_status, webauthn_auth_param, webauthn_invalid_auth_param_message) 
487     end
488   when Hash
489     auth_data
490   else
491     throw_error_reason(:invalid_webauthn_auth_param, invalid_field_error_status, webauthn_auth_param, webauthn_invalid_auth_param_message)
492   end
493 end
webauthn_auth_form_path()
[show source]
    # File lib/rodauth/features/webauthn.rb
247 def webauthn_auth_form_path
248   webauthn_auth_path
249 end
webauthn_authenticator_selection()
[show source]
    # File lib/rodauth/features/webauthn.rb
263 def webauthn_authenticator_selection
264   {'requireResidentKey' => false, 'userVerification' => webauthn_user_verification}
265 end
webauthn_credential_options_for_get()
[show source]
    # File lib/rodauth/features/webauthn.rb
327 def webauthn_credential_options_for_get
328   WebAuthn::Credential.options_for_get(
329     :allow => webauthn_allow,
330     :timeout => webauthn_auth_timeout,
331     :rp_id => webauthn_rp_id,
332     :user_verification => webauthn_user_verification,
333     :extensions => webauthn_extensions,
334   )
335 end
webauthn_extensions()
[show source]
    # File lib/rodauth/features/webauthn.rb
267 def webauthn_extensions
268   {}
269 end
webauthn_key_insert_hash(webauthn_credential)
[show source]
    # File lib/rodauth/features/webauthn.rb
444 def webauthn_key_insert_hash(webauthn_credential)
445   {
446     webauthn_keys_account_id_column => webauthn_account_id,
447     webauthn_keys_webauthn_id_column => webauthn_credential.id,
448     webauthn_keys_public_key_column => webauthn_credential.public_key,
449     webauthn_keys_sign_count_column => Integer(webauthn_credential.sign_count)
450   }
451 end
webauthn_keys_ds()
[show source]
    # File lib/rodauth/features/webauthn.rb
461 def webauthn_keys_ds
462   db[webauthn_keys_table].where(webauthn_keys_account_id_column => webauthn_account_id)
463 end
webauthn_login_options?()
[show source]
   # File lib/rodauth/features/webauthn_autofill.rb
59 def webauthn_login_options?
60   return true unless param_or_nil(login_param)
61   super
62 end
webauthn_login_verification_factor?(webauthn_credential)
[show source]
   # File lib/rodauth/features/webauthn_login.rb
70 def webauthn_login_verification_factor?(webauthn_credential)
71   webauthn_login_user_verification_additional_factor? &&
72     webauthn_credential.response.authenticator_data.user_verified? &&
73     uses_two_factor_authentication?
74 end
webauthn_origin()
[show source]
    # File lib/rodauth/features/webauthn.rb
341 def webauthn_origin
342   base_url
343 end
webauthn_remove_authenticated_session()
[show source]
    # File lib/rodauth/features/webauthn.rb
255 def webauthn_remove_authenticated_session
256   remove_session_value(authenticated_webauthn_id_session_key)
257 end
webauthn_rp_id()
[show source]
    # File lib/rodauth/features/webauthn.rb
349 def webauthn_rp_id
350   webauthn_origin.sub(/\Ahttps?:\/\//, '').sub(/:\d+\z/, '')
351 end
webauthn_rp_name()
[show source]
    # File lib/rodauth/features/webauthn.rb
353 def webauthn_rp_name
354   webauthn_rp_id
355 end
webauthn_setup?()
[show source]
    # File lib/rodauth/features/webauthn.rb
396 def webauthn_setup?
397   !webauthn_keys_ds.empty?
398 end
webauthn_setup_credential_from_form_submission()
[show source]
    # File lib/rodauth/features/webauthn.rb
495 def webauthn_setup_credential_from_form_submission
496   unless two_factor_password_match?(param(password_param))
497     throw_error_reason(:invalid_password, invalid_password_error_status, password_param, invalid_password_message)
498   end
499 
500   begin
501     webauthn_credential = WebAuthn::Credential.from_create(webauthn_setup_data)
502     unless valid_new_webauthn_credential?(webauthn_credential)
503       throw_error_reason(:invalid_webauthn_setup_param, invalid_field_error_status, webauthn_setup_param, webauthn_invalid_setup_param_message) 
504     end
505   rescue WebAuthn::Error, RuntimeError, NoMethodError
506     throw_error_reason(:invalid_webauthn_setup_param, invalid_field_error_status, webauthn_setup_param, webauthn_invalid_setup_param_message) 
507   end
508 
509   webauthn_credential
510 end
webauthn_setup_data()
[show source]
    # File lib/rodauth/features/webauthn.rb
512 def webauthn_setup_data
513   case setup_data = raw_param(webauthn_setup_param)
514   when String
515     begin
516       JSON.parse(setup_data)
517     rescue
518       throw_error_reason(:invalid_webauthn_setup_param, invalid_field_error_status, webauthn_setup_param, webauthn_invalid_setup_param_message) 
519     end
520   when Hash
521     setup_data
522   else
523     throw_error_reason(:invalid_webauthn_setup_param, invalid_field_error_status, webauthn_setup_param, webauthn_invalid_setup_param_message)
524   end
525 end
webauthn_update_session(webauthn_id)
[show source]
    # File lib/rodauth/features/webauthn.rb
259 def webauthn_update_session(webauthn_id)
260   set_session_value(authenticated_webauthn_id_session_key, webauthn_id)
261 end
webauthn_user_ids_ds()
[show source]
    # File lib/rodauth/features/webauthn.rb
457 def webauthn_user_ids_ds
458   db[webauthn_user_ids_table].where(webauthn_user_ids_account_id_column => webauthn_account_id)
459 end
webauthn_user_name()
[show source]
    # File lib/rodauth/features/webauthn.rb
337 def webauthn_user_name
338   account![login_column]
339 end
webauthn_user_verification()
[show source]
   # File lib/rodauth/features/webauthn_autofill.rb
24 def webauthn_user_verification
25   'preferred'
26 end