devise-security 0.11.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b562461dba8b930f89dd68682f11d354a83f7a28
+  data.tar.gz: ffbac7216ea17728e7d483e846e63bfe773bbd8a
+SHA512:
+  metadata.gz: 6031c3ac9f30e9d09501d90d2f263a2600f4919dd79f0b99275b2be4a93732b8a5eddbadf6c95e6a9ba117932cfaba5357cdeb0036b34b2810909f2536eb269b
+  data.tar.gz: cd0a3386d268be89049f2fef0edf39b768d2b31b81335e79771d22b56c3575e34f23444b51a42006e0540b272df0602c323d35e60e31d06f1d916902633ae0a1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,38 @@
+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,42 @@
+AllCops:
+  Include:
+    - '**/Rakefile'
+    - '**/config.ru'
+    - 'lib/tasks/**/*'
+  Exclude:
+    - Gemfile*
+    - 'db/**/*'
+    - 'config/**/*'
+    - 'bin/**/*'
+    - 'vendor/bundle/**/*'
+    - 'spec/support/**/*' # rspec support helpers have a strange api
+
+Rails:
+  Enabled: 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/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInArguments:
+  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/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+before_install: gem install bundler && bundler -v
+install: bundle install --jobs=3 --retry=3
+before_script: bundle install
+script: bundle exec rake
+rvm:
+  - 2.1.8
+  - 2.2.4
+  - 2.3.4
+  - 2.4.1
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,199 @@
+PATH
+  remote: .
+  specs:
+    devise-security (0.11.0)
+      devise (>= 3.0.0, < 5.0)
+      railties (>= 3.2.6, < 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.1.3)
+      actionpack (= 5.1.3)
+      nio4r (~> 2.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.1.3)
+      actionpack (= 5.1.3)
+      actionview (= 5.1.3)
+      activejob (= 5.1.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.3)
+      actionview (= 5.1.3)
+      activesupport (= 5.1.3)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.3)
+      activesupport (= 5.1.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.1.3)
+      activesupport (= 5.1.3)
+      globalid (>= 0.3.6)
+    activemodel (5.1.3)
+      activesupport (= 5.1.3)
+    activerecord (5.1.3)
+      activemodel (= 5.1.3)
+      activesupport (= 5.1.3)
+      arel (~> 8.0)
+    activesupport (5.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    ast (2.3.0)
+    bcrypt (3.1.11)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    coveralls (0.8.21)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.14.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    devise (4.3.0)
+      bcrypt (~> 3.0)
+      orm_adapter (~> 0.1)
+      railties (>= 4.1.0, < 5.2)
+      responders
+      warden (~> 1.2.3)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    easy_captcha (0.6.5)
+      bundler (>= 1.1.0)
+      rails (>= 3.0.0)
+      rmagick (>= 2.13.1)
+      rspec-rails (>= 2.8.1)
+      simplecov (>= 0.3.8)
+      yard (>= 0.7.0)
+    erubi (1.6.1)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
+    i18n (0.8.6)
+    json (2.1.0)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.6)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.2.0)
+    minitest (5.10.3)
+    nio4r (2.1.0)
+    nokogiri (1.8.0)
+      mini_portile2 (~> 2.2.0)
+    orm_adapter (0.5.0)
+    parallel (1.12.0)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rack (2.0.3)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.1.3)
+      actioncable (= 5.1.3)
+      actionmailer (= 5.1.3)
+      actionpack (= 5.1.3)
+      actionview (= 5.1.3)
+      activejob (= 5.1.3)
+      activemodel (= 5.1.3)
+      activerecord (= 5.1.3)
+      activesupport (= 5.1.3)
+      bundler (>= 1.3.0)
+      railties (= 5.1.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    rails_email_validator (0.1.4)
+      activemodel (>= 3.0.0)
+    railties (5.1.3)
+      actionpack (= 5.1.3)
+      activesupport (= 5.1.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rainbow (2.2.2)
+      rake
+    rake (12.0.0)
+    responders (2.4.0)
+      actionpack (>= 4.2.0, < 5.3)
+      railties (>= 4.2.0, < 5.3)
+    rmagick (2.16.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-rails (3.6.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.13)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tins (1.15.0)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+    warden (1.2.7)
+      rack (>= 1.0)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+    yard (0.9.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.3.0, < 2.0)
+  coveralls (~> 0.8)
+  devise-security!
+  easy_captcha (~> 0)
+  minitest (~> 5.0)
+  rails_email_validator (~> 0)
+  rubocop (~> 0)
+  sqlite3 (~> 1.3, >= 1.3.10)
+
+BUNDLED WITH
+   1.15.3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Marco Scholl
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,263 @@
+# Devise Security
+
+[![Build Status](https://travis-ci.org/devise-security/devise-security.svg?branch=master)](https://travis-ci.org/devise-security/devise-security)
+
+A [Devise](https://github.com/plataformatec/devise) extension to add additional security features required by modern web applications. Forked from [Devise Security Extension](https://github.com/phatworx/devise_security_extension)
+
+It is composed of 7 additional Devise modules:
+
+* `:password_expirable` - passwords will expire after a configured time (and will need an update). You will most likely want to use `:password_expirable` together with the `:password_archivable` module to [prevent the current expired password being reused](https://github.com/phatworx/devise-security/issues/175) immediately as the new password.
+* `: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'
+```
+
+Run the bundle command to install it.
+
+After you installed Devise Security Extension you need to run the generator:
+
+```console
+rails generate devise-security: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 documentation 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/devise-security/devise-security/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)
+* 0.11 Support for Rails 5. Forked to allow project maintenance and features
+
+## Maintainers
+
+* Nate Bird (https://github.com/natebird)
+
+## Contributing to devise-security
+
+* 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-2017 Marco Scholl. See LICENSE.txt for further details.