danielcweeks commented on code in PR #13212: URL: https://github.com/apache/iceberg/pull/13212#discussion_r2150889991
########## gcp/src/main/java/org/apache/iceberg/gcp/auth/GoogleAuthManager.java: ########## @@ -0,0 +1,149 @@ +/* + * 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.gcp.auth; + +import com.google.auth.oauth2.GoogleCredentials; +import java.io.FileInputStream; +import java.io.IOException; +import java.io.UncheckedIOException; +import java.util.List; +import java.util.Map; +import org.apache.iceberg.catalog.SessionCatalog; +import org.apache.iceberg.catalog.TableIdentifier; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.relocated.com.google.common.base.Splitter; +import org.apache.iceberg.relocated.com.google.common.base.Strings; +import org.apache.iceberg.relocated.com.google.common.collect.ImmutableList; +import org.apache.iceberg.rest.RESTClient; +import org.apache.iceberg.rest.auth.AuthManager; +import org.apache.iceberg.rest.auth.AuthSession; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * An authentication manager that uses Google Credentials (typically Application Default + * Credentials) to create {@link GoogleAuthSession} instances. + * + * <p>This manager can be configured with properties such as: + * + * <ul> + * <li>{@code gcp.auth.credentials-path}: Path to a service account JSON key file. If not set, + * Application Default Credentials will be used. + * <li>{@code gcp.auth.scopes}: Comma-separated list of OAuth scopes to request. Defaults to + * "https://www.googleapis.com/auth/cloud-platform";. + * </ul> + */ +public class GoogleAuthManager implements AuthManager { + private static final Logger LOG = LoggerFactory.getLogger(GoogleAuthManager.class); + private static final Splitter SPLITTER = Splitter.on(',').trimResults().omitEmptyStrings(); + public static final String DEFAULT_SCOPES = "https://www.googleapis.com/auth/cloud-platform";; + public static final String GCP_CREDENTIALS_PATH_PROPERTY = "gcp.auth.credentials-path"; + public static final String GCP_SCOPES_PROPERTY = "gcp.auth.scopes"; + private final String name; + + private GoogleCredentials credentials; + private boolean initialized = false; + + public GoogleAuthManager(String managerName) { + this.name = managerName; + } + + public String name() { + return name; + } + + private void initialize(Map<String, String> properties) { + if (initialized) { + return; + } + + String credentialsPath = properties.get(GCP_CREDENTIALS_PATH_PROPERTY); + String scopesString = properties.getOrDefault(GCP_SCOPES_PROPERTY, DEFAULT_SCOPES); + List<String> scopes = + Strings.isNullOrEmpty(scopesString) + ? ImmutableList.of() + : ImmutableList.copyOf(SPLITTER.splitToList(scopesString)); + + try { + if (credentialsPath != null && !credentialsPath.isEmpty()) { + LOG.info("Using Google credentials from path: {}", credentialsPath); + try (FileInputStream credentialsStream = new FileInputStream(credentialsPath)) { + this.credentials = GoogleCredentials.fromStream(credentialsStream).createScoped(scopes); + } + } else { + LOG.info("Using Application Default Credentials with scopes: {}", scopesString); + this.credentials = GoogleCredentials.getApplicationDefault().createScoped(scopes); + } + } catch (IOException e) { + throw new UncheckedIOException("Failed to load Google credentials", e); + } + + this.initialized = true; + } + + /** + * Initializes and returns a short-lived session, typically for fetching configuration. This + * implementation reuses the long-lived catalog session logic. + */ + @Override + public AuthSession initSession(RESTClient initClient, Map<String, String> properties) { + return catalogSession(initClient, properties); + } + + /** + * Returns a long-lived session tied to the catalog's lifecycle. This session uses Google + * Application Default Credentials or a specified service account. + * + * @param sharedClient The long-lived RESTClient (not used by this implementation for credential + * fetching). + * @param properties Configuration properties for the auth manager. + * @return A {@link GoogleAuthSession}. + * @throws UncheckedIOException if credential loading fails. + */ + @Override + public AuthSession catalogSession(RESTClient sharedClient, Map<String, String> properties) { + initialize(properties); + Preconditions.checkState( + credentials != null, "GoogleAuthManager not initialized or failed to load credentials"); + return new GoogleAuthSession(credentials); + } + + /** Returns a session for a specific context. Defaults to the catalog session. */ + @Override + public AuthSession contextualSession(SessionCatalog.SessionContext context, AuthSession parent) { + // For GCP, tokens are typically not context-specific in this manner. + // Re-using the parent (which should be a GoogleAuthSession) is appropriate. + return parent; + } + + /** Returns a session for a specific table or view. Defaults to the catalog session. */ + @Override + public AuthSession tableSession( + TableIdentifier table, Map<String, String> properties, AuthSession parent) { + // Similar to contextualSession, GCP tokens are generally not table-specific. + return parent; + } + + /** Closes the manager. This is a no-op for GoogleAuthManager. */ + @Override + public void close() { + // No-op. Credentials lifecycle is managed by the GoogleCredentials object itself or by the + // application. Review Comment: Remove these redundant comments. -- 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: issues-unsubscr...@iceberg.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For additional commands, e-mail: issues-h...@iceberg.apache.org
