commands ¤

Pwndbg command implementations.

As well as various command-handling logic.

Modules:

• ai –

  This command sends information on the current debugging context to OpenAI's

• argv –
• aslr –
• asm –
• attachp –
• auxv –
• binder –
• binja –
• binja_functions –
• branch –
• buddydump –
• canary –
• checksec –
• comments –
• commpage –
• config –

  Dumps all pwndbg-specific configuration points.

• context –
• cpsr –
• cyclic –
• cymbol –

  Add, load, show, edit, or delete symbols for custom structures.

• dev –
• distance –
• dt –
• dumpargs –
• elf –
• flags –
• gdt –
• ghidra –
• godbg –
• got –
• got_tracking –
• hex2ptr –
• hexdump –
• hijack_fd –
• ida –
• ignore –

  Ignoring a breakpoint

• integration –
• ipython_interactive –

  Command to start an interactive IPython prompt.

• jemalloc –
• kbase –
• kbpf –
• kchecksec –
• kcmdline –
• kconfig –
• kdmabuf –
• kdmesg –

  Display the kernel ring buffer (dmesg) contents.

• killthreads –
• klookup –
• kmod –

  Displays information about loaded kernel modules. This command retrieves the list of kernel modules from the modules symbol

• knft –
• ksyscalls –

  Displays the syscall table for kernel debugging.

• ktask –

  Displays information about kernel tasks. This command iterates through the kernel's task list

• kversion –
• leakfind –

  Find a chain of leaks given some starting address.

• libcinfo –
• linkmap –
• mallocng –

  Commands that help with debugging musl's allocator, mallocng.

• memoize –
• misc –
• mmap –
• mprotect –
• msr –
• nearpc –
• next –

  Stepping until an event occurs

• onegadget –
• p2p –
• paging –
• parse_seccomp –
• patch –
• peda –
• pie –
• plist –
• probeleak –
• procinfo –
• profiler –

  Utilities for profiling pwndbg.

• ptmalloc2 –
• ptmalloc2_tracking –
• radare2 –
• reload –
• retaddr –
• rizin –
• rop –
• ropper –
• saved_register_frames –
• search –
• segments –
• sigreturn –
• slab –

  Commands for dealing with Linux kernel slab allocator. Currently, only SLUB is supported.

• spray –
• start –

  Launches the target process after setting a breakpoint at a convenient

• strings –
• telescope –

  Prints out pointer chains starting at some address in memory.

• tips –
• tls –

  Command to print the information of the current Thread Local Storage (TLS).

• valist –
• version –

  Implements version and bugreport commands.

• vmmap –

  Command to print the virtual memory map a la /proc/self/maps.

• windbg –

  Compatibility functionality for WinDbg users.

• xinfo –
• xor –

Classes:

• CommandCategory –
• InvalidDebuggerError –

  Raised when a command is called in a debugger for which

• CommandFormatter –

  The formatter_class that is passed to argparse for all

• CommandObj –

  Represents a command that can be invoked from the

• Command –

  Parametrized decorator for functions that serve as pwndbg commands.

Functions:

• fix –

  Fix a single command-line argument coming from the CLI.

• fix_reraise –
• fix_reraise_arg –

  fix_reraise wrapper for evaluating command arguments

• fix_int –
• fix_int_reraise –
• fix_int_reraise_arg –

  fix_int_reraise wrapper for evaluating command arguments

• func_name –
• OnlyWhenLocal –
• OnlyWithFile –
• OnlyWhenQemuKernel –
• OnlyWhenUserspace –
• OnlyWithKernelDebugInfo –
• OnlyWithKernelDebugSymbols –
• OnlyWhenPagingEnabled –
• OnlyWhenRunning –
• OnlyWithTcache –
• OnlyWhenHeapIsInitialized –
• OnlyWithResolvedHeapSyms –
• sloppy_gdb_parse –

  This function should be used as argparse.ArgumentParser .add_argument method's type helper.

• AddressExpr –

  Parses an address expression. Returns an int.

• HexOrAddressExpr –

  Parses string as hexadecimal int or an address expression. Returns an int.

• load_commands –

Attributes:

