You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Go to file
Gulshan Singh d0b14eea56
Add new flags to tests.sh (#1348)
3 years ago
.devcontainer Updated permissions for Docker container 4 years ago
.github Delete old issue template (#1343) 3 years ago
caps Try heap (#744) 6 years ago
docs Convert all vmmap references to pwndbg.gdblib.vmmap 3 years ago
gdb-pt-dump@f25898adc6 vmmap supports qemu aarch64 and riscv64 3 years ago
profiling Format shell scripts with shfmt (#1123) 3 years ago
pwndbg Refactor pwndbg.commands.windbg.dX and pwndbg.hexdump.hexdump (#1341) 3 years ago
tests Add new flags to tests.sh (#1348) 3 years ago
.gitignore Store coverage files in .cov directory 3 years ago
.gitmodules hack-pt-dump 3 years ago
.pylintrc Add support to use heap commands without debug symbols (#1029) 3 years ago
DEVELOPING.md Rename setup-test-tools.sh to setup-dev.sh (#1320) 3 years ago
Dockerfile Rename setup-test-tools.sh to setup-dev.sh (#1320) 3 years ago
FEATURES.md Fix typos 4 years ago
LICENSE.md license 11 years ago
README.md Update README with GDB build steps 3 years ago
dev-requirements.txt Implementing vermin into CI (#1319) 3 years ago
docker-compose.yml Set security_opt to seccomp:unconfined in docker-compose.yml (#1116) 3 years ago
gdbinit.py add patch command (#1150) 3 years ago
ida_script.py Linting/formatting improvements (#1138) 3 years ago
lint.sh Install shfmt on Ubuntu 22.04, otherwise skip running linter (#1323) 3 years ago
mkdocs.yml Add mkdocs documentation (#639) 7 years ago
pyproject.toml fix coverage generation 3 years ago
requirements.txt Cleanup dependencies (#1251) 3 years ago
setup-dev.sh Install a git pre-push lint hook as part of setup-test-tools.sh (#1345) 3 years ago
setup.cfg Add flake8-builtins to linters (#1254) 3 years ago
setup.sh Format shell scripts with shfmt (#1123) 3 years ago
tests.sh Fix config and theme commands 3 years ago

README.md

pwndbg

license Discord

pwndbg (/poʊndbæg/) is a GDB plug-in that makes debugging with GDB suck less, with a focus on features needed by low-level software developers, hardware hackers, reverse-engineers and exploit developers.

It has a boatload of features, see FEATURES.md.

Why?

Vanilla GDB is terrible to use for reverse engineering and exploit development. Typing x/g30x $esp is not fun, and does not confer much information. The year is 2022 and GDB still lacks a real hexdump command! GDB's syntax is arcane and difficult to approach. Windbg users are completely lost when they occasionally need to bump into GDB.

What?

Pwndbg is a Python module which is loaded directly into GDB, and provides a suite of utilities and crutches to hack around all of the cruft that is GDB and smooth out the rough edges.

Many other projects from the past (e.g., gdbinit, PEDA) and present (e.g. GEF) exist to fill some these gaps. Each provides an excellent experience and great features -- but they're difficult to extend (some are unmaintained, and all are a single 100KB, 200KB, or 363KB file (respectively)).

Pwndbg exists not only to replace all of its predecessors, but also to have a clean implementation that runs quickly and is resilient against all the weird corner cases that come up. It also comes batteries-included, so all of its features are available if you run setup.sh.

How?

Installation is straightforward. Pwndbg is best supported on Ubuntu 18.04 with GDB 7.11, and Ubuntu 20.04 with GDB 8.1.

git clone https://github.com/pwndbg/pwndbg
cd pwndbg
./setup.sh

Other Linux distributions are also supported via setup.sh, including:

  • Debian-based OSes (via apt-get)
  • Fedora and Red Hat (via dnf)
  • Clear (via swiped)
  • OpenSUSE LEAP (via zypper)
  • Arch and Manjaro (via community AUR packages)
  • Void (via xbps)
  • Gentoo (via emerge)

If you use any Linux distribution other than Ubuntu, we recommend using the latest available GDB built from source. You can build it as:

cd <gdb-sources-dir>
mkdir build
cd build
../configure --disable-nls --disable-werror --with-system-readline --with-python=`which python3` --with-system-gdbinit=/etc/gdb/gdbinit --enable-targets=all
make -j7

What can I do with that?

For further info about features/functionalities, see FEATURES.

Who?

Pwndbg is an open-source project, written and maintained by many contributors!

Want to help with development? Read CONTRIBUTING or join our Discord server!

How to develop?

To run tests locally you can do this in docker image, after cloning repo run simply

docker-compose run main ./tests.sh 

Disclaimer - this won't work on apple silicon macs.

Contact

If you have any questions not worthy of a bug report, feel free to ping anybody on Discord and ask away.