Construct a safe information visualization utility utilizing the Amazon Redshift Information API with AWS IAM Id Middle

In right now’s data-driven world, securely accessing, visualizing, and analyzing information is crucial for making knowledgeable enterprise selections. Tens of hundreds of consumers use Amazon Redshift for contemporary information analytics at scale, delivering as much as 3 times higher price-performance and 7 occasions higher throughput than different cloud information warehouses. The Amazon Redshift Information API simplifies entry to your Amazon Redshift information warehouse by eradicating the necessity to handle database drivers, connections, community configurations, information buffering, and extra.

With the newly launched characteristic of Amazon Redshift Information API help for single sign-on and trusted id propagation, you may construct information visualization purposes that combine single sign-on (SSO) and role-based entry management (RBAC), simplifying person administration whereas imposing applicable entry to delicate data. As an illustration, a world sports activities gear firm promoting merchandise throughout a number of areas wants to visualise its gross sales information, which incorporates country-level particulars. To keep up the fitting stage of entry, the corporate needs to limit information visibility primarily based on the person’s position and area. Regional gross sales managers ought to solely see gross sales information for his or her particular area, similar to North America or Europe. Conversely, the worldwide gross sales executives require full entry to your entire dataset, protecting all nations.

On this publish, we dive into the newly launched characteristic of Amazon Redshift Information API help for SSO, Amazon Redshift RBAC for row-level safety (RLS) and column-level safety (CLS), and trusted id propagation with AWS IAM Id Middle to let company identities hook up with AWS providers securely. We exhibit combine these providers to create a knowledge visualization utility utilizing Streamlit, offering safe, role-based entry that simplifies person administration whereas ensuring that your group could make data-driven selections with enhanced safety and ease.

Resolution overview

We use a number of AWS providers and open supply instruments to construct a easy information visualization utility with SSO to entry information in Amazon Redshift with RBAC. The important thing elements that energy the answer are as follows:

IAM Id Middle and trusted id propagation – IAM Id Middle can simplify person administration by enabling SSO throughout AWS providers. This permits customers to authenticate with their company credentials managed of their company id supplier (IdP) like Okta, offering seamless entry to the applying. We discover how trusted id propagation allows managing application-level entry management at scale and exercise logging throughout AWS providers, like Amazon Redshift, by propagating and sustaining id context all through the workflow.
Exterior IdP – We use Okta as an exterior IdP to handle person authentication. Okta connects to IAM Id Middle, permitting customers to authenticate from exterior methods whereas sustaining centralized id administration inside AWS. This makes positive that person entry and roles are constantly maintained throughout each AWS providers and exterior instruments.
Amazon Redshift Serverless workgroup, Amazon Redshift Information API, and Amazon Redshift RBAC – Amazon Redshift is a completely managed information warehouse service that enables for quick querying and evaluation of enormous datasets. On this answer, we use the Redshift Information API, which gives a easy and safe HTTP-based connection to Amazon Redshift, eliminating the necessity for JDBC or ODBC driver-based connections. The Redshift Information API is the beneficial methodology to attach with Amazon Redshift for net purposes. We additionally use RBAC in Amazon Redshift to exhibit entry restrictions on gross sales information primarily based on the area column, ensuring that regional gross sales managers solely see information for his or her assigned areas, whereas world gross sales managers have full entry.
Streamlit utility – Streamlit is a extensively used open supply software that allows the creation of interactive information purposes with minimal code. On this answer, we use Streamlit to construct a user-friendly interface the place gross sales managers can view and analyze gross sales information in a visible, accessible format. The applying will combine with Amazon Redshift, offering customers with entry to the information primarily based on their roles and permissions.

The next diagram illustrates the answer structure for SSO with the Redshift Information API utilizing IAM Id Middle.

The person workflow for the information visualization utility consists of the next steps:

The person (whether or not a regional gross sales supervisor or world gross sales supervisor) accesses the Streamlit utility, which is built-in with SSO to offer a seamless authentication expertise.
The applying redirects the person to authenticate by way of Okta, the exterior IdP. Okta verifies the person’s credentials and returns an ID token to the applying.
The applying makes use of the token issued by Okta to imagine a task and short-term AWS Id and Entry Administration (IAM) session credentials to name the IAM Id Middle AssumeRoleWithWebIdentity API and IAM AssumeRole API in later steps.
The applying exchanges the Okta ID token for a token issued by IAM Id Middle by calling the IAM Id Middle CreateTokenWithIAM API utilizing the short-term IAM credentials from the earlier step. This token makes positive that the person is authenticated with AWS providers and is tied to the IAM Id Middle person profile.
The applying requests an identity-enhanced IAM position session utilizing the IAM Id Middle token by calling the AssumeRole
The applying makes use of the identity-enhanced IAM position session credentials to securely question Amazon Redshift for gross sales information. The credentials guarantee that solely approved customers can work together with the Redshift information.
Because the question is processed, Amazon Redshift checks the id context offered by IAM Id Middle. It verifies the person’s position and group membership, similar to being part of the North American area or the worldwide gross sales supervisor group.
Primarily based on the person’s id and group membership, and utilizing Amazon Redshift RBAC and row-level safety, Amazon Redshift makes an authorization choice. The teams for the illustration may be broadly categorized into the next classes:
1. Regional gross sales managers will probably be granted entry to view gross sales information just for the particular nation or area they handle. As an illustration, the AMER North American Gross sales Supervisor will solely see gross sales information associated to North America. Equally, the entry management primarily based on EMEA and APAC areas will present row-level safety for the respective areas.
2. The worldwide gross sales managers will probably be granted full entry to all areas, enabling them to view your entire world dataset.

