Firejail
関連記事
Firejail は使いやすい SUID サンドボックスプログラムであり、Linux の名前空間や seccomp-bpf、Linux ケイパビリティを使うことで、信頼のおけないアプリケーションの実行環境を制限することにより、セキュリティ侵害のリスクを軽減します。
目次
- 1 インストール
- 2 設定
- 3 使用方法
- 4 カスタムのプロファイルを作成する
- 5 Xephyr と合わせて Firejail を使う
- 6 ヒントとテクニック
- 7 トラブルシューティング
- 7.1 Remove Firejail symbolic links
- 7.2 PulseAudio
- 7.3 hidepid
- 7.4 Proprietary Nvidia drivers
- 7.5 --net options and Linux kernel >=4.20.0
- 7.6 Warning: Cannot confine the application using AppArmor
- 7.7 /usr/bin/patch: **** Can't open patch file
- 7.8 Graphical applications hang on start with AMDGPU
- 7.9 Daemonizing/backgrounded processes hang
- 8 参照
インストール
firejail または firejail-gitAUR パッケージをインストールしてください。Firejail で使用するためのGUIアプリケーション、firetools も用意されています。
設定
ほとんどのユーザはカスタムの設定をする必要はないでしょう。その場合、#使用方法 に進むことができます。
Firejail は、サンドボックス内で実行されるアプリケーションのそれぞれに対してセキュリティ保護を設定するプロファイルを使用します。デフォルトのプロファイルは /etc/firejail/application.profile
で見ることができます。含まれていないアプリケーションに対するカスタムのプロファイルが必要な場合や、デフォルトのプロファイルを変更したい場合、新しいルールや、デフォルトのプロファイルのコピーを ~/.config/firejail/
ディレクトリ内に置くことができます。1つのアプリケーションに対して複数のカスタムのプロファイルを設定することもでき、複数のアプリケーションの間で同一のプロファイルを共有させることもできます。
Firejail に特定のアプリケーションのプロファイルが存在しない場合、システム全体の制限付きデフォルトプロファイルを使用します。これにより、カスタムのプロファイルや制限を緩めたプロファイルを先に作成しないと、アプリケーションが期待通りに動作しない可能性があります。
firejail-profile(5) を参照してください。
使用方法
そのアプリケーションに対する firejail のデフォルトの保護(デフォルトのプロファイル)を使用してアプリケーションを実行するには、以下を実行します:
$ firejail <program name>
デフォルトプロファイルへの1回限りの追加は、コマンドラインオプションとして追加できます(マニュアルページを参照)。たとえば、seccomp 保護を使用して okular を実行するには、次のコマンドを実行します:
$ firejail --seccomp okular
1つのプログラムにデフォルト以外の複数のプロファイルを定義できます。プロファイルファイルを作成したら、次のコマンドを実行して使用できます:
$ firejail --profile=/absolute/path/to/profile <program name>
デフォルトで firejail を使う
Firejail のプロファイルを持つすべてのアプリケーションに対して Firejail を使用するようにするには、firecfg ツールを root として実行してください。
# firecfg
このツールは、Firejail がデフォルトのプロファイルを持つすべてのアプリケーションに対して、/usr/bin/firejail
を指すシンボリックリンクを /usr/local/bin
内に作成します。
アプリケーションごとに手動で設定するには以下を実行してください:
# ln -s /usr/bin/firejail /usr/local/bin/<application>
hardened_malloc を使う
hardened_mallocAUR is a hardened implementation of glibc's malloc()
allocator, originally written for Android but extended for use on the desktop. While not integrated into glibc yet, it can be used selectively with LD_PRELOAD
. The proper way to launch an application within firejail using hardened_malloc is demonstrated below. To make it permanent, you would need to create your own entry in /usr/local/bin for the desired application.
$ firejail --env=LD_PRELOAD='/usr/lib/libhardened_malloc.so' /usr/bin/firefox
Alternatively, add the following to a custom profile:
env LD_PRELOAD=/usr/lib/libhardened_malloc.so
The various environment variables and settings that can be used to tune hardened_malloc can be found on its github page.
Enable AppArmor support
Since 0.9.60-1, Firejail has supported more direct integration with AppArmor through a generic AppArmor profile. During installation, the profile, firejail-default
, is placed in /etc/apparmor.d
directory, and needs to be loaded into the kernel by running the following command as root:
# apparmor_parser -r /etc/apparmor.d/firejail-default
Local customizations of the apparmor profile are supported by editing the file /etc/apparmor.d/local/firejail-local
AppArmor is already enabled for a large number of Firejail profiles. There are several ways to enable AppArmor confinement on top of a Firejail security profile:
- Pass the
--apparmor
flag to Firejail in the command line, e.g.$ firejail --apparmor firefox
- Use a custom profile and add the
apparmor
command. - Enable Apparmor globally in
/etc/firejail/globals.local
and disable as needed through the use ofignore apparmor
in/etc/firejail/<ProgramName>.local
.
Note that enabling AppArmor by above methods always means that /etc/apparmor.d/firejail-default
is used. If you rather want to use a specific AppArmor profile for an application, you have to use the above mentioned ignore apparmor
command. However, that is not recommended, as using both Firejail and AppArmor for the same applications often creates problems.
Firejail が使用中かを確認する
$ firejail --list
A more comprehensive output is produced by
$ firejail --tree
カスタムのプロファイルを作成する
ホワイトリストとブラックリスト
Blacklists are heavily used in various /etc/firejail/*.inc
files which are included in most profiles. Blacklists are permissive:
- Deny access to a directory or file and permit everything else:
blacklist <directory/file>
- Disable/undo/ignore blacklisting a directory or file already blacklisted, e.g., in an *.inc file:
noblacklist <directory/file>
The order in which they appear in a profile is important: noblacklist directives must be added above blacklist directives.
Whitelists block everything what is not explicitly whitelisted. They should not be used in profiles for applications that need access to random locations (e.g., text editors, image viewers/editors).
- Allow access to a directory or file and forbid everything else:
whitelist <directory/file>
- Disable/undo/ignore whitelisting a directory or file already whitelisted, e.g., in an *.inc file:
nowhitelist <directory/file>
The order in which they appear in a profile is important: nowhitelist directives must be added above whitelist directives.
Whitelisting is always done before blacklisting. As mentioned, a whitelist directive blacklists everything else. A blacklist directive is therefore a fallback if there are no whitelist directives or if a whitelist directive is too permissive.
(no)blacklist and (no)whitelist directives are often used in combination. Example: /etc/firejail/disable-programs.inc
(which is included in all profiles) contains the directive:
blacklist ${HOME}/.mozilla
in order to block access to that directory for all applications sandboxed by Firejail. /etc/firejail/firefox.profile
must disable this directive and must add a whitelist directive to allow access to that directory (as the Firefox profile is a whitelisted profile):
noblacklist ${HOME}/.mozilla whitelist ${HOME}/.mozilla
プロファイルの記述法
The basic process is:
- Copy
/usr/share/doc/firejail/profile.template
to/etc/firejail/
or~/.config/firejail/
and rename it toProfileName.profile
where ProfileName should match the name of the executable to be sandboxed - Change the line
include PROFILE.local
toinclude ProfileName.local
- Gradually comment/uncomment the various options while checking at each stage that the application runs inside the new sandbox. Do not change the order of the sections in that template.
- Detailed explanations of the possible options for a Firejail profile can be found in the firejail-profile(5) man page
- Test the profile for security holes, see #Testing profiles
If you want to create a whitelisted profile (i.e. a profile which contains whitelist directives) you can build a whitelist of permitted locations by executing
$ firejail --build application
Keep in mind that a whitelisted profile is problematic for applications that need to access random locations (like text editors or file managers).
ローカルのカスタムプロファイルを永続化する
The standard profile layout includes the capability to make persistent local customisations through the inclusion of .local
files[2]. Basically, each officially supported profile contains the lines include ProgramName.local
and include globals.local
. These *.local files might be located in /etc/firejail
or in ~/.config/firejail
. Since the order of precedence is determined by which is read first, this makes for a very powerful way of making local customisations.
For example, with reference this firejail question, to globally enable Apparmor and disable Internet connectivity, one could simply create/edit /etc/firejail/globals.local
to include the lines
# enable Apparmor and disable Internet globally net none apparmor
Then, to allow, for example, "curl" to connect to the internet, yet still maintain its apparmor confinement, one would create/edit /etc/firejail/curl.local
to include the lines.
# enable internet for curl ignore net
Since curl.local
is read before globals.local
, ignore net
overrides net none
, and, as a bonus, the above changes would be persistent across future updates.
プロファイルのテスト
In order to test and audit a Firejail profile you may find the following to be useful:
firejail --debug $Program > $PathToOutputFile
Gives a detailed breakdown of the sandboxfirejail --debug-blacklists $Program
andfirejail --debug-whitelists $Program
show the blacklisted and whitelisted directories and files for the current profile.firejail --debug-caps
gives a list of caps supported by the current Firejail software build. This is useful when building a caps whitelist.firejail --help
for a full list of--debug
optionsfiremon PID
monitors the running process. Seefiremon --help
for details- Executing
sudo jailcheck
tests running sandboxes. See the jailcheck(1) man page for details. - checksec may also be useful in testing which standard security features are being used
Xephyr と合わせて Firejail を使う
Xephyr will allow you to sandbox Xorg. If you want to be able to resize windows, install a window manager such as Openbox.
xephyr-screen WidthxHeight
can be set in /etc/firejail/firejail.config
where Width
and Height
are in pixels and based on your screen resolution.
To open the sandbox:
$ firejail --x11 --net=device openbox
device
is your active network interface. Then right click and select your applications to run.
A great guide can be found on the Firejail Wordpress.
According to the guide:
- The sandbox replaces the regular X11 server with Xpra or Xephyr server. This prevents X11 keyboard loggers and screenshot utilities from accessing the main X11 server.
Note that the statement:
- The only way to disable the abstract socket
@/tmp/.X11-unix/X0
is by using a network namespace. If for any reasons you cannot use a network namespace, the abstract socket will still be visible inside the sandbox. Hackers can attach keylogger and screenshot programs to this socket.
is incorrect, xserverrc can be edited to -nolisten local
which disables the abstract sockets of X11 and helps isolate it.
ブラウザをサンドボックス化する
Openbox can be configured to start a certain browser at startup. program.profile
is the respective profile contained in /etc/firejail
, and --startup "command"
is the command line used to start the program. For example, to start Chromium in the sandbox:
$ firejail --x11 --profile=/etc/firejail/chromium.profile openbox --startup "chromium"
ヒントとテクニック
スペースを含むパス
If you need to reference, whitelist, or blacklist a directory within a custom profile, such as with palemoonAUR, you must do so using the absolute path, without encapsulation or escapes:
/home/user/.moonchild productions
プライベートモード
Firejail also includes a one time private mode, in which no mounts are made in the chroots to your home directory. In doing this, you can execute applications without performing any changes to disk. For example, to execute okular in private mode, do the following:
$ firejail --seccomp --private okular
トラブルシューティング
Firejail can be hard to debug. The symptoms of a misconfigured or otherwise unfitting setup range from random segmentation faults and hangs in the applications to simple error messages.
Some applications are harder to sandbox than others. For example web browsers and Electron applications tend to need more troubleshooting than others since there is much that can go wrong. It is crucial to check the FAQ and open issues first, since debugging can take quite some time.
Remove Firejail symbolic links
To remove Firejail created symbolic links (e.g. reset to default):
# firecfg --clean
If you do not want to use Firejail for a specific application (e.g., because you prefer to rather confine it with AppArmor), you have to manually remove the related symbolic link:
# rm /usr/local/bin/application
As a subsequent execution of firecfg would re-add the removed symlinks, the respective applications should be commented in /etc/firejail/firecfg.config
.
Verify if any leftovers of Desktop entries are still overruled by Firejail.
PulseAudio
If Firejail causes PulseAudio issues with sandboxed applications [3], the following command may be used:
$ firecfg --fix-sound
This commands creates a custom ~/.config/pulse/client.conf
file for the current user with enable-shm = no
and possible other workarounds.
hidepid
If the system uses the hidepid kernel parameter, Firemon can only be run as root. This, among other things, will cause problems with the Firetools GUI incorrectly reporting "Capabilities", "Protocols" and the status of "Seccomp"[4].
Proprietary Nvidia drivers
Some users report problems when using Firejail and proprietary graphic drivers from NVIDIA (e.g. [5], [6] or [7]). This can often be solved by disabling the noroot
Firejail option in the application's profile file.
--net options and Linux kernel >=4.20.0
There is a bug on firejail 0.5.96 with linux >= 4.20.0, see [8] and [9]
Example error message:
$ firejail --noprofile --net=eth0 ls Parent pid 8521, child pid 8522 Error send: arp.c:182 arp_check: Invalid argument Error: proc 8521 cannot sync with peer: unexpected EOF Peer 8522 unexpectedly exited with status 1
Warning: Cannot confine the application using AppArmor
For some applications (e.g. Firefox [10]) starting with Firejail may result in warnings like:
Warning: Cannot confine the application using AppArmor. Maybe firejail-default AppArmor profile is not loaded into the kernel. As root, run "aa-enforce firejail-default" to load it.
When running the suggested command you might see:
ERROR: Cache read/write disabled: interface file missing. (Kernel needs AppArmor 2.4 compatibility patch.)
This means that AppArmor is not enabled as a kernel parameter, so you have to set it according to AppArmor#Installation.
/usr/bin/patch: **** Can't open patch file
This means the PKGBUILD
uses patch
with the -i
argument so a whitelist for $SRCDEST
in /etc/makepkg.conf
is needed.
Create the override patch.local
with the value of your $SRCDEST
:
whitelist /path/to/makepkg/sources
Changing the PKGBUILD
to use stdin
also works:
patch -p1 < ../file.patch
Graphical applications hang on start with AMDGPU
Some graphical applications, e.g. Firefox and mpv, would hang on start when using AMDGPU with Mesa >= 19.3.4. See [11].
This should be fixed as of firejail 0.9.66, as kcmp is not dropped by default anymore (see also [12]). If this still happens, please report it.
As a workaround, for all affected applications, add seccomp !kcmp
to their profiles in etc/firejail
. If they already have a seccomp
statement, you can concatenate them as a comma-separated list, eg seccomp !chroot,!kcmp
.
Daemonizing/backgrounded processes hang
There is a known issue that prevents processes from daemonizing. There is currently no solution to this except not using Firejail to sandbox the affected application. Because it is a bug within Firejail, no configuration can solve this issue. Fortunately the applications mentioned in the issue usually do not have a large attack surface, so the risks of running them without a sandbox are comparatively low.
参照
- Firejail GitHub プロジェクトページ
- bubblewrap Firejail の最小限の代用品