devise-two-factor 4.1.1 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 787116f2d8fd1e2ef5a6e663c0a3ed5a65ca6110a491f44d2de5eb1a985da516
-  data.tar.gz: f379bef9da0239c3697fe14dad33ba6c662ecfd2b6bcc3ab54fb184f75a970d4
+  metadata.gz: 84d4fba8bbdcee4f8d8b00c5d2662dc5e8d78cc60e7f0502c7e0e9d5fc93a4d4
+  data.tar.gz: 33a77876910f588992917ebb123148f26d82b26fbe713f944e59f3b720c4978c
 SHA512:
-  metadata.gz: 23b55432e9df42fa8723db98cd38abe641656ed05ce6f5d9e5d7ee1a1179624ba7212209c460a7ff4b16d4f14347b11c69750d795e7ff9f56513e93af651c619
-  data.tar.gz: ce784140d65f12c6e46a51d86ed8e97edc6b98e706f276160e67f95bccf615c308a5cf273bd54ad71788b61e5dac92f9676c4e67ebfdd81c83584fa71e0bb509
+  metadata.gz: d2f69c9f760278e3a1a40d5913b786468d9d4d12b54e93dd5d5437cfb5edc669f21a56953ea817d66722cbe305190762dcb86cef80009a0fff718e86a39726be
+  data.tar.gz: e3086e4034e6208e064f81e5845b1027b5e7c19d38ddd4788c615fe1a837772f1330aba234a30fb3f7f9cc549dbed3864da9f70249aef04b9efa066c8284733c

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/workflows/ci.yml

@@ -12,29 +12,17 @@ jobs:
       fail-fast: false
       matrix:
         # Due to https://github.com/actions/runner/issues/849, we should quote versions
-        ruby: ['2.3', '2.4', '2.5', '2.6', '2.7', '3.0', 'truffleruby-head']
-        rails: ['4.1', '4.2', '5.0', '5.1', '5.2', '6.0', '6.1', '7.0']
+        ruby: ['3.1', '3.2', '3.3', 'truffleruby-head']
+        rails: ['7.0', '7.1', '7.2', '8.0']
         exclude:
-          - { ruby: '2.3', rails: '7.0' }
-          - { ruby: '2.4', rails: '7.0' }
-          - { ruby: '2.5', rails: '7.0' }
-          - { ruby: '2.6', rails: '7.0' }
-          - { ruby: '2.3', rails: '6.0' }
-          - { ruby: '2.3', rails: '6.1' }
-          - { ruby: '2.4', rails: '6.0' }
-          - { ruby: '2.4', rails: '6.1' }
-          - { ruby: '2.7', rails: '4.1' }
-          - { ruby: '2.7', rails: '4.2' }
-          - { ruby: '3.0', rails: '4.1' }
-          - { ruby: '3.0', rails: '4.2' }
-          - { ruby: 'truffleruby-head', rails: '4.1' }
-          - { ruby: 'truffleruby-head', rails: '4.2' }
+          - ruby: '3.1'
+            rails: '8.0'
 
     name: Ruby ${{ matrix.ruby }}, Rails ${{ matrix.rails }}
     env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
       BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/rails_${{ matrix.rails }}.gemfile
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/.github/workflows/push.yml

@@ -0,0 +1,28 @@
+name: Push Gem
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  deployment:
+    name: Push gem to RubyGems.org
+    environment: RubyGems
+    runs-on: ubuntu-latest
+
+    permissions:
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
+      contents: write # IMPORTANT: this permission is required for `rake release` to push the release tag
+
+    steps:
+      # Set up
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      # Release
+      - uses: rubygems/release-gem@v1

data/.markdownlint.json

@@ -0,0 +1,6 @@
+{
+  "MD026": false,
+  "MD029": false,
+  "MD031": false,
+  "MD034": false
+}

data/Appraisals

@@ -1,39 +1,19 @@
-appraise "rails-4.1" do
-  gem 'railties', '~> 4.1'
-  gem 'activesupport', '~> 4.1'
-end
-
-appraise "rails-4.2" do
-  gem 'railties', '~> 4.2'
-  gem 'activesupport', '~> 4.2'
-end
-
-appraise "rails-5.0" do
-  gem 'railties', '~> 5.0'
-  gem 'activesupport', '~> 5.0'
-end
-
-appraise "rails-5.1" do
-  gem 'railties', '~> 5.1'
-  gem 'activesupport', '~> 5.1'
-end
-
-appraise "rails-5.2" do
-  gem 'railties', '~> 5.2'
-  gem 'activesupport', '~> 5.2'
+appraise "rails-7.0" do
+  gem 'railties', '~> 7.0.0'
+  gem 'activesupport', '~> 7.0.0'
 end
 
