Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yujideveloper/rack-bearer_auth

Middleware for using RFC 6750 bearer auth in Rack apps
https://github.com/yujideveloper/rack-bearer_auth

auth rack rack-middleware rails rfc-6750 ruby

Last synced: 11 days ago
JSON representation

Middleware for using RFC 6750 bearer auth in Rack apps

Host: GitHub
URL: https://github.com/yujideveloper/rack-bearer_auth
Owner: yujideveloper
License: mit
Created: 2018-05-09T15:08:45.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2021-06-09T04:04:49.000Z (over 3 years ago)
Last Synced: 2024-11-02T12:34:01.044Z (18 days ago)
Topics: auth, rack, rack-middleware, rails, rfc-6750, ruby
Language: Ruby
Size: 42 KB
Stars: 6
Watchers: 2
Forks: 2
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt

Awesome Lists containing this project

README

# Rack::BearerAuth

Rack::BearerAuth is middleware that make using [RFC 6750](https://tools.ietf.org/html/rfc6750) bearer auth in Rack apps.

[![Gem Version](https://badge.fury.io/rb/rack-bearer_auth.svg)](https://badge.fury.io/rb/rack-bearer_auth)
[![Build Status](https://travis-ci.org/yujideveloper/rack-bearer_auth.svg?branch=master)](https://travis-ci.org/yujideveloper/rack-bearer_auth)
[![Maintainability](https://api.codeclimate.com/v1/badges/db47f9a4e48bd30edb98/maintainability)](https://codeclimate.com/github/yujideveloper/rack-bearer_auth/maintainability)

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'rack-bearer_auth'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install rack-bearer_auth

## Configuration

### Rails configuration

``` ruby
module YourApp
class Application < Rails::Application

# ...

config.middleware.use Rack::BearerAuth::Middleware do
match path: "/foo" do |token|
# validate token
# AccessToken.where(token: token).exists?
end

match via: :all do |token|
# validate token
# AccessToken.where(token: token).exists?
end

match path: "/bar", via: %i[post patch delete], token: "some_token"
end
end
end
```

### Rack configuration

``` ruby
use Rack::BearerAuth::Middleware do
match path: "/foo" do |token|
# validate token
# AccessToken.where(token: token).exists?
end

match via: :all do |token|
# validate token
# AccessToken.where(token: token).exists?
end

match path: "/bar", via: %i[post patch delete], token: "some_token"
end

```

### Configration reference

#### matching options

* `path` (`String`, `Regexp`, `Proc` , `Array`): The HTTP request path matches for the resource.
* `via` (`Symbol`, `String`, `Regexp`, `Proc` , `Array`, `:all`): The HTTP request method matchs for the resource.
* `token` (`String`, `Regexp`, `Proc` , `Array`): The access token for the resource.

## Limitations

* [Form-Encoded Body Parameter(RFC 6750 section 2.2)](https://tools.ietf.org/html/rfc6750#section-2.2) is not supported.
* [URI Query Parameter(RFC 6750 section 2.3)](https://tools.ietf.org/html/rfc6750#section-2.3) is not supported.
* `scope` attribute is not supported.

## 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](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/yujideveloper/rack-bearer_auth.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).