Skip to content

Commit bd97364

Browse files
authored
[fix](fe) Use service-specific Ranger select access types (apache#67206)
### What problem does this PR solve? Problem Summary: `RangerAccessController` hardcoded the Doris uppercase `SELECT` access type for row-filter and data-mask requests. Ranger-Hive defines this access type as lowercase `select`. Ordinary authorization could initially succeed, but after Ranger initialized its optimized exact-match evaluator, row-filter and data-mask lookups using uppercase `SELECT` skipped the lowercase policies. This was reproduced against the unmodified `apache/doris:all-in-one-4.1.3` image. The query was authorized but returned unfiltered and unmasked rows: ```text expected: [[2, NULL]] actual: [[1, first], [2, second]] ``` This PR: - delegates SELECT mapping to each Ranger service while retaining a concrete uppercase default, preserving compatibility with existing external subclasses; - uses lowercase `select` consistently for Ranger-Hive authorization, row filters, and data masks; - keeps Ranger connection and process settings in the existing `ranger-<serviceName>-security.xml` configuration; - adds unit coverage and an end-to-end `ranger_p2` case covering lowercase access entries, row filtering, data masking, and a warmed-up policy evaluator. ### Validation - `./run-fe-ut.sh --run org.apache.doris.catalog.authorizer.ranger.hive.RangerHiveAccessControllerTest`: 2 tests passed, 0 failures/errors/skips. - `./run-regression-test.sh --run --conf <local-ranger-conf> -d ranger_p2 -s test_ranger_hive_lowercase_access_type`: 1 suite passed, 0 failed, 0 skipped. The FE loaded `ranger-doris_hive-security.xml`, the catalog did not provide a Ranger URL, and both first and warmed-up queries returned the filtered and masked result.
1 parent 952bfcb commit bd97364

5 files changed

Lines changed: 277 additions & 9 deletions

File tree

‎fe/fe-core/src/main/java/org/apache/doris/catalog/authorizer/ranger/RangerAccessController.java‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,8 @@ public List<? extends RowFilterPolicy> evalRowFilterPolicies(UserIdentity curren
9595
RangerAccessRequestImpl request = createRequest(currentUser);
9696
// If the access type is not set here, it defaults to ANY1 ACCESS.
9797
// The internal logic of the ranger is to traverse all permission items.
98-
// Since the ranger UI will set the access type to 'SELECT',
99-
// we will keep it consistent with the UI here to avoid performance issues
100-
request.setAccessType(DorisAccessType.SELECT.name());
98+
// Keep the access type consistent with the service definition to avoid traversing all policy items.
99+
request.setAccessType(getSelectAccessType());
101100
request.setResource(resource);
102101

103102
if (LOG.isDebugEnabled()) {
@@ -125,7 +124,7 @@ public Optional<DataMaskPolicy> evalDataMaskPolicy(UserIdentity currentUser, Str
125124
String col) {
126125
RangerAccessResourceImpl resource = createResource(ctl, db, tbl, col);
127126
RangerAccessRequestImpl request = createRequest(currentUser);
128-
request.setAccessType(DorisAccessType.SELECT.name());
127+
request.setAccessType(getSelectAccessType());
129128
request.setResource(resource);
130129

131130
if (LOG.isDebugEnabled()) {
@@ -167,6 +166,10 @@ public Optional<DataMaskPolicy> evalDataMaskPolicy(UserIdentity currentUser, Str
167166

168167
protected abstract RangerAccessRequestImpl createRequest(UserIdentity currentUser);
169168

169+
protected String getSelectAccessType() {
170+
return DorisAccessType.SELECT.name();
171+
}
172+
170173
protected abstract RangerAccessResourceImpl createResource(String ctl, String db, String tbl);
171174

172175
protected abstract RangerAccessResourceImpl createResource(String ctl, String db, String tbl, String col);

‎fe/fe-core/src/main/java/org/apache/doris/catalog/authorizer/ranger/hive/RangerHiveAccessController.java‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@
4343
import java.util.Collection;
4444
import java.util.Date;
4545
import java.util.List;
46+
import java.util.Locale;
4647
import java.util.Map;
4748
import java.util.Optional;
4849
import java.util.Set;
@@ -113,14 +114,16 @@ public void close() {
113114

114115
private RangerAccessRequestImpl createRequest(UserIdentity currentUser, HiveAccessType accessType) {
115116
RangerAccessRequestImpl request = createRequest(currentUser);
116-
if (accessType == HiveAccessType.USE) {
117-
request.setAccessType(RangerPolicyEngine.ANY_ACCESS);
118-
} else {
119-
request.setAccessType(accessType.name().toLowerCase());
120-
}
117+
request.setAccessType(toRangerAccessType(accessType));
121118
return request;
122119
}
123120

121+
static String toRangerAccessType(HiveAccessType accessType) {
122+
return accessType == HiveAccessType.USE
123+
? RangerPolicyEngine.ANY_ACCESS
124+
: accessType.name().toLowerCase(Locale.ROOT);
125+
}
126+
124127
@Override
125128
protected RangerAccessRequestImpl createRequest(UserIdentity currentUser) {
126129
RangerAccessRequestImpl request = new RangerAccessRequestImpl();
@@ -137,6 +140,11 @@ protected RangerAccessRequestImpl createRequest(UserIdentity currentUser) {
137140
return request;
138141
}
139142

143+
@Override
144+
protected String getSelectAccessType() {
145+
return toRangerAccessType(HiveAccessType.SELECT);
146+
}
147+
140148
private void checkPrivileges(UserIdentity currentUser, HiveAccessType accessType,
141149
List<RangerHiveResource> hiveResources) throws AuthorizationException {
142150
lifecycleLock.readLock().lock();
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
// Licensed to the Apache Software Foundation (ASF) under one
2+
// or more contributor license agreements. See the NOTICE file
3+
// distributed with this work for additional information
4+
// regarding copyright ownership. The ASF licenses this file
5+
// to you under the Apache License, Version 2.0 (the
6+
// "License"); you may not use this file except in compliance
7+
// with the License. You may obtain a copy of the License at
8+
//
9+
// http://www.apache.org/licenses/LICENSE-2.0
10+
//
11+
// Unless required by applicable law or agreed to in writing,
12+
// software distributed under the License is distributed on an
13+
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
// KIND, either express or implied. See the License for the
15+
// specific language governing permissions and limitations
16+
// under the License.
17+
18+
package org.apache.doris.catalog.authorizer.ranger.hive;
19+
20+
import org.apache.doris.analysis.UserIdentity;
21+
22+
import org.apache.ranger.plugin.policyengine.RangerAccessRequestImpl;
23+
import org.apache.ranger.plugin.policyengine.RangerPolicyEngine;
24+
import org.apache.ranger.plugin.service.RangerBasePlugin;
25+
import org.junit.Assert;
26+
import org.junit.Test;
27+
import org.mockito.Mockito;
28+
29+
import java.lang.reflect.Field;
30+
import java.util.concurrent.locks.ReentrantReadWriteLock;
31+
32+
public class RangerHiveAccessControllerTest {
33+
@Test
34+
public void testRangerAccessTypeMapping() {
35+
Assert.assertEquals("select", RangerHiveAccessController.toRangerAccessType(HiveAccessType.SELECT));
36+
Assert.assertEquals("update", RangerHiveAccessController.toRangerAccessType(HiveAccessType.UPDATE));
37+
Assert.assertEquals(RangerPolicyEngine.ANY_ACCESS,
38+
RangerHiveAccessController.toRangerAccessType(HiveAccessType.USE));
39+
}
40+
41+
@Test
42+
public void testPolicyRequestsUseLowerCaseSelect() throws Exception {
43+
RangerHiveAccessController controller = Mockito.mock(
44+
RangerHiveAccessController.class, Mockito.CALLS_REAL_METHODS);
45+
Field lifecycleLock = RangerHiveAccessController.class.getDeclaredField("lifecycleLock");
46+
lifecycleLock.setAccessible(true);
47+
lifecycleLock.set(controller, new ReentrantReadWriteLock());
48+
RangerBasePlugin plugin = Mockito.mock(RangerBasePlugin.class);
49+
UserIdentity currentUser = UserIdentity.createAnalyzedUserIdentWithIp("user", "%");
50+
RangerAccessRequestImpl rowFilterRequest = new RangerAccessRequestImpl();
51+
RangerAccessRequestImpl dataMaskRequest = new RangerAccessRequestImpl();
52+
53+
Mockito.doReturn(rowFilterRequest, dataMaskRequest).when(controller).createRequest(currentUser);
54+
Mockito.doReturn(plugin).when(controller).getPlugin();
55+
56+
controller.evalRowFilterPolicies(currentUser, "catalog", "database", "table");
57+
controller.evalDataMaskPolicy(currentUser, "catalog", "database", "table", "column");
58+
59+
Assert.assertEquals("select", rowFilterRequest.getAccessType());
60+
Assert.assertEquals("select", dataMaskRequest.getAccessType());
61+
}
62+
}
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
-- This file is automatically generated. You should know what you did if you want to edit this
2+
-- !lowercase_access_type_first --
3+
2 \N
4+
5+
-- !lowercase_access_type_warmed_up --
6+
2 \N
7+
Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
// Licensed to the Apache Software Foundation (ASF) under one
2+
// or more contributor license agreements. See the NOTICE file
3+
// distributed with this work for additional information
4+
// regarding copyright ownership. The ASF licenses this file
5+
// to you under the Apache License, Version 2.0 (the
6+
// "License"); you may not use this file except in compliance
7+
// with the License. You may obtain a copy of the License at
8+
//
9+
// http://www.apache.org/licenses/LICENSE-2.0
10+
//
11+
// Unless required by applicable law or agreed to in writing,
12+
// software distributed under the License is distributed on an
13+
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
// KIND, either express or implied. See the License for the
15+
// specific language governing permissions and limitations
16+
// under the License.
17+
18+
import org.apache.ranger.RangerClient
19+
import org.apache.ranger.plugin.model.RangerPolicy
20+
import org.apache.ranger.plugin.model.RangerService
21+
22+
23+
suite("test_ranger_hive_lowercase_access_type", "p2,ranger,external") {
24+
String enableRangerTest = context.config.otherConfigs.get("enableRangerTest")
25+
String enableHiveTest = context.config.otherConfigs.get("enableHiveTest")
26+
27+
if (!enableRangerTest?.equalsIgnoreCase("true") || !enableHiveTest?.equalsIgnoreCase("true")) {
28+
logger.info("skip Ranger-Hive lowercase access type case because Ranger or Hive test is not enabled")
29+
return
30+
}
31+
32+
String rangerEndpoint = context.config.otherConfigs.get("rangerEndpoint")
33+
String rangerUser = context.config.otherConfigs.get("rangerUser")
34+
String rangerPassword = context.config.otherConfigs.get("rangerPassword")
35+
String rangerServiceName = context.config.otherConfigs.get("rangerServiceName")
36+
String externalEnvIp = context.config.otherConfigs.get("externalEnvIp")
37+
String hmsPort = context.config.otherConfigs.get("hive3HmsPort")
38+
String hiveServerPort = context.config.otherConfigs.get("hive3ServerPort")
39+
String rangerHiveServiceName = "${rangerServiceName}_hive"
40+
41+
String catalog = "ranger_hive_lowercase_catalog"
42+
String database = "ranger_hive_lowercase_db"
43+
String table = "ranger_hive_lowercase_tbl"
44+
String user = "ranger_hive_lowercase_user"
45+
String password = "C123_567p"
46+
String accessPolicyName = "doris_ranger_hive_lowercase_access"
47+
String rowFilterPolicyName = "doris_ranger_hive_lowercase_row_filter"
48+
String dataMaskPolicyName = "doris_ranger_hive_lowercase_data_mask"
49+
List<String> policyNames = [accessPolicyName, rowFilterPolicyName, dataMaskPolicyName]
50+
51+
RangerClient rangerClient = new RangerClient(
52+
"http://${rangerEndpoint}", "simple", rangerUser, rangerPassword, null)
53+
boolean createdHiveService = false
54+
55+
def deletePolicyIfExists = { String policyName ->
56+
try {
57+
rangerClient.deletePolicy(rangerHiveServiceName, policyName)
58+
} catch (Exception e) {
59+
logger.info("Ranger policy ${policyName} does not exist: ${e.getMessage()}")
60+
}
61+
}
62+
63+
def tableResources = {
64+
Map<String, RangerPolicy.RangerPolicyResource> resources = new HashMap<>()
65+
resources.put("database", new RangerPolicy.RangerPolicyResource(database))
66+
resources.put("table", new RangerPolicy.RangerPolicyResource(table))
67+
return resources
68+
}
69+
70+
def accessResources = {
71+
Map<String, RangerPolicy.RangerPolicyResource> resources = tableResources()
72+
resources.put("column", new RangerPolicy.RangerPolicyResource("*"))
73+
return resources
74+
}
75+
76+
try {
77+
try {
78+
RangerService hiveService = rangerClient.getService(rangerHiveServiceName)
79+
assertEquals("hive", hiveService.getType())
80+
} catch (Exception e) {
81+
logger.info("Create Ranger-Hive service ${rangerHiveServiceName}: ${e.getMessage()}")
82+
RangerService hiveService = new RangerService()
83+
hiveService.setType("hive")
84+
hiveService.setName(rangerHiveServiceName)
85+
hiveService.setDisplayName(rangerHiveServiceName)
86+
hiveService.setConfigs([
87+
"username": "hive",
88+
"password": "hive",
89+
"jdbc.driverClassName": "org.apache.hive.jdbc.HiveDriver",
90+
"jdbc.url": "jdbc:hive2://${externalEnvIp}:${hiveServerPort}".toString()
91+
])
92+
rangerClient.createService(hiveService)
93+
createdHiveService = true
94+
}
95+
96+
// Prepare the Hive data through a catalog without Ranger, so setup does not need policies.
97+
sql """DROP CATALOG IF EXISTS `${catalog}`"""
98+
sql """CREATE CATALOG `${catalog}` PROPERTIES (
99+
'type' = 'hms',
100+
'hive.metastore.uris' = 'thrift://${externalEnvIp}:${hmsPort}'
101+
)"""
102+
try_sql """DROP TABLE IF EXISTS `${catalog}`.`${database}`.`${table}`"""
103+
try_sql """DROP DATABASE IF EXISTS `${catalog}`.`${database}`"""
104+
sql """CREATE DATABASE `${catalog}`.`${database}`"""
105+
sql """CREATE TABLE `${catalog}`.`${database}`.`${table}` (
106+
id BIGINT,
107+
secret VARCHAR(20)
108+
) ENGINE=hive
109+
PROPERTIES ('file_format' = 'parquet')"""
110+
sql """INSERT INTO `${catalog}`.`${database}`.`${table}` VALUES
111+
(1, 'first'), (2, 'second')"""
112+
sql """DROP CATALOG `${catalog}`"""
113+
114+
sql """DROP USER IF EXISTS '${user}'"""
115+
sql """CREATE USER '${user}' IDENTIFIED BY '${password}'"""
116+
117+
policyNames.each { deletePolicyIfExists(it) }
118+
119+
RangerPolicy accessPolicy = new RangerPolicy()
120+
accessPolicy.setService(rangerHiveServiceName)
121+
accessPolicy.setName(accessPolicyName)
122+
accessPolicy.setResources(accessResources())
123+
RangerPolicy.RangerPolicyItem accessPolicyItem = new RangerPolicy.RangerPolicyItem()
124+
accessPolicyItem.setUsers([user])
125+
accessPolicyItem.setAccesses([new RangerPolicy.RangerPolicyItemAccess("select")])
126+
accessPolicy.setPolicyItems([accessPolicyItem])
127+
rangerClient.createPolicy(accessPolicy)
128+
129+
RangerPolicy rowFilterPolicy = new RangerPolicy()
130+
rowFilterPolicy.setService(rangerHiveServiceName)
131+
rowFilterPolicy.setName(rowFilterPolicyName)
132+
rowFilterPolicy.setPolicyType(RangerPolicy.POLICY_TYPE_ROWFILTER)
133+
rowFilterPolicy.setResources(tableResources())
134+
RangerPolicy.RangerRowFilterPolicyItem rowFilterPolicyItem = new RangerPolicy.RangerRowFilterPolicyItem()
135+
rowFilterPolicyItem.setUsers([user])
136+
rowFilterPolicyItem.setAccesses([new RangerPolicy.RangerPolicyItemAccess("select")])
137+
rowFilterPolicyItem.setRowFilterInfo(new RangerPolicy.RangerPolicyItemRowFilterInfo("id >= 2"))
138+
rowFilterPolicy.setRowFilterPolicyItems([rowFilterPolicyItem])
139+
rangerClient.createPolicy(rowFilterPolicy)
140+
141+
RangerPolicy dataMaskPolicy = new RangerPolicy()
142+
dataMaskPolicy.setService(rangerHiveServiceName)
143+
dataMaskPolicy.setName(dataMaskPolicyName)
144+
dataMaskPolicy.setPolicyType(RangerPolicy.POLICY_TYPE_DATAMASK)
145+
Map<String, RangerPolicy.RangerPolicyResource> dataMaskResources = tableResources()
146+
dataMaskResources.put("column", new RangerPolicy.RangerPolicyResource("secret"))
147+
dataMaskPolicy.setResources(dataMaskResources)
148+
RangerPolicy.RangerDataMaskPolicyItem dataMaskPolicyItem = new RangerPolicy.RangerDataMaskPolicyItem()
149+
dataMaskPolicyItem.setUsers([user])
150+
dataMaskPolicyItem.setAccesses([new RangerPolicy.RangerPolicyItemAccess("select")])
151+
dataMaskPolicyItem.setDataMaskInfo(
152+
new RangerPolicy.RangerPolicyItemDataMaskInfo("MASK_NULL", "", ""))
153+
dataMaskPolicy.setDataMaskPolicyItems([dataMaskPolicyItem])
154+
rangerClient.createPolicy(dataMaskPolicy)
155+
156+
// Recreate the catalog with Ranger-Hive enabled after policies are ready.
157+
sql """CREATE CATALOG `${catalog}` PROPERTIES (
158+
'type' = 'hms',
159+
'hive.metastore.uris' = 'thrift://${externalEnvIp}:${hmsPort}',
160+
'access_controller.properties.ranger.service.name' = '${rangerHiveServiceName}',
161+
'access_controller.class' =
162+
'org.apache.doris.catalog.authorizer.ranger.hive.RangerHiveAccessControllerFactory'
163+
)"""
164+
waitPolicyEffect()
165+
166+
def tokens = context.config.jdbcUrl.split('/')
167+
def defaultJdbcUrl = tokens[0] + "//" + tokens[2] + "/?"
168+
connect(user, password, defaultJdbcUrl) {
169+
String query = "SELECT id, secret FROM `${catalog}`.`${database}`.`${table}` ORDER BY id"
170+
171+
// The first query initializes Ranger's optimized policy evaluator. The second query verifies
172+
// that lowercase Hive access types still match after that evaluator has been warmed up.
173+
order_qt_lowercase_access_type_first(query)
174+
order_qt_lowercase_access_type_warmed_up(query)
175+
}
176+
} finally {
177+
try_sql "DROP CATALOG IF EXISTS `${catalog}`"
178+
policyNames.each { deletePolicyIfExists(it) }
179+
try_sql "DROP USER IF EXISTS '${user}'"
180+
if (createdHiveService) {
181+
try {
182+
rangerClient.deleteService(rangerHiveServiceName)
183+
} catch (Exception e) {
184+
logger.warn("Failed to delete Ranger-Hive service ${rangerHiveServiceName}: ${e.getMessage()}")
185+
}
186+
}
187+
}
188+
}

0 commit comments

Comments
 (0)