1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
|
.TH FIREJAIL 1 "MONTH YEAR" "VERSION" "firejail man page"
.SH NAME
Firejail \- Linux namespaces sandbox program
.SH SYNOPSIS
Start a sandbox:
.PP
.RS
firejail [OPTIONS] [program and arguments]
.RE
.PP
Network traffic shaping for an existing sandbox:
.PP
.RS
firejail \-\-bandwidth={name|pid} bandwidth-command
.RE
.PP
Monitoring:
.PP
.RS
firejail {\-\-list | \-\-netstats | \-\-top | \-\-tree}
.RE
.PP
Miscellaneous:
.PP
.RS
firejail {\-? | \-\-debug-caps | \-\-debug-errnos | \-\-debug-syscalls | \-\-debug-protocols | \-\-help | \-\-version}
.RE
.SH DESCRIPTION
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.
.PP
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.
.PP
Firejail allows the user to manage application security using security profiles.
Each profile defines a set of permissions for a specific application or group
of applications. The software includes security profiles for a number of more common
Linux programs, such as Mozilla Firefox, Chromium, VLC, Transmission etc.
.SH USAGE
Without any options, the sandbox consists of a filesystem build in a new mount namespace,
and new PID and UTS namespaces. IPC, network and user namespaces can be added using the
command line options. The default Firejail filesystem is based on the host filesystem with the main
system directories mounted read-only. These directories are /etc, /var, /usr, /bin, /sbin, /lib, /lib32,
/libx32 and /lib64. Only /home and /tmp are writable.
.PP
As it starts up, Firejail tries to find a security profile based on the name of the application.
If an appropriate profile is not found, Firejail will use a default profile.
The default profile is quite restrictive. In case the application doesn't work, use --noprofile option
to disable it. For more information, please see \fBSECURITY PROFILES\fR section below.
.PP
If a program argument is not specified, Firejail starts /bin/bash shell.
Examples:
.PP
$ firejail [OPTIONS] # starting a /bin/bash shell
.PP
$ firejail [OPTIONS] firefox # starting Mozilla Firefox
.PP
# sudo firejail [OPTIONS] /etc/init.d/nginx start
.SH OPTIONS
.TP
\fB\-\-
Signal the end of options and disables further option processing.
.TP
\fB\-\-allow-debuggers
Allow tools such as strace and gdb inside the sandbox by whitelisting
system calls ptrace and process_vm_readv. This option is only
available when running on Linux kernels 4.8 or newer - a kernel bug in
ptrace system call allows a full bypass of the seccomp filter.
.br
.br
Example:
.br
$ firejail --allow-debuggers --profile=/etc/firejail/firefox.profile strace -f firefox
.TP
\fB\-\-allusers
All directories under /home are visible inside the sandbox. By default, only current user home directory is visible.
.br
.br
Example:
.br
$ firejail --allusers
.TP
\fB\-\-apparmor
Enable AppArmor confinement. For more information, please see \fBAPPARMOR\fR section below.
.TP
\fB\-\-appimage
Sandbox an AppImage (https://appimage.org/) application. If the sandbox is started as a
regular user, default seccomp and capabilities filters are enabled.
.br
.br
Example:
.br
$ firejail --appimage krita-3.0-x86_64.appimage
.br
$ firejail --appimage --private krita-3.0-x86_64.appimage
.br
$ firejail --appimage --net=none --x11 krita-3.0-x86_64.appimage
.TP
\fB\-\-apparmor.print=name|pid
Print the AppArmor confinement status for the sandbox identified by name or by PID.
.br
.br
Example:
.br
$ firejail \-\-apparmor.print=browser
.br
5074:netblue:/usr/bin/firejail /usr/bin/firefox-esr
.br
AppArmor: firejail-default enforce
.TP
\fB\-\-bandwidth=name|pid
Set bandwidth limits for the sandbox identified by name or PID, see \fBTRAFFIC SHAPING\fR section for more details.
.TP
\fB\-\-bind=filename1,filename2
Mount-bind filename1 on top of filename2. This option is only available when running as root.
.br
.br
Example:
.br
# firejail \-\-bind=/config/etc/passwd,/etc/passwd
.TP
\fB\-\-blacklist=dirname_or_filename
Blacklist directory or file. File globbing is supported, see \fBFILE GLOBBING\fR section for more details.
.br
.br
Example:
.br
$ firejail \-\-blacklist=/sbin \-\-blacklist=/usr/sbin
.br
$ firejail \-\-blacklist=~/.mozilla
.br
$ firejail "\-\-blacklist=/home/username/My Virtual Machines"
.br
$ firejail \-\-blacklist=/home/username/My\\ Virtual\\ Machines
.TP
\fB\-c
Execute command and exit.
.TP
\fB\-\-caps
Linux capabilities is a kernel feature designed to split up the root privilege into a set of distinct privileges.
These privileges can be enabled or disabled independently, thus restricting what a process running
as root can do in the system.
By default root programs run with all capabilities enabled. \-\-caps option disables the following capabilities:
CAP_SYS_MODULE, CAP_SYS_RAWIO,
CAP_SYS_BOOT, CAP_SYS_NICE, CAP_SYS_TTY_CONFIG, CAP_SYSLOG, CAP_MKNOD, CAP_SYS_ADMIN.
The filter is applied to all processes started in the sandbox.
.br
.br
Example:
.br
$ sudo firejail \-\-caps /etc/init.d/nginx start
.TP
\fB\-\-caps.drop=all
Drop all capabilities for the processes running in the sandbox. This option is recommended for running GUI programs
or any other program that doesn't require root privileges. It is a must-have option for sandboxing untrusted programs
installed from unofficial sources - such as games, Java programs, etc.
.br
.br
Example:
.br
$ firejail \-\-caps.drop=all warzone2100
.TP
\fB\-\-caps.drop=capability,capability,capability
Define a custom blacklist Linux capabilities filter.
.br
.br
Example:
.br
$ firejail \-\-caps.drop=net_broadcast,net_admin,net_raw
.TP
\fB\-\-caps.keep=capability,capability,capability
Define a custom whitelist Linux capabilities filter.
.br
.br
Example:
.br
$ sudo firejail \-\-caps.keep=chown,net_bind_service,setgid,\\
setuid /etc/init.d/nginx start
.TP
\fB\-\-caps.print=name|pid
Print the caps filter for the sandbox identified by name or by PID.
.br
.br
Example:
.br
$ firejail \-\-name=mygame \-\-caps.drop=all warzone2100 &
.br
$ firejail \-\-caps.print=mygame
.br
.br
Example:
.br
$ firejail \-\-list
.br
3272:netblue::firejail \-\-private firefox
.br
$ firejail \-\-caps.print=3272
.TP
\fB\-\-cpu=cpu-number,cpu-number,cpu-number
Set CPU affinity.
.br
.br
Example:
.br
$ firejail \-\-cpu=0,1 handbrake
.TP
\fB\-\-cpu.print=name|pid
Print the CPU cores in use by the sandbox identified by name or by PID.
.br
.br
Example:
.br
$ firejail \-\-name=mygame \-\-caps.drop=all warzone2100 &
.br
$ firejail \-\-cpu.print=mygame
.br
.br
Example:
.br
$ firejail \-\-list
.br
3272:netblue::firejail \-\-private firefox
.br
$ firejail \-\-cpu.print=3272
.TP
\fB\-\-debug\fR
Print debug messages.
.br
.br
Example:
.br
$ firejail \-\-debug firefox
.TP
\fB\-\-debug-blacklists\fR
Debug blacklisting.
.br
.br
Example:
.br
$ firejail \-\-debug-blacklists firefox
.TP
\fB\-\-debug-caps
Print all recognized capabilities in the current Firejail software build and exit.
.br
.br
Example:
.br
$ firejail \-\-debug-caps
.TP
\fB\-\-debug-errnos
Print all recognized error numbers in the current Firejail software build and exit.
.br
.br
Example:
.br
$ firejail \-\-debug-errnos
.TP
\fB\-\-debug-protocols
Print all recognized protocols in the current Firejail software build and exit.
.br
.br
Example:
.br
$ firejail \-\-debug-protocols
.TP
\fB\-\-debug-syscalls
Print all recognized system calls in the current Firejail software build and exit.
.br
.br
Example:
.br
$ firejail \-\-debug-syscalls
.TP
\fB\-\-debug-whitelists\fR
Debug whitelisting.
.br
.br
Example:
.br
$ firejail \-\-debug-whitelists firefox
.TP
\fB\-\-defaultgw=address
Use this address as default gateway in the new network namespace.
.br
.br
Example:
.br
$ firejail \-\-net=eth0 \-\-defaultgw=10.10.20.1 firefox
.TP
\fB\-\-disable-mnt
Disable /mnt, /media, /run/mount and /run/media access.
.br
.br
Example:
.br
$ firejail \-\-disable-mnt firefox
.TP
\fB\-\-dns=address
Set a DNS server for the sandbox. Up to three DNS servers can be defined.
Use this option if you don't trust the DNS setup on your network.
.br
.br
Example:
.br
$ firejail \-\-dns=8.8.8.8 \-\-dns=8.8.4.4 firefox
.br
.br
Note: this feature is not supported on systemd-resolved setups.
.TP
\fB\-\-dns.print=name|pid
Print DNS configuration for a sandbox identified by name or by PID.
.br
.br
Example:
.br
$ firejail \-\-name=mygame \-\-caps.drop=all warzone2100 &
.br
$ firejail \-\-dns.print=mygame
.br
.br
Example:
.br
$ firejail \-\-list
.br
3272:netblue::firejail \-\-private firefox
.br
$ firejail \-\-dns.print=3272
.TP
\fB\-\-env=name=value
Set environment variable in the new sandbox.
.br
.br
Example:
.br
$ firejail \-\-env=LD_LIBRARY_PATH=/opt/test/lib
.TP
\fB\-\-fs.print=name|pid
Print the filesystem log for the sandbox identified by name or by PID.
.br
.br
Example:
.br
$ firejail \-\-name=mygame \-\-caps.drop=all warzone2100 &
.br
$ firejail \-\-fs.print=mygame
.br
.br
Example:
.br
$ firejail \-\-list
.br
3272:netblue::firejail \-\-private firefox
.br
$ firejail \-\-fs.print=3272
.TP
\fB\-?\fR, \fB\-\-help\fR
Print options end exit.
.TP
\fB\-\-hostname=name
Set sandbox hostname.
.br
.br
Example:
.br
$ firejail \-\-hostname=officepc firefox
.TP
\fB\-\-hosts-file=file
Use file as /etc/hosts.
.br
.br
Example:
.br
$ firejail \-\-hosts-file=~/myhosts firefox
.TP
\fB\-\-ignore=command
Ignore command in profile file.
.br
.br
Example:
.br
$ firejail \-\-ignore=shell --ignore=seccomp firefox
.br
$ firejail \-\-ignore="net eth0" firefox
.TP
\fB\-\-interface=interface
Move interface in a new network namespace. Up to four --interface options can be specified.
Note: wlan devices are not supported for this option.
.br
.br
Example:
.br
$ firejail \-\-interface=eth1 \-\-interface=eth0.vlan100
.TP
\fB\-\-ip=address
Assign IP addresses to the last network interface defined by a \-\-net option. A
default gateway is assigned by default.
.br
.br
Example:
.br
$ firejail \-\-net=eth0 \-\-ip=10.10.20.56 firefox
.TP
\fB\-\-ip=none
No IP address and no default gateway are configured for the last interface
defined by a \-\-net option. Use this option
in case you intend to start an external DHCP client in the sandbox.
.br
.br
Example:
.br
$ firejail \-\-net=eth0 \-\-\ip=none
.br
.br
If the corresponding interface doesn't have an IP address configured, this
option is enabled by default.
.TP
\fB\-\-ip6=address
Assign IPv6 addresses to the last network interface defined by a \-\-net option.
.br
.br
Example:
.br
$ firejail \-\-net=eth0 \-\-ip6=2001:0db8:0:f101::1/64 firefox
Note: you don't need this option if you obtain your ip6 address from router via SLAAC (your ip6 address and default route will be configured by kernel automatically).
.TP
\fB\-\-iprange=address,address
Assign an IP address in the provided range to the last network interface defined by a \-\-net option. A
default gateway is assigned by default.
.br
.br
Example:
.br
$ firejail \-\-net=eth0 \-\-\iprange=192.168.1.100,192.168.1.150
.TP
\fB\-\-ipc-namespace
Enable a new IPC namespace if the sandbox was started as a regular user. IPC namespace is enabled by default
for sandboxes started as root.
.br
.br
Example:
.br
$ firejail \-\-ipc-namespace firefox
.TP
\fB\-\-join=name|pid
Join the sandbox identified by name or by PID. By default a /bin/bash shell is started after joining the sandbox.
If a program is specified, the program is run in the sandbox. If \-\-join command is issued as a regular user,
all security filters are configured for the new process the same they are configured in the sandbox.
If \-\-join command is issued as root, the security filters, cgroups and cpus configurations are not applied
to the process joining the sandbox.
.br
.br
Example:
.br
$ firejail \-\-name=mygame \-\-caps.drop=all warzone2100 &
.br
$ firejail \-\-join=mygame
.br
.br
Example:
.br
$ firejail \-\-list
.br
3272:netblue::firejail \-\-private firefox
.br
$ firejail \-\-join=3272
.TP
\fB\-\-join-filesystem=name|pid
Join the mount namespace of the sandbox identified by name or PID. By default a /bin/bash shell is started after joining the sandbox.
If a program is specified, the program is run in the sandbox. This command is available only to root user.
Security filters, cgroups and cpus configurations are not applied to the process joining the sandbox.
.TP
\fB\-\-join-network=name|pid
Join the network namespace of the sandbox identified by name. By default a /bin/bash shell is started after joining the sandbox.
If a program is specified, the program is run in the sandbox. This command is available only to root user.
Security filters, cgroups and cpus configurations are not applied to the process joining the sandbox. Example:
.br
.br
# start firefox
.br
$ firejail --net=eth0 --name=browser firefox &
.br
.br
# change netfilter configuration
.br
$ sudo firejail --join-network=browser bash -c "cat /etc/firejail/nolocal.net | /sbin/iptables-restore"
.br
.br
# verify netfilter configuration
.br
$ sudo firejail --join-network=browser /sbin/iptables -vL
.br
.br
# verify IP addresses
.br
$ sudo firejail --join-network=browser ip addr
.br
Switching to pid 1932, the first child process inside the sandbox
.br
1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default
.br
link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
.br
inet 127.0.0.1/8 scope host lo
.br
valid_lft forever preferred_lft forever
.br
inet6 ::1/128 scope host
.br
valid_lft forever preferred_lft forever
.br
2: eth0-1931: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue state UNKNOWN group default
.br
link/ether 76:58:14:42:78:e4 brd ff:ff:ff:ff:ff:ff
.br
inet 192.168.1.158/24 brd 192.168.1.255 scope global eth0-1931
.br
valid_lft forever preferred_lft forever
.br
inet6 fe80::7458:14ff:fe42:78e4/64 scope link
.br
valid_lft forever preferred_lft forever
.TP
\fB\-\-join-or-start=name
Join the sandbox identified by name or start a new one.
Same as "firejail --join=name" if sandbox with specified name exists, otherwise same as "firejail --name=name ..."
.br
Note that in contrary to other join options there is respective profile option.
.TP
\fB\-\-keep-dev-shm
/dev/shm directory is untouched (even with --private-dev)
.br
.br
Example:
.br
$ firejail --keep-dev-shm --private-dev
.TP
\fB\-\-keep-var-tmp
/var/tmp directory is untouched.
.br
.br
Example:
.br
$ firejail --keep-var-tmp
.TP
\fB\-\-list
List all sandboxes, see \fBMONITORING\fR section for more details.
.br
.br
Example:
.br
$ firejail \-\-list
.br
7015:netblue:browser:firejail firefox
.br
7056:netblue:torrent:firejail \-\-net=eth0 transmission-gtk
.br
7064:netblue::firejail \-\-noroot xterm
.br
$
.TP
\fB\-\-mac=address
Assign MAC addresses to the last network interface defined by a \-\-net option. This option
is not supported for wireless interfaces.
.br
.br
Example:
.br
$ firejail \-\-net=eth0 \-\-mac=00:11:22:33:44:55 firefox
.TP
\fB\-\-machine-id
Spoof id number in /etc/machine-id file - a new random id is generated inside the sandbox.
.br
.br
Example:
.br
$ firejail \-\-machine-id
.TP
\fB\-\-memory-deny-write-execute
Install a seccomp filter to block attempts to create memory mappings
that are both writable and executable, to change mappings to be
executable, or to create executable shared memory. The filter examines
the arguments of mmap, mmap2, mprotect, pkey_mprotect and shmat system
calls and kills the process if necessary.
.br
.br
Note: shmat is not implemented
as a system call on some platforms including i386, and it cannot be
handled by seccomp-bpf.
.TP
\fB\-\-mtu=number
Assign a MTU value to the last network interface defined by a \-\-net option.
.br
.br
Example:
.br
$ firejail \-\-net=eth0 \-\-mtu=1492
.TP
\fB\-\-name=name
Set sandbox name. Several options, such as \-\-join and \-\-shutdown, can use
this name to identify a sandbox.
.br
.br
Example:
.br
$ firejail \-\-name=mybrowser firefox
.TP
\fB\-\-net=bridge_interface
Enable a new network namespace and connect it to this bridge interface.
Unless specified with option \-\-ip and \-\-defaultgw, an IP address and a default gateway will be assigned
automatically to the sandbox. The IP address is verified using ARP before assignment. The address
configured as default gateway is the bridge device IP address. Up to four \-\-net
options can be specified.
.br
.br
Example:
.br
$ sudo brctl addbr br0
.br
$ sudo ifconfig br0 10.10.20.1/24
.br
$ sudo brctl addbr br1
.br
$ sudo ifconfig br1 10.10.30.1/24
.br
$ firejail \-\-net=br0 \-\-net=br1
.TP
\fB\-\-net=ethernet_interface|wireless_interface
Enable a new network namespace and connect it
to this ethernet interface using the standard Linux macvlan|ipvaln
driver. Unless specified with option \-\-ip and \-\-defaultgw, an
IP address and a default gateway will be assigned automatically
to the sandbox. The IP address is verified using ARP before
assignment. The address configured as default gateway is the
default gateway of the host. Up to four \-\-net options can be specified.
Support for ipvlan driver was introduced in Linux kernel 3.19.
.br
.br
Example:
.br
$ firejail \-\-net=eth0 \-\-ip=192.168.1.80 \-\-dns=8.8.8.8 firefox
.br
$ firejail \-\-net=wlan0 firefox
.TP
\fB\-\-net=tap_interface
Enable a new network namespace and connect it
to this ethernet tap interface using the standard Linux macvlan
driver. If the tap interface is not configured, the sandbox
will not try to configure the interface inside the sandbox.
Please use \-\-ip, \-\-netmask and \-\-defaultgw to specify the configuration.
.br
.br
Example:
.br
$ firejail \-\-net=tap0 \-\-ip=10.10.20.80 \-\-netmask=255.255.255.0 \-\-defaultgw=10.10.20.1 firefox
.TP
\fB\-\-net=none
Enable a new, unconnected network namespace. The only interface
available in the new namespace is a new loopback interface (lo).
Use this option to deny
network access to programs that don't really need network access.
.br
.br
Example:
.br
$ firejail \-\-net=none vlc
.br
.br
Note: \-\-net=none can crash the application on some platforms.
In these cases, it can be replaced with \-\-protocol=unix.
.TP
\fB\-\-netfilter
Enable a default firewall if a new network namespace is created inside the sandbox.
This option has no effect for sandboxes using the system network namespace.
.br
.br
The default firewall is optimized for regular desktop applications. No incoming
connections are accepted:
.br
.br
*filter
.br
:INPUT DROP [0:0]
.br
:FORWARD DROP [0:0]
.br
:OUTPUT ACCEPT [0:0]
.br
\-A INPUT \-i lo \-j ACCEPT
.br
\-A INPUT \-m state \-\-state RELATED,ESTABLISHED \-j ACCEPT
.br
# allow ping
.br
\-A INPUT \-p icmp \-\-icmp-type destination-unreachable \-j ACCEPT
.br
\-A INPUT \-p icmp \-\-icmp-type time-exceeded \-j ACCEPT
.br
\-A INPUT \-p icmp \-\-icmp-type echo-request \-j ACCEPT
.br
# drop STUN (WebRTC) requests
.br
-A OUTPUT -p udp --dport 3478 -j DROP
.br
-A OUTPUT -p udp --dport 3479 -j DROP
.br
-A OUTPUT -p tcp --dport 3478 -j DROP
.br
-A OUTPUT -p tcp --dport 3479 -j DROP
.br
COMMIT
.br
.br
Example:
.br
$ firejail \-\-net=eth0 \-\-netfilter firefox
.TP
\fB\-\-netfilter=filename
Enable the firewall specified by filename if a new network namespace is created inside the sandbox.
This option has no effect for sandboxes using the system network namespace.
.br
.br
Please use the regular iptables-save/iptables-restore format for the filter file. The following
examples are available in /etc/firejail directory:
.br
.br
.B webserver.net
is a webserver firewall that allows access only to TCP ports 80 and 443.
Example:
.br
.br
$ firejail --netfilter=/etc/firejail/webserver.net --net=eth0 \\
.br
/etc/init.d/apache2 start
.br
.br
.B nolocal.net
is a desktop client firewall that disable access to local network. Example:
.br
.br
$ firejail --netfilter=/etc/firejail/nolocal.net \\
.br
--net=eth0 firefox
.TP
\fB\-\-netfilter=filename,arg1,arg2,arg3 ...
This is the template version of the previous command. $ARG1, $ARG2, $ARG3 ... in the firewall script
are replaced with arg1, arg2, arg3 ... passed on the command line. Up to 16 arguments are supported.
Example:
.br
.br
$ firejail --net=eth0 --ip=192.168.1.105 \\
.br
--netfilter=/etc/firejail/tcpserver.net,5001 server-program
.br
.TP
\fB\-\-netfilter.print=name|pid
Print the firewall installed in the sandbox specified by name or PID. Example:
.br
.br
$ firejail --name=browser --net=eth0 --netfilter firefox &
.br
$ firejail --netfilter.print=browser
.TP
\fB\-\-netfilter6=filename
Enable the IPv6 firewall specified by filename if a new network namespace is created inside the sandbox.
This option has no effect for sandboxes using the system network namespace.
Please use the regular iptables-save/iptables-restore format for the filter file.
.TP
\fB\-\-netfilter6.print=name|pid
Print the IPv6 firewall installed in the sandbox specified by name or PID. Example:
.br
.br
$ firejail --name=browser --net=eth0 --netfilter firefox &
.br
$ firejail --netfilter6.print=browser
.TP
\fB\-\-netmask=address
Use this option when you want to assign an IP address in a new namespace and
the parent interface specified by --net is not configured. An IP address and
a default gateway address also have to be added. By default the new namespace
interface comes without IP address and default gateway configured. Example:
.br
.br
$ sudo /sbin/brctl addbr br0
.br
$ sudo /sbin/ifconfig br0 up
.br
$ firejail --ip=10.10.20.67 --netmask=255.255.255.0 --defaultgw=10.10.20.1
.TP
\fB\-\-netns=name
Run the program in a named, persistent network namespace. These can
be created and configured using "ip netns".
.TP
\fB\-\-netstats
Monitor network namespace statistics, see \fBMONITORING\fR section for more details.
.br
.br
Example:
.br
.br
$ firejail \-\-netstats
.br
PID User RX(KB/s) TX(KB/s) Command
.br
1294 netblue 53.355 1.473 firejail \-\-net=eth0 firefox
.br
7383 netblue 9.045 0.112 firejail \-\-net=eth0 transmission
.TP
\fB\-\-nice=value
Set nice value for all processes running inside the sandbox.
Only root may specify a negative value.
.br
.br
Example:
.br
$ firejail --nice=2 firefox
.TP
\fB\-\-no3d
Disable 3D hardware acceleration.
.br
.br
Example:
.br
$ firejail --no3d firefox
.TP
\fB\-\-noblacklist=dirname_or_filename
Disable blacklist for this directory or file.
.br
.br
Example:
.br
$ firejail
.br
$ nc dict.org 2628
.br
bash: /bin/nc: Permission denied
.br
$ exit
.br
.br
$ firejail --noblacklist=/bin/nc
.br
$ nc dict.org 2628
.br
220 pan.alephnull.com dictd 1.12.1/rf on Linux 3.14-1-amd64
.br
.TP
\fB\-\-nodbus
Disable D-Bus access. Only the regular UNIX socket is handled by this command. To
disable the abstract socket you would need to request a new network namespace using
\-\-net command. Another option is to remove unix from \-\-protocol set.
.br
.br
Example:
.br
$ firejail \-\-nodbus \-\-net=none
.TP
\fB\-\-nodvd
Disable DVD and audio CD devices.
.br
.br
Example:
.br
$ firejail \-\-nodvd
.TP
\fB\-\-noexec=dirname_or_filename
Remount directory or file noexec, nodev and nosuid. File globbing is supported, see \fBFILE GLOBBING\fR section for more details.
.br
.br
Example:
.br
$ firejail \-\-noexec=/tmp
.br
.br
/etc and /var are noexec by default if the sandbox was started as a regular user. If there are more than one mount operation
on the path of the file or directory, noexec should be applied to the last one. Always check if the change took effect inside the sandbox.
.TP
\fB\-\-nogroups
Disable supplementary groups. Without this option, supplementary groups are enabled for the user starting the
sandbox. For root user supplementary groups are always disabled.
.br
.br
Note: By default all regular user groups are removed with the exception of the current user. This can be changed
using \-\-allusers command option.
.br
.br
Example:
.br
$ id
.br
uid=1000(netblue) gid=1000(netblue) groups=1000(netblue),24(cdrom),25(floppy),27(sudo),29(audio)
.br
$ firejail \-\-nogroups
.br
Parent pid 8704, child pid 8705
.br
Child process initialized
.br
$ id
.br
uid=1000(netblue) gid=1000(netblue) groups=1000(netblue)
.br
$
.TP
\fB\-\-noprofile
Do not use a security profile.
.br
.br
Example:
.br
$ firejail
.br
Reading profile /etc/firejail/default.profile
.br
Parent pid 8553, child pid 8554
.br
Child process initialized
.br
[...]
.br
.br
$ firejail \-\-noprofile
.br
Parent pid 8553, child pid 8554
.br
Child process initialized
.br
[...]
.TP
\fB\-\-noroot
Install a user namespace with a single user - the current user.
root user does not exist in the new namespace. This option
requires a Linux kernel version 3.8 or newer. The option
is not supported for \-\-chroot and \-\-overlay configurations,
or for sandboxes started as root.
.br
.br
Example:
.br
$ firejail \-\-noroot
.br
Parent pid 8553, child pid 8554
.br
Child process initialized
.br
$ ping google.com
.br
ping: icmp open socket: Operation not permitted
.br
$
.TP
\fB\-\-nonewprivs
Sets the NO_NEW_PRIVS prctl. This ensures that child processes
cannot acquire new privileges using execve(2); in particular,
this means that calling a suid binary (or one with file capabilities)
does not result in an increase of privilege. This option
is enabled by default if seccomp filter is activated.
.TP
\fB\-\-nosound
Disable sound system.
.br
.br
Example:
.br
$ firejail \-\-nosound firefox
.TP
\fB\-\-noautopulse
Disable automatic ~/.config/pulse init, for complex setups such as remote
pulse servers or non-standard socket paths.
.br
.br
Example:
.br
$ firejail \-\-noautopulse firefox
.TP
\fB\-\-notv
Disable DVB (Digital Video Broadcasting) TV devices.
.br
.br
Example:
.br
$ firejail \-\-notv vlc
.TP
\fB\-\-nou2f
Disable U2F devices.
.br
.br
Example:
.br
$ firejail \-\-nou2f
.TP
\fB\-\-novideo
Disable video devices.
.br
.TP
\fB\-\-nowhitelist=dirname_or_filename
Disable whitelist for this directory or file.
.TP
\fB\-\-private
Mount new /root and /home/user directories in temporary
filesystems. All modifications are discarded when the sandbox is
closed.
.br
.br
Example:
.br
$ firejail \-\-private firefox
.TP
\fB\-\-private=directory
Use directory as user home.
.br
.br
Example:
.br
$ firejail \-\-private=/home/netblue/firefox-home firefox
.TP
\fB\-\-private-cache
Mount an empty temporary filesystem on top of the .cache directory in user home. All
modifications are discarded when the sandbox is closed.
.br
.br
Example:
.br
$ firejail \-\-private-cache openbox
.TP
\fB\-\-private-dev
Create a new /dev directory. Only disc, dri, null, full, zero, tty, pts, ptmx, random, snd, urandom, video, log and shm devices are available.
.br
.br
Example:
.br
$ firejail \-\-private-dev
.br
Parent pid 9887, child pid 9888
.br
Child process initialized
.br
$ ls /dev
.br
cdrom cdrw dri dvd dvdrw full log null ptmx pts random shm snd sr0 tty urandom zero
.br
$
.TP
\fB\-\-private-tmp
Mount an empty temporary filesystem on top of /tmp directory whitelisting X11 and PulseAudio sockets.
.br
.br
Example:
.br
$ firejail \-\-private-tmp
.br
$ ls -al /tmp
.br
drwxrwxrwt 4 nobody nogroup 80 Apr 30 11:46 .
.br
drwxr-xr-x 30 nobody nogroup 4096 Apr 26 22:18 ..
.br
drwx------ 2 nobody nogroup 4096 Apr 30 10:52 pulse-PKdhtXMmr18n
.br
drwxrwxrwt 2 nobody nogroup 4096 Apr 30 10:52 .X11-unix
.br
.TP
\fB\-\-profile=filename
Load a custom security profile from filename. For filename use an absolute path or a path relative to the current path.
For more information, see \fBSECURITY PROFILES\fR section below.
.br
.br
Example:
.br
$ firejail \-\-profile=myprofile
.TP
\fB\-\-profile.print=name|pid
Print the name of the profile file for the sandbox identified by name or or PID.
.br
.br
Example:
.br
$ firejail \-\-profile.print=browser
.br
/etc/firejail/firefox.profile
.br
.TP
\fB\-\-protocol=protocol,protocol,protocol
Enable protocol filter. The filter is based on seccomp and checks the first argument to socket system call.
Recognized values: unix, inet, inet6, netlink and packet. This option is not supported for i386 architecture.
.br
.br
Example:
.br
$ firejail \-\-protocol=unix,inet,inet6 firefox
.TP
\fB\-\-protocol.print=name|pid
Print the protocol filter for the sandbox identified by name or PID.
.br
.br
Example:
.br
$ firejail \-\-name=mybrowser firefox &
.br
$ firejail \-\-protocol.print=mybrowser
.br
unix,inet,inet6,netlink
.br
.br
Example:
.br
$ firejail \-\-list
.br
3272:netblue::firejail \-\-private firefox
.br
$ firejail \-\-protocol.print=3272
.br
unix,inet,inet6,netlink
.TP
\fB\-\-quiet
Turn off Firejail's output.
.TP
\fB\-\-read-only=dirname_or_filename
Set directory or file read-only. File globbing is supported, see \fBFILE GLOBBING\fR section for more details.
.br
.br
Example:
.br
$ firejail \-\-read-only=~/.mozilla firefox
.br
.br
A short note about mixing \-\-whitelist and \-\-read-only options. Whitelisted directories
should be made read-only independently. Making a parent directory read-only, will not
make the whitelist read-only. Example:
.br
.br
$ firejail --whitelist=~/work --read-only=~ --read-only=~/work
.TP
\fB\-\-read-write=dirname_or_filename
Set directory or file read-write. Only files or directories belonging to the current user are allowed for
this operation. File globbing is supported, see \fBFILE GLOBBING\fR section for more details.
Example:
.br
.br
$ mkdir ~/test
.br
$ touch ~/test/a
.br
$ firejail --read-only=~/test --read-write=~/test/a
.TP
\fB\-\-rmenv=name
Remove environment variable in the new sandbox.
.br
.br
Example:
.br
$ firejail \-\-rmenv=DBUS_SESSION_BUS_ADDRESS
.TP
\fB\-\-scan
ARP-scan all the networks from inside a network namespace.
This makes it possible to detect macvlan kernel device drivers running on the current host.
.br
.br
Example:
.br
$ firejail \-\-net=eth0 \-\-scan
.TP
\fB\-\-seccomp
Enable seccomp filter and blacklist the syscalls in the default list (@default). The default list is as follows:
_sysctl, acct, add_key, adjtimex, afs_syscall, bdflush, bpf, break, chroot, clock_adjtime, clock_settime,
create_module, delete_module, fanotify_init, finit_module, ftime, get_kernel_syms, getpmsg, gtty, init_module,
io_cancel, io_destroy, io_getevents, io_setup, io_submit, ioperm, iopl, ioprio_set, kcmp, kexec_file_load,
kexec_load, keyctl, lock, lookup_dcookie, mbind, migrate_pages, modify_ldt, mount, move_pages, mpx,
name_to_handle_at, nfsservctl, ni_syscall, open_by_handle_at, pciconfig_iobase, pciconfig_read, pciconfig_write, perf_event_open,
personality, pivot_root, process_vm_readv, process_vm_writev, prof, profil, ptrace, putpmsg,
query_module, reboot, remap_file_pages, request_key, rtas, s390_mmio_read, s390_mmio_write, s390_runtime_instr,
security, set_mempolicy, setdomainname, sethostname, settimeofday, sgetmask, ssetmask, stime, stty, subpage_prot,
swapoff, swapon, switch_endian, sys_debug_setcontext, sysfs, syslog, tuxcall, ulimit, umount, umount2, uselib, userfaultfd, ustat, vhangup,
vm86, vm86old, vmsplice and vserver.
.br
To help creating useful seccomp filters more easily, the following
system call groups are defined: @clock, @cpu-emulation, @debug,
@default, @default-nodebuggers, @default-keep, @module, @obsolete,
@privileged, @raw-io, @reboot, @resources and @swap. In addtion, a
system call can be specified by its number instead of name with prefix
$, so for example $165 would be equal to mount on i386.
.br
System architecture is strictly imposed only if flag
\-\-seccomp.block-secondary is used. The filter is applied at run time
only if the correct architecture was detected. For the case of I386
and AMD64 both 32-bit and 64-bit filters are installed.
.br
.br
Firejail will print seccomp violations to the audit log if the kernel was compiled with audit support (CONFIG_AUDIT flag).
.br
.br
Example:
.br
$ firejail \-\-seccomp
.TP
\fB\-\-seccomp=syscall,@group
Enable seccomp filter, blacklist the default list (@default) and the syscalls or syscall groups specified by the command.
.br
.br
Example:
.br
$ firejail \-\-seccomp=utime,utimensat,utimes firefox
.br
$ firejail \-\-seccomp=@clock,mkdir,unlinkat transmission-gtk
.br
.br
Instead of dropping the syscall, a specific error number can be returned
using \fBsyscall:errorno\fR syntax.
.br
.br
Example:
$ firejail \-\-seccomp=unlinkat:ENOENT,utimensat,utimes
.br
Parent pid 10662, child pid 10663
.br
Child process initialized
.br
$ touch testfile
.br
$ rm testfile
.br
rm: cannot remove `testfile': Operation not permitted
.br
.br
If the blocked system calls would also block Firejail from operating,
they are handled by adding a preloaded library which performs seccomp
system calls later.
.br
.br
Example:
.br
$ firejail \-\-noprofile \-\-shell=none \-\-seccomp=execve bash
.br
Parent pid 32751, child pid 32752
.br
Post-exec seccomp protector enabled
.br
list in: execve, check list: @default-keep prelist: (null), postlist: execve
.br
Child process initialized in 46.44 ms
.br
$ ls
.br
Bad system call
.br
.TP
\fB\-\-seccomp.block-secondary
Enable seccomp filter and filter system call architectures so that
only the native architecture is allowed. For example, on amd64, i386
and x32 system calls are blocked as well as changing the execution
domain with personality(2) system call.
.br
.TP
\fB\-\-seccomp.drop=syscall,@group
Enable seccomp filter, and blacklist the syscalls or the syscall groups specified by the command.
.br
.br
Example:
.br
$ firejail \-\-seccomp.drop=utime,utimensat,utimes,@clock
.br
.br
Instead of dropping the syscall, a specific error number can be returned
using \fBsyscall:errorno\fR syntax.
.br
.br
Example:
.br
$ firejail \-\-seccomp.drop=unlinkat:ENOENT,utimensat,utimes
.br
Parent pid 10662, child pid 10663
.br
Child process initialized
.br
$ touch testfile
.br
$ rm testfile
.br
rm: cannot remove `testfile': Operation not permitted
.br
.TP
\fB\-\-seccomp.keep=syscall,syscall,syscall
Enable seccomp filter, and whitelist the syscalls specified by the
command. The system calls needed by Firejail (group @default-keep:
prctl, execve) are handled with the preload library.
.br
.br
Example:
.br
$ firejail \-\-shell=none \-\-seccomp.keep=poll,select,[...] transmission-gtk
.TP
\fB\-\-seccomp.print=name|pid
Print the seccomp filter for the sandbox identified by name or PID.
.br
.br
Example:
.br
$ firejail \-\-name=browser firefox &
.br
$ firejail --seccomp.print=browser
.br
line OP JT JF K
.br
=================================
.br
0000: 20 00 00 00000004 ld data.architecture
.br
0001: 15 01 00 c000003e jeq ARCH_64 0003 (false 0002)
.br
0002: 06 00 00 7fff0000 ret ALLOW
.br
0003: 20 00 00 00000000 ld data.syscall-number
.br
0004: 35 01 00 40000000 jge X32_ABI true:0006 (false 0005)
.br
0005: 35 01 00 00000000 jge read 0007 (false 0006)
.br
0006: 06 00 00 00050001 ret ERRNO(1)
.br
0007: 15 41 00 0000009a jeq modify_ldt 0049 (false 0008)
.br
0008: 15 40 00 000000d4 jeq lookup_dcookie 0049 (false 0009)
.br
0009: 15 3f 00 0000012a jeq perf_event_open 0049 (false 000a)
.br
000a: 15 3e 00 00000137 jeq process_vm_writev 0049 (false 000b)
.br
000b: 15 3d 00 0000009c jeq _sysctl 0049 (false 000c)
.br
000c: 15 3c 00 000000b7 jeq afs_syscall 0049 (false 000d)
.br
000d: 15 3b 00 000000ae jeq create_module 0049 (false 000e)
.br
000e: 15 3a 00 000000b1 jeq get_kernel_syms 0049 (false 000f)
.br
000f: 15 39 00 000000b5 jeq getpmsg 0049 (false 0010)
.br
0010: 15 38 00 000000b6 jeq putpmsg 0049 (false 0011)
.br
0011: 15 37 00 000000b2 jeq query_module 0049 (false 0012)
.br
0012: 15 36 00 000000b9 jeq security 0049 (false 0013)
.br
0013: 15 35 00 0000008b jeq sysfs 0049 (false 0014)
.br
0014: 15 34 00 000000b8 jeq tuxcall 0049 (false 0015)
.br
0015: 15 33 00 00000086 jeq uselib 0049 (false 0016)
.br
0016: 15 32 00 00000088 jeq ustat 0049 (false 0017)
.br
0017: 15 31 00 000000ec jeq vserver 0049 (false 0018)
.br
0018: 15 30 00 0000009f jeq adjtimex 0049 (false 0019)
.br
0019: 15 2f 00 00000131 jeq clock_adjtime 0049 (false 001a)
.br
001a: 15 2e 00 000000e3 jeq clock_settime 0049 (false 001b)
.br
001b: 15 2d 00 000000a4 jeq settimeofday 0049 (false 001c)
.br
001c: 15 2c 00 000000b0 jeq delete_module 0049 (false 001d)
.br
001d: 15 2b 00 00000139 jeq finit_module 0049 (false 001e)
.br
001e: 15 2a 00 000000af jeq init_module 0049 (false 001f)
.br
001f: 15 29 00 000000ad jeq ioperm 0049 (false 0020)
.br
0020: 15 28 00 000000ac jeq iopl 0049 (false 0021)
.br
0021: 15 27 00 000000f6 jeq kexec_load 0049 (false 0022)
.br
0022: 15 26 00 00000140 jeq kexec_file_load 0049 (false 0023)
.br
0023: 15 25 00 000000a9 jeq reboot 0049 (false 0024)
.br
0024: 15 24 00 000000a7 jeq swapon 0049 (false 0025)
.br
0025: 15 23 00 000000a8 jeq swapoff 0049 (false 0026)
.br
0026: 15 22 00 000000a3 jeq acct 0049 (false 0027)
.br
0027: 15 21 00 00000141 jeq bpf 0049 (false 0028)
.br
0028: 15 20 00 000000a1 jeq chroot 0049 (false 0029)
.br
0029: 15 1f 00 000000a5 jeq mount 0049 (false 002a)
.br
002a: 15 1e 00 000000b4 jeq nfsservctl 0049 (false 002b)
.br
002b: 15 1d 00 0000009b jeq pivot_root 0049 (false 002c)
.br
002c: 15 1c 00 000000ab jeq setdomainname 0049 (false 002d)
.br
002d: 15 1b 00 000000aa jeq sethostname 0049 (false 002e)
.br
002e: 15 1a 00 000000a6 jeq umount2 0049 (false 002f)
.br
002f: 15 19 00 00000099 jeq vhangup 0049 (false 0030)
.br
0030: 15 18 00 000000ee jeq set_mempolicy 0049 (false 0031)
.br
0031: 15 17 00 00000100 jeq migrate_pages 0049 (false 0032)
.br
0032: 15 16 00 00000117 jeq move_pages 0049 (false 0033)
.br
0033: 15 15 00 000000ed jeq mbind 0049 (false 0034)
.br
0034: 15 14 00 00000130 jeq open_by_handle_at 0049 (false 0035)
.br
0035: 15 13 00 0000012f jeq name_to_handle_at 0049 (false 0036)
.br
0036: 15 12 00 000000fb jeq ioprio_set 0049 (false 0037)
.br
0037: 15 11 00 00000067 jeq syslog 0049 (false 0038)
.br
0038: 15 10 00 0000012c jeq fanotify_init 0049 (false 0039)
.br
0039: 15 0f 00 00000138 jeq kcmp 0049 (false 003a)
.br
003a: 15 0e 00 000000f8 jeq add_key 0049 (false 003b)
.br
003b: 15 0d 00 000000f9 jeq request_key 0049 (false 003c)
.br
003c: 15 0c 00 000000fa jeq keyctl 0049 (false 003d)
.br
003d: 15 0b 00 000000ce jeq io_setup 0049 (false 003e)
.br
003e: 15 0a 00 000000cf jeq io_destroy 0049 (false 003f)
.br
003f: 15 09 00 000000d0 jeq io_getevents 0049 (false 0040)
.br
0040: 15 08 00 000000d1 jeq io_submit 0049 (false 0041)
.br
0041: 15 07 00 000000d2 jeq io_cancel 0049 (false 0042)
.br
0042: 15 06 00 000000d8 jeq remap_file_pages 0049 (false 0043)
.br
0043: 15 05 00 00000116 jeq vmsplice 0049 (false 0044)
.br
0044: 15 04 00 00000087 jeq personality 0049 (false 0045)
.br
0045: 15 03 00 00000143 jeq userfaultfd 0049 (false 0046)
.br
0046: 15 02 00 00000065 jeq ptrace 0049 (false 0047)
.br
0047: 15 01 00 00000136 jeq process_vm_readv 0049 (false 0048)
.br
0048: 06 00 00 7fff0000 ret ALLOW
.br
0049: 06 00 01 00000000 ret KILL
.br
$
.TP
\fB\-\-shell=none
Run the program directly, without a user shell.
.br
.br
Example:
.br
$ firejail \-\-shell=none script.sh
.TP
\fB\-\-shell=program
Set default user shell. Use this shell to run the application using \-c shell option.
For example "firejail \-\-shell=/bin/dash firefox" will start Mozilla Firefox as "/bin/dash \-c firefox".
By default Bash shell (/bin/bash) is used.
.br
.br
Example:
$firejail \-\-shell=/bin/dash script.sh
.TP
\fB\-\-shutdown=name|pid
Shutdown the sandbox identified by name or PID.
.br
.br
Example:
.br
$ firejail \-\-name=mygame \-\-caps.drop=all warzone2100 &
.br
$ firejail \-\-shutdown=mygame
.br
.br
Example:
.br
$ firejail \-\-list
.br
3272:netblue::firejail \-\-private firefox
.br
$ firejail \-\-shutdown=3272
.TP
\fB\-\-timeout=hh:mm:ss
Kill the sandbox automatically after the time has elapsed. The time is specified in hours/minutes/seconds format.
.br
.br
$ firejail \-\-timeout=01:30:00 firefox
.TP
\fB\-\-tmpfs=dirname
Mount a tmpfs filesystem on directory dirname. This option is available only when running the sandbox as root.
File globbing is supported, see \fBFILE GLOBBING\fR section for more details.
.br
.br
Example:
.br
# firejail \-\-tmpfs=/var
.TP
\fB\-\-top
Monitor the most CPU-intensive sandboxes, see \fBMONITORING\fR section for more details.
.br
.br
Example:
.br
$ firejail \-\-top
.TP
\fB\-\-trace
Trace open, access and connect system calls.
.br
.br
Example:
.br
$ firejail \-\-trace wget -q www.debian.org
.br
Reading profile /etc/firejail/wget.profile
.br
3:wget:fopen64 /etc/wgetrc:0x5c8e8ce6c0
.br
3:wget:fopen /etc/hosts:0x5c8e8cfb70
.br
3:wget:socket AF_INET SOCK_DGRAM IPPROTO_IP:3
.br
3:wget:connect 3 8.8.8.8 port 53:0
.br
3:wget:socket AF_INET SOCK_STREAM IPPROTO_IP:3
.br
3:wget:connect 3 130.89.148.14 port 80:0
.br
3:wget:fopen64 index.html:0x5c8e8d1a60
.br
.br
parent is shutting down, bye...
.TP
\fB\-\-tree
Print a tree of all sandboxed processes, see \fBMONITORING\fR section for more details.
.br
.br
Example:
.br
$ firejail \-\-tree
.br
11903:netblue:firejail iceweasel
.br
11904:netblue:iceweasel
.br
11957:netblue:/usr/lib/iceweasel/plugin-container
.br
11969:netblue:firejail \-\-net=eth0 transmission-gtk
.br
11970:netblue:transmission-gtk
.TP
\fB\-\-tunnel[=devname]
Connect the sandbox to a network overlay/VPN tunnel created by firetunnel utility. This options
tries first the client side of the tunnel. If this fails, it tries the server side. If multiple tunnels are active,
please specify the tunnel device using \-\-tunnel=devname.
.br
.br
The available tunnel devices are listed in /etc/firetunnel directory, one file for each device.
The files are regular firejail profile files containing the network configuration,
and are created and managed by firetunnel utility.
By default ftc is the client-side device and fts is the server-side device. For more information
please see man 1 firetunnel.
.br
.br
Example:
.br
$ firejail --tunnel firefox
.br
.TP
\fB\-\-version
Print program version and exit.
.br
.br
Example:
.br
$ firejail \-\-version
.br
firejail version 0.9.27
.TP
\fB\-\-veth-name=name
Use this name for the interface connected to the bridge for --net=bridge_interface commands,
instead of the default one.
.br
.br
Example:
.br
$ firejail \-\-net=br0 --veth-name=if0
.TP
\fB\-\-whitelist=dirname_or_filename
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 could be
user home, /dev, /etc, /media, /mnt, /opt, /srv, /sys/module, /usr/share, /var, and /tmp.
.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.
.br
.br
Example:
.br
$ firejail \-\-noprofile \-\-whitelist=~/.mozilla
.br
$ firejail \-\-whitelist=/tmp/.X11-unix --whitelist=/dev/null
.br
$ firejail "\-\-whitelist=/home/username/My Virtual Machines"
.TP
\fB\-\-writable-etc
Mount /etc directory read-write.
.br
.br
Example:
.br
$ sudo firejail --writable-etc
.TP
\fB\-\-writable-run-user
Disable the default blacklisting of /run/user/$UID/systemd and /run/user/$UID/gnupg.
.br
.br
Example:
.br
$ sudo firejail --writable-run-user
.TP
\fB\-\-writable-var
Mount /var directory read-write.
.br
.br
Example:
.br
$ sudo firejail --writable-var
.TP
\fB\-\-writable-var-log
Use the real /var/log directory, not a clone. By default, a tmpfs is mounted on top of /var/log
directory, and a skeleton filesystem is created based on the original /var/log.
.br
.br
Example:
.br
$ sudo firejail --writable-var-log
.SH DESKTOP INTEGRATION
A symbolic link to /usr/bin/firejail under the name of a program, will start the program in Firejail sandbox.
The symbolic link should be placed in the first $PATH position. On most systems, a good place
is /usr/local/bin directory. Example:
.PP
.RS
.br
.br
Make a firefox symlink to /usr/bin/firejail:
.br
.br
$ ln -s /usr/bin/firejail /usr/local/bin/firefox
.br
.br
Verify $PATH
.br
.br
$ which -a firefox
.br
/usr/local/bin/firefox
.br
/usr/bin/firefox
.br
.br
Starting firefox in this moment, automatically invokes “firejail firefox”.
.RE
.br
.br
This works for clicking on desktop environment icons, menus etc. Use "firejail --tree"
to verify the program is sandboxed.
.PP
.RS
.br
.br
.br
$ firejail --tree
.br
1189:netblue:firejail firefox
.br
1190:netblue:firejail firefox
.br
1220:netblue:/bin/sh -c "/usr/lib/firefox/firefox"
.br
1221:netblue:/usr/lib/firefox/firefox
.RE
We provide a tool that automates all this integration, please see \fBman 1 firecfg\fR for more details.
.SH FILE GLOBBING
.TP
Globbing is the operation that expands a wildcard pattern into the list of pathnames matching the pattern. Matching is defined by:
.br
.br
- '?' matches any character
.br
- '*' matches any string
.br
- '[' denotes a range of characters
.br
.TP
The gobing feature is implemented using glibc glob command. For more information on the wildcard syntax see man 7 glob.
.br
.br
.TP
The following command line options are supported: \-\-blacklist, \-\-private-bin, \-\-noexec, \-\-read-only, \-\-read-write, and \-\-tmpfs.
.br
.br
.TP
Examples:
.br
.br
$ firejail --private-bin=sh,bash,python*
.br
$ firejail --blacklist=~/dir[1234]
.br
$ firejail --read-only=~/dir[1-4]
.br
.SH APPARMOR
.TP
AppArmor support is disabled by default at compile time. Use --enable-apparmor configuration option to enable it:
.br
.br
$ ./configure --prefix=/usr --enable-apparmor
.TP
During software install, a generic AppArmor profile file, firejail-default, is placed in /etc/apparmor.d directory. The local customizations can be placed in /etc/apparmor.d/local/firejail-local. The profile needs to be loaded into the kernel by reloading apparmor.service, rebooting the system or running the following command as root:
.br
.br
# apparmor_parser -r /etc/apparmor.d/firejail-default
.TP
The installed profile is supplemental for main firejail functions and among other things does the following:
.br
.br
- Disable ptrace. With ptrace it is possible to inspect and hijack running programs. Usually this is needed only for debugging. You should have no problems running Chromium or Firefox. This feature is available only on Ubuntu kernels.
.br
.br
- Whitelist write access to several files under /run, /proc and /sys.
.br
.br
- Allow running programs only from well-known system paths, such as /bin, /sbin, /usr/bin etc. Those paths are available as read-only. Running programs and scripts from user home or other directories writable by the user is not allowed.
.br
.br
- Prevent using non-standard network sockets. Only unix, inet, inet6, netlink, raw and packet are allowed.
.br
.br
- Deny access to known sensitive paths like .snapshots.
.TP
To enable AppArmor confinement on top of your current Firejail security features, pass \fB\-\-apparmor\fR flag to Firejail command line. You can also include \fBapparmor\fR command in a Firejail profile file. Example:
.br
.br
$ firejail --apparmor firefox
.SH TRAFFIC SHAPING
Network bandwidth is an expensive resource shared among all sandboxes running on a system.
Traffic shaping allows the user to increase network performance by controlling
the amount of data that flows into and out of the sandboxes.
Firejail implements a simple rate-limiting shaper based on Linux command tc.
The shaper works at sandbox level, and can be used only for sandboxes configured with new network namespaces.
Set rate-limits:
$ firejail --bandwidth=name|pid set network download upload
Clear rate-limits:
$ firejail --bandwidth=name|pid clear network
Status:
$ firejail --bandwidth=name|pid status
where:
.br
name - sandbox name
.br
pid - sandbox pid
.br
network - network interface as used by \-\-net option
.br
download - download speed in KB/s (kilobyte per second)
.br
upload - upload speed in KB/s (kilobyte per second)
Example:
.br
$ firejail \-\-name=mybrowser \-\-net=eth0 firefox &
.br
$ firejail \-\-bandwidth=mybrowser set eth0 80 20
.br
$ firejail \-\-bandwidth=mybrowser status
.br
$ firejail \-\-bandwidth=mybrowser clear eth0
.SH MONITORING
Option \-\-list prints a list of all sandboxes. The format
for each process entry is as follows:
PID:USER:Sandbox Name:Command
Option \-\-tree prints the tree of processes running in the sandbox. The format
for each process entry is as follows:
PID:USER:Sandbox Name:Command
Option \-\-top is similar to the UNIX top command, however it applies only to
sandboxes.
Option \-\-netstats prints network statistics for active sandboxes installing new network namespaces.
Listed below are the available fields (columns) in alphabetical
order for \-\-top and \-\-netstat options:
.TP
Command
Command used to start the sandbox.
.TP
CPU%
CPU usage, the sandbox share of the elapsed CPU time since the
last screen update
.TP
PID
Unique process ID for the task controlling the sandbox.
.TP
Prcs
Number of processes running in sandbox, including the controlling process.
.TP
RES
Resident Memory Size (KiB), sandbox non-swapped physical memory.
It is a sum of the RES values for all processes running in the sandbox.
.TP
RX(KB/s)
Network receive speed.
.TP
Sandbox Name
The name of the sandbox, if any.
.TP
SHR
Shared Memory Size (KiB), it reflects memory shared with other
processes. It is a sum of the SHR values for all processes running
in the sandbox, including the controlling process.
.TP
TX(KB/s)
Network transmit speed.
.TP
Uptime
Sandbox running time in hours:minutes:seconds format.
.TP
USER
The owner of the sandbox.
.SH SECURITY PROFILES
Several command line options can be passed to the program using
profile files. Firejail chooses the profile file as follows:
1. If a profile file is provided by the user with --profile option, the profile file is loaded.
Example:
.PP
.RS
$ firejail --profile=/home/netblue/icecat.profile icecat
.br
Reading profile /home/netblue/icecat.profile
.br
[...]
.RE
2. If a profile file with the same name as the application is present in ~/.config/firejail directory or
in /etc/firejail, the profile is loaded. ~/.config/firejail takes precedence over /etc/firejail. Example:
.PP
.RS
$ firejail icecat
.br
Command name #icecat#
.br
Found icecat profile in /home/netblue/.config/firejail directory
.br
Reading profile /home/netblue/.config/firejail/icecat.profile
.br
[...]
.RE
3. Use default.profile file if the sandbox
is started by a regular user, or server.profile file if the sandbox
is started by root. Firejail looks for these files in ~/.config/firejail directory, followed by /etc/firejail directory.
To disable default profile loading, use --noprofile command option. Example:
.PP
.RS
$ firejail
.br
Reading profile /etc/firejail/default.profile
.br
Parent pid 8553, child pid 8554
.br
Child process initialized
.br
[...]
.br
.br
$ firejail \-\-noprofile
.br
Parent pid 8553, child pid 8554
.br
Child process initialized
.br
[...]
.RE
See \fBman 5 firejail-profile\fR for profile file syntax information.
.SH RESTRICTED SHELL
To configure a restricted shell, replace /bin/bash with /usr/bin/firejail in
/etc/passwd file for each user that needs to be restricted. Alternatively,
you can specify /usr/bin/firejail in adduser command:
adduser \-\-shell /usr/bin/firejail username
Additional arguments passed to firejail executable upon login are declared in /etc/firejail/login.users file.
.SH EXAMPLES
.TP
\f\firejail
Sandbox a regular /bin/bash session.
.TP
\f\firejail firefox
Start Mozilla Firefox.
.TP
\f\firejail \-\-debug firefox
Debug Firefox sandbox.
.TP
\f\firejail \-\-private firefox
Start Firefox with a new, empty home directory.
.TP
\f\firejail --net=none vlc
Start VLC in an unconnected network namespace.
.TP
\f\firejail \-\-net=eth0 firefox
Start Firefox in a new network namespace. An IP address is
assigned automatically.
.TP
\f\firejail \-\-net=br0 \-\-ip=10.10.20.5 \-\-net=br1 \-\-net=br2
Start a /bin/bash session in a new network namespace and connect it
to br0, br1, and br2 host bridge devices. IP addresses are assigned
automatically for the interfaces connected to br1 and b2
.TP
\f\firejail \-\-list
List all sandboxed processes.
.SH LICENSE
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
.PP
Homepage: https://firejail.wordpress.com
.SH SEE ALSO
\&\flfiremon\fR\|(1),
\&\flfirecfg\fR\|(1),
\&\flfirejail-profile\fR\|(5),
\&\flfirejail-users\fR\|(5)
|