Project

actionpack-cloudfront_viewer_address

0.0
The project is in a healthy, maintained state
actionpack-cloudfront_viewer_addresstmimura39/actionpack-cloudfront_viewer_addressHomepageDocumentationSource CodeBug Tracker
Utilize `CloudFront-Viewer-Address`, a custom CloudFront header, to calculate RemoteIp more simply
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
1,289
Stars
0
Forks
0
Watchers
1
 Releases
Current version
1.0.0
Total releases
1
First release
2024-09-30
Latest release
2024-09-30
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2024-09-29
Reverse Dependencies
0

 Dependencies

Runtime

actionpack
>= 0
 Project Readme

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...

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.

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.

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.