README

Seamlessly integrate Google OAuth2 Single Sign-On into your Laravel application with this streamlined package. Born out of the need to efficiently implement Google OAuth2 authentication across multiple projects, this package leverages Laravel's Socialite under the hood, adhering to best practices while simplifying the setup process. It bundles the necessary components, controllers, and routes for an effortless implementation.

Installation

Install via Composer:

composer require motomedialab/laravel-google-signin

The package will auto-register. Next, add your Google Client ID and Secret to your .env file (see below for instructions if you haven't set these up yet).

GOOGLE_OAUTH_CLIENT_ID=your-client-id
GOOGLE_OAUTH_CLIENT_SECRET=your-client-secret

Using the "Sign in with Google" button

This package includes a ready-to-use "Sign in with Google" button. You can include it in your views as a blade component:

<x-google-signin::button />

For further styling, publish the button view to your project:

php artisan vendor:publish --tag=views-google-signin

That's it! You've successfully added Google SSO to your Laravel project. If you haven't already, you'll need to obtain your Google Client ID and Secret from the Google Developer Console.

Getting your Google Client ID and Secret

Visit the Google Developer Console
Create a new project or select an existing one
Navigate to the "Credentials" tab
Click the "Create Credentials" button and choose "OAuth client ID".
Select "Web application" as the application type
Add the URL to your callback route to the "Authorized redirect URIs" list
1. you can find this by running php artisan route:list --name=google-signin.store
Click "Create" to generate your Client ID and Secret
Copy the generated ID and secret to your .env file as per Configuration

Further customisation

To tailor the package's behavior further, such as modifying the login process, publish the configuration file and override the default settings:

php artisan vendor:publish --tag=config-google-signin

So what does it actually do?

From a technical standpoint this package adds a google_id column to your users table. When a user attempts to log in with Google, we'll check if a user with the same Google ID already exists - if it does, we'll log them in.

If it doesn't, and there's a user with a matching email address, we'll link the Google ID to that user and log them in.

If both checks fail, we'll return a 403 forbidden response. It's important to note that a user must have a corresponding Google email address already registered on your platform to be able to gain access.

We store the Google ID to prevent future 'email hijacking' attacks, where a user could change their email address to one that's already in use/was in use by another user.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security-related issues, please email technical@motocom.co.uk instead of using the issue tracker.

License

This package is licensed under the MIT License. See the LICENSE file for more information.

Need help with your next project?

This plugin is maintained and developed by MotoMediaLab, a full-service agency based in the UK. Contact us for assistance with your next project!

motomedialab / laravel-google-signin

Maintainers

Details