Skip to content

Commit 3c211c0

Browse files
committed
Update docs for new capabilities and add a build workflow
1 parent 103d825 commit 3c211c0

File tree

2 files changed

+54
-32
lines changed

2 files changed

+54
-32
lines changed

.github/workflows/gh-pages.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: github pages
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-18.04
11+
steps:
12+
- uses: actions/checkout@v2
13+
14+
- name: Build
15+
uses: ammaraskar/sphinx-action@master
16+
with:
17+
pre-build-command: python -mpip install sphinx-rtd-theme
18+
docs-folder: "docs/"
19+
20+
- name: Deploy
21+
uses: peaceiris/actions-gh-pages@v3
22+
with:
23+
github_token: ${{ secrets.GITHUB_TOKEN }}
24+
publish_dir: ./docs/_build/html
25+
force_orphan: true

docs/index.rst

+29-32
Original file line numberDiff line numberDiff line change
@@ -450,10 +450,24 @@ These are the attributes (:class:`set` refers to each of the above objects):
450450
Enable and disable kernel auditing; change auditing filter rules; retrieve
451451
auditing status and filtering rules.
452452

453+
.. attribute:: set.audit_read
454+
455+
Allow reading the audit log via a multicast netlink socket.
456+
453457
.. attribute:: set.audit_write
454458

455459
Write records to kernel auditing log.
456460

461+
.. attribute:: set.block_suspend
462+
463+
Employ features that can block system suspend (:manpage:`epoll(7)`
464+
:const:`EPOLLWAKEUP`, :file:`/proc/sys/wake_lock`).
465+
466+
.. attribute:: set.bpf
467+
468+
Employ privileged BPF operations; see :manpage:`bpf(2)` and
469+
:manpage:`bpf-helpers(7)`.
470+
457471
.. attribute:: set.chown
458472

459473
Make arbitrary changes to file UIDs and GIDs (see :manpage:`chown(2)`).
@@ -510,14 +524,12 @@ These are the attributes (:class:`set` refers to each of the above objects):
510524

511525
.. attribute:: set.mac_admin
512526

513-
Override Mandatory Access Control (MAC). Implemented for the Smack Linux
514-
Security Module (LSM).
527+
Allow MAC configuration or state changes. Implemented for the Smack LSM.
515528

516529
.. attribute:: set.mac_override
517530

518-
Allow MAC configuration or state changes. Implemented for the Smack LSM.
519-
520-
.. The above two were copied from the manpage, but they seem to be swapped. Hmm...
531+
Override Mandatory Access Control (MAC). Implemented for the Smack Linux
532+
Security Module (LSM).
521533

522534
.. attribute:: set.mknod
523535

@@ -542,6 +554,12 @@ These are the attributes (:class:`set` refers to each of the above objects):
542554

543555
Use :const:`RAW` and :const:`PACKET` sockets.
544556

557+
.. attribute:: set.perfmon
558+
559+
Employ various performance-monitoring mechanisms, including
560+
:func:`perf_event_open` and various BPF operations that have performance
561+
implications..
562+
545563
.. attribute:: set.setgid
546564

547565
Make arbitrary manipulations of process GIDs and supplementary GID list;
@@ -579,23 +597,8 @@ These are the attributes (:class:`set` refers to each of the above objects):
579597

580598
.. attribute:: set.sys_admin
581599

582-
* Perform a range of system administration operations including:
583-
:func:`quotactl`, func:`mount`, :func:`umount`, :func:`swapon`,
584-
:func:`swapoff`, :func:`sethostname`, and :func:`setdomainname`.
585-
* Perform :const:`IPC_SET` and :const:`IPC_RMID` operations on arbitrary
586-
System V IPC objects.
587-
* Perform operations on trusted and security Extended Attributes (see
588-
:manpage:`attr(5)`).
589-
* Use :func:`lookup_dcookie`.
590-
* Use :func:`ioprio_set` to assign the :const:`IOPRIO_CLASS_RT` scheduling
591-
class.
592-
* Forge UID when passing socket credentials.
593-
* Exceed :file:`/proc/sys/fs/file-max`, the system-wide limit on the number
594-
of open files, in system calls that open files (e.g., :func:`accept`,
595-
:func:`execve`, :func:`open`, :func:`pipe`).
596-
* Employ :const:`CLONE_NEWNS` flag with :func:`clone` and :func:`unshare`.
597-
* Perform :const:`KEYCTL_CHOWN` and :const:`KEYCTL_SETPERM` :func:`keyctl`
598-
operations.
600+
Perform a range of system administration operations, which change per kernel
601+
version. See :manpage:`capabilities(7)` for details.
599602

600603
.. attribute:: set.sys_boot
601604

@@ -636,19 +639,13 @@ These are the attributes (:class:`set` refers to each of the above objects):
636639

637640
.. attribute:: set.sys_rawio
638641

639-
Perform I/O port operations (:func:`iopl` and :func:`ioperm`); access
640-
:file:`/proc/kcore`.
642+
Perform a range of privileged i/o operations, which change per kernel
643+
version. See :manpage:`capabilities(7)` for details.
641644

642645
.. attribute:: set.sys_resource
643646

644-
* Use reserved space on ext2 file systems.
645-
* Make :func:`ioctl` calls controlling ext3 journaling.
646-
* Override disk quota limits.
647-
* Increase resource limits (see :manpage:`setrlimit(2)`).
648-
* Override :const:`RLIMIT_NPROC` resource limit.
649-
* Raise :c:data:`msg_qbytes` limit for a System V message queue above the
650-
limit in :file:`/proc/sys/kernel/msgmnb` (see :manpage:`msgop(2)` and
651-
:manpage:`msgctl(2)`).
647+
Use a set of privileged resources, which change per kernel version. See
648+
:manpage:`capabilities(7)` for details.
652649

653650
.. attribute:: set.sys_time
654651

0 commit comments

Comments
 (0)