Implementing social account authentication is very popular these days. It is easy and powerful method for user authentication, social account authentication takes less effort from user for registration or login on your system. there is no need for the user to remember the username and password.
Table Of Content
1 Prerequisites
1.) PHP version of 8.2
2.) MySql
3.) Github Account
2 Introduction
In this article, I am going to show you how to implementation social account authentication to your Laravel application.
We’ll be using Laravel external libraries such as Socialite and Breeze Package.
Laravel provides a package to authenticate with OAuth providers using Laravel Socialite. Although, this package is not pre-installed in laravel.
Laravel Socialite supports authentication only for the following social account providers:
Facebook
Twitter
LinkedIn
Google
GitHub
GitLab
Bitbucket
Slack.
3 Create / Install a Laravel Project
3.1 Install Laravel Project
First, make sure your computer has a composer.
Use the following command to install new Laravel Project.
Upon logging in, the user's record will be stored in the database. This process involves accessing the .env file to input and define the database credentials.
We will use Laravel Breeze as an example of our existing authentication implementation.
4.1 Install Breeze Package
Use the following command to Install Laravel Breeze Package
composer require laravel/breeze --dev
After Composer has installed the Laravel Breeze package, you should run the breeze:install Artisan command. This command publishes the authentication views, routes, controllers, and other resources to your application.
php artisan breeze:install
php artisan migrate
npm install
npm run dev
4.2 Install Socialite Package
Use the following command to Install Laravel Socialite Package
composer require laravel/socialite
5 Create GitHub OAuth Application
5.1 Login into GitHub Account
If you have GitHub Developer Account Go to https://github.com/settings/developers, else you can easily create one directly from the GitHub Account.
5.2 Register new OAuth Application
After Successfuly Login , Goto Settings Menu
Click "Developer Settings" from Left Side menu
Go To OAuth apps then Click "New OAuth App" Button
Fill all the details in "Register a new OAuth application" Form, also fill the Authorization callback URL. This is the URL that we will use to redirect user after they choose their GitHub account to login to our web. For example here I use http://127.0.0.1:8000/callback/github for the callback URL.
After clicking on Register application button , you will receive a Client ID and Client Secrets. copy these keys into your .env file.
6 Configure Github App Credentials
6.1 Add the Github API Credentials in .env
Insert the Client ID and Client Secret key and redirect URI into the .env file, Which we obtained from previous step GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET. Additionally, include a new key in the .env file called GITHUB_REDIRECT_URI and populate it with the callback URI used in the Github API Console.
GITHUB_CLIENT_ID=Your Client ID
GITHUB_CLIENT_SECRET=Your Client Secret
GITHUB_REDIRECT_URI=http://127.0.0.1:8000/callback/github
6.2 Add the Github API .env key in config/services.php
Open the config/services.php file and Insert the Github OAuth Credentials
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
public function up()
{
Schema::table('users', function (Blueprint $table) {
$table->string('github_id')->after('password')->nullable()->unique();
});
}
public function down()
{
Schema::table('users', function (Blueprint $table) {
$table->dropColumn('github_id');
});
}
};
Use the following command to run the migration to update your database.
php artisan migrate
6.4 Update the User Model
In your User model , Include github_id in the fillable array of the User Model. app/Models/User.php
<?php
namespace App\Models;
// use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
class User extends Authenticatable
{
use HasFactory, Notifiable;
/**
* The attributes that are mass assignable.
*
* @var array
*/
protected $fillable = [
'name',
'email',
'password',
'github_id'
];
/**
* The attributes that should be hidden for serialization.
*
* @var array
*/
protected $hidden = [
'password',
'remember_token',
];
/**
* Get the attributes that should be cast.
*
* @return array
*/
protected function casts(): array
{
return [
'email_verified_at' => 'datetime',
'password' => 'hashed',
];
}
}
?>
7 Create New Controller - GithubLoginController
Now create a controller "GithubSocialiteController" and add redirectToGithub() and handleGithubCallback() methods
Use the following artisan command to Create Controller.
<?php
namespace App\Http\Controllers\Auth;
use App\Http\Controllers\Controller;
use App\Models\User;
use Auth;
use Exception;
use Socialite;
class GithubSocialiteController extends Controller
{
public function redirectToGithub()
{
// redirect user to "login with Github account" page
return Socialite::driver('github')----->redirect();
}
public function handleCallback()
{
try {
// get user data from Github
$user = Socialite::driver('github')->user();
//dd($user);
// find user in the database where the social id is the same with the id provided by Github
$finduser = User::where('github_id', $user->id)->first();
if ($finduser) // if user found then do this
{
// Log the user in
Auth::login($finduser);
// redirect user to dashboard page
return redirect('/dashboard');
}
else
{
// if user not found then this is the first time he/she try to login with Github account
// create user data with their Github account data
$newUser = User::create([
'name' => $user->name,
'email' => $user->email,
'github_id' => $user->id,
'password' => bcrypt('my-github'), // fill password by whatever pattern you choose
]);
Auth::login($newUser);
return redirect('/dashboard');
}
}
catch (Exception $e)
{
dd($e->getMessage());
}
}
}
?>
8 Define a Route for Socialite Login with Github
Define routes for the GithubSocialiteController in the web.php file routes/web.php
Route::get('auth/github', [GithubSocialiteController::class, 'redirectToGithub']); // redirect to Github login
Route::get('callback/github', [GithubSocialiteController::class, 'handleCallback']); // callback route after Github account chosen
9 Update Login Blade File With Github Button
Create the Link in the login view to Show Github Sign-in Button resources/views/auth/login.blade.php
Use the following artisan command to Test the App.
php artisan serve
Visit the URL http://127.0.0.1:8000
12 Conclusion
That’s all we need to do.
Now the Github Sign-In Implementation completed in Laravel application with the help of Laravel Socialite and Breeze package.
