aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorLibravatar smitsohu <smitsohu@gmail.com>2019-10-04 22:52:55 +0200
committerLibravatar smitsohu <smitsohu@gmail.com>2019-10-04 22:52:55 +0200
commitc3355cb04b830948477b4d9368ca3d7ee5630a82 (patch)
tree3b92d8bbb08c9ca2b94cfb395287c9a937659e54 /src
parentfix concurrent writing to trace file (diff)
downloadfirejail-c3355cb04b830948477b4d9368ca3d7ee5630a82.tar.gz
firejail-c3355cb04b830948477b4d9368ca3d7ee5630a82.tar.zst
firejail-c3355cb04b830948477b4d9368ca3d7ee5630a82.zip
alphabetize man page entries
Diffstat (limited to 'src')
-rw-r--r--src/man/firejail-profile.txt171
-rw-r--r--src/man/firejail.txt121
2 files changed, 146 insertions, 146 deletions
diff --git a/src/man/firejail-profile.txt b/src/man/firejail-profile.txt
index 3db8c782d..82ca103c9 100644
--- a/src/man/firejail-profile.txt
+++ b/src/man/firejail-profile.txt
@@ -202,6 +202,9 @@ Mount-bind file1 on top of file2. This option is only available when running as
202\fBdisable-mnt 202\fBdisable-mnt
203Disable /mnt, /media, /run/mount and /run/media access. 203Disable /mnt, /media, /run/mount and /run/media access.
204.TP 204.TP
205\fBkeep-dev-shm
206/dev/shm directory is untouched (even with private-dev).
207.TP
205\fBkeep-var-tmp 208\fBkeep-var-tmp
206/var/tmp directory is untouched. 209/var/tmp directory is untouched.
207.TP 210.TP
@@ -253,33 +256,37 @@ closed.
253\fBprivate directory 256\fBprivate directory
254Use directory as user home. 257Use directory as user home.
255.TP 258.TP
256\fBprivate-home file,directory 259\fBprivate-bin file,file
257Build a new user home in a temporary 260Build a new /bin in a temporary filesystem, and copy the programs in the list.
258filesystem, and copy the files and directories in the list in the 261The same directory is also bind-mounted over /sbin, /usr/bin and /usr/sbin.
259new home. All modifications are discarded when the sandbox is
260closed.
261.TP 262.TP
262\fBprivate-cache 263\fBprivate-cache
263Mount an empty temporary filesystem on top of the .cache directory in user home. All 264Mount an empty temporary filesystem on top of the .cache directory in user home. All
264modifications are discarded when the sandbox is closed. 265modifications are discarded when the sandbox is closed.
265.TP 266.TP
266\fBprivate-bin file,file 267\fBprivate-cwd
267Build a new /bin in a temporary filesystem, and copy the programs in the list. 268Set working directory inside jail to the home directory, and failing that, the root directory.
268The same directory is also bind-mounted over /sbin, /usr/bin and /usr/sbin. 269.TP
270\fBprivate-cwd directory
271Set working directory inside the jail.
269.TP 272.TP
270\fBprivate-dev 273\fBprivate-dev
271Create a new /dev directory. Only disc, dri, dvb, hidraw, null, full, zero, tty, pts, ptmx, 274Create a new /dev directory. Only disc, dri, dvb, hidraw, null, full, zero, tty, pts, ptmx,
272random, snd, urandom, video, log, shm and usb devices are available. 275random, snd, urandom, video, log, shm and usb devices are available.
273Use the options no3d, nodvd, nosound, notv, nou2f and novideo for additional restrictions. 276Use the options no3d, nodvd, nosound, notv, nou2f and novideo for additional restrictions.
274.TP 277
275\fBkeep-dev-shm
276/dev/shm directory is untouched (even with private-dev).
277.TP 278.TP
278\fBprivate-etc file,directory 279\fBprivate-etc file,directory
279Build a new /etc in a temporary 280Build a new /etc in a temporary
280filesystem, and copy the files and directories in the list. 281filesystem, and copy the files and directories in the list.
281All modifications are discarded when the sandbox is closed. 282All modifications are discarded when the sandbox is closed.
282.TP 283.TP
284\fBprivate-home file,directory
285Build a new user home in a temporary
286filesystem, and copy the files and directories in the list in the
287new home. All modifications are discarded when the sandbox is
288closed.
289.TP
283\fBprivate-lib file,directory 290\fBprivate-lib file,directory
284Build a new /lib directory and bring in the libraries required by the application to run. 291Build a new /lib directory and bring in the libraries required by the application to run.
285This feature is still under development, see \fBman 1 firejail\fR for some examples. 292This feature is still under development, see \fBman 1 firejail\fR for some examples.
@@ -297,12 +304,6 @@ All modifications are discarded when the sandbox is closed.
297\fBprivate-tmp 304\fBprivate-tmp
298Mount an empty temporary filesystem on top of /tmp directory whitelisting /tmp/.X11-unix. 305Mount an empty temporary filesystem on top of /tmp directory whitelisting /tmp/.X11-unix.
299.TP 306.TP
300\fBprivate-cwd
301Set working directory inside jail to the home directory, and failing that, the root directory.
302.TP
303\fBprivate-cwd directory
304Set working directory inside the jail.
305.TP
306\fBread-only file_or_directory 307\fBread-only file_or_directory
307Make directory or file read-only. 308Make directory or file read-only.
308.TP 309.TP
@@ -352,15 +353,30 @@ Enable AppArmor confinement.
352\fBcaps 353\fBcaps
353Enable default Linux capabilities filter. 354Enable default Linux capabilities filter.
354.TP 355.TP
355\fBcaps.drop all
356Blacklist all Linux capabilities.
357.TP
358\fBcaps.drop capability,capability,capability 356\fBcaps.drop capability,capability,capability
359Blacklist given Linux capabilities. 357Blacklist given Linux capabilities.
360.TP 358.TP
359\fBcaps.drop all
360Blacklist all Linux capabilities.
361.TP
361\fBcaps.keep capability,capability,capability 362\fBcaps.keep capability,capability,capability
362Whitelist given Linux capabilities. 363Whitelist given Linux capabilities.
363.TP 364.TP
365\fBmemory-deny-write-execute
366Install a seccomp filter to block attempts to create memory mappings
367that are both writable and executable, to change mappings to be
368executable or to create executable shared memory.
369.TP
370\fBnonewprivs
371Sets the NO_NEW_PRIVS prctl. This ensures that child processes
372cannot acquire new privileges using execve(2); in particular,
373this means that calling a suid binary (or one with file capabilities)
374does not result in an increase of privilege.
375.TP
376\fBnoroot
377Use this command to enable an user namespace. The namespace has only one user, the current user.
378There is no root account (uid 0) defined in the namespace.
379.TP
364\fBprotocol protocol1,protocol2,protocol3 380\fBprotocol protocol1,protocol2,protocol3
365Enable protocol filter. The filter is based on seccomp and checks the 381Enable protocol filter. The filter is based on seccomp and checks the
366first argument to socket system call. Recognized values: \fBunix\fR, 382first argument to socket system call. Recognized values: \fBunix\fR,
@@ -382,21 +398,6 @@ Enable seccomp filter and blacklist the system calls in the list.
382\fBseccomp.keep syscall,syscall,syscall 398\fBseccomp.keep syscall,syscall,syscall
383Enable seccomp filter and whitelist the system calls in the list. 399Enable seccomp filter and whitelist the system calls in the list.
384.TP 400.TP
385\fBmemory-deny-write-execute
386Install a seccomp filter to block attempts to create memory mappings
387that are both writable and executable, to change mappings to be
388executable or to create executable shared memory.
389.TP
390\fBnonewprivs
391Sets the NO_NEW_PRIVS prctl. This ensures that child processes
392cannot acquire new privileges using execve(2); in particular,
393this means that calling a suid binary (or one with file capabilities)
394does not result in an increase of privilege.
395.TP
396\fBnoroot
397Use this command to enable an user namespace. The namespace has only one user, the current user.
398There is no root account (uid 0) defined in the namespace.
399.TP
400\fBx11 401\fBx11
401Enable X11 sandboxing. 402Enable X11 sandboxing.
402.TP 403.TP
@@ -441,6 +442,15 @@ place the sandbox in an existing control group.
441Examples: 442Examples:
442 443
443.TP 444.TP
445\fBcgroup /sys/fs/cgroup/g1/tasks
446The sandbox is placed in g1 control group.
447.TP
448\fBcpu 0,1,2
449Use only CPU cores 0, 1 and 2.
450.TP
451\fBnice -5
452Set a nice value of -5 to all processes running inside the sandbox.
453.TP
444\fBrlimit-as 123456789012 454\fBrlimit-as 123456789012
445Set the maximum size of the process's virtual memory to 123456789012 bytes. 455Set the maximum size of the process's virtual memory to 123456789012 bytes.
446.TP 456.TP
@@ -459,15 +469,6 @@ Set the maximum number of files that can be opened by a process to 500.
459\fBrlimit-sigpending 200 469\fBrlimit-sigpending 200
460Set the maximum number of processes that can be created for the real user ID of the calling process to 200. 470Set the maximum number of processes that can be created for the real user ID of the calling process to 200.
461.TP 471.TP
462\fBcpu 0,1,2
463Use only CPU cores 0, 1 and 2.
464.TP
465\fBnice -5
466Set a nice value of -5 to all processes running inside the sandbox.
467.TP
468\fBcgroup /sys/fs/cgroup/g1/tasks
469The sandbox is placed in g1 control group.
470.TP
471\fBtimeout hh:mm:ss 472\fBtimeout hh:mm:ss
472Kill the sandbox automatically after the time has elapsed. The time is specified in hours/minutes/seconds format. 473Kill the sandbox automatically after the time has elapsed. The time is specified in hours/minutes/seconds format.
473 474
@@ -477,14 +478,6 @@ Kill the sandbox automatically after the time has elapsed. The time is specified
477All user home directories are visible inside the sandbox. By default, only current user home directory is visible. 478All user home directories are visible inside the sandbox. By default, only current user home directory is visible.
478 479
479.TP 480.TP
480\fBname sandboxname
481Set sandbox name. Example:
482.br
483
484.br
485name browser
486
487.TP
488\fBenv name=value 481\fBenv name=value
489Set environment variable. Examples: 482Set environment variable. Examples:
490.br 483.br
@@ -495,17 +488,23 @@ env LD_LIBRARY_PATH=/opt/test/lib
495env CFLAGS="-W -Wall -Werror" 488env CFLAGS="-W -Wall -Werror"
496 489
497.TP 490.TP
498\fBnodvd 491\fBipc-namespace
499Disable DVD and audio CD devices. 492Enable IPC namespace.
500.TP 493.TP
501\fBnogroups 494\fBname sandboxname
502Disable supplementary user groups 495Set sandbox name. Example:
496.br
497
498.br
499name browser
500
503.TP 501.TP
504\fBshell none 502\fBno3d
505Run the program directly, without a shell. 503Disable 3D hardware acceleration.
506.TP 504.TP
507\fBipc-namespace 505\fBnoautopulse
508Enable IPC namespace. 506Disable automatic ~/.config/pulse init, for complex setups such as remote
507pulse servers or non-standard socket paths.
509.TP 508.TP
510\fBnodbus 509\fBnodbus
511Disable D-Bus access. Only the regular UNIX socket is handled by 510Disable D-Bus access. Only the regular UNIX socket is handled by
@@ -513,13 +512,15 @@ this command. To disable the abstract socket, you would need to
513request a new network namespace using the net command. Another 512request a new network namespace using the net command. Another
514option is to remove unix from protocol set. 513option is to remove unix from protocol set.
515.TP 514.TP
515\fBnodvd
516Disable DVD and audio CD devices.
517.TP
518\fBnogroups
519Disable supplementary user groups
520.TP
516\fBnosound 521\fBnosound
517Disable sound system. 522Disable sound system.
518.TP 523.TP
519\fBnoautopulse
520Disable automatic ~/.config/pulse init, for complex setups such as remote
521pulse servers or non-standard socket paths.
522.TP
523\fBnotv 524\fBnotv
524Disable DVB (Digital Video Broadcasting) TV devices. 525Disable DVB (Digital Video Broadcasting) TV devices.
525.TP 526.TP
@@ -529,8 +530,9 @@ Disable U2F devices.
529\fBnovideo 530\fBnovideo
530Disable video devices. 531Disable video devices.
531.TP 532.TP
532\fBno3d 533\fBshell none
533Disable 3D hardware acceleration. 534Run the program directly, without a shell.
535
534 536
535.SH Networking 537.SH Networking
536Networking features available in profile files. 538Networking features available in profile files.
@@ -618,16 +620,6 @@ Spoof id number in /etc/machine-id file - a new random id is generated inside th
618\fBmtu number 620\fBmtu number
619Assign a MTU value to the last network interface defined by a net command. 621Assign a MTU value to the last network interface defined by a net command.
620 622
621
622
623.TP
624\fBnetfilter
625If a new network namespace is created, enabled default network filter.
626
627.TP
628\fBnetfilter filename
629If a new network namespace is created, enabled the network filter in filename.
630
631.TP 623.TP
632\fBnet bridge_interface 624\fBnet bridge_interface
633Enable a new network namespace and connect it to this bridge interface. 625Enable a new network namespace and connect it to this bridge interface.
@@ -648,6 +640,13 @@ default gateway of the host. Up to four \-\-net devices can
648be defined. Mixing bridge and macvlan devices is allowed. 640be defined. Mixing bridge and macvlan devices is allowed.
649 641
650.TP 642.TP
643\fBnet none
644Enable a new, unconnected network namespace. The only interface
645available in the new namespace is a new loopback interface (lo).
646Use this option to deny network access to programs that don't
647really need network access.
648
649.TP
651\fBnet tap_interface 650\fBnet tap_interface
652Enable a new network namespace and connect it 651Enable a new network namespace and connect it
653to this ethernet tap interface using the standard Linux macvlan 652to this ethernet tap interface using the standard Linux macvlan
@@ -656,11 +655,13 @@ will not try to configure the interface inside the sandbox.
656Please use ip, netmask and defaultgw to specify the configuration. 655Please use ip, netmask and defaultgw to specify the configuration.
657 656
658.TP 657.TP
659\fBnet none 658\fBnetfilter
660Enable a new, unconnected network namespace. The only interface 659If a new network namespace is created, enabled default network filter.
661available in the new namespace is a new loopback interface (lo). 660
662Use this option to deny network access to programs that don't 661.TP
663really need network access. 662\fBnetfilter filename
663If a new network namespace is created, enabled the network filter in filename.
664
664 665
665.TP 666.TP
666\fBnetmask address 667\fBnetmask address
@@ -675,14 +676,14 @@ instead of the default one.
675 676
676.SH Other 677.SH Other
677.TP 678.TP
679\fBdeterministic-exit-code
680Always exit firejail with the first child's exit status. The default behavior is to use the exit status of the final child to exit, which can be nondeterministic.
681
682.TP
678\fBjoin-or-start sandboxname 683\fBjoin-or-start sandboxname
679Join the sandbox identified by name or start a new one. 684Join the sandbox identified by name or start a new one.
680Same as "firejail --join=sandboxname" command if sandbox with specified name exists, otherwise same as "name sandboxname". 685Same as "firejail --join=sandboxname" command if sandbox with specified name exists, otherwise same as "name sandboxname".
681 686
682.TP
683\fBdeterministic-exit-code
684Always exit firejail with the first child's exit status. The default behavior is to use the exit status of the final child to exit, which can be nondeterministic.
685
686.SH FILES 687.SH FILES
687/etc/firejail/filename.profile, $HOME/.config/firejail/filename.profile 688/etc/firejail/filename.profile, $HOME/.config/firejail/filename.profile
688 689
diff --git a/src/man/firejail.txt b/src/man/firejail.txt
index 38bc0edc4..cabc4f619 100644
--- a/src/man/firejail.txt
+++ b/src/man/firejail.txt
@@ -828,24 +828,6 @@ $ sudo ifconfig br1 10.10.30.1/24
828$ firejail \-\-net=br0 \-\-net=br1 828$ firejail \-\-net=br0 \-\-net=br1
829 829
830.TP 830.TP
831\fB\-\-net=none
832Enable a new, unconnected network namespace. The only interface
833available in the new namespace is a new loopback interface (lo).
834Use this option to deny
835network access to programs that don't really need network access.
836.br
837
838.br
839Example:
840.br
841$ firejail \-\-net=none vlc
842.br
843
844.br
845Note: \-\-net=none can crash the application on some platforms.
846In these cases, it can be replaced with \-\-protocol=unix.
847
848.TP
849\fB\-\-net=ethernet_interface|wireless_interface 831\fB\-\-net=ethernet_interface|wireless_interface
850Enable a new network namespace and connect it 832Enable a new network namespace and connect it
851to this ethernet interface using the standard Linux macvlan|ipvaln 833to this ethernet interface using the standard Linux macvlan|ipvaln
@@ -865,6 +847,24 @@ $ firejail \-\-net=eth0 \-\-ip=192.168.1.80 \-\-dns=8.8.8.8 firefox
865$ firejail \-\-net=wlan0 firefox 847$ firejail \-\-net=wlan0 firefox
866 848
867.TP 849.TP
850\fB\-\-net=none
851Enable a new, unconnected network namespace. The only interface
852available in the new namespace is a new loopback interface (lo).
853Use this option to deny
854network access to programs that don't really need network access.
855.br
856
857.br
858Example:
859.br
860$ firejail \-\-net=none vlc
861.br
862
863.br
864Note: \-\-net=none can crash the application on some platforms.
865In these cases, it can be replaced with \-\-protocol=unix.
866
867.TP
868\fB\-\-net=tap_interface 868\fB\-\-net=tap_interface
869Enable a new network namespace and connect it 869Enable a new network namespace and connect it
870to this ethernet tap interface using the standard Linux macvlan 870to this ethernet tap interface using the standard Linux macvlan
@@ -1434,6 +1434,48 @@ Example:
1434$ firejail \-\-private-cache openbox 1434$ firejail \-\-private-cache openbox
1435 1435
1436.TP 1436.TP
1437\fB\-\-private-cwd
1438Set working directory inside jail to the home directory, and failing that, the root directory.
1439.br
1440Does not impact working directory of profile include paths.
1441.br
1442
1443.br
1444Example:
1445.br
1446$ pwd
1447.br
1448/tmp
1449.br
1450$ firejail \-\-private-cwd
1451.br
1452$ pwd
1453.br
1454/home/user
1455.br
1456
1457.TP
1458\fB\-\-private-cwd=directory
1459Set working directory inside the jail.
1460.br
1461Does not impact working directory of profile include paths.
1462.br
1463
1464.br
1465Example:
1466.br
1467$ pwd
1468.br
1469/tmp
1470.br
1471$ firejail \-\-private-cwd=/opt
1472.br
1473$ pwd
1474.br
1475/opt
1476.br
1477
1478.TP
1437\fB\-\-private-dev 1479\fB\-\-private-dev
1438Create a new /dev directory. Only disc, dri, dvb, hidraw, null, full, zero, tty, pts, ptmx, random, snd, urandom, video, log, shm and usb devices are available. 1480Create a new /dev directory. Only disc, dri, dvb, hidraw, null, full, zero, tty, pts, ptmx, random, snd, urandom, video, log, shm and usb devices are available.
1439Use the options --no3d, --nodvd, --nosound, --notv, --nou2f and --novideo for additional restrictions. 1481Use the options --no3d, --nodvd, --nosound, --notv, --nou2f and --novideo for additional restrictions.
@@ -1579,49 +1621,6 @@ drwxrwxrwt 2 nobody nogroup 4096 Apr 30 10:52 .X11-unix
1579.br 1621.br
1580 1622
1581.TP 1623.TP
1582\fB\-\-private-cwd
1583Set working directory inside jail to the home directory, and failing that, the root directory.
1584.br
1585Does not impact working directory of profile include paths.
1586.br
1587
1588.br
1589Example:
1590.br
1591$ pwd
1592.br
1593/tmp
1594.br
1595$ firejail \-\-private-cwd
1596.br
1597$ pwd
1598.br
1599/home/user
1600.br
1601
1602.TP
1603\fB\-\-private-cwd=directory
1604Set working directory inside the jail.
1605.br
1606Does not impact working directory of profile include paths.
1607.br
1608
1609.br
1610Example:
1611.br
1612$ pwd
1613.br
1614/tmp
1615.br
1616$ firejail \-\-private-cwd=/opt
1617.br
1618$ pwd
1619.br
1620/opt
1621.br
1622
1623
1624.TP
1625\fB\-\-profile=filename_or_profilename 1624\fB\-\-profile=filename_or_profilename
1626Load a custom security profile from filename. For filename use an absolute path or a path relative to the current path. 1625Load a custom security profile from filename. For filename use an absolute path or a path relative to the current path.
1627For more information, see \fBSECURITY PROFILES\fR section below. 1626For more information, see \fBSECURITY PROFILES\fR section below.