README

Butler manages multiple Socialite authentication for your Laravel app.

In a few simple steps you can allow users to log in to your site using multiple providers.

Butler is built to work alongside standard Laravel authentication, and uses Socialite to connect to authentication providers.

Requirements

Install Socialite - follow the documentation on the Laravel site.
Set up your Socialite providers (you may need to install extra Socialite Providers).

Installation

Install Butler using composer: composer require konsulting/laravel-butler
If you are using Laravel 5.5, Butler will auto-register the service provider and the Facade. However, if you have chosen not to auto-register, or are using an earlier version, add Butler's Service Provider to config/app.php

'providers' => [
    // Other service providers...

    Konsulting\Butler\ButlerServiceProvider::class,
],

Add Butler's Facade to config/app.php

'aliases' => [
    // Other aliases...

    'Butler' => Konsulting\Butler\ButlerFacade::class,
],

Add Butler's routes to app/Providers/RouteServiceProvider.php

class RouteServiceProvider ...

public function map()
{
    $this->mapApiRoutes();

    $this->mapWebRoutes();

    \Butler::routes();
}

Publish configuration and adjust for your site php artisan vendor:publish --provider=Konsulting\\Butler\\ButlerServiceProvider --tag=config

Adjust in config/butler.php. Add the providers you want to make available for Authentication - these map directly to Socialite drivers. There are examples in the published file.

    // Other Settings

    'providers' => [
        'google' => [
            'name' => 'Google',
            'scopes' => [], // define any specific scopes you want to request here
            'icon' => 'fa fa-google',
            'class' => 'btn-google',
        ],
        ...
    ]

See configuration options for more information.

Optionally add list of Oauth buttons to your login page, and status feedback.

Add the following includes to your blade template for the login page.

@include('butler::status')

@include('butler::list')

Configuration Options

There is a small set of configuration options.

Option	What it’s for
user_provider	It finds and creates users for Butler. Only creating if it is allowed to.
social_identities_table_name	The table used for storing social identities
user_class	The applications user model, used by the user provider, and the SocialIdentity class to set up the user relation.
providers	The list of Social Login providers that Butler needs to be aware of. (These are essentially the Socialite Drivers you are using). It is used to populate the Notification to users and the list view, we also allow a list of scopes to request to be set here.
can_create_users	Sets whether Butler is allowed to create users when a new Social Identity is received and there is no matching user account.
confirm_identity_for_new_user	Sets whether to ask the user to confirm the identity if it is their first one and they just created the account.
confirm_identity_notification	The Notification class to use when telling the user that we had a Social Identification request. Sent when using the AuthController.
can_associate_to_logged_in_user	Allow Butler to associate a new identity to the logged in user, rather than matching on email address.
login_immediately_after_confirm	Should we log someone in straight after confirming via email, default is false.
route_map	Defines the mapping of Butler's name for special routes in the application to actual application values. We’ve set some common ones out of the box.

Butler Driver

We wrap the socialite driver in a Butler Driver which adds a methods to refresh() a social identity using the refresh token. It will also proxy all the usual SocialiteProvider methods to the orginal provider.

	$driver = \Butler::driver(string $providerName); // For a specific social identity, this would be $socialIdentity->provider
	$driver->refresh($socialIdentity);

Security

We have not encrypted any of the retrieved tokens at this time, since the tokens are intended to be short-lived. We’re happy to receive views on this decision.

If you find any security issues, or have any concerns, please email keoghan@klever.co.uk, rather than using the issue tracker.

Contributing

Contributions are welcome and will be fully credited. We will accept contributions by Pull Request.

Please:

Use the PSR-2 Coding Standard
Add tests, if you’re not sure how, please ask.
Document changes in behaviour, including readme.md.

Testing

We use PHPUnit and the excellent orchestral/testbench

Run tests using PHPUnit: vendor/bin/phpunit

konsulting / laravel-butler

Maintainers

Details