Day-to-day, I'm obsessed with helping my clients solve their business problems using the latest and greatest the internet has to offer. This means I spend a lot of time translating vendor techno-babble into usable information. One thing that comes up time and time again is how to securely provide Sign-up/in and user profile services for an app built in AWS, in a user-friendly fashion. If you're lucky, by now, you have probably heard of AWS Cognito, with possibly a little bit of knowledge of how it works and what it can do for you. If you're luckier, you may even know more!
Cognito, in my opinion, is one of the most valuable services that is currently on offer from AWS. Without a lot of detailed configuration, Cognito enables Role Based Access Control (RBAC) and secure user access for your apps in AWS. At first, understanding how AWS Cognito operates can feel like solving a mystery (WTF is the difference between a User Pool and an Identity Pool!?). If you have been looking for a simple and somewhat concise explanation, here it is. I would love to show you.
Modern Problem, Modern Solution. š
Say you are a cryptocurrency fanatic, and you are determined to spread your distinctive, in-depth, Google search acquired knowledge to others on the internet in the form of a subscription service (knowing the demographic of those of you reading this, this isn't far fetched). Like any good subscription service, you aim to release diluted content to the masses for free, littered with advertisements, and place the good stuff behind a paywall. Building a website on AWS delivering text based content likely will not be a challenge, although you're going to have to decide how to manage user accounts, metadata, and subscription information. Furthermore, how are you going to protect your money making content? How are you going to do this at scale? How are you going to make the user experience seamless? Will Dogecoin ever reach the moon?
Well hear this, Amazon Cognito lets you add user sign-up, sign-in, and access control to your web and mobile apps quickly and easily. Amazon Cognito scales to millions of users and supports sign-in with social identity providers, such as Apple, Facebook, Google, and Amazon, and enterprise identity providers via SAML 2.0 and OpenID Connect. In more relatable terms, Cognito enables you to provide a user account experience for your app that is on par with what people are used to nowadays. No Dogecoin required.
Building Blocks: User Pools and Identity Pools šØāš©āš§āš¦
Cognito has two main building blocks: Identity Pools and User Pools. If you are new or have limited exposure to cognito, the difference between the two can be very confusing. Your knowledge of cognito should begin with the understanding the difference between Authentication and Authorisation, as User Pools and Identity Pools seek to address these requirements respectively.
Authentication is the process of asserting a user is who they claim to be. For example, when one of your paid users decides to log into your service, they would have to provide something that only they would know, to prove they are who they really are before accessing restricted content. This usually comes in the form of a password, pin, one-time passcode, or biometrics. As the security demands of modern applications become less avoidable, Multi Factor Authentication (MFA), where multiple forms of authentication must be provided, is rightly growing as a base requirement for authentication on the web. Cognito User Pools provide a managed service which address your user authentication needs for applications in AWS.
Authorisation is the process of giving an authenticated user access to particular resources or actions. For example, given one of your paid users has been authenticated, the user would be associated a set of permissions which denote what they are authorised to access. In this case, your paid user would access a set of permissions which authorises them to access your sweet, sweet, restricted content. Cognito Identity Pools provide a managed service which address your user authorisation needs in AWS.
User Pools
In the simplest terms possible, a User Pool is a user directory. Like any decent directory, it allows you to create, confirm, manage users accounts, and manage user authentication. Beyond basic directory features and storing user meta-data such as the names, addresses, and phone numbers of your users, User Pools provide the capability for users to sign in through third party identity providers like Google, Facebook, Amazon, Apple, through SAML identity providers, or directly into the pool itself. Additionally, you can create an AWS Lambda function that is triggered during user pool operations such as user sign-up, confirmation, and sign-in (authentication) with a Lambda trigger. You can even add authentication challenges, migrate users, and customise verification messages. To be fair, what you can achieve with User Pool configuration extends far beyond what I have described, but for the sake of keeping things simple...ish, here is a list of configurable parameters that use to customise your User Pool. Some of the more useful ones being:
- Attributes - Custom attributes/metadata to help you identify individual users
- Password Policies - Complex passwords are harder to guess, and are recommended as a security best practice
- Email or Phone Verification Configuration - Amazon Cognito can automatically verify email addresses or mobile phone numbers by sending a verification codeāor, for email, a verification link.
So in terms of developing a solution to manage user accounts, metadata, and subscription information, User Pools are a pretty good fit.
Common scenarios such as Accessing Server-side Resources after Sign-in, and Accessing Resources with API Gateway and Lambda After Sign-in, are laid out in detail here.
Tokens
Cognito User Pools provides token handling and management for authenticated users from all identity providers, so your backend systems can standardize on one set of user pool tokens.
After a successful authentication via a User Pool, the user pool tokens are returned to your app. You can use these tokens to grant your users access to your own server-side resources or to AWS resources such as API Gateway and AppSync. Amazon Cognito user pools implements ID, access, and refresh tokens as defined by the OpenID Connect (OIDC) open standard:
- The ID token contains claims about the identity of the authenticated user such as name, email, and phone_number.
- The access token contains scopes and groups and is used to grant access to authorized resources.
- The refresh token contains the information necessary to obtain a new ID or access token.
Information regarding Using the ID Token, Using the Access Token, Using the Refresh Token, Revoking All Tokens for a User, and Verifying a JSON Web Token can be found here.
User Pool App Clients and Domains
After you create a user pool, you can create an App Client for use in built-in webpages for signing up and signing in your users. If custom building all of your UI components is not your thing, you can provision a hosted authentication UI that you can add to your app to handle sign-up and sign-in workflows provided by a User Pool. You can use the AWS Management Console, or the AWS CLI or API, to specify customisation settings for the built-in app UI experience. You can even upload a custom logo image to be displayed in the app and choose many CSS customizations. Fancy.
If you configure your user pool to require email verification, Amazon Cognito has the ability to send an email when a user signs up for a new account in your app or resets their password. Depending on the action that initiates the email, the email contains a verification code or a temporary password.
To handle email delivery, you can use either of the following options:
- The default email functionality that is built into the Amazon Cognito service
- Your Amazon SES configuration These settings are reversible. When needed, you can update your user pool to switch between them.
After setting up an app client, you can configure the address of your sign-up and sign-in webpages. You can use an Amazon Cognito hosted domain and choose an available domain prefix, or you can use your own web address as a custom domain.The following links explain the respective processes:
Identity Pools
By now it should be evident that Identity Pools are useful for managing users' authorisation, in order to give them access to AWS services. But what does that actually mean? If you have ever used AWS cli or sdk, you would know that in order to access AWS services you will need a set of credentials associated with a role that defines which services you are permitted to access. Knowing that User Pools generate OIDC tokens for users which can be used and verified in the client app. However, if your app requires access to other resources in AWS, how will you exchange the aforementioned OIDC tokens for AWS credentials? How will you attach an aws IAM role with it?
Amazon Cognito identity pools enable you to create unique identities and assign permissions for users. Identity pools allow users to obtain temporary AWS credentials with permissions you define to directly access other AWS services. Using Identity Pools, you can segregate user's access to content/services. Your identity pool can include:
- Users in an Amazon Cognito user pool
- Users who authenticate with external identity providers such as Facebook, Google, Apple, or a SAML-based identity provider
- Users authenticated via your own existing authentication process
Wait a second? I thought external identity providers were used to authenticate against User Pools??? Yes, that's correct. Users can authenticate against a User Pool or an Identity Pool using an external identity provider. Bit confusing, isn't it? It is easier to understand when remember that Identity Pools exist to provide users the authorisation to directly access other AWS services. Identity Pools are less concerned with the source of authentication, as long as there is one. So if you need to authenticate your users in order to associate them with an Identity Pool, you can use a User Pool, use an external identity provider, or roll your own!
Authenticated and Unauthenticated User Roles/Identities š
Identity pools define two types of identities: authenticated and unauthenticated. Every identity in your identity pool is either authenticated or unauthenticated. Authenticated identities belong to users who are authenticated by a public login provider (Amazon Cognito user pools, Login with Amazon, Sign in with Apple, Facebook, Google, SAML, or any OpenID Connect Providers) or a developer provider (your own backend authentication process). Unauthenticated identities typically belong to guest users.
For each identity type, there is an assigned IAM role. This role has a policy attached to it which dictates which AWS services that role can access. When Amazon Cognito receives a request, the service will determine the identity type, determine the role assigned to that identity type, and use the policy attached to that role to respond. By modifying a policy or assigning a different role to an identity type, you can control which AWS services an identity type can access.
This is how you are going to protect your money making content. When a user logs in to your app, authenticating via a User Pool, or directly via an Identity Pool, or as a guest, Amazon Cognito generates temporary AWS credentials for the user. These temporary credentials are associated with a specific IAM role associated the with the related authenticated or unauthenticated context. The associated IAM role lets you define a set of permissions to access your AWS resources.
By default, the Amazon Cognito Console creates IAM roles that provide access to Amazon Mobile Analytics and to Amazon Cognito Sync. Alternatively, you can choose to use existing IAM roles. For example, you may desire to extend these roles to protect API level content in AppSync (precious pump-and-dump predictions), or static files in S3 (inspirational images of Elon Musk).
The permissions in access policies attached to a role are effective across all users that assume that role. If you want to partition your users' access, you can do so via policy variables. Be careful when including your users' identity IDs in your access policies, particularly for unauthenticated identities as these may change if the user chooses to login. But this probably isn't the blog post to dig into that detail. Examples of and guidance for access policies can be found here.
Stop Reading, Start Doing š¤
Maybe not as concise as I thought! I haven't even spoken about User Pool Groups yet...nevertheless, hopefully cognito seems a bit less scary - there's plenty of information here to get you started. The best way of learning is doing, so if Cognito sounds like it could work for you, do it. Whats the worst that could happen? š
If you are interested in learning more about progressive product development in the cloud, get in touch and let's have a chat over a coffee - my shout! Or if you are ready to build a slick, efficient, scalable application in the cloud and need some guidance, get in touch with us at Mechanical Rock.
Nate takes pride inĀ delivering outcomes for his clients usingĀ modern software development tools and processes.Through his persistent effort to learn more aboutĀ howĀ technology fits intoĀ the world around us, Nate has developed a passion for showing empathy to better understand and solveĀ businessĀ problems.Ā But donāt let any of this fool you, it should not be aĀ surpriseĀ when Nate engages youĀ in a healthy debate as to why Jeff is, and will always be the best member of The Wiggles, when Nate routinely overestimates how many donuts he can fit in his mouth, or when NateĀ inevitablyĀ tells you a dirty joke.