devise-audit-log 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ecf8a2898f1e6b3c4fd7cba2235e6149600296ff
+  data.tar.gz: b78169721b308219903b9a66f9e607bdab021b14
+SHA512:
+  metadata.gz: ef4553e83c56a26d782d74565fd64465cdea018e5dacee796676bd92b15b9bbd137aa953d73073787cded0d4aa5dcb1b6a9589603645b3ce584bbda3e6b263f1
+  data.tar.gz: b19c4d9af85147804553806298c64a06ecebe6eff95abd0ba525ae5365a0c771833d1c1bd5e700a8ed3d1e6628ce565ddff176d233bfd36e3ddb363dfc594b49

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Rubocop" enabled="false" level="WARNING" enabled_by_default="false" />
+  </profile>
+</component>

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.4
+before_install: gem install bundler -v 1.16.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jonathan@helloglobo.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in devise-audit-log.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jonathan De Jong
+
+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,43 @@
+# Devise::Audit::Log
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/devise/audit/log`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'devise-audit-log'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install devise-audit-log
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/devise-audit-log. 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).
+
+## Code of Conduct
+
+Everyone interacting in the Devise::Audit::Log project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/devise-audit-log/blob/master/CODE_OF_CONDUCT.md).

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/audit/log"
+
+# 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-audit-log.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "devise/audit-log/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "devise-audit-log"
+  spec.version       = Devise::AuditLog::VERSION
+  spec.authors       = ["Jonathan De Jong"]
+  spec.email         = ["jonathan@helloglobo.com"]
+
+  spec.summary       = %q{This GEM provides a log of all authentication requests in Warden and Devise.}
+  spec.description   = %q{This GEM provides a log of all authentication requests in Warden and Devise. Requires devise-eventable for simple events to be monitored by this GEM.}
+  spec.homepage      = "https://github.com/jdejong/devise-audit-log"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency "devise", "~> 4"
+  spec.add_dependency "devise-eventable", ">= 0.1.1", "<= 1"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/devise-audit-log.rb

@@ -0,0 +1 @@
+require "devise/audit_log"

data/lib/devise/audit-log/version.rb

@@ -0,0 +1,5 @@
+module Devise
+  module AuditLog
+    VERSION = "0.1.1"
+  end
+end

data/lib/devise/audit_log.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require "devise"
+require "devise/audit-log/version"
+
+module Devise
+  module AuditLog
+    mattr_accessor :test
+    @@test = true
+
+      def self.log(event, user, warden, env, options, success)
+        env ||= warden.try(:env)
+        warden ||= env["warden"] if env
+
+        request = ActionDispatch::Request.new(env)
+
+        ael = AuthenticationEventLog.new
+
+        ael.event_type = event
+        ael.user = user
+        ael.ip = request.remote_ip if env
+        ael.user_agent = request.user_agent if env
+        ael.referrer = request.referrer if env
+        ael.scope = options[:scope].to_s
+        ael.strategy = AuditLog.warden_strategy(warden) if warden
+
+        ael.success = success
+        ael.failure_reason = options[:message].to_s if !ael.success
+
+        ael.identity = user.try(:email) || request.params[ ael.scope ] && request.params[ ael.scope ][:email] || nil
+
+        ael.action = "#{request.params[:controller]}##{request.params[:action]}" if request && env && request.params.has_key?(:controller)
+
+        ael.save
+      end
+
+
+      def self.warden_strategy(warden_env)
+        strategy = v.env["omniauth.auth"]["provider"] if warden_env.env["omniauth.auth"]
+        strategy ||= warden_env.winning_strategy.class.name.split("::").last.underscore if warden_env.winning_strategy
+        strategy ||= "database_authenticatable"
+        strategy
+      end
+
+      def self.login_event
+        "LOGIN".freeze
+      end
+
+      def self.logout_event
+        "LOGOUT".freeze
+      end
+
+      def self.login_failure_event
+        "LOGIN FAILURE".freeze
+      end
+
+      def self.account_unlocked_event
+        "ACCOUNT UNLOCKED".freeze
+      end
+
+      def self.account_locked_event
+        "ACCOUNT LOCKED".freeze
+      end
+
+      def self.password_reset_event
+        "PASSWORD RESET".freeze
+      end
+
+      def self.password_reset_sent_event
+        "PASSWORD RESET SENT".freeze
+      end
+
+      def self.password_change_event
+        "PASSWORD CHANGED".freeze
+      end
+  end
+
+  self.on(:logout) do |val|
+    AuditLog.log(AuditLog.logout_event, val.try(:[], :record), val.try(:[], :warden), nil, val.try(:[], :options), true)
+  end
+
+  self.on(:login) do |val|
+    AuditLog.log(AuditLog.login_event, val.try(:[], :record), val.try(:[], :warden), nil, val.try(:[], :options), true)
+  end
+
+  self.on(:login_failure) do |val|
+    AuditLog.log(AuditLog.login_failure_event, nil, nil, val.try(:[], :env), val.try(:[], :options), false)
+  end
+
+  self.on(:password_change) do |val|
+    AuditLog.log(AuditLog.password_change_event, val.try(:[], :record), nil, nil, {}, true)
+  end
+
+  self.on(:password_reset_sent) do |val|
+    AuditLog.log(AuditLog.password_reset_sent_event, val.try(:[], :record), nil, nil, {}, true)
+  end
+
+  self.on(:password_reset) do |val|
+    AuditLog.log(AuditLog.password_reset_event, val.try(:[], :record), nil, nil, {}, true)
+  end
+
+  self.on(:account_locked) do |val|
+    AuditLog.log(AuditLog.account_locked_event, val.try(:[], :record), nil, nil, {}, true)
+  end
+
+  self.on(:account_unlocked) do |val|
+    AuditLog.log(AuditLog.account_unlocked_event, val.try(:[], :record), nil, nil, {}, true)
+  end
+end

data/lib/generators/devise_audit_log/install_generator.rb

@@ -0,0 +1,51 @@
+require "rails/generators"
+require "rails/generators/migration"
+require "active_record"
+require "rails/generators/active_record"
+
+module DeviseAuditLog
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path("../templates", __FILE__)
+
+      # Implement the required interface for Rails::Generators::Migration.
+      def self.next_migration_number(dirname) #:nodoc:
+        next_migration_number = current_migration_number(dirname) + 1
+        if ::ActiveRecord::Base.timestamped_migrations
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+
+      def copy_migration
+        migration_template "authentication_event_log_migration.rb", "db/migrate/create_authentication_event_logs.rb", migration_version: migration_version
+      end
+
+      def generate_model
+        template "authentication_event_log_model.rb", "app/models/authentication_event_log.rb", model_base_class: model_base_class, ar_optional_flag: ar_optional_flag
+      end
+
+      def migration_version
+        if rails5?
+          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+        end
+      end
+
+      def rails5?
+        Rails::VERSION::MAJOR >= 5
+      end
+
+      def model_base_class
+        rails5? ? "ApplicationRecord" : "ActiveRecord::Base"
+      end
+
+      def ar_optional_flag
+        if rails5?
+          ", optional: true"
+        end
+      end
+    end
+  end
+end

data/lib/generators/devise_audit_log/templates/authentication_event_log_migration.rb

@@ -0,0 +1,24 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :authentication_event_logs do |t|
+      t.string :scope
+      t.string :strategy
+      t.string :identity
+      t.references :user, polymorphic: true
+      t.string :event_type
+
+      t.boolean :success
+      t.string :failure_reason
+
+      t.string :action
+      t.string :ip
+      t.text :user_agent
+      t.text :referrer
+
+      t.timestamps
+    end
+
+    add_index :authentication_event_logs, :identity
+    add_index :authentication_event_logs, :ip
+  end
+end

data/lib/generators/devise_audit_log/templates/authentication_event_log_model.rb

@@ -0,0 +1,4 @@
+class AuthenticationEventLog < <%= model_base_class %>
+  belongs_to :user, polymorphic: true<%= ar_optional_flag %>
+
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: devise-audit-log
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jonathan De Jong
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: devise-eventable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This GEM provides a log of all authentication requests in Warden and
+  Devise. Requires devise-eventable for simple events to be monitored by this GEM.
+email:
+- jonathan@helloglobo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/inspectionProfiles/Project_Default.xml"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- devise-audit-log.gemspec
+- lib/devise-audit-log.rb
+- lib/devise/audit-log/version.rb
+- lib/devise/audit_log.rb
+- lib/generators/devise_audit_log/install_generator.rb
+- lib/generators/devise_audit_log/templates/authentication_event_log_migration.rb
+- lib/generators/devise_audit_log/templates/authentication_event_log_model.rb
+homepage: https://github.com/jdejong/devise-audit-log
+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.6.14.1
+signing_key: 
+specification_version: 4
+summary: This GEM provides a log of all authentication requests in Warden and Devise.
+test_files: []