https://github.com/mdsakibanwar/gosonar
Binary symbolic execution for detecting uncontrolled recursion in Go binaries. Published at IEEE S&P 2025.
https://github.com/mdsakibanwar/gosonar
angr go golang security security-tools symbolic-execution
Last synced: 2 months ago
JSON representation
Binary symbolic execution for detecting uncontrolled recursion in Go binaries. Published at IEEE S&P 2025.
- Host: GitHub
- URL: https://github.com/mdsakibanwar/gosonar
- Owner: mdsakibanwar
- License: gpl-3.0
- Created: 2025-04-27T20:43:09.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-29T12:42:31.000Z (about 1 year ago)
- Last Synced: 2025-04-30T04:34:16.719Z (about 1 year ago)
- Topics: angr, go, golang, security, security-tools, symbolic-execution
- Language: Python
- Homepage:
- Size: 6.94 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🛡️ **GoSonar**
**Binary Symbolic Execution for Go Binaries**
*Detect and verify uncontrolled recursions with ease.*
---
## 🚀 Overview
**GoSonar** is a tool for *binary symbolic execution* designed to detect **uncontrolled recursions** in Go binaries. This project is based on the research presented in the paper ["GoSonar: Detecting Logical Vulnerabilities in Memory Safe Languages Using Inductive Constraint Reasoning"](https://www.computer.org/csdl/proceedings-article/sp/2025/223600a043/21B7QweuVUs), published at IEEE S&P 2025.
GoSonar offers two primary modes for analysis:
- **Regular Mode**: Direct binary analysis.
- **Call Resolver Mode**: Source-assisted AST parsing to resolve indirect calls.
> 💬 *Recommended usage: Deploy via Docker container for optimal convenience.*
---
## 🐳 Quick Start
### 1. Pull & Run the Docker Image
```bash
docker run -it sakibanwar/gosonar bash
```
---
### 2. Project Structure
| Directory | Purpose |
|------------|----------------------------------|
| `src/` | Main source code. |
| `bins/` | Binaries + source for benchmarks and stdlib. |
| `db/` | SQLite databases for analysis results. |
| `logs/` | Logs of each execution run. |
---
### 3. Running an Analysis
- Easiest way:
```bash
cd gosonar
./run.sh # runs benchmark
./run.sh # runs package analysis assumes binary under go_stdlib in regular mode
./run.sh call # runs package analysis assumes binary under go_stdlib in call resolver mode
```
- Or manually:
```bash
cd src/
python3 main.py --worker-type --binary --package [other options]
```
---
### 4. Compiling Benchmarks
Each subdirectory under `bins/` has a `compile.sh` to build binaries:
```bash
cd bins/benchmark/src
./compile.sh
```
---
## ⚙️ Modes of Operation
| Mode | Description |
|-------------------|------------------------------------------------------|
| Regular Mode | Pure binary analysis. |
| Call Resolver Mode| Needs source code access. AST parsing for better call graph resolution. |
---
## 🗄️ Database and Logs
- **Databases** are saved inside `db/` folder (separate DB for each mode).
- **Logs** are saved under `logs/` and named:
```
___.log
```
---
## 🛠️ Command-Line Arguments
### Required
- `--worker-type` : Specifies the worker type (**mandatory**).
### At Least One Required
- `--package` : Target Go package.
- `--binary` : Path to binary file.
### Optional
- `--mode` : Running mode (`regular`, `callresolver`, etc.).
- `--loglevel` : Logging level (`default: TRACE`).
- `--target-func` : Analyze a specific function.
- `--stop-addresses` : Addresses to stop execution at.
- `--cycle-size` : Cycle size limit (`default: 5`).
- `--db` : Target database.
- `--recursion-limit` : Max recursion depth (`default: 3`).
- `--db-id-start` : Starting database row (`default: 0`).
- `--db-amount` : Number of rows to process (`default: 250`).
- `--no-prune-callgraph` : Disable call graph pruning.
- `--bypass-db` : Skip database operations.
- `--timeout` : Analysis timeout (`default: 600s`).
---
## 📜 License
This project is licensed under the [GPL-3.0](LICENSE).
---
## ✨ Contributions
Pull requests are welcome!
For major changes, please open an issue first to discuss what you would like to change.