devise_security_extension 0.7.2 → 0.10.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 861a1fcbcd16044ea27b948eafcf016c545d1260
+  data.tar.gz: b0282b6fc0a9f73a511acb11c7f37bd2892f0f84
+SHA512:
+  metadata.gz: c2b2c5cd49063826a3ea60490bb25d07632cb7c8adde652ec8a60f109e60a94ef9ac20e6a859fcc5567b087c6507f249e37bb739db7949cad85a9adb9be60048
+  data.tar.gz: f3ca889418be85fff8cd897de27de8f9555e2c21ca4527fe38cc62874a633ccff9110066e81edc0c3b6c6040b83792f6cb786f73a7020dfb939fe80ad847c4f6

data/.gitignore

@@ -0,0 +1,39 @@
+test/rails_app/log/*
+test/rails_app/tmp/*
+*~
+coverage/*
+*.sqlite3
+.bundle
+rdoc/*
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp
+
+log
+test/tmp/*
+*.gem

data/.rubocop.yml

@@ -0,0 +1,38 @@
+AllCops:
+  Include:
+    - '**/Rakefile'
+    - '**/config.ru'
+    - 'lib/tasks/**/*'
+  Exclude:
+    - Gemfile*
+    - 'db/**/*'
+    - 'config/**/*'
+    - 'bin/**/*'
+    - 'vendor/bundle/**/*'
+    - 'spec/support/**/*' # rspec support helpers have a strange api
+  RunRailsCops: true
+
+# We don't care about method length, since we check method cyclomatic
+# complexity.
+Metrics/MethodLength:
+  Enabled: false
+
+# Trailing commas make for clearer diffs because the last line won't appear
+# to have been changed, as it would if it lacked a comma and had one added.
+Style/TrailingComma:
+  EnforcedStyleForMultiline: comma
+
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    # Using `[]` for string arrays instead of `()`, since normal arrays are
+    # indicated with `[]` not `()`.
+    '%w': '[]'
+    '%W': '[]'
+
+Style/AndOr:
+  # Whether `and` and `or` are banned only in conditionals (conditionals)
+  # or completely (always).
+  # They read better, more like normal English.
+  Enabled: false

data/Gemfile

@@ -1,15 +1,2 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-gem "rails", ">= 3.1.1"
-gem "devise", ">= 2.0.0"
-
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "rails_email_validator"
-  gem "easy_captcha"
-  gem "bundler", ">= 1.0.0"
-  gem "jeweler", "~> 1.8.4"
-#  gem "rcov", ">= 0"
-end
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -1,43 +1,63 @@
+PATH
+  remote: .
+  specs:
+    devise_security_extension (0.10.0)
+      devise (>= 3.0.0, < 4.0)
+      railties (>= 3.2.6, < 5.0)
+
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    actionmailer (3.2.9)
-      actionpack (= 3.2.9)
-      mail (~> 2.4.4)
-    actionpack (3.2.9)
-      activemodel (= 3.2.9)
-      activesupport (= 3.2.9)
-      builder (~> 3.0.0)
+    actionmailer (4.2.5.1)
+      actionpack (= 4.2.5.1)
+      actionview (= 4.2.5.1)
+      activejob (= 4.2.5.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.5.1)
+      actionview (= 4.2.5.1)
+      activesupport (= 4.2.5.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.5.1)
+      activesupport (= 4.2.5.1)
+      builder (~> 3.1)
       erubis (~> 2.7.0)
