log_logins 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 21a9dcc5a4f82db3ca896fb29adce696076a910519d27f1806e64d7c6b0b0ae1
+  data.tar.gz: 8f30718d34d660a686c1635ddcf87952d9dd652b425e2aeea3ef70a0331aa236
+SHA512:
+  metadata.gz: 1f97f1daa840b5edb00a4fa8ce744c7608aa0a37485b57e48a537dfbb1aac67042e6ab26173eff2788dc3433aae2e01fa16c1343b4b495b576be3823bc99ac14
+  data.tar.gz: 4be1790c473c2a72e6a4ebe84d7c9dac77d5f2a7e4c1293da7e0b8ad0af4e997e5adb0c6c8cd8e5167227aa717abe84046cbd84eaa2c422a34a97df3622571ac

checksums.yaml.gz.sig

@@ -0,0 +1,2 @@
+�(�u�l)��E&�r�S��F���'�=����Eru��[�k���:0nL��hDi�K��c�r����C����M�T��m�fɁ��P��і�"�)�Ha^]�6�Y�F��]5M���s��Q�<L���.�*�IУ�;Rt�y��V�2�Ne]�T����;��"d�y�����(�>
+'���{�<�l%�-�w[�����~�ԤJ����_��&/��&mW�G��HHQ���SpPƝK�{��Y��._ �tQ��l�UY���

data/db/migrate/20180307100300_create_log_logins_events_table.rb

@@ -0,0 +1,26 @@
+class CreateLogLoginsEventsTable < ActiveRecord::Migration[4.2]
+
+  def change
+    create_table :login_events do |t|
+      t.string :user_type   # User, APIToken
+      t.integer :user_id    # 141
+
+      t.string :username
+
+      t.string :action      # Success, Failed, Blocked
+      t.string :interface    # Web, API, SomeOtherInterface
+      t.string :ip          # 1.2.3.4
+      t.string :user_agent
+
+      t.datetime :last_attempt_at
+
+      t.datetime :created_at
+
+      t.index [:user_type, :user_id], :length => {:user_type => 10}
+      t.index :ip, :length => 10
+      t.index :interface, :length => 10
+      t.index :created_at
+    end
+  end
+
+end

data/lib/log_logins/config.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module LogLogins
+
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.configure(&block)
+    block.call(config)
+    config
+  end
+
+  class Config
+
+    attr_reader :callbacks
+
+    def initialize
+      @callbacks = {}
+    end
+
+    def on(event, &block)
+      @callbacks[event.to_sym] ||= []
+      @callbacks[event.to_sym] << block
+    end
+
+    def remove_callback(event, block)
+      @callbacks[event.to_sym] && @callbacks[event.to_sym].delete(block)
+    end
+
+    def events_table_name
+      @events_table_name || 'login_events'
+    end
+    attr_writer :events_table_name
+
+    def block_time
+      @block_time || 3600
+    end
+    attr_writer :block_time
+
+    def attempts_before_block
+      @attempts_before_block || 10
+    end
+    attr_writer :attempts_before_block
+
+    def attempts_before_block_on_ip
+      @attempts_before_block_on_ip || attempts_before_block
+    end
+    attr_writer :attempts_before_block_on_ip
+
+  end
+end

data/lib/log_logins/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module LogLogins
+  class Engine < ::Rails::Engine
+    engine_name 'log_logins'
+  end
+end

data/lib/log_logins/error.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module LogLogins
+  class Error < StandardError
+  end
+
+  class InvalidLogEventError < Error
+  end
+
+  class LoginBlocked < Error
+    attr_accessor :event
+
+    def initialize(event)
+      @event = event
+    end
+
+  end
+end

