You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ranger.apache.org by dh...@apache.org on 2026/09/11 11:37:45 UTC

(ranger) 01/01: RANGER-5787 : Refactoring the security zone API

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

dhavalshah9131 pushed a commit to branch ds_RANGER-5787
in repository https://gitbox.apache.org/repos/asf/ranger.git

commit 009dac4990a0913997c06e1bbecf03214013fe4f
Author: Dhaval Shah <dh...@gmail.com>
AuthorDate: Fri Sep 11 17:06:48 2026 +0530

    RANGER-5787 : Refactoring the security zone API
---
 .../org/apache/ranger/rest/SecurityZoneREST.java   |  50 +++++++-
 .../apache/ranger/rest/TestSecurityZoneREST.java   | 137 +++++++++++++++++++--
 2 files changed, 179 insertions(+), 8 deletions(-)

diff --git a/security-admin/src/main/java/org/apache/ranger/rest/SecurityZoneREST.java b/security-admin/src/main/java/org/apache/ranger/rest/SecurityZoneREST.java
index 0c04a7f90..3cea7a5f9 100644
--- a/security-admin/src/main/java/org/apache/ranger/rest/SecurityZoneREST.java
+++ b/security-admin/src/main/java/org/apache/ranger/rest/SecurityZoneREST.java
@@ -185,7 +185,7 @@ public RangerSecurityZone updateSecurityZone(@PathParam("id") Long zoneId, Range
         } else {
             securityZone.setId(zoneId);
         }