-      journey (~> 1.0.4)
-      rack (~> 1.4.0)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.2.1)
-    activemodel (3.2.9)
-      activesupport (= 3.2.9)
-      builder (~> 3.0.0)
-    activerecord (3.2.9)
-      activemodel (= 3.2.9)
-      activesupport (= 3.2.9)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activeresource (3.2.9)
-      activemodel (= 3.2.9)
-      activesupport (= 3.2.9)
-    activesupport (3.2.9)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    arel (3.0.2)
-    bcrypt-ruby (3.0.1)
-    builder (3.0.4)
-    devise (2.1.2)
-      bcrypt-ruby (~> 3.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.5.1)
+      activesupport (= 4.2.5.1)
+      globalid (>= 0.3.0)
+    activemodel (4.2.5.1)
+      activesupport (= 4.2.5.1)
+      builder (~> 3.1)
+    activerecord (4.2.5.1)
+      activemodel (= 4.2.5.1)
+      activesupport (= 4.2.5.1)
+      arel (~> 6.0)
+    activesupport (4.2.5.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    ast (2.2.0)
+    bcrypt (3.1.10)
+    builder (3.2.2)
+    concurrent-ruby (1.0.0)
+    devise (3.5.6)
+      bcrypt (~> 3.0)
       orm_adapter (~> 0.1)
-      railties (~> 3.1)
-      warden (~> 1.2.1)
-    diff-lcs (1.1.3)
-    easy_captcha (0.5.1)
+      railties (>= 3.2.6, < 5)
+      responders
+      thread_safe (~> 0.1)
+      warden (~> 1.2.3)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    easy_captcha (0.6.5)
       bundler (>= 1.1.0)
       rails (>= 3.0.0)
       rmagick (>= 2.13.1)
@@ -45,89 +65,114 @@ GEM
       simplecov (>= 0.3.8)
       yard (>= 0.7.0)
     erubis (2.7.0)
-    git (1.2.5)
-    hike (1.2.1)
-    i18n (0.6.1)
-    jeweler (1.8.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-      rdoc
-    journey (1.0.4)
-    json (1.7.5)
-    mail (2.4.4)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.19)
-    multi_json (1.3.7)
-    orm_adapter (0.4.0)
-    polyglot (0.3.3)
-    rack (1.4.1)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-ssl (1.3.2)
-      rack
-    rack-test (0.6.2)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.99.1)
+    mini_portile2 (2.0.0)
+    minitest (5.8.4)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    orm_adapter (0.5.0)
+    parser (2.3.0.6)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rack (1.6.4)
+    rack-test (0.6.3)
       rack (>= 1.0)
-    rails (3.2.9)
-      actionmailer (= 3.2.9)
-      actionpack (= 3.2.9)
-      activerecord (= 3.2.9)
-      activeresource (= 3.2.9)
-      activesupport (= 3.2.9)
-      bundler (~> 1.0)
-      railties (= 3.2.9)
+    rails (4.2.5.1)
+      actionmailer (= 4.2.5.1)
+      actionpack (= 4.2.5.1)
+      actionview (= 4.2.5.1)
+      activejob (= 4.2.5.1)
+      activemodel (= 4.2.5.1)
+      activerecord (= 4.2.5.1)
+      activesupport (= 4.2.5.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.5.1)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
     rails_email_validator (0.1.4)
       activemodel (>= 3.0.0)
-    railties (3.2.9)
-      actionpack (= 3.2.9)
-      activesupport (= 3.2.9)
-      rack-ssl (~> 1.3.2)
+    railties (4.2.5.1)
+      actionpack (= 4.2.5.1)
+      activesupport (= 4.2.5.1)
       rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (>= 0.14.6, < 2.0)
-    rake (10.0.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    rmagick (2.13.1)
-    rspec-core (2.12.0)
-    rspec-expectations (2.12.0)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.0)
-    rspec-rails (2.12.0)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    simplecov (0.7.1)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.7.1)
-    simplecov-html (0.7.1)
-    sprockets (2.2.1)
-      hike (~> 1.2)
-      multi_json (~> 1.0)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    thor (0.16.0)
-    tilt (1.3.3)
-    treetop (1.4.12)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.35)
-    warden (1.2.1)
+      thor (>= 0.18.1, < 2.0)
+    rainbow (2.1.0)
+    rake (10.5.0)
+    responders (2.1.1)
+      railties (>= 4.2.0, < 5.1)
+    rmagick (2.15.4)
+    rspec-core (3.4.3)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-rails (3.4.2)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rubocop (0.37.2)
+      parser (>= 2.3.0.4, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 0.3)
+    ruby-progressbar (1.7.5)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    sprockets (3.5.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.0.3)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.11)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unicode-display_width (0.3.1)
+    warden (1.2.6)
       rack (>= 1.0)
