Rustle is an automatic static analyzer for NEAR smart contracts in Rust. It can help to locate tens of different vulnerabilities in NEAR smart contracts. According to DefiLlama, among the top 10 DApps in NEAR, 8 are audited by BlockSec. With rich audit experience and a deep understanding of NEAR protocol, we build this tool and share it with the community.
Install the required toolkits with the following commands for Rustle. Commands are tested in Ubuntu 20.04 LTS.
# install Rust Toolchain
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
# install LLVM 15
sudo bash -c "$(wget -O - https://apt.llvm.org/llvm.sh)" 15
# install Python toolchain
sudo apt install python3 python3-pip
pip3 install -r utils/requirements.txt # you need to clone this repo first
# add WASM target
rustup target add wasm32-unknown-unknown
# install other components
sudo apt install figlet
cargo install rustfilt
# [optional] useful tools for developing
LLVM_VERSION=
sudo apt install clangd-$LLVM_VERSION clang-format-$LLVM_VERSION clang-tidy-$LLVM_VERSION
We provide a docker solution.
# build the image
docker build --build-arg UID=`id -u` --build-arg GID=`id -g` -t rustle .
# run a container from the image
docker run --name rustle -it -v `pwd`:/rustle -w /rustle rustle bash
# exec the container
docker start rustle
docker exec -it -w /rustle rustle bash
./rustle [-t|--tg_dir <tg_dir>] [-d|--detector <detector_list>] [-o|--output <output_dir>] [-h|--help] <src_dir>
src_dir
: Path to the contract source.tg_dir
: Path to the contract build target. Defaults to be same assrc_dir
.detector
: The detector list. It can be used to pass multiple detectors or groups separated by,
. Defaults toall
.- pass
all
group to enable all detectors. - pass
high
,medium
,low
andinfo
groups to enable detector groups with different severity - pass detector ids in the table to enable those detectors
- pass
output
: Path where audit reports will be generated in. Defaults to./audit-result
.
Note: if the target bit code (.bc
binary) built by cargo is not in the $src_dir
, use -t|--tg_dir
to set the target's directory, or it will be set to $src_dir
by default.
The command below shows an example of analyzing the LiNEAR.
# clone LiNEAR
git clone https://github.com/linear-protocol/LiNEAR.git ~/near-repo/LiNEAR
# run Rustle
./rustle -t ~/near-repo/LiNEAR ~/near-repo/LiNEAR/contracts/linear
# [optional] run Rustle on specified detectors or severity groups and save audit reports in `~/linear-report`
./rustle -t ~/near-repo/LiNEAR ~/near-repo/LiNEAR/contracts/linear -d high,medium,complex-loop -o ~/linear-report
A CSV-format report will be generated in the directory "./audit-result".
All vulnerabilities Rustle can find.
- Fork this repo to your account.
- Put the new detector under /detectors (for the LLVM detector written in C++, add a build target in detectors/Makefile).
- Add a detection target in /Makefile with commands to run your detector.
- Add the target to the dependency of
audit
target and its name to detector list and severity groups in./rustle
script. - Add processing code in utils/audit.py (refer to other detectors' code in
audit.py
). - Submit a pull request from your branch to the main.
Rustle can be used in the development process to scan the NEAR smart contracts iteratively. This can save a lot of manual effort and mitigate part of potential issues. However, vulnerabilities in complex logic or related to semantics are still the limitation of Rustle. Locating complicated semantic issues requires the experts in BlockSec to conduct exhaustive and thorough reviews. Contact us for audit service.
This project is under the AGPLv3 License. See the LICENSE file for the full license text.