gianm commented on code in PR #17564: URL: https://github.com/apache/druid/pull/17564#discussion_r1889263579
########## server/src/main/java/org/apache/druid/server/security/AuthorizationResult.java: ########## @@ -0,0 +1,136 @@ +/* + * 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.druid.server.security; + +import com.google.common.collect.ImmutableMap; +import org.apache.druid.query.filter.DimFilter; + +import javax.annotation.Nonnull; +import javax.annotation.Nullable; +import java.util.Collections; +import java.util.Map; +import java.util.Optional; +import java.util.Set; + +public class AuthorizationResult +{ + /** + * Provides unrestricted access to all resources. This should be limited to Druid internal systems or superusers, + * except in cases where ACL considerations are not a priority. + */ + public static final AuthorizationResult ALLOW_ALL = new AuthorizationResult( + true, + null, + Collections.emptyMap(), + null, + null + ); + + /** + * Provides a default deny access result. + */ + public static final AuthorizationResult DENY = new AuthorizationResult( + false, + Access.DENIED.getMessage(), + Collections.emptyMap(), + null, + null + ); + + private final boolean isAllowed; + + @Nullable + private final String failureMessage; + + private final Map<String, Optional<DimFilter>> policyFilters; + + @Nullable + private final Set<ResourceAction> sqlResourceActions; + + @Nullable + private final Set<ResourceAction> allResourceActions; + + AuthorizationResult( + boolean isAllowed, + @Nullable String failureMessage, + Map<String, Optional<DimFilter>> policyFilters, + @Nullable Set<ResourceAction> sqlResourceActions, + @Nullable Set<ResourceAction> allResourceActions + ) + { + this.isAllowed = isAllowed; + this.failureMessage = failureMessage; + this.policyFilters = policyFilters; + this.sqlResourceActions = sqlResourceActions; + this.allResourceActions = allResourceActions; + } + + public static AuthorizationResult deny(@Nonnull String failureMessage) + { + return new AuthorizationResult(false, failureMessage, Collections.emptyMap(), null, null); + } + + public static AuthorizationResult allowWithRestriction(Map<String, Optional<DimFilter>> policyFilters) + { + return new AuthorizationResult(true, null, policyFilters, null, null); + } + + public AuthorizationResult withResourceActions( + Set<ResourceAction> sqlResourceActions, + Set<ResourceAction> allResourceActions + ) + { + return new AuthorizationResult( + isAllowed(), + getFailureMessage(), + ImmutableMap.copyOf(getPolicyFilters()), + sqlResourceActions, + allResourceActions + ); + } + + public boolean isAllowed() Review Comment: The current design here has a problem— since `isAllowed()` returns `true` when there are policies, it encourages code to "forget" to check policies. It would be better to use a tri-state enum so callers don't "forget": `ALLOWED`, `DENIED`, `ALLOWED_WITH_POLICIES`. OTOH, if we want to maintain more compatibility for extensions, then we can merge this stuff back into `Access`, and do two methods: `isAllowed()` and `isAllowedWithPolicies()`. When there are policies in play, the first method should return `false` and second should return `true`. That would mean things fail-denied if the caller "forgets" to check the policies. -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