-
+        blockAdminFromKMSServiceOnUpdate(securityZone, zoneId);
         RangerSecurityZone ret;
 
         try {
@@ -219,6 +219,8 @@ public void deleteSecurityZone(@PathParam("name") String zoneName) {
         try {
             ensureAdminAccess();
 
+            blockAdminFromKMSServiceOnDelete(zoneName, null);
+
             RangerSecurityZoneValidator validator = validatorFactory.getSecurityZoneValidator(svcStore, securityZoneStore);
 
             validator.validate(zoneName, RangerValidator.Action.DELETE);
@@ -251,6 +253,8 @@ public void deleteSecurityZone(@PathParam("id") Long zoneId) {
         try {
             ensureAdminAccess();
 
+            blockAdminFromKMSServiceOnDelete(null, zoneId);
+
             RangerSecurityZoneValidator validator = validatorFactory.getSecurityZoneValidator(svcStore, securityZoneStore);
 
             validator.validate(zoneId, RangerValidator.Action.DELETE);
@@ -709,6 +713,50 @@ private void blockAdminFromKMSService(RangerSecurityZone securityZone) {
         }
     }
 
+    private void blockAdminFromKMSServiceOnUpdate(RangerSecurityZone submittedZone, Long zoneId) {
+        if (bizUtil.isAdmin()) {
+            blockAdminFromKMSService(submittedZone);
+
+            if (zoneId != null) {
+                RangerSecurityZone existingZone = null;
+
+                try {
+                    existingZone = securityZoneStore.getSecurityZone(zoneId);
+                } catch (WebApplicationException excp) {
+                    throw excp;
+                } catch (Exception ex) {
+                    LOG.error("Unable to get Security Zone with id : {}", zoneId, ex);
+
+                    throw restErrorUtil.createRESTException(ex.getMessage());
+                }
+
+                blockAdminFromKMSService(existingZone);
+            }
+        }
+    }
+
+    private void blockAdminFromKMSServiceOnDelete(String zoneName, Long zoneId) {
+        if (bizUtil.isAdmin()) {
+            RangerSecurityZone existingZone = null;
+
+            try {
+                if (zoneId != null) {
+                    existingZone = securityZoneStore.getSecurityZone(zoneId);
+                } else if (zoneName != null) {
+                    existingZone = securityZoneStore.getSecurityZoneByName(zoneName);
+                }
+            } catch (WebApplicationException excp) {
+                throw excp;
+            } catch (Exception ex) {
+                LOG.error("Unable to get Security Zone with id : {}, name : {}", zoneId, zoneName, ex);
+
+                throw restErrorUtil.createRESTException(ex.getMessage());
+            }
+
+            blockAdminFromKMSService(existingZone);
+        }
+    }
+
     private void removeEmptyEntries(RangerSecurityZone securityZone) {
         bizUtil.removeEmptyStrings(securityZone.getTagServices());
         bizUtil.removeEmptyStrings(securityZone.getAdminUsers());
diff --git a/security-admin/src/test/java/org/apache/ranger/rest/TestSecurityZoneREST.java b/security-admin/src/test/java/org/apache/ranger/rest/TestSecurityZoneREST.java
index c4c64d7d0..7b7c41845 100644
--- a/security-admin/src/test/java/org/apache/ranger/rest/TestSecurityZoneREST.java
+++ b/security-admin/src/test/java/org/apache/ranger/rest/TestSecurityZoneREST.java
@@ -39,6 +39,7 @@
 import org.apache.ranger.plugin.model.RangerSecurityZoneV2.RangerSecurityZoneChangeRequest;
 import org.apache.ranger.plugin.model.validation.RangerSecurityZoneValidator;
 import org.apache.ranger.plugin.model.validation.RangerValidator;
+import org.apache.ranger.plugin.store.EmbeddedServiceDefsUtil;
 import org.apache.ranger.plugin.store.PList;
 import org.apache.ranger.plugin.util.SearchFilter;
 import org.apache.ranger.service.RangerSecurityZoneServiceService;
@@ -224,6 +225,8 @@ public void testUpdateSecurityZone() throws Exception {
         XXServiceDefDao    xServiceDefDao             = Mockito.mock(XXServiceDefDao.class);
         rangerSecurityZoneToUpdate.setId(securityZoneId);
         when(rangerBizUtil.isAdmin()).thenReturn(true);
+        mockNonKmsServiceLookupForZoneCheck();
+        when(securityZoneStore.getSecurityZone(securityZoneId)).thenReturn(rangerSecurityZoneToUpdate);
         when(validatorFactory.getSecurityZoneValidator(svcStore, securityZoneStore)).thenReturn(validator);
 
         doNothing().when(validator).validate(rangerSecurityZoneToUpdate, RangerValidator.Action.UPDATE);
@@ -256,11 +259,10 @@ public void testUpdateSecurityZoneWithMisMatchId() throws Exception {
     public void testUpdateSecurityZoneOptimisticLockException() throws Exception {
         RangerSecurityZone rangerSecurityZoneToUpdate = createRangerSecurityZone();
         Long               securityZoneId             = 2L;
-        XXServiceDao       xServiceDao                = Mockito.mock(XXServiceDao.class);
-        XXService          xService                   = Mockito.mock(XXService.class);
-        XXServiceDefDao    xServiceDefDao             = Mockito.mock(XXServiceDefDao.class);
         rangerSecurityZoneToUpdate.setId(securityZoneId);
         when(rangerBizUtil.isAdmin()).thenReturn(true);
+        mockNonKmsServiceLookupForZoneCheck();
+        when(securityZoneStore.getSecurityZone(securityZoneId)).thenReturn(rangerSecurityZoneToUpdate);
         when(validatorFactory.getSecurityZoneValidator(svcStore, securityZoneStore)).thenReturn(validator);
 
         doNothing().when(validator).validate(rangerSecurityZoneToUpdate, RangerValidator.Action.UPDATE);
@@ -280,11 +282,10 @@ public void testUpdateSecurityZoneOptimisticLockException() throws Exception {
     public void testUpdateSecurityZoneException() throws Exception {
         RangerSecurityZone rangerSecurityZoneToUpdate = createRangerSecurityZone();
         Long               securityZoneId             = 2L;
-        XXServiceDao       xServiceDao                = Mockito.mock(XXServiceDao.class);
-        XXService          xService                   = Mockito.mock(XXService.class);
-        XXServiceDefDao    xServiceDefDao             = Mockito.mock(XXServiceDefDao.class);
         rangerSecurityZoneToUpdate.setId(securityZoneId);
         when(rangerBizUtil.isAdmin()).thenReturn(true);
+        mockNonKmsServiceLookupForZoneCheck();
+        when(securityZoneStore.getSecurityZone(securityZoneId)).thenReturn(rangerSecurityZoneToUpdate);
         when(validatorFactory.getSecurityZoneValidator(svcStore, securityZoneStore)).thenReturn(validator);
 
         doNothing().when(validator).validate(rangerSecurityZoneToUpdate, RangerValidator.Action.UPDATE);
@@ -300,6 +301,46 @@ public void testUpdateSecurityZoneException() throws Exception {
         verify(restErrorUtil).createRESTException(Mockito.anyString());
     }
 
+    @Test
+    void testUpdateSecurityZone_AdminBlockedFromKMSService() throws Exception {
+        Long               zoneId = 2L;
+        RangerSecurityZone zone   = createRangerSecurityZone();
+        zone.setId(zoneId);
+
+        Map<String, RangerSecurityZoneService> services = new HashMap<>();
+        services.put("dev_kms", new RangerSecurityZoneService());
+        zone.setServices(services);
+
+        when(rangerBizUtil.isAdmin()).thenReturn(true);
+        mockKmsServiceLookupForZoneCheck("dev_kms");
+
+        assertThrows(WebApplicationException.class, () -> securityZoneREST.updateSecurityZone(zoneId, zone));
+
+        verify(securityZoneStore, never()).updateSecurityZoneById(any());
+    }
+
+    @Test
+    void testUpdateSecurityZone_AdminBlockedWhenExistingZoneContainsKMSService() throws Exception {
+        Long               zoneId        = 2L;
+        RangerSecurityZone submittedZone = createRangerSecurityZone();
+        RangerSecurityZone existingZone  = createRangerSecurityZone();
+        submittedZone.setId(zoneId);
+        submittedZone.setServices(new HashMap<>());
+        existingZone.setId(zoneId);
+
+        Map<String, RangerSecurityZoneService> kmsServices = new HashMap<>();
+        kmsServices.put("dev_kms", new RangerSecurityZoneService());
+        existingZone.setServices(kmsServices);
+
+        when(rangerBizUtil.isAdmin()).thenReturn(true);
+        mockKmsServiceLookupForZoneCheck("dev_kms");
+        when(securityZoneStore.getSecurityZone(zoneId)).thenReturn(existingZone);
+
+        assertThrows(WebApplicationException.class, () -> securityZoneREST.updateSecurityZone(zoneId, submittedZone));
+
+        verify(securityZoneStore, never()).updateSecurityZoneById(any());
+    }
+
     @Test
     public void testUpdateUnzonedSecurityZone() throws Exception {
         RangerSecurityZone rangerSecurityZone = createRangerSecurityZone();
@@ -311,6 +352,25 @@ public void testUpdateUnzonedSecurityZone() throws Exception {
         verify(restErrorUtil).createRESTException("Cannot update unzoned zone");
     }
 
+    @Test
+    void testDeleteSecurityZoneById_AdminBlockedWhenZoneContainsKMSService() throws Exception {
+        Long               zoneId = 2L;
+        RangerSecurityZone zone   = createRangerSecurityZone();
+        zone.setId(zoneId);
+
+        Map<String, RangerSecurityZoneService> services = new HashMap<>();
+        services.put("dev_kms", new RangerSecurityZoneService());
+        zone.setServices(services);
+
+        when(rangerBizUtil.isAdmin()).thenReturn(true);
+        mockKmsServiceLookupForZoneCheck("dev_kms");
+        when(securityZoneStore.getSecurityZone(zoneId)).thenReturn(zone);
+
+        assertThrows(WebApplicationException.class, () -> securityZoneREST.deleteSecurityZone(zoneId));
+
+        verify(securityZoneStore, never()).deleteSecurityZoneById(anyLong());
+    }
+
     @Test
     public void testGetSecurityZoneById() throws Exception {
         RangerSecurityZone securityZone   = createRangerSecurityZone();
@@ -553,8 +613,12 @@ public void testDeleteUnzonedSecurityZone() throws Exception {
     @Test
     public void testDeleteSecurityZoneByIdOptimisticLockException() throws Exception {
         Long zoneId = 2L;
+        RangerSecurityZone zone   = createRangerSecurityZone();
+        zone.setId(zoneId);
 
         when(rangerBizUtil.isAdmin()).thenReturn(true);
+        mockNonKmsServiceLookupForZoneCheck();
+        when(securityZoneStore.getSecurityZone(zoneId)).thenReturn(zone);
         when(validatorFactory.getSecurityZoneValidator(svcStore, securityZoneStore)).thenReturn(validator);
         doNothing().when(validator).validate(zoneId, RangerValidator.Action.DELETE);
         Mockito.doThrow(new OptimisticLockException()).when(securityZoneStore).deleteSecurityZoneById(zoneId);
@@ -572,8 +636,12 @@ public void testDeleteSecurityZoneByIdOptimisticLockException() throws Exception
     @Test
     public void testDeleteSecurityZoneByIdException() throws Exception {
         Long zoneId = 2L;
+        RangerSecurityZone zone   = createRangerSecurityZone();
+        zone.setId(zoneId);
 
         when(rangerBizUtil.isAdmin()).thenReturn(true);
+        mockNonKmsServiceLookupForZoneCheck();
+        when(securityZoneStore.getSecurityZone(zoneId)).thenReturn(zone);
         when(validatorFactory.getSecurityZoneValidator(svcStore, securityZoneStore)).thenReturn(validator);
         doNothing().when(validator).validate(zoneId, RangerValidator.Action.DELETE);
         Mockito.doThrow(new RuntimeException("General exception")).when(securityZoneStore).deleteSecurityZoneById(zoneId);
@@ -611,12 +679,32 @@ public void testDeleteSecurityZoneByName() throws Exception {
         securityZone.setId(securityZoneId);
         String securityZoneName = securityZone.getName();
         when(rangerBizUtil.isAdmin()).thenReturn(true);
+        mockNonKmsServiceLookupForZoneCheck();
+        when(securityZoneStore.getSecurityZoneByName(securityZoneName)).thenReturn(securityZone);
         when(validatorFactory.getSecurityZoneValidator(svcStore, securityZoneStore)).thenReturn(validator);
         doNothing().when(validator).validate(securityZoneName, RangerValidator.Action.DELETE);
         securityZoneREST.deleteSecurityZone(securityZoneName);
         verify(securityZoneStore, times(1)).deleteSecurityZoneByName(securityZoneName);
     }
 
+    @Test
+    void testDeleteSecurityZoneByName_AdminBlockedWhenZoneContainsKMSService() throws Exception {
+        RangerSecurityZone zone     = createRangerSecurityZone();
+        String             zoneName = zone.getName();
+
+        Map<String, RangerSecurityZoneService> services = new HashMap<>();
+        services.put("dev_kms", new RangerSecurityZoneService());
+        zone.setServices(services);
+
+        when(rangerBizUtil.isAdmin()).thenReturn(true);
+        mockKmsServiceLookupForZoneCheck("dev_kms");
+        when(securityZoneStore.getSecurityZoneByName(zoneName)).thenReturn(zone);
+
+        assertThrows(WebApplicationException.class, () -> securityZoneREST.deleteSecurityZone(zoneName));
+
+        verify(securityZoneStore, never()).deleteSecurityZoneByName(anyString());
+    }
+
     @Test
     public void deleteSecurityZoneByName_AdminAccessDenied() throws Exception {
         String zoneName = "testZoneToDelete";
@@ -635,9 +723,13 @@ public void deleteSecurityZoneByName_AdminAccessDenied() throws Exception {
 
     @Test
     public void deleteSecurityZoneByNameOptimisticLockException() throws Exception {
-        String zoneName = "testZoneToDelete";
+        String             zoneName = "testZoneToDelete";
+        RangerSecurityZone zone     = createRangerSecurityZone();
+        zone.setName(zoneName);
 
         when(rangerBizUtil.isAdmin()).thenReturn(true);
+        mockNonKmsServiceLookupForZoneCheck();
+        when(securityZoneStore.getSecurityZoneByName(zoneName)).thenReturn(zone);
         when(validatorFactory.getSecurityZoneValidator(svcStore, securityZoneStore)).thenReturn(validator);
         Mockito.doNothing().when(validator).validate(Mockito.eq(zoneName), Mockito.eq(RangerValidator.Action.DELETE));
         Mockito.doThrow(new OptimisticLockException()).when(securityZoneStore).deleteSecurityZoneByName(zoneName);
@@ -1003,6 +1095,8 @@ public void testUpdateSecurityZoneWithChangeRequestException() throws Exception
         when(rangerBizUtil.hasModuleAccess(Mockito.anyString())).thenReturn(true);
         when(spySecurityZoneREST.getSecurityZone(zoneId)).thenReturn(existingZone);
         when(rangerBizUtil.isAdmin()).thenReturn(true);
+        mockNonKmsServiceLookupForZoneCheck();
+        when(securityZoneStore.getSecurityZone(zoneId)).thenReturn(existingZone);
         when(validatorFactory.getSecurityZoneValidator(svcStore, securityZoneStore)).thenReturn(validator);
         doNothing().when(validator).validate(any(RangerSecurityZone.class), any());
         when(securityZoneStore.updateSecurityZoneById(any(RangerSecurityZone.class))).thenThrow(new RuntimeException("General exception"));
@@ -1027,6 +1121,8 @@ public void testUpdateSecurityZoneWithChangeRequestWebException() throws Excepti
         when(rangerBizUtil.hasModuleAccess(Mockito.anyString())).thenReturn(true);
         when(spySecurityZoneREST.getSecurityZone(zoneId)).thenReturn(existingZone);
         when(rangerBizUtil.isAdmin()).thenReturn(true);
+        mockNonKmsServiceLookupForZoneCheck();
+        when(securityZoneStore.getSecurityZone(zoneId)).thenReturn(existingZone);
         when(validatorFactory.getSecurityZoneValidator(svcStore, securityZoneStore)).thenReturn(validator);
         doNothing().when(validator).validate(any(RangerSecurityZone.class), any());
         when(securityZoneStore.updateSecurityZoneById(any(RangerSecurityZone.class))).thenThrow(new WebApplicationException());
@@ -1290,6 +1386,33 @@ public void testUpdateSecurityZoneWithChangeRequest_GetSecurityZoneWebException(
         });
     }
 
+    private void mockNonKmsServiceLookupForZoneCheck() {
+        XXServiceDao    xServiceDao    = Mockito.mock(XXServiceDao.class);
+        XXService       xService       = Mockito.mock(XXService.class);
+        XXServiceDefDao xServiceDefDao = Mockito.mock(XXServiceDefDao.class);
+
+        when(daoManager.getXXService()).thenReturn(xServiceDao);
+        when(xServiceDao.findByName("test_service_1")).thenReturn(xService);
+        when(daoManager.getXXServiceDef()).thenReturn(xServiceDefDao);
+        when(xServiceDefDao.getById(xService.getType())).thenReturn(xServiceDef);
+    }
+
+    private void mockKmsServiceLookupForZoneCheck(String kmsServiceName) {
+        XXServiceDao    xServiceDao    = Mockito.mock(XXServiceDao.class);
+        XXService       xService       = Mockito.mock(XXService.class);
+        XXServiceDefDao xServiceDefDao = Mockito.mock(XXServiceDefDao.class);
+        XXServiceDef    kmsServiceDef  = Mockito.mock(XXServiceDef.class);
+
+        when(daoManager.getXXService()).thenReturn(xServiceDao);
+        when(xServiceDao.findByName(kmsServiceName)).thenReturn(xService);
+        when(daoManager.getXXServiceDef()).thenReturn(xServiceDefDao);
+        when(xServiceDefDao.getById(xService.getType())).thenReturn(kmsServiceDef);
+        when(kmsServiceDef.getImplclassname()).thenReturn(EmbeddedServiceDefsUtil.KMS_IMPL_CLASS_NAME);
+        when(restErrorUtil.createRESTException(
+                eq("KMS Services/Service-Defs are not accessible for Zone operations"),
+                eq(MessageEnums.OPER_NOT_ALLOWED_FOR_ENTITY))).thenReturn(new WebApplicationException());
+    }
+
     private RangerSecurityZone createRangerSecurityZone() {
         String       testZone1              = "testzone1";
         List<String> testZone1ResoursesList = new ArrayList(Arrays.asList("/path/to/resource1", "/path/to/resource2"));