You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ranger.apache.org by vi...@apache.org on 2026/09/13 04:47:22 UTC

(ranger) branch master updated: RANGER-5792: Align to best practices for User rest API (#1230)

This is an automated email from the ASF dual-hosted git repository.

vikaskr22 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ranger.git


The following commit(s) were added to refs/heads/master by this push:
     new 1f37dfca1 RANGER-5792: Align to best practices for User rest API (#1230)
1f37dfca1 is described below

commit 1f37dfca164ccfbb5bd314c5bdd877ba0c702b8d
Author: Vikas Kumar <ta...@gmail.com>
AuthorDate: Sun Sep 13 10:17:16 2026 +0530

    RANGER-5792: Align to best practices for User rest API (#1230)
    
    * RANGER-5792: Align to best practices for User rest API
    
    * Update RangerBizUtil.java
    
    * RANGER-5792: Align to best practices for User rest API-Fix for review comments
    
    ---------
    
    Co-authored-by: Madhan Neethiraj <ma...@apache.org>
---
 .../main/java/org/apache/ranger/biz/RangerBizUtil.java  | 17 +++++++++--------
 .../src/main/java/org/apache/ranger/biz/UserMgr.java    |  4 ++--
 .../src/main/java/org/apache/ranger/biz/XUserMgr.java   | 16 ++++++++--------
 .../main/java/org/apache/ranger/common/StringUtil.java  |  9 +++++++++
 4 files changed, 28 insertions(+), 18 deletions(-)

diff --git a/security-admin/src/main/java/org/apache/ranger/biz/RangerBizUtil.java b/security-admin/src/main/java/org/apache/ranger/biz/RangerBizUtil.java
index 9219a86a1..75756e6dd 100644
--- a/security-admin/src/main/java/org/apache/ranger/biz/RangerBizUtil.java
+++ b/security-admin/src/main/java/org/apache/ranger/biz/RangerBizUtil.java
@@ -1063,20 +1063,21 @@ public boolean checkUserAccessible(VXUser vXUser) {
 
         boolean            isAccessible = true;
         Collection<String> roleList     = userMgr.getRolesByLoginId(vXUser.getName());
+        Collection<String> payloadRoles = vXUser.getUserRoleList();
 
         if (isKeyAdmin()) {
-            if (vXUser.getUserRoleList().contains(RangerConstants.ROLE_SYS_ADMIN)
-                    || vXUser.getUserRoleList().contains(RangerConstants.ROLE_ADMIN_AUDITOR)
-                    || roleList.contains(RangerConstants.ROLE_SYS_ADMIN)
-                    || roleList.contains(RangerConstants.ROLE_ADMIN_AUDITOR)) {
+            if (StringUtil.containsIgnoreCase(payloadRoles, RangerConstants.ROLE_SYS_ADMIN)
+                    || StringUtil.containsIgnoreCase(payloadRoles, RangerConstants.ROLE_ADMIN_AUDITOR)
+                    || StringUtil.containsIgnoreCase(roleList, RangerConstants.ROLE_SYS_ADMIN)
+                    || StringUtil.containsIgnoreCase(roleList, RangerConstants.ROLE_ADMIN_AUDITOR)) {
                 isAccessible = false;
             }
         }
         if (isAdmin()) {
-            if (vXUser.getUserRoleList().contains(RangerConstants.ROLE_KEY_ADMIN)
-                    || vXUser.getUserRoleList().contains(RangerConstants.ROLE_KEY_ADMIN_AUDITOR)
-                    || roleList.contains(RangerConstants.ROLE_KEY_ADMIN)
-                    || roleList.contains(RangerConstants.ROLE_KEY_ADMIN_AUDITOR)) {
+            if (StringUtil.containsIgnoreCase(payloadRoles, RangerConstants.ROLE_KEY_ADMIN)
+                    || StringUtil.containsIgnoreCase(payloadRoles, RangerConstants.ROLE_KEY_ADMIN_AUDITOR)
+                    || StringUtil.containsIgnoreCase(roleList, RangerConstants.ROLE_KEY_ADMIN)
+                    || StringUtil.containsIgnoreCase(roleList, RangerConstants.ROLE_KEY_ADMIN_AUDITOR)) {
                 isAccessible = false;
             }
         }
diff --git a/security-admin/src/main/java/org/apache/ranger/biz/UserMgr.java b/security-admin/src/main/java/org/apache/ranger/biz/UserMgr.java
index 722ab1437..63da869df 100644
--- a/security-admin/src/main/java/org/apache/ranger/biz/UserMgr.java
+++ b/security-admin/src/main/java/org/apache/ranger/biz/UserMgr.java
@@ -293,11 +293,11 @@ public boolean updateRoles(Long userId, Collection<String> rolesList) {
         List<String> stringRolesList = new ArrayList<>();
 
         for (String userRole : rolesList) {
-            if (!VALID_ROLE_LIST.contains(userRole.toUpperCase())) {
+            if (userRole == null || !VALID_ROLE_LIST.contains(userRole.trim().toUpperCase())) {
                 throw restErrorUtil.createRESTException("Invalid user role, please provide valid user role.", MessageEnums.INVALID_INPUT_DATA);
             }
 
-            stringRolesList.add(userRole);
+            stringRolesList.add(userRole.trim().toUpperCase());
         }
 
         xUserMgr.checkAccessRoles(stringRolesList);
diff --git a/security-admin/src/main/java/org/apache/ranger/biz/XUserMgr.java b/security-admin/src/main/java/org/apache/ranger/biz/XUserMgr.java
index fa014a10f..900d30398 100755
--- a/security-admin/src/main/java/org/apache/ranger/biz/XUserMgr.java
+++ b/security-admin/src/main/java/org/apache/ranger/biz/XUserMgr.java
@@ -2276,9 +2276,9 @@ public void checkAccessRoles(List<String> stringRolesList) {
                 throw restErrorUtil.create403RESTException("Permission denied. LoggedInUser=" + session.getXXPortalUser().getId() + " ,isn't permitted to perform the action.");
             } else {
                 if (!"rangerusersync".equals(session.getXXPortalUser().getLoginId())) { // new logic for rangerusersync user
-                    if (session.isUserAdmin() && (stringRolesList.contains(RangerConstants.ROLE_KEY_ADMIN) || stringRolesList.contains(RangerConstants.ROLE_KEY_ADMIN_AUDITOR))) {
+                    if (session.isUserAdmin() && (StringUtil.containsIgnoreCase(stringRolesList, RangerConstants.ROLE_KEY_ADMIN) || StringUtil.containsIgnoreCase(stringRolesList, RangerConstants.ROLE_KEY_ADMIN_AUDITOR))) {
                         throw restErrorUtil.create403RESTException("Permission denied. LoggedInUser=" + session.getXXPortalUser().getId() + " isn't permitted to perform the action.");
-                    } else if (session.isKeyAdmin() && (stringRolesList.contains(RangerConstants.ROLE_SYS_ADMIN) || stringRolesList.contains(RangerConstants.ROLE_ADMIN_AUDITOR))) {
+                    } else if (session.isKeyAdmin() && (StringUtil.containsIgnoreCase(stringRolesList, RangerConstants.ROLE_SYS_ADMIN) || StringUtil.containsIgnoreCase(stringRolesList, RangerConstants.ROLE_ADMIN_AUDITOR))) {
                         throw restErrorUtil.create403RESTException("Permission denied. LoggedInUser=" + session.getXXPortalUser().getId() + " isn't permitted to perform the action.");
                     }
                 }
@@ -3308,15 +3308,15 @@ private boolean hasAccessToGetUserInfo(VXUser requestedVXUser) {
             VXUser loggedInVXUser = xUserService.getXUserByUserName(userSession.getLoginId());
 
             if (requestedVXUser != null && CollectionUtils.isNotEmpty(requestedVXUser.getUserRoleList()) && loggedInVXUser != null && loggedInVXUser.getUserRoleList().size() == 1) {
-                if (loggedInVXUser.getUserRoleList().contains(RangerConstants.ROLE_USER)) {
+                if (StringUtil.containsIgnoreCase(loggedInVXUser.getUserRoleList(), RangerConstants.ROLE_USER)) {
                     return requestedVXUser.getId().equals(loggedInVXUser.getId());
-                } else if (loggedInVXUser.getUserRoleList().contains(RangerConstants.ROLE_KEY_ADMIN) || loggedInVXUser.getUserRoleList().contains(RangerConstants.ROLE_KEY_ADMIN_AUDITOR)) {
-                    return requestedVXUser.getUserRoleList().contains(RangerConstants.ROLE_KEY_ADMIN) || requestedVXUser.getUserRoleList().contains(RangerConstants.ROLE_KEY_ADMIN_AUDITOR) || requestedVXUser.getUserRoleList().contains(RangerConstants.ROLE_USER);
-                } else if (loggedInVXUser.getUserRoleList().contains(RangerConstants.ROLE_SYS_ADMIN) || loggedInVXUser.getUserRoleList().contains(RangerConstants.ROLE_ADMIN_AUDITOR)) {
-                    if (loggedInVXUser.getUserRoleList().contains(RangerConstants.ROLE_SYS_ADMIN) && "rangerusersync".equalsIgnoreCase(userSession.getLoginId())) {
+                } else if (StringUtil.containsIgnoreCase(loggedInVXUser.getUserRoleList(), RangerConstants.ROLE_KEY_ADMIN) || StringUtil.containsIgnoreCase(loggedInVXUser.getUserRoleList(), RangerConstants.ROLE_KEY_ADMIN_AUDITOR)) {
+                    return StringUtil.containsIgnoreCase(requestedVXUser.getUserRoleList(), RangerConstants.ROLE_KEY_ADMIN) || StringUtil.containsIgnoreCase(requestedVXUser.getUserRoleList(), RangerConstants.ROLE_KEY_ADMIN_AUDITOR) || StringUtil.containsIgnoreCase(requestedVXUser.getUserRoleList(), RangerConstants.ROLE_USER);
+                } else if (StringUtil.containsIgnoreCase(loggedInVXUser.getUserRoleList(), RangerConstants.ROLE_SYS_ADMIN) || StringUtil.containsIgnoreCase(loggedInVXUser.getUserRoleList(), RangerConstants.ROLE_ADMIN_AUDITOR)) {
+                    if (StringUtil.containsIgnoreCase(loggedInVXUser.getUserRoleList(), RangerConstants.ROLE_SYS_ADMIN) && "rangerusersync".equalsIgnoreCase(userSession.getLoginId())) {
                         return true;
                     } else {
-                        return requestedVXUser.getUserRoleList().contains(RangerConstants.ROLE_SYS_ADMIN) || requestedVXUser.getUserRoleList().contains(RangerConstants.ROLE_ADMIN_AUDITOR) || requestedVXUser.getUserRoleList().contains(RangerConstants.ROLE_USER);
+                        return StringUtil.containsIgnoreCase(requestedVXUser.getUserRoleList(), RangerConstants.ROLE_SYS_ADMIN) || StringUtil.containsIgnoreCase(requestedVXUser.getUserRoleList(), RangerConstants.ROLE_ADMIN_AUDITOR) || StringUtil.containsIgnoreCase(requestedVXUser.getUserRoleList(), RangerConstants.ROLE_USER);
                     }
                 }
             }
diff --git a/security-admin/src/main/java/org/apache/ranger/common/StringUtil.java b/security-admin/src/main/java/org/apache/ranger/common/StringUtil.java
index 87e100c3b..5eed0eedc 100644
--- a/security-admin/src/main/java/org/apache/ranger/common/StringUtil.java
+++ b/security-admin/src/main/java/org/apache/ranger/common/StringUtil.java
@@ -27,6 +27,7 @@
 import java.io.UnsupportedEncodingException;
 import java.net.URLEncoder;
 import java.nio.charset.StandardCharsets;
+import java.util.Collection;
 import java.util.HashMap;
 import java.util.List;
 import java.util.regex.Matcher;
@@ -70,6 +71,14 @@ public static String getUTFEncodedString(String username) throws UnsupportedEnco
         return URLEncoder.encode(username, StandardCharsets.UTF_8.toString());
     }
 
+    public static boolean containsIgnoreCase(Collection<String> values, String str) {
+        if (values != null && str != null) {
+            return values.stream().anyMatch(str::equalsIgnoreCase);
+        }
+
+        return false;
+    }
+
     /**
      * Checks if the string is null or empty string.
      *