theoryxu commented on code in PR #5733: URL: https://github.com/apache/gravitino/pull/5733#discussion_r1881323046
########## authorizations/authorization-ranger/src/main/java/org/apache/gravitino/authorization/ranger/RangerAuthorizationHDFSPlugin.java: ########## @@ -0,0 +1,257 @@ +/* + * 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.gravitino.authorization.ranger; + +import com.google.common.base.Preconditions; +import com.google.common.collect.ImmutableList; +import com.google.common.collect.ImmutableMap; +import com.google.common.collect.ImmutableSet; +import com.google.common.collect.Lists; +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Set; +import java.util.regex.Pattern; +import org.apache.gravitino.GravitinoEnv; +import org.apache.gravitino.MetadataObject; +import org.apache.gravitino.NameIdentifier; +import org.apache.gravitino.authorization.AuthorizationMetadataObject; +import org.apache.gravitino.authorization.AuthorizationPrivilege; +import org.apache.gravitino.authorization.AuthorizationSecurableObject; +import org.apache.gravitino.authorization.Privilege; +import org.apache.gravitino.authorization.SecurableObject; +import org.apache.gravitino.authorization.SecurableObjects; +import org.apache.gravitino.authorization.ranger.reference.RangerDefines; +import org.apache.gravitino.catalog.FilesetDispatcher; +import org.apache.gravitino.exceptions.AuthorizationPluginException; +import org.apache.gravitino.file.Fileset; +import org.apache.ranger.plugin.model.RangerPolicy; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class RangerAuthorizationHDFSPlugin extends RangerAuthorizationPlugin { + private static final Logger LOG = LoggerFactory.getLogger(RangerAuthorizationHDFSPlugin.class); + + private static final Pattern pattern = Pattern.compile("^hdfs://[^/]*"); + + private static volatile RangerAuthorizationHDFSPlugin instance = null; + + private RangerAuthorizationHDFSPlugin(String metalake, Map<String, String> config) { + super(metalake, config); + } + + public static synchronized RangerAuthorizationHDFSPlugin getInstance( + String metalake, Map<String, String> config) { + if (instance == null) { + synchronized (RangerAuthorizationHadoopSQLPlugin.class) { + if (instance == null) { + instance = new RangerAuthorizationHDFSPlugin(metalake, config); + } + } + } + return instance; + } + + @Override + public Map<Privilege.Name, Set<AuthorizationPrivilege>> privilegesMappingRule() { + return ImmutableMap.of( + Privilege.Name.READ_FILESET, + ImmutableSet.of( + RangerPrivileges.RangerHdfsPrivilege.READ, + RangerPrivileges.RangerHdfsPrivilege.EXECUTE), + Privilege.Name.WRITE_FILESET, + ImmutableSet.of( + RangerPrivileges.RangerHdfsPrivilege.WRITE, + RangerPrivileges.RangerHdfsPrivilege.EXECUTE)); + } + + @Override + public Set<AuthorizationPrivilege> ownerMappingRule() { + return ImmutableSet.of( + RangerPrivileges.RangerHdfsPrivilege.READ, + RangerPrivileges.RangerHdfsPrivilege.WRITE, + RangerPrivileges.RangerHdfsPrivilege.EXECUTE); + } + + @Override + public List<String> policyResourceDefinesRule() { + return ImmutableList.of(RangerDefines.PolicyResource.PATH.getName()); + } + + @Override + protected RangerPolicy createPolicyAddResources(AuthorizationMetadataObject metadataObject) { + RangerPolicy policy = new RangerPolicy(); + policy.setService(rangerServiceName); + policy.setName(metadataObject.fullName()); + RangerPolicy.RangerPolicyResource policyResource = + new RangerPolicy.RangerPolicyResource(metadataObject.names().get(0), false, true); + policy.getResources().put(RangerDefines.PolicyResource.PATH.getName(), policyResource); + return policy; + } + + @Override + public AuthorizationSecurableObject generateAuthorizationSecurableObject( + List<String> names, + AuthorizationMetadataObject.Type type, + Set<AuthorizationPrivilege> privileges) { + AuthorizationMetadataObject authMetadataObject = + new RangerHDFSMetadataObject(AuthorizationMetadataObject.getLastName(names), type); + authMetadataObject.validateAuthorizationMetadataObject(); + return new RangerHDFSSecurableObject( + authMetadataObject.name(), authMetadataObject.type(), privileges); + } + + @Override + public Set<Privilege.Name> allowPrivilegesRule() { + return ImmutableSet.of( + Privilege.Name.CREATE_FILESET, Privilege.Name.READ_FILESET, Privilege.Name.WRITE_FILESET); + } + + @Override + public Set<MetadataObject.Type> allowMetadataObjectTypesRule() { + return ImmutableSet.of( + MetadataObject.Type.FILESET, + MetadataObject.Type.SCHEMA, + MetadataObject.Type.CATALOG, + MetadataObject.Type.METALAKE); + } + + @Override + public List<AuthorizationSecurableObject> translatePrivilege(SecurableObject securableObject) { + List<AuthorizationSecurableObject> rangerSecurableObjects = new ArrayList<>(); + + securableObject.privileges().stream() + .filter(Objects::nonNull) + .forEach( + gravitinoPrivilege -> { + Set<AuthorizationPrivilege> rangerPrivileges = new HashSet<>(); + // Ignore unsupported privileges + if (!privilegesMappingRule().containsKey(gravitinoPrivilege.name())) { + return; + } + privilegesMappingRule().get(gravitinoPrivilege.name()).stream() + .forEach( + rangerPrivilege -> + rangerPrivileges.add( + new RangerPrivileges.RangerHivePrivilegeImpl( + rangerPrivilege, gravitinoPrivilege.condition()))); + + switch (gravitinoPrivilege.name()) { + case CREATE_FILESET: + // Ignore the Gravitino privilege `CREATE_FILESET` in the + // RangerAuthorizationHDFSPlugin + break; + case READ_FILESET: + case WRITE_FILESET: + switch (securableObject.type()) { + case METALAKE: + case CATALOG: + case SCHEMA: + break; + case FILESET: + rangerSecurableObjects.add( + generateAuthorizationSecurableObject( + translateMetadataObject(securableObject).names(), + RangerHDFSMetadataObject.Type.PATH, + rangerPrivileges)); + break; + default: + throw new AuthorizationPluginException( + "The privilege %s is not supported for the securable object: %s", + gravitinoPrivilege.name(), securableObject.type()); + } + break; + default: + LOG.warn( + "RangerAuthorizationHDFSPlugin -> privilege {} is not supported for the securable object: {}", + gravitinoPrivilege.name(), + securableObject.type()); + } + }); + + return rangerSecurableObjects; + } + + @Override + public List<AuthorizationSecurableObject> translateOwner(MetadataObject gravitinoMetadataObject) { + List<AuthorizationSecurableObject> rangerSecurableObjects = new ArrayList<>(); + switch (gravitinoMetadataObject.type()) { + case METALAKE: + case CATALOG: + case SCHEMA: + return rangerSecurableObjects; + case FILESET: + rangerSecurableObjects.add( + generateAuthorizationSecurableObject( + translateMetadataObject(gravitinoMetadataObject).names(), + RangerHDFSMetadataObject.Type.PATH, + ownerMappingRule())); + break; + default: + throw new AuthorizationPluginException( + "The owner privilege is not supported for the securable object: %s", + gravitinoMetadataObject.type()); + } + + return rangerSecurableObjects; + } + + @Override + public AuthorizationMetadataObject translateMetadataObject(MetadataObject metadataObject) { + Preconditions.checkArgument( + allowMetadataObjectTypesRule().contains(metadataObject.type()), + String.format( + "The metadata object type %s is not supported in the RangerAuthorizationHDFSPlugin", + metadataObject.type())); + List<String> nsMetadataObject = + Lists.newArrayList(SecurableObjects.DOT_SPLITTER.splitToList(metadataObject.fullName())); + Preconditions.checkArgument( + nsMetadataObject.size() > 0, "The metadata object must have at least one name."); + + if (metadataObject.type() == MetadataObject.Type.FILESET) { + RangerHDFSMetadataObject rangerHDFSMetadataObject = + new RangerHDFSMetadataObject( + getFileSetPath(metadataObject), RangerHDFSMetadataObject.Type.PATH); + rangerHDFSMetadataObject.validateAuthorizationMetadataObject(); + return rangerHDFSMetadataObject; + } else { + return new RangerHDFSMetadataObject("", RangerHDFSMetadataObject.Type.SCHEMA_PATH); + } + } + + private String getFileSetPath(MetadataObject metadataObject) { + FilesetDispatcher filesetDispatcher = GravitinoEnv.getInstance().filesetDispatcher(); + boolean testEnv = + System.getenv("GRAVITINO_TEST") != null || System.getenv("GRAVITINO_TEST_CLOUD_IT") == null; Review Comment: For github CI ENV, `Access Control Integration Test` -- 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: commits-unsubscr...@gravitino.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
