summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar netblue30 <netblue30@yahoo.com>2016-09-09 13:18:18 -0400
committerLibravatar netblue30 <netblue30@yahoo.com>2016-09-09 13:18:18 -0400
commite0935c5a3bb4c3b297c151e2060cfc624377a421 (patch)
tree5226728b6189532783f6b5dcccbf66980b781a37 /README.md
parent0.9.42 testing - CentOS 6 (diff)
downloadfirejail-e0935c5a3bb4c3b297c151e2060cfc624377a421.tar.gz
firejail-e0935c5a3bb4c3b297c151e2060cfc624377a421.tar.zst
firejail-e0935c5a3bb4c3b297c151e2060cfc624377a421.zip
starting new development
Diffstat (limited to 'README.md')
-rw-r--r--README.md167
1 files changed, 1 insertions, 166 deletions
diff --git a/README.md b/README.md
index 2f2ab38e7..eafcf1d78 100644
--- a/README.md
+++ b/README.md
@@ -34,170 +34,5 @@ FAQ: https://firejail.wordpress.com/support/frequently-asked-questions/
34````` 34`````
35 35
36````` 36`````
37# Current development version: 0.9.42~rc2 37# Current development version: 0.9.43
38
39Version 0.9.41~rc1 was released.
40
41## Bringing back --private-home
42
43## Deprecated --user
44
45--user option was deprecated, please use "sudo -u username firejail application" instead.
46
47## --whitelist rework
48
49Symlinks outside user home directories are allowed:
50`````
51 --whitelist=dirname_or_filename
52 Whitelist directory or file. This feature is implemented only
53 for user home, /dev, /media, /opt, /var, and /tmp directories.
54 With the exception of user home, both the link and the real file
55 should be in the same top directory. For /home, both the link
56 and the real file should be owned by the user.
57
58 Example:
59 $ firejail --noprofile --whitelist=~/.mozilla
60 $ firejail --whitelist=/tmp/.X11-unix --whitelist=/dev/null
61 $ firejail "--whitelist=/home/username/My Virtual Machines"
62`````
63
64## AppArmor support
65
66So far I've seen this working on Debian Jessie and Ubuntu 16.04, where I can get Firefox and
67Chromium running. There is more testing to come.
68
69`````
70APPARMOR
71 AppArmor support is disabled by default at compile time. Use --enable-
72 apparmor configuration option to enable it:
73
74 $ ./configure --prefix=/usr --enable-apparmor
75
76 During software install, a generic AppArmor profile file, firejail-
77 default, is placed in /etc/apparmor.d directory. The profile needs to
78 be loaded into the kernel by running the following command as root:
79
80 # aa-enforce firejail-default
81
82 The installed profile tries to replicate some advanced security fea‐
83 tures inspired by kernel-based Grsecurity:
84
85 - Prevent information leakage in /proc and /sys directories. The
86 resulting file system is barely enough for running commands such
87 as "top" and "ps aux".
88
89 - Allow running programs only from well-known system paths, such
90 as /bin, /sbin, /usr/bin etc. Running programs and scripts from
91 user home or other directories writable by the user is not
92 allowed.
93
94 - Disable D-Bus. D-Bus has long been a huge security hole, and
95 most programs don't use it anyway. You should have no problems
96 running Chromium or Firefox.
97
98 To enable AppArmor confinement on top of your current Firejail security
99 features, pass --apparmor flag to Firejail command line. You can also
100 include apparmor command in a Firejail profile file. Example:
101
102 $ firejail --apparmor firefox
103
104`````
105
106## AppImage support
107
108AppImage (http://appimage.org/) is a distribution-agnostic packaging format.
109The package is a regular ISO file containing all binaries, libraries and resources
110necessary for the program to run.
111
112We introduce in this release support for sandboxing AppImage applications. Example:
113`````
114$ firejail --appimage krita-3.0-x86_64.appimage
115`````
116All Firejail sandboxing options should be available. A private home directory:
117`````
118$ firejail --appimage --private krita-3.0-x86_64.appimage
119`````
120or some basic X11 sandboxing:
121`````
122$ firejail --appimage --net=none --x11 krita-3.0-x86_64.appimage
123`````
124Major software applications distributing AppImage packages:
125
126* Krita: https://krita.org/download/krita-desktop/
127* OpenShot: http://www.openshot.org/download/
128* Scribus: https://www.scribus.net/downloads/unstable-branch/
129* MuseScore: https://musescore.org/en/download
130
131More packages build by AppImage developer Simon Peter: https://bintray.com/probono/AppImages
132
133AppImage project home: https://github.com/probonopd/AppImageKit
134
135## Sandbox auditing
136`````
137AUDIT
138 Audit feature allows the user to point out gaps in security profiles.
139 The implementation replaces the program to be sandboxed with a test
140 program. By default, we use faudit program distributed with Firejail. A
141 custom test program can also be supplied by the user. Examples:
142
143 Running the default audit program:
144 $ firejail --audit transmission-gtk
145
146 Running a custom audit program:
147 $ firejail --audit=~/sandbox-test transmission-gtk
148
149 In the examples above, the sandbox configures transmission-gtk profile
150 and starts the test program. The real program, transmission-gtk, will
151 not be started.
152
153 Limitations: audit feature is not implemented for --x11 commands.
154`````
155
156## --noexec
157`````
158 --noexec=dirname_or_filename
159 Remount directory or file noexec, nodev and nosuid.
160
161 Example:
162 $ firejail --noexec=/tmp
163
164 /etc and /var are noexec by default. If there are more than one
165 mount operation on the path of the file or directory, noexec
166 should be applied to the last one. Always check if the change
167 took effect inside the sandbox.
168`````
169
170## --rmenv
171`````
172 --rmenv=name
173 Remove environment variable in the new sandbox.
174
175 Example:
176 $ firejail --rmenv=DBUS_SESSION_BUS_ADDRESS
177`````
178
179## Converting profiles to private-bin - work in progress!
180
181BitTorrent: deluge, qbittorrent, rtorrent, transmission-gtk, transmission-qt, uget-gtk
182
183File transfer: filezilla
184
185Media: vlc, mpv, gnome-mplayer, audacity, rhythmbox, spotify, xplayer, xviewer, eom
186
187Office: evince, gthumb, fbreader, pix, atril, xreader,
188
189Chat/messaging: qtox, gitter, pidgin
190
191Games: warzone2100, gnome-chess
192
193Weather/climate: aweather
194
195Astronomy: gpredict, stellarium
196
197Browsers: Palemoon
198
199## New security profiles
200
201Gitter, gThumb, mpv, Franz messenger, LibreOffice, pix, audacity, xz, xzdec, gzip, cpio, less, Atom Beta, Atom, jitsi, eom, uudeview
202tar (gtar), unzip, unrar, file, skypeforlinux, gnome-chess, inox, Slack, Gajim IM client, DOSBox
203 38