Code Monkey home page Code Monkey logo

laravel-oauth2-login's Introduction

Laravel OAuth2 Login

Software License Latest Stable Version Build Status

This is a Laravel5+ package that provides a middleware to protect routes requiring an OAuth2 login.

You could describe it as a bridge between Laravel and league/oauth2-client.

Features

  • OAuth2 client middleware
  • Keeps token in session
  • Refreshes expired tokens
  • (Cached) resource owner info
  • Driver to allow use of Auth facade

Install

  • Using composer: $ composer require kronthto/laravel-oauth2-login
  • Register the service provider (Auto-Discovery enabled): Kronthto\LaravelOAuth2Login\ServiceProvider
  • Publish the config file: $ artisan vendor:publish --provider="Kronthto\LaravelOAuth2Login\ServiceProvider"
  • Put the credentials of your OAuth Provider in the published config

Usage

Add the Kronthto\LaravelOAuth2Login\CheckOAuth2 middleware to the routes (-groups) you want to protect.

Bear in mind that this only ensures that some user is logged in, if you require further authorization checks those will still have to be implemented. This package stores the resource owner info as an Request-attribute to enable you to do so.

This redirects unauthenticated users. If on some routes you only want to check whether a session by this package exists (for instance to display a login/logout button in your template) use Kronthto\LaravelOAuth2Login\OnlyCheckOAuth. It will also refresh tokens and pull up to date resource owner data, but never redirect. On failure it just doesn't set the Request attribute.

Auth guard

This is optional, as adding the middleware redirects the client anyways if not authenticated. If you want to utilize Policies however you will need to define a custom guard. A driver for it is provided by this package.

In your auth config, add the new guard like this:

  'oauth2' => [
    'driver' => 'oauth2', // Config: oauth2login.auth_driver_key
  ]

You will need to assign a higher priority to CheckOAuth2 than \Illuminate\Auth\Middleware\Authenticate, do this by overriding $middlewarePriority in your Http-Kernel.

Changelog

Please see the CHANGELOG for more information on what has changed recently.

Credits

License

The MIT License (MIT). Please see the License File for more information.

laravel-oauth2-login's People

Contributors

kronthto avatar subtronic avatar

Watchers

James Cloos avatar  avatar

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.