README

Laravel Auth Router

Social Login made easy

Laravel Auth Router streamlines adding multiple social logins to your Laravel app, saving significant developer effort. Forget complex setups; this package leverages Laravel Socialite to offer a vastly simplified experience.

• One-Liner Route Setup: Instead of extensive controller code and numerous route definitions for each provider, a single line in your routes file can manage login, callback, and logout.
• Pre-Built Provider Chooser: Get an immediate, customizable page on your domain for users to select their login method – no manual UI building required.
• Rapid Configuration: Minimal setup is needed due to a unified route helper and familiar service configuration.
• Developer Conveniences: Includes multi-language support (DE/EN), dark mode for the chooser, and session-based error messages for easy integration into your Blade views.

It automatically handles routing, offers flexible customization for redirects and user registration, and prevents route conflicts, letting you focus on core features instead of auth boilerplate.

Contents

• Laravel Auth Router
  • Contents
  • Installation
  • Basic concept
  • Login and Logout flow
  • Name conflicts
  • Configuration
  • Errors
    • Setup errors
    • Runtime errors
  • Example Google login
  • Advanced Example
• Providers
  • Amazon Provider
  • Google Provider
  • Linkedin Provider
  • Microsoft Provider
  • Paypal Provider
  • Auth0 Provider
  • Facebook Provider
  • Stripe Provider

Installation

Install the package with composer:

  composer require schenke-io/laravel-auth-router

Basic concept

This package includes services and has to be configured in config/services.php only.

In the routes/web.php file you add the Route helper authRouter to define which providers you want to use and your registration policy.

Route::authRouter(/* provider/s */, $routeSuccess, $routeError, $routeHome, $canAddUsers);

Route names can be same. If the homepage can display errors routeError and routeHome could be the same. When the service configuration is not complete not all routes will be created.

Login and Logout flow

In the app just link to the login route. It either displays the selector page, configuration errors or redirect to a single login provider.

For logout just do an empty POST to the logout route. Only authenticated users can use the logout.

Name conflicts

This line:

// routes/web.php
Route::authRouter('google','dashboard','error','home',true);

registers the following routes when the configuration is free of errors:

• /login
• /login/google
• /callback/google
• /logout

and expects the 3 named routes to be defined: dashboard, error and home.

If this conflicts with other existing routes just prefix it with something:

// routes/web.php
Route::prefix('any')->name('any.')->group(function () {
    Route::authRouter('google','dashboard','error','home',true);
});

Just use php artisan route:list to see which names and routes have been added.

Configuration

There is no special configuration file, all setup is done over config/services.php.

Errors

The package handles two types of errors differently:

1. setup errors the developer can handle
2. runtime errors which influence the user experience

Setup errors

The setup errors are shown in the /login selector page. If you have any errors with your setup, you can fix them in config/services.php. Its mainly missing keys, or missing provider names in config/services.php.

Runtime errors

The runtime errors are stored in a session and can be handled by the app.

The error page could look like:

<h3>
    {{session('authRouterErrorInfo')}}
</h3>
<p>
    {{session('authRouterErrorMessage')}}
</p>

Example Google login

1. In the .env file you have the credentials:

GOOGLE_CLIENT_ID=24242343242
GOOGLE_CLIENT_SECRET=3843430984

1. In config/services.php you define the service:

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

1. in the routes/web.php you define the route:

// routes/web.php
Route::authRouter('google','dashboard','error','home',true);

Advanced Example

If you want a selection of logins you basically just do:

1. fill the secret data into .env
2. register the services
3. add the route

// routes/web.php
Route::authRouter(['google','paypal','microsoft'],'dashboard','error','home',true);

Providers

The following providers can be easily setup:

Amazon Provider

First go to https://developer.amazon.com/ Go to Developer Portal, create a Developer Account, create a Security Profile under "Login with Amazon", find Client ID and Secret in "Web Settings."

Edit the .env file in your Laravel project and add the credentials:

AMAZON_CLIENT_ID=...
AMAZON_CLIENT_SECRET=...

Edit the config/services.php file:

    'amazon' => [
        'client_id' => env('AMAZON_CLIENT_ID'),
        'client_secret' => env('AMAZON_CLIENT_SECRET'),
    ],

You do not need to configure the callback URL, it will be automatically added

Google Provider

First go to https://console.cloud.google.com/ Go to Google Cloud Console, create a Project, configure OAuth Consent Screen, create OAuth client ID, find Client ID and Secret under Credentials.