• log –
• T –
• P –
• commands (list[CommandObj]) –
• command_names (set[str]) –
• GDB_BUILTIN_COMMANDS –
• pwndbg_is_reloading –

log = getLogger(__name__)

T = TypeVar('T')

P = ParamSpec('P')

commands: list[CommandObj] = []

command_names: set[str] = set()

GDB_BUILTIN_COMMANDS = commands()

pwndbg_is_reloading = False

START = 'Start'

NEXT = 'Step/Next/Continue'

CONTEXT = 'Context'

PTMALLOC2 = 'GLibc ptmalloc2 Heap'

JEMALLOC = 'jemalloc Heap'

BREAKPOINT = 'Breakpoint'

MEMORY = 'Memory'

MUSL = 'musl'

STACK = 'Stack'

REGISTER = 'Register'

PROCESS = 'Process'

LINUX = 'Linux/libc/ELF'

DARWIN = 'Darwin/libsystem/Mach-O'

DISASS = 'Disassemble'

MISC = 'Misc'

KERNEL = 'Kernel'

INTEGRATIONS = 'Integrations'

WINDBG = 'WinDbg'

PWNDBG = 'Pwndbg'

SHELL = 'Shell'

DEV = 'Developer'

CommandObj(
    function: Callable[..., str | None],
    parser: ArgumentParser,
    command_name: str | None,
    category: CommandCategory,
    aliases: list[str],
    examples: str,
    notes: str,
)

builtin_override_whitelist: set[str] = {
    "up",
    "down",
    "search",
    "pwd",
    "start",
    "starti",
    "ignore",
}

history: dict[int, str] = {}

function = function

command_name = command_name

category = category

aliases = aliases

examples = strip()

notes = strip()

parser = parser

repeat = False

register_command()

has_notes_string(text: str) -> bool

has_examples_string(text: str) -> bool

initialize_parser()

invoke(argument: str, from_tty: bool) -> None

check_repeated(argument: str, from_tty: bool) -> bool

__call__(*args: Any, **kwargs: Any) -> str | None

Command(
    parser_or_desc: str | ArgumentParser,
    *,
    category: CommandCategory,
    command_name: str | None = None,
    aliases: list[str] = [],
    examples: str = "",
    notes: str = "",
    only_debuggers: set[DebuggerType] = None,
    exclude_debuggers: set[DebuggerType] = None,
)

parser = ArgumentParser(description=parser_or_desc)

category = category

command_name = command_name

aliases = aliases

examples = examples

notes = notes

only_debuggers = only_debuggers

exclude_debuggers = exclude_debuggers

__call__(function: Callable[..., Any]) -> CommandObj

fix(
    arg: str | Value,
    sloppy: bool = False,
    quiet: bool = True,
    reraise: bool = False,
) -> str | Value | None

fix_reraise(*a, **kw) -> str | Value | None

fix_reraise_arg(arg) -> Value

fix_int(*a, **kw) -> int

fix_int_reraise(*a, **kw) -> int

fix_int_reraise_arg(arg) -> int

func_name(function: Callable[P, T]) -> str

OnlyWhenLocal(function: Callable[P, T]) -> Callable[P, T | None]

OnlyWithFile(function: Callable[P, T]) -> Callable[P, T | None]

OnlyWhenQemuKernel(function: Callable[P, T]) -> Callable[P, T | None]

OnlyWhenUserspace(function: Callable[P, T]) -> Callable[P, T | None]

OnlyWithKernelDebugInfo(function: Callable[P, T]) -> Callable[P, T | None]

OnlyWithKernelDebugSymbols(
    function: Callable[P, T],
) -> Callable[P, T | None]

OnlyWhenPagingEnabled(function: Callable[P, T]) -> Callable[P, T | None]

OnlyWhenRunning(function: Callable[P, T]) -> Callable[P, T | None]

OnlyWithTcache(function: Callable[P, T]) -> Callable[P, T | None]

OnlyWhenHeapIsInitialized(
    function: Callable[P, T],
) -> Callable[P, T | None]

OnlyWithResolvedHeapSyms(function: Callable[P, T]) -> Callable[P, T | None]

sloppy_gdb_parse(s: str) -> int | str

AddressExpr(s: str) -> int

HexOrAddressExpr(s: str) -> int

load_commands() -> None