dimas-b commented on code in PR #2523: URL: https://github.com/apache/polaris/pull/2523#discussion_r2373051752
########## polaris-core/src/main/java/org/apache/polaris/core/identity/resolved/ResolvedAwsIamServiceIdentity.java: ########## @@ -0,0 +1,106 @@ +/* + * 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.polaris.core.identity.resolved; + +import com.google.common.base.Supplier; +import com.google.common.base.Suppliers; +import jakarta.annotation.Nonnull; +import jakarta.annotation.Nullable; +import org.apache.polaris.core.admin.model.AwsIamServiceIdentityInfo; +import org.apache.polaris.core.admin.model.ServiceIdentityInfo; +import org.apache.polaris.core.identity.ServiceIdentityType; +import org.apache.polaris.core.identity.dpo.AwsIamServiceIdentityInfoDpo; +import org.apache.polaris.core.identity.dpo.ServiceIdentityInfoDpo; +import org.apache.polaris.core.secrets.ServiceSecretReference; +import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider; +import software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider; +import software.amazon.awssdk.services.sts.StsClient; +import software.amazon.awssdk.services.sts.StsClientBuilder; + +/** + * Represents a fully resolved AWS IAM service identity, including the associated IAM ARN and + * credentials. Polaris uses this class internally to access AWS services on behalf of a configured + * service identity. + * + * <p>It contains AWS credentials (access key, secret, and optional session token) and provides a + * lazily initialized {@link StsClient} for performing role assumptions or identity verification. + * + * <p>The resolved identity can be converted back into its persisted DPO form using {@link + * #asServiceIdentityInfoDpo()}. + * + * <p>The resolved identity can also be converted into its API model representation using {@link + * #asServiceIdentityInfoModel()} + */ +public class ResolvedAwsIamServiceIdentity extends ResolvedServiceIdentity { + + /** IAM role or user ARN representing the Polaris service identity. */ + private final String iamArn; + + /** AWS credentials provider for accessing AWS services. */ + private final AwsCredentialsProvider awsCredentialsProvider; + + public ResolvedAwsIamServiceIdentity(@Nullable String iamArn) { + this(null, iamArn, DefaultCredentialsProvider.builder().build()); + } + + public ResolvedAwsIamServiceIdentity( + @Nullable String iamArn, @Nonnull AwsCredentialsProvider awsCredentialsProvider) { + this(null, iamArn, awsCredentialsProvider); + } + + public ResolvedAwsIamServiceIdentity( + @Nullable ServiceSecretReference serviceSecretReference, + @Nullable String iamArn, + @Nonnull AwsCredentialsProvider awsCredentialsProvider) { + super(ServiceIdentityType.AWS_IAM, serviceSecretReference); + this.iamArn = iamArn; + this.awsCredentialsProvider = awsCredentialsProvider; + } + + public @Nullable String getIamArn() { + return iamArn; + } + + public @Nonnull AwsCredentialsProvider getAwsCredentialsProvider() { + return awsCredentialsProvider; + } + + @Override + public @Nonnull ServiceIdentityInfoDpo asServiceIdentityInfoDpo() { + return new AwsIamServiceIdentityInfoDpo(getIdentityInfoReference()); + } + + @Override + public @Nonnull ServiceIdentityInfo asServiceIdentityInfoModel() { + return AwsIamServiceIdentityInfo.builder() + .setIdentityType(ServiceIdentityInfo.IdentityTypeEnum.AWS_IAM) + .setIamArn(getIamArn()) + .build(); + } + + /** Returns a memoized supplier for creating an STS client using the resolved credentials. */ + public @Nonnull Supplier<StsClient> stsClientSupplier() { Review Comment: I'm not sure how this fits with `AwsCredentialsStorageIntegration` :thinking: The latter uses `AwsCredentialsProvider` on the main call paths (plus a pool of generic STS clients). Do we really need this special memoized `StsClient` (note: this method is current not called at all)? ########## runtime/service/src/main/java/org/apache/polaris/service/identity/registry/DefaultServiceIdentityRegistry.java: ########## @@ -0,0 +1,144 @@ +/* + * 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.polaris.service.identity.registry; + +import com.google.common.annotations.VisibleForTesting; +import jakarta.inject.Inject; +import java.util.EnumMap; +import java.util.Map; +import java.util.Optional; +import java.util.stream.Collectors; +import org.apache.polaris.core.context.RealmContext; +import org.apache.polaris.core.identity.ServiceIdentityType; +import org.apache.polaris.core.identity.dpo.ServiceIdentityInfoDpo; +import org.apache.polaris.core.identity.registry.ServiceIdentityRegistry; +import org.apache.polaris.core.identity.resolved.ResolvedServiceIdentity; +import org.apache.polaris.core.secrets.ServiceSecretReference; +import org.apache.polaris.service.identity.ServiceIdentityConfiguration; + +/** + * Default implementation of {@link ServiceIdentityRegistry} that resolves service identities from + * statically configured values (typically defined via Quarkus server configuration). + * + * <p>This implementation supports both multi-tenant (e.g., SaaS) and self-managed (single-tenant) + * Polaris deployments: + * + * <ul> + * <li>In multi-tenant mode, each tenant (realm) can have its own set of service identities + * defined in the configuration. The same identity will consistently be assigned for each + * {@link ServiceIdentityType} within a given tenant. + * <li>In single-tenant or self-managed deployments, a single set of service identities can be + * defined and used system-wide. + * </ul> + */ +public class DefaultServiceIdentityRegistry implements ServiceIdentityRegistry { + public static final String DEFAULT_REALM_KEY = ServiceIdentityConfiguration.DEFAULT_REALM_KEY; + public static final String DEFAULT_REALM_NSS = "system:default"; + private static final String IDENTITY_INFO_REFERENCE_URN_FORMAT = + "urn:polaris-secret:default-identity-registry:%s:%s"; + + /** Map of service identity types to their resolved identities. */ + private final EnumMap<ServiceIdentityType, ResolvedServiceIdentity> resolvedServiceIdentities; + + /** Map of identity info references (URNs) to their resolved service identities. */ + private final Map<String, ResolvedServiceIdentity> referenceToResolvedServiceIdentity; + + public DefaultServiceIdentityRegistry() { + this(new EnumMap<>(ServiceIdentityType.class)); + } + + public DefaultServiceIdentityRegistry( + EnumMap<ServiceIdentityType, ResolvedServiceIdentity> serviceIdentities) { + this.resolvedServiceIdentities = serviceIdentities; + this.referenceToResolvedServiceIdentity = + serviceIdentities.values().stream() + .collect( + Collectors.toMap( + identity -> identity.getIdentityInfoReference().getUrn(), + identity -> identity)); + } + + @Inject + public DefaultServiceIdentityRegistry( + RealmContext realmContext, ServiceIdentityConfiguration serviceIdentityConfiguration) { + this.resolvedServiceIdentities = + serviceIdentityConfiguration.resolveServiceIdentities(realmContext).stream() + .collect( + // Collect to an EnumMap, grouping by ServiceIdentityType + Collectors.toMap( + ResolvedServiceIdentity::getIdentityType, + identity -> identity, + (a, b) -> b, + () -> new EnumMap<>(ServiceIdentityType.class))); + + this.referenceToResolvedServiceIdentity = + resolvedServiceIdentities.values().stream() + .collect( + Collectors.toMap( + identity -> identity.getIdentityInfoReference().getUrn(), + identity -> identity)); + } + + @Override + public Optional<ServiceIdentityInfoDpo> discoverServiceIdentity( + ServiceIdentityType serviceIdentityType) { + ResolvedServiceIdentity resolvedServiceIdentity = + resolvedServiceIdentities.get(serviceIdentityType); + if (resolvedServiceIdentity == null) { + return Optional.empty(); + } + return Optional.of(resolvedServiceIdentity.asServiceIdentityInfoDpo()); + } + + @Override + public Optional<ResolvedServiceIdentity> resolveServiceIdentity( Review Comment: The returned `ResolvedServiceIdentity` appears to be always immediately converted to `ServiceIdentityInfo` (or to `ServiceIdentityInfoDpo`). Do we really need `ResolvedServiceIdentity` as a java type? ########## runtime/service/src/main/java/org/apache/polaris/service/identity/registry/DefaultServiceIdentityRegistry.java: ########## @@ -0,0 +1,144 @@ +/* + * 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.polaris.service.identity.registry; + +import com.google.common.annotations.VisibleForTesting; +import jakarta.inject.Inject; +import java.util.EnumMap; +import java.util.Map; +import java.util.Optional; +import java.util.stream.Collectors; +import org.apache.polaris.core.context.RealmContext; +import org.apache.polaris.core.identity.ServiceIdentityType; +import org.apache.polaris.core.identity.dpo.ServiceIdentityInfoDpo; +import org.apache.polaris.core.identity.registry.ServiceIdentityRegistry; +import org.apache.polaris.core.identity.resolved.ResolvedServiceIdentity; +import org.apache.polaris.core.secrets.ServiceSecretReference; +import org.apache.polaris.service.identity.ServiceIdentityConfiguration; + +/** + * Default implementation of {@link ServiceIdentityRegistry} that resolves service identities from + * statically configured values (typically defined via Quarkus server configuration). + * + * <p>This implementation supports both multi-tenant (e.g., SaaS) and self-managed (single-tenant) + * Polaris deployments: + * + * <ul> + * <li>In multi-tenant mode, each tenant (realm) can have its own set of service identities + * defined in the configuration. The same identity will consistently be assigned for each + * {@link ServiceIdentityType} within a given tenant. + * <li>In single-tenant or self-managed deployments, a single set of service identities can be + * defined and used system-wide. + * </ul> + */ +public class DefaultServiceIdentityRegistry implements ServiceIdentityRegistry { + public static final String DEFAULT_REALM_KEY = ServiceIdentityConfiguration.DEFAULT_REALM_KEY; + public static final String DEFAULT_REALM_NSS = "system:default"; + private static final String IDENTITY_INFO_REFERENCE_URN_FORMAT = + "urn:polaris-secret:default-identity-registry:%s:%s"; + + /** Map of service identity types to their resolved identities. */ + private final EnumMap<ServiceIdentityType, ResolvedServiceIdentity> resolvedServiceIdentities; + + /** Map of identity info references (URNs) to their resolved service identities. */ + private final Map<String, ResolvedServiceIdentity> referenceToResolvedServiceIdentity; + + public DefaultServiceIdentityRegistry() { + this(new EnumMap<>(ServiceIdentityType.class)); + } + + public DefaultServiceIdentityRegistry( + EnumMap<ServiceIdentityType, ResolvedServiceIdentity> serviceIdentities) { + this.resolvedServiceIdentities = serviceIdentities; + this.referenceToResolvedServiceIdentity = + serviceIdentities.values().stream() + .collect( + Collectors.toMap( + identity -> identity.getIdentityInfoReference().getUrn(), + identity -> identity)); + } + + @Inject + public DefaultServiceIdentityRegistry( + RealmContext realmContext, ServiceIdentityConfiguration serviceIdentityConfiguration) { + this.resolvedServiceIdentities = + serviceIdentityConfiguration.resolveServiceIdentities(realmContext).stream() + .collect( + // Collect to an EnumMap, grouping by ServiceIdentityType + Collectors.toMap( + ResolvedServiceIdentity::getIdentityType, + identity -> identity, + (a, b) -> b, + () -> new EnumMap<>(ServiceIdentityType.class))); + + this.referenceToResolvedServiceIdentity = + resolvedServiceIdentities.values().stream() + .collect( + Collectors.toMap( + identity -> identity.getIdentityInfoReference().getUrn(), + identity -> identity)); + } + + @Override + public Optional<ServiceIdentityInfoDpo> discoverServiceIdentity( + ServiceIdentityType serviceIdentityType) { + ResolvedServiceIdentity resolvedServiceIdentity = + resolvedServiceIdentities.get(serviceIdentityType); + if (resolvedServiceIdentity == null) { + return Optional.empty(); + } + return Optional.of(resolvedServiceIdentity.asServiceIdentityInfoDpo()); + } + + @Override + public Optional<ResolvedServiceIdentity> resolveServiceIdentity( Review Comment: With the above comment in mind (about caching resolved objects), WDYT about connecting `DefaultServiceIdentityRegistry` to the config sources directly, and returning `ServiceIdentityInfo` or `ServiceIdentityInfoDpo`? ########## runtime/service/src/main/java/org/apache/polaris/service/identity/registry/DefaultServiceIdentityRegistry.java: ########## @@ -0,0 +1,144 @@ +/* + * 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.polaris.service.identity.registry; + +import com.google.common.annotations.VisibleForTesting; +import jakarta.inject.Inject; +import java.util.EnumMap; +import java.util.Map; +import java.util.Optional; +import java.util.stream.Collectors; +import org.apache.polaris.core.context.RealmContext; +import org.apache.polaris.core.identity.ServiceIdentityType; +import org.apache.polaris.core.identity.dpo.ServiceIdentityInfoDpo; +import org.apache.polaris.core.identity.registry.ServiceIdentityRegistry; +import org.apache.polaris.core.identity.resolved.ResolvedServiceIdentity; +import org.apache.polaris.core.secrets.ServiceSecretReference; +import org.apache.polaris.service.identity.ServiceIdentityConfiguration; + +/** + * Default implementation of {@link ServiceIdentityRegistry} that resolves service identities from + * statically configured values (typically defined via Quarkus server configuration). + * + * <p>This implementation supports both multi-tenant (e.g., SaaS) and self-managed (single-tenant) + * Polaris deployments: + * + * <ul> + * <li>In multi-tenant mode, each tenant (realm) can have its own set of service identities + * defined in the configuration. The same identity will consistently be assigned for each + * {@link ServiceIdentityType} within a given tenant. + * <li>In single-tenant or self-managed deployments, a single set of service identities can be + * defined and used system-wide. + * </ul> + */ +public class DefaultServiceIdentityRegistry implements ServiceIdentityRegistry { + public static final String DEFAULT_REALM_KEY = ServiceIdentityConfiguration.DEFAULT_REALM_KEY; + public static final String DEFAULT_REALM_NSS = "system:default"; + private static final String IDENTITY_INFO_REFERENCE_URN_FORMAT = + "urn:polaris-secret:default-identity-registry:%s:%s"; + + /** Map of service identity types to their resolved identities. */ + private final EnumMap<ServiceIdentityType, ResolvedServiceIdentity> resolvedServiceIdentities; + + /** Map of identity info references (URNs) to their resolved service identities. */ + private final Map<String, ResolvedServiceIdentity> referenceToResolvedServiceIdentity; + + public DefaultServiceIdentityRegistry() { + this(new EnumMap<>(ServiceIdentityType.class)); + } + + public DefaultServiceIdentityRegistry( + EnumMap<ServiceIdentityType, ResolvedServiceIdentity> serviceIdentities) { + this.resolvedServiceIdentities = serviceIdentities; + this.referenceToResolvedServiceIdentity = + serviceIdentities.values().stream() + .collect( + Collectors.toMap( + identity -> identity.getIdentityInfoReference().getUrn(), + identity -> identity)); + } + + @Inject + public DefaultServiceIdentityRegistry( + RealmContext realmContext, ServiceIdentityConfiguration serviceIdentityConfiguration) { + this.resolvedServiceIdentities = + serviceIdentityConfiguration.resolveServiceIdentities(realmContext).stream() + .collect( + // Collect to an EnumMap, grouping by ServiceIdentityType + Collectors.toMap( + ResolvedServiceIdentity::getIdentityType, + identity -> identity, + (a, b) -> b, + () -> new EnumMap<>(ServiceIdentityType.class))); + + this.referenceToResolvedServiceIdentity = + resolvedServiceIdentities.values().stream() + .collect( + Collectors.toMap( + identity -> identity.getIdentityInfoReference().getUrn(), + identity -> identity)); + } + + @Override + public Optional<ServiceIdentityInfoDpo> discoverServiceIdentity( + ServiceIdentityType serviceIdentityType) { + ResolvedServiceIdentity resolvedServiceIdentity = + resolvedServiceIdentities.get(serviceIdentityType); + if (resolvedServiceIdentity == null) { + return Optional.empty(); + } + return Optional.of(resolvedServiceIdentity.asServiceIdentityInfoDpo()); + } + + @Override + public Optional<ResolvedServiceIdentity> resolveServiceIdentity( + ServiceIdentityInfoDpo serviceIdentityInfo) { + ResolvedServiceIdentity resolvedServiceIdentity = + referenceToResolvedServiceIdentity.get( + serviceIdentityInfo.getIdentityInfoReference().getUrn()); Review Comment: Would it make sense for the `resolveServiceIdentity()` to have plain URN as a parameter? ########## runtime/service/src/main/java/org/apache/polaris/service/identity/registry/DefaultServiceIdentityRegistry.java: ########## @@ -0,0 +1,144 @@ +/* + * 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.polaris.service.identity.registry; + +import com.google.common.annotations.VisibleForTesting; +import jakarta.inject.Inject; +import java.util.EnumMap; +import java.util.Map; +import java.util.Optional; +import java.util.stream.Collectors; +import org.apache.polaris.core.context.RealmContext; +import org.apache.polaris.core.identity.ServiceIdentityType; +import org.apache.polaris.core.identity.dpo.ServiceIdentityInfoDpo; +import org.apache.polaris.core.identity.registry.ServiceIdentityRegistry; +import org.apache.polaris.core.identity.resolved.ResolvedServiceIdentity; +import org.apache.polaris.core.secrets.ServiceSecretReference; +import org.apache.polaris.service.identity.ServiceIdentityConfiguration; + +/** + * Default implementation of {@link ServiceIdentityRegistry} that resolves service identities from + * statically configured values (typically defined via Quarkus server configuration). + * + * <p>This implementation supports both multi-tenant (e.g., SaaS) and self-managed (single-tenant) + * Polaris deployments: + * + * <ul> + * <li>In multi-tenant mode, each tenant (realm) can have its own set of service identities + * defined in the configuration. The same identity will consistently be assigned for each + * {@link ServiceIdentityType} within a given tenant. + * <li>In single-tenant or self-managed deployments, a single set of service identities can be + * defined and used system-wide. + * </ul> + */ +public class DefaultServiceIdentityRegistry implements ServiceIdentityRegistry { + public static final String DEFAULT_REALM_KEY = ServiceIdentityConfiguration.DEFAULT_REALM_KEY; + public static final String DEFAULT_REALM_NSS = "system:default"; + private static final String IDENTITY_INFO_REFERENCE_URN_FORMAT = + "urn:polaris-secret:default-identity-registry:%s:%s"; + + /** Map of service identity types to their resolved identities. */ + private final EnumMap<ServiceIdentityType, ResolvedServiceIdentity> resolvedServiceIdentities; + + /** Map of identity info references (URNs) to their resolved service identities. */ + private final Map<String, ResolvedServiceIdentity> referenceToResolvedServiceIdentity; + + public DefaultServiceIdentityRegistry() { + this(new EnumMap<>(ServiceIdentityType.class)); + } + + public DefaultServiceIdentityRegistry( + EnumMap<ServiceIdentityType, ResolvedServiceIdentity> serviceIdentities) { + this.resolvedServiceIdentities = serviceIdentities; + this.referenceToResolvedServiceIdentity = + serviceIdentities.values().stream() + .collect( + Collectors.toMap( + identity -> identity.getIdentityInfoReference().getUrn(), + identity -> identity)); + } + + @Inject + public DefaultServiceIdentityRegistry( + RealmContext realmContext, ServiceIdentityConfiguration serviceIdentityConfiguration) { + this.resolvedServiceIdentities = + serviceIdentityConfiguration.resolveServiceIdentities(realmContext).stream() Review Comment: My understanding is that `DefaultServiceIdentityRegistry` is a request-scoped bean. Do we have to "re-resolve" the same data from the same (global) config on every request? `resolvedServiceIdentities` is used with a specific `serviceIdentityType`, which is likely to be required at most once per request. Why not do the whole resolution on demand? It does not look like caching data in `resolvedServiceIdentities` and/or `referenceToResolvedServiceIdentity` is helpful in runtime as it is not likely to be reused. -- 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. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
