GEF - GDB Enhanced Features
GEF (pronounced ʤɛf - "Jeff") is a kick-ass set of commands for X86, ARM, MIPS, PowerPC and SPARC to make GDB cool again for exploit dev. It is aimed to be used mostly by exploit developers and reverse-engineers, to provide additional features to GDB using the Python API to assist during the process of dynamic analysis and exploit development.
It has full support for both Python2 and Python3 indifferently (as more and more
distros start pushing
gdb compiled with Python3 support).
A few of
GEF features include:
- One single GDB script
- Entirely OS Agnostic, NO dependencies:
GEFis battery-included and is installable instantly
- Fast limiting the number of dependencies and optimizing code to make the commands as fast as possible
- Provides a great variety of commands to drastically change your experience in GDB.
- Easily extensible to create other commands by providing more comprehensible layout to GDB Python API.
- Full Python3 support (Python2 support was dropped - see
- Built around an architecture abstraction layer, so all commands work in any GDB-supported architecture such as x86-32/64, ARMv5/6/7, AARCH64, SPARC, MIPS, PowerPC, etc.
- Suited for real-life apps debugging, exploit development, just as much as CTF
Check out the Screenshot page for more.
Or try it online (user:
Simply make sure you have GDB 7.7 or higher.
# via the install script $ wget -q -O- https://github.com/hugsy/gef/raw/master/scripts/gef.sh | sh # manually $ wget -O ~/.gdbinit-gef.py -q https://github.com/hugsy/gef/raw/master/gef.py $ echo source ~/.gdbinit-gef.py >> ~/.gdbinit
Alternatively from inside
$ gdb -q (gdb) pi \ import urllib.request as u, tempfile as t; \ g=t.NamedTemporaryFile(suffix='-gef.py'); \ open(g.name, 'wb+').write( u.urlopen('https://github.com/hugsy/gef/raw/master/gef.py').read() ); \ gdb.execute('source %s' % g.name)
Then just start playing (for local files):
$ gdb -q /path/to/my/bin gef➤ gef help
Or (for remote debugging):
remote:~ $ gdbserver 0.0.0.0:1234 /path/to/file Running as PID: 666
local:~ $ gdb -q gef➤ gef-remote -t your.ip.address:1234 -p 666
If your host/VM is connected to the Internet, you can update
gef easily to the
latest version (even without
git installed). with
python /path/to/gef.py --update
$ python ~/.gdbinit-gef.py --update Updated
This will deploy the latest version of
gef's master branch from Github.
If no updates are available,
gef will respond
No update instead.
Install via Git
To install from Git, simply clone this repository and specify the path to
gef.py inside the
$ git clone https://github.com/hugsy/gef.git $ echo source `pwd`/gef/gef.py >> ~/.gdbinit
If you like living on the edge, you can then switch to the
$ git checkout dev
There are none:
GEF works out of the box!
However, to enjoy all the coolest features from some commands, it is recommended to install:
For a quick installation, simply use the
pip packaged version:
# for Python2.x $ pip2 install capstone unicorn keystone-engine ropper # for Python3.x $ pip3 install capstone unicorn keystone-engine ropper
Just make sure you are using the
pip corresponding to the version of Python
your GDB was compiled with. If you are experiencing issues installing them,
post an issue on the GitHub of the respective projects. If your bug is not
GEF, you will not get an answer.
GEF was built to also provide a solid base for external scripts. The
gef-extras is an open
repository where anyone can freely submit their own commands to extend GDB via
To benefit from it:
# via the install script $ wget -q -O- https://github.com/hugsy/gef/raw/master/scripts/gef-extras.sh | sh # manually # clone the repo $ https://github.com/hugsy/gef-extras.git # specify gef to load this directory $ gdb -ex 'gef config gef.extra_plugins_dir "/path/to/gef-extras/scripts"' -ex 'gef save' -ex quit [+] Configuration saved
You can also use the structures defined from this repository:
$ gdb -ex 'gef config pcustom.struct_path "/path/to/gef-extras/structs"' -ex 'gef save' -ex quit [+] Configuration saved
There, you're now fully equipped epic pwnage with all GEF's goodness!!
Bugs & Feedbacks
gdb, exploitation or other topics, feel free to join our Discord channel.
For bugs or feature requests, just go here and provide a thorough description if you want help.
GEF fully relies on the GDB API and other Linux-specific sources of information (such as
/proc/<pid>). As a consequence, some of the features might not work on custom or hardened systems such as GrSec.
Or if you just like the tool, feel free to drop a simple "thanks" on Discord, Twitter or other, it is always very appreciated.
I love Open-Source, and just like my other projects I've decided to offer a :beer: 4 :bug: (a.k.a beer4bugs) bounty for
GEF, to thank everybody who helps keeping the project living and always better.
The rule is simple, provide a (substantial) contribution to
GEF, such as:
- Submitting a Pull-Request for a new feature/command.
- Submitting a Pull-Request for a new architecture support.
- Or sending a relevant issue request (like a bug, crash, or else).
Come on our Discord channel to talk about it, and next time we meet in person (like at a conference), I'll be happy to pay you a beer.
I do also accept beers if you think that the tool is cool! :wink: