Merge pull request #32 from lisa-analyzer/reachability-cache

Optimized DFS, ReentrancyChecker, Dockerfile, tests

Author: VincenzoArceri

.dockerignore

@@ -0,0 +1 @@
+scripts/

.gitignore

@@ -20,6 +20,7 @@ scripts/python/benchmark-checkers/**/abi/**
 scripts/python/benchmark-checkers/**/json/**
 scripts/python/benchmark-checkers/**/results/**
 scripts/python/benchmark-checkers/images/**
+scripts/python/benchmark-checkers/jars/evm-lisa.jar
 
 # Ignore downloaded bytecode
 evm-testcases/benchmark/

Dockerfile

@@ -2,7 +2,7 @@
 FROM openjdk:11-jdk-slim
 
 # Specify the version of Gradle to install
-ARG GRADLE_VERSION=6.6
+ARG GRADLE_VERSION=8.0
 
 # Install Gradle
 RUN apt-get update && apt-get install -y wget unzip git && \
@@ -23,14 +23,10 @@ WORKDIR /app
 COPY . .
 
 # Build the project with Gradle
-RUN gradle build
-
-# Extract the project ZIP file for distribution
-RUN gradle distZip && \
-    unzip -o build/distributions/evm-lisa.zip -d /app/execution
+RUN gradle assemble
 
 # Create results directory
 RUN mkdir -p /app/execution/results
 
 # Set the entry point of the container
-ENTRYPOINT ["/app/execution/evm-lisa/bin/evm-lisa"]
+ENTRYPOINT ["java", "-jar", "/app/build/libs/evm-lisa-all.jar"]

README.md

@@ -14,8 +14,8 @@ EVMLiSA is based on the peer-reviewed publication
 
 # 🛠 Building EVMLiSA
 Compiling EVMLiSA requires:
-- JDK >= 11
-- [Gradle](https://gradle.org/releases/) >= 6.6
+- JDK >= 11 (optional using Docker)
+- [Gradle](https://gradle.org/releases/) >= 8.0 (optional using Docker)
 - [Etherscan API key](https://etherscan.io/myapikey)
 
 You need to:
@@ -53,53 +53,37 @@ docker run --rm -it \
 -v $(pwd)/.env:/app/.env \
 -v $(pwd)/execution/docker:/app/execution/results \
 evm-lisa:latest \
--a <smart_contract_address> [options]
+[options]
 ```
 
 - `-v $(pwd)/.env:/app/.env`: mount the `.env` file.
 - `-v $(pwd)/execution/docker:/app/execution/results`: share the results' folder.
 
-> Replace `<smart_contract_address>` with the address of the Ethereum smart contract you want to analyze.
-
 ## Via Bash
 Build the Project:
 ```bash
-./gradlew build
-```
-
-Create Distribution Zip:
-```bash
-./gradlew distZip
-```
-
-Unzip the Distribution:
-```bash
-unzip build/distributions/evm-lisa.zip -d execution
+./gradlew assemble
 ```
 
 Then you can run EVMLiSA with:
 ```bash
-./execution/evm-lisa/bin/evm-lisa \
--a <smart_contract_address> [options]
+java -jar build/libs/evm-lisa-all.jar [options]
 ```
-> Replace `<smart_contract_address>` with the address of the Ethereum smart contract you want to analyze.
-
-This command will initiate the analysis process for the specified smart contract, providing insights and results based on the EVM bytecode of the contract.
 
 ```
 Options:
  -a,--address <arg>                        Address of an Ethereum smart contract.
  -b,--benchmark <arg>                      Filepath of the benchmark.
  -c,--cores <arg>                          Number of cores used in benchmark.
     --checker-reentrancy                   Enable re-entrancy checker.
+    --checker-timestampdependency          Enable timestamp-dependency checker.
     --checker-txorigin                     Enable tx-origin checker.
     --creation-code                        Parse bytecode as creation code (instead of runtime code).
     --dot                                  Export a dot-notation file.
     --download-bytecode                    Download the bytecode.
     --dump-report                          Dump analysis report.
     --dump-stats                           Dump statistics.
  -f,--filepath-bytecode <arg>              Filepath of the bytecode file.
-    --filepath-mnemonic <arg>              Filepath of the mnemonic file.
     --html                                 Export a graphic HTML report.
     --link-unsound-jumps-to-all-jumpdest   Link all the unsound jumps to all jumpdest.
  -o,--output <arg>                         Output directory path.
@@ -119,12 +103,12 @@ Here is an example of how to run EVMLiSA. In this example, we will analyze a sma
 
 - Bash:
 ```bash
-./execution/evm-lisa/bin/evm-lisa \
+java -jar build/libs/evm-lisa-all.jar \
 -a 0x7c21C4Bbd63D05Fa9F788e38d14e18FC52E9557B \
 --stack-size 64 \
 --stack-set-size 10 \
---dump-stats \
---use-live-storage
+--creation-code \
+--link-unsound-jumps-to-all-jumpdest
 ```
 
 - Docker:
@@ -136,8 +120,8 @@ evm-lisa:latest \
 -a 0x7c21C4Bbd63D05Fa9F788e38d14e18FC52E9557B \
 --stack-size 64 \
 --stack-set-size 10 \
---dump-stats \
---use-live-storage
+--creation-code \
+--link-unsound-jumps-to-all-jumpdest
 ```
 
 > Use `docker run -a stderr` to dump only the json report as standard output.

evm-testcases/cfs/if_else_npbj/report.json

@@ -3,17 +3,17 @@
   "files" : [ "report.json", "untyped_program.evm-testcases_cfs_if_else_npbj_if_else_npbj_eth.sol().json" ],
   "info" : {
     "cfgs" : "1",
-    "duration" : "7ms",
-    "end" : "2024-10-03T17:31:51.790+02:00",
+    "duration" : "344ms",
+    "end" : "2025-02-19T15:16:09.128+01:00",
     "expressions" : "9",
     "files" : "1",
     "globals" : "0",
     "members" : "1",
     "programs" : "1",
-    "start" : "2024-10-03T17:31:51.783+02:00",
+    "start" : "2025-02-19T15:16:08.784+01:00",
     "statements" : "17",
     "units" : "0",
-    "version" : "0.1b8",
+    "version" : "0.1",
     "warnings" : "0"
   },
   "configuration" : {

evm-testcases/cfs/if_else_npbj/untyped_program.evm-testcases_cfs_if_else_npbj_if_else_npbj_eth.sol().json

@@ -380,114 +380,114 @@ def compile_bridge(name):
                                           abi_dir='./cross-chain/THORChain-bridge/abi/')
 
     if args.solidifi:
-        compile_solidity_sources('./reentrancy-solidifi/source-code',
-                                 './reentrancy-solidifi/json')
-        compile_solidity_sources('./vanilla-solidifi/source-code',
-                                 './vanilla-solidifi/json')
-        compile_solidity_sources('./tx-origin-solidifi/source-code',
-                                 './tx-origin-solidifi/json')
-        compile_solidity_sources('./timestamp-dependency-solidifi/source-code',
-                                 './timestamp-dependency-solidifi/json')
+        compile_solidity_sources('./solidifi/reentrancy/source-code',
+                                 './solidifi/reentrancy/json')
+        compile_solidity_sources('./solidifi/vanilla/source-code',
+                                 './solidifi/vanilla/json')
+        compile_solidity_sources('./solidifi/tx-origin/source-code',
+                                 './solidifi/tx-origin/json')
+        compile_solidity_sources('./solidifi/timestamp-dependency/source-code',
+                                 './solidifi/timestamp-dependency/json')
 
         if args.longest_bytecode:
             # EVMLiSA
-            extract_and_save_longest_bytecode('./vanilla-solidifi/bytecode/evmlisa',
-                                              './vanilla-solidifi/json',
-                                              abi_dir='./vanilla-solidifi/abi/evmlisa')
-            extract_and_save_longest_bytecode('./reentrancy-solidifi/bytecode/evmlisa',
-                                              './reentrancy-solidifi/json',
-                                              abi_dir='./reentrancy-solidifi/abi/evmlisa')
+            extract_and_save_longest_bytecode('./solidifi/vanilla/bytecode/evmlisa',
+                                              './solidifi/vanilla/json',
+                                              abi_dir='./solidifi/vanilla/abi/evmlisa')
+            extract_and_save_longest_bytecode('./solidifi/reentrancy/bytecode/evmlisa',
+                                              './solidifi/reentrancy/json',
+                                              abi_dir='./solidifi/reentrancy/abi/evmlisa')
                 # TX-ORIGIN
-            extract_and_save_longest_bytecode('./tx-origin-solidifi/bytecode/evmlisa',
-                                              './tx-origin-solidifi/json')
+            extract_and_save_longest_bytecode('./solidifi/tx-origin/bytecode/evmlisa',
+                                              './solidifi/tx-origin/json')
 
                 # Timestamp-dependency
-            extract_and_save_longest_bytecode('./timestamp-dependency-solidifi/bytecode/evmlisa',
-                                              './timestamp-dependency-solidifi/json')
+            extract_and_save_longest_bytecode('./solidifi/timestamp-dependency/bytecode/evmlisa',
+                                              './solidifi/timestamp-dependency/json')
 
             # EtherSolve
-            extract_and_save_longest_bytecode('./vanilla-solidifi/bytecode/ethersolve',
-                                              './vanilla-solidifi/json',
+            extract_and_save_longest_bytecode('./solidifi/vanilla/bytecode/ethersolve',
+                                              './solidifi/vanilla/json',
                                               True)
-            extract_and_save_longest_bytecode('./reentrancy-solidifi/bytecode/ethersolve',
-                                              './reentrancy-solidifi/json',
+            extract_and_save_longest_bytecode('./solidifi/reentrancy/bytecode/ethersolve',
+                                              './solidifi/reentrancy/json',
                                               True)
         else:
             # EVMLiSA
-            extract_and_save_bytecode('./vanilla-solidifi/bytecode/evmlisa',
-                                      './vanilla-solidifi/json')
-            extract_and_save_bytecode('./reentrancy-solidifi/bytecode/evmlisa',
-                                      './reentrancy-solidifi/json')
+            extract_and_save_bytecode('./solidifi/vanilla/bytecode/evmlisa',
+                                      './solidifi/vanilla/json')
+            extract_and_save_bytecode('./solidifi/reentrancy/bytecode/evmlisa',
+                                      './solidifi/reentrancy/json')
                 # TX-ORIGIN
-            extract_and_save_bytecode('./tx-origin-solidifi/bytecode/evmlisa',
-                                      './tx-origin-solidifi/json')
+            extract_and_save_bytecode('./solidifi/tx-origin/bytecode/evmlisa',
+                                      './solidifi/tx-origin/json')
 
                 # Timestamp-dependency
-            extract_and_save_bytecode('./timestamp-dependency-solidifi/bytecode/evmlisa',
-                                      './timestamp-dependency-solidifi/json')
+            extract_and_save_bytecode('./solidifi/timestamp-dependency/bytecode/evmlisa',
+                                      './solidifi/timestamp-dependency/json')
 
             # EtherSolve
-            extract_and_save_bytecode('./vanilla-solidifi/bytecode/ethersolve',
-                                      './vanilla-solidifi/json',
+            extract_and_save_bytecode('./solidifi/vanilla/bytecode/ethersolve',
+                                      './solidifi/vanilla/json',
                                       True)
-            extract_and_save_bytecode('./reentrancy-solidifi/bytecode/ethersolve',
-                                      './reentrancy-solidifi/json',
+            extract_and_save_bytecode('./solidifi/reentrancy/bytecode/ethersolve',
+                                      './solidifi/reentrancy/json',
                                       True)
 
     if args.smartbugs:
-        compile_solidity_sources_with_different_version('./reentrancy-smartbugs/source-code',
-                                                        './reentrancy-smartbugs/json',
-                                                        './reentrancy-smartbugs/source-code/version.csv')
+        compile_solidity_sources_with_different_version('./smartbugs/reentrancy/source-code',
+                                                        './smartbugs/reentrancy/json',
+                                                        './smartbugs/reentrancy/source-code/version.csv')
 
-        compile_solidity_sources_with_different_version('./timestamp-dependency-smartbugs/source-code',
-                                                        './timestamp-dependency-smartbugs/json',
-                                                        './timestamp-dependency-smartbugs/source-code/version.csv')
+        compile_solidity_sources_with_different_version('./smartbugs/timestamp-dependency/source-code',
+                                                        './smartbugs/timestamp-dependency/json',
+                                                        './smartbugs/timestamp-dependency/source-code/version.csv')
 
         if args.longest_bytecode:
-            extract_and_save_longest_bytecode('./reentrancy-smartbugs/bytecode/evmlisa',
-                                              './reentrancy-smartbugs/json')
-            extract_and_save_longest_bytecode('./timestamp-dependency-smartbugs/bytecode/evmlisa',
-                                              './timestamp-dependency-smartbugs/json')
-            extract_and_save_longest_bytecode('./reentrancy-smartbugs/bytecode/ethersolve',
-                                              './reentrancy-smartbugs/json',
+            extract_and_save_longest_bytecode('./smartbugs/reentrancy/bytecode/evmlisa',
+                                              './smartbugs/reentrancy/json')
+            extract_and_save_longest_bytecode('./smartbugs/timestamp-dependency/bytecode/evmlisa',
+                                              './smartbugs/timestamp-dependency/json')
+            extract_and_save_longest_bytecode('./smartbugs/reentrancy/bytecode/ethersolve',
+                                              './smartbugs/reentrancy/json',
                                               True)
         else:
-            extract_and_save_bytecode('./reentrancy-smartbugs/bytecode/evmlisa',
-                                      './reentrancy-smartbugs/json')
-            extract_and_save_bytecode('./timestamp-dependency-smartbugs/bytecode/evmlisa',
-                                      './timestamp-dependency-smartbugs/json')
-            extract_and_save_bytecode('./reentrancy-smartbugs/bytecode/ethersolve',
-                                      './reentrancy-smartbugs/json',
+            extract_and_save_bytecode('./smartbugs/reentrancy/bytecode/evmlisa',
+                                      './smartbugs/reentrancy/json')
+            extract_and_save_bytecode('./smartbugs/timestamp-dependency/bytecode/evmlisa',
+                                      './smartbugs/timestamp-dependency/json')
+            extract_and_save_bytecode('./smartbugs/reentrancy/bytecode/ethersolve',
+                                      './smartbugs/reentrancy/json',
                                       True)
 
     if args.slise:
-        extract_solidity_versions('./reentrancy-slise-db1/source-code',
-                                  './reentrancy-slise-db1/source-code/version.csv')
-        generate_file_index('./reentrancy-slise-db1/source-code',
-                            './reentrancy-slise-db1/match-file-index.json')
-        compile_solidity_sources_with_different_version('./reentrancy-slise-db1/source-code',
-                                                        './reentrancy-slise-db1/json',
-                                                        './reentrancy-slise-db1/source-code/version.csv')
+        extract_solidity_versions('./slise/reentrancy-db1/source-code',
+                                  './slise/reentrancy-db1/source-code/version.csv')
+        generate_file_index('./slise/reentrancy-db1/source-code',
+                            './slise/reentrancy-db1/match-file-index.json')
+        compile_solidity_sources_with_different_version('./slise/reentrancy-db1/source-code',
+                                                        './slise/reentrancy-db1/json',
+                                                        './slise/reentrancy-db1/source-code/version.csv')
 
-        with open('./reentrancy-slise-db1/match-file-index.json', 'r') as index_file:
+        with open('./slise/reentrancy-db1/match-file-index.json', 'r') as index_file:
             match_file_index = json.load(index_file)
 
         if args.longest_bytecode:
-            extract_and_save_longest_bytecode('./reentrancy-slise-db1/bytecode/evmlisa',
-                                              './reentrancy-slise-db1/json',
+            extract_and_save_longest_bytecode('./slise/reentrancy-db1/bytecode/evmlisa',
+                                              './slise/reentrancy-db1/json',
                                               False,
                                               match_file_index)
-            extract_and_save_longest_bytecode('./reentrancy-slise-db1/bytecode/ethersolve',
-                                              './reentrancy-slise-db1/json',
+            extract_and_save_longest_bytecode('./slise/reentrancy-db1/bytecode/ethersolve',
+                                              './slise/reentrancy-db1/json',
                                               True,
                                               match_file_index)
         else:
 
-            extract_and_save_bytecode('./reentrancy-slise-db1/bytecode/evmlisa',
-                                      './reentrancy-slise-db1/json', 
+            extract_and_save_bytecode('./slise/reentrancy-db1/bytecode/evmlisa',
+                                      './slise/reentrancy-db1/json', 
                                       False, 
                                       match_file_index)
-            extract_and_save_bytecode('./reentrancy-slise-db1/bytecode/ethersolve',
-                                      './reentrancy-slise-db1/json',
+            extract_and_save_bytecode('./slise/reentrancy-db1/bytecode/ethersolve',
+                                      './slise/reentrancy-db1/json',
                                       True,
                                       match_file_index)