ip_shield 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f54832ed652f00062f3a7770bce88afb7ba793998041638dfceef3adac5a4d01
+  data.tar.gz: 963f19709c1b32aa93470888b80ff8985b4d254933b6f1fc799de62967b56d41
+SHA512:
+  metadata.gz: f3c868ff2be3ef91659c031867a0e0fa5958bd7ed72420c58b4d162aade29fcc0b69c5291681dca111ab1044283f01beeead368855f2678024bef5919494663a
+  data.tar.gz: afa6f0e75e8f9afbbf8130caa3fa06337730f8cfe3bce68ac3b52605752862580934514110225ceffce919aa1cabf20a0defd39f19215e0289a896804f10d472

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-10-20
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at Abdullah.Janjua@dvla.gov.uk. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ip_shield.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+group :development, :test do
+  gem "roda"
+  gem "rspec", "~> 3.0"
+  gem "rubocop", "~> 1.21"
+end

data/README.md

@@ -0,0 +1,81 @@
+<div align="center">
+   <img src="/docs/lego.png" height="auto" width="500" style="border-radius:30%">
+</div>
+
+## IP Shield
+##### _A simple Roda plugin that helps you secure your Roda application by only allowing authoriased IP addresses an access to your app/page/resources_
+
+
+Thank you for using `ip_shield` gem. This gem helps defending your Roda application agenst unwanted requests by only granding authorased IP addresses and access to the app, page or any resources.  
+
+
+| 🏁  Installation & Getting statrted |
+| ----------------------------------------- |
+
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add ip_shield
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install ip_shield
+
+
+| 👔 Usage and examples |
+| ----------------------------------------- |
+
+Add the plugin to your Roda Application
+```ruby
+plugin :ip_shield, '0.0.0.0', ['128.0.0.0', '128.0.0.5']
+```
+
+Check if the request IP is authorised by calling `authorised_ip?` or `must_be_authorised_ip`. Please bear in mind that `authorised_ip?` will return a boolean value. `must_be_authorised_ip` in on the other hand will raise `UnauthorisedIP` error.
+```ruby
+route do |r|
+  r.authorised_ip? ? 'IP is authorised' : 'IP is not authorised'
+end
+```
+
+```ruby
+route do |r|
+    begin
+        r.must_be_authorised_ip
+        'IP is authorised'
+        rescue UnauthorisedIP
+        'IP is not authorised'
+    end
+end
+```
+
+You can add an IP from the request by simply using `authorise_ip`
+```ruby
+route do |r|
+  r.authorise_ip unless r.authorised_ip?
+end
+```
+
+Use `deauthorise_ip` to remove the de-authorise the request IP
+```ruby
+route do |r|
+  r.deauthorise_ip if r.authorised_ip?
+end
+```
+
+Note that calling `authorised_ip?` is not a must. However checking if the IP is authorised will help in preventing you from having a duplicate IPs, or de-authorise an IP that does not exist in the authorised IP list.
+
+
+| 🛠 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+| 📃 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/ip_shield/ip_validator.rb

