Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fetch cognito credentials only as needed. Fixes #1311 #1391

Merged
merged 1 commit into from
Sep 14, 2023
Merged

Fetch cognito credentials only as needed. Fixes #1311 #1391

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 62 additions & 49 deletions src/main/java/org/broad/igv/util/AmazonUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
import java.net.URL;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.time.Instant;
import java.util.*;
import java.util.concurrent.CompletableFuture;
import java.util.stream.Collectors;
Expand All @@ -50,6 +51,8 @@ public class AmazonUtils {
private static Region AWSREGION;
private static Boolean awsCredentialsPresent = null;

private static Credentials cognitoAWSCredentials = null;


/**
* Maps s3:// URLs to presigned URLs
Expand Down Expand Up @@ -135,65 +138,67 @@ private static Region getAWSREGION() {
*/
public static Credentials GetCognitoAWSCredentials() {

OAuthProvider provider = OAuthUtils.getInstance().getAWSProvider();
if (cognitoAWSCredentials == null || isExpired(cognitoAWSCredentials)) {
log.debug("fetch credentials");
OAuthProvider provider = OAuthUtils.getInstance().getAWSProvider();

JsonObject igv_oauth_conf = GetCognitoConfig();
JsonObject response = provider.getResponse();
JsonObject igv_oauth_conf = GetCognitoConfig();
JsonObject response = provider.getResponse();

// Handle non-user initiated S3 auth (IGV early startup), i.e user-specified GenomesLoader
if (response == null) {
// Go back to auth flow, not auth'd yet
checkLogin();
response = provider.getResponse();
}
// Handle non-user initiated S3 auth (IGV early startup), i.e user-specified GenomesLoader
if (response == null) {
// Go back to auth flow, not auth'd yet
checkLogin();
response = provider.getResponse();
}

JsonObject payload = JWTParser.getPayload(response.get("id_token").getAsString());
JsonObject payload = JWTParser.getPayload(response.get("id_token").getAsString());

log.debug("JWT payload id token: " + payload);
log.debug("JWT payload id token: " + payload);

// Collect necessary information from federated IdP for Authentication purposes
String idTokenStr = response.get("id_token").getAsString();
String idProvider = payload.get("iss").toString().replace("https://", "")
.replace("\"", "");
String email = payload.get("email").getAsString();
String federatedPoolId = igv_oauth_conf.get("aws_cognito_fed_pool_id").getAsString();
String cognitoRoleARN = igv_oauth_conf.get("aws_cognito_role_arn").getAsString();
// Collect necessary information from federated IdP for Authentication purposes
String idTokenStr = response.get("id_token").getAsString();
String idProvider = payload.get("iss").toString().replace("https://", "")
.replace("\"", "");
String email = payload.get("email").getAsString();
String federatedPoolId = igv_oauth_conf.get("aws_cognito_fed_pool_id").getAsString();
String cognitoRoleARN = igv_oauth_conf.get("aws_cognito_role_arn").getAsString();

HashMap<String, String> logins = new HashMap<>();
logins.put(idProvider, idTokenStr);
HashMap<String, String> logins = new HashMap<>();
logins.put(idProvider, idTokenStr);

// Avoid "software.amazon.awssdk.core.exception.SdkClientException: Unable to load credentials from any of the providers in the chain AwsCredentialsProviderChain("
// The use of the AnonymousCredentialsProvider essentially bypasses the provider chain's requirement to access ~/.aws/credentials.
// https://stackoverflow.com/questions/36604024/sts-saml-and-java-sdk-unable-to-load-aws-credentials-from-any-provider-in-the-c
AnonymousCredentialsProvider anoCredProv = AnonymousCredentialsProvider.create();
// Avoid "software.amazon.awssdk.core.exception.SdkClientException: Unable to load credentials from any of the providers in the chain AwsCredentialsProviderChain("
// The use of the AnonymousCredentialsProvider essentially bypasses the provider chain's requirement to access ~/.aws/credentials.
// https://stackoverflow.com/questions/36604024/sts-saml-and-java-sdk-unable-to-load-aws-credentials-from-any-provider-in-the-c
AnonymousCredentialsProvider anoCredProv = AnonymousCredentialsProvider.create();

// https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/cognitoidentity/CognitoIdentityClient.html
// Build the Cognito client
CognitoIdentityClientBuilder cognitoIdentityBuilder = CognitoIdentityClient.builder();
// https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/cognitoidentity/CognitoIdentityClient.html
// Build the Cognito client
CognitoIdentityClientBuilder cognitoIdentityBuilder = CognitoIdentityClient.builder();

cognitoIdentityBuilder.region(getAWSREGION()).credentialsProvider(anoCredProv);
cognitoIdentityClient = cognitoIdentityBuilder.build();
cognitoIdentityBuilder.region(getAWSREGION()).credentialsProvider(anoCredProv);
cognitoIdentityClient = cognitoIdentityBuilder.build();


// https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html
// Basic (Classic) Authflow
// Uses AssumeRoleWithWebIdentity and facilitates CloudTrail org.broad.igv.logging. Uses one more request but provides user traceability.
GetIdRequest.Builder idrequest = GetIdRequest.builder().identityPoolId(federatedPoolId)
.logins(logins);
GetIdResponse idResult = cognitoIdentityClient.getId(idrequest.build());
// https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html
// Basic (Classic) Authflow
// Uses AssumeRoleWithWebIdentity and facilitates CloudTrail org.broad.igv.logging. Uses one more request but provides user traceability.
GetIdRequest.Builder idrequest = GetIdRequest.builder().identityPoolId(federatedPoolId)
.logins(logins);
GetIdResponse idResult = cognitoIdentityClient.getId(idrequest.build());

GetOpenIdTokenRequest.Builder openidrequest = GetOpenIdTokenRequest.builder().logins(logins).identityId(idResult.identityId());
GetOpenIdTokenResponse openId = cognitoIdentityClient.getOpenIdToken(openidrequest.build());
GetOpenIdTokenRequest.Builder openidrequest = GetOpenIdTokenRequest.builder().logins(logins).identityId(idResult.identityId());
GetOpenIdTokenResponse openId = cognitoIdentityClient.getOpenIdToken(openidrequest.build());


AssumeRoleWithWebIdentityRequest.Builder webidrequest = AssumeRoleWithWebIdentityRequest.builder().webIdentityToken(openId.token())
.roleSessionName(email)
.roleArn(cognitoRoleARN);
AssumeRoleWithWebIdentityRequest.Builder webidrequest = AssumeRoleWithWebIdentityRequest.builder().webIdentityToken(openId.token())
.roleSessionName(email)
.roleArn(cognitoRoleARN);

AssumeRoleWithWebIdentityResponse stsClientResponse = StsClient.builder().credentialsProvider(anoCredProv)
.region(getAWSREGION())
.build()
.assumeRoleWithWebIdentity(webidrequest.build());
AssumeRoleWithWebIdentityResponse stsClientResponse = StsClient.builder().credentialsProvider(anoCredProv)
.region(getAWSREGION())
.build()
.assumeRoleWithWebIdentity(webidrequest.build());

// // Enhanced (Simplified) Authflow
// // Major drawback: Does not store federated user information on CloudTrail only authenticated role name appears in logs.
Expand All @@ -211,7 +216,17 @@ public static Credentials GetCognitoAWSCredentials() {
//
// return authedRes.credentials()

return stsClientResponse.credentials();
cognitoAWSCredentials = stsClientResponse.credentials();
}
return cognitoAWSCredentials;
}

/**
* @param cognitoAWSCredentials
* @return true if credentials are due to expire within next 10 seconds*
*/
private static boolean isExpired(Credentials cognitoAWSCredentials) {
return cognitoAWSCredentials.expiration().minusSeconds(10).isBefore(Instant.now());
}


Expand Down Expand Up @@ -269,7 +284,7 @@ public static HeadObjectResponse getObjectMetadata(String bucket, String key) {
.bucket(bucket)
.key(key).build();
HeadObjectResponse HeadObjRes = s3Client.headObject(HeadObjReq);
log.debug("getObjectMetadata(): "+HeadObjRes.toString());
log.debug("getObjectMetadata(): " + HeadObjRes.toString());
return HeadObjRes;
}

Expand Down Expand Up @@ -404,8 +419,6 @@ private static List<String> getReadableBuckets(List<String> buckets) {

public static ArrayList<IGVS3Object> ListBucketObjects(String bucketName, String prefix) {
ArrayList<IGVS3Object> objects = new ArrayList<>();
log.debug("Listing objects for bucketName: " + bucketName);

if (GetCognitoConfig() != null) {
OAuthUtils.getInstance().getAWSProvider().getAccessToken();
updateS3Client(GetCognitoAWSCredentials());
Expand Down Expand Up @@ -530,7 +543,7 @@ public static boolean isPresignedURL(String urlString) {

public static String updatePresignedURL(String urlString) throws IOException {
String s3UrlString = presignedToS3Map.get(urlString);
if(s3UrlString == null) {
if (s3UrlString == null) {
throw new RuntimeException("Unrecognized presigned url: " + urlString);
} else {
return translateAmazonCloudURL(s3UrlString);
Expand Down
Loading