Post Syndicated from Raghavarao Sodabathina original https://aws.amazon.com/blogs/architecture/building-saml-federation-for-amazon-opensearch-dashboards-with-ping-identity/

Amazon OpenSearch is an open search and log analytics service, powered by the Apache Lucene search library.

In this blog post, we provide step-by-step guidance for SP-initiated SSO by showing how to set up a trial Ping Identity account. We’ll show how to build users and groups within your organization’s directory and enable SSO in OpenSearch Dashboards.

To use this feature, you must enable fine-grained access control. Rather than authenticating through Amazon Cognito or the internal user database, SAML authentication for OpenSearch Dashboards lets you use third-party identity providers to log in.

Ping Identity is an AWS Competency Partner, and the provider of the PingOne Cloud Platform is a multi-tenant Identity-as-a-Service (IDaaS) platform. Ping Identity supports both service provider (SP)-initiated and identity provider (IdP)-initiated SSO.

Overview of Ping Identity SAML authenticated solution

Figure 1 shows a sample architecture of a generic integrated solution between Ping Identity and OpenSearch Dashboards over SAML authentication.

The sign-in flow is as follows:

1. User opens browser window and navigates to Amazon OpenSearch Dashboards
2. Amazon OpenSearch generates SAML authentication request
3. Amazon OpenSearch redirects request back to browser
4. Browser redirects to Ping Identity URL
5. Ping Identity parses SAML request, authenticates user, and generates SAML response
6. Ping Identity returns encoded SAML response to browser
7. Browser sends SAML response back to Amazon OpenSearch Assertion Consumer Service (ACS) URL
8. ACS verifies SAML response
9. User logs into Amazon OpenSearch domain

Prerequisites

For this walkthrough, you should have the following prerequisites:

1. An AWS account
2. A virtual private cloud (VPC)-based Amazon OpenSearch domain with fine-grained access control enabled
3. Ping Identity account with user and a group
4. A browser with network connectivity to Ping Identity, Amazon OpenSearch domain, and Amazon OpenSearch Dashboards.

The steps in this post are structured into the following sections:

1. Identity provider (Ping Identity) setup
2. Prepare Amazon OpenSearch for SAML configuration
3. Identity provider (Ping Identity) SAML configuration
4. Finish Amazon OpenSearch for SAML configuration
5. Validation
6. Cleanup

Identity provider (Ping Identity) setup

Step 1: Sign up for a Ping Identity account

• Sign up for a Ping Identity account, then click on the Sign up button to complete your account setup.
• If you already have an account with Ping Identity, login to your Ping Identity account.

Step 2: Create Population in Ping Identity

• Choose Identities in the left menu and click Populations to proceed.
• Click on the blue + button next to Populations, enter the name as IT, then click on the Save button (see Figure 2).

Step 3: Create a group in Ping Identity

• Choose Groups from the left menu and click on the blue + button next to Groups. For this example, we will create a group called opensearch for Kibana access. Click on the Save button to complete the group creation.

Step 4: Create users in Ping Identity

• Choose Users in left menu, then click the + Add User button.
• Provide GIVEN NAME, FAMILY NAME, EMAIL ADDRESS, and choose Population as users, as created in Step 1. Choose your own USERNAME. Click on the SAVE button to create your user.
• Add more users as needed.

Step 5: Assign role and group to users

• Click on Identities/users in the left menu, and click on Users. Then click on the edit button for a particular user, as shown in Figure 3.

• Click on the Edit button, click on + Add Role button, and click on the edit button to assign a role to the user.
• For this example, choose Environment Admin, as shown in Figure 4. You can choose different roles depending on your use case.

• For this example, assign administrator responsibilities for our users. Click on Show Environments, and drag Administrators into the ADDED RESPONSIBILITES section. Then click on the Add Role button.
• Add Group to users. Go to the Groups tab, search for the opensearch group created in Step 3. Click on the + button next to opensearch to add into group memberships.

Prepare Amazon OpenSearch for SAML configuration

Once the Amazon OpenSearch domain is up and running, we can proceed with configuration.

• Under Actions, choose Edit security configuration, as shown in Figure 5.

