summaryrefslogtreecommitdiff
path: root/src/chroot-tools/librechroot
blob: 1eba63c999b5d6c279b8eb4ff33911443f4113a4 (plain)
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
#!/usr/bin/env bash
set -euE
# librechroot

# Copyright (C) 2010-2012 Nicolás Reynolds <fauno@parabola.nu>
# Copyright (C) 2011-2012 Joshua Ismael Haase Hernández (xihh) <hahj87@gmail.com>
# Copyright (C) 2012 Michał Masłowski <mtjm@mtjm.eu>
# Copyright (C) 2012-2014 Luke Shumaker <lukeshu@sbcglobal.net>
#
# License: GNU GPLv2+
#
# This file is part of Parabola.
#
# Parabola 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.
#
# Parabola is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Parabola. If not, see <http://www.gnu.org/licenses/>.

# HACKING: if a command is added or removed, it must be changed in 4 places:
#   - the usage() text
#   - the commands=() array
#   - the case statement in main() that checks the number of arguments
#   - the case statement in main() that runs them

. "$(librelib conf)"
load_files chroot

. libremessages

shopt -s nullglob
umask 0022

readonly _arch_nspawn="$(librelib chroot/arch-nspawn)"
readonly _mkarchroot="$(librelib chroot/mkarchroot)"
readonly _makechrootpkg="$(librelib chroot/makechrootpkg.sh)"

# Because the makechrootpkg.sh library functions don't work with -euE
_makechrootpkg() (
	set +euE
	. "$_makechrootpkg"
	"$@"
)

# Usage: make_empty_repo $copydir
make_empty_repo() {
	local copydir=$1
	mkdir -p "${copydir}/repo"
	bsdtar -czf "${copydir}/repo/repo.db.tar.gz" -T /dev/null
	ln -s "repo.db.tar.gz" "${copydir}/repo/repo.db"
}

# Usage: chroot_add_to_local_repo $copydir $pkgfiles...
chroot_add_to_local_repo() {
	local copydir=$1; shift
	mkdir -p "$copydir/repo"
	local pkgfile
	for pkgfile in "$@"; do
		cp "$pkgfile" "$copydir/repo"
		pushd "$copydir/repo" >/dev/null
		repo-add repo.db.tar.gz "${pkgfile##*/}"
		popd >/dev/null
	done
}

usage() {
	eval "$(calculate_directories)"
	print "Usage: %s [OPTIONS] COMMAND [ARGS...]" "${0##*/}"
	print 'Interacts with an archroot (arch chroot).'
	echo
	prose 'This is configured with `chroot.conf`, either in
	       `/etc/libretools.d/`, or `$XDG_CONFIG_HOME/libretools/`.
	       The variables you may set are $CHROOTDIR, $CHROOT, and
	       $CHROOTEXTRAPKG.'
	echo
	prose 'There may be multiple chroots; they are stored in $CHROOTDIR.'
	echo
	prose 'Each chroot is named; the default is configured with $CHROOT.'
	echo
	prose 'Each named chroot has a master clean copy (named `root`), and any
	       number of other named copies; the copy used by default is the
	       current username (or $SUDO_USER, or `copy` if root).'
	echo
	prose 'The full path to the chroot copy is "$CHROOTDIR/$CHROOT/$COPY",
	       unless the copy name is manually specified as an absolute path,
	       in which case, that path is used.'
	echo
	prose 'The current settings for the above variables are:'
	printf '    CHROOTDIR : %s\n' "${CHROOTDIR:-$(_ 'ERROR: NO SETTING')}"
	printf '    CHROOT    : %s\n' "${CHROOT:-$(_ 'ERROR: NO SETTING')}"
	printf '    COPY      : %s\n' "$COPY"
	printf '    rootdir   : %s\n' "${rootdir:-$(_ 'ERROR')}"
	printf '    copydir   : %s\n' "${copydir:-$(_ 'ERROR')}"
	echo
	prose 'If the chroot or copy does not exist, it will be created
	       automatically.  A chroot by default contains the packages in the
	       group "base-devel" and any packages named in $CHROOTEXTRAPKG.
	       Unless the `-C` or `-M` flags are used, the configuration files
	       that this program installs are the stock versions supplied in the
	       packages, not the versions from your host system.  Other tools
	       (such as libremakepkg) may alter the configuration.'
	echo
	prose 'This command will make the following configuration changes in the
	       chroot:'
	bullet   'overwrite `/etc/libretools.d/chroot.conf`'
	bullet   'overwrite `/etc/pacman.d/mirrorlist`'
	bullet    'set `CacheDir` in `/etc/pacman.conf`'
	prose 'If a new `pacman.conf` is inserted with the `-C` flag, the change
	       is made after the file is copied in; the `-C` flag doesn'\''t
	       stop the change from being effective.'
	echo
	prose 'Creating a copy, deleting a copy, or syncing a copy can be fairly
	       slow; but are very fast if $CHROOTDIR is on a btrfs partition.'
	echo
	print 'Options:'
	flag "-n <$(_ CHROOT)>" 'Name of the chroot to use'
	flag "-l <$(_ COPY)>"   'Name of, or absolute path to, the copy to use'
	flag '-N'               'Disable networking in the chroot'
	flag "-C <$(_ FILE)>"   'Copy this file to `$copydir/etc/pacman.conf`'
	flag "-M <$(_ FILE)>"   'Copy this file to `$copydir/etc/makepkg.conf`'
	flag "-w <$(_ 'PATH[:PATH]')>" 'Bind mount a file or directory, read/write'
	flag "-r <$(_ 'PATH[:PATH]')>" 'Bind mount a file or directory, read-only'
	echo
	print 'Commands:'
	print ' Create/copy/delete:'
	flag 'noop|make'       'Do not do anything, but still creates the chroot
	                        copy if it does not exist'
	flag 'sync'            'Sync the copy with the clean (`root`) copy'
	flag 'delete'          'Delete the chroot copy'
	print ' Dealing with packages:'
	flag "install-file $(_ FILES...)"       'Like `pacman -U FILES...`'
	flag "install-name $(_ NAMES...)"       'Like `pacman -S NAMES...`'
	flag 'update'                           'Like `pacman -Syu`'
	flag 'clean-pkgs'      'Remove all packages from the chroot copy that
	                        are not in base-devel, $CHROOTEXTRAPKG, or named
	                        as a dependency in the file `/startdir/PKGBUILD`
	                        in the chroot copy'
	print ' Other:'
	flag "run $(_ CMD...)" 'Run CMD in the chroot copy'
	flag 'enter'           'Enter an interactive shell in the chroot copy'
	flag 'clean-repo'      'Clean /repo in the chroot copy'
	flag 'help'            'Show this message'
}
readonly commands=(
	noop make sync delete
	install-file install-name update clean-pkgs
	run enter clean-repo help
)

