Find file History
Permalink
..
Failed to load latest commit information.
README.md Fix grammar Jun 1, 2018
user-management.yaml Fixed description of UpdateConfigFunction (yaml) Aug 6, 2018

README.md

Module 2: User Authentication and Registration with Amazon Cognito User Pools

In this module you'll create an Amazon Cognito user pool to manage your users' accounts. You'll deploy pages that enable customers to register as a new user, verify their email address, and sign into the site.

If you want to skip ahead to the next module, you can launch one of these AWS CloudFormation templates in the Region of your choice in order to build the necessary resources automatically.

Region Launch
US East (N. Virginia) Launch Module 2 in us-east-1
US East (Ohio) Launch Module 2 in us-east-2
US West (Oregon) Launch Module 2 in us-west-2
EU (Frankfurt) Launch Module 2 in eu-central-1
EU (Ireland) Launch Module 2 in eu-west-1
EU (London) Launch Module 2 in eu-west-2
Asia Pacific (Tokyo) Launch Module 2 in ap-northeast-1
Asia Pacific (Seoul) Launch Module 2 in ap-northeast-2
Asia Pacific (Sydney) Launch Module 2 in ap-southeast-2
Asia Pacific (Mumbai) Launch Module 2 in ap-south-1
CloudFormation Launch Instructions (expand for details)

  1. Choose the Launch Stack link above for the region of your choice.

  2. Choose Next on the Select Template page.

  3. Provide the name of your website bucket from module 1 for the Website Bucket Name (e.g. wildrydes-yourname) and choose Next.

    Note: You must specify the same bucket name you used in the previous module. If you provide a bucket name that does not exist or that you do not have write access to, the CloudFormation stack will fail during creation.

    Speficy Details Screenshot

  4. On the Options page, leave all the defaults and choose Next.

  5. On the Review page, check the box to acknowledge that CloudFormation will create IAM resources and choose Create. Acknowledge IAM Screenshot

    This template uses custom resources to create an Amazon Cognito user pool and client as well as generate a configuration file with the details needed to connect to this user pool and upload it to your website bucket. The template will create a role that provides access for creating these resources and uploading the config file to your bucket.

  6. Wait for the wildrydes-webapp-2 stack to reach a status of CREATE_COMPLETE.

  7. Follow the steps outlined in the Implementation Verification section to confirm you are ready to move on to the next module.

Architecture Overview

When users visit your website they will first register a new user account. For the purposes of this workshop we'll only require them to provide an email address and password to register. However, you can configure Amazon Cognito to require additional attributes in your own applications.

After users submit their registration, Amazon Cognito will send a confirmation email with a verification code to the address they provided. To confirm their account, users will return to your site and enter their email address and the verification code they received. You can also confirm user accounts using the Amazon Cognito console if you want to use fake email addresses for testing.

After users have a confirmed account (either using the email verification process or a manual confirmation through the console), they will be able to sign in. When users sign in, they enter their username (or email) and password. A JavaScript function then communicates with Amazon Cognito, authenticates using the Secure Remote Password protocol (SRP), and receives back a set of JSON Web Tokens (JWT). The JWTs contain claims about the identity of the user and will be used in the next module to authenticate against the RESTful API you build with Amazon API Gateway.

Authentication architecture

Implementation Instructions

Each of the following sections provides an implementation overview and detailed, step-by-step instructions. The overview should provide enough context for you to complete the implementation if you're already familiar with the AWS Management Console or you want to explore the services yourself without following a walkthrough.

If you're using the latest version of the Chrome, Firefox, or Safari web browsers the step-by-step instructions won't be visible until you expand the section.

1. Create an Amazon Cognito User Pool

Background

Amazon Cognito provides two different mechanisms for authenticating users. You can use Cognito User Pools to add sign-up and sign-in functionality to your application or use Cognito Identity Pools to authenticate users through social identity providers such as Facebook, Twitter, or Amazon, with SAML identity solutions, or by using your own identity system. For this module you'll use a user pool as the backend for the provided registration and sign-in pages.

High-Level Instructions

Use the Amazon Cognito console to create a new user pool using the default settings. Once your pool is created, note the Pool Id. You'll use this value in a later section.

Step-by-step instructions (expand for details)

  1. From the AWS Console click Services then select Cognito under Security, Identity & Compliance.

  2. Choose Manage your User Pools.

  3. Choose Create a User Pool

  4. Provide a name for your user pool such as WildRydes, then select Review Defaults

    Create a user pool screenshot

  5. On the review page, click Create pool.

  6. Note the Pool Id on the Pool details page of your newly created user pool.

2. Add an App Client to Your User Pool