The setup consists of two most important steps:

Provision the sources for IAM Id Middle, Amazon Redshift and Okta:
1. Allow IAM Id Middle and configure Okta because the IdP to handle person authentication and group provisioning.
2. Create an Okta utility to authenticate customers accessing the Streamlit utility.
3. Arrange an Amazon Redshift IAM Id Middle connection utility to allow trusted id propagation for safe authentication.
4. Provision an Amazon Redshift Serverless
5. Create the tables and configure RBAC inside the Redshift workgroup to implement row-level safety for various IAM Id Middle federated roles, mapped to IAM Id Middle teams.
Obtain, configure, and run the Streamlit utility:
1. Create a buyer managed utility in IAM Id Middle for the Redshift Information API shopper (Streamlit utility) to allow safe API-based queries and create the required IAM roles
2. Configure the Streamlit utility.
3. Run the Streamlit utility.

Stipulations

You must have the next stipulations:

Provision the sources for IAM Id Middle, Amazon Redshift, and Okta

On this part, we stroll by way of the steps to provision the sources for IAM Id Middle, Amazon Redshift, and Okta.

Allow IAM Id Middle and configure Okta because the IdP

Full the next steps to allow IAM Id Middle and configure Okta because the IdP to handle person authentication and group provisioning:

Create the next customers and teams in Okta:
1. Ethan World with e-mail ethan@instance.com, in group exec-global
2. Frank Amer with e-mail frank@instance.com, in group amer-sales
3. Alex Emea with e-mail alex@instance.com, in group emea-sales
4. Ming Apac with e-mail ming@instance.com, in group apac-sales

Create an IAM Id Middle occasion within the AWS Area the place Amazon Redshift goes to be deployed. A company occasion kind is beneficial.
Configure Okta because the id supply and allow automated person and group provisioning. The customers and teams will probably be pushed to IAM Id Middle utilizing SCIM protocol.

The next screenshot exhibits the customers synced in IAM Id Middle utilizing SCIM protocol.

Create an Okta utility

Full the next steps to create an Okta utility to authenticate customers accessing the Streamlit utility:

Create an OIDC utility in Okta.
1. Copy and save the shopper ID and shopper secret wanted later for the Streamlit utility and the IAM Id Middle utility to attach utilizing the Redshift Information API.
2. Generate the shopper secret and set sign-in redirect URL and sign-out URL to http://localhost:8501 (we’ll host the Streamlit utility regionally on port 8501).
3. Below Assignments, Managed entry, grant entry to everybody.
Create an OIDC IdP on IAM the console. The next screenshot exhibits an IdP created on the IAM console.

Arrange an Amazon Redshift IAM Id Middle connection utility

Full the next steps to create an Amazon Redshift IAM Id Middle connection utility to allow trusted id propagation for safe authentication:

On the Amazon Redshift console, select IAM Id Middle connection within the navigation pane.
Select Create utility.
Title the applying redshift-data-api-okta-app.
Notice down the IdP namespace. The default worth AWSIDC is used for this publish.

Within the IAM position for IAM Id Middle entry part, it’s good to present an IAM position. You possibly can go to the IAM console and create an IAM position known as RedshiftOktaRole with the next coverage and belief relationship. RedshiftOktaRole is utilized by the Amazon Redshift IAM Id Middle connection utility to handle and work together with IAM Id Middle.

The coverage connected to the position wants the next permissions:

{   "Model": "2012-10-17",   "Assertion": [     {       "Effect": "Allow",       "Action": [         "sso:DescribeApplication",         "sso:DescribeInstance"       ],       "Useful resource": [         "arn:aws:sso:::instance/",         "arn:aws:sso:::application//*"       ]     }   ] }

The position makes use of the next belief relationship:

{   "Model": "2012-10-17",   "Assertion": [     {       "Effect": "Allow",       "Principal": {         "Service": [           "redshift.amazonaws.com",           "redshift-serverless.amazonaws.com"         ]       },       "Motion": [         "sts:AssumeRole",         "sts:SetContext"       ]     }   ] }

