Important: This package is not actively maintained. For bug fixes and new features, please fork., (*1)
Eloquent OAuth L5
, (*2)
Note: Use the Laravel 4 package if you are using Laravel 4., (*3)
Eloquent OAuth is a package for Laravel 5 designed to make authentication against various OAuth providers ridiculously brain-dead simple. Specify your client IDs and secrets in a config file, run a migration and after that it's just two method calls and you have OAuth integration., (*4)
Video Walkthrough
, (*5)
Basic example
// Redirect to Facebook for authorization
Route::get('facebook/authorize', function() {
return SocialAuth::authorize('facebook');
});
// Facebook redirects here after authorization
Route::get('facebook/login', function() {
// Automatically log in existing users
// or create a new user if necessary.
SocialAuth::login('facebook');
// Current user is now available via Auth facade
$user = Auth::user();
return Redirect::intended();
});
Supported Providers
- Facebook
- GitHub
- Google
- LinkedIn
- Instagram
- Soundcloud
Feel free to open an issue if you would like support for a particular provider, or even better, submit a pull request., (*6)
Installation
Add this package using Composer
From the command line inside your project directory, simply type:, (*7)
composer require adamwathan/eloquent-oauth-l5, (*8)
Update your config
Add the service provider to the providers array in config/app.php:, (*9)
'providers' => [
// ...
AdamWathan\EloquentOAuthL5\EloquentOAuthServiceProvider::class,
// ...
]
Add the facade to the aliases array in config/app.php:, (*10)
'aliases' => [
// ...
'SocialAuth' => AdamWathan\EloquentOAuth\Facades\OAuth::class,
// ...
]
Publish the package configuration
Publish the configuration file and migrations by running the provided console command:, (*11)
php artisan eloquent-oauth:install, (*12)
Next, re-migrate your database:, (*13)
php artisan migrate, (*14)
If you need to change the name of the table used to store OAuth identities, you can do so in the eloquent-oauth config file., (*15)
Update your app information for the providers you are using in config/eloquent-oauth.php:, (*16)
'providers' => [
'facebook' => [
'client_id' => '12345678',
'client_secret' => 'y0ur53cr374ppk3y',
'redirect_uri' => 'https://example.com/facebook/login'),
'scope' => [],
]
]
Each provider is preconfigured with the scope necessary to retrieve basic user information and the user's email address, so the scope array can usually be left empty unless you need specific additional permissions. Consult the provider's API documentation to find out what permissions are available for the various services., (*17)
All done!, (*18)
Eloquent OAuth is designed to integrate with Laravel's Eloquent authentication driver, so be sure you are using the eloquent driver in app/config/auth.php. You can define your actual User model however you choose and add whatever behavior you need, just be sure to specify the model you are using with its fully qualified namespace in app/config/auth.php as well., (*19)
Custom providers
If you'd like to register a provider for a service that isn't supported out of the box, you can do so by first specifying the configuration needed for that provider in your config/eloquent-oauth.php:, (*20)
// config/eloquent-oauth.php
return [
'model' => User::class,
'table' => 'oauth_identities',
'providers' => [
'facebook' => [ /* ... */],
'google' => [ /* ... */],
'gumroad' => [
'client_id' => env('GUMROAD_CLIENT_ID'),
'client_secret' => env('GUMROAD_CLIENT_SECRET'),
'redirect_uri' => env('GUMROAD_REDIRECT_URI'),
'scope' => ['view_sales'],
],
],
];
Then specify which class should be used for that provider by extending EloquentOAuthServiceProvider with your own implementation that maps the provider name to a provider class:, (*21)
class MySocialAuthServiceProvider extends EloquentOAuthServiceProvider
{
protected function getProviderLookup()
{
// Merge the default providers if you like, or override entirely
// to skip loading those providers completely.
return array_merge($this->providerLookup, [
'gumroad' => GumroadProvider::class
]);
}
}
Don't forget to use your extension of the provider in config/app.php instead of the one supplied by the package., (*22)
If your provider follows the same __construct($config, $httpClient, $request) parameter signature that the default providers use, you're done., (*23)
If not, make sure you bind your provider to the IOC container in another provider, and the package will make sure to fetch the implementation from the container instead of trying to construct it itself., (*24)
To get an idea of how the providers work, take a look at how the packaged providers are implemented:, (*25)
- https://github.com/adamwathan/socialnorm-google
- https://github.com/adamwathan/socialnorm-github
- https://github.com/adamwathan/socialnorm-instagram
- https://github.com/adamwathan/socialnorm-soundcloud
- https://github.com/adamwathan/socialnorm-facebook
- https://github.com/adamwathan/socialnorm-linkedin
Usage
Authentication against an OAuth provider is a multi-step process, but I have tried to simplify it as much as possible., (*26)
Authorizing with the provider
First you will need to define the authorization route. This is the route that your "Login" button will point to, and this route redirects the user to the provider's domain to authorize your app. After authorization, the provider will redirect the user back to your second route, which handles the rest of the authentication process., (*27)
To authorize the user, simply return the SocialAuth::authorize() method directly from the route., (*28)
Route::get('facebook/authorize', function() {
return SocialAuth::authorize('facebook');
});
Authenticating within your app
Next you need to define a route for authenticating against your app with the details returned by the provider., (*29)
For basic cases, you can simply call SocialAuth::login() with the provider name you are authenticating with. If the user
rejected your application, this method will throw an ApplicationRejectedException which you can catch and handle
as necessary., (*30)
The login method will create a new user if necessary, or update an existing user if they have already used your application
before., (*31)
Once the login method succeeds, the user will be authenticated and available via Auth::user() just like if they
had logged in through your application normally., (*32)
use SocialNorm\Exceptions\ApplicationRejectedException;
use SocialNorm\Exceptions\InvalidAuthorizationCodeException;
Route::get('facebook/login', function() {
try {
SocialAuth::login('facebook');
} catch (ApplicationRejectedException $e) {
// User rejected application
} catch (InvalidAuthorizationCodeException $e) {
// Authorization was attempted with invalid
// code,likely forgery attempt
}
// Current user is now available via Auth facade
$user = Auth::user();
return Redirect::intended();
});
If you need to do anything with the newly created user, you can pass an optional closure as the second
argument to the login method. This closure will receive the $user instance and a ProviderUserDetails
object that contains basic information from the OAuth provider, including:, (*33)
- User ID
- Nickname
- Full Name
- Email
- Avatar URL
- Access Token
SocialAuth::login('facebook', function($user, $details) {
$user->nickname = $details->nickname;
$user->name = $details->full_name;
$user->profile_image = $details->avatar;
$user->save();
});
Note: The Instagram and Soundcloud APIs do not allow you to retrieve the user's email address, so unfortunately that field will always be null for those providers., (*34)
Advanced: Storing additional data
Remember: One of the goals of the Eloquent OAuth package is to normalize the data received across all supported providers, so that you can count on those specific data items (explained above) being available in the $details object., (*35)
But, each provider offers its own sets of additional data. If you need to access or store additional data beyond the basics of what Eloquent OAuth's default ProviderUserDetails object supplies, you need to do two things:, (*36)
-
Request it from the provider, by extending its scope:, (*37)
Say for example we want to collect the user's gender when they login using Facebook., (*38)
In the config/eloquent-oauth.php file, set the [scope] in the facebook provider section to include the public_profile scope, like this:, (*39)
'scope' => ['public_profile'],
For available scopes with each provider, consult that provider's API documentation., (*40)
Note: By increasing the scope you will be asking the user to grant access to additional information. They will be informed of the scopes you're requesting. If you ask for too much unnecessary data, they may refuse. So exercise restraint when requesting additional scopes., (*41)
-
Now where you do your SocialAuth::login, store the to your $user object by accessing the $details->raw()['KEY'] data:, (*42)
SocialAuth::login('facebook', function($user, $details) (
$user->gender = $details->raw()['gender'];
$user->save();
});
Tip: You can see what the available keys are by testing with dd($details->raw()); inside that same closure., (*43)
Wallogit.com
