https://github.com/mikeheft/auth0_current_user

Gem to facilitate the inclusion of Auth0 basic setup. Also provides a current_user method
https://github.com/mikeheft/auth0_current_user

auth0 auth0-jwt authentication rails

Last synced: about 1 month ago
JSON representation

Gem to facilitate the inclusion of Auth0 basic setup. Also provides a current_user method

• Host: GitHub
• URL: https://github.com/mikeheft/auth0_current_user
• Owner: mikeheft
• License: mit
• Created: 2020-10-04T18:05:57.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-01-11T14:29:28.000Z (about 3 years ago)
• Last Synced: 2024-12-01T16:06:32.225Z (2 months ago)
• Topics: auth0, auth0-jwt, authentication, rails
• Language: Ruby
• Homepage:
• Size: 40 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Auth0CurrentUser

[![Gem Version](https://badge.fury.io/rb/auth0_current_user.svg)](https://badge.fury.io/rb/auth0_current_user)

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'auth0_current_user'

```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install auth0_current_user

## Usage

After including the gem in your Gemfile, run `rails g auth0_current_user:install` to install the initializer. This configuration of the gem is dependant on a couple of attributes:

  * `client_id`

    * This is the client id for your tenant. It is used to facilitate redirecting to the `/authorize` endpoint in `WebSecured` when the user's session has expired or is non-existant 

  * `auth0_domain`

    * This is the domain from setting up your Auth0 application.

  * `auth0_audience`

    * This is the api identifier that you chose when creating your api(M2M) application

  * `authenticated_klass`

    * Defaults to `User`, but if you have a different model name for the class that will be logging in and being authenticate, be sure to change that in the initializer.

    * accepted values are symbols or strings

      * :user, 'user', :User, 'User'

      * :my_user, 'my_user', :MyUser, 'MyUser'

To take advantage of the Auth0 authentication there are two flows you can use by simply including the relevant module in which ever controller you wish to lockdown.

1. Web

   a. `include Auth0CurrentUser::WebSecured` 

3. Api

   a. `include Auth0CurrentUser::ApiSecured` 

  

In either case, you will have access to the `current_user` method. The `WebSecured` will check for `current_user` or `session['userinfo']` and the `ApiSecured` will check against the JsonWebToken being passed in.

## Development

After checking out the repo, run `bin/setup` to install dependencies. 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/[USERNAME]/auth0_current_user. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/auth0_current_user/blob/master/CODE_OF_CONDUCT.md).

## License

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

## Code of Conduct

Everyone interacting in the Auth0CurrentUser project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/auth0_current_user/blob/master/CODE_OF_CONDUCT.md).