Skip to content

Commit

Permalink
Revert "allow/deny help and man pages"
Browse files Browse the repository at this point in the history 
This reverts commit a11707e.

The man pages currently direct users to use the aliases instead of the
commands, which some users of firejail-git may end up doing.  Example:

netblue30#4496

So revert the man page changes as well to avoid confusion.

Note: This is not a full revert.  The commit in question also contains
some string formatting fixes on src/firejail/usage.c (related to dbus
and netmask), which are left intact.

Relates to netblue30#4410.
  • Loading branch information
@kmk3
kmk3 committed Sep 2, 2021
1 parent a44fa49 commit dd13595
Show file tree
Hide file tree
Showing 4 changed files with 129 additions and 141 deletions.
4 changes: 2 additions & 2 deletions src/firejail/main.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1263,9 +1263,9 @@ int main(int argc, char **argv, char **envp) {
arg_debug = 1;
arg_quiet = 0;
}
else if (strcmp(argv[i], "--debug-deny") == 0)
else if (strcmp(argv[i], "--debug-blacklists") == 0)
arg_debug_blacklists = 1;
else if (strcmp(argv[i], "--debug-allow") == 0)
else if (strcmp(argv[i], "--debug-whitelists") == 0)
arg_debug_whitelists = 1;
else if (strcmp(argv[i], "--debug-private-lib") == 0)
arg_debug_private_lib = 1;
Expand Down
30 changes: 15 additions & 15 deletions src/firejail/usage.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ static char *usage_str =
"\n"
"Options:\n"
" -- - signal the end of options and disables further option processing.\n"
" --allow=filename - allow file system access.\n"
" --allow-debuggers - allow tools such as strace and gdb inside the sandbox.\n"
" --allusers - all user home directories are visible inside the sandbox.\n"
" --apparmor - enable AppArmor confinement.\n"
Expand All @@ -39,12 +38,13 @@ static char *usage_str =
#endif
" --bind=dirname1,dirname2 - mount-bind dirname1 on top of dirname2.\n"
" --bind=filename1,filename2 - mount-bind filename1 on top of filename2.\n"
" --build - build a profile for the application.\n"
" --build=filename - build a profile for the application.\n"
" --blacklist=filename - blacklist directory or file.\n"
" --build - build a whitelisted profile for the application.\n"
" --build=filename - build a whitelisted profile for the application.\n"
" --caps - enable default Linux capabilities filter.\n"
" --caps.drop=all - drop all capabilities.\n"
" --caps.drop=capability,capability - drop capabilities.\n"
" --caps.keep=capability,capability - allow capabilities.\n"
" --caps.drop=capability,capability - blacklist capabilities filter.\n"
" --caps.keep=capability,capability - whitelist capabilities filter.\n"
" --caps.print=name|pid - print the caps filter.\n"
#ifdef HAVE_FILE_TRANSFER
" --cat=name|pid filename - print content of file from sandbox container.\n"
Expand Down Expand Up @@ -75,18 +75,17 @@ static char *usage_str =
" --dbus-user.talk=name - allow talking to name on the session DBus.\n"
#endif
" --debug - print sandbox debug messages.\n"
" --debug-allow - debug file system access.\n"
" --debug-deny - debug file system access.\n"
" --debug-blacklists - debug blacklisting.\n"
" --debug-caps - print all recognized capabilities.\n"
" --debug-errnos - print all recognized error numbers.\n"
" --debug-private-lib - debug for --private-lib option.\n"
" --debug-protocols - print all recognized protocols.\n"
" --debug-syscalls - print all recognized system calls.\n"
" --debug-syscalls32 - print all recognized 32 bit system calls.\n"
" --debug-whitelists - debug whitelisting.\n"
#ifdef HAVE_NETWORK
" --defaultgw=address - configure default gateway.\n"
#endif
" --deny=filename - deny access to directory or file.\n"
" --deterministic-exit-code - always exit with first child's status code.\n"
" --dns=address - set DNS server.\n"
" --dns.print=name|pid - print DNS configuration.\n"
Expand Down Expand Up @@ -153,8 +152,7 @@ static char *usage_str =
#endif
" --nice=value - set nice value.\n"
" --no3d - disable 3D hardware acceleration.\n"
" --noallow=filename - disable allow command for file or directory.\n"
" --nodeny=filename - disable deny command for file or directory.\n"
" --noblacklist=filename - disable blacklist for file or directory.\n"
" --nodbus - disable D-Bus access.\n"
" --nodvd - disable DVD and audio CD devices.\n"
" --noexec=filename - remount the file or directory noexec nosuid and nodev.\n"
Expand All @@ -169,6 +167,7 @@ static char *usage_str =
" --noautopulse - disable automatic ~/.config/pulse init.\n"
" --novideo - disable video devices.\n"
" --nou2f - disable U2F devices.\n"
" --nowhitelist=filename - disable whitelist for file or directory.\n"
#ifdef HAVE_OUTPUT
" --output=logfile - stdout logging and log rotation.\n"
" --output-stderr=logfile - stdout and stderr logging and log rotation.\n"
Expand Down Expand Up @@ -225,14 +224,14 @@ static char *usage_str =
#ifdef HAVE_NETWORK
" --scan - ARP-scan all the networks from inside a network namespace.\n"
#endif
" --seccomp - enable seccomp filter and drop the default syscalls.\n"
" --seccomp=syscall,syscall,syscall - enable seccomp filter, drop the\n"
" --seccomp - enable seccomp filter and apply the default blacklist.\n"
" --seccomp=syscall,syscall,syscall - enable seccomp filter, blacklist the\n"
"\tdefault syscall list and the syscalls specified by the command.\n"
" --seccomp.block-secondary - build only the native architecture filters.\n"
" --seccomp.drop=syscall,syscall,syscall - enable seccomp filter, and\n"
"\tdrop the syscalls specified by the command.\n"
"\tblacklist the syscalls specified by the command.\n"
" --seccomp.keep=syscall,syscall,syscall - enable seccomp filter, and\n"
"\tallow the syscalls specified by the command.\n"
"\twhitelist the syscalls specified by the command.\n"
" --seccomp.print=name|pid - print the seccomp filter for the sandbox\n"
"\tidentified by name or PID.\n"
" --seccomp.32[.drop,.keep][=syscall] - like above but for 32 bit architecture.\n"
Expand All @@ -247,14 +246,15 @@ static char *usage_str =
" --top - monitor the most CPU-intensive sandboxes.\n"
" --trace - trace open, access and connect system calls.\n"
" --tracelog - add a syslog message for every access to files or\n"
"\tdirectories dropped by the security profile.\n"
"\tdirectories blacklisted by the security profile.\n"
" --tree - print a tree of all sandboxed processes.\n"
" --tunnel[=devname] - connect the sandbox to a tunnel created by\n"
"\tfiretunnel utility.\n"
" --version - print program version and exit.\n"
#ifdef HAVE_NETWORK
" --veth-name=name - use this name for the interface connected to the bridge.\n"
#endif
" --whitelist=filename - whitelist directory or file.\n"
" --writable-etc - /etc directory is mounted read-write.\n"
" --writable-run-user - allow access to /run/user/$UID/systemd and\n"
"\t/run/user/$UID/gnupg.\n"
Expand Down
98 changes: 49 additions & 49 deletions src/man/firejail-profile.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ Scripting commands:
\fBFile and directory names
File and directory names containing spaces are supported. The space character ' ' should not be escaped.

