Setup AWS Cognito User Pool with an Azure AD identity provider to perform single sign-on (SSO) authentication in mobile app (Part 1).
This a step-by-step tutorial of how to set up an AWS Cognito User Pool with an Azure AD identity provider and perform single sign-on (SSO) authentication with Azure AD account to access AWS services in your iOS and Android mobile application. Tutorial will consist of 3 separate parts:
- Setup AWS Cognito User Pool with an Azure AD identity provider to perform single sign-on (SSO) authentication with mobile app.
- Integration Cognito Auth in iOS application.
- Integration Cognito Auth in Android application.
Amazon Cognito — service that provides authentication, authorization, and user management for web and mobile apps. Users can sign-in directly with a username and password or through a third party such as Azure AD, Amazon, or Google. Amazon Cognito consists of two main components: user pools and identity pools. User pools are user directories that provide sign-up and sign-in options for app users. Identity pools enable you to grant your users access to other AWS services. You can use identity pools and user pools separately or together.
Azure AD (Azure Active Directory) — Microsoft’s multi-tenant, cloud-based directory, and identity management service.
Federation Identity Management (FIdM) — a system of shared protocols, technologies and standards that allows user identities and devices to be managed across organizations.
Identity Provider (IdP) — a system that creates, maintains, and manages identity information for principals (users, services, or systems) and provides principal authentication to other service providers (applications) within a federation or distributed network. An IdP can provide a user with identifying information and serve that information to services when the user requests access.
SAML (Security Assertion Markup Language) — is a standard for securely exchanging user’s identity between SAML authority (called an identity provider or IdP) and SAML consumer (called a service provider or SP). Thus defining 3 roles: the principal (user), identity provider and service provider. SAML eliminates passing passwords. Instead, it uses cryptography and digital signatures to pass a secure sign-in token from an identity provider to a service provider. Is one of the most widely used protocols when it comes to Single sign-on implementation.
Service Providers (SP) — an entity that provides Web Services that receives and accepts authentication assertions in conjunction with a single sign-on (SSO) profile of the Security Assertion Markup Language (SAML). SAML’s Service Provider (SP) depends on receiving assertions from a SAML Identity Provider (IdP).
Single sign-on (SSO) — is an authentication process which allows automatically granting access to multiple system services and apps by once log in to the system. Single sign-on typically use in enterprise environments by providing employees single access to the services and applications rather than creating and managing separate credentials for each service.
In case SSO authentication with Azure AD account to AWS Cognito, Azure AD will be an identity provider (IdP) and AWS Cognito a Service provider (SP). AWS Cognito before giving to the user an access to AWS resources checks with the identity provider if the user’s permissions. Azure AD verifies user identity (emails and password, for example) and if valid asserts back to AWS Cognito that user should have access along with the user’s identity.
The SSO flow based on the next steps:
- The user accesses an application, which redirects him to a page hosted by AWS Cognito.
- AWS Cognito identifies the user’s origin (by client id, application subdomain etc) and redirects the user to the identity provider, asking for authentication. In this case to an Azure AD login page. This is the SAML authentication request.
- The browser redirects the user to an SSO URL. The user either has an existing active browser session with the identity provider or establishes one by logging into the identity provider. The identity provider (Azure AD) creates the authentication response in the XML-document format, which contains the user’s username or email address (and other attributes if set) and signs it using an X.509 certificate. The result is passing back to the service provider (AWS Cognito). This is the SAML authentication response.
- The service provider, which already knows the identity provider and has a certificate fingerprint, retrieves the authentication response and validates it using the certificate fingerprint. The identity of the user is established and the user is provided with app access. with the access_token in the URL.
- Azure account with Azure AD Premium enabled.
- AWS account.
The setup consist of 5 steps:
- Create an AWS Cognito User Pool.
- Create AWS App client and add it to the User Pool.
- Create an Azure AD enterprise application.
- Set up Azure AD identity provider to the Cognito User Pool.
- Setup Identity Provider in your AWS User Pool.
1. Create a AWS Cognito User Pool
1.1 Login to AWS Console (https://console.aws.amazon.com/) and open “All Services” section.
1.2 Choose “Cognito” in section Security, Identity & Compliance:
1.3 In Cognito service choose “Manage User Pools”:
1.4 Choose “Create a user pool”:
1.5 Type a name of your user pool and choose “Review Defaults” in case you don’t have specific settings you want to set:
1.6 Choose section with required attributes and click on edit:
1.7 Setup user sign-in option by choosing “email address or phone number”. In subcategories choose “allow email addresses” and choose “Next step”:
1.8 Leave all settings default (if you don’t want to set some). At the last screen choose “Create Pool”:
1.9 Now your pool is created. Memorize Pool Id (e.g. us-east-1_XX123xxXXX). You will need this id in Azure AD portal and mobile app settings.
1.10 Set User Pool Domain Name. For this open your User Pool, choose section “App Integration” -> “Domain Name”. Type your domain prefix.
Amazon Cognito Domain is built by this scheme:
Memorize it, it will be required in Azure and mobile app settings.
With this example Amazon Cognito Domain is https://example-setup-app.auth.us-east-1.amazoncognito.com
As a result of this section you should have next information:
- User Pool id (e.g. us-east-1_XX123xxXXX)
- Amazon Cognito Domain associated with User Pool (e.g. https://example-setup-app.auth.us-east-1.amazoncognito.com)
2. Create App client and add it to the User Pool
Basically, you can create your application with Mobile Hub and associate it with your user pool. But in this tutorial described how to create an application from Cognito Service.
2.1 Open your User Pool, choose “General settings” -> “App Clients” and click on “Add new app client”:
2.2 Type a name of your app client, e.g. “iOS App Client”, make sure that “Generate client secret” is checked, leave other setting default. Press “Create app client”.
2.3 Now your app client is created, open “General” -> “App Clients”. Your application will be listed there. Memorize “App client id” and “App client secret”:
2.4 Setup App Client. Open “App integration” -> “App Client Settings”. Choose your mobile client app and set next settings:
Allowed OAuth Flows: Authorization code grant, Implicit grant;
Allowed OAuth Scopes: email, aws.cognito.signin.user.admin, openid (openid is required with email scope);
Callback URL(s) and Sign Out URL(s) should be set to your app URL Scheme (you can read more about this here):
Save your changes.
At the end of this section you should have the next information:
- App client id;
- App client secret;
- Callback URL;
- Sign Out URL;
- List of Allowed OAuth Scopes.
This is not all set-up which you need to perform in AWS, but for now, you need to continue with setup Azure.
3. Create an Azure AD enterprise application
3.1 Open Azure Portal https://portal.azure.com/, on the right side menu choose “Azure Active Directory”.
If there is no such service, Open “All services” and type “Azure Active Directory”:
3.2 In Active Directory menu choose “Enterprise applications”:
3.3 In opened section choose “New Application”:
3.4 Pick “Non-gallery application” type for your application:
3.5 Type name of your application and press “Add”. Now your application is created and time to connect it to AWS User Pool.
3.6 Setup Single sign-on. In your Azure AD enterprise application choose section “Single sign-on”, in dropdown list choose “SAML-based Sign-on”:
In section “Domain and URLs” set next information:
- Identifier. Identifier contains your User Pool id (from AWS) and built with next pattern:
- Reply URL. The Reply URL is where from application expects to receive the authentication token. This is also referred to as the “Assertion Consumer Service” (ACS) in SAML. Is should follow the pattern:
Example of Identifier and Reply URL:
Save your changes and download SAML File:
3.7 Add a User to your app. In your Azure AD select “Enterprise applications” and choose your application. Select “Users and groups”->“Add user”.
Invite new users or select from existing. These users will be able to login with this Azure AD account to your application. When you’ll finish adding a user select “Assign”.
This is all settings in the Azure portal. At the end of this section you should have:
- SAML file with XML format;
- user(s) to login.
5. Setup Identity Provider in your AWS User Pool
5.1 Open your User Pool and choose section “Federation” -> “Identity Providers”. In opened section select “SAML” provider:
5.2 Type a name for your provider and upload SAML file from Azure. Press “Create Provider”:
5.3 Setup attribute mapping from your provider to AWS. In this example we are only interested in email, so for email add next:
User pool attribute: Email
Save your changes.
5.4 Assign Identity provider to your app client. In your user pool open section “App Client Settings”. Choose your application, in the section “Enabled Identity Providers” choose a provider which you just created for this user pool. Save your changes.
That’s all settings which you should do in AWS console and Azure portal. You can now test your set-up.
Testing your set-up
You can easily test your setup in Azure Portal:
- Open Single sign-on section of your application in the Azure portal and choose button “Test SAML Settings”:
- Then you will need to install My Apps Secure Sign-in Extension and the perform a sign in with the account which you have added to this application on step 3.7:
- You will be able to see SAML request and response, and token if the login succeeds:
At this point, you should have all required values to begin setup SSO authentication with Azure AD account in your mobile application.
The final list of settings which you should have at the end of this setup:
- User Pool ID;
- Amazon Cognito Domain associated with User Pool;
- App client ID;
- App client secret;
- Callback URL;
- Sign Out URL;
- List of Allowed OAuth Scopes;