Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: man: Note that some commands can be disabled in firejail.config #5366

Merged
merged 7 commits into from
Sep 14, 2022

Conversation

glitsj16
Copy link
Collaborator

No description provided.

Copy link
Collaborator

@rusty-snake rusty-snake left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM


IMHO we can expand the firejail.config docu in the manpage even more.

  • There's no central firejail.config section where it is explaind, what it does, where it is, ... just random notes like "can be configured in firejail.config".
  • We could add a harden firejail with firejail.config by setting ...
  • We could add notes about allow-tray, browser-allow-drm, ...
  • We could add a note about restricted-network being yes on Debian.
  • ...

src/man/firejail.txt Outdated Show resolved Hide resolved
@kmk3 kmk3 added the documentation Issues and pull requests related to the documentation label Sep 13, 2022
@reinerh
Copy link
Collaborator

reinerh commented Sep 14, 2022

What about the firejail-profile manpage? Should this also get mentioned there, or is it sufficient in the firejail manpage?

Copy link
Collaborator

@kmk3 kmk3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if this PR is intended to be comprehensive, but note that there
are many more options in firejail.config that might affect existing commands.

Examples, including the options that are already in this PR (and formatted as
"firejail.config option: commands"):

  • apparmor: --apparmor
  • bind: --bind
  • chroot: --chroot
  • dbus: --dbus-user, --dbus-system
  • disable-mnt: --disable-mnt
  • file-transfer: --ls, --get, --put, --cat (maybe note it only once in "FILE
    TRANSFER"?)
  • join: --join, --join-filesystem, --join-network, --join-or-start
  • name-change: --name (already on man page, but in a different format)
  • overlayfs: --overlay
  • private-bin: --private-bin
  • private-cache: --private-cache
  • private-etc: --private-etc
  • private-home: --private-home
  • private-lib: --private-lib
  • private-opt: --private-opt
  • private-srv: --private-srv
  • tracelog: --tracelog

There are also the following options, which I'm less sure about all the
commands that they might or might not affect:

  • network
  • restricted-network
  • seccomp
  • userns
  • x11

src/man/firejail.txt Outdated Show resolved Hide resolved
@glitsj16
Copy link
Collaborator Author

@reinerh

What about the firejail-profile manpage? Should this also get mentioned there, or is it sufficient in the firejail manpage?

Like @kmk3 hinted on, this PR was never meant to be comprehensive. For now I think it gets the most exposure by placing the notes in the firejail manpage.

src/man/firejail.txt Outdated Show resolved Hide resolved
@kmk3 kmk3 changed the title [man] Make it explicit that some options are disabled by default in firejail.config docs: man: Make it explicit that some options can be enabled/disabled in firejail.config Sep 14, 2022
@kmk3 kmk3 changed the title docs: man: Make it explicit that some options can be enabled/disabled in firejail.config docs: man: Note that some commands can be disabled in firejail.config Sep 14, 2022
src/man/firejail.txt Outdated Show resolved Hide resolved
Copy link
Collaborator

@kmk3 kmk3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@glitsj16 glitsj16 merged commit c7cf0dd into netblue30:master Sep 14, 2022
@glitsj16 glitsj16 deleted the man-fixes branch September 14, 2022 19:05
@rusty-snake
Copy link
Collaborator

FTR

disable-mnt: --disable-mnt

disable-mnt in firejail.config is an enforcment setting (like force-nonewprivs) and does not affect disable-mnt.

userns

maps to noroot. (#5304 (comment))

kmk3 added a commit to kmk3/firejail that referenced this pull request Sep 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues and pull requests related to the documentation
Projects
Status: Done (on RELNOTES)
Development

Successfully merging this pull request may close these issues.

4 participants