sungwy commented on code in PR #2680: URL: https://github.com/apache/polaris/pull/2680#discussion_r2415299897
########## polaris-core/src/main/java/org/apache/polaris/core/auth/TokenProvider.java: ########## @@ -0,0 +1,51 @@ +/* + * 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.auth; + +import jakarta.annotation.Nullable; + +/** + * Interface for providing bearer tokens for authentication. + * + * <p>Implementations can provide tokens from various sources such as: + * + * <ul> + * <li>Static string values + * <li>Files (with automatic reloading) + * <li>External token services + * </ul> + */ +public interface TokenProvider { Review Comment: Sure! ########## polaris-core/src/main/java/org/apache/polaris/core/auth/FileTokenProvider.java: ########## @@ -0,0 +1,229 @@ +/* + * 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.auth; + +import jakarta.annotation.Nullable; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.time.Duration; +import java.time.Instant; +import java.util.Optional; +import java.util.concurrent.locks.ReadWriteLock; +import java.util.concurrent.locks.ReentrantReadWriteLock; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * A token provider that reads tokens from a file and automatically reloads them based on a + * configurable refresh interval or JWT expiration timing. + * + * <p>This is particularly useful in Kubernetes environments where tokens are mounted as files and + * refreshed by external systems (e.g., service account tokens, projected volumes, etc.). + * + * <p>The token file is expected to contain the bearer token as plain text. Leading and trailing + * whitespace will be trimmed. + * + * <p>If JWT expiration refresh is enabled and the token is a valid JWT with an 'exp' claim, the + * provider will automatically refresh the token based on the expiration time minus a configurable + * buffer, rather than using the fixed refresh interval. + */ +public class FileTokenProvider implements TokenProvider { + + private static final Logger logger = LoggerFactory.getLogger(FileTokenProvider.class); + + private final Path tokenFilePath; + private final Duration refreshInterval; + private final boolean jwtExpirationRefresh; + private final Duration jwtExpirationBuffer; + private final ReadWriteLock lock = new ReentrantReadWriteLock(); + + private volatile String cachedToken; + private volatile Instant lastRefresh; + private volatile Instant nextRefresh; + private volatile boolean closed = false; + + /** + * Create a new file-based token provider with basic refresh interval. + * + * @param tokenFilePath path to the file containing the bearer token + * @param refreshInterval how often to check for token file changes + */ + public FileTokenProvider(String tokenFilePath, Duration refreshInterval) { + this(tokenFilePath, refreshInterval, true, Duration.ofSeconds(60)); + } + + /** + * Create a new file-based token provider with JWT expiration support. + * + * @param tokenFilePath path to the file containing the bearer token + * @param refreshInterval how often to check for token file changes (fallback for non-JWT tokens) + * @param jwtExpirationRefresh whether to use JWT expiration for refresh timing + * @param jwtExpirationBuffer buffer time before JWT expiration to refresh the token + */ + public FileTokenProvider( + String tokenFilePath, + Duration refreshInterval, + boolean jwtExpirationRefresh, + Duration jwtExpirationBuffer) { + this.tokenFilePath = Paths.get(tokenFilePath); + this.refreshInterval = refreshInterval; + this.jwtExpirationRefresh = jwtExpirationRefresh; + this.jwtExpirationBuffer = jwtExpirationBuffer; + this.lastRefresh = Instant.MIN; // Force initial load + this.nextRefresh = Instant.MIN; // Force initial calculation + + logger.info( + "Created file token provider for path: {} with refresh interval: {}, JWT expiration refresh: {}, JWT buffer: {}", + tokenFilePath, + refreshInterval, + jwtExpirationRefresh, + jwtExpirationBuffer); + } + + @Override + @Nullable + public String getToken() { + if (closed) { + logger.warn("Token provider is closed, returning null"); + return null; + } + + // Check if we need to refresh + if (shouldRefresh()) { + refreshToken(); + } + + lock.readLock().lock(); + try { + return cachedToken; + } finally { + lock.readLock().unlock(); + } + } + + @Override + public void close() { + closed = true; + lock.writeLock().lock(); + try { + cachedToken = null; + logger.info("File token provider closed"); + } finally { + lock.writeLock().unlock(); + } + } + + private boolean shouldRefresh() { + return Instant.now().isAfter(nextRefresh); + } + + private void refreshToken() { + lock.writeLock().lock(); + try { + // Double-check pattern - another thread might have refreshed while we waited for the lock + if (!shouldRefresh()) { + return; + } + + String newToken = loadTokenFromFile(); + cachedToken = newToken; + lastRefresh = Instant.now(); + + // Calculate next refresh time based on JWT expiration or fixed interval + nextRefresh = calculateNextRefresh(newToken); + + if (logger.isDebugEnabled()) { Review Comment: Good catch! I'll remove this leftover from debugging. Thank you for catching it @flyrain ########## runtime/service/src/main/java/org/apache/polaris/service/config/AuthorizationConfiguration.java: ########## @@ -0,0 +1,75 @@ +/* + * 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.config; + +import io.smallrye.config.ConfigMapping; +import io.smallrye.config.WithDefault; +import java.util.Optional; + +@ConfigMapping(prefix = "polaris.authorization") +public interface AuthorizationConfiguration { + @WithDefault("default") + String type(); + + OpaConfig opa(); + + interface OpaConfig { + Optional<String> url(); + + Optional<String> policyPath(); + + Optional<Integer> timeoutMs(); + + BearerTokenConfig bearerToken(); + + @WithDefault("true") + boolean verifySsl(); + + Optional<String> trustStorePath(); + + Optional<String> trustStorePassword(); + } + + interface BearerTokenConfig { Review Comment: Thanks for the suggestion Yufei. I've added the validation in the factory ########## polaris-core/src/main/java/org/apache/polaris/core/auth/OpaPolarisAuthorizer.java: ########## @@ -0,0 +1,407 @@ +/* + * 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.auth; + +// Removed Quarkus/MicroProfile annotations for portability +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.node.ArrayNode; +import com.fasterxml.jackson.databind.node.ObjectNode; +import jakarta.annotation.Nonnull; +import jakarta.annotation.Nullable; +import java.io.FileInputStream; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.security.KeyStore; +import java.util.List; +import java.util.Locale; +import java.util.Set; +import javax.net.ssl.SSLContext; +import org.apache.http.HttpHeaders; +import org.apache.http.client.config.RequestConfig; +import org.apache.http.client.methods.CloseableHttpResponse; +import org.apache.http.client.methods.HttpPost; +import org.apache.http.conn.ssl.NoopHostnameVerifier; +import org.apache.http.conn.ssl.SSLConnectionSocketFactory; +import org.apache.http.conn.ssl.TrustAllStrategy; +import org.apache.http.entity.StringEntity; +import org.apache.http.impl.client.CloseableHttpClient; +import org.apache.http.impl.client.HttpClients; +import org.apache.http.ssl.SSLContextBuilder; +import org.apache.http.util.EntityUtils; +import org.apache.iceberg.exceptions.ForbiddenException; +import org.apache.polaris.core.entity.PolarisBaseEntity; +import org.apache.polaris.core.persistence.PolarisResolvedPathWrapper; + +/** + * OPA-based implementation of {@link PolarisAuthorizer}. + * + * <p>This authorizer delegates authorization decisions to an Open Policy Agent (OPA) server using a + * configurable REST API endpoint and policy path. The input to OPA is constructed from the + * principal, entities, operation, and resource context. + */ +public class OpaPolarisAuthorizer implements PolarisAuthorizer { + private final String opaServerUrl; + private final String opaPolicyPath; + private final TokenProvider tokenProvider; + private final CloseableHttpClient httpClient; + private final ObjectMapper objectMapper; + + /** Private constructor for factory method and advanced wiring. */ + private OpaPolarisAuthorizer( + String opaServerUrl, + String opaPolicyPath, + TokenProvider tokenProvider, + CloseableHttpClient httpClient, + ObjectMapper objectMapper) { + this.opaServerUrl = opaServerUrl; + this.opaPolicyPath = opaPolicyPath; + this.tokenProvider = tokenProvider; + this.httpClient = httpClient; + this.objectMapper = objectMapper; + } + + /** + * Static factory that accepts a TokenProvider for advanced token management. + * + * @param opaServerUrl OPA server URL + * @param opaPolicyPath OPA policy path + * @param tokenProvider Token provider for authentication (optional) + * @param timeoutMs HTTP call timeout in milliseconds + * @param verifySsl Whether to verify SSL certificates for HTTPS connections + * @param trustStorePath Custom SSL trust store path (optional) + * @param trustStorePassword Custom SSL trust store password (optional) + * @param client Apache HttpClient (optional, can be null) + * @param mapper ObjectMapper (optional, can be null) + * @return OpaPolarisAuthorizer instance + */ + public static OpaPolarisAuthorizer create( + String opaServerUrl, + String opaPolicyPath, + TokenProvider tokenProvider, + int timeoutMs, + boolean verifySsl, + String trustStorePath, + String trustStorePassword, + Object client, // Accept any client type for compatibility Review Comment: Thanks for catching this Yufei - I've correctly injected the client into the OpaPolarisAuthorizer so we have it set up at the application scope and injected into the class instead (since PolarisAuthorizer is RequestScoped). As for the mapper - I was being a bit forward thinking in having a catch all input param for future configs. I can remove this for now. ########## polaris-core/src/main/java/org/apache/polaris/core/auth/OpaPolarisAuthorizer.java: ########## @@ -0,0 +1,407 @@ +/* + * 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.auth; + +// Removed Quarkus/MicroProfile annotations for portability +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.node.ArrayNode; +import com.fasterxml.jackson.databind.node.ObjectNode; +import jakarta.annotation.Nonnull; +import jakarta.annotation.Nullable; +import java.io.FileInputStream; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.security.KeyStore; +import java.util.List; +import java.util.Locale; +import java.util.Set; +import javax.net.ssl.SSLContext; +import org.apache.http.HttpHeaders; +import org.apache.http.client.config.RequestConfig; +import org.apache.http.client.methods.CloseableHttpResponse; +import org.apache.http.client.methods.HttpPost; +import org.apache.http.conn.ssl.NoopHostnameVerifier; +import org.apache.http.conn.ssl.SSLConnectionSocketFactory; +import org.apache.http.conn.ssl.TrustAllStrategy; +import org.apache.http.entity.StringEntity; +import org.apache.http.impl.client.CloseableHttpClient; +import org.apache.http.impl.client.HttpClients; +import org.apache.http.ssl.SSLContextBuilder; +import org.apache.http.util.EntityUtils; +import org.apache.iceberg.exceptions.ForbiddenException; +import org.apache.polaris.core.entity.PolarisBaseEntity; +import org.apache.polaris.core.persistence.PolarisResolvedPathWrapper; + +/** + * OPA-based implementation of {@link PolarisAuthorizer}. + * + * <p>This authorizer delegates authorization decisions to an Open Policy Agent (OPA) server using a + * configurable REST API endpoint and policy path. The input to OPA is constructed from the + * principal, entities, operation, and resource context. + */ +public class OpaPolarisAuthorizer implements PolarisAuthorizer { + private final String opaServerUrl; + private final String opaPolicyPath; + private final TokenProvider tokenProvider; + private final CloseableHttpClient httpClient; + private final ObjectMapper objectMapper; + + /** Private constructor for factory method and advanced wiring. */ + private OpaPolarisAuthorizer( + String opaServerUrl, + String opaPolicyPath, + TokenProvider tokenProvider, + CloseableHttpClient httpClient, + ObjectMapper objectMapper) { + this.opaServerUrl = opaServerUrl; + this.opaPolicyPath = opaPolicyPath; + this.tokenProvider = tokenProvider; + this.httpClient = httpClient; + this.objectMapper = objectMapper; + } + + /** + * Static factory that accepts a TokenProvider for advanced token management. + * + * @param opaServerUrl OPA server URL + * @param opaPolicyPath OPA policy path + * @param tokenProvider Token provider for authentication (optional) + * @param timeoutMs HTTP call timeout in milliseconds + * @param verifySsl Whether to verify SSL certificates for HTTPS connections + * @param trustStorePath Custom SSL trust store path (optional) + * @param trustStorePassword Custom SSL trust store password (optional) + * @param client Apache HttpClient (optional, can be null) + * @param mapper ObjectMapper (optional, can be null) + * @return OpaPolarisAuthorizer instance + */ + public static OpaPolarisAuthorizer create( + String opaServerUrl, + String opaPolicyPath, + TokenProvider tokenProvider, + int timeoutMs, + boolean verifySsl, + String trustStorePath, + String trustStorePassword, + Object client, // Accept any client type for compatibility + ObjectMapper mapper) { + + try { + // Create request configuration with timeouts + RequestConfig requestConfig = + RequestConfig.custom() + .setConnectTimeout(timeoutMs) + .setSocketTimeout(timeoutMs) + .setConnectionRequestTimeout(timeoutMs) + .build(); + + // Configure SSL for HTTPS connections + SSLConnectionSocketFactory sslSocketFactory = + createSslSocketFactory(opaServerUrl, verifySsl, trustStorePath, trustStorePassword); + + // Create HTTP client with SSL configuration + CloseableHttpClient httpClient; + if (client instanceof CloseableHttpClient) { + httpClient = (CloseableHttpClient) client; + } else { + if (sslSocketFactory != null) { + httpClient = + HttpClients.custom() + .setDefaultRequestConfig(requestConfig) + .setSSLSocketFactory(sslSocketFactory) + .build(); + } else { + httpClient = HttpClients.custom().setDefaultRequestConfig(requestConfig).build(); + } + } + + ObjectMapper objectMapperWithDefaults = mapper != null ? mapper : new ObjectMapper(); + return new OpaPolarisAuthorizer( + opaServerUrl, opaPolicyPath, tokenProvider, httpClient, objectMapperWithDefaults); + } catch (Exception e) { + throw new RuntimeException("Failed to create OpaPolarisAuthorizer with SSL configuration", e); + } + } + + /** + * Authorizes a single target and secondary entity for the given principal and operation. + * + * <p>Delegates to the multi-target version for consistency. + * + * @param polarisPrincipal the principal requesting authorization + * @param activatedEntities the set of activated entities (roles, etc.) + * @param authzOp the operation to authorize + * @param target the main target entity + * @param secondary the secondary entity (if any) + * @throws ForbiddenException if authorization is denied by OPA + */ + @Override + public void authorizeOrThrow( + @Nonnull PolarisPrincipal polarisPrincipal, + @Nonnull Set<PolarisBaseEntity> activatedEntities, + @Nonnull PolarisAuthorizableOperation authzOp, + @Nullable PolarisResolvedPathWrapper target, + @Nullable PolarisResolvedPathWrapper secondary) { + authorizeOrThrow( + polarisPrincipal, + activatedEntities, + authzOp, + target == null ? null : List.of(target), + secondary == null ? null : List.of(secondary)); + } + + /** + * Authorizes one or more target and secondary entities for the given principal and operation. + * + * <p>Sends the authorization context to OPA and throws if not allowed. + * + * @param polarisPrincipal the principal requesting authorization + * @param activatedEntities the set of activated entities (roles, etc.) + * @param authzOp the operation to authorize + * @param targets the list of main target entities + * @param secondaries the list of secondary entities (if any) + * @throws ForbiddenException if authorization is denied by OPA + */ + @Override + public void authorizeOrThrow( + @Nonnull PolarisPrincipal polarisPrincipal, + @Nonnull Set<PolarisBaseEntity> activatedEntities, + @Nonnull PolarisAuthorizableOperation authzOp, + @Nullable List<PolarisResolvedPathWrapper> targets, + @Nullable List<PolarisResolvedPathWrapper> secondaries) { + boolean allowed = queryOpa(polarisPrincipal, activatedEntities, authzOp, targets, secondaries); + if (!allowed) { + throw new ForbiddenException("OPA denied authorization"); + } + } + + /** + * Sends an authorization query to the OPA server and parses the response. + * + * <p>Builds the OPA input JSON, sends it via HTTP POST, and checks the 'allow' field in the + * response. + * + * @param principal the principal requesting authorization + * @param entities the set of activated entities + * @param op the operation to authorize + * @param targets the list of main target entities + * @param secondaries the list of secondary entities (if any) + * @return true if OPA allows the operation, false otherwise + * @throws RuntimeException if the OPA query fails + */ + private boolean queryOpa( + PolarisPrincipal principal, + Set<PolarisBaseEntity> entities, + PolarisAuthorizableOperation op, + List<PolarisResolvedPathWrapper> targets, + List<PolarisResolvedPathWrapper> secondaries) { + try { + String inputJson = buildOpaInputJson(principal, entities, op, targets, secondaries); + + // Create HTTP POST request using Apache HttpComponents + HttpPost httpPost = new HttpPost(opaServerUrl + opaPolicyPath); + httpPost.setHeader("Content-Type", "application/json"); + + // Add bearer token authentication if provided + if (tokenProvider != null) { + String token = tokenProvider.getToken(); + if (token != null && !token.isEmpty()) { + httpPost.setHeader(HttpHeaders.AUTHORIZATION, "Bearer " + token); + } + } + + httpPost.setEntity(new StringEntity(inputJson, StandardCharsets.UTF_8)); + + // Execute request + try (CloseableHttpResponse response = httpClient.execute(httpPost)) { + int statusCode = response.getStatusLine().getStatusCode(); + if (statusCode != 200) { + return false; + } + + // Read and parse response + String responseBody = EntityUtils.toString(response.getEntity(), StandardCharsets.UTF_8); + ObjectNode respNode = (ObjectNode) objectMapper.readTree(responseBody); + return respNode.path("result").path("allow").asBoolean(false); + } + } catch (IOException e) { + throw new RuntimeException("OPA query failed", e); + } + } + + /** + * Builds the OPA input JSON for the authorization query. + * + * <p>Assembles the actor, action, resource, and context sections into the expected OPA input + * format. + * + * @param principal the principal requesting authorization + * @param entities the set of activated entities + * @param op the operation to authorize + * @param targets the list of main target entities + * @param secondaries the list of secondary entities (if any) + * @return the OPA input JSON string + * @throws IOException if JSON serialization fails + */ + private String buildOpaInputJson( + PolarisPrincipal principal, + Set<PolarisBaseEntity> entities, + PolarisAuthorizableOperation op, + List<PolarisResolvedPathWrapper> targets, + List<PolarisResolvedPathWrapper> secondaries) + throws IOException { + ObjectNode input = objectMapper.createObjectNode(); + input.set("actor", buildActorNode(principal)); + input.put("action", op.name()); + input.set("resource", buildResourceNode(targets, secondaries)); + input.set("context", buildContextNode()); + ObjectNode root = objectMapper.createObjectNode(); + root.set("input", input); Review Comment: Yes, I was just thinking about this :) I think a follow up PR to introduce the JSON Schema would be nice for documentation, generating the pojo, and enabling schema validations of the OPA Server Rego https://www.openpolicyagent.org/docs/cli#check ########## polaris-core/src/main/java/org/apache/polaris/core/auth/OpaPolarisAuthorizer.java: ########## @@ -0,0 +1,407 @@ +/* + * 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.auth; + +// Removed Quarkus/MicroProfile annotations for portability +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.node.ArrayNode; +import com.fasterxml.jackson.databind.node.ObjectNode; +import jakarta.annotation.Nonnull; +import jakarta.annotation.Nullable; +import java.io.FileInputStream; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.security.KeyStore; +import java.util.List; +import java.util.Locale; +import java.util.Set; +import javax.net.ssl.SSLContext; +import org.apache.http.HttpHeaders; +import org.apache.http.client.config.RequestConfig; +import org.apache.http.client.methods.CloseableHttpResponse; +import org.apache.http.client.methods.HttpPost; +import org.apache.http.conn.ssl.NoopHostnameVerifier; +import org.apache.http.conn.ssl.SSLConnectionSocketFactory; +import org.apache.http.conn.ssl.TrustAllStrategy; +import org.apache.http.entity.StringEntity; +import org.apache.http.impl.client.CloseableHttpClient; +import org.apache.http.impl.client.HttpClients; +import org.apache.http.ssl.SSLContextBuilder; +import org.apache.http.util.EntityUtils; +import org.apache.iceberg.exceptions.ForbiddenException; +import org.apache.polaris.core.entity.PolarisBaseEntity; +import org.apache.polaris.core.persistence.PolarisResolvedPathWrapper; + +/** + * OPA-based implementation of {@link PolarisAuthorizer}. + * + * <p>This authorizer delegates authorization decisions to an Open Policy Agent (OPA) server using a + * configurable REST API endpoint and policy path. The input to OPA is constructed from the + * principal, entities, operation, and resource context. + */ +public class OpaPolarisAuthorizer implements PolarisAuthorizer { + private final String opaServerUrl; + private final String opaPolicyPath; + private final TokenProvider tokenProvider; + private final CloseableHttpClient httpClient; + private final ObjectMapper objectMapper; + + /** Private constructor for factory method and advanced wiring. */ + private OpaPolarisAuthorizer( + String opaServerUrl, + String opaPolicyPath, + TokenProvider tokenProvider, + CloseableHttpClient httpClient, + ObjectMapper objectMapper) { + this.opaServerUrl = opaServerUrl; + this.opaPolicyPath = opaPolicyPath; + this.tokenProvider = tokenProvider; + this.httpClient = httpClient; + this.objectMapper = objectMapper; + } + + /** + * Static factory that accepts a TokenProvider for advanced token management. + * + * @param opaServerUrl OPA server URL + * @param opaPolicyPath OPA policy path + * @param tokenProvider Token provider for authentication (optional) + * @param timeoutMs HTTP call timeout in milliseconds + * @param verifySsl Whether to verify SSL certificates for HTTPS connections + * @param trustStorePath Custom SSL trust store path (optional) + * @param trustStorePassword Custom SSL trust store password (optional) + * @param client Apache HttpClient (optional, can be null) + * @param mapper ObjectMapper (optional, can be null) + * @return OpaPolarisAuthorizer instance + */ + public static OpaPolarisAuthorizer create( + String opaServerUrl, + String opaPolicyPath, + TokenProvider tokenProvider, + int timeoutMs, + boolean verifySsl, + String trustStorePath, + String trustStorePassword, + Object client, // Accept any client type for compatibility + ObjectMapper mapper) { + + try { + // Create request configuration with timeouts + RequestConfig requestConfig = + RequestConfig.custom() + .setConnectTimeout(timeoutMs) + .setSocketTimeout(timeoutMs) + .setConnectionRequestTimeout(timeoutMs) + .build(); + + // Configure SSL for HTTPS connections + SSLConnectionSocketFactory sslSocketFactory = + createSslSocketFactory(opaServerUrl, verifySsl, trustStorePath, trustStorePassword); + + // Create HTTP client with SSL configuration + CloseableHttpClient httpClient; + if (client instanceof CloseableHttpClient) { + httpClient = (CloseableHttpClient) client; + } else { + if (sslSocketFactory != null) { + httpClient = + HttpClients.custom() + .setDefaultRequestConfig(requestConfig) + .setSSLSocketFactory(sslSocketFactory) + .build(); + } else { + httpClient = HttpClients.custom().setDefaultRequestConfig(requestConfig).build(); + } + } + + ObjectMapper objectMapperWithDefaults = mapper != null ? mapper : new ObjectMapper(); + return new OpaPolarisAuthorizer( + opaServerUrl, opaPolicyPath, tokenProvider, httpClient, objectMapperWithDefaults); + } catch (Exception e) { + throw new RuntimeException("Failed to create OpaPolarisAuthorizer with SSL configuration", e); + } + } + + /** + * Authorizes a single target and secondary entity for the given principal and operation. + * + * <p>Delegates to the multi-target version for consistency. + * + * @param polarisPrincipal the principal requesting authorization + * @param activatedEntities the set of activated entities (roles, etc.) + * @param authzOp the operation to authorize + * @param target the main target entity + * @param secondary the secondary entity (if any) + * @throws ForbiddenException if authorization is denied by OPA + */ + @Override + public void authorizeOrThrow( + @Nonnull PolarisPrincipal polarisPrincipal, + @Nonnull Set<PolarisBaseEntity> activatedEntities, + @Nonnull PolarisAuthorizableOperation authzOp, + @Nullable PolarisResolvedPathWrapper target, + @Nullable PolarisResolvedPathWrapper secondary) { + authorizeOrThrow( + polarisPrincipal, + activatedEntities, + authzOp, + target == null ? null : List.of(target), + secondary == null ? null : List.of(secondary)); + } + + /** + * Authorizes one or more target and secondary entities for the given principal and operation. + * + * <p>Sends the authorization context to OPA and throws if not allowed. + * + * @param polarisPrincipal the principal requesting authorization + * @param activatedEntities the set of activated entities (roles, etc.) + * @param authzOp the operation to authorize + * @param targets the list of main target entities + * @param secondaries the list of secondary entities (if any) + * @throws ForbiddenException if authorization is denied by OPA + */ + @Override + public void authorizeOrThrow( + @Nonnull PolarisPrincipal polarisPrincipal, + @Nonnull Set<PolarisBaseEntity> activatedEntities, + @Nonnull PolarisAuthorizableOperation authzOp, + @Nullable List<PolarisResolvedPathWrapper> targets, + @Nullable List<PolarisResolvedPathWrapper> secondaries) { + boolean allowed = queryOpa(polarisPrincipal, activatedEntities, authzOp, targets, secondaries); + if (!allowed) { + throw new ForbiddenException("OPA denied authorization"); + } + } + + /** + * Sends an authorization query to the OPA server and parses the response. + * + * <p>Builds the OPA input JSON, sends it via HTTP POST, and checks the 'allow' field in the + * response. + * + * @param principal the principal requesting authorization + * @param entities the set of activated entities + * @param op the operation to authorize + * @param targets the list of main target entities + * @param secondaries the list of secondary entities (if any) + * @return true if OPA allows the operation, false otherwise + * @throws RuntimeException if the OPA query fails + */ + private boolean queryOpa( + PolarisPrincipal principal, + Set<PolarisBaseEntity> entities, + PolarisAuthorizableOperation op, + List<PolarisResolvedPathWrapper> targets, + List<PolarisResolvedPathWrapper> secondaries) { + try { + String inputJson = buildOpaInputJson(principal, entities, op, targets, secondaries); + + // Create HTTP POST request using Apache HttpComponents + HttpPost httpPost = new HttpPost(opaServerUrl + opaPolicyPath); Review Comment: The header and response are somewhat standard, the request payload is only standardized to the top level attribute "input", and the path is entirely our decision. I'll add a Java doc to reference the most relevant documentation, and I think we can supplement this with user docs that explain our choices. > How does a OPA Service support multiple Polaris instance? Configuring different path? I think we could support it either at the same path through the same OPA Server and Policy Rego with different payloads that refer to a centrally governed policy bundle, or with multiple Polaris instances each configured to hit different OPA Servers running different Rego. Both work in my opinion, and depends strictly on how varied the policy Rego is across instances. -- 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]
