README

This package provides a simple way to use AWS Cognito authentication in Laravel. The idea of this package, and some of the code, is based on the package from Pod-Point which you can find here: Pod-Point/laravel-cognito-auth. We decided to use it as a basis for our own package as we wanted to customize it in certain ways to fit our needs.

Currently we have the following features implemented in our package:

Registration and Confirmation E-Mail
Login
Remember Me Cookie
Single Sign On
Forgot Password
User Deletion
Edit User Attributes
Reset User Password
Confirm Sign Up

Disclaimer

This package is currently in development and is not production ready.

Installation

You can install the package via composer.

composer require black-bits/laravel-cognito-auth

Laravel 5.4 and before

Using a version prior to Laravel 5.5 you need to manually register the service provider.

// config/app.php
'providers' => [
    ...
    BlackBits\LaravelCognitoAuth\CognitoAuthServiceProvider::class,
    
];

Next you can publish the config and the view.

php artisan vendor:publish --provider="BlackBits\LaravelCognitoAuth\CognitoAuthServiceProvider"

Last but not least you want to change the auth driver. To do so got to your config\auth.php file and change it to look the following:

'guards' => [
    'web' => [
        'driver' => 'cognito', // This line is important 
        'provider' => 'users',
    ],
    'api' => [
        'driver' => 'token',
        'provider' => 'users',
    ],
],

Cognito User Pool

In order to use AWS Cognito as authentication provider, you require a Cognito User Pool.

If you haven't created one already, go to your Amazon management console and create a new user pool.

Next, generate an App Client. This will give you the App client id and the App client secret you need for your .env file.

IMPORTANT: Don't forget to activate the checkbox to Enable sign-in API for server-based Authentication. The Auth Flow is called: ADMIN_USER_PASSWORD_AUTH (formerly ADMIN_NO_SRP_AUTH)

You also need a new IAM Role with the following Access Rights:

AmazonCognitoDeveloperAuthenticatedIdentities
AmazonCognitoPowerUser
AmazonESCognitoAccess

From this user you can fetch the AWS_COGNITO_KEY and AWS_COGNITO_SECRET.

Cognito API configuration

Add the following fields to your .env file and set the values according to your AWS settings:

AWS_COGNITO_KEY=
AWS_COGNITO_SECRET=
AWS_COGNITO_REGION=
AWS_COGNITO_CLIENT_ID=
AWS_COGNITO_CLIENT_SECRET=
AWS_COGNITO_USER_POOL_ID=
AWS_COGNITO_DELETE_USER=

Importing existing users into the Cognito Pool

If you are already working on an existing project and want to integrate Cognito you have to import a user csv file to your Cognito Pool.

Usage

Our package is providing you 5 traits you can just add to your Auth Controllers to get our package running.

BlackBits\LaravelCognitoAuth\Auth\AuthenticatesUsers
BlackBits\LaravelCognitoAuth\Auth\RegistersUsers
BlackBits\LaravelCognitoAuth\Auth\ResetsPasswords
BlackBits\LaravelCognitoAuth\Auth\SendsPasswordResetEmails
BlackBits\LaravelCognitoAuth\Auth\VerifiesEmails

In the simplest way you just go through your Auth Controllers and change namespaces from the traits which are currently implemented from Laravel.

During the publishing process of our package you created a view which you will find under Resources/views/vendor/black-bits/laravel-cognito-auth.

You can change structure to suit your needs. Please be aware of the @extend statement in the blade file to fit into your project structure. At the current state you need to have those 4 form fields defined in here. Those are token, email, password, password_confirmation.

Single Sign-On

With our package and AWS Cognito we provide you a simple way to use Single Sign-Ons. For configuration options take a look at the config cognito.php.

To enable single sign-on you can set USE_SSO to true in your .env file.

USE_SSO=true

When you have SSO enabled in your config and a user tries to login into your application we will check if the user exists in your Cognito pool. If the user exists, he will be created automatically in your database and is logged in simultaneously.

That's what we use the fields sso_user_model and sso_user_fields for. In sso_user_model you define the class of your user model. In most cases this will simply be App\User.

With sso_user_fields you can define the fields which should be stored in Cognito. Put attention here. If you define a field which you do not send with the Register Request this will throw you an InvalidUserFieldException and you won't be able to register.

Now that you have registered your users with their attributes in the Cognito pool and your database and you want to attach a second app which should use the same pool. Well, that's actually pretty easy. You set up your project like you are used to and install our laravel-cognito-auth package. On both sites set use_sso to true. Be sure you entered exactly the same pool id. Now when a user is registered in your other app but not in your second app and wants to login he gets created. That's all you need to do.

IMPORTANT: if your users table has a password field you are not going to need this anymore. What you want to do is set this field to be nullable, so that users can be created without passwords. From now on, Passwords are stored in Cognito. Any additional registration data you have, for example firstname, lastname needs to be added in cognito.php sso_user_fields config to be pushed to Cognito. Otherwise they are only stored locally and are not available if you want to use Single Sign On's.

Registering Users

As a default, if you are registering a new user with Cognito, Cognito will send you an email during signUp were the user can verify themselves. If the user now clicks on the link in the email he will be redirected to a confirmation page which is provided by Cognito. In most cases, this is not you what you want. You want the user to stay on your page.

We have found a neat way to get around this default behaviour.

You need to create an extra field for the user where you want to store the verification token. This field has to be nullable.
Create an Event Listener that listens for Registered Event which is fired after the user has been registered.
In this event listener, you generate a token and store that in the field you created above.
You create an email and send that token, stored in a link, to the user.

The link should point to a controller action where you first check if a user with this token exists. If such a exists in the database you make a call to Cognito and set the user Attributes to email_verified true and confirm the signUp.

 public function verifyEmail(
        $token,
        CognitoClient $cognitoClient,
        CognitoUserPropertyAccessor $cognitoUserPropertyAccessor
    ) {
        $user = User::whereToken($token)->firstOrFail();

        $user->token = null;
        $user->save();

        $cognitoClient->setUserAttributes($user->email, [
            'email_verified' => 'true',
        ]);

        if ($cognitoUserPropertyAccessor->getUserStatus($user->email) != 'CONFIRMED') {
            $cognitoClient->confirmSignUp($user->email);
            return response()->redirectToRoute('login');
        }

        return response()->redirectToRoute('dashboard');
    }

Now you need to turn off Cognito to send you emails. Go into your AWS account and navigate to the Cognito section. Select your user pool and click on MFA and verifications You will see a headline: Do you want to require verification of emails or phone numbers? You have to remove all checked fields here. Once done, you should see a red alert: You have not selected either email or phone number verification, so your users will not be able to recover their passwords without contacting you for support.
Now you have told Cognito to stop sending you messages when a user registers on your app and you can handle it all by yourself.

As a sidenote: Password Forgot Emails will still be triggered through Cognito. You cannot turn them off, so make sure to style those emails to suit your needs. Also make sure to send the email from a proper FROM address.

Delete User

If you want to give your users the ability to delete themselves from your app you can use our deleteUser function from the CognitoClient.

To delete the user you should call deleteUser and pass the email of the user as a parameter to it. After the user has been deleted in your cognito pool, delete your user from your database too.

    $cognitoClient->deleteUser($user->email);
    $user->delete();

We have implemented a new config option delete_user, which you can access through AWS_COGNITO_DELETE_USER env var. If you set this config to true, the user is deleted in the Cognito pool. If it is set to false, it will stay registered. Per default this option is set to false. If you want this behaviour you should set USE_SSO to true to let the user restore themselves after a successful login.

To access our CognitoClient you can simply pass it as a parameter to your Controller Action where you want to perform the deletion.

    public function deleteUser(Request $request, CognitoClient $cognitoClient)

Laravel will take care of the dependency injection by itself.

    IMPORTANT: You want to secure this action by maybe security questions, a second delete password or by confirming 
    the email address.

Changelog

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

Security

If you discover any security related issues, please email hello@blackbits.io instead of using the issue tracker.

Credits

Support us

Black Bits, Inc. is a web and consulting agency specialized in Laravel and AWS based in Grants Pass, Oregon. You'll find an overview of what we do on our website.

License

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

black-bits / laravel-cognito-auth

Maintainers

Details