dinks / cloudfront-rails

Proxy whitelist for Cloudfront proxies for Rails 4 / 5

Cloudfront::Rails

This Gem is a shameless copy of cloudflare-rails, but for CloudFront

Installation

This gem supports Rails 4 and 5

Add this line to your application's Gemfile:

group :production do
  gem 'cloudfront-rails'
end

And then execute:

$ bundle

Or install it yourself as:

$ gem install cloudfront-rails

Usage

The code gets the list of proxies from https://ip-ranges.amazonaws.com/ip-ranges.json, updates the cache accordingly. This then whitelists these proxy ranges so that request.ip and request.remote_ip does not return these proxies.

For configuration

config.cloudfront.expires_in = 1.hour # Cache expiry for the ips
config.cloudfront.timeout = 2.seconds # Timeout for the http access

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 tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/dinks/cloudfront-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.