• Under SAML authentication for OpenSearch Dashboards/Kibana, select Enable SAML authentication check box (Figure 6). When we enable SAML, it will create different URLs required for configuring SAML with your identity provider.

We will be using the Service Provider entity ID and SP-initiated SSO URL as highlighted in Figure 6 for Ping Identity SAML configuration. We will complete the rest of the Amazon OpenSearch SAML configuration after the Ping Identity SAML configuration.

Ping Identity SAML configuration

Go back to PingIdentity.com, and navigate to Connections on the left menu. Then select Applications, and click on Application +.

• For this example, we are creating an application called “Kibana”
• Select WEB APP as APPLICATION TYPE and CHOOSE CONNECTION TYPE as SAML, and click on Configure button to proceed as shown in Figure 7.

• On the “Create App Profile” page, click on the Next button, and choose the “Manually Enter” option for PROVIDE APP METADATA. Enter the following under Configure SAML Connection section
  • ACS URL https://vpc-XXXXX-XXXXX-west-2.es.amazonaws.com/_dashboards/_opendistro/_security/saml/acs (SP-initiated SSO URL)
  • Choose Sign Assertion & Response under SIGNING KEY
  • ENTITY ID: https://vpc-XXXXX-XXXXX.us-west-2.es.amazonaws.com (Service provider entity ID)
  • ASSERTION VALIDITY DURATION (IN SECONDS) as 3600
  • Choose default options, then click on the Save and Continue button as shown in Figure 8

• Enter the following under Configure Attribute Mapping, then click on Save and Close.
  • Set User ID to default
  • Click on +ADD ATTRIBUTE button to add following SAML attributes
    • OUTGOING VALUE: Group Names, SAML ATTRIBUTE: saml_group
    • OUTGOING VALUE: Username, SAML ATTRIBUTE: saml_username
• Select the Policies tab and click on edit icon on the right.
• Add the Single_Factor policy to the application, then click on Save.
• Select the Access tab, add the opensearch group to the application, then click on Save to complete SAML configuration.
• Finally, go to the Configuration tab, click on the Download Metadata button to download the Ping Identity metadata for the Amazon OpenSearch SAML configuration. Enable opensearch SAML application (Figure 9).

Amazon OpenSearch SAML configuration

• Switch back to Amazon OpenSearch domain:
  • Navigate to the Amazon OpenSearch console.
  • Click on Actions, then click on Modify Security configuration.
  • Select the Enable SAML authentication check box.

• Under Import IdP metadata section:
  • Metadata from IdP: Import the Ping Identity identity provider metadata from the downloaded XML file, shown in Figure 10.
  • SAML master backend role: opensearch (Ping Identity group). Provide SAML backend role/group SAML assertion key for group SSO into Kibana.

• Under Optional SAML settings:
  • Leave the Subject Key as saml_subject from Ping Identity SAML application attribute name.
  • Role key should be saml_group. You can view a sample assertion during the configuration process by tools like SAML-tracer. This can help you examine and troubleshoot the contents of real assertions.
  • Session time to live (mins): 60
• Click on the Submit button to complete Amazon OpenSearch SAML configuration for Kibana. We have successfully completed SAML configuration and are now ready for testing.

Validating Access with Ping Identity Users

• The OpenSearch Dashboards URL can be found in the Overview tab within “General Information” in the Amazon OpenSearch console (Figure 11). The first access to the OpenSearch Dashboards URL redirects you to the Ping Identity login screen.

• If your OpenSearch domain is hosted within a private VPC, you will not be able to access OpenSearch Dashboards over public internet. But you can still use SAML as long as your browser can communicate with both your OpenSearch cluster and your identity provider.
• You can create a Mac or Windows EC2 instance within the same VPC and access Amazon OpenSearch Dashboards from an EC2 instance’s web browser to validate your SAML configuration. Or you can access your Amazon OpenSearch Dashboards through Site-to-Site VPN if you are trying to access it from your on-premises environment.
• Now copy and paste the OpenSearch Dashboards URL in your browser, and enter user credentials.
• After successful login, you will be redirected into the OpenSearch Dashboards home page. Explore our sample data and visualizations in OpenSearch Dashboards, as shown in Figure 12.

