jingle
is a library that models (a fragment of) Ghidra's p-code
in the language of SMT. It represents states of
the p-code
Virtual Machine as expressions on the QF_ABV
logic, and represents p-code
operations as relations
between these states.
ALPHA SOFTWARE: this software is fresh, largely untested, and subject to change. It is not yet using semantic versioning.
This repository contains a Cargo Workspace for two related crates:
jingle_sleigh
: a Rust FFI in front of Ghidra' s code translator:SLEIGH
.SLEIGH
is written in C++ and can be found here. This crate contains a private internal low-level API toSLEIGH
and exposes an idiomatic high-level API to consumers.jingle
: a set of functions built on top ofjingle_sleigh
that defines an encoding ofp-code
operations into SMT.jingle
is currently designed for providing formulas for use in decision procedures over individual program traces. As such, it does not yet expose APIs for constructing or reasoning about control-flow graphs. A more robust analysis is forthcoming, depending on my research needs.jingle_python
: a set of pyo3 bindings forjingle
. These bindings expose a simple interface to both SLEIGH and our logical modeling ofp-code
in SMT. SMT formulae are exposed wrapped in their "native" python z3 classes, allowing easy integration with other tools. These bindings are especially raw and subject to change.
If you're working directly with the jingle
source distribution,
you will need to manually download a copy of the ghidra
source tree
in order to build jingle
or jingle_sleigh
If you're working with git
, this can be done using the existing submodule.
Simply run
git submodule init && git submodule update
If you are for some reason using a zipped source distribution, then you can run the following:
cd jingle_sleigh
git clone https://github.com/NationalSecurityAgency/ghidra.git
If you are using jingle
as a cargo git
or crates.io
dependency,
this step is not necessary. cargo
will handle all this in the git
case
and we will vendor the necessary ghidra
sources into all crates.io
releases.
While jingle
can be configured to work with a single set sleigh
architecture,
the default way to use it is to point it to an existing ghidra
installation.
Install ghidra and, if you are using jingle
programatically,
point it at the top level folder of the installation. If you are using the CLI,
then provide the path to ghidra as an argument in your first run.
The only thing ghidra is used for here is as a standardized folder layout for sleigh
architectures.
jingle
has no code dependency on ghidra outside of the bundled sleigh
C++ code.
In order to use jingle
, include it in your Cargo.toml
as usual:
jingle = { git = "ssh://[email protected]/toolCHAINZ/jingle", branch = "main" }
Again, this project is under active development an is still of "research quality" so we recommend targeting
the latest commit SHA on main
or a tag.
jingle
was developed in support of our research paper Synthesis of Code-Reuse Attacks from p-code
Programs.
You can find the author accepted manuscript here.
This work has been accepted to Usenix Security 2025.
You can cite this work with the following BibTex:
@inproceedings {denhoed2025synthesis,
author = {Mark DenHoed and Thomas Melham},
title = {Synthesis of Code-Reuse Attacks from p-code Programs},
booktitle = {34th USENIX Security Symposium (USENIX Security 25)},
year = {2025},
address = {Seattle, WA},
publisher = {USENIX Association},
month = aug
}