devise-two-factor 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 938b85d49e3435d3b68b2c9f2b1e6c9af8ca9757
-  data.tar.gz: 0fbb5330958d58752c38291640b9dfad48ce7ee6
+  metadata.gz: b71e31499a33b73bf9091ea49d750379c9a65445
+  data.tar.gz: 2d5600d12491430e2ba1053d31f0757fb7159141
 SHA512:
-  metadata.gz: 731403794ad7ae6ef5b1830c168696b7acd82236af741f82b9623e44696f2b29492b16a089735fdc44b384c28818366894c292f306798250813a067aad5b6cae
-  data.tar.gz: 858170aa39d456777fa6fe7e1c80503a67a7d48e4c4b715d1668fcd7f132c20deea4c04a2f1700cc6f97050e247ddf21234145339a3206bc82d9d70a37001c12
+  metadata.gz: bbe11caae0da8ea8a6fcbcd8b36592066c9fa73e027c1b67f0294d431219592623d832614e1db08c25f5bb39805e0945ba831996850934b2e191761a4cc06a44
+  data.tar.gz: 32ac8864fb19ad19a0d13514e1afb3eabcb2c7ffcddb329c8a801cc35e1598e4f0161fff6599ac7b24b89803d83e8220bf684e05f82ea745a3e3eca1f389d8c9

data/README.md

