actionpack-cloudfront_viewer_address 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 34e070576256e4c00774f58897bd6a5aebf0be15128138d7357aec5e9df40bab
+  data.tar.gz: 3a4bad860e9118c8f398d4720231375292303a791f554f463b87330f2e08db4c
+SHA512:
+  metadata.gz: 5ed5990d238e93abc38b0909d254111b18f793219819d5f3edd97e37f1320f100a7748ce2c8189131811ef3e6452efb5c721314021989c238067f5302ad5a017
+  data.tar.gz: 33b93f477e26eb7562d9e5dfb331e46cf19289c8941abb462ae0c2ddef5eb503e8ec781b92d67fb68fdc824d40e356e9d1693277d7e0bf9222edde27b82f9d03

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,25 @@
+require:
+  - rubocop-performance
+  - rubocop-rails
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-rspec_rails
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+Layout/LineLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2024-09-30
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Tomohiko Mimura
+
+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,71 @@
+# ActionPack::CloudfrontViewerAddress
+
+Calculate the remote IP ( `request.remote_ip` ) using `CloudFront-Viewer-Address`.
+
+> [!CAUTION]
+> Be sure to configure security groups and other settings so that HTTP requests go through Amazon CloudFront.  
+> Otherwise, the `CloudFront-Viewer-Address` will be freely modified and IP spoofing.
+
+## Why do you need this Gem?
+
+If you use 'Amazon CloudFront' as the Proxy for Rails App, the remote IP ( `request.remote_ip` ) will be set to the CloudFront IP.  
+To work around this problem, it was necessary to calculate the remote IP address using a combination of `X-Forwarded-For` and the 'IP address of a trusted Proxy'.
+Like these Gem...
+
+* https://github.com/dinks/cloudfront-rails
+* https://github.com/customink/actionpack-cloudfront
+
+However, CloudFront provides a more concise solution to this problem with `CloudFront-Viewer-Address`.  
+This Gem is intended to make this functionality more concise for use in Rails applications.
+
+## Usage
+
+### Step1. Amazon CloudFront Setup
+
+Before using this Gem, modify your Amazon CloudFront configuration to enable `CloudFront-Viewer-Address`.  
+Please refer to the following for details on how to set up.
+
+* https://aws.amazon.com/about-aws/whats-new/2021/10/amazon-cloudfront-client-ip-address-connection-port-header/
+* https://dev.classmethod.jp/articles/amazon-cloudfront-client-ip-address-connection-port-header/ (written in Japanese)
+
+### Step2. This `ActionPack::CloudfrontViewerAddress` Gem Install
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add actionpack-cloudfront_viewer_address
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install actionpack-cloudfront_viewer_address
+
+### Step3. Rack middleware
+
+**If you are using Rails, omit this as it will be set automatically.**  
+Otherwise, set the middleware as `middleware.insert_after ActionDispatch::RemoteIp, ActionPack::CloudfrontViewerAddress::RemoteIp`.
+
+### Step4. Use `request.remote_ip`
+
+Otherwise, no special processing is required.  
+The client's IP address can be obtained by referring to `request.remote_ip` as usual.
+
+## About IP spoofing
+
+This Gem only references the `CloudFront-Viewer-Address` request header.  
+The `CloudFront-Viewer-Address` header is not improved if the request is made to a Rails application via Amazon CloudFront.  
+However, if the request is made to a Rails application without going through Amazon CloudFront, the `CloudFront-Viewer-Address` can be freely rewritten and there is a risk of IP spoofing.
+
+**Please keep this in mind.**
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tmimura39/actionpack-cloudfront_viewer_address.
+
+## 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/action_pack/cloudfront_viewer_address/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "remote_ip"
+
+module ActionPack
+  module CloudfrontViewerAddress
+    class Railtie < ::Rails::Railtie
+      initializer "actionpack_cloudfront_viewer_address.configure_rails_initialization" do |app|
+        app.config.middleware.insert_after ActionDispatch::RemoteIp, ActionPack::CloudfrontViewerAddress::RemoteIp
+      end
+    end
+  end
+end

data/lib/action_pack/cloudfront_viewer_address/remote_ip.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "action_dispatch"
+
+module ActionPack
+  module CloudfrontViewerAddress
+    class RemoteIp
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        req = ::ActionDispatch::Request.new(env)
+        if env["HTTP_CLOUDFRONT_VIEWER_ADDRESS"].present?
+          # IPv4 "HTTP_CLOUDFRONT_VIEWER_ADDRESS" = "1.1.1.1:3000"
+          # IPV6 "HTTP_CLOUDFRONT_VIEWER_ADDRESS" = "0000:0000:0000:0000:0000:0000:0000:0000:3000"
+          req.remote_ip = req.env["HTTP_CLOUDFRONT_VIEWER_ADDRESS"].sub(/:\d+\z/, "") # remove `port(:0000)` part
+        end
+        app.call(req.env)
+      end
+
+      private
+
+      attr_reader :app
+    end
+  end
+end

data/lib/action_pack/cloudfront_viewer_address/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActionPack
+  module CloudfrontViewerAddress
+    VERSION = "1.0.0"
+  end
+end

data/lib/action_pack/cloudfront_viewer_address.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "cloudfront_viewer_address/version"
+require_relative "cloudfront_viewer_address/remote_ip"
+
+require_relative "cloudfront_viewer_address/railtie" if defined?(Rails::Railtie)
+
+module ActionPack
+  module CloudfrontViewerAddress
+  end
+end

data/lib/actionpack/cloudfront_viewer_address.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "action_pack/cloudfront_viewer_address"

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: actionpack-cloudfront_viewer_address
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tomohiko Mimura
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  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: Utilize `CloudFront-Viewer-Address`, a custom CloudFront header, to calculate
+  RemoteIp more simply
+email:
+- mito.5525@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/action_pack/cloudfront_viewer_address.rb
+- lib/action_pack/cloudfront_viewer_address/railtie.rb
+- lib/action_pack/cloudfront_viewer_address/remote_ip.rb
+- lib/action_pack/cloudfront_viewer_address/version.rb
+- lib/actionpack/cloudfront_viewer_address.rb
+homepage: https://github.com/tmimura39/actionpack-cloudfront_viewer_address
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/tmimura39/actionpack-cloudfront_viewer_address
+  source_code_uri: https://github.com/tmimura39/actionpack-cloudfront_viewer_address
+  changelog_uri: https://github.com/tmimura39/actionpack-cloudfront_viewer_address/tree/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.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.18
+signing_key:
+specification_version: 4
+summary: Calculate RemoteIp based on `CloudFront-Viewer-Address` Header
+test_files: []