Example: "deny ~/My Virtual Machines"
Example: "blacklist ~/My Virtual Machines"

.TP
\fB# this is a comment
Expand All @@ -170,9 +170,9 @@ net none # this command creates an empty network namespace
\fB?CONDITIONAL: profile line
Conditionally add profile line.

Example: "?HAS_APPIMAGE: allow ${HOME}/special/appimage/dir"
Example: "?HAS_APPIMAGE: whitelist ${HOME}/special/appimage/dir"

This example will load the profile line only if the \-\-appimage option has been specified on the command line.
This example will load the whitelist profile line only if the \-\-appimage option has been specified on the command line.

Currently the only conditionals supported this way are HAS_APPIMAGE, HAS_NET, HAS_NODBUS, HAS_NOSOUND, HAS_PRIVATE and HAS_X11. The conditionals BROWSER_DISABLE_U2F and BROWSER_ALLOW_DRM
can be enabled or disabled globally in Firejail's configuration file.
Expand Down Expand Up @@ -205,16 +205,16 @@ storing modifications to the persistent configuration. Persistent .local files
are included at the start of regular profile files.

.TP
\fBnoallow file_name
If the file name matches file_name, the file will not be allowed in any allow commands that follow.
\fBnoblacklist file_name
If the file name matches file_name, the file will not be blacklisted in any blacklist commands that follow.

