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
83 if ! wget_wrapper
-T 30 -q https
://${DOWNLOAD_SERVER}/$1 -O $2 >/dev
/null
2>&1; then
84 if ! wget_wrapper
-T 30 -q http
://${DOWNLOAD_SERVER}/$1 -O $2 >/dev
/null
2>&1; then
85 if [ "$3" = "noexit" ]; then
88 echo "ERROR: Failed to download http://${DOWNLOAD_SERVER}/$1" 1>&2
91 elif [ "$DOWNLOAD_SHOW_HTTP_WARNING" = "true" ]; then
92 DOWNLOAD_SHOW_HTTP_WARNING
="false"
93 echo "WARNING: Failed to download the file over HTTPs." 1>&2
94 echo -n " The file was instead download over HTTP. " 1>&2
95 echo "A server replay attack may be possible!" 1>&2
101 if ! download_file
$1 $2 noexit
; then
102 if [ "$DOWNLOAD_VALIDATE" = "true" ]; then
103 if [ "$3" = "normal" ]; then
104 echo "ERROR: Failed to download http://${DOWNLOAD_SERVER}/$1" 1>&2
116 if [ "$DOWNLOAD_VALIDATE" = "false" ]; then
120 if [ "$DOWNLOAD_READY_GPG" = "true" ]; then
124 echo "Setting up the GPG keyring"
126 mkdir
-p "$DOWNLOAD_TEMP/gpg"
127 chmod 700 "$DOWNLOAD_TEMP/gpg"
128 export GNUPGHOME
="$DOWNLOAD_TEMP/gpg"
131 for i
in $
(seq 3); do
132 if gpg
--keyserver $DOWNLOAD_KEYSERVER \
133 --recv-keys ${DOWNLOAD_KEYID} >/dev
/null
2>&1; then
139 if [ -z "$success" ]; then
140 echo "ERROR: Unable to fetch GPG key from keyserver."
144 DOWNLOAD_READY_GPG
="true"
148 if [ "$DOWNLOAD_VALIDATE" = "false" ]; then
149 if [ "$DOWNLOAD_SHOW_GPG_WARNING" = "true" ]; then
150 echo "WARNING: Running without gpg validation!" 1>&2
152 DOWNLOAD_SHOW_GPG_WARNING
="false"
156 if ! gpg
--verify $1 >/dev
/zero
2>&1; then
157 echo "ERROR: Invalid signature for $1" 1>&2
163 [ -e /proc
/self
/uid_map
] ||
{ echo no
; return; }
165 fields
=$
(echo $line |
awk '{ print $1 " " $2 " " $3 }')
166 [ "$fields" = "0 0 4294967295" ] && { echo no
; return; } || true
167 echo $fields |
grep -q " 0 1$" && { echo userns-root
; return; } || true
168 done < /proc
/self
/uid_map
170 [ "$(cat /proc/self/uid_map)" = "$(cat /proc/1/uid_map)" ] && \
171 { echo userns-root
; return; }
176 FILE_PATH
="${LXC_CACHE_PATH}/$1"
177 if [ -e "${FILE_PATH}-${DOWNLOAD_MODE}" ]; then
178 FILE_PATH
="${FILE_PATH}-${DOWNLOAD_MODE}"
180 if [ -e "$FILE_PATH.${DOWNLOAD_COMPAT_LEVEL}" ]; then
181 FILE_PATH
="${FILE_PATH}.${DOWNLOAD_COMPAT_LEVEL}"
189 LXC container image downloader
192 [ -d | --dist <distribution> ]: The name of the distribution
193 [ -r | --release <release> ]: Release name/version
194 [ -a | --arch <architecture> ]: Architecture of the container
197 [ -h | --help ]: This help message
198 [ -l | --list ]: List all available images
199 [ --variant <variant> ]: Variant of the image (default: "default")
200 [ --server <server> ]: Image server (default: "images.linuxcontainers.org")
201 [ --keyid <keyid> ]: GPG keyid (default: 0x...)
202 [ --keyserver <keyserver> ]: GPG keyserver to use
203 [ --no-validate ]: Disable GPG validation (not recommended)
204 [ --flush-cache ]: Flush the local copy (if present)
205 [ --force-cache ]; Force the use of the local copy even if expired
207 LXC internal arguments (do not pass manually!):
208 [ --name <name> ]: The container name
209 [ --path <path> ]: The path to the container
210 [ --rootfs <rootfs> ]: The path to the container's rootfs
211 [ --mapped-uid <map> ]: A uid map (user namespaces)
212 [ --mapped-gid <map> ]: A gid map (user namespaces)
217 options
=$
(getopt
-o d
:r
:a
:hl
-l dist
:,release
:,arch
:,help,list
,variant
:,\
218 server
:,keyid
:,keyserver
:,no-validate
,flush-cache
,force-cache
,name
:,path
:,\
219 rootfs
:,mapped-uid
:,mapped-gid
: -- "$@")
221 if [ $?
-ne 0 ]; then
225 eval set -- "$options"
229 -h|
--help) usage
&& exit 1;;
230 -l|
--list) DOWNLOAD_LIST_IMAGES
="true"; shift 1;;
231 -d|
--dist) DOWNLOAD_DIST
=$2; shift 2;;
232 -r|
--release) DOWNLOAD_RELEASE
=$2; shift 2;;
233 -a|
--arch) DOWNLOAD_ARCH
=$2; shift 2;;
234 --variant) DOWNLOAD_VARIANT
=$2; shift 2;;
235 --server) DOWNLOAD_SERVER
=$2; shift 2;;
236 --keyid) DOWNLOAD_KEYID
=$2; shift 2;;
237 --keyserver) DOWNLOAD_KEYSERVER
=$2; shift 2;;
238 --no-validate) DOWNLOAD_VALIDATE
="false"; shift 1;;
239 --flush-cache) DOWNLOAD_FLUSH_CACHE
="true"; shift 1;;
240 --force-cache) DOWNLOAD_FORCE_CACHE
="true"; shift 1;;
241 --name) LXC_NAME
=$2; shift 2;;
242 --path) LXC_PATH
=$2; shift 2;;
243 --rootfs) LXC_ROOTFS
=$2; shift 2;;
244 --mapped-uid) LXC_MAPPED_UID
=$2; shift 2;;
245 --mapped-gid) LXC_MAPPED_GID
=$2; shift 2;;
250 # Check for required binaries
251 for bin
in tar xz wget
; do
252 if ! type $bin >/dev
/null
2>&1; then
253 echo "ERROR: Missing required tool: $bin" 1>&2
259 if [ "$DOWNLOAD_VALIDATE" = "true" ]; then
260 if ! type gpg
>/dev
/null
2>&1; then
261 echo "ERROR: Missing recommended tool: gpg" 1>&2
262 echo "You can workaround this by using --no-validate." 1>&2
267 # Check that we have all variables we need
268 if [ -z "$LXC_NAME" ] ||
[ -z "$LXC_PATH" ] ||
[ -z "$LXC_ROOTFS" ]; then
269 echo "ERROR: Not running through LXC." 1>&2
275 if [ "$USERNS" != "no" ]; then
276 if [ "$USERNS" = "yes" ]; then
277 if [ -z "$LXC_MAPPED_UID" ] ||
[ "$LXC_MAPPED_UID" = "-1" ]; then
278 echo "ERROR: In a user namespace without a map." 1>&2
282 DOWNLOAD_TARGET
="user"
285 DOWNLOAD_TARGET
="system"
289 if [ -z "$DOWNLOAD_DIST" ] ||
[ -z "$DOWNLOAD_RELEASE" ] || \
290 [ -z "$DOWNLOAD_ARCH" ]; then
291 DOWNLOAD_INTERACTIVE
="true"
294 # Trap all exit signals
295 trap cleanup EXIT HUP INT TERM
297 if ! type mktemp
>/dev
/null
2>&1; then
298 DOWNLOAD_TEMP
=/tmp
/lxc-download.$$
299 mkdir
-p $DOWNLOAD_TEMP
301 DOWNLOAD_TEMP
=$
(mktemp
-d)
305 if [ "$DOWNLOAD_LIST_IMAGES" = "true" ] || \
306 [ "$DOWNLOAD_INTERACTIVE" = "true" ]; then
311 DOWNLOAD_INDEX_PATH
=/meta
/1.0/index-
${DOWNLOAD_MODE}
313 echo "Downloading the image index"
314 if ! download_file
${DOWNLOAD_INDEX_PATH}.
${DOWNLOAD_COMPAT_LEVEL} \
315 ${DOWNLOAD_TEMP}/index noexit ||
316 ! download_sig
${DOWNLOAD_INDEX_PATH}.
${DOWNLOAD_COMPAT_LEVEL}.asc \
317 ${DOWNLOAD_TEMP}/index.asc noexit
; then
318 download_file
${DOWNLOAD_INDEX_PATH} ${DOWNLOAD_TEMP}/index normal
319 download_sig
${DOWNLOAD_INDEX_PATH}.asc \
320 ${DOWNLOAD_TEMP}/index.asc normal
323 gpg_validate
${DOWNLOAD_TEMP}/index.asc
328 printf "DIST\tRELEASE\tARCH\tVARIANT\tBUILD\n"
337 [ -n "$DOWNLOAD_DIST" ] && [ "$1" != "$DOWNLOAD_DIST" ] && continue
338 [ -n "$DOWNLOAD_RELEASE" ] && [ "$2" != "$DOWNLOAD_RELEASE" ] && continue
339 [ -n "$DOWNLOAD_ARCH" ] && [ "$3" != "$DOWNLOAD_ARCH" ] && continue
340 [ -n "$DOWNLOAD_VARIANT" ] && [ "$4" != "$DOWNLOAD_VARIANT" ] && continue
341 [ -z "$5" ] ||
[ -z "$6" ] && continue
343 printf "$1\t$2\t$3\t$4\t$5\n"
344 done < ${DOWNLOAD_TEMP}/index
347 if [ "$DOWNLOAD_LIST_IMAGES" = "true" ]; then
354 if [ -z "$DOWNLOAD_DIST" ]; then
355 echo -n "Distribution: "
359 if [ -z "$DOWNLOAD_RELEASE" ]; then
361 read DOWNLOAD_RELEASE
364 if [ -z "$DOWNLOAD_ARCH" ]; then
365 echo -n "Architecture: "
373 if [ "$DOWNLOAD_TARGET" = "system" ]; then
374 LXC_CACHE_BASE
="$LOCALSTATEDIR/cache/lxc/"
376 LXC_CACHE_BASE
="$HOME/.cache/lxc/"
379 LXC_CACHE_PATH
="$LXC_CACHE_BASE/download/$DOWNLOAD_DIST"
380 LXC_CACHE_PATH
="$LXC_CACHE_PATH/$DOWNLOAD_RELEASE/$DOWNLOAD_ARCH/"
381 LXC_CACHE_PATH
="$LXC_CACHE_PATH/$DOWNLOAD_VARIANT"
383 if [ -d "$LXC_CACHE_PATH" ]; then
384 if [ "$DOWNLOAD_FLUSH_CACHE" = "true" ]; then
385 echo "Flushing the cache..."
386 rm -Rf $LXC_CACHE_PATH
387 elif [ "$DOWNLOAD_FORCE_CACHE" = "true" ]; then
388 DOWNLOAD_USE_CACHE
="true"
390 DOWNLOAD_USE_CACHE
="true"
391 if [ -e "$(relevant_file expiry)" ]; then
392 if [ "$(cat $(relevant_file expiry))" -lt $
(date +%s
) ]; then
393 echo "The cached copy has expired, re-downloading..."
394 DOWNLOAD_USE_CACHE
="false"
400 # Download what's needed
401 if [ "$DOWNLOAD_USE_CACHE" = "false" ]; then
406 DOWNLOAD_INDEX_PATH
=/meta
/1.0/index-
${DOWNLOAD_MODE}
408 echo "Downloading the image index"
409 if ! download_file
${DOWNLOAD_INDEX_PATH}.
${DOWNLOAD_COMPAT_LEVEL} \
410 ${DOWNLOAD_TEMP}/index noexit ||
411 ! download_sig
${DOWNLOAD_INDEX_PATH}.
${DOWNLOAD_COMPAT_LEVEL}.asc \
412 ${DOWNLOAD_TEMP}/index.asc noexit
; then
413 download_file
${DOWNLOAD_INDEX_PATH} ${DOWNLOAD_TEMP}/index normal
414 download_sig
${DOWNLOAD_INDEX_PATH}.asc \
415 ${DOWNLOAD_TEMP}/index.asc normal
418 gpg_validate
${DOWNLOAD_TEMP}/index.asc
428 if [ "$1" != "$DOWNLOAD_DIST" ] || \
429 [ "$2" != "$DOWNLOAD_RELEASE" ] || \
430 [ "$3" != "$DOWNLOAD_ARCH" ] || \
431 [ "$4" != "$DOWNLOAD_VARIANT" ] || \
439 done < ${DOWNLOAD_TEMP}/index
441 if [ -z "$DOWNLOAD_URL" ]; then
442 echo "ERROR: Couldn't find a matching image." 1>&1
446 if [ -d "$LXC_CACHE_PATH" ] && [ -f "$LXC_CACHE_PATH/build_id" ] && \
447 [ "$(cat $LXC_CACHE_PATH/build_id)" = "$DOWNLOAD_BUILD" ]; then
448 echo "The cache is already up to date."
449 echo "Using image from local cache"
451 # Download the actual files
452 echo "Downloading the rootfs"
453 download_file
$DOWNLOAD_URL/rootfs.
tar.xz \
454 ${DOWNLOAD_TEMP}/rootfs.
tar.xz normal
455 download_sig
$DOWNLOAD_URL/rootfs.
tar.xz.asc \
456 ${DOWNLOAD_TEMP}/rootfs.
tar.xz.asc normal
457 gpg_validate
${DOWNLOAD_TEMP}/rootfs.
tar.xz.asc
459 echo "Downloading the metadata"
460 download_file
$DOWNLOAD_URL/meta.
tar.xz \
461 ${DOWNLOAD_TEMP}/meta.
tar.xz normal
462 download_sig
$DOWNLOAD_URL/meta.
tar.xz.asc \
463 ${DOWNLOAD_TEMP}/meta.
tar.xz.asc normal
464 gpg_validate
${DOWNLOAD_TEMP}/meta.
tar.xz.asc
466 if [ -d $LXC_CACHE_PATH ]; then
467 rm -Rf $LXC_CACHE_PATH
469 mkdir
-p $LXC_CACHE_PATH
470 mv ${DOWNLOAD_TEMP}/rootfs.
tar.xz
$LXC_CACHE_PATH
471 if ! tar Jxf
${DOWNLOAD_TEMP}/meta.
tar.xz
-C $LXC_CACHE_PATH; then
472 echo "ERROR: Invalid rootfs tarball." 2>&1
476 echo $DOWNLOAD_BUILD > $LXC_CACHE_PATH/build_id
478 if [ -n "$LXC_MAPPED_UID" ] && [ "$LXC_MAPPED_UID" != "-1" ]; then
479 chown
-R $LXC_MAPPED_UID $LXC_CACHE_BASE >/dev
/null
2>&1 || true
481 if [ -n "$LXC_MAPPED_GID" ] && [ "$LXC_MAPPED_GID" != "-1" ]; then
482 chgrp
-R $LXC_MAPPED_GID $LXC_CACHE_BASE >/dev
/null
2>&1 || true
484 echo "The image cache is now ready"
487 echo "Using image from local cache"
491 echo "Unpacking the rootfs"
494 excludelist
=$
(relevant_file excludes
)
495 if [ -f "${excludelist}" ]; then
497 EXCLUDES
="$EXCLUDES --exclude=$line"
501 tar --anchored ${EXCLUDES} --numeric-owner -xpJf \
502 ${LXC_CACHE_PATH}/rootfs.
tar.xz
-C ${LXC_ROOTFS}
504 mkdir
-p ${LXC_ROOTFS}/dev
/pts
/
506 # Setup the configuration
507 configfile
=$
(relevant_file config
)
508 fstab
=$
(relevant_file fstab
)
509 if [ ! -e $configfile ]; then
510 echo "ERROR: meta tarball is missing the configuration file" 1>&2
514 ## Extract all the network config entries
515 sed -i -e "/lxc.network/{w ${LXC_PATH}/config-network" -e "d}" \
518 ## Extract any other config entry
519 sed -i -e "/lxc./{w ${LXC_PATH}/config-auto" -e "d}" ${LXC_PATH}/config
521 ## Append the defaults
522 echo "" >> ${LXC_PATH}/config
523 echo "# Distribution configuration" >> ${LXC_PATH}/config
524 cat $configfile >> ${LXC_PATH}/config
526 ## Add the container-specific config
527 echo "" >> ${LXC_PATH}/config
528 echo "# Container specific configuration" >> ${LXC_PATH}/config
529 if [ -e "${LXC_PATH}/config-auto" ]; then
530 cat ${LXC_PATH}/config-auto
>> ${LXC_PATH}/config
531 rm ${LXC_PATH}/config-auto
533 if [ -e "$fstab" ]; then
534 echo "lxc.mount = ${LXC_PATH}/fstab" >> ${LXC_PATH}/config
536 echo "lxc.utsname = ${LXC_NAME}" >> ${LXC_PATH}/config
538 ## Re-add the previously removed network config
539 if [ -e "${LXC_PATH}/config-network" ]; then
540 echo "" >> ${LXC_PATH}/config
541 echo "# Network configuration" >> ${LXC_PATH}/config
542 cat ${LXC_PATH}/config-network
>> ${LXC_PATH}/config
543 rm ${LXC_PATH}/config-network
546 TEMPLATE_FILES
="${LXC_PATH}/config"
549 if [ -e $fstab ]; then
550 cp ${fstab} ${LXC_PATH}/fstab
551 TEMPLATE_FILES
="$TEMPLATE_FILES ${LXC_PATH}/fstab"
554 # Look for extra templates
555 if [ -e "$(relevant_file templates)" ]; then
557 fullpath
=${LXC_ROOTFS}/$line
558 [ ! -e "$fullpath" ] && continue
559 TEMPLATE_FILES
="$TEMPLATE_FILES $fullpath"
560 done < $
(relevant_file templates
)
563 # Replace variables in all templates
564 for file in $TEMPLATE_FILES; do
565 [ ! -f "$file" ] && continue
567 sed -i "s#LXC_NAME#$LXC_NAME#g" $file
568 sed -i "s#LXC_PATH#$LXC_PATH#g" $file
569 sed -i "s#LXC_ROOTFS#$LXC_ROOTFS#g" $file
570 sed -i "s#LXC_TEMPLATE_CONFIG#$LXC_TEMPLATE_CONFIG#g" $file
571 sed -i "s#LXC_HOOK_DIR#$LXC_HOOK_DIR#g" $file
574 if [ -n "$LXC_MAPPED_UID" ] && [ "$LXC_MAPPED_UID" != "-1" ]; then
575 chown
$LXC_MAPPED_UID $LXC_PATH/config
$LXC_PATH/fstab
>/dev
/null
2>&1 || true
577 if [ -n "$LXC_MAPPED_GID" ] && [ "$LXC_MAPPED_GID" != "-1" ]; then
578 chgrp
$LXC_MAPPED_GID $LXC_PATH/config
$LXC_PATH/fstab
>/dev
/null
2>&1 || true
581 if [ -e "$(relevant_file create-message)" ]; then
584 cat "$(relevant_file create-message)"