Skip to content

Latest commit

 

History

History
148 lines (101 loc) · 6.71 KB

README.md

File metadata and controls

148 lines (101 loc) · 6.71 KB
Raw

Devise Google Authenticator

This is a fork of the devise extension to allow your app to utilise Google Authenticator for Time-based One Time Passwords (TOTP).

The current version of this gem support Rails from version 4.2 (older versions are requiring older version of Ruby, which is hard to maintain), until version 6.1.x.
For more details see the .github/workflows/ci.yml file.

Installation

Add the gem to your Gemfile (don't forget devise too):

gem 'devise_gauth', '0.4.3'

Don't forget to "bundle install"

Before you can setup Devise Google Authenticator you need to setup Devise first.

Automatic Installation (Lets assume this is a bare bones app)

Run the following generator to add the necessary configuration options to Devise's config file:

rails g devise_google_authenticator:install

After you've created your Devise user models (which is usually done with a "rails g devise MODEL"), set up your Google Authenticator additions:

rails g devise_google_authenticator MODEL

Don't forget to migrate if you're NOT using Mongoid as your database ORM, Mongoid installations will have appropriate fields added to the model after the command above:

rake db:migrate

Installation With Existing Users

After the above steps have been performed, you'll need to generate secrets for each user:

 User.where(gauth_secret: nil).find_each do |user|
  user.send(:assign_auth_secret)
  user.save!
 end

By default, users won't need to perform two-factor authentication (gauth_enabled='0'). By visiting /MODEL/displayqr (eg: /users/displayqr) and submitting the form, two-factor authentication will then be turned on (gauth_enabled=1) and required for subsequent logins.

Configuration Options

The install generator adds some options to the end of your Devise config file (config/initializers/devise.rb)

  • config.ga_timeout - how long should the user be able to authenticate with their Google Authenticator token
  • config.ga_timedrift - a multiplier which provides for drift between a user's clock (and therefore their OTP) and the system clock. This should be fine at 3.
  • config.ga_remembertime - how long to remember the token for before requiring another. By default this is 1 month. To disable this setting change it to nil.
  • config.ga_appname - If you want to set a custom application name instead of using the name of the Rails app.
  • config.ga_bypass_signup - If you don't want to immediately forward newly registered or signed-up users to the Display QR page. If this is enabled, users will have to visit the /displayqr page to enable Google Authenticator.

Custom Views

If you want to customise your views (which you likely will want to, as they're pretty ugly right now), you can use the generator:

rails g devise_google_authenticator:views

Usage

With this extension enabled, the following is expected behaviour:

  • When a user registers, they are forwarded onto the Display QR page (unless ga_bypass_signup is set to true). This allows them to add their new "token" to their mobile device, and enable, or disable, the functionality. To enable/disable the functionality, the user has to enter the current token.
  • If users can't self-register, they're still able to visit this page by visiting /MODEL/displayqr (eg: /users/displayqr).
  • If the function is enabled (for that user), when they sign in, they'll be prompted for their password (as per normal), but then redirected into the Check QR page. They have to enter their token (from their device) to then successfully authenticate.
  • If configured (by default to 1 month), the user will only be prompted for the token every 1 month.

I18n

The install generator also installs an english copy of a Devise Google Authenticator i18n file. This can be modified (or used to create other language versions) and is located at: config/locales/devise.google_authenticator.en.yml

Testing

You can use Docker to build & run tests. To make it even more easier this project uses Earthly so that you can build the project's docker image with:

earthly +dev

Then you can run the tests using Docker Compose:

docker compose run --rm gem

Or you can run the tests like on the CI using Earthly (This reduces random failures between the CI and you environment):

earthly --allow-privileged +test

And in the case you'd like to test a different version of Ruby/Rails/Devise:

earthly --allow-privileged +test --EARTHLY_RUBY_VERSION=2.5 --EARTHLY_RAILS_VERSION=5.2.8.1 --EARTHLY_DEVISE_VERSION=4.8.1

Be careful when switching between Rails versions, don't forget to delete your local Gemfile.lock file in order to avoid gem issues.

Thanks (and unknown contributors)

This extension would not exist without the following other projects and associated authors (Whom I have turned to for inspiration and definitely have helped contributing by providing awesome Devise extensions. A lot of this code has been refactored from various sources, in particular these - in particular Sergio and Devise_invitable for his excellent unit test code):

Contributing to devise_gauth

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
  • Fork the project
  • Start a feature/bugfix branch
  • Commit and push until you are happy with your contribution
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright (c) 2014 Christian Frichot. See LICENSE.txt for further details.