Go to file
Frostbyte4664 63c45f5de5
steam.profile: Allow Baba Is You (#6054)
2023-10-16 20:14:22 +00:00
.github build(deps): bump github/codeql-action from 2.22.0 to 2.22.3 2023-10-16 12:56:08 +00:00
ci build: use ASCII sort on firecfg and check for duplicates 2023-08-05 17:17:15 -03:00
contrib build: add missing dbus/x11 commands to arg1 list 2023-09-06 03:19:32 -03:00
etc steam.profile: Allow Baba Is You (#6054) 2023-10-16 20:14:22 +00:00
etc-fixes Fix wrong syscall names for s390_pci_mmio_{read,write} 2023-08-26 21:48:44 +03:00
m4 update m4 macro from autoconf-archive (2022.02.11) 2022-07-31 02:05:35 +02:00
platform build: use config.sh in more scripts 2023-07-28 14:10:31 -03:00
src New profile: termshark (#6039) 2023-10-07 20:46:32 +00:00
test tests: disable broken wget tests in utils/sysutils 2023-08-28 19:03:09 -03:00
.editorconfig editorconfig: add indentation rules 2023-02-20 18:07:09 -03:00
.git-blame-ignore-revs .git-blame-ignore-revs: add Landlock v1 commits 2022-09-19 11:56:41 -03:00
.gitattributes .gitattributes: mark some binary files as such 2023-02-20 17:39:16 -03:00
.gitignore cleanup 2023-07-27 19:47:24 -04:00
.gitlab-ci.yml ci: standardize apt-get update/install 2023-06-14 18:54:49 -03:00
CONTRIBUTING.md docs: line-wrap markdown and use double-spacing 2023-03-26 13:52:11 -03:00
COPYING use license file from gnu.org (#4571) 2021-09-22 23:03:42 +02:00
Makefile build: add missing dbus/x11 commands to arg1 list 2023-09-06 03:19:32 -03:00
README merges 2023-07-16 12:39:59 -04:00
README.md docs: add missing CI badges to README.md 2023-08-22 04:58:21 -03:00
RELNOTES modif: keep pipewire group unless nosound is used 2023-09-20 12:23:31 -03:00
SECURITY.md docs: deduplicate info from SECURITY.md 2023-03-26 03:54:40 -03:00
config.mk.in Improve errExit error messages 2023-06-28 04:00:13 -03:00
config.sh.in build: add new TARNAME variable 2022-08-14 02:17:39 -03:00
configure rebuild configure script for Debian 12 (run into some problems with PKG_CHECK_MODULES macro 2023-07-05 08:56:38 -04:00
configure.ac build: remove -mretpoline and NO_EXTRA_CFLAGS 2023-06-18 13:43:55 -03:00
gcov.sh make --private-lib a compile time option, disabled by default 2023-03-09 12:46:11 -05:00
install.sh Update copyright to 2023 (#5664) 2023-02-15 18:57:44 +00:00
linecnt.sh Update copyright to 2023 (#5664) 2023-02-15 18:57:44 +00:00
mkasc.sh build: use config.sh in more scripts 2023-07-28 14:10:31 -03:00
mkdeb.sh Merge pull request #5668 from kmk3/build-deb-apparmor-default 2023-02-17 09:16:56 -05:00
mketc.sh Update copyright to 2023 (#5664) 2023-02-15 18:57:44 +00:00
mkuid.sh Update copyright to 2023 (#5664) 2023-02-15 18:57:44 +00:00

README.md

Firejail

Build (GitLab) Build (GitHub) Build-extra Test Check-C Check-Profiles Check-Python Codespell Packaging status (Repology)

Firejail is a SUID sandbox program that reduces the risk of security breaches by restricting the running environment of untrusted applications using Linux namespaces, seccomp-bpf and Linux capabilities. It allows a process and all its descendants to have their own private view of the globally shared kernel resources, such as the network stack, process table, mount table. Firejail can work in a SELinux or AppArmor environment, and it is integrated with Linux Control Groups.

Written in C with virtually no dependencies, the software runs on any Linux computer with a 3.x kernel version or newer. It can sandbox any type of processes: servers, graphical applications, and even user login sessions. The software includes sandbox profiles for a number of more common Linux programs, such as Mozilla Firefox, Chromium, VLC, Transmission etc.

The sandbox is lightweight, the overhead is low. There are no complicated configuration files to edit, no socket connections open, no daemons running in the background. All security features are implemented directly in Linux kernel and available on any Linux computer.

Videos

Advanced Browser Security
Advanced Browser Security
How To Disable Network Access
How To Disable Network Access
Deep Dive
Deep Dive

Security vulnerabilities

See SECURITY.md.

Installing

Debian

Debian stable (bullseye): We recommend to use the backports package.

Ubuntu

For Ubuntu 18.04+ and derivatives (such as Linux Mint), users are strongly advised to use the PPA.

How to add and install from the PPA:

sudo add-apt-repository ppa:deki/firejail
sudo apt-get update
sudo apt-get install firejail firejail-profiles

Reason: The firejail package for Ubuntu 20.04 has been left vulnerable to CVE-2021-26910 for months after a patch for it was posted on Launchpad:

See also https://wiki.ubuntu.com/SecurityTeam/FAQ:

What software is supported by the Ubuntu Security team?

Ubuntu is currently divided into four components: main, restricted, universe and multiverse. All binary packages in main and restricted are supported by the Ubuntu Security team for the life of an Ubuntu release, while binary packages in universe and multiverse are supported by the Ubuntu community.

Additionally, the PPA version is likely to be more recent and to contain more profile fixes.

See the following discussions for details:

Other

Firejail is available in multiple Linux distributions:

Repology

Packaging status (Repology)

Other than the aforementioned exceptions, as long as your distribution provides a supported version of firejail, it's generally a good idea to install it from the distribution.

The version can be checked with firejail --version after installing.

You can also install one of the released packages.

Or clone the source code from our git repository and build manually:

git clone https://github.com/netblue30/firejail.git
cd firejail
./configure && make && sudo make install-strip

On Debian/Ubuntu you will need to install git and gcc. AppArmor development libraries and pkg-config are required when using the --enable-apparmor ./configure option:

sudo apt-get install git build-essential libapparmor-dev pkg-config gawk

For --selinux option, add libselinux1-dev (libselinux-devel for Fedora).

Detailed information on using firejail from git is available on the wiki.

Running the sandbox

To start the sandbox, prefix your command with firejail:

firejail firefox            # starting Mozilla Firefox
firejail transmission-gtk   # starting Transmission BitTorrent
firejail vlc                # starting VideoLAN Client
sudo firejail /etc/init.d/nginx start

Run firejail --list in a terminal to list all active sandboxes. Example:

$ firejail --list
1617:netblue:/usr/bin/firejail /usr/bin/firefox-esr
7719:netblue:/usr/bin/firejail /usr/bin/transmission-qt
7779:netblue:/usr/bin/firejail /usr/bin/galculator
7874:netblue:/usr/bin/firejail /usr/bin/vlc --started-from-file file:///home/netblue/firejail-whitelist.mp4
7916:netblue:firejail --list

Desktop integration

Integrate your sandbox into your desktop by running the following two commands:

firecfg --fix-sound
sudo firecfg

The first command solves some shared memory/PID namespace bugs in PulseAudio software prior to version 9. The second command integrates Firejail into your desktop. You would need to logout and login back to apply PulseAudio changes.

Start your programs the way you are used to: desktop manager menus, file manager, desktop launchers.

The integration applies to any program supported by default by Firejail. There are over 900 default applications in the current Firejail version, and the number goes up with every new release.

We keep the application list in src/firecfg/firecfg.config (/etc/firejail/firecfg.config when installed).

Security profiles

Most Firejail command line options can be passed to the sandbox using profile files.

You can find the profiles for all supported applications in etc/ (/etc/firejail/ when installed).

We also keep a list of profile fixes for previous released versions in etc-fixes/.

If you keep additional Firejail security profiles in a public repository, please give us a link:

Use this issue to request new profiles:

You can also use this tool to get a list of syscalls needed by a program:

Uninstalling

firecfg creates symlinks in /usr/local/bin, so to fully remove firejail, run the following before uninstalling:

sudo firecfg --clean

See man firecfg for details.

Note: Broken symlinks are ignored when searching for an executable in $PATH, so uninstalling without doing the above should not cause issues.

Latest released version: 0.9.72

Current development version: 0.9.73

--keep-shell-rc

       --keep-shell-rc
              By default, when using a private home directory, firejail copies
              files  from the system's user home template (/etc/skel) into it,
              which overrides attempts to whitelist the original  files  (such
              as  ~/.bashrc and ~/.zshrc).  This option disables this feature,
              and enables the user to whitelist the original files.

private-etc rework

       --private-etc, --private-etc=file,directory,@group
              The files installed by --private-etc are copies of the original
              system files from /etc directory.  By default, the command
              brings in a skeleton of files and directories used by most
              console tools:

              $ firejail --private-etc dig debian.org

              For X11/GTK/QT/Gnome/KDE  programs add @x11 group as a
              parameter. Example:

              $ firejail --private-etc=@x11,gcrypt,python* gimp

              gcrypt and /etc/python* directories are not part of the generic
              @x11 group.  File globbing is supported.

              For games, add @games group:

              $ firejail --private-etc=@games,@x11 warzone2100

              Sound and networking files are included automatically, unless
              --nosound or --net=none are specified.  Files for encrypted
              TLS/SSL protocol are in @tls-ca group.

              $ firejail --private-etc=@tls-ca,wgetrc wget https://debian.org

              Note: The easiest way to extract the list of /etc files accessed
              by your program is using strace utility:

              $ strace /usr/bin/transmission-qt 2>&1 | grep open | grep etc

We keep the list of groups in src/include/etc_groups.h.

Discussion:

Profile Statistics

A small tool to print profile statistics. Compile and install as usual. The tool is installed in the /usr/lib/firejail directory.

Run it over the profiles in /etc/profiles:

$ /usr/lib/firejail/profstats /etc/firejail/*.profile
No include .local found in /etc/firejail/noprofile.profile
Warning: multiple caps in /etc/firejail/transmission-daemon.profile

Stats:
    profiles			1209
    include local profile	1208   (include profile-name.local)
    include globals		1181   (include globals.local)
    blacklist ~/.ssh		1079   (include disable-common.inc)
    seccomp			1096
    capabilities		1202
    noexec			1087   (include disable-exec.inc)
    noroot			1003
    memory-deny-write-execute	272
    restrict-namespaces		958
    apparmor			753
    private-bin			704
    private-dev			1058
    private-etc			550
    private-lib			71
    private-tmp			932
    whitelist home directory	585
    whitelist var		870   (include whitelist-var-common.inc)
    whitelist run/user		1176   (include whitelist-runuser-common.inc
					or blacklist ${RUNUSER})
    whitelist usr/share		640   (include whitelist-usr-share-common.inc
    net none			410
    dbus-user none 		679
    dbus-user filter 		141
    dbus-system none 		851
    dbus-system filter 		12