-appraise "rails-6.0" do
-  gem 'railties', '~> 6.0'
-  gem 'activesupport', '~> 6.0'
+appraise "rails-7.1" do
+  gem 'railties', '~> 7.1.0'
+  gem 'activesupport', '~> 7.1.0'
 end
 
-appraise "rails-6.1" do
-  gem 'railties', '~> 6.1'
-  gem 'activesupport', '~> 6.1'
+appraise "rails-7.2" do
+  gem 'railties', '~> 7.2.0'
+  gem 'activesupport', '~> 7.2.0'
 end
 
-appraise "rails-7.0" do
-  gem 'railties', '~> 7.0'
-  gem 'activesupport', '~> 7.0'
+appraise "rails-8.0" do
+  gem 'railties', '~> 8.0.0'
+  gem 'activesupport', '~> 8.0.0'
 end

data/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 ## Unreleased
 
+## 6.0.0
+
+**Breaking Changes**
+- `otp_secret_length` and `otp_backup_code_length` options have changed to be the number of random bytes that are generated. See [UPGRADING.md](UPGRADING.md).
+- `consume_otp!` and `invalidate_otp_backup_code!` now call `save!` instead of `save`. See [UPGRADING.md](UPGRADING.md).
+
+## 5.1.0
+
+- Remove faker dev dependency
+- Insert two_factor_authenticatable at the top of the devise module list
+- README and CI improvements
+
+## 5.0.0
+
+**Breaking Changes**
+- attr_encrypted has been deprecated in favor of native Rails attribute encryption. See [UPGRADING.md](UPGRADING.md) for details on how to migrate your records. You **must** use or build a migration strategy (see examples in [UPGRADING.md](UPGRADING.md)) to use existing data!
+- Rails 7 is now required.
+
+## 4.1.0 / 4.1.1
+- Add support for attr_encrypted v4
+
 ## 4.0.2
 - Add Rails 7.0 support
 - Renew signing certificate

data/README.md

@@ -1,7 +1,6 @@
 # Devise-Two-Factor Authentication