Depart Trusted Id propagation part unchanged, then select Subsequent. You could have the choice to decide on AWS Lake Formation or Amazon S3 Entry Grants to be used circumstances like utilizing Amazon Redshift Spectrum to question exterior tables in Lake Formation. In our use case, we solely use Amazon Redshift native tables so we don’t select both.
Within the Configure shopper connections that use third-party IdPs part, select No.
Assessment and select Create utility.
When the applying is created, navigate to your IAM Id Middle connection redshift-data-api-okta-app and select Assign so as to add the teams that have been synced in IAM Id Middle utilizing SCIM protocol from Okta.

We are going to allow trusted id propagation and third-party IdP (Okta) on the client managed utility for the Redshift Information API in a later step as a substitute of configuring it within the Amazon Redshift connection utility.

The next screenshot exhibits the IAM Id Middle connection utility created on the Amazon Redshift console.

The next screenshot exhibits teams assigned to the Amazon Redshift IAM Id Middle connection for the managed utility.

Provision a Redshift Serverless workgroup

Full the next steps to create a Redshift Serverless workgroup. For extra particulars, discuss with Making a workgroup with a namespace.

On the Amazon Redshift console, navigate to the Redshift Serverless dashboard.
Select Create workgroup.
Enter a reputation in your workgroup (for instance, redshift-tip-enabled).
Change the Base capability to eight RPU within the Efficiency and price management
You possibly can configure community and safety primarily based in your digital personal cloud (VPC) and subnet you wish to create the workgroup.
Within the Namespace part, create a brand new namespace in your workgroup. (For instance, redshift-tip-enabled-namespace).
Within the Database identify and password part, choose Customise admin person credentials and set the admin person identify and create a password. Notice them down to make use of in a later step to configure RBAC in Amazon Redshift.
Within the Id Middle connections part, select Allow for the cluster possibility and choose the Amazon Redshift IAM Id Middle utility created within the earlier step (redshift-data-api-okta-app).
Affiliate an IAM position with the workgroup that has the next insurance policies connected. Make it the default position to make use of.
Depart different settings as default and select Subsequent.
Assessment the settings and create the workgroup.

Wait till the workgroup is obtainable earlier than persevering with to the subsequent steps.

Create the tables and configure RBAC inside the Redshift Serverless workgroup

Subsequent, you employ the Amazon Redshift Question Editor V2 on the Amazon Redshift console to connect with the workgroup you simply created. You create the tables and configure the Amazon Redshift roles akin to Okta teams for the teams in IAM Id Middle and use the RBAC coverage to grant customers privileges to view information just for their areas. Full the next steps:

On the Amazon Redshift console, open the Question Editor V2.
Select the choices menu (three dots) subsequent to the Redshift workgroup identify and select Edit connection.
Choose Different methods to attach and use the database person identify and password to attach.

Within the question editor, run the next code to create the gross sales desk and cargo the information from Amazon Easy Storage Service (Amazon S3):

# Create the desk CREATE TABLE IF NOT EXISTS public.sales_data (     SKU VARCHAR(50),     Product_Name VARCHAR(255),     Class VARCHAR(100),     Amount INT,     Sales_Price DECIMAL(10,2),     Timestamp TIMESTAMP,     Metropolis VARCHAR(100),     Region_Code VARCHAR(10),     Nation VARCHAR(10),     Latitude DECIMAL(10,6),     Longitude DECIMAL(10,6),     Inhabitants INT,     Elevation INT,     Timezone VARCHAR(50) ); # Load information from S3 to desk COPY public.sales_data FROM 's3://redshift-blogs/redshift-data-api-idc/sales_data.csv' IAM_ROLE default CSV IGNOREHEADER 1 DELIMITER ',' TIMEFORMAT 'auto'; # Create Redshift roles for the teams in IDC, the position format is Namespace:IDCGroupName CREATE ROLE "AWSIDC:amer-sales"; CREATE ROLE "AWSIDC:emea-sales"; CREATE ROLE "AWSIDC:apac-sales"; CREATE ROLE "AWSIDC:exec-global"; --Create RLS coverage CREATE RLS POLICY eu_region_filter WITH (timezone VARCHAR(50)) USING (timezone LIKE 'Europe%'); CREATE RLS POLICY apac_region_filter WITH (timezone VARCHAR(50)) USING (timezone LIKE 'Asia%'); CREATE RLS POLICY amer_region_filter WITH (timezone VARCHAR(50)) USING (timezone LIKE 'America%'); --Connect coverage ATTACH RLS POLICY eu_region_filter ON sales_data TO ROLE "AWSIDC:emea-sales"; ATTACH RLS POLICY apac_region_filter ON sales_data TO ROLE "AWSIDC:apac-sales"; ATTACH RLS POLICY amer_region_filter ON sales_data TO ROLE "AWSIDC:amer-sales"; --Activate RLS on desk ALTER TABLE public.sales_data ROW LEVEL SECURITY ON; GRANT IGNORE RLS TO ROLE "AWSIDC:exec-global";