• You have successfully federated Amazon OpenSearch Dashboards with Ping Identity as an identity provider. You can connect OpenSearch Dashboards by using your Ping Identity credentials.

Cleaning up

After you test out this solution, remember to delete all the resources you created to avoid incurring future charges. Refer to these links:

• Deleting your Amazon OpenSearch domain
• Reach out to Ping Identity to delete your account (If needed)

Conclusion

In this blog post, we have demonstrated how to set up Ping Identity as an identity provider over SAML authentication for Amazon OpenSearch Dashboards access. With this solution, you now have an OpenSearch Dashboard that uses Ping Identity as the custom identity provider for your users. This reduces the customer login process to one set of credentials and improves employee productivity.

Get started by checking the Amazon OpenSearch Developer Guide, which provides guidance on how to build applications using Amazon OpenSearch for your operational analytics.

Post Syndicated from Raghavarao Sodabathina original https://aws.amazon.com/blogs/architecture/building-saml-federation-for-amazon-opensearch-dashboards-with-okta/

Amazon OpenSearch Service is a fully managed open search and analytics service powered by the Apache Lucene search library. Security Assertion Markup Language (SAML)-based federation for OpenSearch Dashboards lets you use your existing identity provider (IdP) like Okta to provide single sign-on (SSO) for OpenSearch Dashboards on OpenSearch Service domains.

This post shows step-by-step guidance to enable SP-initiated single sign-on (SSO) into OpenSearch Dashboards using Okta.

To use this feature, you must enable fine-grained access control. Rather than authenticating through Amazon Cognito or the internal user database, SAML authentication for OpenSearch Dashboards lets you use third-party identity providers to log in to OpenSearch Dashboards. SAML authentication for OpenSearch Dashboards is only for accessing OpenSearch Dashboards through a web browser.

Overview of Okta SAML authenticated solution

Figure 1 depicts a sample architecture of a generic, integrated solution between Okta and OpenSearch Dashboards over SAML authentication.

The initial sign-in flow is as follows:

1. User opens browser window and navigates to OpenSearch Dashboards
2. OpenSearch Service generates SAML authentication request
3. OpenSearch Service redirects request back to browser
4. Browser redirects to Okta URL
5. Okta parses SAML request, authenticates user, and generates SAML response
6. Okta returns encoded SAML response to browser
7. Browser sends SAML response back to OpenSearch Service Assertion Consumer Services (ACS) URL
8. ACS verifies SAML response
9. User logs into OpenSearch Service domain

Prerequisites

For this walkthrough, you should have the following prerequisites:

1. An AWS account
2. A virtual private cloud (VPC)-based OpenSearch Service domain with fine-grained access control enabled
3. Okta account with user and a group
4. A browser with network connectivity to Okta, OpenSearch Service domain, and OpenSearch Dashboards.

The steps in this post are structured into the following sections:

1. Identity provider (Okta) setup
2. Prepare OpenSearch Service for SAML configuration
3. Identity provider (Okta) SAML configuration
4. Finish OpenSearch Service for SAML configuration
5. Validation
6. Cleanup

Identity provider (Okta) setup

Step 1: Sign up for an Okta account

• Sign up for an Okta account, then click on the Sign up button to complete your account setup.
• If you already have an account with Okta, login to your Okta account.

Step 2: Create Groups in Okta

• Choose Directory in the left menu and click Groups to proceed.
• Click on Add Group and enter name as opensearch. Then click on the Save button, see Figure 2.

Step 3: Create users in Okta

• Choose People in left menu under Directory section and click the +Add Person button.
• Provide First name, Last name, username (email ID), and primary email. Then select set by admin from the Password dropdown, and choose first time password. Click on the Save button to create your user.
• Add more users as needed.

Step 4: Assign Groups to users 

• Choose Groups from the left menu, then click on the opensearch group created in Step 2. Click on the Assign People button to add users to the opensearch group. Next, either click on individual user under Person & Username, or use the Add All button to add all existing users to the opensearch group. Click on the Save button to complete adding users to your group.