-By [Tinfoil Security](https://www.tinfoilsecurity.com/) (acq. [Synopsys](https://www.synopsys.com/) 2020). Interested in [working with us](https://www.synopsys.com/careers.html)? We're hiring!
 
-![Build Status](https://github.com/tinfoil/devise-two-factor/actions/workflows/ci.yml/badge.svg)
+![Build Status](https://github.com/devise-two-factor/devise-two-factor/actions/workflows/ci.yml/badge.svg)
 
 Devise-Two-Factor is a minimalist extension to Devise which offers support for two-factor authentication, through the [TOTP](https://en.wikipedia.org/wiki/Time-based_One-Time_Password) scheme. It:
 
@@ -11,89 +10,109 @@ Devise-Two-Factor is a minimalist extension to Devise which offers support for t
 * Is extensible, and includes two-factor backup codes as an example of how plugins can be structured
 
 ## Contributing
+
 We welcome pull requests, bug reports, and other contributions. We're especially looking for help getting this gem fully compatible with Rails 5+ and squashing any deprecation messages.
 
 ## Example App
-An example Rails 4 application is provided in the `demo` directory. It showcases a minimal example of Devise-Two-Factor in action, and can act as a reference for integrating the gem into your own application.
 
-For the demo app to work, create an encryption key and store it as an environment variable. One way to do this is to create a file named `local_env.yml` in the application root. Set the value of `ENCRYPTION_KEY` in the YML file. That value will be loaded into the application environment by `application.rb`.
+See [examples](demo/README.md).
 
 ## Getting Started
-Devise-Two-Factor doesn't require much to get started, but there are a few prerequisites before you can start using it in your application.
+
+Devise-Two-Factor doesn't require much to get started, but there are two prerequisites before you can start using it in your application:
+
+1. A Rails application with [devise](https://github.com/heartcombo/devise) installed
+1. Secrets configured for ActiveRecord encrypted attributes
 
 First, you'll need a Rails application setup with Devise. Visit the Devise [homepage](https://github.com/plataformatec/devise) for instructions.
 
-You can add Devise-Two-Factor to your Gemfile with:
+Devise-Two-Factor uses [ActiveRecord encrypted attributes](https://edgeguides.rubyonrails.org/active_record_encryption.html). If you haven't already set up ActiveRecord encryption you must generate a key set and configure your application to use them either with Rails' encrypted credentials or from another source such as environment variables.
 
-```ruby
-gem 'devise-two-factor'
+```bash
+# Generates a random key set and outputs it to stdout
+./bin/rails db:encryption:init
 ```
 
-Next, since Devise-Two-Factor encrypts its secrets before storing them in the database, you'll need to generate an encryption key, and store it in an environment variable of your choice. Set the encryption key in the model that uses Devise:
-
-```ruby
-  devise :two_factor_authenticatable,
-         :otp_secret_encryption_key => ENV['YOUR_ENCRYPTION_KEY_HERE']
+You can load the key set using Rails' credentials.
 
+```bash
+# Copy the generated key set into your encrypted credentials file
+# Setting the EDITOR environment variable is optional, but without it your default editor will open
+EDITOR="code --wait" ./bin/rails credentials:edit
 ```
 
-Finally, you can automate all of the required setup by simply running:
+To learn more about credentials run `./bin/rails credentials:help`.
+
+Alternatively, you can configure your application with environment variables rather than Rails' credentials.
 
 ```ruby
-rails generate devise_two_factor MODEL ENVIRONMENT_VARIABLE
+# Copy the generate key set and set them as environment variables
+
+config.active_record.encryption.primary_key = ENV['ACTIVE_RECORD_ENCRYPTION_PRIMARY_KEY']
+config.active_record.encryption.deterministic_key = ENV['ACTIVE_RECORD_ENCRYPTION_DETERMINISTIC_KEY']
+config.active_record.encryption.key_derivation_salt = ENV['ACTIVE_RECORD_ENCRYPTION_KEY_DERIVATION_SALT']
 ```
 
-Where `MODEL` is the name of the model you wish to add two-factor functionality to (for example `user`), and `ENVIRONMENT_VARIABLE` is the name of the variable you're storing your encryption key in.
+Add Devise-Two-Factor to your Gemfile with:
 
-This generator will add a few columns to the specified model:
+```ruby
+# Gemfile
 
-* encrypted_otp_secret
-* encrypted_otp_secret_iv
-* encrypted_otp_secret_salt
-* consumed_timestep
-* otp_required_for_login
+gem 'devise-two-factor'
+```
 
-Remember to apply the new migration.
+There is a generator which automates most of the setup:
 
-```ruby
-bundle exec rake db:migrate
+```bash
+# MODEL is the name of the model you wish to configure devise_two_factor e.g. User or Admin
+./bin/rails generate devise_two_factor MODEL
 ```
 
-It also adds the `:two_factor_authenticatable` directive to your model, and sets up your encryption key. If present, it will remove `:database_authenticatable` from the model, as the two strategies are incompatible. Lastly, the generator will add a Warden config block to your Devise initializer, which enables the strategies required for two-factor authentication.
+Where `MODEL` is the name of the model you wish to add two-factor functionality to (for example `user`)
 
-If you're running Rails 3, or do not have strong parameters enabled, the generator will also setup the required mass-assignment security options in your model.
+This generator will:
 
-If you're running Rails 4, you'll also need to whitelist `:otp_attempt` as a permitted parameter in Devise `:sign_in` controller. You can do this by adding the following to your `application_controller.rb`:
+1. Create a new migration which adds a few columns to the specified model:
 
-```ruby
-before_action :configure_permitted_parameters, if: :devise_controller?
+    ```ruby
+    add_column :users, :otp_secret, :string
+    add_column :users, :consumed_timestep, :integer
+    add_column :users, :otp_required_for_login, :boolean
+    ```
 
-...
+1. Edit `app/models/MODEL.rb` (where MODEL is your model name):
+    * add the `:two_factor_authenticatable` devise module
+    * remove the `:database_authenticatable` if present because it is incompatible with `:two_factor_authenticatable`
+1. Add a Warden config block to your Devise initializer, which enables the strategies required for two-factor authentication.
 
-protected
+Remember to apply the new migration after you run the generator:
 
-def configure_permitted_parameters
-  devise_parameter_sanitizer.for(:sign_in) << :otp_attempt
-end
+```bash
+./bin/rails db:migrate
 ```
 
-If you're running Devise 4.0.0 or above, you'll want to use `.permit` instead:
+Next you need to whitelist `:otp_attempt` as a permitted parameter in Devise `:sign_in` controller. You can do this by adding the following to your `application_controller.rb`:
 
 ```ruby
-before_action :configure_permitted_parameters, if: :devise_controller?
+# app/controllers/application_controller.rb
 
-...
+  before_action :configure_permitted_parameters, if: :devise_controller?
 
-protected
+  # ...
 
-def configure_permitted_parameters
-  devise_parameter_sanitizer.permit(:sign_in, keys: [:otp_attempt])
-end
+  protected
+
+  def configure_permitted_parameters
+    devise_parameter_sanitizer.permit(:sign_in, keys: [:otp_attempt])
+  end
 ```
 
-**After running the generator, verify that `:database_authenticatable` is not being loaded by your model. The generator will try to remove it, but if you have a non-standard Devise setup, this step may fail. Loading both `:database_authenticatable` and `:two_factor_authenticatable` in a model will allow users to bypass two-factor authenticatable due to the way Warden handles cascading strategies.**
+Finally you should verify that `:database_authenticatable` is **not** being loaded by your model. The generator will try to remove it, but if you have a non-standard Devise setup, this step may fail.
+
+**Loading both `:database_authenticatable` and `:two_factor_authenticatable` in a model is a security issue** It will allow users to bypass two-factor authenticatable due to the way Warden handles cascading strategies!
 
 ## Designing Your Workflow
+
 Devise-Two-Factor only worries about the backend, leaving the details of the integration up to you. This means that you're responsible for building the UI that drives the gem. While there is an example Rails application included in the gem, it is important to remember that this gem is intentionally very open-ended, and you should build a user experience which fits your individual application.
 
 There are two key workflows you'll have to think about:
@@ -103,8 +122,8 @@ There are two key workflows you'll have to think about:
 
 We chose to keep things as simple as possible, and our implementation can be found by registering at [Tinfoil Security](https://www.tinfoilsecurity.com/), and enabling two-factor authentication from the [security settings page](https://www.tinfoilsecurity.com/account/security).
 
-
 ### Logging In
+
 Logging in with two-factor authentication works extremely similarly to regular database authentication in Devise. The `TwoFactorAuthenticatable` strategy accepts three parameters:
 
 1. email
@@ -114,11 +133,13 @@ Logging in with two-factor authentication works extremely similarly to regular d
 These parameters can be submitted to the standard Devise login route, and the strategy will handle the authentication of the user for you.
 
 ### Disabling Automatic Login After Password Resets
+
 If you use the Devise `recoverable` strategy, the default behavior after a password reset is to automatically authenticate the user and log them in. This is obviously a problem if a user has two-factor authentication enabled, as resetting the password would get around the two-factor requirement.
 
 Because of this, you need to set `sign_in_after_reset_password` to `false` (either globally in your Devise initializer or via `devise_for`).
 
 ### Enabling Two-Factor Authentication
+
 Enabling two-factor authentication for a user is easy. For example, if my user model were named User, I could do the following:
 
 ```ruby
@@ -149,6 +170,7 @@ current_user.current_otp
 ```
 
 The generated code will be valid for the duration specified by `otp_allowed_drift`. This value can be modified by adding a config in `config/initializers/devise.rb`.
+
 ```ruby
 Devise.otp_allowed_drift = 240 # value in seconds
 Devise.setup do |config|
@@ -165,13 +187,27 @@ However you decide to handle enrollment, there are a few important consideration
 It sounds like a lot of work, but most of these problems have been very elegantly solved by other people. We recommend taking a look at the excellent workflows used by Heroku and Google for inspiration.
 
 ### Filtering sensitive parameters from the logs
+
 To prevent two-factor authentication codes from leaking if your application logs get breached, you'll want to filter sensitive parameters from the Rails logs. Add the following to `config/initializers/filter_parameter_logging.rb`:
 
 ```ruby
 Rails.application.config.filter_parameters += [:otp_attempt]
 ```
 
+### Preventing Brute-Force Attacks
+
+With any authentication solution it is also important to protect your users from brute-force attacks. For Devise-Two-Factor specifically if a user's username and password have already been compromised an attacker would be able to try possible TOTP codes and see if they can hit a lucky collision to log in. While Devise-Two-Factor is open-ended by design and cannot solve this for all applications natively there are some possible mitigations to consider. A non-exhaustive list follows:
+
+1. Use the `lockable` strategy from Devise to lock a user after a certain number of failed login attempts. See https://www.rubydoc.info/github/heartcombo/devise/main/Devise/Models/Lockable for more information.
+2. Configure a rate limit for your application, especially on the endpoints used to log in. One such library to accomplish this is [rack-attack](https://rubygems.org/gems/rack-attack).
+3. When displaying authentication errors hide whether validating a username/password combination failed or a two-factor code failed behind a more generic error message.
+
+#### Acknowledgements
+
+Thank you to Christian Reitter (Radically Open Security) and Chris MacNaughton (Centauri Solutions) for reporting the issue.
+
 ## Backup Codes
+
 Devise-Two-Factor is designed with extensibility in mind. One such extension, `TwoFactorBackupable`, is included and serves as a good example of how to extend this gem. This plugin allows you to add the ability to generate single-use backup codes for a user, which they may use to bypass two-factor authentication, in the event that they lose access to their device.
 
 To install it, you need to add the `:two_factor_backupable` directive to your model.
@@ -186,17 +222,39 @@ You'll also be required to enable the `:two_factor_backupable` strategy, by addi
 manager.default_strategies(:scope => :user).unshift :two_factor_backupable
 ```
 
-The final installation step is dependent on your version of Rails. If you're not running Rails 4, skip to the next section. Otherwise, create the following migration:
+### Migration
+
+The final installation step may be dependent on your version of Rails.
+
+#### PostgreSQL
 
 ```ruby
 class AddDeviseTwoFactorBackupableToUsers < ActiveRecord::Migration
   def change
-    # Change type from :string to :text if using MySQL database
     add_column :users, :otp_backup_codes, :string, array: true
   end
 end
 ```
 
+#### MySQL
+
+```ruby
+# migration
+class AddDeviseTwoFactorBackupableToUsers < ActiveRecord::Migration
+  def change
+    add_column :users, :otp_backup_codes, :text
+  end
+end
+
+# model
+class User < ApplicationRecord
+  devise :two_factor_backupable
+  serialize :otp_backup_codes, Array
+end
+```
+
+### Generation
+
 You can then generate backup codes for a user:
 
 ```ruby
@@ -214,23 +272,8 @@ devise :two_factor_backupable, otp_backup_code_length:     32,
                                otp_number_of_backup_codes: 10
 ```
 
-### Help! I'm not using Rails 4.0!
-Don't worry! `TwoFactorBackupable` stores the backup codes as an array of strings in the database. In Rails 4.0 this is supported natively, but in earlier versions you can use a gem to emulate this behavior: we recommend [activerecord-postgres-array](https://github.com/tlconnor/activerecord-postgres-array).
-
-You'll then simply have to create a migration to add an array named `otp_backup_codes` to your model. If you use the above gem, this migration might look like:
-
-```ruby
-class AddTwoFactorBackupCodesToUsers < ActiveRecord::Migration
-  def change
-    # Change type from :string_array to :text_array if using MySQL database
-    add_column :users, :otp_backup_codes, :string_array
-  end
-end
-```
-
-Now just continue with the setup in the previous section, skipping the generator step.
-
 ## Testing
+
 Devise-Two-Factor includes shared-examples for both `TwoFactorAuthenticatable` and `TwoFactorBackupable`. Adding the following two lines to the specs for your two-factor enabled models will allow you to test your models for two-factor functionality:
 
 ```ruby
@@ -241,6 +284,7 @@ it_behaves_like "two_factor_backupable"
 ```
 
 ## Troubleshooting
+
 If you are using Rails 4.x and Ruby >= 2.7, you may get an error like
 
 ```
@@ -250,9 +294,11 @@ Failure/Error: require 'devise'
 NoMethodError:
   undefined method `new' for BigDecimal:Class
 ```
+
 see https://github.com/ruby/bigdecimal#which-version-should-you-select and https://github.com/ruby/bigdecimal/issues/127
 for more details, but you should be able to solve this
 by explicitly requiring an older version of bigdecimal in your gemfile like
-```
+
+```ruby
 gem "bigdecimal", "~> 1.4"
 ```

data/Rakefile

@@ -11,6 +11,8 @@ rescue Bundler::BundlerError => e
 end
 require 'rake'
 
+require 'bundler/gem_tasks'
+
 require 'rspec/core'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|

data/SECURITY.md

@@ -0,0 +1,5 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+Please report any vulnerabilities to the [Black Duck PSIRT](psirt@blackduck.com).