IAM Id Middle will map the teams into the Redshift roles within the format of Namespace:IDCGroupName. Due to this fact, create the position identify as AWSIDC:emea-sales and so forth to match them with Okta group names synced in IAM Id Middle. The customers will probably be created robotically inside the teams as they log in utilizing SSO into Amazon Redshift.

Obtain, configure, and run the Streamlit utility

On this part, we stroll by way of the steps to obtain, configure, and run the Streamlit utility.

Create a buyer managed utility in IAM Id Middle for the Redshift Information API shopper

With a purpose to begin a trusted id propagation workflow and permit Amazon Redshift to make authorization selections primarily based on the customers and teams from IAM Id Middle (provisioned from the exterior IdP), you want an identity-enhanced IAM position session.

This requires a few IAM roles and a buyer managed utility in IAM Id Middle to deal with the belief relationship between the exterior IdP and IAM Id Middle and management entry for the Redshift Information API shopper, on this case, the Streamlit utility.

First, you create two IAM roles, then you definitely create a buyer managed utility for the Streamlit utility. Full the next steps:

Create a short lived IAM position (we named it IDCBridgeRole) to alternate the token with IAM Id Middle (assuming you don’t have an current IAM id to make use of). This position will probably be assumed by the Streamlit utility with AssumeRoleWithWebIdentity to get a short lived set of position credentials to name the CreateTokenWithIAM and AssumeRole APIs to get the identity-enhanced position session.

Connect the next coverage the position:

{     "Model": "2012-10-17",     "Assertion": [         {             "Effect": "Allow",             "Action": "sso-oauth:CreateTokenWithIAM",             "Resource": "*"         },         {             "Effect": "Allow",             "Action": "sts:SetContext",             "Resource": "*"         },         {             "Effect": "Allow",             "Action": "sts:AssumeRole",             "Resource": "*"         }     ] }

Within the belief relationship, present your AWS account ID and IdP’s URL. The trusted principal to make use of is the Amazon Useful resource Title (ARN) of oidc-provider you created earlier.

{     "Model": "2012-10-17",     "Assertion": [         {             "Effect": "Allow",             "Principal": {                 "Federated": "arn:aws:iam:::oidc-provider/"             },             "Action": "sts:AssumeRoleWithWebIdentity"         }     ] }

Create an IAM position with permissions to entry the Redshift Information API (we named it RedshiftDataAPIClientRole). This position will probably be assumed by the Streamlit utility with the improved identities from IAM Id Middle after which used to authenticate requests to the Redshift Information API.
1. Connect the AmazonRedshiftDataFullAccess AWS managed coverage. AWS recommends utilizing the precept of least privilege in your IAM coverage.
2. Limit the belief relationship to the IDCBridgeRole ARN created within the earlier step), and supply your AWS account ID:
```
{     "Model": "2012-10-17",     "Assertion": [         {             "Sid": "Statement1",             "Effect": "Allow",             "Principal": {                 "AWS": "arn:aws:iam:::role/IDCBridgeRole"             },             "Action": [                 "sts:AssumeRole",                 "sts:SetContext"             ]         }     ] }
```

Now you may create the client managed utility.

On the IAM Id Middle console, select Purposes within the navigation pane.
Select Add utility.
Select I’ve an utility I wish to setup, choose the OAuth 2.0 utility kind, and select Subsequent.
Enter a reputation for the applying, for instance, RedshiftStreamlitDemo.
In Person and group project methodology, select Don’t require project. This implies all of the customers provisioned in IAM Id Middle from Okta can use their Okta credentials to sign up to the Streamlit utility. You possibly can alternatively choose the Require assignments possibility and decide the customers and teams you wish to permit entry to the applying.
Within the AWS entry portal part, select Not seen, then select Subsequent.
Within the Authentication with trusted token issuer part, choose Create trusted token issuer, then enter the Okta issuer URL and enter a reputation for the trusted token issuer.
Within the map attribute, use the default e-mail to e-mail mapping between the exterior IdP attribute and IAM Id Middle attribute, then create the trusted token issuer.
Choose the trusted token issuer you simply created.
Within the Aud declare part, use the shopper ID of the Okta utility you famous earlier, then select Subsequent.

Within the Specify utility credentials part, select Edit the applying coverage and use the next coverage:

{   "Model": "2012-10-17",   "Assertion": [     {       "Effect": "Allow",       "Principal": {         "Service": "redshift-data.amazonaws.com"       },       "Action": "sso-oauth:*",       "Resource": "*"     }   ] }

Select Submit.

After the applying is created, you may view it in on the IAM Id Middle.

Select Purposes within the navigation pane, and find the Buyer managed purposes tab.

Select the applying to navigate to the applying particulars web page.
Within the Trusted purposes for id propagation part, select Specify trusted purposes and choose the setup kind as Particular person purposes and specify entry, then select Subsequent.
Select Amazon Redshift because the service, then select Subsequent.
Within the Utility that may obtain requests part, select the Amazon Redshift IAM Id Middle utility you created, then select Subsequent.
Within the Entry Scopes to use part, examine the redshift:join
Assessment after which select Belief utility.

