README

Laravel SSO

Laravel SSO is a package for implementing Single Sign-On (SSO) authorizations in your Laravel project. This package allows you to authorize users on a Laravel panel from another website.

Requirements

PHP 7.3 or higher
Laravel 8.0 or higher

Installation

To install the package, use Composer:

composer require gigabait/laravel-sso

Configuration

Publish the configuration file by running the following command:

php artisan vendor:publish --tag=sso

This command will publish the config/sso.php file, where you can set the secret key for SSO authorization.

Set the secret key in your .env file:

SSO_SECRET_KEY=your_secret_key

Make sure the secret key is 32 characters long.

Usage

To authorize users on the Laravel panel from another website, first perform SSO authorization on your website.
Redirect the user to the /sso-login route with a GET parameter auth_marker containing the encrypted user data in JSON format. For example:

use Illuminate\Encryption\Encrypter;

public function redirectToAppB()
{
    $user = Auth::user();
    $authMarkerData = [
        'email' => $user->email,
        'secret_key' => config('sso.secret_key')
    ];

    $key = config('sso.secret_key');
    $cipher = config('app.cipher');
    $encrypter = new Encrypter($key, $cipher);
    $token = json_encode($authMarkerData);
    $encryptedToken = $encrypter->encrypt($token);

    header("Location: https://app-b.example.com/sso-login?token=" . urlencode($encryptedToken));
}

After being redirected to the /sso-login route, the user will be automatically authorized on the Laravel panel if their email address matches a record in the database.

Note

Make sure both applications use the same SSO_SECRET_KEY in their respective .env files. This is required for the encryption and decryption process to work correctly. The key must be 32 characters long.

Error Handling

If an error occurs during the SSO process, the user will be redirected to the login page of App B. If the secret key length is not 32 characters, an error message will be displayed.

Support

If you have any questions or issues, please create a new issue in the project repository on GitHub.

License

This project is licensed under the MIT License. See the LICENSE file for details.

gigabait / laravel-sso

Maintainers

Details