mirror of
https://github.com/LadybirdBrowser/ladybird.git
synced 2024-11-23 08:00:20 +00:00
Base: Add a man page about pledge(2)
This commit is contained in:
parent
8b54ba0d61
commit
f3eb06a46f
Notes:
sideshowbarker
2024-07-19 10:07:55 +09:00
Author: https://github.com/awesomekling Commit: https://github.com/SerenityOS/serenity/commit/f3eb06a46fb
1 changed files with 52 additions and 0 deletions
52
Base/usr/share/man/man2/pledge.md
Normal file
52
Base/usr/share/man/man2/pledge.md
Normal file
|
@ -0,0 +1,52 @@
|
|||
## Name
|
||||
|
||||
pledge - reduce process capabilities
|
||||
|
||||
## Synopsis
|
||||
|
||||
```**c++
|
||||
#include <unistd.h>
|
||||
|
||||
int pledge(const char* promises, const char* execpromises);
|
||||
```
|
||||
|
||||
## Description
|
||||
|
||||
`pledge()` makes a promise to the kernel that from this moment on, it 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)](fork.md).
|
||||
|
||||
`execpromises` are applied if/when a new process image is created with [`exec(2)`](exec.md).
|
||||
|
||||
If `promises` or `execpromises` is null, the corresponding value is unchanged.
|
||||
|
||||
## Promises
|
||||
|
||||
* `stdio`: Basic I/O, memory allocation, information about self, various non-desctructive syscalls
|
||||
* `thread`: The POSIX threading API
|
||||
* `id`: Ability to change UID/GID
|
||||
* `tty`: TTY related functionility
|
||||
* `proc`: Process and scheduling related functionality
|
||||
* `exec`: The [`exec(2)`](exec.md) syscall
|
||||
* `tty`: TTY related functionility
|
||||
* `unix`: UNIX local domain sockets
|
||||
* `inet`: IPv4 domain 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
|
||||
* `shared_buffer`: Shared memory buffers
|
||||
* `chroot`: The [`chroot(2)`](chroot.md) syscall
|
||||
* `video`: May use [`ioctl(2)`](ioctl.md) and [`mmap(2)`](mmap.md) on framebuffer video devices
|
||||
|
||||
## 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.
|
Loading…
Reference in a new issue