Configure and run the Streamlit utility

Now that you’ve got the roles and the client managed utility in IAM Id Middle, you may create an identity-enhanced IAM position session, which is probably the most vital step to allow trusted id propagation. Following steps present an outline of Streamlit utility code to create the identity-enhanced IAM position session.

Authenticate with and retrieve the id_token from the exterior IdP (Okta).
Name CreateTokenWithIAM utilizing the exterior IdP issued id_token to acquire an IAM Id Middle issued id_token.
Use AssumeRoleWithWebIdentity to acquire short-term IAM credentials (by assuming IDCBridgeRole, defined later).
Extract the sts:identity_context from the IAM Id Middle issued id_token.
Assume the position RedshiftDataAPIClientRole with the AssumeRole API and insert the sts:identity_context to acquire the identity-enhanced IAM position session credentials.

Now you need to use these credentials to make requests to the Redshift Information API, and Amazon Redshift will have the ability to use the id context for authorization selections.

At this level, you need to have all of the required sources for creating the Streamlit utility. Full the next steps to check the Streamlit utility:

Obtain the Streamlit utility code and modify the configuration part of the code primarily based on the sources provisioned earlier:

# TIP Token alternate configuration AWS_REGION = "" # us-east-1 TOKEN_EXCHANGE_APP_ARN = "" # The ARN of the IDC customer-managed-App created earlier TOKEN_GRANT_TYPE = "urn:ietf:params:oauth:grant-type:jwt-bearer" # mounted worth, please do not change TEMP_ROLE_ARN = "" # The position created on this step for customers to imagine with AssumeRoleWithWebIdentity(IDCBridgeRole) ENHANCED_ROLE_ARN = "" # The position created on this step for customers to imagine for the Id-enhanced position session with IAM Id Middle(RedshiftDataAPIClientRole) IDENHANCED_ROLE_SESSION_NAME = "rs-idc-tip-session" # Use any identify for the session  ROLE_DURATION_SECS = 3600  # 1 hour # Okta OAuth configuration, exchange with your individual Okta Area OKTA_DOMAIN = "" AUTHORIZE_URL = f"https://{OKTA_DOMAIN}/oauth2/v1/authorize" TOKEN_URL = f"https://{OKTA_DOMAIN}/oauth2/v1/token" REFRESH_TOKEN_URL = f"https://{OKTA_DOMAIN}/oauth2/v1/token" REVOKE_TOKEN_URL = f"https://{OKTA_DOMAIN}/oauth2/v1/revoke" LOGOUT_URL = f"https://{OKTA_DOMAIN}/oauth2/v1/logout" CLIENT_ID = "" # The shopper id of the Okta app created for the Streamlit app in 2. CLIENT_SECRET = "" # The shopper id of the Okta app created for the Streamlit app in 2. REDIRECT_URI = "http://localhost:8501" # That is for dev/check goal solely SCOPE = "openid profile e-mail" # Please don't change WORKGROUP_NAME = "" #The identify of the created Redshift Workgroup DATABASE = "dev" # The database set for the Workgroup

We advocate internet hosting this utility on an Amazon Elastic Compute Cloud (Amazon EC2) occasion for manufacturing use circumstances, and utilizing AWS Secrets and techniques Supervisor for delicate data just like the CLIENT_ID and CLIENT_SECRET offered as configuration parameters within the code for simplicity.

For this instance, we use the Okta group URL (/oauth2/v1/). You should use the client authorization servers as effectively, for instance, the default authorization server, however be sure all URLs are utilizing the identical authorization server. Consult with Authorization servers for extra details about authorization servers in Okta.

After you modify the script for the Streamlit utility, you may run it utilizing a Python digital atmosphere.

Create a Python digital atmosphere. The applying has been examined efficiently with variations v3.12.8 and v3.12.2.

You might want to set up the next packages, that are required libraries for the Streamlit utility code you downloaded in your digital atmosphere:

streamlit
streamlit_oauth
boto3
pyjwt
pydeck
pandas

You possibly can set up these libraries instantly utilizing the next command with the necessities file:
```
pip set up -r https://redshift-blogs.s3.us-east-1.amazonaws.com/redshift-data-api-idc/necessities.txt
```
Check the Streamlit utility within the Python digital atmosphere with the next command:
```
streamlit run /path/to/st_app.py
```
Log in with the person ming@instance.com from the apac-sales group.

The identity-enhanced position session credentials will show on the highest of the web page after profitable authentication with Okta.

For the APAC area supervisor, you need to solely see the information from the nations within the Asia-Pacific area primarily based on the row-level safety filter you configured earlier.

Log off and log again in with the worldwide govt person, ethan@instance.com from the exec-global

You must see the information in all areas.

You possibly can attempt different regional customers’ logins and you need to see solely the information within the area they belong to.

Trusted id propagation deep dive

On this part, you stroll by way of the Python code of the Streamlit utility and clarify how trusted id propagation works. The next is an evidence of key components of the applying code.

most important()

The most important() operate of the Streamlit utility implements the previous steps to get the identity-enhanced IAM position session utilizing the get_id_enhanded_session() operate, which wraps the login to get the identity-enhanced position session credentials:

def most important():     # Create OAuth2Component occasion     oauth2 = OAuth2Component(         CLIENT_ID,          CLIENT_SECRET,          AUTHORIZE_URL,          TOKEN_URL,          REFRESH_TOKEN_URL,          REVOKE_TOKEN_URL)          # Different setup code omitted          # Deal with OAuth authentication with Okta     if not st.session_state.is_authenticated or is_token_expired():         # Present the login button if not authenticated         st.title("Login to the Demo app")         outcome = oauth2.authorize_button("Login with Okta", REDIRECT_URI, SCOPE)         if outcome and "token" in outcome:             # Save the token in session state and mark the person as authenticated             st.session_state.token = outcome.get("token")             st.session_state.user_email = get_user_email_from_token(st.session_state.token.get("id_token"))             st.session_state.aws_creds = get_id_enhanced_session(st.session_state.token.get("id_token"))             st.session_state.is_authenticated = True             st.rerun()     else:                  st.json(st.session_state.aws_creds)         st.title("Complete Gross sales by Metropolis")              if not is_token_expired():             # Use the improved credentials to create the Redshift shopper             redshift_client = boto3.shopper("redshift-data", region_name=AWS_REGION,                                         aws_access_key_id=st.session_state.aws_creds['AccessKeyId'],                                         aws_secret_access_key=st.session_state.aws_creds['SecretAccessKey'],                                         aws_session_token=st.session_state.aws_creds['SessionToken'])         else:             st.error("Session expired. Please re-authenticate.")             logout()                  # extra code for question execution and information visualizetion omitted

We use the Streamlit st.session_state offered by Streamlit to retailer necessary session states, together with the authentication standing in addition to further data like person data and the AWS identity-enhanced position session credentials.

get_id_enhanced_session()

The get_id_enhanced_session() operate code has three steps:

We use the id_token (variable identify: jwt_token) from Okta in JWT format to name the AssumeRoleWithWebIdentity API to imagine the position IDCBridgeRole. It’s because the person doesn’t have any AWS credentials to work together with the IAM Id Middle API. For those who plan to host this utility in an AWS atmosphere with an IAM position out there, for instance, on an EC2 occasion, you need to use the position related to Amazon EC2 to make the decision to the IAM Id Middle APIs with out creating IDCBridgeRole, however be sure the EC2 position has the required permissions we specified for IDCBridgeRole.
After now we have the credentials of the short-term position, we use them to make a name to the CreateTokenWithIAM API of IAM Id Middle. This API handles the alternate of tokens by taking within the id_token from Okta and returning an IAM Id Middle issued token, which will probably be used later to get the identity-enhanced position session. For extra data, discuss with the CreateTokenWithIAM API reference.
Lastly, we extract the sts:identity_context from the IAM Id Middle issued id_token and cross it to the AWS Safety Token Service (AWS STS) AssumeRole That is carried out by together with the sts:identity_context within the ContextAssertion parameter inside ProvidedContexts, together with ProviderArn set to arn:aws:iam::aws:contextProvider/IdentityCenter.

def get_id_enhanced_session(jwt_token):     """     Obtains an identity-enhanced session by assuming a short lived IAM position,     making a token with IAM, and assuming an enhanced position session.          Args:         jwt_token (str): The JWT id token from the id supplier.          Returns:         dict or None: The improved session credentials if profitable, in any other case None.     """     logging.information("Beginning identity-enhanced session course of.")     # Step 1: Assume a short lived IAM position with the offered JWT token     temp_credentials = assume_role_with_web_identity(jwt_token)     if not temp_credentials:         logging.error("Didn't assume position with net id.")         return None     # Step 2: Use the short-term credentials to create a token with IAM     id_token = create_token_with_iam(jwt_token, temp_credentials)     if not id_token:         logging.error("Didn't create ID token with IAM.")         return None     # Step 3: Use the ID token to imagine an enhanced position session     enhanced_creds = assume_enhanced_role_session(id_token, temp_credentials)     if not enhanced_creds:         logging.error("Didn't assume enhanced position session.")         return None     logging.information("Efficiently obtained identity-enhanced session credentials.")     return enhanced_creds

assume_role_with_web_identity()

The assume_role_with_web_identity() operate code is as follows. We initialize the STS shopper, decode the JWT token, after which assume the position with the net id.

def assume_role_with_web_identity(jwt_token):     """     Assumes an IAM position utilizing an internet id token and returns the short-term credentials.     Args:         jwt_token (str): The JWT token for authentication, usually issued by an exterior id supplier.     Returns:         dict: Momentary IAM credentials (Entry Key, Secret Key, Session Token) or None if an error happens.     """     attempt:         # Initialize the STS shopper         sts_client = boto3.shopper('sts', region_name=AWS_REGION)                  # Decode the JWT token with out verifying signature (for debugging functions)         decoded_jwt = jwt.decode(jwt_token, choices={"verify_signature": False})         logging.debug(f"Decoded JWT Token: {decoded_jwt}")         # Put together the request for AssumeRoleWithWebIdentity         assume_role_request = {             'RoleArn': TEMP_ROLE_ARN,             'RoleSessionName': 'WebIdentitySession',             'WebIdentityToken': jwt_token,             'DurationSeconds': DURATION_SECS  # 1 hour         }         # Name the AssumeRoleWithWebIdentity API         assume_role_response = sts_client.assume_role_with_web_identity(**assume_role_request)                  # Extract the short-term credentials from the response         temp_credentials = assume_role_response['Credentials']         logging.information("Momentary credentials efficiently obtained.")                  # Return the short-term credentials         return temp_credentials     besides ClientError as e:         logging.error(f"Error calling AssumeRoleWithWebIdentity: {e}")         return None     besides jwt.ExpiredSignatureError:         logging.error("JWT token has expired.")         return None     besides jwt.DecodeError:         logging.error("Error decoding JWT token.")         return None     besides Exception as e:         logging.error(f"Surprising error: {e}")         return None

create_token_with_iam()

The create_token_with_iam() operate code is known as to get the id_token from IAM Id Middle. The jwt_token is the id_token in JWT format issued by Okta; the id_token is the IAM Id Middle issued id_token.

def create_token_with_iam(jwt_token, temp_credentials):     """     Creates an IAM token utilizing the offered JWT token and short-term credentials.     Args:         jwt_token (str): The JWT token to alternate for an IAM token.         temp_credentials (dict): Momentary AWS credentials for assuming the position.          Returns:         str or None: The IAM token if profitable, in any other case None.     """     logging.information("Beginning token creation course of with IAM.")          # Initialize the SSO OIDC shopper with short-term credentials     attempt:         sso_oidc_client = boto3.shopper(             'sso-oidc',              region_name=AWS_REGION,              aws_access_key_id=temp_credentials['AccessKeyId'],             aws_secret_access_key=temp_credentials['SecretAccessKey'],             aws_session_token=temp_credentials['SessionToken']         )     besides Exception as e:         logging.error(f"Error initializing SSO OIDC shopper: {e}")         return None     # Put together the request for CreateTokenWithIAM     token_request = {         'clientId': TOKEN_EXCHANGE_APP_ARN,         'grantType': TOKEN_GRANT_TYPE,         'assertion': jwt_token     }     # Name the CreateTokenWithIAM API     attempt:         token_result = sso_oidc_client.create_token_with_iam(**token_request)         id_token = token_result['idToken']         logging.information(f"Efficiently obtained ID Token: {id_token}")         return id_token     besides ClientError as e:         logging.error(f"Error calling CreateTokenWithIAM API: {e}")         return None     besides KeyError as e:         logging.error(f"Lacking anticipated area in response: {e}")         return None

Within the CreateTokenWithIAM name, we cross the next parameters:

clientId – The ARN of the IAM Id Middle utility for the Redshift Information API shopper
grantType – urn:ietf:params:oauth:grant-type:jwt-bearer
assertion – The id_token (jwt_token) issued by Okta

The idToken issued by IAM Id Middle is returned.

assume_enhanced_role_session()

The assume_enhanced_role_session() operate makes use of the ID token to imagine an identity-enhanced position session:

def assume_enhanced_role_session(id_token, temp_credentials):     """     Assumes an identity-enhanced IAM position session utilizing the offered ID token and short-term credentials.     Args:         id_token (str): The ID token containing the id context.         temp_credentials (dict): Momentary AWS credentials for assuming the position.     Returns:         dict or None: The credentials for the identity-enhanced IAM position session, or None on failure.     """     logging.information("Extracting id context from ID token.")     identity_context = extract_identity_context_from_id_token(id_token)     if not identity_context:         logging.error("Didn't extract id context from ID token.")         return None     attempt:         # Initialize STS shopper with short-term credentials         sts_client = boto3.shopper(             'sts',             region_name=AWS_REGION,             aws_access_key_id=temp_credentials['AccessKeyId'],             aws_secret_access_key=temp_credentials['SecretAccessKey'],             aws_session_token=temp_credentials['SessionToken']         )         # Put together AssumeRole request with id context         assume_role_request = {             'RoleArn': ENHANCED_ROLE_ARN,             'RoleSessionName': IDENHANCED_ROLE_SESSION_NAME,             'DurationSeconds': ROLE_DURATION_SECS,             'ProvidedContexts': [{                 'ContextAssertion': identity_context,                 'ProviderArn': "arn:aws:iam::aws:contextProvider/IdentityCenter"             }]         }         # Name the AssumeRole API         logging.information("Calling STS AssumeRole for identity-enhanced session.")         assume_role_response = sts_client.assume_role(**assume_role_request)         enhanced_role_credentials = assume_role_response['Credentials']         logging.information("Efficiently assumed enhanced position.")                  return enhanced_role_credentials     besides ClientError as e:         logging.error(f"Error calling AssumeRole: {e}")         return None

