PWNtools

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.

The primary location for this documentation is at docs.pwntools.com, which uses readthedocs. It comes in three primary flavors:

• Stable
• Beta
• Dev

Getting Started

• About pwntools
  • pwn — Toolbox optimized for CTFs
  • pwnlib — Normal python library
• Installation
  • Prerequisites
    • Binutils
    • Python Development Headers
  • Released Version
  • Development
• Getting Started
  • Making Connections
  • Packing Integers
  • Setting the Target Architecture and OS
  • Setting Logging Verbosity
  • Assembly and Disassembly
  • Misc Tools
  • ELF Manipulation
• from pwn import *
• Command Line Tools
  • pwn
    • pwn asm
    • pwn checksec
    • pwn constgrep
    • pwn cyclic
    • pwn debug
    • pwn disablenx
    • pwn disasm
    • pwn elfdiff
    • pwn elfpatch
    • pwn errno
    • pwn hex
    • pwn phd
    • pwn pwnstrip
    • pwn scramble
    • pwn shellcraft
    • pwn template
    • pwn unhex
    • pwn update

Module Index

Each of the pwntools modules is documented here.

• pwnlib.adb — Android Debug Bridge
• pwnlib.args — Magic Command-Line Arguments
• pwnlib.asm — Assembler functions
• pwnlib.atexception — Callbacks on unhandled exception
• pwnlib.atexit — Replacement for atexit
• pwnlib.constants — Easy access to header file constants
• pwnlib.config — Pwntools Configuration File
• pwnlib.context — Setting runtime variables
• pwnlib.dynelf — Resolving remote functions using leaks
• pwnlib.encoders — Encoding Shellcode
• pwnlib.elf — ELF Executables and Libraries
• pwnlib.exception — Pwnlib exceptions
• pwnlib.flag — CTF Flag Management
• pwnlib.fmtstr — Format string bug exploitation tools
• pwnlib.gdb — Working with GDB
• pwnlib.libcdb — Libc Database
• pwnlib.log — Logging stuff
• pwnlib.memleak — Helper class for leaking memory
• pwnlib.protocols — Wire Protocols
• pwnlib.qemu — QEMU Utilities
• pwnlib.replacements — Replacements for various functions
• pwnlib.rop — Return Oriented Programming
• pwnlib.rop.rop — Return Oriented Programming
• pwnlib.rop.srop — Sigreturn Oriented Programming
• pwnlib.runner — Running Shellcode
• pwnlib.shellcraft — Shellcode generation
• pwnlib.shellcraft.aarch64 — Shellcode for AArch64
• pwnlib.shellcraft.amd64 — Shellcode for AMD64
• pwnlib.shellcraft.arm — Shellcode for ARM
• pwnlib.shellcraft.common — Shellcode common to all architecture
• pwnlib.shellcraft.i386 — Shellcode for Intel 80386
• pwnlib.shellcraft.mips — Shellcode for MIPS
• pwnlib.regsort — Register sorting
• pwnlib.shellcraft.thumb — Shellcode for Thumb Mode
• pwnlib.term — Terminal handling
• pwnlib.timeout — Timeout handling
• pwnlib.tubes — Talking to the World!
• pwnlib.tubes.process — Processes
• pwnlib.tubes.serialtube — Serial Ports
• pwnlib.tubes.sock — Sockets
• pwnlib.tubes.ssh — SSH
• pwnlib.ui — Functions for user interaction
• pwnlib.update — Updating Pwntools
• pwnlib.useragents — A database of useragent strings
• pwnlib.util.crc — Calculating CRC-sums
• pwnlib.util.cyclic — Generation of unique sequences
• pwnlib.util.fiddling — Utilities bit fiddling
• pwnlib.util.hashes — Hashing functions
• pwnlib.util.iters — Extension of standard module itertools
• pwnlib.util.lists — Operations on lists
• pwnlib.util.misc — We could not fit it any other place
• pwnlib.util.net — Networking interfaces
• pwnlib.util.packing — Packing and unpacking of strings
• pwnlib.util.proc — Working with /proc/
• pwnlib.util.safeeval — Safe evaluation of python code
• pwnlib.util.sh_string — Shell Expansion is Hard
• pwnlib.util.web — Utilities for working with the WWW

Indices and tables

• Index
• Module Index
• Search Page