attacked 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0b04ffb22bcc29d0d939bd2eb5e1c22c605386a9ffce1f2aa59bc919dc1850ae
+  data.tar.gz: c6b5e545c137f187130a49edb59c0ab7a07c31402d025f3eba9667ef46b158f4
+SHA512:
+  metadata.gz: ae74f489a4fb6a25c7697330ae25f297987fd0824cef1064baf7c632dcf2b8222b6224dc86fc05467b0ca6330e626b065807899d606ce73776c13d6fd7960be0
+  data.tar.gz: ab911ef29e7fce5539e3380d867fd77cad9b328dfb1a391b912f968af2357743e6579e91929eeb9cd1c1fa917cf5fe0a39fd2e05fd76172b24a73f96d71f7a91

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Murray Summers
+
+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,74 @@
+# Attacked
+
+Attacked allows you to manage a list of blocked IP addresses in your Rails application.
+Attacked stores a list of blocked IP addresses in your database and also caches
+these in your Rails cache for fast lookups.
+
+Attacked allows you the convenience to block an IP from your admin area or Rails console without deploying your application.
+
+You can use Attacked with [rack-attack](https://github.com/rack/rack-attack) to manage a blocklist.
+Attacked caches blocked IP addresses so that there is minimal overhead to your requests.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'attacked'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Copy the migrations from attacked to your application:
+
+```bash
+$ bin/rails attacked:install:migrations
+```
+
+Migrate your application:
+
+```bash
+$ bin/rails db:migrate
+```
+
+Install [rack-attack](https://github.com/rack/rack-attack) as usual and setup a blocklist:
+
+```ruby
+# Block attacks from IPs
+# To block an IP: Attacked::BlockedIpAddress.block("1.2.3.4")
+# To unblock an IP: Attacked::BlockedIpAddress.unblock("1.2.3.4")
+blocklist("block ips") do |req|
+  Attacked::BlockedIpAddress.blocked?(req.ip)
+end
+```
+
+Please note that `Attacked` defaults to using the `Rails.cache` when caching blocked
+IP addresses. As such you must setup a cache store for your application.
+
+### Usage
+
+To block an IP:
+
+```ruby
+Attacked::BlockedIpAddress.block("1.2.3.4")
+```
+
+To unblock an IP:
+
+```ruby
+Attacked::BlockedIpAddress.unblock("1.2.3.4")
+```
+
+To check if an IP is blocked:
+
+```ruby
+Attacked::BlockedIpAddress.blocked?("1.2.3.4")
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,18 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/attacked_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/attacked .css

data/app/assets/stylesheets/attacked/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/attacked/application_controller.rb

@@ -0,0 +1,4 @@
+module Attacked
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/attacked/application_helper.rb

@@ -0,0 +1,4 @@
+module Attacked
+  module ApplicationHelper
+  end
+end

data/app/jobs/attacked/application_job.rb

@@ -0,0 +1,4 @@
+module Attacked
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/attacked/application_mailer.rb

@@ -0,0 +1,6 @@
+module Attacked
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/attacked/application_record.rb

@@ -0,0 +1,5 @@
+module Attacked
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/attacked/blocked_ip_address.rb

@@ -0,0 +1,52 @@
+require "resolv"
+
+module Attacked
+  class BlockedIpAddress < ApplicationRecord
+
+    after_create :create_in_cache
+
+    after_destroy :remove_from_cache
+
+    validates :ip_address, format: {
+      with: Regexp.union(Resolv::IPv4::Regex, Resolv::IPv6::Regex)
+    }
+    validates :ip_address, uniqueness: {
+      message: "has already been blocked"
+    }
+
+    def self.blocked?(ip_address)
+      Rails.cache.read(blocked_cache_key(ip_address)) ? true : false
+    end
+
+    def self.block(ip_address)
+      create ip_address: ip_address
+    end
+
+    def self.unblock(ip_address)
+      blocked_ip_address = find_by(ip_address: ip_address)
+      blocked_ip_address.unblock
+    end
+
+    def unblock
+      destroy
+    end
+
+    private
+
+    def create_in_cache
+      Rails.cache.write(blocked_cache_key(ip_address), true)
+    end
+
+    def remove_from_cache
+      Rails.cache.delete(blocked_cache_key(ip_address))
+    end
+
+    def self.blocked_cache_key(ip_address)
+      "attacked_blocked_ip #{ip_address}"
+    end
+
+    def blocked_cache_key(ip_address)
+      "attacked_blocked_ip #{ip_address}"
+    end
+  end
+end

data/app/views/layouts/attacked/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Attacked</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "attacked/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Attacked::Engine.routes.draw do
+end

data/db/migrate/20220104121238_create_attacked_blocked_ip_addresses.rb

@@ -0,0 +1,9 @@
+class CreateAttackedBlockedIpAddresses < ActiveRecord::Migration[5.1]
+  def change
+    create_table :attacked_blocked_ip_addresses do |t|
+      t.string :ip_address, index: { unique: true }
+      t.text :description
+      t.timestamps
+    end
+  end
+end

data/lib/attacked/engine.rb

@@ -0,0 +1,5 @@
+module Attacked
+  class Engine < ::Rails::Engine
+    isolate_namespace Attacked
+  end
+end

data/lib/attacked/version.rb

@@ -0,0 +1,3 @@
+module Attacked
+  VERSION = '0.1.0'
+end

data/lib/attacked.rb

@@ -0,0 +1,6 @@
+require "attacked/version"
+require "attacked/engine"
+
+module Attacked
+  # Your code goes here...
+end

data/lib/tasks/attacked_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :attacked do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: attacked
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Murray Summers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+description: Manage a persisted list of blocked IP addresses and block these requests
+email:
+- murray.sum@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/attacked_manifest.js
+- app/assets/stylesheets/attacked/application.css
+- app/controllers/attacked/application_controller.rb
+- app/helpers/attacked/application_helper.rb
+- app/jobs/attacked/application_job.rb
+- app/mailers/attacked/application_mailer.rb
+- app/models/attacked/application_record.rb
+- app/models/attacked/blocked_ip_address.rb
+- app/views/layouts/attacked/application.html.erb
+- config/routes.rb
+- db/migrate/20220104121238_create_attacked_blocked_ip_addresses.rb
+- lib/attacked.rb
+- lib/attacked/engine.rb
+- lib/attacked/version.rb
+- lib/tasks/attacked_tasks.rake
+homepage: https://github.com/murraysum/attacked
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/murraysum/attacked
+  source_code_uri: https://github.com/murraysum/attacked
+  changelog_uri: https://github.com/murraysum/attacked
+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.3
+signing_key: 
+specification_version: 4
+summary: Manage a persisted list of blocked IP addresses
+test_files: []