diff --git a/README.md b/README.md index cbf184fef..06a80dc86 100644 --- a/README.md +++ b/README.md @@ -14,14 +14,14 @@ It has a boatload of features, see our [Features page](https://pwndbg.re/pwndbg/ and [CHEATSHEET][CHEATSHEET] (feel free to print it!). If you have any questions you may read the [documentation](https://pwndbg.re/pwndbg/latest/) or asks us in our [Discord server](https://discord.gg/x47DssnGwm). -[CHEATSHEET]: https://pwndbg.re/pwndbg/latest/CHEATSHEET.pdf +[CHEATSHEET]: https://pwndbg.re/pwndbg/dev/CHEATSHEET.pdf ## Why? Vanilla GDB and LLDB are terrible to use for reverse engineering and exploit development. Typing `x/30gx $rsp` or navigating cumbersome LLDB commands is not fun and often provides minimal information. The year is 2025, and core debuggers still lack many user-friendly -features such as a robust hexdump command. Windbg users are completely lost when they +features such as a robust hexdump command. WinDbg users are completely lost when they occasionally need to bump into GDB or LLDB. Pwndbg is a Python module which can be loaded into GDB or run as a REPL interface for LLDB. diff --git a/docs/assets/caps/context_tui.png b/docs/assets/caps/context_tui.png index b91ff0ae9..550dcfebd 100644 Binary files a/docs/assets/caps/context_tui.png and b/docs/assets/caps/context_tui.png differ diff --git a/docs/assets/caps/procinfo.png b/docs/assets/caps/procinfo.png index 0761b0027..e632b47d9 100644 Binary files a/docs/assets/caps/procinfo.png and b/docs/assets/caps/procinfo.png differ diff --git a/docs/assets/caps/procinfo_curl.png b/docs/assets/caps/procinfo_curl.png new file mode 100644 index 000000000..1a1560545 Binary files /dev/null and b/docs/assets/caps/procinfo_curl.png differ diff --git a/docs/commands/index.md b/docs/commands/index.md index b0bd19b27..4d2064ce5 100644 --- a/docs/commands/index.md +++ b/docs/commands/index.md @@ -236,10 +236,10 @@ - [ew](windbg/ew.md) - Write hex words at the specified address. - [ez](windbg/ez.md) - Write a string at the specified address. - [eza](windbg/eza.md) - Write a string at the specified address. -- [go](windbg/go.md) - Windbg compatibility alias for 'continue' command. +- [go](windbg/go.md) - WinDbg compatibility alias for 'continue' command. - [k](windbg/k.md) - Print a backtrace (alias 'bt'). - [ln](windbg/ln.md) - List the symbols nearest to the provided value. -- [pc](windbg/pc.md) - Windbg compatibility alias for 'nextcall' command. +- [pc](windbg/pc.md) - WinDbg compatibility alias for 'nextcall' command. - [peb](windbg/peb.md) - Not be windows. ## jemalloc Heap diff --git a/docs/commands/linux_libc_elf/got.md b/docs/commands/linux_libc_elf/got.md index 543a7211d..e73da24ff 100644 --- a/docs/commands/linux_libc_elf/got.md +++ b/docs/commands/linux_libc_elf/got.md @@ -25,10 +25,15 @@ Show the state of the Global Offset Table. ### Examples ```text -got -got puts -got -p libc -got -a +> got + Print all writable GOT entries in the executable. +> got -r puts + Print all GOT entries that contain the string "puts". +> got -p libc + Print all writable GOT entries used by libc. (And any other loaded + object files that contain the string "libc" in their path). +> got -ra + Print all GOT entries in the address space. ``` diff --git a/docs/commands/windbg/go.md b/docs/commands/windbg/go.md index 01738b140..1a0643547 100644 --- a/docs/commands/windbg/go.md +++ b/docs/commands/windbg/go.md @@ -7,7 +7,7 @@ usage: go [-h] ``` -Windbg compatibility alias for 'continue' command. +WinDbg compatibility alias for 'continue' command. ### Optional arguments |Short|Long|Help| diff --git a/docs/commands/windbg/pc.md b/docs/commands/windbg/pc.md index da825059f..9ae944640 100644 --- a/docs/commands/windbg/pc.md +++ b/docs/commands/windbg/pc.md @@ -6,7 +6,7 @@ usage: pc [-h] ``` -Windbg compatibility alias for 'nextcall' command. +WinDbg compatibility alias for 'nextcall' command. ### Optional arguments |Short|Long|Help| diff --git a/docs/features.md b/docs/features.md index 4c680eaba..c1fe8cba6 100644 --- a/docs/features.md +++ b/docs/features.md @@ -107,9 +107,9 @@ While most other GDB plugins are well *GDB plugins*, Pwndbg's implementation is ![](assets/caps/lldb.png){ style="width: 70%;" } -## Windbg Compatibility +## WinDbg Compatibility -For those coming from a Windows background, Pwndbg has a complete Windbg compatibility layer. You can `dd`, `dps`, `eq`, and even `eb $rip 90` to your heart's content. +For those coming from a Windows background, Pwndbg has a complete WinDbg compatibility layer. You can `dd`, `dps`, `eq`, and even `eb $rip 90` to your heart's content. ![](assets/caps/windbg.png){ style="width: 70%;" } @@ -127,7 +127,8 @@ Go take a look at [Commands](commands/index.md)! Here is some cool stuff you can Use the [`procinfo`](commands/process/procinfo.md) command in order to inspect the current process state, like UID, GID, Groups, SELinux context, and open file descriptors! Pwndbg works particularly well with remote GDB debugging like with Android phones. -![](assets/caps/procinfo.png) +![](assets/caps/procinfo.png){ style="width: 50%;" } +![](assets/caps/procinfo_curl.png){ style="width: 50%;" } ### ROP Gadgets diff --git a/pwndbg/__init__.py b/pwndbg/__init__.py index 1ce4bcb8a..07630166e 100644 --- a/pwndbg/__init__.py +++ b/pwndbg/__init__.py @@ -17,10 +17,6 @@ from pwndbg import dbg as dbg_mod from pwndbg.dbg import dbg as dbg __version__ = pwndbg.lib.version.__version__ -""" -Pwndbg version. -""" +"""Pwndbg version.""" version = __version__ -""" -Pwndbg version. -""" +"""Pwndbg version.""" diff --git a/pwndbg/aglib/dt.py b/pwndbg/aglib/dt.py index f70814f6b..7bdd69781 100644 --- a/pwndbg/aglib/dt.py +++ b/pwndbg/aglib/dt.py @@ -1,5 +1,5 @@ """ -Prints structures in a manner similar to Windbg's "dt" command. +Prints structures in a manner similar to WinDbg's "dt" command. """ from __future__ import annotations @@ -33,7 +33,7 @@ def dt( obj: pwndbg.dbg_mod.Value | None = None, ) -> str: """ - Dump out a structure type Windbg style. + Dump out a structure type WinDbg style. """ # Return value is a list of strings.of # We concatenate at the end. diff --git a/pwndbg/commands/got.py b/pwndbg/commands/got.py index 5d1a54e3e..2cd990743 100644 --- a/pwndbg/commands/got.py +++ b/pwndbg/commands/got.py @@ -61,10 +61,15 @@ parser.add_argument( parser, category=CommandCategory.LINUX, examples=""" -got -got puts -got -p libc -got -a +> got + Print all writable GOT entries in the executable. +> got -r puts + Print all GOT entries that contain the string "puts". +> got -p libc + Print all writable GOT entries used by libc. (And any other loaded + object files that contain the string "libc" in their path). +> got -ra + Print all GOT entries in the address space. """, ) @pwndbg.commands.OnlyWhenRunning diff --git a/pwndbg/commands/windbg.py b/pwndbg/commands/windbg.py index a19375fc9..13a389830 100644 --- a/pwndbg/commands/windbg.py +++ b/pwndbg/commands/windbg.py @@ -1,5 +1,5 @@ """ -Compatibility functionality for Windbg users. +Compatibility functionality for WinDbg users. """ from __future__ import annotations @@ -425,12 +425,12 @@ if pwndbg.dbg.is_gdblib_available(): gdb.execute("bt") @pwndbg.commands.Command( - "Windbg compatibility alias for 'continue' command.", category=CommandCategory.WINDBG + "WinDbg compatibility alias for 'continue' command.", category=CommandCategory.WINDBG ) @pwndbg.commands.OnlyWhenRunning def go() -> None: """ - Windbg compatibility alias for 'continue' command. + WinDbg compatibility alias for 'continue' command. """ gdb.execute("continue") @@ -469,11 +469,11 @@ def peb() -> None: @pwndbg.commands.Command( - "Windbg compatibility alias for 'nextcall' command.", category=CommandCategory.WINDBG + "WinDbg compatibility alias for 'nextcall' command.", category=CommandCategory.WINDBG ) @pwndbg.commands.OnlyWhenRunning def pc(): """ - Windbg compatibility alias for 'nextcall' command. + WinDbg compatibility alias for 'nextcall' command. """ return pwndbg.commands.next.nextcall() diff --git a/pwndbg/lib/tips.py b/pwndbg/lib/tips.py index 1ec0fd41e..74072f39a 100644 --- a/pwndbg/lib/tips.py +++ b/pwndbg/lib/tips.py @@ -25,7 +25,7 @@ PWNDBG_TIPS: List[str] = [ "The `set show-flags on` setting will display CPU flags register in the regs context panel", "GDB and Pwndbg parameters can be shown or set with `show ` and `set ` GDB commands", "Use Pwndbg's `config` and `theme` commands to tune its configuration and theme colors!", - "Pwndbg mirrors some of Windbg commands like `eq`, `ew`, `ed`, `eb`, `es`, `dq`, `dw`, `dd`, `db`, `ds` for writing and reading memory", + "Pwndbg mirrors some of WinDbg commands like `eq`, `ew`, `ed`, `eb`, `es`, `dq`, `dw`, `dd`, `db`, `ds` for writing and reading memory", "Pwndbg resolves kernel memory maps by parsing page tables (default) or via `monitor info mem` QEMU gdbstub command (use `set kernel-vmmap-via-page-tables off` for that)", "Use the `vmmap` command for a better & colored memory maps display (than the GDB's `info proc mappings`)", "Use the `telescope` command to dereference a given address/pointer multiple times (if the dereferenced value is a valid ptr; see `config telescope` to configure its behavior)",