image_authentication 0.1.0

data/app/assets/stylesheets/image_authentication/image_authentication.scss

@@ -0,0 +1,20 @@
+.image-authentication {
+  width: 730px;
+}
+
+#auth-images {
+  margin: 0 auto;
+  border-collapse: collapse;
+
+  td {
+    padding: 5px;
+  }
+
+  img {
+    border: 3px solid #f1f1f1;
+  }
+
+  img.selected {
+    border: 3px solid #66cc33;
+  }
+}

data/app/controllers/devise/image_authentication_controller.rb

@@ -0,0 +1,92 @@
+class Devise::ImageAuthenticationController < DeviseController
+
+  prepend_before_filter :authenticate_scope!
+  before_filter :prepare_and_validate, :handle_image_authentication
+  before_filter :setup_auth_categories, :only => [ :confirm, :show ]
+
+  def enable
+    @auth_categories = resource.all_auth_categories
+
+    if request.get?
+      session["user_return_to"] = request.referer
+    else
+      if params[:image_auth_categories] && params[:image_auth_categories].size == resource.class.maximum_categories
+        resource.auth_categories = params[:image_auth_categories]
+        resource.save
+        
+        setup_auth_categories
+
+        render :action => 'confirm'
+      else
+        render :action => 'enable'
+      end
+    end
+  end
+
+  def confirm
+    if resource.valid_images?(params[:image_auth_categories])
+      resource.image_authentication_enabled = true
+      resource.save
+
+      redirect_to session["user_return_to"]
+    else
+      render :action => 'confirm'
+    end
+  end
+
+  def disable
+    resource.auth_categories_mask         = nil
+    resource.image_authentication_enabled = false
+    resource.save
+
+    redirect_to :back
+  end
+
+  def show
+    return redirect_to :back if !resource.image_authentication_enabled?
+  end
+
+  def update
+    if resource.valid_images?(params[:image_auth_categories])
+      warden.session(resource_name)[:requires_image_authentication] = false
+      sign_in resource_name, resource, :bypass => true
+
+      redirect_to session["user_return_to"]
+    else
+      resource.failed_attempts += 1
+      resource.save
+
+      if resource.max_login_attempts?
+        sign_out(resource)
+        resource.lock_access!
+
+        render :action => 'locked'
+      else
+        setup_auth_categories
+
+        render :action => 'show'
+      end
+    end
+  end
+
+  private
+
+    def authenticate_scope!
+      self.resource = send("current_#{resource_name}")
+    end
+
+    def prepare_and_validate
+      redirect_to :root and return if resource.nil?
+
+      if resource.max_login_attempts?
+        sign_out(resource)
+        resource.lock_access!
+        render :action => 'locked'
+      end
+    end
+
+    def setup_auth_categories
+      @auth_categories = resource.all_auth_categories
+    end
+
+end

data/app/views/devise/image_authentication/_image_grid.html.erb

@@ -0,0 +1,11 @@
+<table id="auth-images">
+  <% @auth_categories.in_groups_of(Math.sqrt(@auth_categories.size).ceil, false) do |group| %>
+    <tr>
+      <% group.each do |cat| %>
+        <td>
+          <%= image_tag("image_authentication/#{cat}/#{rand(1..20)}.png", :class => cat) %>
+        </td>
+      <% end %>
+    </tr>
+  <% end %>
+</table>

data/app/views/devise/image_authentication/confirm.html.erb

@@ -0,0 +1,13 @@
+<div class="image-authentication">
+  <h2><%= t(:please_confirm_your_selection) %></h2>
+
+  <%= render :partial => "devise/image_authentication/image_grid" %>
+
+  <%= form_for(resource, :url => confirm_user_image_authentication_url, :html => { :id => 'auth-form' }) do |form| %>
+    <fieldset></fieldset>
+
+    <div class="form-actions">
+      <%= submit_tag("Confirm Selection", :class => 'btn btn-success') %>
+    </div>
+  <% end %>
+</div>

data/app/views/devise/image_authentication/enable.html.erb

