How to use Laravel Socialite for Google login?

Install Laravel Socialite via Composer. 2. Create OAuth credentials in Google Cloud Console and set redirect URI. 3. Add GOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET, and GOOGLE_REDIRECT_URI to .env and configure in config/services.php. 4. Define routes for Google login and callback. 5. Create GoogleAuthController with redirectToGoogle and handleGoogleCallback methods to authenticate and log in user. 6. Add google_id, google_token, and google_refresh_token fields to users table via migration and include in User model's $fillable array. 7. Add a login button in Blade template linking to the Google login route, and optionally specify scopes for additional data access, ensuring email validation for security, completing the full Google login integration in Laravel using Socialite.

Using Laravel Socialite to implement Google login is straightforward. Here's a step-by-step guide to help you set it up properly in your Laravel application.

1. Install Laravel Socialite

First, install Laravel Socialite via Composer:

composer require laravel/socialite

Note: Laravel Socialite is a first-party package, so it’s well-maintained and integrates smoothly.

2. Configure Google OAuth Credentials

Go to the Google Cloud Console:

1. Create a new project or select an existing one.
2. Navigate to APIs & Services > Credentials.
3. Click Create Credentials > OAuth client ID.
4. Choose Web application.
5. Add authorized redirect URIs. For local development, use:

   http://your-app.test/login/google/callback

   or if using Laravel Sail or Valet:

   

   http://localhost:8000/login/google/callback

6. Save and copy the Client ID and Client Secret.

3. Add Google Credentials to .env

In your .env file, add the following:

GOOGLE_CLIENT_ID=your-google-client-id
GOOGLE_CLIENT_SECRET=your-google-client-secret
GOOGLE_REDIRECT_URI=http://localhost:8000/login/google/callback

Then, register these in config/services.php:

// config/services.php
'google' => [
    'client_id'     => env('GOOGLE_CLIENT_ID'),
    'client_secret' => env('GOOGLE_CLIENT_SECRET'),
    'redirect'      => env('GOOGLE_REDIRECT_URI'),
],

4. Set Up Routes

Add routes for redirecting to Google and handling the callback:

// routes/web.php
use Illuminate\Support\Facades\Route;
use App\Http\Controllers\Auth\GoogleAuthController;

Route::get('/login/google', [GoogleAuthController::class, 'redirectToGoogle'])
    ->name('login.google');

Route::get('/login/google/callback', [GoogleAuthController::class, 'handleGoogleCallback']);

5. Create the Controller

Generate the controller:

php artisan make:controller Auth/GoogleAuthController

Implement the methods:

// App/Http/Controllers/Auth/GoogleAuthController.php
<?php

namespace App\Http\Controllers\Auth;

use App\Http\Controllers\Controller;
use Illuminate\Http\Request;
use Laravel\Socialite\Facades\Socialite;
use App\Models\User;
use Illuminate\Support\Facades\Auth;

class GoogleAuthController extends Controller
{
    public function redirectToGoogle()
    {
        return Socialite::driver('google')->redirect();
    }

    public function handleGoogleCallback()
    {
        try {
            $googleUser = Socialite::driver('google')->user();
        } catch (\Exception $e) {
            return redirect('/login')->withErrors('Google login failed.');
        }

        // Find or create user
        $user = User::updateOrCreate([
            'google_id' => $googleUser->id,
        ], [
            'name' => $googleUser->name,
            'email' => $googleUser->email,
            'google_token' => $googleUser->token,
            'google_refresh_token' => $googleUser->refreshToken,
        ]);

        Auth::login($user);

        return redirect('/dashboard');
    }
}

? Tip: Store google_id in your users table to uniquely identify Google users. You may also want to add google_token if you plan to use Google APIs later.

6. Update Your User Model and Migration

Make sure your users table has the necessary fields:

php artisan make:migration add_google_fields_to_users_table --table=users

// migration file
public function up()
{
    Schema::table('users', function ($table) {
        $table->string('google_id')->nullable()->unique();
        $table->string('google_token')->nullable();
        $table->string('google_refresh_token')->nullable();
    });
}

Run the migration:

php artisan migrate

Also, add the fields to your User model's $fillable array:

// app/Models/User.php
protected $fillable = [
    'name',
    'email',
    'google_id',
    'google_token',
    'google_refresh_token',
];

7. Add Google Login Button in Your View

Example in a Blade file:

<!-- resources/views/auth/login.blade.php -->
<a href="{{ route('login.google') }}" class="btn btn-danger">
    Login with Google
</a>

Optional: Scopes and Additional Data

If you need more permissions (e.g., user's profile, email), you can add scopes:

return Socialite::driver('google')
    ->scopes(['openid', 'profile', 'email'])
    ->redirect();

By default, Socialite requests basic profile and email, so this is often not needed.

That’s it! You now have Google login working in your Laravel app using Socialite.

⚠️ Security Note: Always validate the email and consider email verification if you're allowing account creation based on Google login.

Basically just follow the flow: redirect → callback → get user → log in or register → redirect to dashboard.

The above is the detailed content of How to use Laravel Socialite for Google login?. For more information, please follow other related articles on the PHP Chinese website!