3 # Client script for LXC container images.
5 # Copyright © 2014 Stéphane Graber <stgraber@ubuntu.com>
7 # This library is free software; you can redistribute it and/or
8 # modify it under the terms of the GNU Lesser General Public
9 # License as published by the Free Software Foundation; either
10 # version 2.1 of the License, or (at your option) any later version.
12 # This library is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # Lesser General Public License for more details.
17 # You should have received a copy of the GNU Lesser General Public
18 # License along with this library; if not, write to the Free Software
19 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
24 LOCALSTATEDIR
="@LOCALSTATEDIR@"
25 LXC_HOOK_DIR
="@LXCHOOKDIR@"
26 LXC_TEMPLATE_CONFIG
="@LXCTEMPLATECONFIG@"
31 DOWNLOAD_COMPAT_LEVEL
=2
33 DOWNLOAD_FLUSH_CACHE
="false"
34 DOWNLOAD_FORCE_CACHE
="false"
35 DOWNLOAD_INTERACTIVE
="false"
36 DOWNLOAD_KEYID
="0xBAEFF88C22F6E216"
37 DOWNLOAD_KEYSERVER
="hkp://pool.sks-keyservers.net"
38 DOWNLOAD_LIST_IMAGES
="false"
39 DOWNLOAD_MODE
="system"
40 DOWNLOAD_READY_GPG
="false"
42 DOWNLOAD_SERVER
="images.linuxcontainers.org"
43 DOWNLOAD_SHOW_GPG_WARNING
="true"
44 DOWNLOAD_SHOW_HTTP_WARNING
="true"
45 DOWNLOAD_TARGET
="system"
47 DOWNLOAD_USE_CACHE
="false"
48 DOWNLOAD_VALIDATE
="true"
49 DOWNLOAD_VARIANT
="default"
57 # Deal with GPG over http proxy
58 if [ -n "${http_proxy:-}" ]; then
59 DOWNLOAD_KEYSERVER
="hkp://p80.pool.sks-keyservers.net:80"
62 # Make sure the usual locations are in PATH
63 export PATH
=$PATH:/usr
/sbin
:/usr
/bin
:/sbin
:/bin
65 # Some useful functions
67 if [ -d "$DOWNLOAD_TEMP" ]; then
73 if ! wget
-T 30 -q https
://${DOWNLOAD_SERVER}/$1 -O $2 >/dev
/null
2>&1; then
74 if ! wget
-T 30 -q http
://${DOWNLOAD_SERVER}/$1 -O $2 >/dev
/null
2>&1; then
75 if [ "$3" = "noexit" ]; then
78 echo "ERROR: Failed to download http://${DOWNLOAD_SERVER}/$1" 1>&2
81 elif [ "$DOWNLOAD_SHOW_HTTP_WARNING" = "true" ]; then
82 DOWNLOAD_SHOW_HTTP_WARNING
="false"
83 echo "WARNING: Failed to download the file over HTTPs." 1>&2
84 echo -n " The file was instead download over HTTP. " 1>&2
85 echo "A server replay attack may be possible!" 1>&2
91 if ! download_file
$1 $2 noexit
; then
92 if [ "$DOWNLOAD_VALIDATE" = "true" ]; then
93 if [ "$3" = "normal" ]; then
94 echo "ERROR: Failed to download http://${DOWNLOAD_SERVER}/$1" 1>&2
106 if [ "$DOWNLOAD_VALIDATE" = "false" ]; then
110 if [ "$DOWNLOAD_READY_GPG" = "true" ]; then
114 echo "Setting up the GPG keyring"
116 mkdir
-p "$DOWNLOAD_TEMP/gpg"
117 chmod 700 "$DOWNLOAD_TEMP/gpg"
118 export GNUPGHOME
="$DOWNLOAD_TEMP/gpg"
121 for i
in $
(seq 3); do
122 if gpg
--keyserver $DOWNLOAD_KEYSERVER \
123 --recv-keys ${DOWNLOAD_KEYID} >/dev
/null
2>&1; then
129 if [ -z "$success" ]; then
130 echo "ERROR: Unable to fetch GPG key from keyserver."
134 DOWNLOAD_READY_GPG
="true"
138 if [ "$DOWNLOAD_VALIDATE" = "false" ]; then
139 if [ "$DOWNLOAD_SHOW_GPG_WARNING" = "true" ]; then
140 echo "WARNING: Running without gpg validation!" 1>&2
142 DOWNLOAD_SHOW_GPG_WARNING
="false"
146 if ! gpg
--verify $1 >/dev
/zero
2>&1; then
147 echo "ERROR: Invalid signature for $1" 1>&2
153 [ -e /proc
/self
/uid_map
] ||
{ echo no
; return; }
155 fields
=$
(echo $line |
awk '{ print $1 " " $2 " " $3 }')
156 [ "$fields" = "0 0 4294967295" ] && { echo no
; return; } || true
157 echo $fields |
grep -q " 0 1$" && { echo userns-root
; return; } || true
158 done < /proc
/self
/uid_map
160 [ "$(cat /proc/self/uid_map)" = "$(cat /proc/1/uid_map)" ] && \
161 { echo userns-root
; return; }
166 FILE_PATH
="${LXC_CACHE_PATH}/$1"
167 if [ -e "${FILE_PATH}-${DOWNLOAD_MODE}" ]; then
168 FILE_PATH
="${FILE_PATH}-${DOWNLOAD_MODE}"
170 if [ -e "$FILE_PATH.${DOWNLOAD_COMPAT_LEVEL}" ]; then
171 FILE_PATH
="${FILE_PATH}.${DOWNLOAD_COMPAT_LEVEL}"
179 LXC container image downloader
182 [ -d | --dist <distribution> ]: The name of the distribution
183 [ -r | --release <release> ]: Release name/version
184 [ -a | --arch <architecture> ]: Architecture of the container
187 [ -h | --help ]: This help message
188 [ -l | --list ]: List all available images
189 [ --variant <variant> ]: Variant of the image (default: "default")
190 [ --server <server> ]: Image server (default: "images.linuxcontainers.org")
191 [ --keyid <keyid> ]: GPG keyid (default: 0x...)
192 [ --keyserver <keyserver> ]: GPG keyserver to use
193 [ --no-validate ]: Disable GPG validation (not recommended)
194 [ --flush-cache ]: Flush the local copy (if present)
195 [ --force-cache ]; Force the use of the local copy even if expired
197 LXC internal arguments (do not pass manually!):
198 [ --name <name> ]: The container name
199 [ --path <path> ]: The path to the container
200 [ --rootfs <rootfs> ]: The path to the container's rootfs
201 [ --mapped-uid <map> ]: A uid map (user namespaces)
202 [ --mapped-gid <map> ]: A gid map (user namespaces)
207 options
=$
(getopt
-o d
:r
:a
:hl
-l dist
:,release
:,arch
:,help,list
,variant
:,\
208 server
:,keyid
:,no-validate
,flush-cache
,force-cache
,name
:,path
:,\
209 rootfs
:,mapped-uid
:,mapped-gid
: -- "$@")
211 if [ $?
-ne 0 ]; then
215 eval set -- "$options"
219 -h|
--help) usage
&& exit 1;;
220 -l|
--list) DOWNLOAD_LIST_IMAGES
="true"; shift 1;;
221 -d|
--dist) DOWNLOAD_DIST
=$2; shift 2;;
222 -r|
--release) DOWNLOAD_RELEASE
=$2; shift 2;;
223 -a|
--arch) DOWNLOAD_ARCH
=$2; shift 2;;
224 --variant) DOWNLOAD_VARIANT
=$2; shift 2;;
225 --server) DOWNLOAD_SERVER
=$2; shift 2;;
226 --keyid) DOWNLOAD_KEYID
=$2; shift 2;;
227 --no-validate) DOWNLOAD_VALIDATE
="false"; shift 1;;
228 --flush-cache) DOWNLOAD_FLUSH_CACHE
="true"; shift 1;;
229 --force-cache) DOWNLOAD_FORCE_CACHE
="true"; shift 1;;
230 --name) LXC_NAME
=$2; shift 2;;
231 --path) LXC_PATH
=$2; shift 2;;
232 --rootfs) LXC_ROOTFS
=$2; shift 2;;
233 --mapped-uid) LXC_MAPPED_UID
=$2; shift 2;;
234 --mapped-gid) LXC_MAPPED_GID
=$2; shift 2;;
239 # Check for required binaries
240 for bin
in tar xz wget
; do
241 if ! type $bin >/dev
/null
2>&1; then
242 echo "ERROR: Missing required tool: $bin" 1>&2
248 if [ "$DOWNLOAD_VALIDATE" = "true" ]; then
249 if ! type gpg
>/dev
/null
2>&1; then
250 echo "ERROR: Missing recommended tool: gpg" 1>&2
251 echo "You can workaround this by using --no-validate." 1>&2
256 # Check that we have all variables we need
257 if [ -z "$LXC_NAME" ] ||
[ -z "$LXC_PATH" ] ||
[ -z "$LXC_ROOTFS" ]; then
258 echo "ERROR: Not running through LXC." 1>&2
264 if [ "$USERNS" != "no" ]; then
265 if [ "$USERNS" = "yes" ]; then
266 if [ -z "$LXC_MAPPED_UID" ] ||
[ "$LXC_MAPPED_UID" = "-1" ]; then
267 echo "ERROR: In a user namespace without a map." 1>&2
271 DOWNLOAD_TARGET
="user"
274 DOWNLOAD_TARGET
="system"
278 if [ -z "$DOWNLOAD_DIST" ] ||
[ -z "$DOWNLOAD_RELEASE" ] || \
279 [ -z "$DOWNLOAD_ARCH" ]; then
280 DOWNLOAD_INTERACTIVE
="true"
283 # Trap all exit signals
284 trap cleanup EXIT HUP INT TERM
286 if ! type mktemp
>/dev
/null
2>&1; then
287 DOWNLOAD_TEMP
=/tmp
/lxc-download.$$
288 mkdir
-p $DOWNLOAD_TEMP
290 DOWNLOAD_TEMP
=$
(mktemp
-d)
294 if [ "$DOWNLOAD_LIST_IMAGES" = "true" ] || \
295 [ "$DOWNLOAD_INTERACTIVE" = "true" ]; then
300 DOWNLOAD_INDEX_PATH
=/meta
/1.0/index-
${DOWNLOAD_MODE}
302 echo "Downloading the image index"
303 if ! download_file
${DOWNLOAD_INDEX_PATH}.
${DOWNLOAD_COMPAT_LEVEL} \
304 ${DOWNLOAD_TEMP}/index noexit ||
305 ! download_sig
${DOWNLOAD_INDEX_PATH}.
${DOWNLOAD_COMPAT_LEVEL}.asc \
306 ${DOWNLOAD_TEMP}/index.asc noexit
; then
307 download_file
${DOWNLOAD_INDEX_PATH} ${DOWNLOAD_TEMP}/index normal
308 download_sig
${DOWNLOAD_INDEX_PATH}.asc \
309 ${DOWNLOAD_TEMP}/index.asc normal
312 gpg_validate
${DOWNLOAD_TEMP}/index.asc
317 printf "DIST\tRELEASE\tARCH\tVARIANT\tBUILD\n"
326 [ -n "$DOWNLOAD_DIST" ] && [ "$1" != "$DOWNLOAD_DIST" ] && continue
327 [ -n "$DOWNLOAD_RELEASE" ] && [ "$2" != "$DOWNLOAD_RELEASE" ] && continue
328 [ -n "$DOWNLOAD_ARCH" ] && [ "$3" != "$DOWNLOAD_ARCH" ] && continue
329 [ -n "$DOWNLOAD_VARIANT" ] && [ "$4" != "$DOWNLOAD_VARIANT" ] && continue
330 [ -z "$5" ] ||
[ -z "$6" ] && continue
332 printf "$1\t$2\t$3\t$4\t$5\n"
333 done < ${DOWNLOAD_TEMP}/index
336 if [ "$DOWNLOAD_LIST_IMAGES" = "true" ]; then
343 if [ -z "$DOWNLOAD_DIST" ]; then
344 echo -n "Distribution: "
348 if [ -z "$DOWNLOAD_RELEASE" ]; then
350 read DOWNLOAD_RELEASE
353 if [ -z "$DOWNLOAD_ARCH" ]; then
354 echo -n "Architecture: "
362 if [ "$DOWNLOAD_TARGET" = "system" ]; then
363 LXC_CACHE_BASE
="$LOCALSTATEDIR/cache/lxc/"
365 LXC_CACHE_BASE
="$HOME/.cache/lxc/"
368 LXC_CACHE_PATH
="$LXC_CACHE_BASE/download/$DOWNLOAD_DIST"
369 LXC_CACHE_PATH
="$LXC_CACHE_PATH/$DOWNLOAD_RELEASE/$DOWNLOAD_ARCH/"
370 LXC_CACHE_PATH
="$LXC_CACHE_PATH/$DOWNLOAD_VARIANT"
372 if [ -d "$LXC_CACHE_PATH" ]; then
373 if [ "$DOWNLOAD_FLUSH_CACHE" = "true" ]; then
374 echo "Flushing the cache..."
375 rm -Rf $LXC_CACHE_PATH
376 elif [ "$DOWNLOAD_FORCE_CACHE" = "true" ]; then
377 DOWNLOAD_USE_CACHE
="true"
379 DOWNLOAD_USE_CACHE
="true"
380 if [ -e "$(relevant_file expiry)" ]; then
381 if [ "$(cat $(relevant_file expiry))" -lt $
(date +%s
) ]; then
382 echo "The cached copy has expired, re-downloading..."
383 DOWNLOAD_USE_CACHE
="false"
389 # Download what's needed
390 if [ "$DOWNLOAD_USE_CACHE" = "false" ]; then
395 DOWNLOAD_INDEX_PATH
=/meta
/1.0/index-
${DOWNLOAD_MODE}
397 echo "Downloading the image index"
398 if ! download_file
${DOWNLOAD_INDEX_PATH}.
${DOWNLOAD_COMPAT_LEVEL} \
399 ${DOWNLOAD_TEMP}/index noexit ||
400 ! download_sig
${DOWNLOAD_INDEX_PATH}.
${DOWNLOAD_COMPAT_LEVEL}.asc \
401 ${DOWNLOAD_TEMP}/index.asc noexit
; then
402 download_file
${DOWNLOAD_INDEX_PATH} ${DOWNLOAD_TEMP}/index normal
403 download_sig
${DOWNLOAD_INDEX_PATH}.asc \
404 ${DOWNLOAD_TEMP}/index.asc normal
407 gpg_validate
${DOWNLOAD_TEMP}/index.asc
417 if [ "$1" != "$DOWNLOAD_DIST" ] || \
418 [ "$2" != "$DOWNLOAD_RELEASE" ] || \
419 [ "$3" != "$DOWNLOAD_ARCH" ] || \
420 [ "$4" != "$DOWNLOAD_VARIANT" ] || \
428 done < ${DOWNLOAD_TEMP}/index
430 if [ -z "$DOWNLOAD_URL" ]; then
431 echo "ERROR: Couldn't find a matching image." 1>&1
435 if [ -d "$LXC_CACHE_PATH" ] && [ -f "$LXC_CACHE_PATH/build_id" ] && \
436 [ "$(cat $LXC_CACHE_PATH/build_id)" = "$DOWNLOAD_BUILD" ]; then
437 echo "The cache is already up to date."
438 echo "Using image from local cache"
440 # Download the actual files
441 echo "Downloading the rootfs"
442 download_file
$DOWNLOAD_URL/rootfs.
tar.xz \
443 ${DOWNLOAD_TEMP}/rootfs.
tar.xz normal
444 download_sig
$DOWNLOAD_URL/rootfs.
tar.xz.asc \
445 ${DOWNLOAD_TEMP}/rootfs.
tar.xz.asc normal
446 gpg_validate
${DOWNLOAD_TEMP}/rootfs.
tar.xz.asc
448 echo "Downloading the metadata"
449 download_file
$DOWNLOAD_URL/meta.
tar.xz \
450 ${DOWNLOAD_TEMP}/meta.
tar.xz normal
451 download_sig
$DOWNLOAD_URL/meta.
tar.xz.asc \
452 ${DOWNLOAD_TEMP}/meta.
tar.xz.asc normal
453 gpg_validate
${DOWNLOAD_TEMP}/meta.
tar.xz.asc
455 if [ -d $LXC_CACHE_PATH ]; then
456 rm -Rf $LXC_CACHE_PATH
458 mkdir
-p $LXC_CACHE_PATH
459 mv ${DOWNLOAD_TEMP}/rootfs.
tar.xz
$LXC_CACHE_PATH
460 if ! tar Jxf
${DOWNLOAD_TEMP}/meta.
tar.xz
-C $LXC_CACHE_PATH; then
461 echo "ERROR: Invalid rootfs tarball." 2>&1
465 echo $DOWNLOAD_BUILD > $LXC_CACHE_PATH/build_id
467 if [ -n "$LXC_MAPPED_UID" ] && [ "$LXC_MAPPED_UID" != "-1" ]; then
468 chown
-R $LXC_MAPPED_UID $LXC_CACHE_BASE >/dev
/null
2>&1 || true
470 if [ -n "$LXC_MAPPED_GID" ] && [ "$LXC_MAPPED_GID" != "-1" ]; then
471 chgrp
-R $LXC_MAPPED_GID $LXC_CACHE_BASE >/dev
/null
2>&1 || true
473 echo "The image cache is now ready"
476 echo "Using image from local cache"
480 echo "Unpacking the rootfs"
483 excludelist
=$
(relevant_file excludes
)
484 if [ -f "${excludelist}" ]; then
486 EXCLUDES
="$EXCLUDES --exclude=$line"
490 tar --anchored ${EXCLUDES} --numeric-owner -xpJf \
491 ${LXC_CACHE_PATH}/rootfs.
tar.xz
-C ${LXC_ROOTFS}
493 mkdir
-p ${LXC_ROOTFS}/dev
/pts
/
495 # Setup the configuration
496 configfile
=$
(relevant_file config
)
497 fstab
=$
(relevant_file fstab
)
498 if [ ! -e $configfile ]; then
499 echo "ERROR: meta tarball is missing the configuration file" 1>&2
503 ## Extract all the network config entries
504 sed -i -e "/lxc.network/{w ${LXC_PATH}/config-network" -e "d}" \
507 ## Extract any other config entry
508 sed -i -e "/lxc./{w ${LXC_PATH}/config-auto" -e "d}" ${LXC_PATH}/config
510 ## Append the defaults
511 echo "" >> ${LXC_PATH}/config
512 echo "# Distribution configuration" >> ${LXC_PATH}/config
513 cat $configfile >> ${LXC_PATH}/config
515 ## Add the container-specific config
516 echo "" >> ${LXC_PATH}/config
517 echo "# Container specific configuration" >> ${LXC_PATH}/config
518 if [ -e "${LXC_PATH}/config-auto" ]; then
519 cat ${LXC_PATH}/config-auto
>> ${LXC_PATH}/config
520 rm ${LXC_PATH}/config-auto
522 if [ -e "$fstab" ]; then
523 echo "lxc.mount = ${LXC_PATH}/fstab" >> ${LXC_PATH}/config
525 echo "lxc.utsname = ${LXC_NAME}" >> ${LXC_PATH}/config
527 ## Re-add the previously removed network config
528 if [ -e "${LXC_PATH}/config-network" ]; then
529 echo "" >> ${LXC_PATH}/config
530 echo "# Network configuration" >> ${LXC_PATH}/config
531 cat ${LXC_PATH}/config-network
>> ${LXC_PATH}/config
532 rm ${LXC_PATH}/config-network
535 TEMPLATE_FILES
="${LXC_PATH}/config"
538 if [ -e $fstab ]; then
539 cp ${fstab} ${LXC_PATH}/fstab
540 TEMPLATE_FILES
="$TEMPLATE_FILES ${LXC_PATH}/fstab"
543 # Look for extra templates
544 if [ -e "$(relevant_file templates)" ]; then
546 fullpath
=${LXC_ROOTFS}/$line
547 [ ! -e "$fullpath" ] && continue
548 TEMPLATE_FILES
="$TEMPLATE_FILES $fullpath"
549 done < $
(relevant_file templates
)
552 # Replace variables in all templates
553 for file in $TEMPLATE_FILES; do
554 [ ! -f "$file" ] && continue
556 sed -i "s#LXC_NAME#$LXC_NAME#g" $file
557 sed -i "s#LXC_PATH#$LXC_PATH#g" $file
558 sed -i "s#LXC_ROOTFS#$LXC_ROOTFS#g" $file
559 sed -i "s#LXC_TEMPLATE_CONFIG#$LXC_TEMPLATE_CONFIG#g" $file
560 sed -i "s#LXC_HOOK_DIR#$LXC_HOOK_DIR#g" $file
563 if [ -n "$LXC_MAPPED_UID" ] && [ "$LXC_MAPPED_UID" != "-1" ]; then
564 chown
$LXC_MAPPED_UID $LXC_PATH/config
$LXC_PATH/fstab
>/dev
/null
2>&1 || true
566 if [ -n "$LXC_MAPPED_GID" ] && [ "$LXC_MAPPED_GID" != "-1" ]; then
567 chgrp
$LXC_MAPPED_GID $LXC_PATH/config
$LXC_PATH/fstab
>/dev
/null
2>&1 || true
570 if [ -e "$(relevant_file create-message)" ]; then
573 cat "$(relevant_file create-message)"