devise_revocable_session 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7fd2174196e326e6415a40c53d1e34b9e365e4e530fb200b5444f6cac0f6c3ca
+  data.tar.gz: 944e658e4e52f08158215a2db81e9a9ffed681e9bdb791862f2d3c0317ae2d78
+SHA512:
+  metadata.gz: 332723f1fc5f8eaec040ca9f876634ec3e54cac7cea558021f6626a37ea490ff63e8dc1aa83d09b910686775a19579688acc8074e93dd86bbd427f41d345513b
+  data.tar.gz: c4ccbd0380357329671590d6e8452affeca7873a8b3485ccf11b46a6499b47d1ca9e22cd58b63aec0f635fe204029669c16bac4f628b79a8c83e7aa3c5f1ee2b

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Carl Allen
+
+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,39 @@
+# DeviseRevocableSession
+
+A module for devise to revoke sessions.
+
+This is borrowed heavily from: https://github.com/mkhairi/devise_revocable and https://www.jonathanleighton.com/articles/2013/revocable-sessions-with-devise/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'devise_revocable_session'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install devise_revocable_session
+
+## Usage
+
+Install using the generator
+
+    $ rails g devise_revocable_sessions
+
+
+Add `:revocable_session` to your model's devise declaration
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/carlallen/devise_revocable_session. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/models/devise/revocable_session.rb

@@ -0,0 +1,6 @@
+module Devise
+  class RevocableSession < ApplicationRecord
+    belongs_to :resource, polymorphic: true
+    validates_presence_of :resource, :session_id, :device_id
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "devise_revocable_session"
+
+# 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(__FILE__)

data/bin/setup

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

data/devise_revocable_session.gemspec

@@ -0,0 +1,26 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "devise_revocable_session/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "devise_revocable_session"
+  spec.version       = DeviseRevocableSession::VERSION
+  spec.authors       = ['Carl Allen']
+  spec.email         = ["github@allenofmn.com"]
+
+  spec.summary       = 'A module for devise to revoke sessions'
+  spec.description   = 'A module for devise to revoke sessions'
+  spec.homepage      = 'http://github.com/carlallen/devise_revocable_session'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "devise"
+  spec.add_dependency "activemodel"
+end

data/lib/devise_revocable_session/hooks/revocable_session.rb

@@ -0,0 +1,41 @@
+# After authenticating, we’re removing any session activation that may already
+# exist, and creating a new session# activation. We generate our own random id
+# (in User#activate_session) and store it in the auth_id key. There is already
+# a session_id key, but the session gets renewed (and the session id changes)
+# after authentication in order to avoid session fixation attacks. So it’s
+# easier to just use our own id.
+Warden::Manager.after_set_user except: :fetch do |record, warden, options|
+  scope = options[:scope]
+  if record && record.respond_to?(:has_revocable_sessions?) && record.has_revocable_sessions?
+    record.deactivate_session!(warden.raw_session[:auth_id])
+    revocable_session = record.activate_session(warden.request)
+    warden.raw_session[:auth_id] = revocable_session.session_id
+    warden.cookies[:device_id] = revocable_session.device_id
+  end
+end
+
+# After fetching a user from the session, we check that the session is marked
+# as active for that record. If it’s not we log the user out.
+Warden::Manager.after_fetch do |record, warden, options|
+  scope = options[:scope]
+  if record && record.respond_to?(:has_revocable_sessions?) && record.has_revocable_sessions?
+    device_cookie = warden.cookies[:device_id]
+    valid_session = record.session_active?(device_cookie, warden.raw_session[:auth_id])
+    if device_cookie.present? and valid_session
+      record.mark_last_seen!(device_cookie)
+    else
+      warden.logout(scope)
+      throw :warden, scope: scope, message: :unauthenticated
+    end
+  end
+end
+
+# When logging out, we deactivate_session! the current session. This ensures that the
+# session cookie can’t be reused afterwards.
+Warden::Manager.before_logout do |record, warden, options|
+  scope = options[:scope]
+  if record && record.respond_to?(:has_revocable_sessions?) && record.has_revocable_sessions?
+    record.deactivate_session!(warden.raw_session[:auth_id])
+    warden.cookies.delete(:device_id)
+  end
+end

data/lib/devise_revocable_session/models/revocable_session.rb