@@ -3,7 +3,7 @@ By [Tinfoil Security](http://tinfoilsecurity.com/)
 
 [![Build Status](https://travis-ci.org/tinfoil/devise-two-factor.svg?branch=master)](https://travis-ci.org/tinfoil/devise-two-factor)
 
-Devise-two-factor is a minimalist extension to Devise which offers support for two-factor authentication. It:
+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_Algorithm) scheme. It:
 
 * Allows you to incorporate two-factor authentication into your existing models
 * Is opinionated about security, so you don't have to be
@@ -11,17 +11,22 @@ 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
 
 ## Example App
-An example Rails 4 application is provided in demo/
-
-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.
+An example Rails 4 application is provided in demo/. 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`.
 
 ## 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.
 
 First, you'll need a Rails application setup with Devise. Visit the Devise [homepage](https://github.com/plataformatec/devise) for instructions.
 
-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.
+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: 
+
+```
+  devise :two_factor_authenticatable,
+         :otp_secret_encryption_key => ENV['YOUR_ENCRYPTION_KEY_HERE']
+
+```
 
 Finally, you can automate all of the required setup by simply running:
 
@@ -45,14 +50,14 @@ If you're running Rails 3, or do not have strong parameters enabled, the generat
 **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.**
 
 ## 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 importable to remember that this gem is intentionally very open-ended, and you should build a user experience which fits your individual application.
+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:
 
 1. Logging in with two-factor authentication
 2. Enabling two-factor authentication for a given user
 
-We chose to keep things as simple as possible, and our implemention can be found by registering at [Tinfoil Security](https://tinfoilsecurity.com/), and enabling two-factor authentication from the [security settings page](https://www.tinfoilsecurity.com/account/security).
+We chose to keep things as simple as possible, and our implementation can be found by registering at [Tinfoil Security](https://tinfoilsecurity.com/), and enabling two-factor authentication from the [security settings page](https://www.tinfoilsecurity.com/account/security).
 
 
 ### Logging In
@@ -64,6 +69,53 @@ 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 2FA requirement.
+
+Because of this, you need to override the controller and disable the automatic login on your own. If you don't use the ```recoverable``` strategy and don't provide the option of password resets, you don't need to worry about this. An example is as follows:
+
+```ruby
+# app/controllers/passwords_controller.rb
+class PasswordsController < Devise::PasswordsController
+  # Overrides to require a user to log in after resetting the password
+
+  def update
+    self.resource = resource_class.reset_password_by_token(resource_params)
+    yield resource if block_given?
+
+    if resource.errors.empty?
+      resource.unlock_access! if unlockable?(resource)
+      flash_message = resource.active_for_authentication? ? :updated : :updated_not_active
+      set_flash_message(:notice, flash_message) if is_flashing_format?
+
+      # Do not automatically login if two-factor is enabled for this user.
+      # Remove the following three lines entirely if you want to disable
+      # automatic login for all users regardless, after a password reset.
+      unless resource.try(:otp_required_for_login?)
+        sign_in(resource_name, resource)
+      end
+
+      respond_with resource, location: after_resetting_password_path_for(resource)
+    else
+      respond_with resource
+    end
+  end
+
+  protected
+
+  def after_resetting_password_path_for(resource)
+    new_session_path(resource)
+  end
+end
+```
+
+And then tell Devise to use your new controller instead of the default:
+
+```ruby
+# app/config/routes.rb
+devise_for :users, :controllers => {:passwords => "passwords"}
+```
+
 ### 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:
 
@@ -77,6 +129,14 @@ Before you can do this however, you need to decide how you're going to transmit
 
 At Tinfoil Security, we opted to use the excellent [rqrcode-rails3](https://github.com/samvincent/rqrcode-rails3) gem to generate a QR-code representing the user's secret key, which can then be scanned by any mobile two-factor authentication client.
 
+If you instead to decide to send the one-time password to the user directly, such as via SMS, you'll need a mechanism for generating the one-time password on the server:
+
+```ruby
+current_user.current_otp
+```
+
+The generated code will be valid for the duration specified by otp_allowed_drift.
+
 However you decide to handle enrollment, there are a few important considerations to be made:
 
 * Whether you'll force the use of two-factor authentication, and if so, how you'll migrate existing users to system, and what your onboarding experience will look like
@@ -146,7 +206,7 @@ Now just continue with the setup in the previous section, skipping the generator
 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
-require 'devise_two_factor/spec_helpers
+require 'devise_two_factor/spec_helpers'
 
 it_behaves_like "two_factor_authenticatable"
 it_behaves_like "two_factor_backupable"

data/devise-two-factor.gemspec

@@ -27,12 +27,12 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'rails' # For generators
   s.add_runtime_dependency 'activesupport'
   s.add_runtime_dependency 'activemodel'
-  s.add_runtime_dependency 'attr_encrypted'
-  s.add_runtime_dependency 'devise'
-  s.add_runtime_dependency 'rotp'
+  s.add_runtime_dependency 'attr_encrypted', '~> 1.3.2'
+  s.add_runtime_dependency 'devise',         '~> 3.2.4'
+  s.add_runtime_dependency 'rotp',           '~> 1.6.1'
 
-  s.add_development_dependency 'bundler',   '> 1.0'
-  s.add_development_dependency 'rspec',     '~> 2.8'
+  s.add_development_dependency 'bundler',    '> 1.0'
+  s.add_development_dependency 'rspec',      '~> 2.8'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'faker'
   s.add_development_dependency 'timecop'

data/lib/devise_two_factor/models/two_factor_authenticatable.rb

@@ -10,7 +10,7 @@ module Devise
 
       included do
         attr_encrypted :otp_secret, :key  => self.otp_secret_encryption_key,
-                                    :mode => :per_attribute_iv_and_salt
+                                    :mode => :per_attribute_iv_and_salt unless self.attr_encrypted?(:otp_secret)
 
         attr_accessor :otp_attempt
       end

data/lib/devise_two_factor/spec_helpers/two_factor_authenticatable_shared_examples.rb

@@ -41,22 +41,22 @@ shared_examples 'two_factor_authenticatable' do
 
     it 'validates a precisely correct OTP' do
       otp = ROTP::TOTP.new(otp_secret).at(Time.now)
-      subject.valid_otp?(otp).should be_true
+      subject.valid_otp?(otp).should be true
     end
 
     it 'validates an OTP within the allowed drift' do
       otp = ROTP::TOTP.new(otp_secret).at(Time.now + subject.class.otp_allowed_drift, true)
-      subject.valid_otp?(otp).should be_true
+      subject.valid_otp?(otp).should be true
     end
 
     it 'does not validate an OTP above the allowed drift' do
       otp = ROTP::TOTP.new(otp_secret).at(Time.now + subject.class.otp_allowed_drift * 2, true)
-      subject.valid_otp?(otp).should be_false
+      subject.valid_otp?(otp).should be false
     end
 
     it 'does not validate an OTP below the allowed drift' do
       otp = ROTP::TOTP.new(otp_secret).at(Time.now - subject.class.otp_allowed_drift * 2, true)
-      subject.valid_otp?(otp).should be_false
+      subject.valid_otp?(otp).should be false
     end
   end
 

data/lib/devise_two_factor/spec_helpers/two_factor_backupable_shared_examples.rb

@@ -56,14 +56,14 @@ shared_examples 'two_factor_backupable' do
 
     context 'given an invalid recovery code' do
       it 'returns false' do
-        subject.invalidate_otp_backup_code!('password').should be_false
+        subject.invalidate_otp_backup_code!('password').should be false
       end
     end
 
     context 'given a valid recovery code' do
       it 'returns true' do
         @plaintext_codes.each do |code|
-          subject.invalidate_otp_backup_code!(code).should be_true
+          subject.invalidate_otp_backup_code!(code).should be true
         end
       end
 
@@ -71,7 +71,7 @@ shared_examples 'two_factor_backupable' do
         code = @plaintext_codes.sample
 
         subject.invalidate_otp_backup_code!(code)
-        subject.invalidate_otp_backup_code!(code).should be_false
+        subject.invalidate_otp_backup_code!(code).should be false
       end
 
       it 'does not invalidate the other recovery codes' do
@@ -81,7 +81,7 @@ shared_examples 'two_factor_backupable' do
         @plaintext_codes.delete(code)
 
         @plaintext_codes.each do |code|
-          subject.invalidate_otp_backup_code!(code).should be_true
+          subject.invalidate_otp_backup_code!(code).should be true
         end
       end
     end

data/lib/devise_two_factor/version.rb

@@ -1,3 +1,3 @@
 module DeviseTwoFactor
-   VERSION = '1.0.0'.freeze
+   VERSION = '1.0.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devise-two-factor
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Shane Wilton
@@ -84,7 +84,7 @@ cert_chain:
   5C31v4YyRBnNCp0pN66nxYX2avEiQ8riTBP5mlkPPOhsIoYQHHe2Uj75aVpu0LZ3
   cdFzuO4GC1dV0Wv+dsDm+MyF7DT5E9pUPXpnMJuPvPrFpCb+wrFlszW9hGjXbQ==
   -----END CERTIFICATE-----
-date: 2014-05-20 00:00:00.000000000 Z
+date: 2015-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -132,44 +132,44 @@ dependencies:
   name: attr_encrypted
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.2
 - !ruby/object:Gem::Dependency
   name: devise
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.4
 - !ruby/object:Gem::Dependency
   name: rotp
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -300,3 +300,4 @@ test_files:
 - spec/devise/models/two_factor_authenticatable_spec.rb
 - spec/devise/models/two_factor_backupable_spec.rb
 - spec/spec_helper.rb
+has_rdoc: