giovannifumarola commented on a change in pull request #1844: URL: https://github.com/apache/iceberg/pull/1844#discussion_r533755181
########## File path: aws/src/main/java/org/apache/iceberg/aws/AssumeRoleCredentialsFactory.java ########## @@ -0,0 +1,69 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.iceberg.aws; + +import java.util.Map; +import java.util.UUID; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.util.PropertyUtil; +import software.amazon.awssdk.awscore.client.builder.AwsClientBuilder; +import software.amazon.awssdk.services.sts.StsClientBuilder; +import software.amazon.awssdk.services.sts.auth.StsAssumeRoleCredentialsProvider; +import software.amazon.awssdk.services.sts.model.AssumeRoleRequest; + +/** + * Factory to use STS assume role credential to access cross-account cross-region AWS resources. + */ +public class AssumeRoleCredentialsFactory implements AwsClientCredentialsFactory { + + private String roleArn; + private String externalId; + private int timeout; + + @Override + public void configure(AwsClientBuilder clientBuilder) { + // STS will use default credential in the environment as the root credential to assume the role + if (!(clientBuilder instanceof StsClientBuilder)) { + clientBuilder.credentialsProvider(StsAssumeRoleCredentialsProvider.builder() + .refreshRequest(AssumeRoleRequest.builder() + .roleArn(roleArn) + .roleSessionName(genSessionName()) + .durationSeconds(timeout) + .externalId(externalId) + .build()) + .stsClient(AwsClientUtil.defaultStsClient()) + .build()); + } + } + + private String genSessionName() { + return String.format("iceberg-aws-%s", UUID.randomUUID()); + } + + @Override + public void initialize(Map<String, String> properties) { + roleArn = properties.get(AwsProperties.CLIENT_ASSUME_ROLE_ARN); + Preconditions.checkNotNull(roleArn, + "Cannot initialize AssumeRoleCredentialsProviderFactory with null role ARN"); + timeout = PropertyUtil.propertyAsInt(properties, AwsProperties.CLIENT_ASSUME_ROLE_TIMEOUT, + AwsProperties.CLIENT_ASSUME_ROLE_TIMEOUT_DEFAULT); + externalId = properties.get(AwsProperties.CLIENT_ASSUME_ROLE_EXTERNAL_ID); Review comment: externalId can be null or empty. do you need any check here? ########## File path: aws/src/main/java/org/apache/iceberg/aws/AwsProperties.java ########## @@ -19,12 +19,15 @@ package org.apache.iceberg.aws; +import java.io.Serializable; import java.util.Map; +import org.apache.iceberg.CatalogUtil; +import org.apache.iceberg.catalog.CatalogConfigurable; import org.apache.iceberg.relocated.com.google.common.base.Preconditions; import org.apache.iceberg.util.PropertyUtil; import software.amazon.awssdk.services.s3.model.ObjectCannedACL; -public class AwsProperties { +public class AwsProperties implements Serializable { Review comment: why do you need serializable? ########## File path: aws/src/main/java/org/apache/iceberg/aws/AssumeRoleCredentialsFactory.java ########## @@ -0,0 +1,69 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.iceberg.aws; + +import java.util.Map; +import java.util.UUID; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.util.PropertyUtil; +import software.amazon.awssdk.awscore.client.builder.AwsClientBuilder; +import software.amazon.awssdk.services.sts.StsClientBuilder; +import software.amazon.awssdk.services.sts.auth.StsAssumeRoleCredentialsProvider; +import software.amazon.awssdk.services.sts.model.AssumeRoleRequest; + +/** + * Factory to use STS assume role credential to access cross-account cross-region AWS resources. + */ +public class AssumeRoleCredentialsFactory implements AwsClientCredentialsFactory { + + private String roleArn; + private String externalId; + private int timeout; + + @Override + public void configure(AwsClientBuilder clientBuilder) { + // STS will use default credential in the environment as the root credential to assume the role + if (!(clientBuilder instanceof StsClientBuilder)) { + clientBuilder.credentialsProvider(StsAssumeRoleCredentialsProvider.builder() + .refreshRequest(AssumeRoleRequest.builder() + .roleArn(roleArn) + .roleSessionName(genSessionName()) + .durationSeconds(timeout) + .externalId(externalId) + .build()) + .stsClient(AwsClientUtil.defaultStsClient()) + .build()); + } + } + + private String genSessionName() { + return String.format("iceberg-aws-%s", UUID.randomUUID()); + } + + @Override + public void initialize(Map<String, String> properties) { + roleArn = properties.get(AwsProperties.CLIENT_ASSUME_ROLE_ARN); Review comment: why do you use propertyutil.property()? ########## File path: core/src/main/java/org/apache/iceberg/util/PropertyUtil.java ########## @@ -53,6 +58,11 @@ public static int propertyAsInt(Map<String, String> properties, return defaultValue; } + public static Long propertyAsLong(Map<String, String> properties, String property) { + String value = properties.get(property); Review comment: same here. ########## File path: core/src/main/java/org/apache/iceberg/util/PropertyUtil.java ########## @@ -44,6 +44,11 @@ public static double propertyAsDouble(Map<String, String> properties, return defaultValue; } + public static Integer propertyAsInt(Map<String, String> properties, String property) { + String value = properties.get(property); Review comment: this can go to npe if properties is null. ########## File path: aws/src/main/java/org/apache/iceberg/aws/AssumeRoleCredentialsFactory.java ########## @@ -0,0 +1,69 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.iceberg.aws; + +import java.util.Map; +import java.util.UUID; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.util.PropertyUtil; +import software.amazon.awssdk.awscore.client.builder.AwsClientBuilder; +import software.amazon.awssdk.services.sts.StsClientBuilder; +import software.amazon.awssdk.services.sts.auth.StsAssumeRoleCredentialsProvider; +import software.amazon.awssdk.services.sts.model.AssumeRoleRequest; + +/** + * Factory to use STS assume role credential to access cross-account cross-region AWS resources. + */ +public class AssumeRoleCredentialsFactory implements AwsClientCredentialsFactory { + + private String roleArn; + private String externalId; + private int timeout; + + @Override + public void configure(AwsClientBuilder clientBuilder) { + // STS will use default credential in the environment as the root credential to assume the role + if (!(clientBuilder instanceof StsClientBuilder)) { Review comment: you need to check if the caller has called init before calling configure. ########## File path: aws/src/main/java/org/apache/iceberg/aws/AssumeRoleSingleRegionFactory.java ########## @@ -0,0 +1,50 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.iceberg.aws; + +import java.util.Map; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import software.amazon.awssdk.awscore.client.builder.AwsClientBuilder; +import software.amazon.awssdk.regions.Region; +import software.amazon.awssdk.services.sts.StsClientBuilder; + +/** + * Factory that uses the same configured region for all AWS client initialization, + * and uses region in the default AWS region provider chain for refreshing assume role credentials. + */ +public class AssumeRoleSingleRegionFactory implements AwsClientRegionFactory { + + private Region region; + + @Override + public void configure(AwsClientBuilder clientBuilder) { + // do not configure STS so it can pick up default credentials + if (!(clientBuilder instanceof StsClientBuilder)) { + clientBuilder.region(region); + } + } + + @Override + public void initialize(Map<String, String> properties) { + String regionStr = properties.get(AwsProperties.CLIENT_ASSUME_ROLE_REGION); + Preconditions.checkNotNull(regionStr, "Cannot initialize AssumeRoleSingleRegionFactory with null region"); + region = Region.of(regionStr); Review comment: RegionStr can be an incorrect value. We need to check if region is correct. ########## File path: aws/src/main/java/org/apache/iceberg/aws/AssumeRoleCredentialsFactory.java ########## @@ -0,0 +1,69 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.iceberg.aws; + +import java.util.Map; +import java.util.UUID; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.util.PropertyUtil; +import software.amazon.awssdk.awscore.client.builder.AwsClientBuilder; +import software.amazon.awssdk.services.sts.StsClientBuilder; +import software.amazon.awssdk.services.sts.auth.StsAssumeRoleCredentialsProvider; +import software.amazon.awssdk.services.sts.model.AssumeRoleRequest; + +/** + * Factory to use STS assume role credential to access cross-account cross-region AWS resources. + */ +public class AssumeRoleCredentialsFactory implements AwsClientCredentialsFactory { + + private String roleArn; + private String externalId; + private int timeout; + + @Override + public void configure(AwsClientBuilder clientBuilder) { + // STS will use default credential in the environment as the root credential to assume the role + if (!(clientBuilder instanceof StsClientBuilder)) { + clientBuilder.credentialsProvider(StsAssumeRoleCredentialsProvider.builder() + .refreshRequest(AssumeRoleRequest.builder() + .roleArn(roleArn) + .roleSessionName(genSessionName()) + .durationSeconds(timeout) + .externalId(externalId) + .build()) + .stsClient(AwsClientUtil.defaultStsClient()) + .build()); + } + } + + private String genSessionName() { + return String.format("iceberg-aws-%s", UUID.randomUUID()); + } + + @Override + public void initialize(Map<String, String> properties) { + roleArn = properties.get(AwsProperties.CLIENT_ASSUME_ROLE_ARN); Review comment: properties can be null at this point. ########## File path: aws/src/main/java/org/apache/iceberg/aws/AssumeRoleSingleRegionFactory.java ########## @@ -0,0 +1,50 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.iceberg.aws; + +import java.util.Map; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import software.amazon.awssdk.awscore.client.builder.AwsClientBuilder; +import software.amazon.awssdk.regions.Region; +import software.amazon.awssdk.services.sts.StsClientBuilder; + +/** + * Factory that uses the same configured region for all AWS client initialization, + * and uses region in the default AWS region provider chain for refreshing assume role credentials. + */ +public class AssumeRoleSingleRegionFactory implements AwsClientRegionFactory { + + private Region region; + + @Override + public void configure(AwsClientBuilder clientBuilder) { Review comment: same comments from the previous class. ########## File path: api/src/main/java/org/apache/iceberg/catalog/CatalogConfigurable.java ########## @@ -0,0 +1,38 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.iceberg.catalog; + +import java.util.Map; + +/** + * Interface for classes to implement when the class might be initialized during Review comment: This is not clear. Can you rephrase? ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
