SSO-Package for Laravel

Overview

This Laravel Composer package provides seamless integration for multiple Single Sign-On (SSO) providers. The supported providers in this version include:

• GitHub
• Google
• JumpCloud
• LinkedIn
• Twitter
• AWS Cognito

The package is designed to be modular, scalable, and easy to configure for any Laravel application.

Installation

Step 1: Require the Package

composer require sahdevpalaniya/laravel-multi-sso

Step 2: Publish the Configuration

Publish the configuration file to your Laravel project:

php artisan vendor:publish --tag=sso-config

This will create a configuration file (sso.php) in the config directory.

Step 3: Configure the Environment

Add the necessary environment variables for your desired SSO providers in the .env file. Below are the detailed configurations for each provider.

Supported Providers

GitHub

Configuration:

SSO_GITHUB_CLIENT_ID=your-github-client-id
SSO_GITHUB_CLIENT_SECRET=your-github-client-secret
SSO_GITHUB_REDIRECT=https://yourdomain.com/sso/github/callback

Routes:

Route::get('/sso/github/redirect', function () {
    return SSO::driver('github')->redirect();
})->name('github.redirect');

Route::get('/sso/github/callback', function (Request $request) {
    $githubData = SSO::driver('github')->callback($request);
    return response()->json($githubData->getData()->data);
})->name('github.callback');

Google

Configuration:

SSO_GOOGLE_CLIENT_ID=your-google-client-id
SSO_GOOGLE_CLIENT_SECRET=your-google-client-secret
SSO_GOOGLE_REDIRECT=https://yourdomain.com/sso/google/callback

Routes:

Route::get('/sso/google/redirect', function () {
    return SSO::driver('google')->redirect();
})->name('google.redirect');

Route::get('/sso/google/callback', function (Request $request) {
    $googleData = SSO::driver('google')->callback($request);
    return response()->json($googleData->getData()->data);
})->name('google.callback');

JumpCloud

Configuration:

SSO_JUMPCLOUD_ENTITY_ID=your-jumpcloud-entity-id
SSO_JUMPCLOUD_SSO_URL=your-jumpcloud-sso-url
SSO_JUMPCLOUD_CERTIFICATE=your-jumpcloud-certificate

Routes:

Route::get('/sso/jumpcloud/redirect', function () {
    return SSO::driver('jumpcloud')->redirect();
})->name('jumpcloud.redirect');

Route::get('/sso/jumpcloud/callback', function (Request $request) {
    $jumpcloudData = SSO::driver('jumpcloud')->callback($request);
    return response()->json($jumpcloudData->getData()->data);
})->name('jumpcloud.callback');

LinkedIn

Configuration:

SSO_LINKEDIN_CLIENT_ID=your-linkedin-client-id
SSO_LINKEDIN_CLIENT_SECRET=your-linkedin-client-secret
SSO_LINKEDIN_REDIRECT=https://yourdomain.com/sso/linkedin/callback

Routes:

Route::get('/sso/linkedin/redirect', function () {
    return SSO::driver('linkedin')->redirect();
})->name('linkedin.redirect');

Route::get('/sso/linkedin/callback', function (Request $request) {
    $linkedinData = SSO::driver('linkedin')->callback($request);
    return response()->json($linkedinData->getData()->data);
})->name('linkedin.callback');

Twitter

Configuration:

SSO_TWITTER_CLIENT_ID=your-twitter-client-id
SSO_TWITTER_CLIENT_SECRET=your-twitter-client-secret
SSO_TWITTER_REDIRECT=https://yourdomain.com/sso/twitter/callback

Routes:

Route::get('/sso/twitter/redirect', function () {
    return SSO::driver('twitter')->redirect();
})->name('twitter.redirect');

Route::get('/sso/twitter/callback', function (Request $request) {
    $twitterData = SSO::driver('twitter')->callback($request);
    return response()->json($twitterData->getData()->data);
})->name('twitter.callback');

AWS Cognito

Configuration:

SSO_AWS_COGNITO_CLIENT_ID=your-aws-cognito-client-id
SSO_AWS_COGNITO_CLIENT_SECRET=your-aws-cognito-client-secret
SSO_AWS_COGNITO_REGION=your-aws-region
SSO_AWS_COGNITO_USER_POOL_ID=your-aws-cognito-user-pool-id

Routes:

Register User

To register a new user, you can call the register method with an array of user data.

Route::post('/sso/aws/register', function (Request $request) {
    $userData = $request->all();
    $response = SSO::driver('aws')->register($userData);
    return response()->json($response);
})->name('aws.register');

You can also call the register method directly in your code:

$userData = [
    'username' => 'testuser',
    'password' => 'Password123!',
    'email' => 'test@example.com',
    // ... other optional attributes
];
$response = SSO::driver('aws')->register($userData);

Login User

To log in a user, you can call the login method with an array containing the user's credentials.

Route::post('/sso/aws/login', function (Request $request) {
    $credentials = $request->only('username', 'password');
    $response = SSO::driver('aws')->login($credentials);
    return response()->json($response);
})->name('aws.login');

You can also call the login method directly in your code:

$credentials = [
    'username' => 'testuser',
    'password' => 'Password123!',
];
$response = SSO::driver('aws')->login($credentials);

✅ Notes:

1. If the user is already logged in, there is no need to call the login() method again before logout and getUserDetails.
2. Ideally, logout and getUserDetails should directly use the current user's valid access token.

Get User Details

To get user details, you need to provide a valid accessToken obtained after a successful login.

Route::post('/aws/user-details', function (Request $request) {
    // The access token should be passed in the request body.
    $data = ['access_token' => $request->input('access_token')];
    $awsUserDetails = SSO::driver('aws')->getUserDetails($data);
    return response()->json($awsUserDetails);
})->name('aws.user-details');

Logout User

To log out a user, you need to provide a valid accessToken obtained after a successful login.

Route::post('/sso/aws/logout', function (Request $request) {
    // The access token should be passed in the request body.
    $data = ['access_token' => $request->input('access_token')];
    $response = SSO::driver('aws')->logout($data);
    return response()->json($response);
})->name('aws.logout');

Attribute Mapping for AWS Cognito

The attributes array in the register API accepts the following keys:

Contributing

Contributions are welcome! Feel free to fork the repository and submit PRs.

Changelog

See CHANGELOG for a detailed history of changes.

License

This project is open-source and licensed under the MIT License.

Support

For any questions or issues, please create an issue in this repository or contact sahdevsinhpalaniya98@gmail.com.