backup codes #10434
Draft
backup codes #10434
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
garyhtou
reviewed
May 15, 2025
Comment on lines
+7
to
+9
| default to: -> { | ||
| emails = @user.email_address_with_name | ||
| } |
There was a problem hiding this comment.
Suggested change
| default to: -> { | |
| emails = @user.email_address_with_name | |
| } | |
| default to: -> { @user.email_address_with_name } |
| @@ -59,7 +59,7 @@ class Login < ApplicationRecord | |||
| event :mark_complete do | |||
| transitions from: :incomplete, to: :complete do | |||
| guard do | |||
| authentication_factors_count == (user.use_two_factor_authentication? ? 2 : 1) | |||
| authentication_factors_count >= (user.use_two_factor_authentication? && !authenticated_with_backup_code ? 2 : 1) | |||
There was a problem hiding this comment.
Suggested change
| authentication_factors_count >= (user.use_two_factor_authentication? && !authenticated_with_backup_code ? 2 : 1) | |
| authentication_factors_count == (user.use_two_factor_authentication? ? 2 : 1) || authenticated_with_backup_code |
Comment on lines
+392
to
+408
| backup_codes.create!(hash: OpenSSL::KDF.pbkdf2_hmac(code + pepper, hash: "sha512", salt:, iterations: 20_000, length: 64).unpack1("H*"), salt: Base64.strict_encode64(salt)) | ||
| rescue ActiveRecord::RecordInvalid | ||
| # if the code is already in use, skip it | ||
| next | ||
| end | ||
| codes << code | ||
| end | ||
|
|
||
| codes | ||
| end | ||
|
|
||
| def redeem_backup_code(code) | ||
| found = nil | ||
| pepper = Credentials.fetch(:BACKUP_CODE_PEPPER) | ||
| # make sure we do not short circuit | ||
| unused_backup_codes.each do |backup_code| | ||
| hash = OpenSSL::KDF.pbkdf2_hmac(code + pepper, hash: "sha512", salt: Base64.decode64(backup_code.salt), iterations: 20_000, length: 64).unpack1("H*") |
There was a problem hiding this comment.
Create a class method on BackupCode for calculating a hash.
Comment on lines
+404
to
+412
| found = nil | ||
| pepper = Credentials.fetch(:BACKUP_CODE_PEPPER) | ||
| # make sure we do not short circuit | ||
| unused_backup_codes.each do |backup_code| | ||
| hash = OpenSSL::KDF.pbkdf2_hmac(code + pepper, hash: "sha512", salt: Base64.decode64(backup_code.salt), iterations: 20_000, length: 64).unpack1("H*") | ||
| if ActiveSupport::SecurityUtils.secure_compare(hash, backup_code.hash) | ||
| found = backup_code | ||
| end | ||
| end |
There was a problem hiding this comment.
If someone is brute forcing, the loop will already run its entirety. And is someone puts in a valid backup code, that means they've already gained access and we don't need to keep running the loop to prevent leaking timing information.
Let's instantly return when found.
Comment on lines
+415
to
+417
| found.transaction do | ||
| found.mark_used! | ||
| end |
There was a problem hiding this comment.
Since we're only doing one write here, we don't need a transaction
Suggested change
| found.transaction do | |
| found.mark_used! | |
| end | |
| found.mark_used! |
| end | ||
|
|
||
| def disable_backup_codes | ||
| backup_codes.where.not(aasm_state: [:used, :invalidated]).find_each &:mark_invalidated! |
There was a problem hiding this comment.
I'd suggest
def invalidate_backup_codes
backup_codes.where(aasm_state: :unsaved).destroy_all
backup_codes.where(aasm_state: :unused).find_each &:mark_invalidated!
end| create_table :user_backup_codes do |t| | ||
| t.references :user, null: false, foreign_key: true | ||
| t.string :aasm_state | ||
| t.text :hash, null: false |
| t.string :aasm_state | ||
| t.text :hash, null: false | ||
| t.text :salt, null: false | ||
| t.datetime :deleted_at |
There was a problem hiding this comment.
Drop acts as parnoid and this column
| transitions from: :unused, to: :used | ||
|
|
||
| after do | ||
| case user.backup_codes.where(aasm_state: :unused).count |
There was a problem hiding this comment.
Suggested change
| case user.backup_codes.where(aasm_state: :unused).count | |
| case user.backup_codes.unused.size |
| case user.backup_codes.where(aasm_state: :unused).count | ||
| when 0 | ||
| User::BackupCodeMailer.with(user_id: user.id).no_codes_remaining.deliver_now | ||
| when 1..2 |
There was a problem hiding this comment.
Suggested change
| when 1..2 | |
| when 1..3 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of the problem
Describe your changes