archr
Traditionally, binary analysis has been implicitly program-centric, meaning that the atomic unit of concern is the binary being analyzed.
This assumption is usually implicit: angr.Project is instantiated with the binary in question, afl launches the binary itself, generally hyper-modified to make it easier to fuzz, and so on.
However, outside of the CGC, programs do not exist in a vacuum. Specific library versions, values in configuration files, environment variables, and a myriad other factors combine with the program binary itself to make a unique holistic target, and in many cases, it is that target that needs to be analyzed, not just the program itself. This is specifically true for analysis that need extreme accuracy, such as automatic exploit generation.
archr is an implementation of such a target-centric analysis paradigm.
It consists of two main concepts: Targets, which describe the specification of the target itself, how it is configured, how it will be launched, and how it would be interacted with, and Analyzers, which specialize targets for specific analysis actions, such as tracing, symbolic execution, and so on.
To accomplish their tasks, Analyzers might inject Implants (i.e., qemu-user, gdbserver, and so on) into the target.
We have the following Targets:
- DockerImageTarget, which takes a description of the target in the form of a docker image
- LocalTarget, which just describes running the target in the local system
The following Analyzers exist:
- DataScoutAnalyzer (will grabs the memory map, environment, and auxv of the process, exactly as it is at launch)
- AngrProjectAnalyzer (can create an angr project with the right libs at the right offsets)
- AngrStateAnalyzer (can create a angr states with the right env, args, and fs)
- QEMUTraceAnalyzer (does qemu tracing of the target)
- GDBServerAnalyzer (launches the target in a gdbserver)
- STraceAnalyzer (straces a target)
- CoreAnalyzer (launches the target and retrieves a core)
- InputFDAnalyzer (determines the FD number for user input (in some cases))
Using archr
To use archr, one must first create a Target.
First, build a docker image that launches your target.
Here is an example dockerfile for a docker-cat image:
from ubuntu:latest
entrypoint ["/bin/cat"]
Then, load it as a target:
import archr
t = archr.targets.DockerImageTarget('docker-cat').build()
And viola!, your target is ready to use. archr will automatically figure out how your binary runs inside your target, and then you can launch and interact with it:
t.start()
assert t.run_command(stdin=subprocess.DEVNULL).wait() == 0
t.stop()
archr makes heavy use of with contexts, which will help clean up resources.
Embrace them.
For example, you can:
with t.start():
with t.run_context() as p:
print(p,"is a subprocess.Popen object!")
p.stdin.write("hello")
assert p.stdout.read(5) == "hello"
There is even a context that will allow you to temporarily replace files on the target!
with t.start():
with t.replacemenet_context("/etc/passwd", "hahaha"), t.run_context(args_suffix=["/etc/passwd"]) as p:
assert p.stdout.read() == "hahaha"
assert t.run_command(args_suffix=["/etc/passwd"]).stdout.read() != "hahaha"
And even one that will temporarily replace the target binary's code with shellcode:
with t.start():
with t.shellcode_context(asm_code="mov rax, 60; mov rdi, 42; syscall") as p:
assert p.wait() == 42
You can retrieve files from the target with retrieve_contents, retrieve_paths, and retrieve_glob, inject files with inject_path, inject_contents, and so on, get network endpoints using ipv4_address, udp_ports, and tcp_ports, and some other interesting stuff!
You can also make a LocalTarget to just run stuff on your host, and it is almost perfectly interchange with a DockerTarget:
import archr
t = archr.targets.LocalTarget(["/bin/cat"]).build()
To figure out how to run the binary, LocalTarget takes at least an argv list.
You can also pass in an env.
Keep in mind that since some of the above examples need write access to files, you will need to use writable files instead of /etc/passwd and /bin/cat.
Caveats
Some caveats at the moment:
- archr does not handle string-specified (as opposed to array-specified) entrypoint directives in the docker file. This isn't hard; we just haven't gotten around to it (see issue #1).
Metadata
Release files for archr 9.2.165
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| archr-9.2.165.tar.gz | 58.7 kB | With provenance | Details for archr-9.2.165.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| archr-9.2.165-py3-none-manylinux2014_x86_64.whl | Python 3 | none | Linux glibc 2.17+ x86-64 | Details for archr-9.2.165-py3-none-manylinux2014_x86_64.whl |
Total release size: 126.4 kB
Release files / archr-9.2.165.tar.gz
| Download URL | archr-9.2.165.tar.gz |
|---|---|
| Size | 58.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6bcd3d94c6f6408b83ba753848cb06d2a1724efd31dde15c116d0ba2dcd7c863
|
|
BLAKE2b-256 checksum How to use checksums |
42ac44f061dc0ddd700e22a43c2be0f3efe96133f8c3a91e66ff7822c7ee2627
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 10, 2025.
Transparency logRelease files / archr-9.2.165-py3-none-manylinux2014_x86_64.whl
| Download URL | archr-9.2.165-py3-none-manylinux2014_x86_64.whl |
|---|---|
| Size | 67.8 kB |
| Tags | Linux glibc 2.17+ x86-64 Python 3 |
|
SHA-256 checksum How to use checksums |
e2ab68fd81fc3131eaae0a28592c244b6ae3a7187bbbfd5dd758db2bfb2dc013
|
|
BLAKE2b-256 checksum How to use checksums |
a0e97dda0fd61ea7dc44874d14d0ad467e16c3cceb4fc5dd0fa688803267add6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 10, 2025.
Transparency logSecurity for archr 9.2.165
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for archr-9.2.165.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 10, 2025.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.