login_attack_report 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fdb2838a0f29019f47a8eb65c39761516e0f0aec
-  data.tar.gz: 1408354cae0e893dff5b23c2e034b67321fd7bf6
+  metadata.gz: 90ec651c4f9966ec8d80b445ec9399e5207df9c1
+  data.tar.gz: edfceae3bb150af2a6df7740444e0b0030276c88
 SHA512:
-  metadata.gz: 327f415e8a9fd4936018feeea8d970fd395d01d1bd727b594942ce5a378a658d2c6e31f2a4e1ee176f6d5f08377965e5099b30d5a6dc6f48c230747f36165d44
-  data.tar.gz: 46e6a37606a50c3ae868f84fd737c4ee7b28825dea26486ccd0107acb633cda09babfa055018e57d4cad41774eed62dffc4d4f77f524c6e96df9e6112ed4ba10
+  metadata.gz: a57479ad6632a67b8cdd40f69bd39ef9d6149dd838df8bfae447f65760ae289ebe35b863366c7502d1c25606bb9910f61f885d298c8a6d251aa74dfb5722ccee
+  data.tar.gz: c169bce692f47a0ed0cb27cfa398138a767746863fb8bf632b175cd46789234b6ad380b0ba676050488d02e2fb6428d83c76b89e72c60391b07f37d9a7eaacd9

data/README.md

@@ -1,12 +1,16 @@
 # LoginAttackReport
 
-TODO: Write a gem description
+攻撃性のあるログインを判定します。
 
 ## Installation
 
 Add this line to your application's Gemfile:
+'devise' and 'paper_trail' is required
 
 ```ruby
+gem 'devise'
+gem 'paper_trail'
+
 gem 'login_attack_report'
 ```
 
@@ -18,9 +22,33 @@ Or install it yourself as:
 
     $ gem install login_attack_report
 
+## Configuring
+
+/config/initializers/login_attack_report.rb
+```ruby
+LoginAttackReport.setup do |config|
+  # ログイン成功回数リミット
+  config.login_ok_limit = 200
+  # ログイン失敗回数リミット
+  config.login_ng_limit = 50
+end
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+モデル名をシンボルで渡すことで攻撃性のあるログインを判定します。
+
+ログイン成功回数のlimitを超えたユーザを抽出します。
+※ 異常に多い場合、どこかでID/パスワードが漏れている、もしくはIDが共有されている可能性あり
+```ruby
+    LoginAttackReport::LARVersion.login_ok_limit_over(:User)
+```
+
+ログイン失敗回数のlimitを超えたユーザを抽出します。
+※ 異常に多い場合、リスト型攻撃を受けている可能性あり
+```ruby
+    LoginAttackReport::LARVersion.login_ng_limit_over(:User)
+```
 
 ## Contributing
 

data/lib/login_attack_report/frameworks/active_record/models/l_a_r_version.rb

@@ -0,0 +1,7 @@
+require 'login_attack_report/l_a_r_version_concern'
+
+module LoginAttackReport
+  class LAReportVersion < ::ActiveRecord::Base
+    include LoginAttackReport::LARVersionConcern
+  end
+end

data/lib/login_attack_report/frameworks/active_record.rb

@@ -1,4 +1,4 @@
 #Dir[File.join(File.dirname(__FILE__), 'active_record', 'models', 'login_attack_report', '*.rb')].each do |file|
 #  require "login_attack_report/frameworks/active_record/models/#{File.basename(file, '.rb')}"
 #end
-require "login_attack_report/frameworks/active_record/models/login_attack_report_version.rb"
+require "login_attack_report/frameworks/active_record/models/l_a_r_version.rb"

data/lib/login_attack_report/{login_attack_report_version_concern.rb → l_a_r_version_concern.rb}

@@ -1,7 +1,7 @@
 require 'active_support/concern'
 
 module LoginAttackReport
-  module LoginAttackReportVersionConcern
+  module LARVersionConcern
     extend ::ActiveSupport::Concern
 
     module ClassMethods

data/lib/login_attack_report/version.rb

@@ -1,3 +1,3 @@
 module LoginAttackReport
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/lib/login_attack_report.rb

@@ -9,12 +9,16 @@ end
 require 'login_attack_report/frameworks/active_record'
 
 module LoginAttackReport
+
+  # login ok limit
   mattr_accessor :login_ok_limit
   @@login_ok_limit = 200
 
+  # login ng limit
   mattr_accessor :login_ng_limit
   @@login_ng_limit = 50
 
+  # config/initializers/login_attack_report.rb
   def self.setup
     yield self
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: login_attack_report
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - taru m
@@ -176,8 +176,8 @@ files:
 - Rakefile
 - lib/login_attack_report.rb
 - lib/login_attack_report/frameworks/active_record.rb
-- lib/login_attack_report/frameworks/active_record/models/login_attack_report_version.rb
-- lib/login_attack_report/login_attack_report_version_concern.rb
+- lib/login_attack_report/frameworks/active_record/models/l_a_r_version.rb
+- lib/login_attack_report/l_a_r_version_concern.rb
 - lib/login_attack_report/version.rb
 - login_attack_report.gemspec
 - spec/login_attack_report_spec.rb

data/lib/login_attack_report/frameworks/active_record/models/login_attack_report_version.rb

@@ -1,7 +0,0 @@
-require 'login_attack_report/login_attack_report_version_concern'
-
-module LoginAttackReport
-  class LoginAttackReportVersion < ::ActiveRecord::Base
-    include LoginAttackReport::LoginAttackReportVersionConcern
-  end
-end