Skip to content

[MINOR][CORE][3.5] Avoid accidental collisions in SHS using LevelDB #58616

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
holdenk wants to merge 1 commit into from
Closed

[MINOR][CORE][3.5] Avoid accidental collisions in SHS using LevelDB #58616

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions common/kvstore/src/main/java/org/apache/spark/util/kvstore/LevelDBTypeInfo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -461,6 +461,15 @@ byte[] toKey(Object value, byte prefix) {

if (value instanceof String) {
byte[] str = ((String) value).getBytes(UTF_8);
for (byte b : str) {
if (b == KEY_SEPARATOR) {
// String bytes are copied verbatim into the key, so an embedded key
// separator would corrupt the index key structure and mix entries across
// range scans and deletes. Reject such values outright.
throw new IllegalArgumentException(
"Index string values cannot contain the key separator (0x00) byte.");
}
}
result = new byte[str.length + 1];
result[0] = prefix;
System.arraycopy(str, 0, result, 1, str.length);
Expand Down
9 changes: 9 additions & 0 deletions common/kvstore/src/main/java/org/apache/spark/util/kvstore/RocksDBTypeInfo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -463,6 +463,15 @@ byte[] toKey(Object value, byte prefix) {

if (value instanceof String) {
byte[] str = ((String) value).getBytes(UTF_8);
for (byte b : str) {
if (b == KEY_SEPARATOR) {
// String bytes are copied verbatim into the key, so an embedded key
// separator would corrupt the index key structure and mix entries across
// range scans and deletes. Reject such values outright.
throw new IllegalArgumentException(
"Index string values cannot contain the key separator (0x00) byte.");
}
}
result = new byte[str.length + 1];
result[0] = prefix;
System.arraycopy(str, 0, result, 1, str.length);
Expand Down
8 changes: 8 additions & 0 deletions common/kvstore/src/test/java/org/apache/spark/util/kvstore/LevelDBTypeInfoSuite.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,4 +210,12 @@ public String id(boolean illegalParam) {

}


@Test
public void testStringValuesRejectKeySeparator() throws Exception {
LevelDBTypeInfo.Index idx = newTypeInfo(CustomType1.class).indices().iterator().next();
assertThrows(IllegalArgumentException.class, () -> idx.toKey("key\u0000suffix"));
assertThrows(IllegalArgumentException.class,
() -> idx.toKey(new String[] { "ok", "bad\u0000" }));
}
}
8 changes: 8 additions & 0 deletions common/kvstore/src/test/java/org/apache/spark/util/kvstore/RocksDBTypeInfoSuite.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,4 +210,12 @@ public String id(boolean illegalParam) {

}


@Test
public void testStringValuesRejectKeySeparator() throws Exception {
RocksDBTypeInfo.Index idx = newTypeInfo(CustomType1.class).indices().iterator().next();
assertThrows(IllegalArgumentException.class, () -> idx.toKey("key\u0000suffix"));
assertThrows(IllegalArgumentException.class,
() -> idx.toKey(new String[] { "ok", "bad\u0000" }));
}
}