dimas-b commented on code in PR #3760: URL: https://github.com/apache/polaris/pull/3760#discussion_r2830890135
########## polaris-core/src/main/java/org/apache/polaris/core/auth/AuthorizationRequest.java: ########## @@ -0,0 +1,116 @@ +/* + * 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.Nonnull; +import jakarta.annotation.Nullable; +import java.util.List; +import org.apache.polaris.core.entity.PolarisEntityType; +import org.apache.polaris.immutables.PolarisImmutable; + +/** + * Authorization request inputs for pre-authorization and core authorization. + * + * <p>This wrapper keeps authorization inputs together and conveys the intent to be authorized via + * {@link PolarisSecurable} targets and secondaries. + */ +@PolarisImmutable +public interface AuthorizationRequest { + static AuthorizationRequest of( + @Nonnull PolarisPrincipal principal, + @Nonnull PolarisAuthorizableOperation operation, + @Nullable List<PolarisSecurable> targets, + @Nullable List<PolarisSecurable> secondaries) { + return ImmutableAuthorizationRequest.builder() + .principal(principal) + .operation(operation) + .targets(targets) + .secondaries(secondaries) + .build(); + } + + /** Returns the principal requesting authorization. */ + @Nonnull + PolarisPrincipal getPrincipal(); + + /** Returns the operation being authorized. */ + @Nonnull + PolarisAuthorizableOperation getOperation(); + + /** + * Returns the primary target securables, if any. + * + * <p>Targets are the primary resources the operation applies to (for example, the table being + * created or dropped). + */ + @Nullable + List<PolarisSecurable> getTargets(); + + /** + * Returns the secondary securables, if any. + * + * <p>Secondaries are related resources needed to evaluate the authorization decision but are not + * the direct object of the operation. Examples in current handlers include: + * + * <ul> + * <li>Table rename: the destination namespace (target is the source table). + * <li>Role grants: the grantee role/principal (target may be the role or the resource being + * granted on). + * <li>Policy attach/detach: the catalog/namespace/table being attached to (target is the + * policy). + * </ul> + */ + @Nullable + List<PolarisSecurable> getSecondaries(); Review Comment: Thanks for the javadoc! It certainly helped me refresh my memory 😉 Given current use cases, I wonder if a List-to-List relationship between targets and secondary is actually correct in general. I'd imagine in all relevant cases it is a 1:1 association. When there are multiple targets, there are going to be multiple target/secondary pairs, right? I know it might be a bit of rift in the existing code pattern, but since we're introducing a new SPI, WDYT about modeling this as `List<Pair<PolarisSecurable, PolarisSecurable>> getTargets()`? Of course, we have have a dedicated small immutable object with target/secondary attributes instead of the `Pair`. -- 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]