Example: "nowhitelist ~/.config"
Example: "noblacklist ${HOME}/.mozilla"

.TP
\fBnodeny file_name
If the file name matches file_name, the file will not be denied any deny commands that follow.
\fBnowhitelist file_name
If the file name matches file_name, the file will not be whitelisted in any whitelist commands that follow.

Example: "nodeny ${HOME}/.mozilla"
Example: "nowhitelist ~/.config"

.TP
\fBignore
Expand Down Expand Up @@ -242,17 +242,19 @@ HOME directories are searched, see the \fBfirejail\f(1) \fBFILE GLOBBING\fR sect
for more details.
Examples:
.TP
\fBallow file_or_directory
Allow directory or file. A temporary file system is mounted on the top directory, and the
allowed files are mount-binded inside. Modifications to allowd files are persistent,
everything else is discarded when the sandbox is closed. The top directory can be
all directories in / (except /proc and /sys), /sys/module, /run/user/$UID, $HOME and
all directories in /usr.
\fBblacklist file_or_directory
Blacklist directory or file. Examples:
.br

.br
Symbolic link handling: with the exception of user home, both the link and the real file should be in
the same top directory. For user home, both the link and the real file should be owned by the user.
blacklist /usr/bin
.br
blacklist /usr/bin/gcc*
.br
blacklist ${PATH}/ifconfig
.br
blacklist ${HOME}/.ssh

.TP
\fBblacklist-nolog file_or_directory
When --tracelog flag is set, blacklisting generates syslog messages if the sandbox tries to access the file or directory.
Expand All @@ -270,20 +272,6 @@ Mount-bind directory1 on top of directory2. This option is only available when r
.TP
\fBbind file1,file2
Mount-bind file1 on top of file2. This option is only available when running as root.
.TP
\fBdeny file_or_directory
Deny access to directory or file. Examples:
.br

.br
deny /usr/bin
.br
deny /usr/bin/gcc*
.br
deny ${PATH}/ifconfig
.br
deny ${HOME}/.ssh

.TP
\fBdisable-mnt
Disable /mnt, /media, /run/mount and /run/media access.
Expand All @@ -304,7 +292,7 @@ The directory is created if it doesn't already exist.
.br

.br
Use this command for allowed directories you need to preserve
Use this command for whitelisted directories you need to preserve
when the sandbox is closed. Without it, the application will create the directory, and the directory
will be deleted when the sandbox is closed. Subdirectories are recursively created. Example from
firefox profile:
Expand All @@ -317,7 +305,7 @@ whitelist ~/.mozilla
.br
mkdir ~/.cache/mozilla/firefox
.br
allow ~/.cache/mozilla/firefox
whitelist ~/.cache/mozilla/firefox
.br

.br
Expand Down Expand Up @@ -423,7 +411,7 @@ expressed as foo/bar -- is disallowed).
All modifications are discarded when the sandbox is closed.
.TP
\fBprivate-tmp
Mount an empty temporary filesystem on top of /tmp directory allowing /tmp/.X11-unix.
Mount an empty temporary filesystem on top of /tmp directory whitelisting /tmp/.X11-unix.
.TP
\fBread-only file_or_directory
Make directory or file read-only.
Expand All @@ -435,13 +423,25 @@ Make directory or file read-write.
Mount an empty tmpfs filesystem on top of directory. Directories outside user home or not owned by the user are not allowed. Sandboxes running as root are exempt from these restrictions.
.TP
\fBtracelog
File system deny violations logged to syslog.
Blacklist violations logged to syslog.
.TP
\fBwhitelist file_or_directory
Whitelist directory or file. A temporary file system is mounted on the top directory, and the
whitelisted files are mount-binded inside. Modifications to whitelisted files are persistent,
everything else is discarded when the sandbox is closed. The top directory can be
all directories in / (except /proc and /sys), /sys/module, /run/user/$UID, $HOME and
all directories in /usr.
.br

