From 9366d1925db4e095a77125f03f3d1648f4c179f5 Mon Sep 17 00:00:00 2001 From: Vit Mojzis Date: Thu, 1 Jun 2023 16:39:13 +0200 Subject: [PATCH] sandbox: Add examples to man pages Content-type: text/plain While at it, remove trailing whitespaces. Signed-off-by: Vit Mojzis Acked-by: Petr Lautrbach --- sandbox/sandbox.8 | 28 ++++++++++++++++++---------- sandbox/seunshare.8 | 21 ++++++++++++++------- 2 files changed, 32 insertions(+), 17 deletions(-) diff --git a/sandbox/sandbox.8 b/sandbox/sandbox.8 index 775e4b231204..1c1870190e51 100644 --- a/sandbox/sandbox.8 +++ b/sandbox/sandbox.8 @@ -11,12 +11,12 @@ sandbox \- Run cmd under an SELinux sandbox .br .SH DESCRIPTION .PP -Run the -.I cmd +Run the +.I cmd application within a tightly confined SELinux domain. The default sandbox domain only allows applications the ability to read and write stdin, stdout and any other file descriptors handed to it. It is not allowed to open any other files. The \-M option will mount an alternate homedir and tmpdir to be used by the sandbox. -If you have the -.I policycoreutils-sandbox +If you have the +.I policycoreutils-sandbox package installed, you can use the \-X option and the \-M option. .B sandbox \-X allows you to run X applications within a sandbox. These applications will start up their own X Server and create a temporary home directory and /tmp. The default SELinux policy does not allow any capabilities or network access. It also prevents all access to the users other processes and files. Files specified on the command that are in the home directory or /tmp will be copied into the sandbox directories. @@ -78,27 +78,35 @@ Run a full desktop session, Requires level, and home and tmpdir. Specifies the windowsize when creating an X based Sandbox. The default windowsize is 1000x700. .TP \fB\-W\fR \fB\-\-windowmanager\fR -Select alternative window manager to run within +Select alternative window manager to run within .B sandbox \-X. Default to /usr/bin/matchbox-window-manager. .TP -\fB\-X\fR +\fB\-X\fR Create an X based Sandbox for gui apps, temporary files for $HOME and /tmp, secondary Xserver, defaults to sandbox_x_t .TP \fB\-d\fR \fB\-\-dpi\fR Set the DPI value for the sandbox X Server. Defaults to the current X Sever DPI. .TP -\fB\-C\fR \fB\-\-capabilities\fR Use capabilities within the -sandbox. By default applications executed within the sandbox will not -be allowed to use capabilities (setuid apps), with the \-C flag, you -can use programs requiring capabilities. +\fB\-C\fR \fB\-\-capabilities\fR +Use capabilities within the sandbox. By default applications executed within the sandbox will not be allowed to use capabilities (setuid apps), with the \-C flag, you can use programs requiring capabilities. .PP .SH "SEE ALSO" .TP runcon(1), seunshare(8), selinux(8) .PP +.SH EXAMPLE +.nf +Run a graphical application inside the sandbox +# sandbox -X evince +Run a graphical application that requires the use of network +# sandbox ‑X ‑t sandbox_web_t firefox +Preserve data from one session to the next +# mkdir -p ~/sandbox/home ~/sandbox/tmp +# sandbox -H ~/sandbox/home -T ~/sandbox/tmp -X libreoffice --writer + .SH AUTHOR This manual page was written by .I Dan Walsh diff --git a/sandbox/seunshare.8 b/sandbox/seunshare.8 index 09cf7feae45d..5339a3b1fb20 100644 --- a/sandbox/seunshare.8 +++ b/sandbox/seunshare.8 @@ -9,29 +9,36 @@ seunshare \- Run cmd with alternate homedir, tmpdir and/or SELinux context .PP Run the .I executable -within the specified context, using the alternate home directory and /tmp directory. The seunshare command unshares from the default namespace, then mounts the specified homedir and tmpdir over the default homedir and /tmp. Finally it tells the kernel to execute the application under the specified SELinux context. +within the specified context, using custom home directory and /tmp directory. The seunshare command unshares from the default namespace, then mounts the specified homedir and tmpdir over the default homedir and /tmp. Finally it tells the kernel to execute the application under the specified SELinux context. .TP \fB\-h homedir\fR -Alternate homedir to be used by the application. Homedir must be owned by the user. +Alternate homedir to be used by the application. Homedir must be owned by the user .TP \fB\-t\ tmpdir -Use alternate temporary directory to mount on /tmp. tmpdir must be owned by the user. +Use alternate temporary directory to mount on /tmp. tmpdir must be owned by the user .TP \fB\-r\ runuserdir -Use alternate temporary directory to mount on XDG_RUNTIME_DIR (/run/user/$UID). runuserdir must be owned by the user. +Use alternate temporary directory to mount on XDG_RUNTIME_DIR (/run/user/$UID). runuserdir must be owned by the user .TP \fB\-C --capabilities\fR -Allow apps executed within the namespace to use capabilities. Default is no capabilities. +Allow apps executed within the namespace to use capabilities. Default is no capabilities .TP \fB\-k --kill\fR -Kill all processes with matching MCS level. +Kill all processes with matching MCS level .TP \fB\-Z\ context -Use alternate SELinux context while running the executable. +Use alternate SELinux context while running the executable .TP \fB\-v\fR Verbose output + +.SH EXAMPLE +.nf +Run bash with temporary /home and /tmp directory +# USERHOMEDIR=`mktemp -d /tmp/home.XXXXXX`; USERTEMPDIR=`mktemp -d /tmp/temp.XXXXXX` +# seunshare -v -h ${USERHOMEDIR} -t ${USERTEMPDIR} -- /bin/bash + .SH "SEE ALSO" .TP runcon(1), sandbox(8), selinux(8) -- 2.41.0