@@ -0,0 +1,14 @@
+<div class="image-authentication">
+  <h2><%= t(:please_choose_your_images) %></h2>
+  <h3><%= t(:choose_a_maximum_of, :count => User.maximum_categories) %></h3>
+
+  <%= render :partial => "devise/image_authentication/image_grid" %>
+
+  <%= form_for(resource, :url => enable_user_image_authentication_url, :html => { :id => 'auth-form', :method => :put }) do |form| %>
+    <fieldset></fieldset>
+
+    <div class="form-actions">
+      <%= submit_tag(t(:confirm_selection), :class => 'btn btn-success') %>
+    </div>
+  <% end %>
+</div>

data/app/views/devise/image_authentication/locked.html.erb

@@ -0,0 +1,8 @@
+<div class="external-user-session">
+  <h2><%= t(:your_account_has_now_been_locked) %></h2>
+
+  <div class="form-actions">
+    <%= link_to "Visit Homepage", root_path, :class => "btn btn-success" %>
+  </div>
+  
+</div>

data/app/views/devise/image_authentication/show.html.erb

@@ -0,0 +1,13 @@
+<div class="image-authentication">
+  <h2><%= t(:please_select_your_images) %></h2>
+
+  <%= render :partial => "devise/image_authentication/image_grid" %>
+
+  <%= form_for(resource, :url => user_image_authentication_url, :html => { :id => 'auth-form', :method => :put }) do |form| %>
+    <fieldset></fieldset>
+
+    <div class="form-actions">
+      <%= submit_tag(t(:confirm_selection), :class => 'btn btn-success') %>
+    </div>
+  <% end %>
+</div>

data/config/locales/en.yml

@@ -0,0 +1,7 @@
+en:
+  your_account_has_now_been_locked: "Your account has now been locked for 2 hours"
+  please_select_your_images: "Please select your images"
+  confirm_selection: "Confirm Selection"
+  please_choose_your_images: "Please choose your image selection"
+  please_confirm_your_selection: "Please confirm your image selection"
+  choose_a_maximum_of: "Choose a maximum of %{count} images"

data/image_authentication.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "image_authentication/version"
+
+Gem::Specification.new do |s|
+  s.name        = "image_authentication"
+  s.version     = ImageAuthentication::VERSION.dup
+  s.authors     = ["Kieran Johnson"]
+  s.email       = ["kieran@invisiblelines.com"]
+  s.homepage    = "https://github.com/invisiblelines/image_authentication"
+  s.summary     = %q{Image authentication extension for devise}
+  s.description = "Provides secondary authentication by asking the user to select their chosen images"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'rails', '>= 3.1.1'
+  s.add_runtime_dependency 'devise'
+
+  s.add_development_dependency 'bundler'
+end

data/lib/generators/active_record/image_authentication_generator.rb

@@ -0,0 +1,14 @@
+require 'rails/generators/active_record'
+
+module ActiveRecord
+  module Generators
+    class ImageAuthenticationGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_image_authentication_migration
+        migration_template "migration.rb", "db/migrate/image_authentication_add_to_#{table_name}"
+      end
+
+    end
+  end
+end

data/lib/generators/active_record/templates/migration.rb

@@ -0,0 +1,8 @@
+class ImageAuthenticationAddTo<%= table_name.camelize %> < ActiveRecord::Migration
+  def change
+    change_table :<%= table_name %> do |t|
+      t.boolean :image_authentication_enabled, :default => false 
+      t.integer :auth_categories_mask,         :default => 0
+    end
+  end
+end

data/lib/generators/image_authentication/image_authentication_generator.rb

@@ -0,0 +1,17 @@
+module ImageAuthentication
+  module Generators
+    class ImageAuthenticationGenerator < Rails::Generators::NamedBase
+      namespace "image_authentication"
+
+      desc "Adds :image_authenticable directive in the given model. It also generates an active record migration."
+
+      def inject_image_authentication_content
+        path = File.join("app", "models", "#{file_path}.rb")
+        inject_into_file(path, "image_authenticatable, :", :after => "devise :") if File.exists?(path)
+      end
+
+      hook_for :orm
+
+    end
+  end
+end

data/lib/image_authentication/controllers/helpers.rb