From the Amazon Cognito console select your user pool and then select the App clients section. Add a new app and make sure the Generate client secret option is deselected. Client secrets aren't supported with the JavaScript SDK. If you do create an app with a generated secret, delete it and create a new one with the correct configuration.

Step-by-step instructions (expand for details)

  1. From the Pool Details page for your user pool, select App clients from the General settings section in the left navigation bar.

  2. Choose Add an app client.

  3. Give the app client a name such as WildRydesWebApp.

  4. Uncheck the Generate client secret option. Client secrets aren't supported for use with browser-based applications.

  5. Choose Create app client.

    Create app client screenshot

  6. Note the App client id for the newly created application.

3. Update the config.js File in Your Website Bucket

The /js/config.js file contains settings for the user pool ID, app client ID and Region. Update this file with the settings from the user pool and app you created in the previous steps and upload the file back to your bucket.

Step-by-step instructions (expand for details)

  1. Download the config.js file from the website directory of the first module in this repository to your local machine.

  2. Open the downloaded file using the text editor of your choice.

  3. Update the cognito section with the correct values for the user pool and app you just created.

    You can find the value for userPoolId on the Pool details page of the Amazon Cognito console after you select the user pool that you created.

    Pool ID

    You can find the value for userPoolClientId by selecting App clients from the left navigation bar. Use the value from the App client id field for the app you created in the previous section.

    Pool ID

    The value for region should be the AWS Region code where you created your user pool. E.g. us-east-1 for the N. Virginia Region, or us-west-2 for the Oregon Region. If you're not sure which code to use, you can look at the Pool ARN value on the Pool details page. The Region code is the part of the ARN immediately after arn:aws:cognito-idp:.

    The updated config.js file should look like this. Note that the actual values for your file will be different:

    window._config = {
        cognito: {
            userPoolId: 'us-west-2_uXboG5pAb', // e.g. us-east-2_uXboG5pAb
            userPoolClientId: '25ddkmj4v6hfsfvruhpfi7n4hv', // e.g. 25ddkmj4v6hfsfvruhpfi7n4hv
            region: 'us-west-2' // e.g. us-east-2
        },
        api: {
            invokeUrl: '' // e.g. https://rc7nyt4tql.execute-api.us-west-2.amazonaws.com/prod',
        }
    };
  4. Save the modified file making sure the filename is still config.js.

  5. Open the Amazon S3 console by visiting https://console.aws.amazon.com/s3/.

  6. Select your Wild Rydes website bucket that you created in the previous module.

  7. Browse to the js prefix.

  8. Choose Upload, then Add Files.

  9. Browse to the directory where you saved your locally modified version of the config.js file, select it, and choose Open.

    s3-upload.png

  10. Choose Upload on the left side of the dialog.

Note: Instead of having you write the browser-side code for managing the registration, verification, and sign in flows, we provide a working implementation in the assets you deployed in the first module. The cognito-auth.js file contains the code that handles UI events and invokes the appropriate Amazon Cognito Identity SDK methods. For more information about the SDK, see the project page on GitHub.

Implementation Validation

  1. Visit /register.html under your website domain, or choose the Giddy Up! button on the homepage of your site.

  2. Complete the registration form and choose Let's Ryde. You can use your own email or enter a fake email. Make sure to choose a password that contains at least one upper-case letter, a number, and a special character. Don't forget the password you entered for later. You should see an alert that confirms that your user has been created.

  3. Confirm your new user using one of the two following methods.

  4. If you used an email address you control, you can complete the account verification process by visiting /verify.html under your website domain and entering the verification code that is emailed to you. Please note, the verification email may end up in your spam folder. For real deployments we recommend configuring your user pool to use Amazon Simple Email Service to send emails from a domain you own.

  5. If you used a dummy email address, you must confirm the user manually through the Cognito console.

1. From the AWS console, click Services then select **Cognito** under Security, Identity & Compliance.
1. Choose **Manage your User Pools**
1. Select the `WildRydes` user pool and click **Users and groups** in the left navigation bar.
1. You should see a user corresponding to the email address that you submitted through the registration page. Choose that username to view the user detail page.
1. Choose **Confirm user** to finalize the account creation process.
  1. After confirming the new user using either the /verify.html page or the Cognito console, visit /signin.html and log in using the email address and password you entered during the registration step.

  2. If successful you should be redirected to /ride.html. You should see a notification that the API is not configured.

    Successful login screenshot

After you have successfully logged into your web application, you can proceed to the next module, Serverless Backend.

Extra

  • Try copying the auth_token you've received and paste that into an online JWT Decoder to understand what this token means for your application