yifan-c commented on code in PR #179: URL: https://github.com/apache/cassandra-sidecar/pull/179#discussion_r1942087645
########## server/src/main/java/org/apache/cassandra/sidecar/acl/authorization/DataResourceScope.java: ########## @@ -0,0 +1,163 @@ +/* + * 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.cassandra.sidecar.acl.authorization; + +import java.util.Collections; +import java.util.Set; + +import com.google.common.collect.ImmutableSet; + +import static org.apache.cassandra.sidecar.common.ApiEndpointsV1.KEYSPACE; +import static org.apache.cassandra.sidecar.common.ApiEndpointsV1.TABLE; +import static org.apache.cassandra.sidecar.common.utils.StringUtils.isNullOrEmpty; + +/** + * Signifies scope of Cassandra data resource. {@code keyspaceScoped} can be set to true to create data scope + * restricted to a keyspace. {@code tableScoped} can be set to true to create data scope restricted to a table. + */ +public class DataResourceScope implements ResourceScope +{ + private static final String DATA = "data"; + + /** + * Cassandra stores data resource in the format data, data/keyspace or data/keyspace_name/table_name within + * role_permissions table. A similar format is followed for storing data resources in sidecar permissions + * table role_permissions_v1. Hence, sidecar endpoints expect data resources to be provided in format + * data/keyspace_name/table_name. + * <p> + * In this context, curly braces are used to denote variable parts of the resource. For e.g., when permissions are + * checked for resource data/{keyspace} in an endpoint, the part within the curly braces ({keyspace}) + * represents a placeholder for the actual keyspace name provided as a path parameter. For more context refer to + * io.vertx.ext.auth.authorization.impl.VariableAwareExpression + * <p> + * During the permission matching process, the placeholder {keyspace} is resolved to the actual keyspace + * being accessed by the endpoint. For e.g. data/{keyspace} resolves to data/university if the keyspace is + * "university". + * <p> + * User permissions are then extracted from both Cassandra and sidecar role permissions tables for + * the resolved resource and are matched against the expected permissions set defined in the endpoint's handler. + */ + private static final String DATA_WITH_KEYSPACE = String.format("data/{%s}", KEYSPACE); + + // TODO remove this hack once VariableAwareExpression bug is fixed + // VariableAwareExpression in vertx-auth-common package has a bug during String.substring() call, hence + // we cannot set resources that do not end in curly braces (e.g. data/keyspace/*) in + // PermissionBasedAuthorizationImpl or WildcardPermissionBasedAuthorizationImpl. data/{%s}/{TABLE_WILDCARD} treats + // TABLE_WILDCARD as a variable. This hack allows to read resource level permissions that could be set for all + // tables through data/<keyspace_name>/*. Bug should be fixed in 4.5.12 + // Note: DATA_WITH_KEYSPACE_ALL_TABLES authorizes for all tables under the keyspace excluding the keyspace itself + private static final String DATA_WITH_KEYSPACE_ALL_TABLES = String.format("data/{%s}/{TABLE_WILDCARD}", KEYSPACE); + + private static final String DATA_WITH_KEYSPACE_TABLE = String.format("data/{%s}/{%s}", KEYSPACE, TABLE); + + private final boolean keyspaceScoped; + private final boolean tableScoped; + private final Set<String> expandedResources; + + private DataResourceScope(boolean keyspaceScoped, boolean tableScoped) + { + this.keyspaceScoped = keyspaceScoped; + this.tableScoped = tableScoped; + this.expandedResources = initializeExpandedResources(); + } + + private Set<String> initializeExpandedResources() + { + if (tableScoped) + { + // can expand to DATA, DATA_WITH_KEYSPACE and DATA_WITH_KEYSPACE_ALL_TABLES + return ImmutableSet.of(DATA, DATA_WITH_KEYSPACE, DATA_WITH_KEYSPACE_ALL_TABLES, DATA_WITH_KEYSPACE_TABLE); + } + if (keyspaceScoped) + { + // can expand to DATA + return ImmutableSet.of(DATA, DATA_WITH_KEYSPACE); + } + return Collections.singleton(DATA); + } + + @Override + public String variableAwareResource() + { + if (tableScoped) + { + return DATA_WITH_KEYSPACE_TABLE; + } + if (keyspaceScoped) + { + return DATA_WITH_KEYSPACE; + } + return DATA; + } + + @Override + public String resolveWithResource(String resource) + { + if (isNullOrEmpty(resource)) + { + throw new IllegalArgumentException("Resource expected for resolving"); + } + + if (!resource.startsWith("data")) + { + return variableAwareResource(); + } + + String[] parts = resource.split("/"); + if (tableScoped) + { + return resource; + } + else if (keyspaceScoped) + { + return parts.length == 3 ? "data/" + parts[1] : resource; + } + return "data"; + } + + @Override + public Set<String> expandedResources() + { + return expandedResources; + } + + /** + * @return {@link DataResourceScope} scoped at data level including all keyspaces and tables + */ + public static DataResourceScope createWithDataScope() + { + return new DataResourceScope(false, false); + } + + /** + * @return {@link DataResourceScope} scoped at keyspace level within data + */ + public static DataResourceScope createWithKeyspaceScope() + { + return new DataResourceScope(true, false); + } + + /** + * @return {@link DataResourceScope} scoped at table level within a keyspace + */ + public static DataResourceScope createWithTableScope() Review Comment: Nope. This is what I meant. In this class file, having this instead. ```java public static DataResourceScope DATA = new DataResourceScope(false, false); // so on for the other 2 scopes. ``` -- 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: pr-unsubscr...@cassandra.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: pr-unsubscr...@cassandra.apache.org For additional commands, e-mail: pr-h...@cassandra.apache.org
