mneethiraj commented on code in PR #1000:
URL: https://github.com/apache/ranger/pull/1000#discussion_r3370858459
##########
security-admin/src/main/java/org/apache/ranger/biz/XUserMgr.java:
##########
@@ -1887,6 +1897,51 @@ public Set<String> getGroupsForUser(String userName) {
return ret;
}
+ /**
+ * Returns synced group names from Ranger DB (no API permission checks).
+ * For config super-user / super-group matching at login only.
+ *
+ * @param userName user login id
+ * @return group names from {@code x_group_users}
+ */
+ public Set<String> getSyncedGroupsForUser(final String userName) {
+ Set<String> ret = new HashSet<>();
+
+ try {
+ XXUser xUser = daoManager.getXXUser().findByUserName(userName);
Review Comment:
I suggest replacing 2 queries `daoManager.getXXUser().findByUserName()` and
`daoManager.getXXGroupUser().findByUserId()` with a single query that returns
group names as `List<String>` for the given `userName`. In addition to saving
number of queries, it will also avoid bringing `XXUser` and `XXGroupUser` JPA
objects to memory.
##########
security-admin/src/main/java/org/apache/ranger/common/RangerSuperUserConfig.java:
##########
@@ -0,0 +1,245 @@
+/*
+ * 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.ranger.common;
+
+import org.apache.commons.collections.CollectionUtils;
+import org.apache.commons.lang3.StringUtils;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Set;
+
+/**
+ * Configuration-based Ranger Admin super users and super groups.
+ * When {@code ranger.admin.super.users} or
+ * {@code ranger.admin.super.groups} are set, matching authenticated users
+ * receive full Ranger administrative privileges (system admin and key admin
+ * capabilities) without requiring corresponding roles in the Ranger database.
+ */
+public final class RangerSuperUserConfig {
+ private static volatile RangerSuperUserConfig instance;
+
+ private final boolean superUsersConfigured;
+ private final boolean superGroupsConfigured;
+ private final boolean enabled;
+
+ private RangerSuperUserConfig() {
Review Comment:
`PropertiesUtil.getPropertyStringList()` is still getting called in every
call to `isSuperUser()`; this should be avoided.
```
public final class RangerSuperUserConfig {
private final Set<String> superUsers = new HashSet<>();
private final Set<String> superUserGroups = new HashSet<>();
private final boolean isEnabled;
private final boolean isSuperUsersConfigured;
private final boolean isSuperUserGroupsConfigured;
private RangerSuperUserConfig() {
String[] cfgSuperUsers =
PropertiesUtil.getPropertyStringList(RangerConstants.RANGER_ADMIN_SUPER_USERS));
String[] cfgSuperUserGroups =
PropertiesUtil.getPropertyStringList(RangerConstants.RANGER_ADMIN_SUPER_GROUPS));
if (cfgSuperUsers != null) {
for (String user : cfgSuperUsers) {
superUsers.add(user);
}
}
if (cfgSuperUserGroups != null) {
for (String userGroup : cfgSuperUserGroups) {
superUserGroups.add(userGroup);
}
}
isSuperUsersConfigured = !superUsers.isEmpty();
isSuperUserGroupsConfigured = !superUserGroups.isEmpty();
isEnabled = isSuperUsersConfigured ||
isSuperUserGroupsConfigured;
}
public boolean isSuperUser(String userName) {
return superUsers.contains(userName);
}
public boolean isSuperUserGroup(String groupName) {
return superUserGroups.contains(groupName);
}
public boolean isSuperUser(String userName, Collection<String>
userGroupNames) {
return superUsers.contains(userName) ||
(CollectionUtils.isNotEmpty(userGroupNames) &&
CollectionUtils.containsAny(superUserGroups, userGroupNames));
}
}
```
##########
security-admin/src/main/java/org/apache/ranger/biz/XUserMgr.java:
##########
@@ -1887,6 +1897,51 @@ public Set<String> getGroupsForUser(String userName) {
return ret;
}
+ /**
+ * Returns synced group names from Ranger DB (no API permission checks).
+ * For config super-user / super-group matching at login only.
+ *
+ * @param userName user login id
+ * @return group names from {@code x_group_users}
+ */
+ public Set<String> getSyncedGroupsForUser(final String userName) {
Review Comment:
Please rename: `getSyncedGroupsForUser()` => `getGroupsForUser()`, to avoid
possible confusion that this method is synchronized.
##########
security-admin/src/main/java/org/apache/ranger/biz/RangerBizUtil.java:
##########
@@ -1133,6 +1180,16 @@ public boolean isUserRangerAdmin(String username) {
return isAdmin;
}
+ /**
Review Comment:
This method, `RangerBizUtil.isSuperUser()` seems unused. Please remove if
unused.
##########
security-admin/src/main/java/org/apache/ranger/biz/RangerBizUtil.java:
##########
@@ -1117,13 +1129,48 @@ public boolean
isUserAllowedForGrantRevoke(RangerService rangerService, String u
return isUserInConfigParameter(rangerService,
ServiceREST.Allowed_User_List_For_Grant_Revoke, userName);
}
+ /**
+ * True when {@code username} is a full Ranger admin: DB sys/admin role,
+ * config super-user ({@code ranger.admin.super.users/groups}), or the
+ * current session is a Ranger admin ({@link
UserSessionBase#isUserAdmin()}).
+ */
public boolean isUserRangerAdmin(String username) {
+ if (StringUtils.isBlank(username)) {
+ return false;
+ }
+
+ UserSessionBase userSession = ContextUtil.getCurrentUserSession();
+
+ // Ranger admin on current session (DB sys admin or config super-user).
+ if (userSession != null
+ && username.equalsIgnoreCase(userSession.getLoginId())
+ && userSession.isUserAdmin()) {
+ return true;
+ }
+
+ // Config super-user when no session context (e.g. grantor checks).
+ if (RangerSuperUserConfig.isEnabled() && xUserMgr != null) {
Review Comment:
Looks like this can be further optimized:
```
final boolean configSuperUser;
if (RangerSuperUserConfig.isSuperUser(username)) {
configSuperUser = true;
} else if (RangerSuperUserConfig.isSuperGroupsConfigured() && xUserMgr !=
null) {
configSuperUser = RangerSuperUserConfig.isSuperUser(username,
xUserMgr.getSyncedGroupsForUser(username));
} else {
configSuperUser = false;
}
```
##########
security-admin/src/main/java/org/apache/ranger/biz/RoleDBStore.java:
##########
@@ -314,24 +313,31 @@ public RangerRoleList getRolesForUser(SearchFilter
filter, RangerRoleList ranger
List<RangerRole> roles;
UserSessionBase userSession = ContextUtil.getCurrentUserSession();
- if (userSession != null && userSession.getUserRoleList().size() == 1
&& userSession.getUserRoleList().contains(RangerConstants.ROLE_USER) &&
userSession.getLoginId() != null) {
- VXUser loggedInVXUser =
xUserService.getXUserByUserName(userSession.getLoginId());
- List<XXRole> xxRoles =
daoMgr.getXXRole().findByUserId(loggedInVXUser.getId());
+ // Plain ROLE_USER only; config super-users see all roles.
+ if (userSession != null && userSession.isSingleRoleUserSession()
Review Comment:
To improve readability, I suggest avoid breaking a statement into multiple
lines.
##########
security-admin/src/main/java/org/apache/ranger/biz/SessionMgr.java:
##########
@@ -556,6 +566,50 @@ private void setUserRoles(UserSessionBase userSession) {
userSession.setUserAdmin(false);
}
+ applyConfigSuperUserSessionFlags(userSession);
+
+ if (userSession.isSuperUser()) {
+ strRoleList =
RangerSuperUserConfig.mergeConfigSuperUserRoles(strRoleList, true);
+ }
+
userSession.setUserRoleList(strRoleList);
}
+
+ /**
+ * Applies config super-user session flag ({@code superUser}) when login
matches
+ * {@code ranger.admin.super.users} / super.groups.
+ */
+ private void applyConfigSuperUserSessionFlags(
+ final UserSessionBase userSession) {
+ if (userSession == null) {
Review Comment:
Consider keeping a single `return` statement per method, to keep consistency
with rest of code base.
```
if (userSession != null) {
String loginId = userSession.getLoginId();
final boolean isSuperUser;
if (StringUtils.isBlank(loginId)) {
isSuperUser = false;
} else if (!RangerSuperUserConfig.isEnabled()) {
isSuperUser = false;
} else if (RangerSuperUserConfig.isSuperUser(loginId)) {
isSuperUser = true;
} else if (RangerSuperUserConfig.isSuperGroupsConfigured()) {
isSuperUser = RangerSuperUserConfig.isSuperUser(loginId,
xUserMgr.getSyncedGroupsForUser(loginId));
} else {
isSuperUser = false;
}
if (isSuperUser) {
userSession.setSuperUser(true);
logger.info("Granted full admin privileges via config for user {}",
loginId);
} else {
userSession.setSuperUser(false);
}
}
```
##########
security-admin/src/main/java/org/apache/ranger/biz/RangerBizUtil.java:
##########
@@ -1117,13 +1129,48 @@ public boolean
isUserAllowedForGrantRevoke(RangerService rangerService, String u
return isUserInConfigParameter(rangerService,
ServiceREST.Allowed_User_List_For_Grant_Revoke, userName);
}
+ /**
+ * True when {@code username} is a full Ranger admin: DB sys/admin role,
+ * config super-user ({@code ranger.admin.super.users/groups}), or the
+ * current session is a Ranger admin ({@link
UserSessionBase#isUserAdmin()}).
+ */
public boolean isUserRangerAdmin(String username) {
+ if (StringUtils.isBlank(username)) {
+ return false;
+ }
+
+ UserSessionBase userSession = ContextUtil.getCurrentUserSession();
+
+ // Ranger admin on current session (DB sys admin or config super-user).
+ if (userSession != null
+ && username.equalsIgnoreCase(userSession.getLoginId())
+ && userSession.isUserAdmin()) {
+ return true;
+ }
+
+ // Config super-user when no session context (e.g. grantor checks).
+ if (RangerSuperUserConfig.isEnabled() && xUserMgr != null) {
+ final boolean configSuperUser;
+
+ if (RangerSuperUserConfig.isSuperGroupsConfigured()) {
+ configSuperUser = RangerSuperUserConfig.isSuperUser(username,
+ xUserMgr.getSyncedGroupsForUser(username));
+ } else {
+ configSuperUser = RangerSuperUserConfig.isSuperUser(username);
+ }
+
+ if (configSuperUser) {
+ return true;
+ }
+ }
+
boolean isAdmin = false;
try {
VXUser vxUser = xUserService.getXUserByUserName(username);
- if (vxUser != null &&
(vxUser.getUserRoleList().contains(RangerConstants.ROLE_ADMIN) ||
vxUser.getUserRoleList().contains(RangerConstants.ROLE_SYS_ADMIN))) {
+ if (vxUser != null &&
(vxUser.getUserRoleList().contains(RangerConstants.ROLE_ADMIN)
+ ||
vxUser.getUserRoleList().contains(RangerConstants.ROLE_SYS_ADMIN))) {
Review Comment:
I suggest avoiding updates that aren't related to this enhancement, like
this formating one - to make reviewing the code a little easier.
--
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]