data/lib/log_logins/event.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'log_logins/config'
+require 'log_logins/error'
+
+module LogLogins
+  class Event < ActiveRecord::Base
+
+    self.table_name = LogLogins.config.events_table_name
+
+    ACTIONS = ['Success', 'Failed', 'Blocked', 'Unblocked']
+
+    belongs_to :user, :polymorphic => true
+
+    validates :action, :inclusion => {:in => ACTIONS}
+
+    # Events that have failed in the last hour (or whatever the block time might be)
+    scope :failed_in_block_time, -> { where(:action => 'Failed').where("created_at > ?", Time.now - LogLogins.config.block_time )}
+    scope :success, -> { where(:action => 'Success') }
+    scope :success_or_unblock, -> { where(:action => ['Success', 'Unblocked']) }
+    scope :failed, -> { where(:action => 'Failed') }
+    scope :blocked, -> { where(:action => 'Blocked') }
+
+    # Is this the first block in a series?
+    #
+    # @return [Boolean]
+    def first_block_in_series?
+      !!(self.action == 'Blocked' && (previous.nil? ||previous.action != 'Blocked'))
+    end
+
+    # Return the login event that preceeded this one for the given scope
+    #
+    # @return [LogLogins::Event, nil]
+    def previous
+      similar.order(:id => :desc).where("id < ?", self.id).first
+    end
+
+    # Return a scope of similar events
+    def similar
+      if self.user
+        self.class.where(:user => user)
+      elsif self.ip
+        self.class.where(:user => nil, :ip => ip)
+      else
+        none
+      end
+    end
+
+    # Log a new login event
+    #
+    # @param action [String] the action
+    # @param username [String] the username that was provided with the login attempt
+    # @param user [ActiveRecord::Base, nil] the user to login against or a string
+    # @option options [String] :ip
+    # @option options [String] :scope
+    # @option options [String] :user_agent
+    # @return [LogLogins::Event]
+    def self.log(action, username, user, ip, options = {})
+      event = self.new
+      event.user = user
+      event.action = action
+      event.username = username
+      event.ip = ip
+      event.interface = options[:interface]
+      event.user_agent = options[:user_agent]
+      if event.save
+        event
+      else
+        raise LogLogins::InvalidLogEventError, event.errors.full_messages.to_sentence
+      end
+    end
+
+    # Is the given user currently blocked from logging in?
+    #
+    # @param user [ActiveRecord::Base]
+    # @return [Boolean]
+    def self.user_blocked?(user)
+      return false unless user.is_a?(ActiveRecord::Base)
+      last_success = self.success_or_unblock.order(:id => :desc).select(:id).first.try(:id) || 0
+      self.failed_in_block_time.where(:user => user).where("id > ?", last_success).count >= LogLogins.config.attempts_before_block
+    end
+
+    # Is the given IP address currently blocked from logging in?
+    #
+    # @param ip [String]
+    # @return [Boolean]
+    def self.ip_blocked?(ip)
+      return false if ip.nil?
+      last_success = self.success_or_unblock.order(:id => :desc).select(:id).first.try(:id) || 0
+      self.failed_in_block_time.where(:user => nil, :ip => ip.to_s).where("id > ?", last_success).count >= LogLogins.config.attempts_before_block_on_ip
+    end
+
+  end
+end

data/lib/log_logins/user.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module LogLogins
+  module User
+
+    def self.included(base)
+      base.has_many :login_events, :class_name => 'LogLogins::Event', :as => :user, :dependent => :delete_all
+    end
+
+  end
+end

data/lib/log_logins/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LogLogins
+  VERSION = '1.0.0'
+end

data/lib/log_logins.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'log_logins/config'
+require 'log_logins/event'
+require 'log_logins/user'
+
+if defined?(Rails)
+  require 'log_logins/engine'
+end
+
+module LogLogins
+
+  def self.success(*args)
+    event = touch('Success', *args)
+    dispatch(:success, event)
+    event
+  end
+
+  def self.fail(*args)
+    event = touch('Failed', *args)
+    dispatch(:fail, event)
+    event
+  end
+
+  def self.dispatch(callback_name, event)
+    if callbacks = config.callbacks[callback_name.to_sym]
+      callbacks.each { |c| c.call(event) }
+    end
+  end
+
+  def self.unblock_user(user)
+    Event.log('Unblocked', nil, user, nil)
+  end
+
+  def self.unblock_ip(ip)
+    Event.log('Unblocked', nil, nil, ip)
+  end
+
+  private
+
+  def self.blocked!(username, user, ip, options = {})
+    event = Event.log('Blocked', username, user, ip, options)
+    dispatch(:blocked, event)
+    raise LogLogins::LoginBlocked.new(event), "Login has been blocked due to too many failed logins."
+  end
+
+  def self.touch(action, username, user, ip, options = {})
+    if Event.user_blocked?(user)
+      blocked!(username, user, ip, options)
+    end
+
+    if Event.ip_blocked?(ip)
+      blocked!(username, user, ip, options)
+    end
+
+    Event.log(action, username, user, ip, options)
+  end
+
+end

data.tar.gz.sig

