1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY bubblewrap-download-http "https://github.com/containers/bubblewrap/releases/download/v&bubblewrap-version;/bubblewrap-&bubblewrap-version;.tar.xz">
|
---|
8 | <!ENTITY bubblewrap-download-ftp " ">
|
---|
9 | <!ENTITY bubblewrap-md5sum "85f144f6c2c28c112abbcf98bedf6137">
|
---|
10 | <!ENTITY bubblewrap-size "120 KB">
|
---|
11 | <!ENTITY bubblewrap-buildsize "3.3 MB (with tests)">
|
---|
12 | <!ENTITY bubblewrap-time "less than 0.1 SBU (with tests)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="bubblewrap" xreflabel="bubblewrap-&bubblewrap-version;">
|
---|
16 | <?dbhtml filename="bubblewrap.html"?>
|
---|
17 |
|
---|
18 |
|
---|
19 | <title>Bubblewrap-&bubblewrap-version;</title>
|
---|
20 |
|
---|
21 | <indexterm zone="bubblewrap">
|
---|
22 | <primary sortas="a-bubblewrap">bubblewrap</primary>
|
---|
23 | </indexterm>
|
---|
24 |
|
---|
25 | <sect2 role="package">
|
---|
26 | <title>Introduction to Bubblewrap</title>
|
---|
27 |
|
---|
28 | <para>
|
---|
29 | <application>Bubblewrap</application> is a setuid implementation of user
|
---|
30 | namespaces, or sandboxing, that provides access to a subset of kernel
|
---|
31 | user namespace features. Bubblewrap allows user owned processes to run in
|
---|
32 | an isolated environment with limited access to the underlying filesystem.
|
---|
33 | <!-- Thanks for the reword DJ -->
|
---|
34 | </para>
|
---|
35 |
|
---|
36 | &lfs122_checked;
|
---|
37 |
|
---|
38 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
39 | <itemizedlist spacing="compact">
|
---|
40 | <listitem>
|
---|
41 | <para>
|
---|
42 | Download (HTTP): <ulink url="&bubblewrap-download-http;"/>
|
---|
43 | </para>
|
---|
44 | </listitem>
|
---|
45 | <listitem>
|
---|
46 | <para>
|
---|
47 | Download (FTP): <ulink url="&bubblewrap-download-ftp;"/>
|
---|
48 | </para>
|
---|
49 | </listitem>
|
---|
50 | <listitem>
|
---|
51 | <para>
|
---|
52 | Download MD5 sum: &bubblewrap-md5sum;
|
---|
53 | </para>
|
---|
54 | </listitem>
|
---|
55 | <listitem>
|
---|
56 | <para>
|
---|
57 | Download size: &bubblewrap-size;
|
---|
58 | </para>
|
---|
59 | </listitem>
|
---|
60 | <listitem>
|
---|
61 | <para>
|
---|
62 | Estimated disk space required: &bubblewrap-buildsize;
|
---|
63 | </para>
|
---|
64 | </listitem>
|
---|
65 | <listitem>
|
---|
66 | <para>
|
---|
67 | Estimated build time: &bubblewrap-time;
|
---|
68 | </para>
|
---|
69 | </listitem>
|
---|
70 | </itemizedlist>
|
---|
71 |
|
---|
72 | <bridgehead renderas="sect3">Bubblewrap Dependencies</bridgehead>
|
---|
73 |
|
---|
74 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
75 | <para role="optional">
|
---|
76 | <xref linkend="libxslt"/> (to generate manual pages),
|
---|
77 | <xref linkend="libseccomp"/> (built with python bindings, for tests),
|
---|
78 | <ulink url="https://github.com/scop/bash-completion">bash-completion</ulink>, and
|
---|
79 | <ulink url="https://github.com/SELinuxProject/selinux">SELinux</ulink>
|
---|
80 | </para>
|
---|
81 |
|
---|
82 | </sect2>
|
---|
83 |
|
---|
84 | <sect2 role="kernel" id="bubblewrap-kernel">
|
---|
85 | <title>Kernel Configuration</title>
|
---|
86 |
|
---|
87 | <para>
|
---|
88 | When this package began, upstream expected it could be installed
|
---|
89 | suid-root. That was a long time ago, suid-root is generally considered
|
---|
90 | a bad idea. As well as the default namespaces, this package requires the
|
---|
91 | optional User namespace to be enabled. If that has not yet been enabled,
|
---|
92 | select the following option in the kernel configuration and recompile the
|
---|
93 | kernel:
|
---|
94 | </para>
|
---|
95 |
|
---|
96 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
97 | href="bubblewrap-kernel.xml"/>
|
---|
98 |
|
---|
99 | <indexterm zone="bubblewrap bubblewrap-kernel">
|
---|
100 | <primary sortas="d-bubblewrap">bubblewrap</primary>
|
---|
101 | </indexterm>
|
---|
102 | </sect2>
|
---|
103 |
|
---|
104 | <sect2 role="installation">
|
---|
105 | <title>Installation of Bubblewrap</title>
|
---|
106 |
|
---|
107 | <para>
|
---|
108 | Install <application>Bubblewrap</application> by running the following
|
---|
109 | commands:
|
---|
110 | </para>
|
---|
111 |
|
---|
112 | <screen><userinput>mkdir build &&
|
---|
113 | cd build &&
|
---|
114 |
|
---|
115 | meson setup --prefix=/usr --buildtype=release .. &&
|
---|
116 | ninja</userinput></screen>
|
---|
117 |
|
---|
118 | <para>
|
---|
119 | Next, if you desire to run the test suite, fix an issue caused by the
|
---|
120 | merged-/usr configuration in LFS:
|
---|
121 | </para>
|
---|
122 |
|
---|
123 | <screen remap="test"><userinput>sed 's@symlink usr/lib64@ro-bind-try /lib64@' -i ../tests/libtest.sh</userinput></screen>
|
---|
124 |
|
---|
125 | <para>
|
---|
126 | To test the results, issue (as a user other than the
|
---|
127 | <systemitem class="username">root</systemitem> user):
|
---|
128 | <command>ninja test</command>
|
---|
129 | </para>
|
---|
130 |
|
---|
131 | <para>
|
---|
132 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
133 | </para>
|
---|
134 |
|
---|
135 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
136 | </sect2>
|
---|
137 |
|
---|
138 | <sect2 role="commands">
|
---|
139 | <title>Command Explanations</title>
|
---|
140 |
|
---|
141 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
142 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
143 | </sect2>
|
---|
144 |
|
---|
145 | <sect2 role="content">
|
---|
146 | <title>Contents</title>
|
---|
147 |
|
---|
148 | <segmentedlist>
|
---|
149 | <segtitle>Installed Program</segtitle>
|
---|
150 | <segtitle>Installed Libraries</segtitle>
|
---|
151 | <segtitle>Installed Directories</segtitle>
|
---|
152 |
|
---|
153 | <seglistitem>
|
---|
154 | <seg>
|
---|
155 | bwrap
|
---|
156 | </seg>
|
---|
157 | <seg>
|
---|
158 | None
|
---|
159 | </seg>
|
---|
160 | <seg>
|
---|
161 | None
|
---|
162 | </seg>
|
---|
163 | </seglistitem>
|
---|
164 | </segmentedlist>
|
---|
165 |
|
---|
166 | <variablelist>
|
---|
167 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
168 | <?dbfo list-presentation="list"?>
|
---|
169 | <?dbhtml list-presentation="table"?>
|
---|
170 |
|
---|
171 | <varlistentry id="bwrap">
|
---|
172 | <term><command>bwrap</command></term>
|
---|
173 | <listitem>
|
---|
174 | <para>
|
---|
175 | generates a sandbox for a program to run in
|
---|
176 | </para>
|
---|
177 | <indexterm zone="bubblewrap bwrap">
|
---|
178 | <primary sortas="b-bwrap">bwrap</primary>
|
---|
179 | </indexterm>
|
---|
180 | </listitem>
|
---|
181 | </varlistentry>
|
---|
182 | </variablelist>
|
---|
183 | </sect2>
|
---|
184 |
|
---|
185 | </sect1>
|
---|