Git Product home page Git Product logo

rack-cloudflare-access's Introduction

Rack::CloudflareAccess

This is a rack middleware to add Cloudflare access to your application. This means that you can turn on SSO with Cloudflare Zero Trust and ensure all requests to your application are authenticated.

This middleware is also designed to work with Rails and to raise an error that is captured by Rails error handling if any part of the process fails.

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add rack-cloudflare-access

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install rack-cloudflare-access

Usage

Authenticating Users

You will need to have a Cloudflare the team url and AUD (audience). You can follow the Cloudflare Zero Trust Getting Started Guide followed by the Validating JSON guide in order to get your AUD.

In order to retreive your AUD you will need to decrypt a JWT token generated by Cloudflare for your application. It used to be possible to access this from your Cloudflare Dashboard but I can no longer find it. An AUD is required to ensure tokens from other applcations are not used to access your application.

[add how to get AUD or contact support]

Once you have these, you can add the middleware to your Rack application. In rails you can create an initializer:

config/initializers/cloudflare_access.rb

Rails.application.config.middleware.use(Rack::CloudflareAccess::Middleware, <teams_url>, <AUD>)

Rack, in your config.ru file add:

use(Rack::CloudflareAccess::Middleware, <teams_url>, <AUD>)

Replace the AUD and the teams_url with those from Cloudflare.

Authorising and Identifying Users

  • Here is how you can find the subject
  • Email - can change.

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/TigerWolf/rack-cloudflare-access. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

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

Code of Conduct

Everyone interacting in the Rack::Cloudflare::Access project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Future improvements and features

  • Allow for urls to be filtered out (e.g. login)
  • More efficient HTTP library for getting the certs - for now just keep it simple
  • Better rails integration? .present? and deep_symbolize_keys! could use quite useful

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.