Prepare OpenSearch Service for SAML configuration

Once OpenSearch Service domain is up and running, we can proceed with configuration.

• Navigate to the OpenSearch Service console
• Under Actions, choose Edit security configuration as shown in Figure 3

• Under SAML authentication for OpenSearch Dashboards/Kibana, select the Enable SAML authentication check box, see Figure 4. When we enable SAML, it will create different URLs required for configuring SAML with your identity provider.

We will be using the Service Provider entity ID and SP-initiated SSO URL (highlighted in Figure 4) for Okta SAML configuration. The OpenSearch Dashboards login flow can take one of two forms:

• Service provider (SP) initiated: You navigate to your OpenSearch Dashboard (for example, https://my-domain.us-east-1.es.amazonaws.com/_dashboards), which redirects you to the login screen. After you log in, the identity provider redirects you to OpenSearch Dashboards.
• Identity provider (IdP) initiated: You navigate to your identity provider, log in, and choose OpenSearch Dashboards from an application directory.

We will complete the rest of the OpenSearch Service SAML configuration after the Okta SAML configuration.

Okta SAML configuration

• Go back to Okta.com, and choose Applications from the left menu. Click on Applications, then click on Create App Integration and choose SAML 2.0. Click on the Next button to proceed, as shown in Figure 5.
• For this example, we are creating an application called “OpenSearch Dashboard”.
• Select Platform as Web, and select Sign on method as SAML 2.0. Click on the Create button to proceed.

• Enter the App name as OpenSearch, use default options, and click on the Next button to proceed.
• Enter the following under the SAML Settings section, as shown in Figure 6. Click on the Next button to proceed.
  • Single Sign on URL = https://vpc-XXXXX-XXXXX.us-west-2.es.amazonaws.com/_dashboards/_opendistro/_security/saml/acs (SP-initiated SSO URL)
  • Audience URI(SP Entity ID) = https://vpc-XXXXX-XXXXX.us-west-2.es.amazonaws.com (Service Provider entity ID)
  • Default RelayState = leave it blank
  • Name ID format = Select EmailAddress from drop down
  • Application username = Select Okta username from dropdown
  • Update application username on = leave it set to default
• Enter the following under Attribute Statements (optional) section.
  • Name = http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
  • Name format = Select URI Reference from dropdown
  • Value = user.email
• Enter the following under the Group Attribute Statements (optional) section.
  • Name = http://schemas.xmlsoap.org/claims/Group
  • Name format = Select URI Reference from dropdown
  • Filter = Select Matches regex from dropdown and enter value as .*open.* to match the group created in previous steps for OpenSearch Dashboards access.

• Select I’m a software vendor. I’d like to integrate my app with Okta under the Help Okta Support understand how you configured this application section.
• Click on the Finish button to complete the Okta SAML application configuration.
• Choose Sign on menu. Right click on the Identity Provider metadata hyperlink to download the Okta identity provider metadata as okta.xml. You will use this for the SAML configuration in OpenSearch Service, see Figure 7.

• Choose the Assignments menu and click on Assign-> Assign to Groups
• Select the opensearch group, click on Assign, and click on the Done button to complete the Group assignment, as shown in Figure 8.

• Switch back to the OpenSearch Service domain
• Under the Import IdP metadata section:
  • Metadata from IdP: Import the Okta identity provider metadata from the downloaded XML file
  • SAML master backend role: opensearch (Okta group). Provide the SAML backend role/group SAML assertion key for group SSO into OpenSearch Dashboard.
• Under Optional SAML settings:
  • Leave Subject Key blank
  • Role key should be http://schemas.xmlsoap.org/claims/Group. You can view a sample assertion during the configuration process with tools like SAML-tracer. This can help you examine and troubleshoot the contents of real assertions.
  • Session time to live (mins): 60
• Click on the Save changes button (Figure 9) to complete OpenSearch Service SAML configuration for OpenSearch Dashboards. We have successfully completed SAML configuration, and now we are ready for testing.

Validating access with Okta users

• Access the OpenSearch Dashboards endpoint from the previously created OpenSearch Service cluster. The OpenSearch Dashboards URL can be found in General information within “My Domains” of the OpenSearch Service console, as shown in Figure 10. The first access to OpenSearch Dashboards URL redirects you to the Okta login screen.

• Now copy and paste the OpenSearch Dashboards URL in your browser, and enter the user credentials.
• If your OpenSearch Service domain is hosted within a private VPC, you will not be able to access your OpenSearch Dashboard over public internet. But you can still use SAML as long as your browser can communicate with both your OpenSearch Service cluster and your identity provider.
• You can create a Mac or Windows EC2 instance within the same VPC so that you can access Amazon OpenSearch Dashboard from EC2 instance’s web browser to validate your SAML configuration. Or you can access your OpenSearch Dashboard through Site-to-Site VPN from your on-premises environment.
• After successful login, you will be redirected into the OpenSearch Dashboards home page. Here, you can explore our sample data and visualizations in OpenSearch Dashboards (Figure 11).

• Now, you have successfully federated OpenSearch Dashboards with Okta as an identity provider. You can connect OpenSearch Dashboards by using your Okta credentials.

Cleaning up

After you test out this solution, remember to delete all the resources you created, to avoid incurring future charges. Refer to these links:

• Deleting your OpenSearch Service domain
• Deleting your Okta account (if needed)

Conclusion

In this blog post, we have demonstrated how to set up Okta as an identity provider over SAML authentication for OpenSearch Dashboards access. Get started by checking the Amazon OpenSearch Service Developer Guide, which provides guidance on how to build applications using OpenSearch Service.

Post Syndicated from Raghavarao Sodabathina original https://aws.amazon.com/blogs/architecture/building-saml-federation-for-amazon-opensearch-dashboards-with-auth0/

Amazon OpenSearch is a fully managed, distributed, open search, and analytics service that is powered by the Apache Lucene search library. OpenSearch is derived from Elasticsearch 7.10.2, and is used for real-time application monitoring, log analytics, and website search. It’s ideal for use cases that require fast access and response for large volumes of data. OpenSearch Dashboards is derived from Kibana 7.10.2, and used for visual data exploration. With Security Assertion Markup Language (SAML)-based federation for OpenSearch, Dashboards lets you use your existing identity provider (IdP) like Auth0. You can use Auth0 to provide single sign-on (SSO) for OpenSearch Dashboards on Amazon OpenSearch search domains. It also gives you fine-grained access control, and the ability to search your data and build visualizations. Amazon OpenSearch supports providers that use the SAML 2.0 standard, such as Auth0, Okta, Keycloak, Active Directory Federation Services (AD FS), and Ping Identity (PingID).

In this post, we provide step-by-step guidance to show you how to set up a trial Auth0 account. We’ll demonstrate how to build users and groups within your organization’s directory, and enable SP-initiated single sign-on (SSO) into OpenSearch Dashboards.

To use this feature, you must enable fine-grained access control. Rather than authenticating through Amazon Cognito or an internal user database, SAML authentication for OpenSearch Dashboards lets you use third-party identity providers to log in to the OpenSearch Dashboards. SAML authentication for OpenSearch Dashboards is only for accessing the OpenSearch Dashboards through a web browser. Your SAML credentials do not let you make direct HTTP requests to OpenSearch or OpenSearch Dashboards APIs.

Auth0 is an AWS Competency Partner and popular Identity-as-a-Service (IDaaS) solution. It supports both service provider (SP)-initiated and identity provider (IdP)-initiated SSO. For SP-initiated SSO, when you sign into the OpenSearch Dashboards login page it sends an authorization request to Auth0. Once it authenticates your identity, you are redirected to OpenSearch Dashboards. In IdP-initiated SSO, you log in to the Auth0 SSO page, and choose OpenSearch Dashboards to open the application.

Overview of AuthO SAML authenticated solution

Figure 1 depicts a sample architecture of a generic, integrated solution between Auth0 and OpenSearch Dashboards over SAML authentication.

The sign-in flow is as follows:

1. User opens browser window and navigates to Amazon OpenSearch Dashboards
2. Amazon OpenSearch generates SAML authentication request
3. Amazon OpenSearch redirects request back to browser
4. Browser redirects to Auth0 URL
5. Auth0 parses SAML request, authenticates user, and generates SAML response
6. Auth0 returns encoded SAML response to browser
7. Browser sends SAML response back to Amazon OpenSearch Assertion Consumer Service (ACS) URL
8. ACS verifies SAML response
9. User logs into Amazon OpenSearch domain

Prerequisites

For this walkthrough, you should have the following prerequisites:

1. An AWS account
2. A virtual private cloud (VPC) based Amazon OpenSearch domain with fine-grained access control enabled
3. An Auth0 account with user and a group
4. A browser with network connectivity to Auth0, Amazon OpenSearch domain, and Amazon OpenSearch Dashboards.

The steps in this post are structured into the following sections:

1. Identity provider (Auth0) setup
2. Prepare Amazon OpenSearch for SAML configuration
3. Identity provider (Auth0) SAML configuration
4. Finish Amazon OpenSearch for SAML configuration
5. Validation
6. Cleanup

Identity provider (Auth0) setup

Step 1: Sign up for an Auth0 account

• Sign up for an Auth0 account, then click on the Sign up button to complete your account setup.
• If you already have an account with Auth0, log in to your Auth0 account.

Step 2: Create Groups in Auth0

• Choose User Management in the left menu and click Users, then click on the +Create User button.
• Provide an email, password, and connection to your users. Click on the Create button to create your user.
• Add more users to your Auth0 account.

Step 3: Install Auth0 Extension to create a group and assign users to the group

• Click on Extensions in the left menu and search for “Auth0 Authorization”. Click on Auth0 Authorization to install the extension, shown in Figure 2.

• Use all default options and click on the Install button to install the extension.
• Click on the Auth0 Authorization extension and choose the Accept button to provide access to your Auth0 account.
• The Auth0 Authorization extension must be configured. Click on Go to Configuration (Figure 3).

• Rotate your API keys and check Groups, Roles, and Permissions to provide authorization to the extension and then click on PUBLISH RULE to complete the configuration, see Figure 4.

Step 4: Create a group in Auth0

• Choose Groups from the left menu and click on the Create your first Group button. For this example, we will create a group called opensearch for OpenSearch Dashboards access.
• Add your users to opensearch by clicking on ADD MEMBERS BUTTON, then click on the CONFIRM button to complete your group assignment (Figure 5).

Step 5: Create an Auth0 Application

• Choose Applications from the left menu. Click on the +Create Application button.
• For this example, we are creating an application called “opensearch”.
• Select Single Page Web Applications, then click on the CREATE button to proceed.
• Click on the Addons tab on the application Kibana (Figure 6).

• Click on the SAML2 WEB APP, then select settings to provide SAML URLs from Amazon OpenSearch. We will configure these details after preparing the Amazon OpenSearch cluster for SAML.

Prepare Amazon OpenSearch for SAML configuration

Once the Amazon OpenSearch domain is up and running, we can proceed with configuration.

• Under Actions, choose Edit security configuration (Figure 7).

• Under SAML authentication for OpenSearch Dashboards/Kibana, select the Enable SAML authentication check box (Figure 8). When we enable SAML, it will create different URLs required for configuring SAML with your identity provider.

We will be using the Service Provider entity ID and SP-initiated SSO URL (highlighted in Figure 8) for Auth0 SAML configuration. We will complete the rest of the Amazon OpenSearch SAML configuration after the Auth0 SAML configuration.

Auth0 SAML configuration

Go back to Auth0.com, and navigate to Applications from the left menu. Then select the opensearch application that you created as a part of the Auth0 setup.

• Click on the Addons tab on the application opensearch.
• Click on the SAML2 WEB APP, then select Settings to provide SAML URLs from Amazon OpenSearch, as shown in Figure 9:
  • Application Callback URL = https://vpc-XXXXX-XXXXX.us-east-1.es.amazonaws.com/_dashboards/_opendistro/_security/saml/acs (SP-initiated SSO URL)
  • audience”: “https://vpc-XXXXX-XXXXX.us-east-1.es.amazonaws.com” (Service provider entity ID)
  • destination”: “ https://vpc-XXXXX-XXXXX.us-east-1.es.amazonaws.com/_plugin/kibana/_opendistro/_security/saml/acs” (SP-initiated SSO URL)
  • Mappings and other configurations shown in Figure 9

{
  "audience": "https://vpc-XXXXX-XXXXX.us-east-1.es.amazonaws.com",
  "destination": "https://vpc-XXXXX-XXXXX.us-east-1.es.amazonaws.com/_plugin/kibana/_opendistro/_security/saml/acs",
  "mappings":
  {
    "email":
    "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress",
    "name": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name",
    "groups": "http://schemas.xmlsoap.org/claims/Group"
  },
  "createUpnClaim": false,
  "passthroughClaimsWithNoMapping": false,
  "mapUnknownClaimsAsIs": false,
  "mapIdentities": false,
  "nameIdentifierFormat":
  "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", "nameIdentifierProbes": [
"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" ]
}

• Click on Enable to save the SAML configurations.
• Go to the Usage tab, and click on the Download button to download Identity Provider Metadata, see Figure 10.

Amazon OpenSearch SAML configuration

• Switch back to Amazon OpenSearch domain:
  • Navigate to Amazon OpenSearch console
  • Click on Actions, then click on Modify Security configuration
  • Select Enable SAML authentication check box
• Under Import IdP metadata section (Figure 11):
  • Metadata from IdP: Import the Auth0 identity provider metadata from downloaded XML file
  • SAML master backend role: opensearch (Auth0 group). Provide a SAML backend role/group SAML assertion key for group SSO into Kibana

• Under Optional SAML settings (Figure 12):
  • Leave Subject Key as blank, as Auth0 provides NameIdentifier
  • Role key should be http://schemas.xmlsoap.org/claims/Group. Auth0 lets you view a sample assertion during the configuration process by clicking on the DEBUG button on SAML2 WebApp. Tools like SAML-tracer can help you examine and troubleshoot the contents of real assertions.
  • Session time to live (mins): 60

Click on the Save changes button to complete Amazon OpenSearch SAML configuration for Kibana. We have successfully completed SAML configuration and are now ready for testing.

Validating access with Auth0 users

• Access OpenSearch Dashboards from the previously created OpenSearch cluster. The OpenSearch Dashboards URL can be found as shown in Figure 13. The first access to the OpenSearch Dashboards URL redirects you to the Auth0 login screen.

• Now copy and paste the OpenSearch Dashboards URL in your browser, and enter the user credentials.
• If your OpenSearch domain is hosted within a private VPC, you will not be able to access your OpenSearch Dashboard over the public internet. But you can still use SAML as long as your browser can communicate with both your OpenSearch cluster and your identity provider.
• You can create a Mac or Windows EC2 instance within the same VPC. This way you can access Amazon OpenSearch Dashboards from your EC2 instance’s web browser to validate your SAML configuration. You can also access Amazon OpenSearch Dashboards through Site-to-Site VPN from an on-premises environment.
• After successful login, you will be redirected into the OpenSearch Dashboards home page. Explore our sample data and visualizations in OpenSearch Dashboards, as shown in Figure 14.

• You now have successfully federated Amazon OpenSearch Dashboards with Auth0 as an identity provider. You can connect OpenSearch Dashboards by using your Auth0 credentials.

Cleaning up

After you test out this solution, remember to delete all the resources you created to avoid incurring future charges. Refer to these links:

• Deleting your Amazon OpenSearch domain
• Deleting your Auth0 account (if needed)

Conclusion

In this blog post, we have demonstrated how to set up Auth0 as an identity provider over SAML authentication for Amazon OpenSearch Dashboards access. With this solution, you now have an OpenSearch Dashboard that uses Auth0 as the custom identity provider for your users. This reduces the customer login process to one set of credentials and improves employee productivity.

Get started by checking the Amazon OpenSearch Developer Guide, which provides guidance on how to build applications using Amazon OpenSearch for your operational analytics.