Merge pull request #6271 from waynercheung/feat/harden_filters

feat(jsonrpc): check maxSubTopics and maxBlockRange to be consistent with eth

Author: CodeNinjaEvan

common/src/main/java/org/tron/common/parameter/CommonParameter.java

@@ -8,9 +8,9 @@
 import java.util.Set;
 import lombok.Getter;
 import lombok.Setter;
-import org.tron.common.cron.CronExpression;
 import org.tron.common.args.GenesisBlock;
 import org.tron.common.config.DbBackupConfig;
+import org.tron.common.cron.CronExpression;
 import org.tron.common.logsfilter.EventPluginConfig;
 import org.tron.common.logsfilter.FilterQuery;
 import org.tron.common.setting.RocksDbSettings;
@@ -495,6 +495,13 @@ public class CommonParameter {
   @Getter
   @Setter
   public boolean jsonRpcHttpPBFTNodeEnable = false;
+  @Getter
+  @Setter
+  public int jsonRpcMaxBlockRange = 5000;
+  @Getter
+  @Setter
+  public int jsonRpcMaxSubTopics = 1000;
+
   @Getter
   @Setter
   public int maxTransactionPendingSize;

common/src/main/java/org/tron/common/utils/ByteUtil.java

@@ -479,40 +479,41 @@ public static byte[] setBit(byte[] data, int pos, int val) {
 
   public static byte[] compress(byte[] data) throws EventBloomException {
     Deflater deflater = new Deflater();
-    deflater.setInput(data);
 
-    ByteArrayOutputStream outputStream = new ByteArrayOutputStream(data.length);
+    try (ByteArrayOutputStream outputStream = new ByteArrayOutputStream(data.length)) {
+      deflater.setInput(data);
+      deflater.finish();
+      byte[] buffer = new byte[1024];
 
-    deflater.finish();
-    byte[] buffer = new byte[1024];
-    while (!deflater.finished()) {
-      int count = deflater.deflate(buffer); // returns the generated code... index
-      outputStream.write(buffer, 0, count);
-    }
-    try {
-      outputStream.close();
+      while (!deflater.finished()) {
+        int count = deflater.deflate(buffer);  // returns the generated code... index
+        outputStream.write(buffer, 0, count);
+      }
+
+      return outputStream.toByteArray();
     } catch (IOException e) {
       throw new EventBloomException("compress data failed");
+    } finally {
+      deflater.end();
     }
-    byte[] output = outputStream.toByteArray();
-
-    return output;
   }
 
   public static byte[] decompress(byte[] data) throws IOException, DataFormatException {
     Inflater inflater = new Inflater();
-    inflater.setInput(data);
 
-    ByteArrayOutputStream outputStream = new ByteArrayOutputStream(data.length);
-    byte[] buffer = new byte[1024];
-    while (!inflater.finished()) {
-      int count = inflater.inflate(buffer);
-      outputStream.write(buffer, 0, count);
-    }
-    outputStream.close();
-    byte[] output = outputStream.toByteArray();
+    try (ByteArrayOutputStream outputStream = new ByteArrayOutputStream(data.length)) {
+      inflater.setInput(data);
+      byte[] buffer = new byte[1024];
+
+      while (!inflater.finished()) {
+        int count = inflater.inflate(buffer);
+        outputStream.write(buffer, 0, count);
+      }
 
-    return output;
+      return outputStream.toByteArray();
+    } finally {
+      inflater.end();
+    }
   }
 
 }

common/src/main/java/org/tron/core/Constant.java

@@ -145,6 +145,8 @@ public class Constant {
   public static final String NODE_JSONRPC_HTTP_SOLIDITY_PORT = "node.jsonrpc.httpSolidityPort";
   public static final String NODE_JSONRPC_HTTP_PBFT_ENABLE = "node.jsonrpc.httpPBFTEnable";
   public static final String NODE_JSONRPC_HTTP_PBFT_PORT = "node.jsonrpc.httpPBFTPort";
+  public static final String NODE_JSONRPC_MAX_BLOCK_RANGE = "node.jsonrpc.maxBlockRange";
+  public static final String NODE_JSONRPC_MAX_SUB_TOPICS = "node.jsonrpc.maxSubTopics";
 
   public static final String NODE_DISABLED_API_LIST = "node.disabledApi";
 

framework/src/main/java/org/tron/core/config/args/Args.java

@@ -202,6 +202,8 @@ public static void clearParam() {
     PARAMETER.jsonRpcHttpFullNodeEnable = false;
     PARAMETER.jsonRpcHttpSolidityNodeEnable = false;
     PARAMETER.jsonRpcHttpPBFTNodeEnable = false;
+    PARAMETER.jsonRpcMaxBlockRange = 5000;
+    PARAMETER.jsonRpcMaxSubTopics = 1000;
     PARAMETER.nodeMetricsEnable = false;
     PARAMETER.metricsStorageEnable = false;
     PARAMETER.metricsPrometheusEnable = false;
@@ -507,6 +509,16 @@ public static void setParam(final Config config) {
           config.getBoolean(Constant.NODE_JSONRPC_HTTP_PBFT_ENABLE);
     }
 
+    if (config.hasPath(Constant.NODE_JSONRPC_MAX_BLOCK_RANGE)) {
+      PARAMETER.jsonRpcMaxBlockRange =
+          config.getInt(Constant.NODE_JSONRPC_MAX_BLOCK_RANGE);
+    }
+
+    if (config.hasPath(Constant.NODE_JSONRPC_MAX_SUB_TOPICS)) {
+      PARAMETER.jsonRpcMaxSubTopics =
+          config.getInt(Constant.NODE_JSONRPC_MAX_SUB_TOPICS);
+    }
+
     if (config.hasPath(Constant.VM_MIN_TIME_RATIO)) {
       PARAMETER.minTimeRatio = config.getDouble(Constant.VM_MIN_TIME_RATIO);
     }

framework/src/main/java/org/tron/core/services/jsonrpc/TronJsonRpcImpl.java

@@ -1327,7 +1327,7 @@ public LogFilterElement[] getLogs(FilterRequest fr) throws JsonRpcInvalidParamsE
 
     long currentMaxBlockNum = wallet.getNowBlock().getBlockHeader().getRawData().getNumber();
     //convert FilterRequest to LogFilterWrapper
-    LogFilterWrapper logFilterWrapper = new LogFilterWrapper(fr, currentMaxBlockNum, wallet);
+    LogFilterWrapper logFilterWrapper = new LogFilterWrapper(fr, currentMaxBlockNum, wallet, true);
 
     return getLogsByLogFilterWrapper(logFilterWrapper, currentMaxBlockNum);
   }

framework/src/main/java/org/tron/core/services/jsonrpc/filters/LogBlockQuery.java

@@ -39,23 +39,21 @@ public LogBlockQuery(LogFilterWrapper logFilterWrapper, SectionBloomStore sectio
     this.currentMaxBlockNum = currentMaxBlockNum;
 
     if (logFilterWrapper.getFromBlock() == Long.MAX_VALUE) {
-      minSection = (int) (currentMaxBlockNum / Bloom.BLOOM_BIT_SIZE);
       minBlock = currentMaxBlockNum;
     } else {
-      minSection = (int) (logFilterWrapper.getFromBlock() / Bloom.BLOOM_BIT_SIZE);
       minBlock = logFilterWrapper.getFromBlock();
     }
+    minSection = (int) (minBlock / Bloom.BLOOM_BIT_SIZE);
 
     if (logFilterWrapper.getToBlock() == Long.MAX_VALUE) {
-      maxSection = (int) (currentMaxBlockNum / Bloom.BLOOM_BIT_SIZE);
       maxBlock = currentMaxBlockNum;
     } else {
-      maxSection = (int) (logFilterWrapper.getToBlock() / Bloom.BLOOM_BIT_SIZE);
       maxBlock = logFilterWrapper.getToBlock();
       if (maxBlock > currentMaxBlockNum) {
         maxBlock = currentMaxBlockNum;
       }
     }
+    maxSection = (int) (maxBlock / Bloom.BLOOM_BIT_SIZE);
   }
 
   public List<Long> getPossibleBlock() throws ExecutionException, InterruptedException,
@@ -71,7 +69,7 @@ public List<Long> getPossibleBlock() throws ExecutionException, InterruptedExcep
     BitSet blockNumBitSet = new BitSet(capacity);
     blockNumBitSet.set(0, capacity);
 
-    //works serial
+    // works serial
     for (int[][] conditionsIndex : allConditionsIndex) {
       BitSet bitSet = subMatch(conditionsIndex);
       blockNumBitSet.and(bitSet);

framework/src/main/java/org/tron/core/services/jsonrpc/filters/LogFilter.java

@@ -13,6 +13,7 @@
 import org.tron.common.bloom.Bloom;
 import org.tron.common.crypto.Hash;
 import org.tron.common.runtime.vm.DataWord;
+import org.tron.core.config.args.Args;
 import org.tron.core.exception.JsonRpcInvalidParamsException;
 import org.tron.core.services.jsonrpc.TronJsonRpc.FilterRequest;
 import org.tron.protos.Protocol.TransactionInfo.Log;
@@ -35,6 +36,8 @@ public class LogFilter {
   @Setter
   private Bloom[][] filterBlooms;
 
+  // The maximum number of topic criteria allowed, vm.LOG4 - vm.LOG0
+  private final int maxTopics = 4;
 
   public LogFilter() {
   }
@@ -66,8 +69,8 @@ public LogFilter(FilterRequest fr) throws JsonRpcInvalidParamsException {
 
     if (fr.getTopics() != null) {
       //restrict depth of topics, because event has a signature and most 3 indexed parameters
-      if (fr.getTopics().length > 4) {
-        throw new JsonRpcInvalidParamsException("topics size should be <= 4");
+      if (fr.getTopics().length > maxTopics) {
+        throw new JsonRpcInvalidParamsException("topics size should be <= " + maxTopics);
       }
       for (Object topic : fr.getTopics()) {
         if (topic == null) {
@@ -79,6 +82,10 @@ public LogFilter(FilterRequest fr) throws JsonRpcInvalidParamsException {
             throw new JsonRpcInvalidParamsException("invalid topic(s): " + topic);
           }
         } else if (topic instanceof ArrayList) {
+          int maxSubTopics = Args.getInstance().getJsonRpcMaxSubTopics();
+          if (maxSubTopics > 0 && ((ArrayList<?>) topic).size() > maxSubTopics) {
+            throw new JsonRpcInvalidParamsException("exceed max topics: " + maxSubTopics);
+          }
 
           List<byte[]> t = new ArrayList<>();
           for (Object s : ((ArrayList) topic)) {

framework/src/main/java/org/tron/core/services/jsonrpc/filters/LogFilterAndResult.java

@@ -16,7 +16,8 @@ public class LogFilterAndResult extends FilterResult<LogFilterElement> {
 
   public LogFilterAndResult(FilterRequest fr, long currentMaxBlockNum, Wallet wallet)
       throws JsonRpcInvalidParamsException {
-    this.logFilterWrapper = new LogFilterWrapper(fr, currentMaxBlockNum, wallet);
+    // eth_newFilter, no need to check block range
+    this.logFilterWrapper = new LogFilterWrapper(fr, currentMaxBlockNum, wallet, false);
     result = new LinkedBlockingQueue<>();
     this.updateExpireTime();
   }

framework/src/main/java/org/tron/core/services/jsonrpc/filters/LogFilterWrapper.java

@@ -7,6 +7,7 @@
 import org.apache.commons.lang3.StringUtils;
 import org.tron.common.utils.ByteArray;
 import org.tron.core.Wallet;
+import org.tron.core.config.args.Args;
 import org.tron.core.exception.JsonRpcInvalidParamsException;
 import org.tron.core.services.jsonrpc.JsonRpcApiUtil;
 import org.tron.core.services.jsonrpc.TronJsonRpc.FilterRequest;
@@ -23,8 +24,8 @@ public class LogFilterWrapper {
   @Getter
   private final long toBlock;
 
-  public LogFilterWrapper(FilterRequest fr, long currentMaxBlockNum, Wallet wallet)
-      throws JsonRpcInvalidParamsException {
+  public LogFilterWrapper(FilterRequest fr, long currentMaxBlockNum, Wallet wallet,
+      boolean checkBlockRange) throws JsonRpcInvalidParamsException {
 
     // 1.convert FilterRequest to LogFilter
     this.logFilter = new LogFilter(fr);
@@ -86,6 +87,12 @@ public LogFilterWrapper(FilterRequest fr, long currentMaxBlockNum, Wallet wallet
           throw new JsonRpcInvalidParamsException("please verify: fromBlock <= toBlock");
         }
       }
+
+      // till now, it needs to check block range for eth_getLogs
+      int maxBlockRange = Args.getInstance().getJsonRpcMaxBlockRange();
+      if (checkBlockRange && maxBlockRange > 0 && (toBlockSrc - fromBlockSrc) > maxBlockRange) {
+        throw new JsonRpcInvalidParamsException("exceed max block range: " + maxBlockRange);
+      }
     }
 
     this.fromBlock = fromBlockSrc;

framework/src/main/resources/config-localtest.conf

@@ -161,6 +161,8 @@ node {
     # httpSolidityPort = 8555
     # httpPBFTEnable = true
     # httpPBFTPort = 8565
+    # maxBlockRange = 5000
+    # maxSubTopics = 1000
   }
 
 }