@@ -0,0 +1,119 @@
+require "ipaddr"
+require "singleton"
+
+# the +IPValidator+ is a simple singleton class to validate and manage IP addresses.
+# You can use this class to authorize a list of IP address.
+class IPValidator
+  include Singleton
+  attr_accessor :ips
+
+  # Invalid IP boundary error
+  class InvalidIPsBoundary < StandardError; end
+
+  # Invalid IP address error
+  class InvalidIP < StandardError; end
+
+  INVALID_BOUNDARY = "IP boundary must be an array of 2 elements: high and low".freeze
+  IP_DOES_NOT_EXIST = "the given IP is not within the authorised list".freeze
+  INVALID_IP = "IP must be a valid IPv4 or IPv6".freeze
+
+  def initialize() @ips = []; end
+
+  # Ensure that all IPs are valid. an IP is invalid if its nil, not a string, or not in a IPv4 or
+  # IPv6 format. In case of a boundary-ip, it also must also be an array of 2
+  # elements (ex. [high, low]). if one or more IP in the list is invalid,
+  # it will raise an error. Otherwise, it will return self
+  #
+  # @example
+  #   invalid_ip = ['0.0....']
+  #   invalid_ip.each {|ip| IPValidator.instance.add_ip(ip)}
+  #
+  #   IPValidator.instance.check_ips # will raise InvalidIP error
+  #
+  # @raise
+  #   * InvalidIPsBoundary: if the array has an invalid number of elements.
+  #   * InvalidIP: if the IP address is invalid
+  #
+  # @param [Array] ip_addr_list a list of all IP address
+  # @return [IPValidator] will return self unless one or more IP is invalid
+  def check_ips(ip_addr_list = @ips)
+    ip_addr_list.each do |ip_addr|
+      if ip_addr.is_a?(Array)
+        ip_addr
+          .tap { |ip| raise InvalidIPsBoundary, INVALID_BOUNDARY unless ip.count.eql?(2) }
+          .each { |ip| raise InvalidIP, INVALID_IP unless is_ip?(ip) }
+      else
+        raise InvalidIP, INVALID_IP unless is_ip?(ip_addr)
+      end
+    end
+
+    return_self
+  end
+
+  # Checks if the IP is authorized. The IP is authorized if any of the following true:
+  # 1. the IP matches on of the IPs in the list +@ips+
+  # 2. the IP is within any IP boundaries in +@ips+
+  # this function will return true if any 1 or 2 is true. Otherwise, it will return false.
+  #
+  # @example
+  #  IPValidator
+  #     .instance
+  #     .is_authorize_ip?('0.0.0.0')
+  #
+  # @param [String] ip_addr the IP address
+  # @return [TrueClass, FalseClass] true if the IP is authorized. Otherwise return false
+  def is_authorize_ip?(ip_addr)
+    ip_range, ip_list = @ips.partition{|all_ips| all_ips.is_a? Array}
+
+    ip_list.filter!{|ip| IPAddr.new(ip).to_i === IPAddr.new(ip_addr).to_i}
+    ip_list.empty? && ip_range.filter! do |range|
+      low = IPAddr.new(range.first)
+      high = IPAddr.new(range.last)
+      current = IPAddr.new(ip_addr)
+
+      (low..high) === current
+    end
+
+    (ip_list.count + ip_range.count).positive?
+  end
+
+  # Use this function to add new IPs to the authorized IP list.
+  # 
+  # @note
+  # This function will check if the IP is valid before adding the IP to the
+  # authorized IP list.
+  # 
+  # @example
+  #   IPValidator.instance.add_ip('0.0.0.0')
+  # 
+  # @param [String] ip_addr the IP address to be added
+  # @return [IPValidator] self
+  def add_ip(ip_addr)
+    check_ips([ip_addr]) && @ips.push(ip_addr)
+    return_self
+  end
+
+  # Use this function to remove the IP from the authorized IP list. The given IP
+  # must exist in the IP list
+  #
+  # @raise
+  #   InvalidIP: If the IP does not exist in the authorized IP list
+  #
+  # @param [String] ip_addr the IP address to be removed
+  # @return [IPValidator] self
+  def remove_ip(ip_addr)
+    raise InvalidIP, IP_DOES_NOT_EXIST if @ips.delete(ip_addr).nil?
+    return_self
+  end
+
+  private
+
+  def is_ip?(ip_addr = @ips)
+    return false if ip_addr.nil?
+    return false unless ip_addr.is_a? String
+
+    true if IPAddr.new(ip_addr) rescue false
+  end
+
+  def return_self() self; end
+end

data/lib/ip_shield/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module IpShield
+  VERSION = "0.1.0"
+end

