rack_do_app_platform_safelist 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6bce93ff200590683a6ac90c0ac3d2d830336ee8dd751b688af93c86b2d4ef6
+  data.tar.gz: 3212a885b1e37ac65de4cd4f5bfc36f0c843bee1e1d350d5af286623d8188834
+SHA512:
+  metadata.gz: 2518416145149e6aeff291dc2f20c71f5322c8af859be76f7121ab8863006306b73a997e4f55e060f838af055f4db9666290693fb49312db9b686ea4aa2199c2
+  data.tar.gz: 6109e59f4205f5e21cb0cbcbad687d32c5389f7caac7683e9e73f5e1ed0a624d201a1ae5655162791d07503e6a09ed64570e96d1dbdad428368fb13c73e98074

data/.rubocop.yml

@@ -0,0 +1,9 @@
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2023-02-11
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "debug", "~> 1.7"
+gem "minitest", "~> 5.0"
+gem "rack-test", "~> 2.0"
+gem "rake", "~> 13.0"
+gem "rubocop"
+gem "rubocop-minitest"
+gem "rubocop-rake"
+gem "simplecov", "~> 0.22"

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    rack_do_app_platform_safelist (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    debug (1.7.1)
+    docile (1.4.0)
+    json (2.6.3)
+    minitest (5.17.0)
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
+    rack (3.0.4.1)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rubocop (1.45.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.26.0)
+      parser (>= 3.2.1.0)
+    rubocop-minitest (0.27.0)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  debug (~> 1.7)
+  minitest (~> 5.0)
+  rack-test (~> 2.0)
+  rack_do_app_platform_safelist!
+  rake (~> 13.0)
+  rubocop
+  rubocop-minitest
+  rubocop-rake
+  simplecov (~> 0.22)
+
+BUNDLED WITH
+   2.4.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Blayne Farinha
+
+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,85 @@
+# Rack DigitalOcean AppPlatform Safelist
+
+Simple rack middleware for ruby applications hosted on Digital Ocean app platform to block ip addresses that are not
+safelisted via an environment variable.
+
+Simply add an environment variable called ALLOWED_IPS that contains a comma seperated list of ips that are allowed to
+access you application (you can use CIDR notation as well to safelist ips).
+
+Example:
+
+ALLOWED_IPS = "8.8.8.8, 8.8.4.4, 1.2.3.0/24"
+
+## Getting started
+
+### Installing
+
+Add this line to your application's Gemfile:
+
+```ruby
+# In your Gemfile
+
+gem "rack_do_app_platform_safelist"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack_do_app_platform_safelist
+
+### Plugging into the application
+
+Then tell your ruby web application to use the middleware.
+
+a) For __rails__ applications.
+
+```ruby
+# In config/initializers/rack_do_app_platform_safelist.rb
+
+require "rack_do_app_platform_safelist"
+
+Rails.application.config.middleware.insert_before(0, RackDoAppPlatformSafelist, logger: Rails.logger)
+```
+
+This will insert the middleware at the top of the middleware stack so it can block request before reaching any other
+middleware in your application
+
+b) For __rack__ applications:
+
+```ruby
+# In config.ru
+
+require "rack_do_app_platform_safelist"
+
+use RackDoAppPlatformSafelist
+run App.new
+```
+
+If you want to use a different environment variable for the whitelisted IPs you can pass it as an argument
+
+a) For __rails__ applications.
+
+```ruby
+# In config/initializers/rack_do_app_platform_safelist.rb
+
+require "rack_do_app_platform_safelist"
+
+Rails.application.config.middleware.insert_before(0, RackDoAppPlatformSafelist, logger: Rails.logger,
+                                                                                env_key: "SAFELISTED_IPS")
+```
+
+b) For __rack__ applications:
+
+```ruby
+# In config.ru
+
+require "rack_do_app_platform_safelist"
+
+use RackDoAppPlatformSafelist, env_key: "SAFELISTED_IPS"
+run App.new
+```
+
+The middleware will now look for the IP addresses to safelist in the SAFELISTED_IPS environment variable.

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/rack_do_app_platform_safelist/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class RackDoAppPlatformSafelist
+  VERSION = "1.0.0"
+end

data/lib/rack_do_app_platform_safelist.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "ipaddr"
+require "logger"
+
+require_relative "rack_do_app_platform_safelist/version"
+
+# Rack middleware for digital ocean app platform that will block any ip address that is not saflisted using the
+# ALLOWED_IPS enviroment variable by default.
+#
+#  Eg:
+#   ALLOWED_IPS = "8.8.8.8,8.8.4.4,1.2.3.0/24"
+class RackDoAppPlatformSafelist
+  attr_reader :allowed_ips
+
+  # @param logger [#info] the logger to use for messages. If nil it will use the value set in "rack.logger" if present
+  #   or create a new logger instance.
+  # @param env_key [#to_s] the environment variable to use to get the safelisted ips.
+  def initialize(app, logger: nil, env_key: "ALLOWED_IPS")
+    @app = app
+    @logger = logger
+    @allowed_ips = ENV.fetch(env_key.to_s, "").split(",").map(&:strip).uniq.map { |ip| IPAddr.new(ip) }
+  end
+
+  def call(env)
+    client_ip = extract_client_ip(env)
+    return @app.call(env) if safelisted_ip?(client_ip)
+
+    logger(env).info(error_message(client_ip))
+    [403, { "content-type" => "text/plain" }, ["Forbidden\n"]]
+  end
+
+  private
+
+  def safelisted_ip?(client_ip)
+    return false if client_ip.nil?
+
+    IPAddr.new(client_ip).then { |ip| allowed_ips.any? { |allowed_ip| allowed_ip.include?(ip) } }
+  end
+
+  def extract_client_ip(env)
+    # DigitalOcean's load balancer appends the client ip and the load balancer's ip to the X-Forwarded-For header so
+    # since we know there will always be one load balancer infront of your application on App Platform we can split the
+    # string on commas and the client ip will always be the second to last item in the array.
+    env["HTTP_X_FORWARDED_FOR"].to_s.split(",")[-2]
+  end
+
+  def error_message(client_ip)
+    message = client_ip.nil? ? "Could not determine client ip address" : "IP address #{client_ip} is not safelisted"
+
+    "Blocking request - #{message}"
+  end
+
+  def logger(env)
+    if @logger
+      @logger
+    elsif env["rack.logger"]
+      env["rack.logger"]
+    else
+      ::Logger.new(env["rack.errors"])
+    end
+
+    # return @logger if @logger
+    # return env["rack.logger"] if env["rack.logger"]
+
+    # ::Logger.new(env["rack.errors"])
+  end
+end

data/rack_do_app_platform_safelist.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/rack_do_app_platform_safelist/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rack_do_app_platform_safelist"
+  spec.version = RackDoAppPlatformSafelist::VERSION
+  spec.authors = ["Blayne Farinha"]
+  spec.email = ["blayne.farinha@gmail.com"]
+
+  spec.summary = "Rack middleware for safelisting IP addresses in DigitalOcean's App Platform"
+  spec.description = "Rack middleware for safelisting IP addresses using an environment variables in DigitalOcean's " \
+                     "App Platform"
+  spec.homepage = "https://github.com/blafri/rack_do_app_platform_whitelist"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/blafri/rack_do_app_platform_whitelist"
+  spec.metadata["changelog_uri"] = "https://github.com/blafri/rack_do_app_platform_whitelist/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: rack_do_app_platform_safelist
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Blayne Farinha
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-02-12 00:00:00.000000000 Z
+dependencies: []
+description: Rack middleware for safelisting IP addresses using an environment variables
+  in DigitalOcean's App Platform
+email:
+- blayne.farinha@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack_do_app_platform_safelist.rb
+- lib/rack_do_app_platform_safelist/version.rb
+- rack_do_app_platform_safelist.gemspec
+homepage: https://github.com/blafri/rack_do_app_platform_whitelist
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/blafri/rack_do_app_platform_whitelist
+  source_code_uri: https://github.com/blafri/rack_do_app_platform_whitelist
+  changelog_uri: https://github.com/blafri/rack_do_app_platform_whitelist/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key: 
+specification_version: 4
+summary: Rack middleware for safelisting IP addresses in DigitalOcean's App Platform
+test_files: []