README

pwntools - CTF toolkit
!pwntools logo










Pwntools is a CTF framework and exploit development library. Written in Python, it is designed for rapid prototyping and development, and intended to make exploit writing as simple as possible.

python
from pwn import 
context(arch = 'i386', os = 'linux')

r = remote('exploitme.example.com', 31337)
 EXPLOIT CODE GOES HERE
r.send(asm(shellcraft.sh()))
r.interactive()


 Documentation

Our documentation is available at docs.pwntools.com

A series of tutorials is also available online

To get you started, we've provided some example solutions for past CTF challenges in our write-ups repository.

 Installation

Pwntools is best supported on 64-bit Ubuntu LTS releases (22.04 and 24.04).  Most functionality should work on any Posix-like distribution (Debian, Arch, FreeBSD, OSX, etc.).  

Pwntools supports Python 3.10+ since version 5.0.0.  Use Pwntools 4.x for older versions as well as Python 2.7. Most of the functionality of pwntools is self-contained and Python-only.  You should be able to get running quickly with

sh
sudo apt-get update
sudo apt-get install python3 python3-pip python3-dev git libssl-dev libffi-dev build-essential
python3 -m pip install --upgrade pip
python3 -m pip install --upgrade pwntools



However, some of the features (assembling/disassembling foreign architectures) require non-Python dependencies.  For more information, see the complete installation instructions here.


 Contribution

See CONTRIBUTING.md

 Contact and Community
If you have any questions not worthy of a bug report, join the Discord server at https://discord.gg/96VA2zvjCB