@@ -0,0 +1 @@
+2#�^�h�q,O�N�[�L�����hëL��?5)QuAr�A���Dq��76^�搛�g������P&�O�X�v�W���nѦ�R��U��6�d�VȔ4���zW�Dž�x��)�6P#l�˫�

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: log_logins
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Adam Cooke
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEZDCCAsygAwIBAgIBATANBgkqhkiG9w0BAQsFADA8MQswCQYDVQQDDAJtZTEZ
+  MBcGCgmSJomT8ixkARkWCWFkYW1jb29rZTESMBAGCgmSJomT8ixkARkWAmlvMB4X
+  DTE4MDMwNTE3MzAwNVoXDTE5MDMwNTE3MzAwNVowPDELMAkGA1UEAwwCbWUxGTAX
+  BgoJkiaJk/IsZAEZFglhZGFtY29va2UxEjAQBgoJkiaJk/IsZAEZFgJpbzCCAaIw
+  DQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBAOH6HpXwjmVYrUQxUHm25mLm9qYK
+  WS66Me1IfMUX3ZREZ/GzqiJZdV6itPuaaaKpbcm2A/KjgGSPOi9FZBneZ5KvbIeK
+  /GsixL98kxB06q9DZwJbFz7Inklxkd/S0anm+PxtWkQP1TLkMsviRcBPEAqSLON9
+  dCKC7+3kibhatdlsbqIQaeEhSoCUipYMi7ZyFHu5Qz+zMwc8JwHvQ4yi8cMa/QZ+
+  s1tN4mkp/6vWWj4G4lF3YjFYyt2txJcK5ELDtyBy7a3vbMImPy9pplFx1/M6SNpn
+  7Pck0LqDprRzJXsGjq3CbC0nUaudFjUPr31KwxMYq1u13aQL9YuO3GeQCQ3gvdlJ
+  TSd7zoGgLwrMGmXqgd392Psr29yp+WBLcvhFUJnNPDV8nlph/cqmRzoIewP1kdPq
+  pEIUIJQdyKJU7gmFlJ1FurarkuT0a2Rgs99WokCoXLxuPmRWQRN1sH2nHL70jgAR
+  UuvyXEtyALHoCn3VqBR7ZvpfDblUzfANQDhBgwIDAQABo3EwbzAJBgNVHRMEAjAA
+  MAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUa7gxxSE4SO2Ors4B+y3qANdMpo4wGgYD
+  VR0RBBMwEYEPbWVAYWRhbWNvb2tlLmlvMBoGA1UdEgQTMBGBD21lQGFkYW1jb29r
+  ZS5pbzANBgkqhkiG9w0BAQsFAAOCAYEAkbz/AJwBsRKwgt2BhWqgr/egf/37IS3s
+  utVox7feYutKyFDHXYvCjm64XUJNioG7ipbRwOOGs5bEYfwgkabcAQnxSlkdNjc4
+  JIgL/cF4YRg8uJG7DH+LwpydXHqr7RneDiONuiHlEN/1EZZ8tjwXypdwzhQ2/6ot
+  YOxdSi/mXdoDoFlIebsLyInUZjqnm7dQ9nTTUNSB+1LoOD8ARNhTIPnKCnxwZd56
+  giOxoHuJIOhgi6U2zicZJHv8lUj2Lc3bcirQk5eeOFRPVGQSpLLoqA7dtS7Jy4cv
+  3c5m+HyxSxzlrcVHMAgJYemK0uhVQD9Y6JwHKDroWDH+MPALjlScw8ui1jmNuH31
+  n5JOH/07C4gYcwTjJmtoRSov46Z6Gn5cc6NFkQpA185pbRLqEDKzusXvBOQlAOLh
+  iyQrH6PJ0xgVJNYx+DLq3eFmo2hYJkw/lVhYAK+MdajtYJbD5VvCIEHO0d5RRgV+
+  qnCNZoPPy0UtRmGKZTMZvVJEZiw4g0fY
+  -----END CERTIFICATE-----
+date: 2018-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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 Rails library for logging login attempts and blocking as appropriate.
+email:
+- me@adamcooke.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- db/migrate/20180307100300_create_log_logins_events_table.rb
+- lib/log_logins.rb
+- lib/log_logins/config.rb
+- lib/log_logins/engine.rb
+- lib/log_logins/error.rb
+- lib/log_logins/event.rb
+- lib/log_logins/user.rb
+- lib/log_logins/version.rb
+homepage: https://github.com/adamcooke/log_logins
+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.7.4
+signing_key: 
+specification_version: 4
+summary: A Rails library for logging login attempts and blocking as appropriate.
+test_files: []