Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove the old otp_secret_encryption_key in the UPGRADING.md guide #242

Open
niklas-hasselmeyer opened this issue Jun 30, 2023 · 0 comments · May be fixed by #266
Open

Remove the old otp_secret_encryption_key in the UPGRADING.md guide #242

niklas-hasselmeyer opened this issue Jun 30, 2023 · 0 comments · May be fixed by #266

Comments

@niklas-hasselmeyer
Copy link

I noticed by chance that the gem doesn't read the :otp_secret_encryption_key configuration anymore.

$ rg otp_secret_encryption_key -C 3 lib/
lib/devise-two-factor.rb
13-  @@otp_allowed_drift = 30
14-
15-  # The key used to encrypt OTP secrets in the database in legacy installs.
16:  mattr_accessor :otp_secret_encryption_key
17:  @@otp_secret_encryption_key = nil
18-
19-  # These options are passed to the Rails 7+ encrypted attribute
20-  mattr_accessor :otp_encrypted_attribute_options

lib/devise_two_factor/models/two_factor_authenticatable.rb
91-        Devise::Models.config(self, :otp_secret_length,
92-                                    :otp_allowed_drift,
93-                                    :otp_encrypted_attribute_options,
94:                                    :otp_secret_encryption_key)
95-
96-        def generate_otp_secret(otp_secret_length = self.otp_secret_length)
97-          ROTP::Base32.random_base32(otp_secret_length)

The only reason why it can't be removed at all is its usage in the legacy_otp_secret method from the upgrading guide. But when that method is removed during the clean up phase, it should be mentioned that the otp_secret_encryption_key attribute can now be removed as well. This would keep us from carrying unused secrets in our config.
@kimesf kimesf linked a pull request Feb 28, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

add missing clean up step on the upgrading guide kimesf/devise-two-factor
1 participant
@niklas-hasselmeyer