kirschbaum-development/laravel-socialite-cognito

A custom AWS Cognito driver for Laravel Socialite

0.0.1 2021-06-17 19:46 UTC

This package is auto-updated.

Last update: 2021-10-18 14:00:37 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

This package is a custom AWS Cognito driver for Laravel Socialite.

Installation

You can install the package via composer:

composer require kirschbaum-development/laravel-socialite-cognito

Usage

Once you install the package, add the next config values in you config/services.php configuration file:

'cognito' => [
    'base_uri' => env('COGNITO_URI'),
    'client_id' => env('COGNITO_CLIENT_ID'),
    'client_secret' => env('COGNITO_CLIENT_SECRET'),
    'redirect' => env('COGNITO_REDIRECT_URI'),
],

Then, you can use the driver as you would use it in the Laravel Socialite's official documentation. Use cognito keyword when you want to instantiate the driver:

$user = Socialite::driver('cognito')->user();

The default scopes are:

$scopes = [
    'openid',
    'profile',
    'aws.cognito.signin.user.admin',
];

You can add more scopes or override the default ones by using scopes or setScopes methods like the official documentation shows (link)

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

If you discover any security related issues, please email guette@kirschbaumdevelopment.com or nathan@kirschbaumdevelopment.com instead of using the issue tracker.

Sponsorship

Development of this package is sponsored by Kirschbaum Development Group, a developer driven company focused on problem solving, team building, and community. Learn more about us or join us!

License

The MIT License (MIT). Please see License File for more information.