-    yard (0.8.3)
+    yard (0.8.7.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (>= 1.0.0)
-  devise (>= 2.0.0)
-  easy_captcha
-  jeweler (~> 1.8.4)
-  rails (>= 3.1.1)
-  rails_email_validator
+  bundler (>= 1.3.0, < 2.0)
+  devise_security_extension!
+  easy_captcha (~> 0)
+  minitest
+  rails_email_validator (~> 0)
+  rubocop (~> 0)
+  sqlite3 (~> 1.3.10)
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -0,0 +1,264 @@
+# Devise Security Extension
+
+An enterprise security extension for [Devise](https://github.com/plataformatec/devise), trying to meet industrial standard security demands for web applications.
+
+It is composed of 7 additional Devise modules:
+
+* `:password_expirable` - passwords will expire after a configured time (and will need an update)
+* `:secure_validatable` - better way to validate a model (email, stronger password validation). Don't use with Devise `:validatable` module!
+* `:password_archivable` - save used passwords in an `old_passwords` table for history checks (don't be able to use a formerly used password)
+* `:session_limitable` - ensures, that there is only one session usable per account at once
+* `:expirable` - expires a user account after x days of inactivity (default 90 days)
+* `:security_questionable` - as accessible substitution for captchas (security question with captcha fallback)
+* `:paranoid_verification` - admin can generate verification code that user needs to fill in otherwise he wont be able to use the application.
+
+Configuration and database schema for each module below.
+
+## Additional features
+
+* **captcha support** for `sign_up`, `sign_in`, `recover` and `unlock` (to make automated mass creation and brute forcing of accounts harder)
+
+## Getting started
+
+Devise Security Extension works with Devise on Rails 3.2 onwards. You can add it to your Gemfile after you successfully set up Devise (see [Devise documentation](https://github.com/plataformatec/devise)) with:
+
+```ruby
+gem 'devise_security_extension'
+```
+
+Run the bundle command to install it.
+
+After you installed Devise Security Extension you need to run the generator:
+
+```console
+rails generate devise_security_extension:install
+```
+
+The generator adds optional configurations to `config/initializers/devise.rb`. Enable
+the modules you wish to use in the initializer you are ready to add Devise Security Extension modules on top of Devise modules to any of your Devise models:
+
+```ruby
+devise :password_expirable, :secure_validatable, :password_archivable, :session_limitable, :expirable
+```
+
+for `:secure_validatable` you need to add
+
+```ruby
+gem 'rails_email_validator'
+```
+
+## Configuration
+
+```ruby
+Devise.setup do |config|
+  # ==> Security Extension
+  # Configure security extension for devise
+
+  # Should the password expire (e.g 3.months)
+  # config.expire_password_after = 3.months
+
+  # Need 1 char of A-Z, a-z and 0-9
+  # config.password_regex = /(?=.*\d)(?=.*[a-z])(?=.*[A-Z])/
+
+  # Number of old passwords in archive
+  # config.password_archiving_count = 5
+
+  # Deny old password (true, false, count)
+  # config.deny_old_passwords = true
+
+  # captcha integration for recover form
+  # config.captcha_for_recover = true
+
+  # captcha integration for sign up form
+  # config.captcha_for_sign_up = true
+
+  # captcha integration for sign in form
+  # config.captcha_for_sign_in = true
+
+  # captcha integration for unlock form
+  # config.captcha_for_unlock = true
+
+  # security_question integration for recover form
+  # this automatically enables captchas (captcha_for_recover, as fallback)
+  # config.security_question_for_recover = false
+
+  # security_question integration for unlock form
+  # this automatically enables captchas (captcha_for_unlock, as fallback)
+  # config.security_question_for_unlock = false
+
+  # security_question integration for confirmation form
+  # this automatically enables captchas (captcha_for_confirmation, as fallback)
+  # config.security_question_for_confirmation = false
+
+  # ==> Configuration for :expirable
+  # Time period for account expiry from last_activity_at
+  # config.expire_after = 90.days
+end
+```
+
+## Captcha-Support
+The captcha support depends on [EasyCaptcha](https://github.com/phatworx/easy_captcha). See further documention there.
+
+### Installation
+
+1. Add EasyCaptcha to your `Gemfile` with
+```ruby
+gem 'easy_captcha'
+```
+2. Run the initializer
+```ruby
+rails generate easy_captcha:install
+```
+3. Enable captcha - see "Configuration" of Devise Security Extension above.
+4. Add the captcha in the generated devise views for each controller you have activated
+```erb
+<p><%= captcha_tag %></p>
+<p><%= text_field_tag :captcha %></p>
+```
+
+## Schema
+
+### Password expirable
+```ruby
+create_table :the_resources do |t|
+  # other devise fields
+
+  t.datetime :password_changed_at
+end
+add_index :the_resources, :password_changed_at
+```
+
+### Password archivable
+```ruby
+create_table :old_passwords do |t|
+  t.string :encrypted_password, :null => false
+  t.string :password_archivable_type, :null => false
+  t.integer :password_archivable_id, :null => false
+  t.datetime :created_at
+end
+add_index :old_passwords, [:password_archivable_type, :password_archivable_id], :name => :index_password_archivable
+```
+
+### Session limitable
+```ruby
+create_table :the_resources do |t|
+  # other devise fields
+
+  t.string :unique_session_id, :limit => 20
+end
+```
+
+### Expirable
+```ruby
+create_table :the_resources do |t|
+  # other devise fields
+
+  t.datetime :last_activity_at
+  t.datetime :expired_at
+end
+add_index :the_resources, :last_activity_at
+add_index :the_resources, :expired_at
+```
+
+### Paranoid verifiable
+```ruby
+create_table :the_resources do |t|
+  # other devise fields
+
+  t.string   :paranoid_verification_code
+  t.integer  :paranoid_verification_attempt, default: 0
+  t.datetime :paranoid_verified_at
+end
+add_index :the_resources, :paranoid_verification_code
+add_index :the_resources, :paranoid_verified_at
+```
+
+[Documentation for Paranoid Verifiable module]( https://github.com/phatworx/devise_security_extension/wiki/Paranoid-Verification)
+
+### Security questionable
+
+```ruby
+# app/models/security_question.rb
+class SecurityQuestion < ActiveRecord::Base
+  validates :locale, presence: true
+  validates :name, presence: true, uniqueness: true
+end
+```
+
+```ruby
+create_table :security_questions do |t|
+  t.string :locale, :null => false
+  t.string :name, :null => false
+end
+
+SecurityQuestion.create! locale: :de, name: 'Wie lautet der Geburstname Ihrer Mutter?'
+SecurityQuestion.create! locale: :de, name: 'Wo sind sie geboren?'
+SecurityQuestion.create! locale: :de, name: 'Wie lautet der Name Ihres ersten Haustieres?'
+SecurityQuestion.create! locale: :de, name: 'Was ist Ihr Lieblingsfilm?'
+SecurityQuestion.create! locale: :de, name: 'Was ist Ihr Lieblingsbuch?'
+SecurityQuestion.create! locale: :de, name: 'Was ist Ihr Lieblingstier?'
+SecurityQuestion.create! locale: :de, name: 'Was ist Ihr Lieblings-Reiseland?'
+```
+
+
+```ruby
+add_column :the_resources, :security_question_id, :integer
+add_column :the_resources, :security_question_answer, :string
+```
+
+or
+
+```ruby
+create_table :the_resources do |t|
+  # other devise fields
+
+  t.integer :security_question_id
+  t.string :security_question_answer
+end
+```
+
+## Requirements
+
+* Devise (https://github.com/plataformatec/devise)
+* Rails 3.2 onwards (http://github.com/rails/rails)
+* recommendations:
+  * `autocomplete-off` (http://github.com/phatworx/autocomplete-off)
+  * `easy_captcha` (http://github.com/phatworx/easy_captcha)
+  * `rails_email_validator` (http://github.com/phatworx/rails_email_validator)
+
+
+## Todo
+
+* see the github issues (feature requests)
+
+## History
+* 0.1 expire passwords
+* 0.2 strong password validation
+* 0.3 password archivable with validation
+* 0.4 captcha support for sign_up, sign_in, recover and unlock
+* 0.5 session_limitable module
+* 0.6 expirable module
+* 0.7 security questionable module for recover and unlock
+* 0.8 Support for Rails 4 (+ variety of patches)
+
+## Maintainers
+
+* Team Phatworx (https://github.com/phatworx)
+* Alexander Dreher (https://github.com/alexdreher)
+* Christoph Chilian (https://github.com/cc-web)
+* Marco Scholl (https://github.com/traxanos)
+* Thomas Powell (https://github.com/stringsn88keys)
+
+## Contributing to devise_security_extension
+
+* 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) 2011-2015 Marco Scholl. See LICENSE.txt for further details.