ptrace is a system call found in Unix and several Unix-like operating systems. By using ptrace (the name is an abbreviation of "process trace") one process can control another, enabling the controller to inspect and manipulate the internal state of its target. ptrace is used by debuggers and other code-analysis tools, mostly as aids to software development.
ptrace is used by debuggers (such as gdb and dbx), by tracing tools like strace and ltrace, and by code coverage tools. ptrace is also used by specialized programs to patch running programs, to avoid unfixed bugs or to overcome security features. It can further be used as a sandbox and as a run-time environment simulator (like emulating root access for non-root software).
By attaching to another process using the ptrace call, a tool has extensive control over the operation of its target. This includes manipulation of its file descriptors, memory, and registers. It can single-step through the target's code, can observe and intercept system calls and their results, and can manipulate the target's signal handlers and both receive and send signals on its behalf. The ability to write into the target's memory allows not only its data store to be changed, but also the application's own code segment, allowing the controller to install breakpoints and patch the running code of the target.
As the ability to inspect and alter another process is very powerful, ptrace can attach only to processes that the owner can send signals to (typically only their own processes); the superuser account can ptrace almost any process (except init on kernels before 2.6.26). In Linux systems that feature capabilities-based security, the ability to ptrace is further limited by the CAP_SYS_PTRACE capability or by the YAMA Linux Security Module. In FreeBSD, it's limited by FreeBSD jails and Mandatory Access Control policies.
Communications between the controller and target take place using repeated calls of ptrace, passing a small fixed-size block of memory between the two (necessitating two context switches per call); this is acutely inefficient when accessing large amounts of the target's memory, as this can only be done in word sized blocks (with a ptrace call for each word). For this reason the 8th edition of Unix introduced procfs, which allows permitted processes direct access to the memory of another process - 4.4BSD followed, and the use of /proc for debugger support was inherited by Solaris, BSD, and AIX, and mostly copied by Linux. Some, such as Solaris, have removed ptrace as a system call altogether, retaining it as a library call that reinterprets calls to ptrace in terms of the platform's procfs. Such systems use ioctls on the file descriptor of the opened /proc file to issue commands to the controlled process. FreeBSD, on the other hand, extended ptrace to remove mentioned problems, and declared procfs obsolete due to its inherent design problems.[vague]
ptrace only provides the most basic interface necessary to support debuggers and similar tools. Programs using it must have intimate knowledge of the specifics of the OS and architecture, including stack layout, application binary interface, system call mechanism, name mangling, the format of any debug data, and are responsible for understanding and disassembling machine code themselves. Further, programs that inject executable code into the target process or (like gdb) allow the user to enter commands that are executed in the context of the target must generate and load that code themselves, generally without the help of the program loader.
Unix and BSD
ptrace was first implemented in Version 6 Unix, and was present in both the SVr4 and 4.3BSD branches of Unix. ptrace is available as a system call on IRIX, IBM AIX, NetBSD, FreeBSD, OpenBSD, and Linux. ptrace is implemented as a library call on Solaris, built on the Solaris kernel's procfs filesystem; Sun notes that ptrace on Solaris is intended for compatibility, and recommends that new implementations use the richer interface that proc supplies instead. UnixWare also features a limited ptrace but like Sun, SCO recommends implementers use the underlying procfs features instead. HP-UX supported ptrace until release 11i v3 (it was deprecated in favour of ttrace, a similar OS-specific call, in 11i v1).
Apple's Mac OS X also implements ptrace as a system call. Apple's version adds a special option PT_DENY_ATTACH – if a process invokes this option on itself, subsequent attempts to ptrace the process will fail. Apple uses this feature to limit the use of debuggers on programs that manipulate DRM-ed content, including iTunes. PT_DENY_ATTACH on also disables DTrace's ability to monitor the process. Debuggers on OS X typically use a combination of ptrace and the Mach VM and thread APIs. ptrace (again with PT_DENY_ATTACH) is available to developers for the Apple iPhone.
Linux also gives processes the ability to prevent other processes from attaching to them. Processes can call the prctl syscall and clear their PR_SET_DUMPABLE flag; in later kernels this prevents non-root processes from ptracing the calling process; the OpenSSH authentication agent uses this mechanism to prevent ssh session hijacking via ptrace. Later Ubuntu versions ship with a Linux kernel configured to prevent ptrace attaches from processes other than the traced process' parent; this allows gdb and strace to continue to work when running a target process, but prevents them from attaching to an unrelated running process. Control of this feature is performed via the /proc/sys/kernel/yama/ptrace_scope setting. On systems where this feature is enabled, commands like "gdb --attach" and "strace -p" will not work.
- "Fakeroot NG". Retrieved 2020-05-12.
- For example retty uses ptrace to alter another process' file descriptors, and to inject executable code into the target's text segment
- "ptrace(2) manpage", Linux manual section 2
- Yama.txt in Linux Git
- The Design and Implementation of the 4.4 BSD Operating System, Marshall Kirk McKusick, Keith Bostic, Michael J. Karels, John Quarterman, Addison-Wesley, April 1996, ISBN 0-201-54979-4
- "ptrace() Request Values", Solaris Transition Guide, Sun Microsystems, 2000
- "ptrace(2)", IRIX 6.5 manual, section 2, SGI techpubs library
- "ptrace,ptracex,ptrace64 subroutine", IBM AIX Technical Reference: Base Operating System and Extensions, Volume 1
- ptrace(2), netbsd manual, section 2
- , FreeBSD manual, section 2
- "ptrace(2)", OpenBSD manual, section 2
- ptrace(2), SCO UnixWare 7 manual, section 2
- "System call compatibility notes" Archived 2011-07-16 at the Wayback Machine, UnixWare 7 Documentation
- "ptrace() System Call (Obsolete)", HP-UX 11i Version 3 Release Notes: HP 9000 and HP Integrity Servers, Hewlett Packard, February 2007
- "ptrace(2) manual page", Apple Darwin/OS-X manual
- "Owning the Fanboys : Hacking Mac OS X", Charlie Miller, Black Hat Briefings conference 2008
- "Apple 'breaks' Sun developer app", Matthew Broersma, Computerworld UK, 24 January 2008
- Chapter 9, Mac OS X internals: a systems approach, Amit Singh, ISBN 978-0-321-27854-8, Addison Wesley, 2006
- "ptrace(2)", BSD System Calls Manual, Apple iPhone OS Reference Library
- "KernelHardening", Ubuntu security team roadmap
- "prctl(2)", Linux programmer's manual, section 2
- "PATCH ptrace: allow restriction of ptrace scope" posting by Canonical Ltd. engineer Kees Cook, Linux Kernel mailing list, June 16, 2010