Skip to content

Pipe: Add upper bound check for Pipe request decompression buffer #15699

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
SteveYurongSu merged 12 commits into from
Jun 23, 2025
Merged

Pipe: Add upper bound check for Pipe request decompression buffer #15699

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
df5f94b
limit decompressed buffer size
XNX02 Jun 8, 2025
50804e8
update
XNX02 Jun 11, 2025
e74a444
update
XNX02 Jun 11, 2025
8a14089
update
XNX02 Jun 11, 2025
59ad1b0
fix
XNX02 Jun 11, 2025
f678a4e
fix
XNX02 Jun 11, 2025
ead6f2d
fix
XNX02 Jun 11, 2025
9bac0a2
Merge branch 'master' of https://github.com/apache/iotdb into compres…
XNX02 Jun 16, 2025
1003f3c
fix
XNX02 Jun 18, 2025
4d86858
hot reload config
XNX02 Jun 19, 2025
2737b61
Update PipeTransferCompressedReq.java
SteveYurongSu Jun 19, 2025
81b04a0
Merge branch 'master' of https://github.com/apache/iotdb into pr/15699
SteveYurongSu Jun 19, 2025
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
18 changes: 18 additions & 0 deletions iotdb-core/node-commons/src/main/java/org/apache/iotdb/commons/conf/CommonConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,8 @@ public class CommonConfig {
private long pipeReceiverLoginPeriodicVerificationIntervalMs = 300000;
private double pipeReceiverActualToEstimatedMemoryRatio = 3;

private int pipeReceiverReqDecompressedMaxLengthInBytes = 1073741824; // 1GB

private int pipeMaxAllowedHistoricalTsFilePerDataRegion = Integer.MAX_VALUE; // Deprecated
private int pipeMaxAllowedPendingTsFileEpochPerDataRegion = Integer.MAX_VALUE; // Deprecated
private int pipeMaxAllowedPinnedMemTableCount = Integer.MAX_VALUE; // per data region
Expand Down Expand Up @@ -1466,6 +1468,22 @@ public double getPipeReceiverActualToEstimatedMemoryRatio() {
return pipeReceiverActualToEstimatedMemoryRatio;
}

public void setPipeReceiverReqDecompressedMaxLengthInBytes(
int pipeReceiverReqDecompressedMaxLengthInBytes) {
if (this.pipeReceiverReqDecompressedMaxLengthInBytes
== pipeReceiverReqDecompressedMaxLengthInBytes) {
return;
}
this.pipeReceiverReqDecompressedMaxLengthInBytes = pipeReceiverReqDecompressedMaxLengthInBytes;
logger.info(
"pipeReceiverReqDecompressedMaxLengthInBytes is set to {}.",
pipeReceiverReqDecompressedMaxLengthInBytes);
}

public int getPipeReceiverReqDecompressedMaxLengthInBytes() {
return pipeReceiverReqDecompressedMaxLengthInBytes;
}

public int getPipeMaxAllowedHistoricalTsFilePerDataRegion() {
return pipeMaxAllowedHistoricalTsFilePerDataRegion;
}
Expand Down
7 changes: 7 additions & 0 deletions iotdb-core/node-commons/src/main/java/org/apache/iotdb/commons/pipe/config/PipeConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,10 @@ public double getPipeReceiverActualToEstimatedMemoryRatio() {
return COMMON_CONFIG.getPipeReceiverActualToEstimatedMemoryRatio();
}

public int getPipeReceiverReqDecompressedMaxLengthInBytes() {
return COMMON_CONFIG.getPipeReceiverReqDecompressedMaxLengthInBytes();
}

/////////////////////////////// Hybrid Mode ///////////////////////////////

public int getPipeMaxAllowedHistoricalTsFilePerDataRegion() {
Expand Down Expand Up @@ -617,6 +621,9 @@ public void printAllConfigs() {
LOGGER.info(
"PipeReceiverActualToEstimatedMemoryRatio: {}",
getPipeReceiverActualToEstimatedMemoryRatio());
LOGGER.info(
"PipeReceiverReqDecompressedMaxLengthInBytes: {}",
getPipeReceiverReqDecompressedMaxLengthInBytes());

LOGGER.info(
"PipeMaxAllowedHistoricalTsFilePerDataRegion: {}",
Expand Down
5 changes: 5 additions & 0 deletions ...-core/node-commons/src/main/java/org/apache/iotdb/commons/pipe/config/PipeDescriptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -435,6 +435,11 @@ public static void loadPipeInternalConfig(CommonConfig config, TrimProperties pr
properties.getProperty(
"pipe_receiver_actual_to_estimated_memory_ratio",
Double.toString(config.getPipeReceiverActualToEstimatedMemoryRatio()))));
config.setPipeReceiverReqDecompressedMaxLengthInBytes(
Integer.parseInt(
properties.getProperty(
"pipe_receiver_req_decompressed_max_length_in_bytes",
String.valueOf(config.getPipeReceiverReqDecompressedMaxLengthInBytes()))));

config.setPipeMaxAllowedHistoricalTsFilePerDataRegion(
Integer.parseInt(
Expand Down
16 changes: 16 additions & 0 deletions ...apache/iotdb/commons/pipe/connector/payload/thrift/request/PipeTransferCompressedReq.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

package org.apache.iotdb.commons.pipe.connector.payload.thrift.request;

import org.apache.iotdb.commons.pipe.config.PipeConfig;
import org.apache.iotdb.commons.pipe.connector.compressor.PipeCompressor;
import org.apache.iotdb.commons.pipe.connector.compressor.PipeCompressorFactory;
import org.apache.iotdb.service.rpc.thrift.TPipeTransferReq;
Expand All @@ -36,6 +37,9 @@

public class PipeTransferCompressedReq extends TPipeTransferReq {

private static final int MAX_DECOMPRESSED_LENGTH =
PipeConfig.getInstance().getPipeReceiverReqDecompressedMaxLengthInBytes();

/** Generate a compressed req with provided compressors. */
public static TPipeTransferReq toTPipeTransferReq(
final TPipeTransferReq originalReq, final List<PipeCompressor> compressors)
Expand Down Expand Up @@ -91,6 +95,7 @@ public static TPipeTransferReq fromTPipeTransferReq(final TPipeTransferReq trans
compressors.add(
PipeCompressorFactory.getCompressor(ReadWriteIOUtils.readByte(compressedBuffer)));
uncompressedLengths.add(ReadWriteIOUtils.readInt(compressedBuffer));
checkDecompressedLength(uncompressedLengths.get(i));
}

byte[] body = new byte[compressedBuffer.remaining()];
Expand Down Expand Up @@ -144,6 +149,17 @@ public static byte[] toTPipeTransferReqBytes(
}
}

/** This method is used to prevent decompression bomb attacks. */
private static void checkDecompressedLength(final int decompressedLength)
throws IllegalArgumentException {
if (decompressedLength < 0 || decompressedLength > MAX_DECOMPRESSED_LENGTH) {
Comment thread
SteveYurongSu marked this conversation as resolved.
Outdated
throw new IllegalArgumentException(
String.format(
"Decompressed length should be between 0 and %d, but got %d.",
MAX_DECOMPRESSED_LENGTH, decompressedLength));
}
}

private PipeTransferCompressedReq() {
// Empty constructor
}
Expand Down
Loading