@@ -0,0 +1,62 @@
+module Devise
+  module Models
+    module RevocableSession
+      extend ActiveSupport::Concern
+
+        included do
+          has_many :revocable_sessions, dependent: :destroy,
+            as: :resource, class_name: "Devise::RevocableSession"
+        end
+
+        def has_revocable_sessions?
+          true
+        end
+
+         #session
+        def activate_session(request)
+          new_session = revocable_sessions.new(attrs_for_login(request))
+          new_session.session_id = SecureRandom.hex(64)
+          new_session.device_id  = SecureRandom.uuid
+          new_session.signed_in_ip = request.remote_ip
+          new_session.save
+          purge_old_sessions
+          new_session
+        end
+
+        def exclusive_session(session_id)
+          revocable_sessions.where('session_id != ?', session_id).delete_all
+        end
+
+        def session_active?(device_id, session_id)
+          revocable_sessions.where(device_id: device_id, session_id: session_id).exists?
+        end
+
+        def deactivate_session!(session_id)
+          revocable_sessions.where(session_id: session_id).delete_all
+        end
+
+        def purge_old_sessions
+          revocable_sessions.order(created_at: :desc).offset(10).destroy_all
+        end
+
+        def mark_last_seen!(device_id)
+          login_record = revocable_sessions.find_by(device_id: device_id)
+          #skip second to reduce database hit
+          if (Time.now - (login_record.last_seen_at)) >= 60
+            login_record.update_column :last_seen_at, Time.now
+          end
+        end
+
+        protected
+
+        def attrs_for_login(request)
+          t = Time.now
+          { user_agent: request.user_agent,
+            last_seen_ip: request.remote_ip,
+            signed_in_at: t,
+            last_seen_at: t }
+        end
+
+    end
+  end
+end

data/lib/devise_revocable_session/version.rb

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

data/lib/devise_revocable_session.rb

@@ -0,0 +1,13 @@
+require "devise_revocable_session/version"
+require 'devise'
+require 'devise_revocable_session/hooks/revocable_session'
+require 'devise_revocable_session/models/revocable_session'
+
+module DeviseRevocableSession
+  class Engine < ::Rails::Engine
+  end
+end
+
+Devise.with_options model: true do |d|
+	d.add_module :revocable_session
+end

data/lib/generators/devise_revocable_session/devise_revocable_session_generator.rb

@@ -0,0 +1,37 @@
+require 'rails/generators/migration'
+
+class DeviseRevocableSessionGenerator < Rails::Generators::Base
+
+  if defined?(ActiveRecord)
+    include Rails::Generators::Migration
+  end
+
+  desc "Generates a migration to store revocable sessions."
+
+  def self.source_root
+    @_devise_source_root ||= File.expand_path('../templates', __FILE__)
+  end
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime('%Y%m%d%H%M%S')
+    else
+      '%.3d' % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def generate
+    create_migration_file
+  end
+
+
+  private
+
+  def create_migration_file
+    migration_template 'migration.rb', "db/migrate/create_revocable_sessions.rb", migration_version: migration_version
+  end
+
+  def migration_version
+    "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+  end
+end

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

@@ -0,0 +1,24 @@
+class CreateRevocableSessions < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :revocable_sessions do |t|
+      t.integer   :resource_id,   null: false
+      t.string    :resource_type,   null: false
+      t.string    :session_id, null: false
+      t.string    :device_id
+      t.string    :user_agent
+      t.datetime  :signed_in_at
+      t.string    :signed_in_ip
+      t.datetime  :last_seen_at
+      t.string    :last_seen_ip
+      t.datetime  :signed_out_at
+      t.boolean   :active, default: true
+
+      t.index [:resource_id, :resource_type], name: :resource
+      t.index :session_id, unique: true
+      t.index :device_id
+
+      t.timestamps
+    end
+  end
+end
+

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: devise_revocable_session
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carl Allen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A module for devise to revoke sessions
+email:
+- github@allenofmn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/models/devise/revocable_session.rb
+- bin/console
+- bin/setup
+- devise_revocable_session.gemspec
+- lib/devise_revocable_session.rb
+- lib/devise_revocable_session/hooks/revocable_session.rb
+- lib/devise_revocable_session/models/revocable_session.rb
+- lib/devise_revocable_session/version.rb
+- lib/generators/devise_revocable_session/devise_revocable_session_generator.rb
+- lib/generators/devise_revocable_session/templates/migration.rb
+homepage: http://github.com/carlallen/devise_revocable_session
+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: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: A module for devise to revoke sessions
+test_files: []