mckenziearts/laravel-oauth

Social OAuth authentication for Laravel 5. Drivers: Facebook, Twitter, Google, LinkedIn, Github

1.0.6 2018-07-19 20:30 UTC

Requires

• illuminate/support: ~5
• laravel/socialite: ^3.0

Requires (Dev)

• orchestra/testbench: ~3.0
• phpunit/phpunit: ~6.0

MIT

• Arthur Monney

• oauth
• laravel
• laravel-socialite

README

Introduction

Social OAuth authentication for Laravel 5 which provides oAuth support in PHP 5.3+ and is very easy to integrate with any project which requires an oAuth client. This package use Laravel Socialite. For Laravel 4 look this package

Supported services

The library supports OAuth 2.0 compliant services. A list of currently implemented services can be found below. More services will be implemented soon.

Included service implementations:

• OAuth2
  • Facebook
  • GitHub
  • Google
  • Instagram
  • LinkedIn
  • Bitbucket
  • Twitter
  • Dribbble
  • Pinterest
  • Youtube
  • Gitlab
• more to come!

Laravel Support version

Installation

1. Include the package in your project using Composer

$ composer require mckenziearts/laravel-oauth

1. Add the service provider to your config/app.php providers array:

   For Laravel 5.5.+ - you're done.

Mckenziearts\LaravelOAuth\LaravelOAuthServiceProvider::class,

1. Publish the Vendor Assets files by running:

php artisan vendor:publish --provider="Mckenziearts\LaravelOAuth\LaravelOAuthServiceProvider"

1. Now that we have published a few new files to our application we need to reload them with the following command:

composer dump-autoload

Configuration

When you published the vendor assets you added a new file inside of your config folder which is called config/laravel-oauth.php. This file contains a bunch of configuration you can use to configure your connexion using social networks.

First, you have to add your service like is defined on The official documentation of Socialite available here. Just setup your Oauth services for your application. Laravel/socialite is automatically installed by this package.

Usage

1. Fisrt of all in the config/laravel-oauth.php file you must define the default users table name to simplify migrations. By default users table is used

'users' => [
    'table'   => 'users',
],

1. Secondly you must specify the providers to use for social login in the providers array. To active a provider set the value to true

  'providers' => [
    'facebook'  => true,
    'google'    => true,
    'github'    => true,
  ],

The last configuration is to stylize the button by editing class name and add or remove icon

Next, if you may want to re-publish the laravel-oauth assets, config, and the migrations run the following command:

php artisan vendor:publish --tag=laravel-oauth.assets --force
php artisan vendor:publish --tag=laravel-oauth.config --force
php artisan vendor:publish --tag=laravel-oauth.migrations --force

1. Next to make sure you have the latest database schema run:

php artisan migrate

1. Inside of your master.blade.php file include a header yield. Inside the head of your master or app.blade.php add the following:

@yield('css')

1. Add the blade directive to your view where you want to display the socials buttons. The directive takes a parameter login to display the login text or resgister for the text related to the registration

@socialite('login')

1. Add the style of the buttons by adding this to your view in the section in the @yield('css') who defined in your master layout

@section('css')
    <link href="{{ url('/vendor/mckenziearts/laravel-oauth/assets/css/socialite.css') }}" rel="stylesheet">
@endsection

1. In the Auth\LoginController of your application, add the OAuthSocialite trait:

namespace App\Http\Controllers\Auth;

use App\Http\Controllers\Controller;
use Illuminate\Foundation\Auth\AuthenticatesUsers;
use Mckenziearts\LaravelOAuth\Traits\OAuthSocialite;

class LoginController extends Controller
{
    use OAuthSocialite;
    ..

With this feature you can overwrite the present methods on the trait if you want to customize them even more

1. Add this routes to your default web route file

Route::get('/auth/{provider}', 'Auth\LoginController@redirectToProvider');
Route::get('/callback/{provider}', 'Auth\LoginController@handleProviderCallback');

Change log

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

Testing

$ composer test

Contributing

Please see contributing.md for details and a todolist.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Arthur Monney
• Laravel Socialite

License

MIT. Please see the license.md for more information.