aboutsummaryrefslogtreecommitdiffstats
path: root/src/man/firejail.txt
diff options
context:
space:
mode:
Diffstat (limited to 'src/man/firejail.txt')
-rw-r--r--src/man/firejail.txt63
1 files changed, 32 insertions, 31 deletions
diff --git a/src/man/firejail.txt b/src/man/firejail.txt
index 9e89d4e79..68deb85ec 100644
--- a/src/man/firejail.txt
+++ b/src/man/firejail.txt
@@ -42,6 +42,15 @@ Miscellaneous:
42firejail {\-? | \-\-debug-caps | \-\-debug-errnos | \-\-debug-syscalls | \-\-debug-syscalls32 | \-\-debug-protocols | \-\-help | \-\-version} 42firejail {\-? | \-\-debug-caps | \-\-debug-errnos | \-\-debug-syscalls | \-\-debug-syscalls32 | \-\-debug-protocols | \-\-help | \-\-version}
43.RE 43.RE
44.SH DESCRIPTION 44.SH DESCRIPTION
45#ifdef HAVE_LTS
46This is Firejail long-term support (LTS), an enterprise focused version of the software,
47LTS is usually supported for two or three years.
48During this time only bugs and the occasional documentation problems are fixed.
49The attack surface of the SUID executable was greatly reduced by removing some of the features.
50.br
51
52.br
53#endif
45Firejail is a SUID sandbox program that reduces the risk of security breaches by 54Firejail is a SUID sandbox program that reduces the risk of security breaches by
46restricting the running environment of untrusted applications using Linux 55restricting the running environment of untrusted applications using Linux
47namespaces, seccomp-bpf and Linux capabilities. 56namespaces, seccomp-bpf and Linux capabilities.
@@ -146,12 +155,6 @@ $ firejail --appimage --private krita-3.0-x86_64.appimage
146$ firejail --appimage --net=none --x11 krita-3.0-x86_64.appimage 155$ firejail --appimage --net=none --x11 krita-3.0-x86_64.appimage
147#endif 156#endif
148.TP 157.TP
149\fB\-\-audit
150Audit the sandbox, see \fBAUDIT\fR section for more details.
151.TP
152\fB\-\-audit=test-program
153Audit the sandbox, see \fBAUDIT\fR section for more details.
154.TP
155\fB\-\-bandwidth=name|pid 158\fB\-\-bandwidth=name|pid
156Set bandwidth limits for the sandbox identified by name or PID, see \fBTRAFFIC SHAPING\fR section for more details. 159Set bandwidth limits for the sandbox identified by name or PID, see \fBTRAFFIC SHAPING\fR section for more details.
157.TP 160.TP
@@ -1105,6 +1108,26 @@ Example:
1105$ firejail \-\-machine-id 1108$ firejail \-\-machine-id
1106 1109
1107.TP 1110.TP
1111\fB\-\-mkdir=dirname
1112Create a directory in user home. Parent directories are created as needed.
1113.br
1114
1115.br
1116Example:
1117.br
1118$ firejail --mkdir=~/work/project
1119
1120.TP
1121\fB\-\-mkfile=filename
1122Create an empty file in user home.
1123.br
1124
1125.br
1126Example:
1127.br
1128$ firejail --mkfile=~/work/project/readme
1129
1130.TP
1108\fB\-\-memory-deny-write-execute 1131\fB\-\-memory-deny-write-execute
1109Install a seccomp filter to block attempts to create memory mappings 1132Install a seccomp filter to block attempts to create memory mappings
1110that are both writable and executable, to change mappings to be 1133that are both writable and executable, to change mappings to be
@@ -1622,6 +1645,7 @@ Disable video devices.
1622\fB\-\-nowhitelist=dirname_or_filename 1645\fB\-\-nowhitelist=dirname_or_filename
1623Disable whitelist for this directory or file. 1646Disable whitelist for this directory or file.
1624 1647
1648#ifdef HAVE_OUTPUT
1625.TP 1649.TP
1626\fB\-\-output=logfile 1650\fB\-\-output=logfile
1627stdout logging and log rotation. Copy stdout to logfile, and keep the size of the file under 500KB using log 1651stdout logging and log rotation. Copy stdout to logfile, and keep the size of the file under 500KB using log
@@ -1652,6 +1676,7 @@ $ ls -l sandboxlog*
1652.TP 1676.TP
1653\fB\-\-output-stderr=logfile 1677\fB\-\-output-stderr=logfile
1654Similar to \-\-output, but stderr is also stored. 1678Similar to \-\-output, but stderr is also stored.
1679#endif
1655 1680
1656#ifdef HAVE_OVERLAYFS 1681#ifdef HAVE_OVERLAYFS
1657.TP 1682.TP
@@ -2451,7 +2476,7 @@ $ firejail --seccomp.print=browser
2451$ 2476$
2452 2477
2453.TP 2478.TP
2454\fB\-\-seccomp-error-action= kill | ERRNO 2479\fB\-\-seccomp-error-action= kill | ERRNO | log
2455By default, if a seccomp filter blocks a system call, the process gets 2480By default, if a seccomp filter blocks a system call, the process gets
2456EPERM as the error. With \-\-seccomp-error-action=error, another error 2481EPERM as the error. With \-\-seccomp-error-action=error, another error
2457number can be returned, for example ENOSYS or EACCES. The process can 2482number can be returned, for example ENOSYS or EACCES. The process can
@@ -2941,30 +2966,6 @@ To enable AppArmor confinement on top of your current Firejail security features
2941$ firejail --apparmor firefox 2966$ firejail --apparmor firefox
2942#endif 2967#endif
2943 2968
2944.SH AUDIT
2945Audit feature allows the user to point out gaps in security profiles. The
2946implementation replaces the program to be sandboxed with a test program. By
2947default, we use faudit program distributed with Firejail. A custom test program
2948can also be supplied by the user. Examples:
2949
2950Running the default audit program:
2951.br
2952 $ firejail --audit transmission-gtk
2953
2954Running a custom audit program:
2955.br
2956 $ firejail --audit=~/sandbox-test transmission-gtk
2957
2958In the examples above, the sandbox configures transmission-gtk profile and
2959starts the test program. The real program, transmission-gtk, will not be
2960started.
2961
2962You can also audit a specific profile without specifying a program.
2963.br
2964 $ firejail --audit --profile=/etc/firejail/zoom.profile
2965
2966Limitations: audit feature is not implemented for --x11 commands.
2967
2968.SH DESKTOP INTEGRATION 2969.SH DESKTOP INTEGRATION
2969A symbolic link to /usr/bin/firejail under the name of a program, will start the program in Firejail sandbox. 2970A symbolic link to /usr/bin/firejail under the name of a program, will start the program in Firejail sandbox.
2970The symbolic link should be placed in the first $PATH position. On most systems, a good place 2971The symbolic link should be placed in the first $PATH position. On most systems, a good place