What is Aderyn?
Aderyn is an open-source public good developer tool. It is a Rust-based solidity smart contract static analyzer designed to help protocol engineers and security researchers find vulnerabilities in Solidity code bases.
Thanks to its collection of static vulnerability detectors, running Cyfrin Aderyn on your Solidity codebase will highlight potential vulnerabilities, drastically reducing the potential for unknown issues in your Solidity code and giving you the time to focus on more complex problems.
Built using Rust, Aderyn integrates seamlessly into small and enterprise-level development workflows, offering lighting-fast command-line functionality and a framework to build custom detectors to adapt to your codebase.
You can read the Cyfrin official documentation for an in-depth look at Aderyn's functionalities.
Features
Installation
Prerequisites
Before installing Aderyn, ensure you have the following:
- Rust: Aderyn is built in Rust. Before running, you must install Rust and Cargo (Rust's package manager). If you still need to install Rust, follow the instructions on the official Rust website.
Aderyn currently only supports Foundry-based projects. If you're using Hardhat, please take a look at the contribution guidelines and issues for information on how to contribute. Suggested VSCode extensions: rust-analyzer - Rust language support for Visual Studio Code Rust Syntax - Improved Rust syntax highlighting
Installing Aderyn
Step 1: Install Aderyn using cargo
Aderyn is currently installed using Cargo, Rust's package manager. Open your command line interface and run the following command:
This command downloads and installs the Aderyn package.
Step 2: Verify installation
After the installation, you can verify that Aderyn is correctly installed by checking its version. In your command line, execute:
This command should return the installed version of Aderyn, confirming that the installation was successful.
Step 3: Update PATH (if necessary)
If you cannot run the aderyn after installation, you may need to add Cargo's bin directory to your PATH. The exact instructions can vary based on your operating system. Typically, it involves adding ~/.cargo/bin to your PATH in your shell profile script (like .bashrc or .zshrc).
Step 4: Future Updates
To update Aderyn to the latest version, you can run the install command again:
Cargo will replace the existing version with the latest one.
Quick Start
Once Aderyn is installed on your system, you can run it against your Foundry-based codebase to find vulnerabilities in your code.
We will use the aderyn-contracts-playground repository in this example. You can follow along by cloning it to your system:
Navigate inside the repository:
We usually use several smart contracts and tests to try new detectors. Build the contracts by running:
Building your project by running forge build --ast will save you time the first time you run Aderyn. Once your smart contracts have been successfully compiled, run Aderyn using the following command:
Replace [OPTIONS] with specific command-line arguments as needed.
For an in-depth walkthrough on how to get started using Aderyn, check the Cyfrin official docs
Arguments
Usage: aderyn [OPTIONS] <ROOT>
<ROOT>: The path to the root of the codebase to be analyzed. Defaults to the current directory.
Options:
-o,--output <OUTPUT>: Desired file path for the final report (will overwrite the existing one) [default: report.md]-s,--scope <SCOPE>: List of path strings to include, delimited by comma (no spaces). Any solidity file path not containing these strings will be ignored-e,--exclude <EXCLUDE>: List of path strings to exclude, delimited by comma (no spaces). Any solidity file path containing these strings will be ignored-n,--no-snippets: Do not include code snippets in the report (reduces report size in large repos)-h,--help: Print help-V,--version: Print version
You must provide the root directory of the repo you want to analyze. Alternatively, you can provide a single Solidity file path (this mode requires Foundry to be installed).
Examples:
Find more examples on the official Cyfrin Docs
Building a custom Aderyn detector
Aderyn makes it easy to build Static Analysis detectors that can adapt to any Solidity codebase and protocol. This guide will teach you how to build, test, and run your custom Aderyn detectors. To learn how to create your custom Aderyn detectors, checkout the official docs
Docker
You can run Aderyn from a Docker container.
Build the image:
/path/to/project/root should be the path to your Foundry or Hardhat project root directory and it will be mounted to /share in the container.
Run Aderyn:
Run with flags:
Single Solidity File Mode
If it is a Solidity file path, then Aderyn will create a temporary Foundry project, copy the contract into it, compile the contract and then analyze the AST generated by that temporary project.
Contributing & License
Help us build Aderyn 🦜 Please see our contribution guidelines. Aderyn is an open-source software licensed under the MIT License.
To build Aderyn locally, install Rust, clone this repo, and use cargo commands to build, test and run locally
Credits
This project exists thanks to all the people who contribute.
Attribution
- AST Visitor code from solc-ast-rs.
- Original detectors based on 4naly3er detectors.
- Shoutout to the original king of static analysis slither.