Skip to content

Commit

Permalink
document changes in bwrap.xml
Browse files Browse the repository at this point in the history
Signed-off-by: Mikhail Kulko <mkulko@mkulko.me>
  • Loading branch information
Mikhail Kulko committed Jun 17, 2023
1 parent 58fb6d3 commit 64ca7d1
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions bwrap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,10 @@
<term><option>--version</option></term>
<listitem><para>Print version</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--compat <arg choice="plain">compatability level</arg></option></term>
<listitem><para>Set compatability level (negative value means latest)</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--args <arg choice="plain">FD</arg></option></term>
<listitem><para>
Expand Down Expand Up @@ -145,6 +149,15 @@
<listitem><para>After setting up the new namespace, switch into the specified namespace. For this to work the specified namespace must be a descendant of the user namespace used for the setup, so this is only useful in combination with --userns.</para>
<para>This is useful because sometimes bubblewrap itself creates nested user namespaces (to work around some kernel issues) and --userns2 can be used to enter these.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--allow-userns</option></term>
<listitem><para>
Allow the process in the sandbox to create further user namespaces,
so that it can rearrange the filesystem namespace or do other more
complex namespace modification.
This option is only available in compatability level 1 or later.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--disable-userns</option></term>
<listitem><para>
Expand All @@ -157,6 +170,7 @@
in the outer namespace.
This option requires <option>--unshare-user</option>, and doesn't work
in the setuid version of bubblewrap.
This option is not available in compatability level 1 or later.
</para></listitem>
</varlistentry>
<varlistentry>
Expand Down Expand Up @@ -455,12 +469,29 @@
ignore members and objects that they do not understand.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-new-session</option></term>
<listitem><para>
Don't create a new terminal session for the sandbox (don't call
setsid()). This doesn't disconnect the sandbox from the controlling
terminal which means the sandbox can for instance inject input into
the terminal. This option is only available in compatability level 1
or later.
</para><para>
Note: In a general sandbox, if you use --no-new-session, it is
recommended to use seccomp to disallow the TIOCSTI ioctl, otherwise
the application can feed keyboard input to the terminal
which can e.g. lead to out-of-sandbox command execution
(see CVE-2017-5226).
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--new-session</option></term>
<listitem><para>
Create a new terminal session for the sandbox (calls setsid()). This
disconnects the sandbox from the controlling terminal which means
the sandbox can't for instance inject input into the terminal.
This option is not available in compatability level 1 or later.
</para><para>
Note: In a general sandbox, if you don't use --new-session, it is
recommended to use seccomp to disallow the TIOCSTI ioctl, otherwise
Expand Down

0 comments on commit 64ca7d1

Please sign in to comment.