Cerberus

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/cerberus. To experiment with that code, run bin/console for an interactive prompt.

Installation

Add this line to your application's Gemfile:

gem "cerberus"

And then execute:

$ bundle

Or install it yourself as:

$ gem install cerberus

Usage

Configure Cerberus with required information:

Cerberus.configure do |config|
  config.jwt = {
    rsa_public: ENV["JWT_RSA_PUBLIC"],
    algorithm: "RS256",
    issuer: "org.website.project",
    enabled: ->(env) { Rails.env.production? }
  }.freeze

  config.basic = {
    username_digest: ::Digest::SHA256.hexdigest("test"),
    password_digest: ::Digest::SHA256.hexdigest("test"),
    enabled: ->(env) { env["PATH_INFO"].start_with?("/protected") }
  }.freeze
end

require "cerberus/jwt"
require "cerberus/basic"

And then just inject a middleware:

config.middleware.use Cerberus::Jwt
config.middleware.use Cerberus::Basic

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/[USERNAME]/cerberus.

License

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