# Print code to set $rootdir and $copydir; blank them on error
calculate_directories() {
	# Don't assume that CHROOTDIR or CHROOT are set,
	# but assume that COPY is set.
	local rootdir copydir

	if [[ -n ${CHROOTDIR:-} ]] && [[ -n ${CHROOT:-} ]]; then
		rootdir="${CHROOTDIR}/${CHROOT}/root"
	else
		rootdir=''
	fi

	if [[ ${COPY:0:1} = / ]]; then
		copydir=$COPY
	elif [[ -n ${CHROOTDIR:-} ]] && [[ -n ${CHROOT:-} ]]; then
		copydir="${CHROOTDIR}/${CHROOT}/${COPY}"
	else
		copydir=''
	fi

	declare -p rootdir
	declare -p copydir
}

check_mountpoint() {
	local file=$1
	local mountpoint="$(df -P "$file"|sed '1d;s/.*\s//')"
	local mountopts=($(LC_ALL=C mount|awk "{ if (\$3==\"$mountpoint\") { gsub(/[(,)]/, \" \", \$6); print \$6 } }"))
	! in_array nosuid "${mountopts[@]}" && ! in_array noexec "${mountopts[@]}"
}

arch_nspawn_flags=()
sysd_nspawn_flags=()
arch-nspawn() {
	local copydir=$1; shift
	local cmd=("$@")

	set +u # if an array is empty, it counts as unbound
	"$_arch_nspawn" "${arch_nspawn_flags[@]}" "$copydir" "${sysd_nspawn_flags[@]}" -- "${cmd[@]}"
	set -u
}