extract_identity_context_from_id_token()

The extract_identity_context_from_id_token() operate extracts the sts:identity_context:

def extract_identity_context_from_id_token(id_token):     """     Extracts the id context from a decoded JWT token.     Args:         id_token (str): The JWT token containing id context.     Returns:         dict or None: The extracted id context if out there, in any other case None.     """     logging.information("Decoding ID token to extract id context.")     attempt:         # Decode the JWT token (with out signature verification)         decoded_jwt = jwt.decode(id_token, choices={"verify_signature": False})         logging.debug(f"Decoded JWT Claims: {decoded_jwt}")         # Extract the id context from the token         for key in ('sts:identity_context', 'sts:audit_context'):             if key in decoded_jwt:                 return decoded_jwt[key]         logging.warning("No legitimate id context discovered within the token.")         return None     besides Exception as e:         logging.error(f"Error decoding JWT: {e}")         return None

Now you will have the identity-enhanced position session credentials to name the Amazon Redshift Information API.

execute_statement() and fetch_results()

The execute_statement() and fetch_results() features exhibit run Redshift queries and retrieve question outcomes with trusted id propagation for visualization:

def execute_statement(sql, redshift_client):     """     Executes a SQL assertion on Amazon Redshift utilizing the offered Redshift Information API shopper.     Args:         sql (str): The SQL question to execute.         redshift_client (boto3.shopper): The Redshift Information API shopper.     Returns:         str: The execution ID of the assertion.     Raises:         ClientError: If an error happens throughout execution.     """     attempt:         response = redshift_client.execute_statement(             WorkgroupName=WORKGROUP_NAME,             Database=DATABASE,             Sql=sql          )         return response["Id"]          besides ClientError as e:         error_code = e.response.get('Error', {}).get('Code', '')                  if error_code == 'ExpiredTokenException':             logging.error("Session expired. Logging out...")             logout()         else:             logging.error(f"Error executing assertion: {e}")             increase              def fetch_results(statement_id, redshift_client):     """     Fetches question outcomes from the Redshift Information API.     Args:         statement_id (str): The execution ID of the assertion.         redshift_client (boto3.shopper): The Redshift Information API shopper.     Returns:         listing: A listing of information from the question outcome.     """     attempt:         response = redshift_client.get_statement_result(Id=statement_id)         return response.get("Information", [])          besides ClientError as e:         logging.error(f"Error fetching question outcomes: {e}")         increase

Conclusion

On this publish, we confirmed create a third-party utility backed by analytics insights arriving from Amazon Redshift securely utilizing OIDC. With Redshift Information API help of IAM Id Middle integration, you may hook up with Amazon Redshift utilizing SSO from the IdP of your alternative. You possibly can lengthen this methodology to authenticate different AWS providers that help trusted id propagation, similar to Amazon Athena and Amazon QuickSight, enabling fine-grained entry management for IAM Id Middle customers and teams throughout your AWS ecosystem. We encourage you to arrange your utility utilizing IAM Id Middle integration and unify your entry management instantly out of your IdP throughout all IAM Id Middle supported AWS providers.

For extra data on AWS providers and purposes that help trusted id propagation, discuss with Trusted id propagation overview.

In regards to the Authors

Songzhi Liu is a Principal Huge Information Architect with the AWS Id Options group. On this position, he collaborates carefully with AWS clients and cross-functional groups to design and implement scalable information architectures, specializing in integrating massive information and machine studying options to boost id consciousness inside the AWS ecosystem.

Rohit Vashishtha is a Senior Analytics Specialist Options Architect at AWS primarily based in Dallas, Texas. He has over 19 years of expertise architecting, constructing, main, and sustaining massive information platforms. Rohit helps clients modernize their analytic workloads utilizing the breadth of AWS providers and ensures that clients get the perfect value/efficiency with utmost safety and information governance.

Fei Peng is a Senior Software program Growth Engineer working within the Amazon Redshift group, the place he leads the event of Redshift Information API, enabling seamless and scalable entry to cloud information warehouses.

Yanzhu Ji is a Product Supervisor within the Amazon Redshift group. She has expertise in product imaginative and prescient and technique in industry-leading information merchandise and platforms. She has excellent ability in constructing substantial software program merchandise utilizing net growth, system design, database, and distributed programming methods. In her private life, Yanzhu likes portray, images, and enjoying tennis.