Skip to content

Strengthen scroll_id validation #22396

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

Merged
cwperks merged 1 commit into from
Jul 7, 2026
+27 −1
Merged

Strengthen scroll_id validation #22396

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
6 changes: 5 additions & 1 deletion server/src/main/java/org/opensearch/action/search/TransportSearchHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,11 @@ static ParsedScrollId parseScrollId(String scrollId) {
includeContextUUID = false;
type = firstChunk;
}
SearchContextIdForNode[] context = new SearchContextIdForNode[in.readVInt()];
int count = in.readVInt();
if (count < 0 || count > bytes.length) {
throw new IllegalArgumentException("Invalid scroll id");
}
SearchContextIdForNode[] context = new SearchContextIdForNode[count];
for (int i = 0; i < context.length; ++i) {
final String contextUUID = includeContextUUID ? in.readString() : "";
long id = in.readLong();
Expand Down
22 changes: 22 additions & 0 deletions server/src/test/java/org/opensearch/action/search/TransportSearchHelperTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@
import org.opensearch.test.OpenSearchTestCase;
import org.opensearch.test.VersionUtils;

import java.io.ByteArrayOutputStream;
import java.util.Base64;

import static org.hamcrest.Matchers.equalTo;

public class TransportSearchHelperTests extends OpenSearchTestCase {
Expand Down Expand Up @@ -92,4 +95,23 @@ public void testParseScrollId() {
assertEquals(42, parseScrollId.getContext()[2].getSearchContextId().getId());
assertThat(parseScrollId.getContext()[2].getSearchContextId().getSessionId(), equalTo("c"));
}

public void testParseScrollIdRejectsOversizedCount() throws Exception {
// Craft a scroll_id with a varint-encoded count far exceeding the payload size.
// This would previously cause an OOM by allocating a huge array.
ByteArrayOutputStream baos = new ByteArrayOutputStream();
// Write type string: length=1, char='q' (any valid type)
baos.write(1); // vint string length
baos.write('q');
// Write a massive vint count (Integer.MAX_VALUE encoded as 5-byte varint)
baos.write(0xFF);
baos.write(0xFF);
baos.write(0xFF);
baos.write(0xFF);
baos.write(0x07);
String scrollId = Base64.getUrlEncoder().encodeToString(baos.toByteArray());

IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> TransportSearchHelper.parseScrollId(scrollId));
assertEquals("Cannot parse scroll id", e.getMessage());
}
}
Loading