.br
Symbolic link handling: with the exception of user home, both the link and the real file should be in
the same top directory. For user home, both the link and the real file should be owned by the user.
.TP
\fBwritable-etc
Mount /etc directory read-write.
.TP
\fBwritable-run-user
Disable the default denying of run/user/$UID/systemd and /run/user/$UID/gnupg.
Disable the default blacklisting of run/user/$UID/systemd and /run/user/$UID/gnupg.
.TP
\fBwritable-var
Mount /var directory read-write.
Expand All @@ -455,7 +455,7 @@ The following security filters are currently implemented:

.TP
\fBallow-debuggers
Allow tools such as strace and gdb inside the sandbox by allowing system calls ptrace and process_vm_readv.
Allow tools such as strace and gdb inside the sandbox by whitelisting system calls ptrace and process_vm_readv.
#ifdef HAVE_APPARMOR
.TP
\fBapparmor
Expand All @@ -466,13 +466,13 @@ Enable AppArmor confinement.
Enable default Linux capabilities filter.
.TP
\fBcaps.drop capability,capability,capability
Deny given Linux capabilities.
Blacklist given Linux capabilities.
.TP
\fBcaps.drop all
Deny all Linux capabilities.
Blacklist all Linux capabilities.
.TP
\fBcaps.keep capability,capability,capability
Allow given Linux capabilities.
Whitelist given Linux capabilities.
.TP
\fBmemory-deny-write-execute
Install a seccomp filter to block attempts to create memory mappings
Expand All @@ -497,32 +497,32 @@ first argument to socket system call. Recognized values: \fBunix\fR,
\fBinet\fR, \fBinet6\fR, \fBnetlink\fR, \fBpacket\fR and \fBbluetooth\fR.
.TP
\fBseccomp
Enable seccomp filter and deny the syscalls in the default list. See man 1 firejail for more details.
Enable seccomp filter and blacklist the syscalls in the default list. See man 1 firejail for more details.
.TP
\fBseccomp.32
Enable seccomp filter and deny the syscalls in the default list for 32 bit system calls on a 64 bit architecture system.
Enable seccomp filter and blacklist the syscalls in the default list for 32 bit system calls on a 64 bit architecture system.
.TP
\fBseccomp syscall,syscall,syscall
Enable seccomp filter and deny the system calls in the list on top of default seccomp filter.
Enable seccomp filter and blacklist the system calls in the list on top of default seccomp filter.
.TP
\fBseccomp.32 syscall,syscall,syscall
Enable seccomp filter and deny the system calls in the list on top of default seccomp filter for 32 bit system calls on a 64 bit architecture system.
Enable seccomp filter and blacklist the system calls in the list on top of default seccomp filter for 32 bit system calls on a 64 bit architecture system.
.TP
\fBseccomp.block-secondary
Enable seccomp filter and filter system call architectures
so that only the native architecture is allowed.
.TP
\fBseccomp.drop syscall,syscall,syscall
Enable seccomp filter and deny the system calls in the list.
Enable seccomp filter and blacklist the system calls in the list.
.TP
\fBseccomp.32.drop syscall,syscall,syscall
Enable seccomp filter and deny the system calls in the list for 32 bit system calls on a 64 bit architecture system.
Enable seccomp filter and blacklist the system calls in the list for 32 bit system calls on a 64 bit architecture system.
.TP
\fBseccomp.keep syscall,syscall,syscall
Enable seccomp filter and allow the system calls in the list.
Enable seccomp filter and whitelist the system calls in the list.
.TP
\fBseccomp.32.keep syscall,syscall,syscall
Enable seccomp filter and allow the system calls in the list for 32 bit system calls on a 64 bit architecture system.
Enable seccomp filter and whitelist the system calls in the list for 32 bit system calls on a 64 bit architecture system.
.TP
\fBseccomp-error-action kill | log | ERRNO
Return a different error instead of EPERM to the process, kill it when
Expand All @@ -534,7 +534,7 @@ attempt.
Enable X11 sandboxing.
.TP
\fBx11 none
Deny access to /tmp/.X11-unix directory, ${HOME}/.Xauthority and file specified in ${XAUTHORITY} environment variable.
Blacklist /tmp/.X11-unix directory, ${HOME}/.Xauthority and file specified in ${XAUTHORITY} environment variable.
Remove DISPLAY and XAUTHORITY environment variables.
Stop with error message if X11 abstract socket will be accessible in jail.
.TP
Expand Down
Loading

0 comments on commit dd13595

Please sign in to comment.