pledge(2) - SerenityOS man pages

#Name

pledge - reduce process capabilities

#Synopsis

#include <unistd.h>

int pledge(const char* promises, const char* execpromises);

#Description

pledge() makes a promise to the kernel that from this moment on, the calling process will only use a subset of system functionality.

Functionality is divided into a curated set of promises (described below), which can be combined to cover the program's needs. Both arguments are space-separated lists of promises.

Note that pledge() can be called repeatedly to remove previously-pledged promises, but it can never regain capabilities once lost.

promises are applied to the current process, and will also be inherited by children created by fork(2).

execpromises are applied if/when a new process image is created with exec(2).

If promises or execpromises is null, the corresponding value is unchanged.

If the process later attempts to use any system functionality it has previously promised not to use, the process is instantly terminated. Note that a process that has not ever called pledge() is considered to not have made any promises, and is allowed use any system functionality (subject to regular permission checks).

pledge() is intended to be used in programs that want to sandbox themselves, either to limit the impact of a possible vulnerability exploitation, or before intentionally executing untrusted code.

#Promises

stdio: Basic I/O, memory allocation, information about self, various non-destructive syscalls
thread: The POSIX threading API (*)
id: Ability to change UID/GID
tty: TTY related functionality
proc: Process and scheduling related functionality
exec: The exec(2) syscall
unix: UNIX local domain sockets
inet: IPv4 domain sockets
accept: May use accept(2) to accept incoming socket connections on already listening sockets (*)
rpath: "Read" filesystem access
wpath: "Write" filesystem access
cpath: "Create" filesystem access
dpath: Creating new device files
chown: Changing file owner/group
fattr: Changing file attributes/permissions
video: May use ioctl(2) and mmap(2) on framebuffer video devices
settime: Changing the system time and date
setkeymap: Changing the system keyboard layout (*)
sigaction: Change signal handlers and dispositions (*)
sendfd: Send file descriptors over a local socket
recvfd: Receive file descriptors over a local socket
ptrace: The ptrace(2) syscall (*)
prot_exec: mmap(2) and mprotect(2) with PROT_EXEC
map_fixed: mmap(2) with MAP_FIXED or MAP_FIXED_NOREPLACE (*)
mount: mount(2) Various filesystem mount related syscalls (*)
unshare: Various unshare-specific syscalls (*)
no_error: Ignore requests of pledge elevation going forwards, this is useful for enforcing execpromises while the child process wants to ask for more upfront (Note that the elevation requests are not granted, merely ignored), this is similar to the error pledge in OpenBSD.

Promises marked with an asterisk (*) are SerenityOS specific extensions not supported by the original OpenBSD pledge().

#Errors

EFAULT: promises and/or execpromises are not null and not in readable memory.
EINVAL: One or more invalid promises were specified.
EPERM: An attempt to increase capabilities was rejected.
E2BIG: promises string or execpromises string are longer than all known promises strings together.

#History