# Globals: $CHROOTDIR, $CHROOT, $COPY, $rootdir and $copydir
main() {
	COPY=$LIBREUSER
	[[ $COPY != root ]] || COPY=copy

	local mode=enter
	while getopts 'n:l:NC:M:w:r:' opt; do
		case $opt in
			n) CHROOT=$OPTARG;;
			l) COPY=$OPTARG;;
			N) sysd_nspawn_flags+=(--private-network);;
			C|M) arch_nspawn_flags+=(-$opt "$OPTARG");;
			w) sysd_nspawn_flags+=("--bind=$OPTARG");;
			r) sysd_nspawn_flags+=("--bind-ro=$OPTARG");;
			*) usage >&2; return 1;;
		esac
	done
	shift $(($OPTIND - 1))
	if [[ $# -lt 1 ]]; then
		error "Must specify a command"
		usage >&2
		return 1
	fi
	mode=$1
	if ! in_array "$mode" "${commands[@]}"; then
		error "Unrecognized command: %s" "$mode"
		usage >&2
		return 1
	fi
	shift
	case "$mode" in
		noop|make|sync|delete|update|enter|clean-pkgs|clean-repo)
			if [[ $# -gt 0 ]]; then
				error 'Command `%s` does not take any arguments: %s' "$mode" "$*"
				usage >&2
				return 1
			fi
			:;;
		install-file)
			if [[ $# -lt 1 ]]; then
				error 'Command `%s` requires at least one file' "$mode"
				usage >&2
				return 1
			else
				local missing=()
				local file
				for file in "$@"; do
					if ! [[ -f $file ]]; then
						missing+=("$file")
					fi
				done
				if [[ ${#missing[@]} -gt 0 ]]; then
					error "%s: file(s) not found: %s" "$mode" "${missing[*]}"
					return 1
				fi
			fi
			:;;
		install-name)
			if [[ $# -lt 1 ]]; then
				error 'Command `%s` requires at least one package name' "$mode"
				usage >&2
				return 1
			fi
			:;;
		run)
			if [[ $# -lt 1 ]]; then
				error 'Command `%s` requires at least one argument' "$mode"
				usage >&2
				return 1
			fi
			:;;
	esac


	if [[ $mode == help ]]; then
		usage
		return 0
	fi

	check_vars chroot CHROOTDIR CHROOT
	eval "$(calculate_directories)"

	readonly LIBREUSER LIBREHOME
	readonly CHROOTDIR CHROOT COPY
	readonly rootdir copydir
	readonly mode

	########################################################################

	if (( EUID )); then
		error "This program must be run as root."
		return 1
	fi

	umask 0022

	# XXX: SYSTEMD-STDIN HACK
	if ! [[ -t 0 ]]; then
		error "Input is not a TTY"
		plain "https://labs.parabola.nu/issues/420"
		plain "https://bugs.freedesktop.org/show_bug.cgi?id=70290"
		prose "Due to a bug in systemd-nspawn, redirecting stdin is not
		       supported.  We have been able to mitigate the problems
		       with redirecting stdout, but until the bug is fixed,
		       redirecting stdin will only end in pain." >&2
		return 1
	fi

	# Keep this lock as long as we are running
	# Note that '9' is the same FD number as in mkarchroot et al.
	lock 9 "$copydir.lock" \
		"Waiting for existing lock on chroot copy to be released: [%s]" "$COPY"

	if ! check_mountpoint "$copydir.lock"; then
		error "Chroot copy is mounted with nosuid or noexec options: [%s]" "$COPY"
		return 1
	fi

	if [[ ! -d $rootdir ]]; then
		msg "Creating 'root' copy for chroot [%s]" "$CHROOT"
		set +u # if an array is empty, it counts as unbound
		"$_mkarchroot" "${arch_nspawn_flags[@]}" "$rootdir" base-devel
		set -u
		make_empty_repo "$rootdir"
	fi

	if [[ ! -d $copydir ]] || [[ $mode == sync ]]; then
		msg "Syncing copy [%s] with root copy" "$COPY"
		_makechrootpkg sync_chroot "$CHROOTDIR/$CHROOT" "$COPY"
	fi

	mkdir -p "$copydir/etc/libretools.d"
	{
		if [[ ${#CHROOTEXTRAPKG[*]} -eq 0 ]]; then
			echo 'CHROOTEXTRAPKG=()'
		else
			printf 'CHROOTEXTRAPKG=('
			printf '%q ' "${CHROOTEXTRAPKG[@]}"
			printf ')\n'
		fi
		# TODO: only set CHROOTARCH if $CARCH != $(uname -m)
		printf 'CHROOTARCH=%q\n' "$(uname -m)"
	} > "$copydir"/etc/libretools.d/chroot.conf

	if [[ $mode != delete ]]; then
		# "touch" the chroot first
		# this will
		#  - overwrite \`/etc/pacman.d/mirrorlist'"
		#  - set \`CacheDir' in \`/etc/pacman.conf'"
		#  - apply -C or -M flags
		arch-nspawn "$copydir" true
		arch_nspawn_flags=() # XXX dirty hack, don't apply -C or -M again
	fi

	########################################################################

	case "$mode" in
		# Creat/copy/delete
		noop|make|sync) :;;
		delete)
			if [[ -d $copydir ]]; then
				_makechrootpkg delete_chroot "$copydir" "$COPY"
			fi
			;;

		# Dealing with packages
		install-file)
			_makechrootpkg install_packages "$copydir" "$@"
			chroot_add_to_local_repo        "$copydir" "$@"
			;;
		install-name)
			arch-nspawn "$copydir" pacman -Sy "$@"
			;;
		update)
			arch-nspawn "$copydir" bash -c 'pacman -Syu --noconfirm'
			;;
		clean-pkgs)
			trap "rm -f -- $(printf '%q ' "$copydir"/{bin/chcleanup,chrootexec})" EXIT
			install -m755 "$(librelib chroot/chcleanup)" "$copydir/bin/chcleanup"
			printf '%s\n' \
				'#!/bin/bash' \
				'mkdir -p /startdir' \
				'cd /startdir' \
				'/bin/chcleanup' \
				> "$copydir/chrootexec"
			chmod 755 "$copydir/chrootexec"
			arch-nspawn "$copydir" /chrootexec
			;;

		# Other
		run)
			arch-nspawn "$copydir" "$@"
			;;
		enter)
			arch-nspawn "$copydir" bash
			;;
		clean-repo)
			rm -rf "${copydir}"/repo/*
			make_empty_repo "$copydir"
			;;
	esac
}

main "$@"