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

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


The following commit(s) were added to refs/heads/master by this push:
     new 5defed4038e HIVE-28540: Special characters in user DN escaped when 
querying LDAP (#5472) (Zoltan Ratkai reviewed by Denys Kuzmenko)
5defed4038e is described below

commit 5defed4038e8f41a5016d6f961ac67f33f08c34a
Author: Zoltan Ratkai <[email protected]>
AuthorDate: Tue Oct 8 10:11:28 2024 +0200

    HIVE-28540: Special characters in user DN escaped when querying LDAP 
(#5472) (Zoltan Ratkai reviewed by Denys Kuzmenko)
---
 pom.xml                                            |  1 +
 service/pom.xml                                    |  5 ++
 .../apache/hive/service/auth/ldap/LdapSearch.java  |  5 +-
 .../hive/service/auth/ldap/TestLdapSearch.java     | 52 +++++++++++++++++++++
 standalone-metastore/metastore-common/pom.xml      |  5 ++
 .../hadoop/hive/metastore/ldap/LdapSearch.java     |  5 +-
 .../hadoop/hive/metastore/ldap/TestLdapSearch.java | 53 ++++++++++++++++++++++
 standalone-metastore/pom.xml                       |  1 +
 8 files changed, 125 insertions(+), 2 deletions(-)

diff --git a/pom.xml b/pom.xml
index 7857427424b..4093992a03b 100644
--- a/pom.xml
+++ b/pom.xml
@@ -229,6 +229,7 @@
     <jansi.version>2.4.0</jansi.version>
     <!-- If upgrading, upgrade atlas as well in ql/pom.xml, which brings in 
some springframework dependencies transitively -->
     <spring.version>5.3.21</spring.version>
+    <spring.ldap.version>2.4.1</spring.ldap.version>
     
<project.build.outputTimestamp>2024-01-01T00:00:00Z</project.build.outputTimestamp>
   </properties>
   <repositories>
diff --git a/service/pom.xml b/service/pom.xml
index 3bff1ab5ab6..f689feeae0d 100644
--- a/service/pom.xml
+++ b/service/pom.xml
@@ -231,6 +231,11 @@
       <groupId>org.springframework</groupId>
       <artifactId>spring-core</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.springframework.ldap</groupId>
+      <artifactId>spring-ldap-core</artifactId>
+      <version>${spring.ldap.version}</version>
+    </dependency>
     <dependency>
       <groupId>org.jamon</groupId>
       <artifactId>jamon-runtime</artifactId>
diff --git a/service/src/java/org/apache/hive/service/auth/ldap/LdapSearch.java 
b/service/src/java/org/apache/hive/service/auth/ldap/LdapSearch.java
index 2b5ca940cfc..2e8eaa495f8 100644
--- a/service/src/java/org/apache/hive/service/auth/ldap/LdapSearch.java
+++ b/service/src/java/org/apache/hive/service/auth/ldap/LdapSearch.java
@@ -21,6 +21,7 @@ import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
+import java.util.regex.Matcher;
 import javax.naming.NamingEnumeration;
 import javax.naming.NamingException;
 import javax.naming.directory.DirContext;
@@ -29,6 +30,7 @@ import javax.naming.directory.SearchResult;
 import org.apache.hadoop.hive.conf.HiveConf;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.springframework.ldap.support.LdapEncoder;
 
 /**
  * Implements search for LDAP.
@@ -180,7 +182,8 @@ public final class LdapSearch implements DirSearch {
    */
   @Override
   public List<String> executeUserAndGroupFilterQuery(String user, String 
userDn, String groupSearchFilter, String groupBaseDn) throws NamingException {
-    Query query = queries.findDnByUserAndGroupSearch(user, userDn, 
groupSearchFilter);
+    String userDnTransformed = 
Matcher.quoteReplacement(LdapEncoder.filterEncode(userDn));
+    Query query = queries.findDnByUserAndGroupSearch(user, userDnTransformed, 
groupSearchFilter);
     return execute(Collections.singletonList(groupBaseDn), 
query).getAllLdapNames();
   }
 
diff --git 
a/service/src/test/org/apache/hive/service/auth/ldap/TestLdapSearch.java 
b/service/src/test/org/apache/hive/service/auth/ldap/TestLdapSearch.java
index 78cba2ac55c..145ba771be7 100644
--- a/service/src/test/org/apache/hive/service/auth/ldap/TestLdapSearch.java
+++ b/service/src/test/org/apache/hive/service/auth/ldap/TestLdapSearch.java
@@ -290,4 +290,56 @@ public class TestLdapSearch {
     assertTrue(search.isUserMemberOfGroup("CN=User1,OU=org1,DC=foo,DC=bar", 
"grp1"));
     assertFalse(search.isUserMemberOfGroup("CN=User2,OU=org1,DC=foo,DC=bar", 
"grp2"));
   }
+  @Test
+  public void testExecuteUserAndGroupFilterQueryWithSpecialCharacter() throws 
NamingException {
+    final String groupSearchFilter = "member=CN={0},OU=org1,DC=foo,DC=bar";
+    final String groupBaseDn = "dc=example,dc=com";
+    NamingEnumeration<SearchResult> validResult1 = 
LdapTestUtils.mockNamingEnumeration("Test User 1");
+    NamingEnumeration<SearchResult> validResult2 = 
LdapTestUtils.mockNamingEnumeration("Test User 2");
+    NamingEnumeration<SearchResult> validResult3 = 
LdapTestUtils.mockNamingEnumeration("Test User 3");
+    NamingEnumeration<SearchResult> validResult4 = 
LdapTestUtils.mockNamingEnumeration("Test User 4");
+    NamingEnumeration<SearchResult> validResult5 = 
LdapTestUtils.mockNamingEnumeration("Test User 5");
+
+    when(ctx.search(anyString(), contains("member=CN=Test \\5c 
User,OU=org1,DC=foo,DC=bar,OU=org1,DC=foo,DC=bar"),
+        any(SearchControls.class))).thenReturn(validResult1);
+    when(ctx.search(anyString(), contains("member=CN=Test \\2a 
User,OU=org1,DC=foo,DC=bar,OU=org1,DC=foo,DC=bar"),
+        any(SearchControls.class))).thenReturn(validResult2);
+    when(ctx.search(anyString(), contains("member=CN=Test \\28 
User,OU=org1,DC=foo,DC=bar,OU=org1,DC=foo,DC=bar"),
+        any(SearchControls.class))).thenReturn(validResult3);
+    when(ctx.search(anyString(), contains("member=CN=Test \\29 
User,OU=org1,DC=foo,DC=bar,OU=org1,DC=foo,DC=bar"),
+        any(SearchControls.class))).thenReturn(validResult4);
+    when(ctx.search(anyString(), contains("member=CN=Test \\00 
User,OU=org1,DC=foo,DC=bar,OU=org1,DC=foo,DC=bar"),
+        any(SearchControls.class))).thenReturn(validResult5);
+    search = new LdapSearch(conf, ctx);
+
+    // contains \
+    List<String> result = search.executeUserAndGroupFilterQuery("Test , User", 
"Test \\ User,OU=org1,DC=foo,DC=bar",
+        groupSearchFilter, groupBaseDn);
+    assertEquals(1, result.size());
+    assertEquals("Test User 1", result.get(0));
+
+    //contains *
+    result = search.executeUserAndGroupFilterQuery("Test , User", "Test * 
User,OU=org1,DC=foo,DC=bar",
+        groupSearchFilter, groupBaseDn);
+    assertEquals(1, result.size());
+    assertEquals("Test User 2", result.get(0));
+
+    //contains (
+    result = search.executeUserAndGroupFilterQuery("Test , User", "Test ( 
User,OU=org1,DC=foo,DC=bar",
+        groupSearchFilter, groupBaseDn);
+    assertEquals(1, result.size());
+    assertEquals("Test User 3", result.get(0));
+
+    //contains )
+    result = search.executeUserAndGroupFilterQuery("Test , User", "Test ) 
User,OU=org1,DC=foo,DC=bar",
+        groupSearchFilter, groupBaseDn);
+    assertEquals(1, result.size());
+    assertEquals("Test User 4", result.get(0));
+
+    //contains � 
+    result = search.executeUserAndGroupFilterQuery("Test , User", "Test \000 
User,OU=org1,DC=foo,DC=bar",
+        groupSearchFilter, groupBaseDn);
+    assertEquals(1, result.size());
+    assertEquals("Test User 5", result.get(0));
+  }
 }
diff --git a/standalone-metastore/metastore-common/pom.xml 
b/standalone-metastore/metastore-common/pom.xml
index 8ff828018ff..a4455fc9fc1 100644
--- a/standalone-metastore/metastore-common/pom.xml
+++ b/standalone-metastore/metastore-common/pom.xml
@@ -311,6 +311,11 @@
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-api</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.springframework.ldap</groupId>
+      <artifactId>spring-ldap-core</artifactId>
+      <version>${spring.ldap.version}</version>
+    </dependency>
     <!-- test scope dependencies -->
     <dependency>
       <groupId>junit</groupId>
diff --git 
a/standalone-metastore/metastore-common/src/main/java/org/apache/hadoop/hive/metastore/ldap/LdapSearch.java
 
b/standalone-metastore/metastore-common/src/main/java/org/apache/hadoop/hive/metastore/ldap/LdapSearch.java
index 775127457ef..fbb418ed6c0 100644
--- 
a/standalone-metastore/metastore-common/src/main/java/org/apache/hadoop/hive/metastore/ldap/LdapSearch.java
+++ 
b/standalone-metastore/metastore-common/src/main/java/org/apache/hadoop/hive/metastore/ldap/LdapSearch.java
@@ -21,6 +21,7 @@ import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
+import java.util.regex.Matcher;
 import javax.naming.NamingEnumeration;
 import javax.naming.NamingException;
 import javax.naming.directory.DirContext;
@@ -30,6 +31,7 @@ import org.apache.hadoop.conf.Configuration;
 import org.apache.hadoop.hive.metastore.conf.MetastoreConf;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.springframework.ldap.support.LdapEncoder;
 
 /**
  * Implements search for LDAP.
@@ -181,7 +183,8 @@ public final class LdapSearch implements DirSearch {
    */
   @Override
   public List<String> executeUserAndGroupFilterQuery(String user, String 
userDn, String groupSearchFilter, String groupBaseDn) throws NamingException {
-    Query query = queries.findDnByUserAndGroupSearch(user, userDn, 
groupSearchFilter);
+    String userDnTransformed = 
Matcher.quoteReplacement(LdapEncoder.filterEncode(userDn));
+    Query query = queries.findDnByUserAndGroupSearch(user, userDnTransformed, 
groupSearchFilter);
     return execute(Collections.singletonList(groupBaseDn), 
query).getAllLdapNames();
   }
 
diff --git 
a/standalone-metastore/metastore-server/src/test/java/org/apache/hadoop/hive/metastore/ldap/TestLdapSearch.java
 
b/standalone-metastore/metastore-server/src/test/java/org/apache/hadoop/hive/metastore/ldap/TestLdapSearch.java
index 92aef8c25e6..fef7fcd1797 100644
--- 
a/standalone-metastore/metastore-server/src/test/java/org/apache/hadoop/hive/metastore/ldap/TestLdapSearch.java
+++ 
b/standalone-metastore/metastore-server/src/test/java/org/apache/hadoop/hive/metastore/ldap/TestLdapSearch.java
@@ -292,4 +292,57 @@ public class TestLdapSearch {
     assertTrue(search.isUserMemberOfGroup("CN=User1,OU=org1,DC=foo,DC=bar", 
"grp1"));
     assertFalse(search.isUserMemberOfGroup("CN=User2,OU=org1,DC=foo,DC=bar", 
"grp2"));
   }
+
+  @Test
+  public void testExecuteUserAndGroupFilterQueryWithSpecialCharacter() throws 
NamingException {
+    final String groupSearchFilter = "member=CN={0},OU=org1,DC=foo,DC=bar";
+    final String groupBaseDn = "dc=example,dc=com";
+    NamingEnumeration<SearchResult> validResult1 = 
LdapTestUtils.mockNamingEnumeration("Test User 1");
+    NamingEnumeration<SearchResult> validResult2 = 
LdapTestUtils.mockNamingEnumeration("Test User 2");
+    NamingEnumeration<SearchResult> validResult3 = 
LdapTestUtils.mockNamingEnumeration("Test User 3");
+    NamingEnumeration<SearchResult> validResult4 = 
LdapTestUtils.mockNamingEnumeration("Test User 4");
+    NamingEnumeration<SearchResult> validResult5 = 
LdapTestUtils.mockNamingEnumeration("Test User 5");
+
+    when(ctx.search(anyString(), contains("member=CN=Test \\5c 
User,OU=org1,DC=foo,DC=bar,OU=org1,DC=foo,DC=bar"),
+        any(SearchControls.class))).thenReturn(validResult1);
+    when(ctx.search(anyString(), contains("member=CN=Test \\2a 
User,OU=org1,DC=foo,DC=bar,OU=org1,DC=foo,DC=bar"),
+        any(SearchControls.class))).thenReturn(validResult2);
+    when(ctx.search(anyString(), contains("member=CN=Test \\28 
User,OU=org1,DC=foo,DC=bar,OU=org1,DC=foo,DC=bar"),
+        any(SearchControls.class))).thenReturn(validResult3);
+    when(ctx.search(anyString(), contains("member=CN=Test \\29 
User,OU=org1,DC=foo,DC=bar,OU=org1,DC=foo,DC=bar"),
+        any(SearchControls.class))).thenReturn(validResult4);
+    when(ctx.search(anyString(), contains("member=CN=Test \\00 
User,OU=org1,DC=foo,DC=bar,OU=org1,DC=foo,DC=bar"),
+        any(SearchControls.class))).thenReturn(validResult5);
+    search = new LdapSearch(conf, ctx);
+
+    // contains \
+    List<String> result = search.executeUserAndGroupFilterQuery("Test , User", 
"Test \\ User,OU=org1,DC=foo,DC=bar",
+        groupSearchFilter, groupBaseDn);
+    assertEquals(1, result.size());
+    assertEquals("Test User 1", result.get(0));
+
+    //contains *
+    result = search.executeUserAndGroupFilterQuery("Test , User", "Test * 
User,OU=org1,DC=foo,DC=bar",
+        groupSearchFilter, groupBaseDn);
+    assertEquals(1, result.size());
+    assertEquals("Test User 2", result.get(0));
+
+    //contains (
+    result = search.executeUserAndGroupFilterQuery("Test , User", "Test ( 
User,OU=org1,DC=foo,DC=bar",
+        groupSearchFilter, groupBaseDn);
+    assertEquals(1, result.size());
+    assertEquals("Test User 3", result.get(0));
+
+    //contains )
+    result = search.executeUserAndGroupFilterQuery("Test , User", "Test ) 
User,OU=org1,DC=foo,DC=bar",
+        groupSearchFilter, groupBaseDn);
+    assertEquals(1, result.size());
+    assertEquals("Test User 4", result.get(0));
+
+    //contains  \ 000
+    result = search.executeUserAndGroupFilterQuery("Test , User", "Test \000 
User,OU=org1,DC=foo,DC=bar",
+        groupSearchFilter, groupBaseDn);
+    assertEquals(1, result.size());
+    assertEquals("Test User 5", result.get(0));
+  }
 }
diff --git a/standalone-metastore/pom.xml b/standalone-metastore/pom.xml
index 1abd1079762..6d4eba24998 100644
--- a/standalone-metastore/pom.xml
+++ b/standalone-metastore/pom.xml
@@ -114,6 +114,7 @@
     <javax.annotation-api.version>1.3.2</javax.annotation-api.version>
     <!-- If upgrading, upgrade atlas as well in ql/pom.xml, which brings in 
some springframework dependencies transitively -->
     <spring.version>5.3.21</spring.version>
+    <spring.ldap.version>2.4.1</spring.ldap.version>
     <!-- Thrift properties -->
     <thrift.home>you-must-set-this-to-run-thrift</thrift.home>
     <thrift.gen.dir>${basedir}/src/gen/thrift</thrift.gen.dir>

Reply via email to