devise_hacker_tracker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3765dd410d14455610636c11ef582d94d791d3a
+  data.tar.gz: 6ff4ef457e13ba10ee0bcf0cde49c498aebfd2a6
+SHA512:
+  metadata.gz: da982f88ac91828f8d8c487d810abd50d26db81d200fb42b305eaa03d74f094e34aa86e726f3d40e95fe155645fae83967683df85b3005b6e260b947fb902fac
+  data.tar.gz: d90cbd8a8c44fd19a4755955ae828f15d9304cb041046b5f77293d8c18f17dca467b6c1321355a5958480bbc7ac23c32a5311bd6cc600238f03f35a2c36a8861

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.4
+cache:
+  - apt
+  - bundler
+# With this, feature branches will only be built when a Pull Request is sent
+branches:
+  only:
+    - master
+    - develop
+    - /^release\/.*$/
+    - /^hotfix\/.*$/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in devise_hacker_tracker.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Abletech
+
+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,68 @@
+# DeviseHackerTracker
+Track failed attempts to sign in through devise.
+
+This can allow for increased security measures, such as locking sign in after multiple failed attempts on different accounts from a single IP address.
+
+## Requirements
+
+- Devise: follow the setup from their page [here](https://github.com/plataformatec/devise#getting-started)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'devise_hacker_tracker', :git => 'https://github.com/AbleTech/devise_hacker_tracker.git', branch: 'develop'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+To setup the gem and generate the relevant config additions and migrations, run:
+```bash
+$ rails generate devise_hacker_tracker sign_in_failures
+```
+- To change the name of the database table storing the failed sign in attempts, replace `sign_in_failures` with your preferred name
+- To use uuid as the index for the `sign_in_failures` table, add the flag `--enable-uuid`
+
+
+The generator will create the following new files
+- db/migrate/devise_create_sign_in_failures.rb
+- config/locales/devise_hacker_tracker.en.yml
+
+and also add some configuration options to config/initializers/devise.rb.
+
+Create the new `sign_in_failures` database table by running:
+```bash
+$ rake db:migrate
+```
+
+You can then prevent a user from signing in, if they have made too many attempts at different accounts, by adding the following code to your Devise sessions controller (you may need to create this controller if you haven't already. Follow the [devise explanation here](https://github.com/plataformatec/devise#configuring-controllers)). You can change the flash message and redirection path as appropriate for you application.
+
+```ruby
+class SessionsController < Devise::SessionsController
+
+  def create
+    if HackerTracker.hacker?(request.remote_ip)
+      set_flash_message :alert, :ip_blocked
+      redirect_to new_user_session_path
+    else
+      super
+    end
+  end
+
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/AbleTech/devise_hacker_tracker.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "devise_hacker_tracker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  devise:
+    sessions:
+      ip_blocked: "Sorry, your IP address has been temporarily blocked from signing in."

data/devise_hacker_tracker.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'devise_hacker_tracker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "devise_hacker_tracker"
+  spec.version       = DeviseHackerTracker::VERSION
+  spec.authors       = ["Dawn Richardson"]
+  spec.email         = ["dawn.richardson@abletech.co.nz"]
+
+  spec.summary       = %q{Track failed attempts to sign in through devise}
+  spec.description   = %q{Track failed attempts to sign in through devise to allow for increased security measures, such as locking sign in after failed attempts on several accounts from a single IP address.}
+  spec.homepage      = "https://github.com/AbleTech/devise_hacker_tracker"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency "factory_girl", "~> 4.5"
+  spec.add_development_dependency 'database_cleaner', "~> 1.4"
+  spec.add_development_dependency 'byebug', "~> 5"
+  spec.add_runtime_dependency 'devise', '>= 3.4.1'
+  spec.add_runtime_dependency 'rails', '~> 4.2.0'
+end

data/lib/devise_hacker_tracker/hooks/hacker_tracker.rb

@@ -0,0 +1,15 @@
+require 'warden'
+
+Warden::Manager.before_failure do |env, options|
+  if options.try(:[], :action) == "unauthenticated" && options.has_key?(:recall)
+    request = ActionDispatch::Request.new(env)
+
+    attributes = { ip_address: request.remote_ip, user_agent: request.user_agent }
+    authentication_values =  request.params.try(:[], options.try(:[], :scope))
+
+    Devise.authentication_keys.each do |key|
+      attributes = attributes.merge(key => authentication_values.try(:[], key))
+    end
+    SignInFailure.create!(attributes)
+  end
+end

data/lib/devise_hacker_tracker/models/hacker_tracker.rb

@@ -0,0 +1,22 @@
+require 'devise_hacker_tracker/models/sign_in_failure'
+
+module HackerTracker
+
+  def self.hacker?(ip_address)
+    SignInFailure.clear_outdated!
+
+    failures = SignInFailure.recent.where(ip_address: ip_address)
+    too_many_attempts?(failures) && too_many_accounts_tried?(failures)
+  end
+
+  private
+
+  def self.too_many_attempts?(failures)
+    failures.size >= Devise.maximum_attempts_per_ip
+  end
+
+  def self.too_many_accounts_tried?(failures)
+    failures.distinct.count(*Devise.authentication_keys) >= Devise.maximum_accounts_attempted
+  end
+
+end

data/lib/devise_hacker_tracker/models/sign_in_failure.rb

@@ -0,0 +1,14 @@
+require 'active_record'
+
+class SignInFailure < ActiveRecord::Base
+  def self.table_name
+    Devise.sign_in_failures_table_name
+  end
+
+  scope :recent, -> { where("created_at > '#{Devise.ip_block_time.ago.utc}'") }
+  scope :outdated, -> { where("created_at <= '#{Devise.ip_block_time.ago.utc}'") }
+
+  def self.clear_outdated!
+    outdated.destroy_all
+  end
+end

data/lib/devise_hacker_tracker/version.rb

@@ -0,0 +1,3 @@
+module DeviseHackerTracker
+  VERSION = "0.1.0"
+end

data/lib/devise_hacker_tracker.rb

@@ -0,0 +1,20 @@
+require 'devise'
+
+module Devise
+  mattr_accessor :ip_block_time
+  @@ip_block_time = 5.minutes
+
+  mattr_accessor :maximum_attempts_per_ip
+  @@maximum_attempts_per_ip = 5
+
+  mattr_accessor :maximum_accounts_attempted
+  @@maximum_accounts_attempted = 3
+
+  mattr_accessor :sign_in_failures_table_name
+  @@sign_in_failures_table_name = 'sign_in_failures'
+
+end
+
+require "devise_hacker_tracker/version"
+require 'devise_hacker_tracker/hooks/hacker_tracker'
+require 'devise_hacker_tracker/models/hacker_tracker'

data/lib/generators/devise_hacker_tracker_generator.rb

@@ -0,0 +1,47 @@
+require 'rails/generators/active_record'
+
+class DeviseHackerTrackerGenerator < ActiveRecord::Generators::Base
+  source_root File.expand_path("../templates", __FILE__)
+
+  desc "Generates a model and migration with the given NAME to store failed sign in attempts and adds to the devise configuration."
+
+  class_option :uuid, desc: "Enable uuid as the index for NAME table", type: :boolean, default: false
+
+  def setup_hacker_tracker_configuration
+    devise_initializer_path = "config/initializers/devise.rb"
+    if File.exist?(devise_initializer_path)
+      old_content = File.read(devise_initializer_path)
+
+      if old_content.match(Regexp.new(/^\s# ==> Configuration for :hacker_tracker\n/))
+        false
+      else
+        inject_into_file(devise_initializer_path, :before => "  # ==> Configuration for :confirmable\n") do
+" # ==> Configuration for :hacker_tracker
+  # Amount of time an IP address stays blocked for
+  # config.ip_block_time = 5.minutes
+  #
+  # Total number of failed sign in attempts allowed per IP address before being blocked
+  # config.maximum_attempts_per_ip = #{Devise.maximum_attempts_per_ip}
+  #
+  # Total number accounts a single IP address is allowed to attempt before being blocked
+  # config.maximum_accounts_attempted = #{Devise.maximum_accounts_attempted}
+  #
+  # The name of the table storing the failed sign in attempts
+  config.sign_in_failures_table_name = '#{table_name}'
+
+"
+        end
+      end
+    end
+  end
+
+  def setup_hacker_tracker_locales
+    copy_file "../../../config/locales/en.yml", "config/locales/devise_hacker_tracker.en.yml"
+  end
+
+  def create_hacker_tracker_migration
+    @uuid_enabled = options.uuid
+    migration_template "migration.rb", "db/migrate/devise_create_#{table_name}.rb"
+  end
+
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,11 @@
+class DeviseCreate<%= table_name.camelcase %> < ActiveRecord::Migration
+  def change
+    create_table(:<%= table_name %><%= ", id: :uuid" if @uuid_enabled %>) do |t|
+<% Devise.authentication_keys.each { |key| %><%= "\n      t.string :#{key}" %><% } %>
+      t.string :ip_address
+      t.string :user_agent
+
+      t.timestamps null: false
+    end
+  end
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: devise_hacker_tracker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dawn Richardson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+description: Track failed attempts to sign in through devise to allow for increased
+  security measures, such as locking sign in after failed attempts on several accounts
+  from a single IP address.
+email:
+- dawn.richardson@abletech.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/locales/en.yml
+- devise_hacker_tracker.gemspec
+- lib/devise_hacker_tracker.rb
+- lib/devise_hacker_tracker/hooks/hacker_tracker.rb
+- lib/devise_hacker_tracker/models/hacker_tracker.rb
+- lib/devise_hacker_tracker/models/sign_in_failure.rb
+- lib/devise_hacker_tracker/version.rb
+- lib/generators/devise_hacker_tracker_generator.rb
+- lib/generators/templates/migration.rb
+homepage: https://github.com/AbleTech/devise_hacker_tracker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Track failed attempts to sign in through devise
+test_files: []