@@ -0,0 +1,36 @@
+module ImageAuthentication
+  module Controllers
+    module Helpers
+      extend ActiveSupport::Concern
+
+      included do
+        before_filter :handle_image_authentication
+      end
+
+      private
+
+      def handle_image_authentication
+        unless devise_controller?
+          Devise.mappings.keys.flatten.any? do |scope|
+            if signed_in?(scope) and warden.session(scope)[:requires_image_authentication]
+              handle_failed_image_authentication(scope)
+            end
+          end
+        end
+      end
+
+      def handle_failed_image_authentication(scope)
+        if request.format.present? and request.format.html?
+          session["#{scope}_return_to"] = request.path if request.get?
+
+          scope = Devise::Mapping.find_scope!(scope)
+          path  = send("#{scope}_image_authentication_path")
+          redirect_to path
+        else
+          render :nothing => true, :status => :unauthorized
+        end
+      end
+
+    end
+  end
+end

data/lib/image_authentication/hooks/image_authentication.rb

@@ -0,0 +1,5 @@
+Warden::Manager.after_authentication do |user, auth, options|
+  if user.respond_to?(:image_authentication_enabled?)
+    auth.session(options[:scope])[:requires_image_authentication] = user.requires_image_authentication?(auth.request)
+  end
+end

data/lib/image_authentication/models/image_authenticatable.rb

@@ -0,0 +1,60 @@
+require 'image_authentication/hooks/image_authentication'
+
+module Devise
+  module Models
+    module ImageAuthenticatable
+      extend ActiveSupport::Concern
+
+      Categories = [
+        'Aeroplanes',
+        'Beverages',
+        'Bicycles',
+        'Birds',
+        'Boats',
+        'Cars',
+        'Cats',
+        'Clocks',
+        'Dogs',
+        'Fish',
+        'Flowers',
+        'Food',
+        'Furniture',
+        'Houses',
+        'Insects',
+        'Money',
+        'People',
+        'Shoes',
+        'Telephones',
+        'Trains'
+      ]
+
+      module ClassMethods
+        ::Devise::Models.config(self, :lock_after_failed_attempts, :number_of_categories, :maximum_categories)
+      end
+
+      def auth_categories=(categories)
+        self.auth_categories_mask = (categories & Categories).map { |c| 2**Categories.index(c) }.sum
+      end
+
+      def auth_categories
+        Categories.reject { |c| ((auth_categories_mask || 0 ) & 2**Categories.index(c)).zero? }
+      end
+
+      def requires_image_authentication?(request)
+        image_authentication_enabled?
+      end
+
+      def valid_images?(categories)
+        (auth_categories - Categories).empty?
+      end
+
+      def all_auth_categories
+        Categories.shuffle[0..self.class.number_of_categories]
+      end
+
+      def max_login_attempts?
+        self.class.lock_after_failed_attempts && (failed_attempts >= self.class.maximum_attempts)
+      end
+    end
+  end
+end

data/lib/image_authentication/rails.rb

@@ -0,0 +1,7 @@
+module ImageAuthentication
+  class Engine < ::Rails::Engine
+    ActiveSupport.on_load(:action_controller) do
+      include ImageAuthentication::Controllers::Helpers
+    end
+  end
+end

data/lib/image_authentication/routes.rb

@@ -0,0 +1,19 @@
+module ActionDispatch::Routing
+  class Mapper
+    protected
+
+      def devise_image_authentication(mapping, controllers)
+        resource :image_authentication, 
+          :only       => [:show, :update, :enable, :disable, :confirm],
+          :path       => mapping.path_names[:image_authentication],
+          :controller => controllers[:image_authentication] do
+            get :enable, :on => :member
+            put :enable, :on => :member
+            put :disable, :on => :member
+
+            get :confirm, :on => :member
+            put :confirm, :on => :member
+          end
+      end
+  end
+end

data/lib/image_authentication/version.rb

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

data/lib/image_authentication.rb

@@ -0,0 +1,26 @@
+require 'image_authentication/version'
+require 'devise'
+require 'active_support/concern'
+
+module Devise
+  mattr_accessor :lock_after_failed_attempts
+  @@lock_after_failed_attempts = false
+
+  mattr_accessor :number_of_categories
+  @@number_of_categories = 20
+
+  mattr_accessor :maximum_categories
+  @@maximum_categories = 3
+end
+
+module ImageAuthentication
+  module Controllers
+    autoload :Helpers, 'image_authentication/controllers/helpers'
+  end
+end
+
+Devise.add_module :image_authenticatable, :model => 'image_authentication/models/image_authenticatable', :controller => :image_authentication, :route => :image_authentication
+
+require 'image_authentication/routes'
+require 'image_authentication/models/image_authenticatable'
+require 'image_authentication/rails'