data/lib/ip_shield.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require_relative "ip_shield/version"
+require_relative "ip_shield/ip_validator"
+require "ipaddr"
+require 'roda'
+class Roda
+  module RodaPlugins
+    module IpShield
+
+      # Unauthorised IP error
+      class UnauthorisedIP < RodaError; end
+
+      # invalid IP error
+      class InvalidIP < RodaError; end
+
+      # Auto configure +ip_shield+ plugin. Set IPs when the plugin is loaded. The provided
+      # IP will be authorize automatically as long as they as are valid IPv4 or IPv6. There are
+      # two ways to set IP.
+      # 1. As a string. Ex; '0.0.0.0'
+      # 2. As an array of low and high boundaries. Ex; ['0.0.0.0', '0.0.0.7']
+      #
+      # @note
+      # boundaries should be an array with two string elements - IP. The first element must
+      # be low IP and the second should be high.
+      #
+      # @example
+      #    plugin :ip_shield, '0.0.0.0', ['128.0.0.0', '128.0.0.5']
+      #
+      # @param [Object] app App
+      # @param [Array] ip_addrs list of aip addresses
+      def self.configure(app, *ip_addrs)
+        ip_addrs = app.opts[:ip_shield] || ip_addrs
+        ip_addrs.each { |ip_addr| IPValidator.instance.add_ip(ip_addr) } unless ip_addrs.nil? || ip_addrs.empty?
+      end
+
+      module RequestMethods
+
+        # A simple but fun way to check if the request IP is authorised. Only added IPs are
+        # authorised. If the IP is not added, then it will be considered as deauthorise ip and
+        # therefore this function will return false.
+        #
+        # @example
+        #   r.authorised_ip? ? 'IP is authorised' : 'IP is not authorised'
+        #
+        # @return [TrueClass, FalseClass] true only if the request IP is authorised & false if not
+        def authorised_ip?
+          req_ip_addr = ip_addr(self)
+
+          IPValidator
+            .instance
+            .is_authorize_ip?(req_ip_addr)
+        end
+
+        # This function will raise +UnauthorisedIP+ error if the request IP is not authorised.
+        # Use this function if you would like to hard-stop the program execution but be
+        # sure to handle the error.
+        #
+        # @example
+        #   begin
+        #   r.must_be_authorised_ip
+        #   'IP is authorised'
+        #   rescue UnauthorisedIP
+        #   'IP is not authorised'
+        #   end
+        #
+        # @raise
+        #   UnauthorisedIP: The request IP is not authorised'
+        #
+        # @return [TrueClass, FalseClass] true if IP is authorised or raise UnauthorisedIP when isn't
+        def must_be_authorised_ip
+          req_ip_addr = ip_addr(self)
+
+          IPValidator
+            .instance
+            .is_authorize_ip?(req_ip_addr)
+            .tap { |auth| raise UnauthorisedIP, 'The request IP is not authorised' unless auth }
+        end
+
+        # Remove an IP from the authorised list. The IP must be valid and exist in the
+        # authorised IP list. Its recommended to check if the IP exist before deauthorise it.
+        #
+        # @example
+        #   r.deauthorise_ip if r.authorised_ip?
+        #
+        # @raise
+        #   IP_DOES_NOT_EXIST: the given IP is not within the authorised list
+        def deauthorise_ip
+          IPValidator
+            .instance
+            .remove_ip(ip_addr(self))
+        end
+
+        # Add an IP ti the authorised list. You can only add any of the following:
+        # 1. IP as a string. Ex; '0.0.0.0'
+        # 2. An array of low and high boundaries. Ex; ['0.0.0.0', '0.0.0.7']
+        #
+        # @note
+        # The IP validity will get checked automatically before it gets added to the
+        # authorise IP list. However, there are no checks for duplicate IPs. Its
+        # recommended to check if the IP exist before authorise it.
+        #
+        # @example
+        #   r.authorise_ip unless r.authorised_ip?
+        #
+        # @return [String|Array] an IP as a string or an IP boundary
+        def authorise_ip
+          IPValidator
+            .instance
+            .add_ip(ip_addr(self))
+        end
+
+        private
+
+        def ip_addr(request)
+          request&.ip.nil? ? (raise InvalidIP, 'No IP is not found') : request.ip
+        end
+
+      end
+    end
+
+    register_plugin(:ip_shield, IpShield)
+  end
+end
+

data/sig/ip_shield.rbs

@@ -0,0 +1,4 @@
+module IpShield
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: ip_shield
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Abdullah Janjua
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-11-24 00:00:00.000000000 Z
+dependencies: []
+description: 'do it: Write a longer description or delete this line.'
+email:
+- AbdullahJanjuauk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- docs/lego.png
+- lib/ip_shield.rb
+- lib/ip_shield/ip_validator.rb
+- lib/ip_shield/version.rb
+- sig/ip_shield.rbs
+homepage: https://github.com/DevAbdullahUk/roda-IPShield
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/DevAbdullahUk/roda-IPShield
+  source_code_uri: https://github.com/DevAbdullahUk/roda-IPShield
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: 'do it: Write a short summary, because RubyGems requires one.'
+test_files: []