Edit the .env file in your Laravel project and add the credentials:

GOOGLE_CLIENT_ID=...
GOOGLE_CLIENT_SECRET=...

Edit the config/services.php file:

    'google' => [
        'client_id' => env('GOOGLE_CLIENT_ID'),
        'client_secret' => env('GOOGLE_CLIENT_SECRET'),
    ],

You do not need to configure the callback URL, it will be automatically added

Linkedin Provider

First go to https://developer.linkedin.com/ Go to Developer Portal, sign in, navigate to "My Apps," create an Application, find Client ID and Secret under "Authentication Keys" in "Authentication" settings.

Edit the .env file in your Laravel project and add the credentials:

LINKEDIN_CLIENT_ID=...
LINKEDIN_CLIENT_SECRET=...

Edit the config/services.php file:

    'linkedin' => [
        'client_id' => env('LINKEDIN_CLIENT_ID'),
        'client_secret' => env('LINKEDIN_CLIENT_SECRET'),
    ],

You do not need to configure the callback URL, it will be automatically added

Microsoft Provider

First go to https://portal.azure.com/ Go to Azure Portal, navigate to Azure Active Directory (or Entra ID), select "App registrations," register a new application, find Application (client) ID on "Overview," generate Client Secret under "Certificates & secrets."

Edit the .env file in your Laravel project and add the credentials:

MICROSOFT_CLIENT_ID=...
MICROSOFT_CLIENT_SECRET=...

Edit the config/services.php file:

    'microsoft' => [
        'client_id' => env('MICROSOFT_CLIENT_ID'),
        'client_secret' => env('MICROSOFT_CLIENT_SECRET'),
    ],

You do not need to configure the callback URL, it will be automatically added

Paypal Provider

First go to https://developer.paypal.com/ Go to Developer Portal, log in with business account, navigate to "Apps & Credentials," choose Sandbox or Live, create an App, find Client ID and Secret on the app details page.

Edit the .env file in your Laravel project and add the credentials:

PAYPAL_CLIENT_ID=...
PAYPAL_CLIENT_SECRET=...

Edit the config/services.php file:

    'paypal' => [
        'client_id' => env('PAYPAL_CLIENT_ID'),
        'client_secret' => env('PAYPAL_CLIENT_SECRET'),
    ],

You do not need to configure the callback URL, it will be automatically added

Auth0 Provider

First go to https://auth0.com/developers Go to Auth0 Dashboard, navigate to "Applications," create a new Application, find Client ID and Secret on the "Settings" tab under "Basic Information."

Edit the .env file in your Laravel project and add the credentials:

AUTH0_CLIENT_ID=...
AUTH0_CLIENT_SECRET=...
AUTH0_DOMAIN=...
AUTH0_COOKIE_SECRET=...

Edit the config/services.php file:

    'auth0' => [
        'client_id' => env('AUTH0_CLIENT_ID'),
        'client_secret' => env('AUTH0_CLIENT_SECRET'),
        'domain' => env('AUTH0_DOMAIN'),
        'cookie_secret' => env('AUTH0_COOKIE_SECRET'),
    ],

You do not need to configure the callback URL, it will be automatically added

Facebook Provider

First go to https://developers.facebook.com/ Go to Meta for Developers, log in, navigate to "My Apps," create an App, find App ID on the dashboard or under "Settings" -> "Basic," find App Secret under "Settings" -> "Basic" (click "Show").

Edit the .env file in your Laravel project and add the credentials:

FACEBOOK_CLIENT_ID=...
FACEBOOK_CLIENT_SECRET=...

Edit the config/services.php file:

    'facebook' => [
        'client_id' => env('FACEBOOK_CLIENT_ID'),
        'client_secret' => env('FACEBOOK_CLIENT_SECRET'),
    ],

You do not need to configure the callback URL, it will be automatically added

Stripe Provider

First go to https://dashboard.stripe.com/ Go to Stripe Dashboard, navigate to "Connect" -> "Settings" -> "OAuth settings" to find Client ID, navigate to "Developers" -> "API keys" to find Secret API Key (acts as client secret).

Edit the .env file in your Laravel project and add the credentials:

STRIPE_CLIENT_ID=...
STRIPE_CLIENT_SECRET=...

Edit the config/services.php file:

    'stripe' => [
        'client_id' => env('STRIPE_CLIENT_ID'),
        'client_secret' => env('STRIPE_CLIENT_SECRET'),
    ],

You do not need to configure the callback URL, it will be automatically added