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
=5
33 DOWNLOAD_FLUSH_CACHE
="false"
34 DOWNLOAD_FORCE_CACHE
="false"
35 DOWNLOAD_INTERACTIVE
="false"
36 DOWNLOAD_KEYID
="0xE7FB0CAEC8173D669066514CBAEFF88C22F6E216"
37 DOWNLOAD_LIST_IMAGES
="false"
38 DOWNLOAD_MODE
="system"
39 DOWNLOAD_READY_GPG
="false"
41 DOWNLOAD_SERVER
="images.linuxcontainers.org"
42 DOWNLOAD_SHOW_GPG_WARNING
="true"
43 DOWNLOAD_SHOW_HTTP_WARNING
="true"
44 DOWNLOAD_TARGET
="system"
46 DOWNLOAD_USE_CACHE
="false"
47 DOWNLOAD_VALIDATE
="true"
48 DOWNLOAD_VARIANT
="default"
57 if [ -z "${DOWNLOAD_KEYSERVER:-}" ]; then
58 DOWNLOAD_KEYSERVER
="hkp://pool.sks-keyservers.net"
60 # Deal with GPG over http proxy
61 if [ -n "${http_proxy:-}" ]; then
62 DOWNLOAD_KEYSERVER
="hkp://p80.pool.sks-keyservers.net:80"
66 # Make sure the usual locations are in PATH
67 export PATH
=$PATH:/usr
/sbin
:/usr
/bin
:/sbin
:/bin
69 # Some useful functions
71 if [ -d "${DOWNLOAD_TEMP}" ]; then
72 rm -Rf "${DOWNLOAD_TEMP}"
87 if ! wget_wrapper
-T 30 -q "https://${DOWNLOAD_SERVER}/$1" -O "$2" >/dev
/null
2>&1; then
88 if ! wget_wrapper
-T 30 -q "http://${DOWNLOAD_SERVER}/$1" -O "$2" >/dev
/null
2>&1; then
89 if [ "$3" = "noexit" ]; then
92 echo "ERROR: Failed to download http://${DOWNLOAD_SERVER}/$1" 1>&2
95 elif [ "${DOWNLOAD_SHOW_HTTP_WARNING}" = "true" ]; then
96 DOWNLOAD_SHOW_HTTP_WARNING
="false"
97 echo "WARNING: Failed to download the file over HTTPs" 1>&2
98 echo " The file was instead download over HTTP " 1>&2
99 echo "A server replay attack may be possible!" 1>&2
105 if ! download_file
"$1" "$2" noexit
; then
106 if [ "${DOWNLOAD_VALIDATE}" = "true" ]; then
107 if [ "$3" = "normal" ]; then
108 echo "ERROR: Failed to download http://${DOWNLOAD_SERVER}/$1" 1>&2
120 if [ "${DOWNLOAD_VALIDATE}" = "false" ]; then
124 if [ "${DOWNLOAD_READY_GPG}" = "true" ]; then
128 echo "Setting up the GPG keyring"
130 mkdir
-p "${DOWNLOAD_TEMP}/gpg"
131 chmod 700 "${DOWNLOAD_TEMP}/gpg"
132 export GNUPGHOME
="${DOWNLOAD_TEMP}/gpg"
135 for _
in $
(seq 3); do
136 if gpg
--keyserver "${DOWNLOAD_KEYSERVER}" \
137 --recv-keys "${DOWNLOAD_KEYID}" >/dev
/null
2>&1; then
144 if [ -z "${success}" ]; then
145 echo "ERROR: Unable to fetch GPG key from keyserver"
149 DOWNLOAD_READY_GPG
="true"
153 if [ "${DOWNLOAD_VALIDATE}" = "false" ]; then
154 if [ "${DOWNLOAD_SHOW_GPG_WARNING}" = "true" ]; then
155 echo "WARNING: Running without gpg validation!" 1>&2
157 DOWNLOAD_SHOW_GPG_WARNING
="false"
161 if ! gpg
--verify "$1" >/dev
/null
2>&1; then
162 echo "ERROR: Invalid signature for $1" 1>&2
168 [ -e /proc
/self
/uid_map
] ||
{ echo no
; return; }
169 while read -r line
; do
170 fields
="$(echo "$line" | awk '{ print $1 " " $2 " " $3 }')"
171 if [ "${fields}" = "0 0 4294967295" ]; then
175 if echo "${fields}" |
grep -q " 0 1$"; then
179 done < /proc
/self
/uid_map
181 [ "$(cat /proc/self/uid_map)" = "$(cat /proc/1/uid_map)" ] && { echo userns-root
; return; }
186 FILE_PATH
="${LXC_CACHE_PATH}/$1"
188 if [ -e "${FILE_PATH}-${DOWNLOAD_MODE}" ]; then
189 FILE_PATH
="${FILE_PATH}-${DOWNLOAD_MODE}"
192 if [ -e "${FILE_PATH}.${DOWNLOAD_COMPAT_LEVEL}" ]; then
193 FILE_PATH
="${FILE_PATH}.${DOWNLOAD_COMPAT_LEVEL}"
201 LXC container image downloader
204 [ -h | --help ]: Print this help message and exit
205 [ -l | --list ]: List all available images and exit
208 [ -d | --dist <distribution> ]: The name of the distribution
209 [ -r | --release <release> ]: Release name/version
210 [ -a | --arch <architecture> ]: Architecture of the container
213 [ --variant <variant> ]: Variant of the image (default: "default")
214 [ --server <server> ]: Image server (default: "images.linuxcontainers.org")
215 [ --keyid <keyid> ]: GPG keyid (default: 0x...)
216 [ --keyserver <keyserver> ]: GPG keyserver to use. Environment variable: DOWNLOAD_KEYSERVER
217 [ --no-validate ]: Disable GPG validation (not recommended)
218 [ --flush-cache ]: Flush the local copy (if present)
219 [ --force-cache ]: Force the use of the local copy even if expired
221 LXC internal arguments (do not pass manually!):
222 [ --name <name> ]: The container name
223 [ --path <path> ]: The path to the container
224 [ --rootfs <rootfs> ]: The path to the container's rootfs
225 [ --mapped-uid <map> ]: A uid map (user namespaces)
226 [ --mapped-gid <map> ]: A gid map (user namespaces)
228 Environment Variables:
229 DOWNLOAD_KEYSERVER : The URL of the key server to use, instead of the default.
230 Can be further overridden by using optional argument --keyserver
236 if ! options
=$
(getopt
-o d
:r
:a
:hl
-l dist
:,release
:,arch
:,help,list
,variant
:,\
237 server
:,keyid
:,keyserver
:,no-validate
,flush-cache
,force-cache
,name
:,path
:,\
238 rootfs
:,mapped-uid
:,mapped-gid
: -- "$@"); then
242 eval set -- "$options"
246 -h|
--help) usage
&& exit 1;;
247 -l|
--list) DOWNLOAD_LIST_IMAGES
="true"; shift 1;;
248 -d|
--dist) DOWNLOAD_DIST
="$2"; shift 2;;
249 -r|
--release) DOWNLOAD_RELEASE
="$2"; shift 2;;
250 -a|
--arch) DOWNLOAD_ARCH
="$2"; shift 2;;
251 --variant) DOWNLOAD_VARIANT
="$2"; shift 2;;
252 --server) DOWNLOAD_SERVER
="$2"; shift 2;;
253 --keyid) DOWNLOAD_KEYID
="$2"; shift 2;;
254 --keyserver) DOWNLOAD_KEYSERVER
="$2"; shift 2;;
255 --no-validate) DOWNLOAD_VALIDATE
="false"; shift 1;;
256 --flush-cache) DOWNLOAD_FLUSH_CACHE
="true"; shift 1;;
257 --force-cache) DOWNLOAD_FORCE_CACHE
="true"; shift 1;;
258 --name) LXC_NAME
="$2"; shift 2;;
259 --path) LXC_PATH
="$2"; shift 2;;
260 --rootfs) LXC_ROOTFS
="$2"; shift 2;;
261 --mapped-uid) LXC_MAPPED_UID
="$2"; shift 2;;
262 --mapped-gid) LXC_MAPPED_GID
="$2"; shift 2;;
267 # Check for required binaries
268 for bin
in tar xz wget
; do
269 if ! command -V "${bin}" >/dev
/null
2>&1; then
270 echo "ERROR: Missing required tool: ${bin}" 1>&2
276 if [ "${DOWNLOAD_VALIDATE}" = "true" ]; then
277 if ! command -V gpg
>/dev
/null
2>&1; then
278 echo "ERROR: Missing recommended tool: gpg" 1>&2
279 echo "You can workaround this by using --no-validate" 1>&2
284 # Check that we have all variables we need
285 if [ -z "${LXC_NAME}" ] || [ -z "${LXC_PATH}" ] || [ -z "${LXC_ROOTFS}" ]; then
286 if [ "${DOWNLOAD_LIST_IMAGES}" != "true" ]; then
287 echo "ERROR: Please pass the name, path, and rootfs for the container" 1>&2
292 USERNS
="$(in_userns)"
294 if [ "${USERNS}" != "no" ]; then
295 if [ "${USERNS}" = "yes" ]; then
296 if [ -z "${LXC_MAPPED_UID}" ] ||
[ "${LXC_MAPPED_UID}" = "-1" ]; then
297 echo "ERROR: In a user namespace without a map" 1>&2
301 DOWNLOAD_TARGET
="user"
304 DOWNLOAD_TARGET
="system"
308 if [ -z "${DOWNLOAD_DIST}" ] || [ -z "${DOWNLOAD_RELEASE}" ] || [ -z "${DOWNLOAD_ARCH}" ]; then
309 DOWNLOAD_INTERACTIVE
="true"
312 # Trap all exit signals
313 trap cleanup EXIT HUP INT TERM
315 # /tmp may be mounted in tmpfs or noexec
316 if mountpoint
-q /tmp
; then
317 DOWNLOAD_TEMP
="${LXC_PATH}"
320 if ! command -V mktemp
>/dev
/null
2>&1; then
321 DOWNLOAD_TEMP
="${DOWNLOAD_TEMP}/tmp/lxc-download.$$"
322 elif [ -n "${DOWNLOAD_TEMP}" ]; then
323 mkdir
-p "${DOWNLOAD_TEMP}"
324 DOWNLOAD_TEMP
="$(mktemp -p ${DOWNLOAD_TEMP} -d)"
326 DOWNLOAD_TEMP
="${DOWNLOAD_TEMP}$(mktemp -d)"
330 if [ "${DOWNLOAD_LIST_IMAGES}" = "true" ] ||
[ "${DOWNLOAD_INTERACTIVE}" = "true" ]; then
335 DOWNLOAD_INDEX_PATH
="/meta/1.0/index-${DOWNLOAD_MODE}"
337 echo "Downloading the image index"
338 if ! download_file
"${DOWNLOAD_INDEX_PATH}.${DOWNLOAD_COMPAT_LEVEL}" "${DOWNLOAD_TEMP}/index" noexit ||
339 ! download_sig
"${DOWNLOAD_INDEX_PATH}.${DOWNLOAD_COMPAT_LEVEL}.asc" "${DOWNLOAD_TEMP}/index.asc" noexit
; then
340 download_file
"${DOWNLOAD_INDEX_PATH}" "${DOWNLOAD_TEMP}/index" normal
341 download_sig
"${DOWNLOAD_INDEX_PATH}.asc" "${DOWNLOAD_TEMP}/index.asc" normal
344 gpg_validate
"${DOWNLOAD_TEMP}/index.asc"
349 printf "DIST\tRELEASE\tARCH\tVARIANT\tBUILD\n"
351 while IFS
=';' read -r f1 f2 f3 f4 f5 f6
; do
352 [ -n "${DOWNLOAD_DIST}" ] && [ "$f1" != "${DOWNLOAD_DIST}" ] && continue
353 [ -n "${DOWNLOAD_RELEASE}" ] && [ "$f2" != "${DOWNLOAD_RELEASE}" ] && continue
354 [ -n "${DOWNLOAD_ARCH}" ] && [ "$f3" != "${DOWNLOAD_ARCH}" ] && continue
355 [ -n "${DOWNLOAD_VARIANT}" ] && [ "$f4" != "${DOWNLOAD_VARIANT}" ] && continue
356 [ -z "${f5}" ] ||
[ -z "${f6}" ] && continue
358 printf "%s\t%s\t%s\t%s\t%s\n" "${f1}" "${f2}" "${f3}" "${f4}" "${f5}"
359 unset f1 f2 f3 f4 f5 f6
360 done < "${DOWNLOAD_TEMP}/index"
363 if [ "${DOWNLOAD_LIST_IMAGES}" = "true" ]; then
370 if [ -z "${DOWNLOAD_DIST}" ]; then
371 echo "Distribution: "
372 read -r DOWNLOAD_DIST
375 if [ -z "${DOWNLOAD_RELEASE}" ]; then
377 read -r DOWNLOAD_RELEASE
380 if [ -z "${DOWNLOAD_ARCH}" ]; then
381 echo "Architecture: "
382 read -r DOWNLOAD_ARCH
389 if [ "${DOWNLOAD_TARGET}" = "system" ]; then
390 LXC_CACHE_BASE
="${LOCALSTATEDIR}/cache/lxc/"
392 LXC_CACHE_BASE
="${HOME}/.cache/lxc/"
395 # Allow the setting of the LXC_CACHE_PATH with the usage of environment variables.
396 LXC_CACHE_PATH
="${LXC_CACHE_PATH:-"${LXC_CACHE_BASE}"}"
397 LXC_CACHE_PATH
="${LXC_CACHE_PATH}/download/${DOWNLOAD_DIST}"
398 LXC_CACHE_PATH
="${LXC_CACHE_PATH}/${DOWNLOAD_RELEASE}/${DOWNLOAD_ARCH}/"
399 LXC_CACHE_PATH
="${LXC_CACHE_PATH}/${DOWNLOAD_VARIANT}"
401 if [ -d "${LXC_CACHE_PATH}" ]; then
402 if [ "${DOWNLOAD_FLUSH_CACHE}" = "true" ]; then
403 echo "Flushing the cache..."
404 rm -Rf "${LXC_CACHE_PATH}"
405 elif [ "${DOWNLOAD_FORCE_CACHE}" = "true" ]; then
406 DOWNLOAD_USE_CACHE
="true"
408 DOWNLOAD_USE_CACHE
="true"
409 if [ -e "$(relevant_file expiry)" ]; then
410 if [ "$(cat "$
(relevant_file expiry
)")" -lt "$(date +%s)" ]; then
411 echo "The cached copy has expired, re-downloading..."
412 DOWNLOAD_USE_CACHE
="false"
418 # Download what's needed
419 if [ "${DOWNLOAD_USE_CACHE}" = "false" ]; then
424 DOWNLOAD_INDEX_PATH
="/meta/1.0/index-${DOWNLOAD_MODE}"
426 echo "Downloading the image index"
427 if ! download_file
"${DOWNLOAD_INDEX_PATH}.${DOWNLOAD_COMPAT_LEVEL}" "${DOWNLOAD_TEMP}/index" noexit ||
428 ! download_sig
"${DOWNLOAD_INDEX_PATH}.${DOWNLOAD_COMPAT_LEVEL}.asc" "${DOWNLOAD_TEMP}/index.asc" noexit
; then
429 download_file
"${DOWNLOAD_INDEX_PATH}" "${DOWNLOAD_TEMP}/index" normal
430 download_sig
"${DOWNLOAD_INDEX_PATH}.asc" "${DOWNLOAD_TEMP}/index.asc" normal
433 gpg_validate
"${DOWNLOAD_TEMP}/index.asc"
436 while IFS
=';' read -r f1 f2 f3 f4 f5 f6
; do
437 if [ "${f1}" != "${DOWNLOAD_DIST}" ] || \
438 [ "${f2}" != "${DOWNLOAD_RELEASE}" ] || \
439 [ "${f3}" != "${DOWNLOAD_ARCH}" ] || \
440 [ "${f4}" != "${DOWNLOAD_VARIANT}" ] || \
445 DOWNLOAD_BUILD
="${f5}"
448 unset f1 f2 f3 f4 f5 f6
450 done < "${DOWNLOAD_TEMP}/index"
452 if [ -z "${DOWNLOAD_URL}" ]; then
453 echo "ERROR: Couldn't find a matching image" 1>&1
457 if [ -d "${LXC_CACHE_PATH}" ] && [ -f "${LXC_CACHE_PATH}/build_id" ] && \
458 [ "$(cat "${LXC_CACHE_PATH}/build_id
")" = "${DOWNLOAD_BUILD}" ]; then
459 echo "The cache is already up to date"
460 echo "Using image from local cache"
462 # Download the actual files
463 echo "Downloading the rootfs"
464 download_file
"${DOWNLOAD_URL}/rootfs.tar.xz" "${DOWNLOAD_TEMP}/rootfs.tar.xz" normal
465 download_sig
"${DOWNLOAD_URL}/rootfs.tar.xz.asc" "${DOWNLOAD_TEMP}/rootfs.tar.xz.asc" normal
466 gpg_validate
"${DOWNLOAD_TEMP}/rootfs.tar.xz.asc"
468 echo "Downloading the metadata"
469 download_file
"${DOWNLOAD_URL}/meta.tar.xz" "${DOWNLOAD_TEMP}/meta.tar.xz" normal
470 download_sig
"$DOWNLOAD_URL/meta.tar.xz.asc" "${DOWNLOAD_TEMP}/meta.tar.xz.asc" normal
471 gpg_validate
"${DOWNLOAD_TEMP}/meta.tar.xz.asc"
473 if [ -d "${LXC_CACHE_PATH}" ]; then
474 rm -Rf "${LXC_CACHE_PATH}"
476 mkdir
-p "${LXC_CACHE_PATH}"
477 mv "${DOWNLOAD_TEMP}/rootfs.tar.xz" "${LXC_CACHE_PATH}"
478 if ! tar Jxf
"${DOWNLOAD_TEMP}/meta.tar.xz" -C "${LXC_CACHE_PATH}"; then
479 echo "ERROR: Invalid rootfs tarball." 2>&1
483 echo "${DOWNLOAD_BUILD}" > "${LXC_CACHE_PATH}/build_id"
485 if [ -n "${LXC_MAPPED_UID}" ] && [ "${LXC_MAPPED_UID}" != "-1" ]; then
486 # As the script is run in strict mode (set -eu), all commands
487 # exiting with non 0 would make the script stop.
488 # || true or || : (more portable) prevents that.
489 chown
-R "${LXC_MAPPED_UID}" "${LXC_CACHE_BASE}" >/dev
/null
2>&1 ||
:
491 if [ -n "${LXC_MAPPED_GID}" ] && [ "${LXC_MAPPED_GID}" != "-1" ]; then
492 chgrp
-R "${LXC_MAPPED_GID}" "${LXC_CACHE_BASE}" >/dev
/null
2>&1 ||
:
494 echo "The image cache is now ready"
497 echo "Using image from local cache"
501 echo "Unpacking the rootfs"
504 excludelist
=$
(relevant_file excludes
)
505 if [ -f "${excludelist}" ]; then
506 while read -r line
; do
507 EXCLUDES
="${EXCLUDES} --exclude=${line}"
508 done < "${excludelist}"
511 # Do not surround ${EXCLUDES} by quotes. This does not work. The solution could
512 # use array but this is not POSIX compliant. The only POSIX compliant solution
513 # is to use a function wrapper, but the latter can't be used here as the args
514 # are dynamic. We thus need to ignore the warning brought by shellcheck.
515 # shellcheck disable=SC2086
516 tar --anchored ${EXCLUDES} --numeric-owner -xpJf "${LXC_CACHE_PATH}/rootfs.tar.xz" -C "${LXC_ROOTFS}"
518 mkdir -p "${LXC_ROOTFS}/dev
/pts
/"
520 # Setup the configuration
521 configfile="$
(relevant_file config
)"
522 fstab="$
(relevant_file fstab
)"
523 if [ ! -e "${configfile}" ]; then
524 echo "ERROR
: meta tarball is missing the configuration
file" 1>&2
528 ## Extract all the network config entries
529 sed -i -e "/lxc.net
.0/{w
${LXC_PATH}/config-network
" -e "d
}" "${LXC_PATH}/config
"
531 ## Extract any other config entry
532 sed -i -e "/lxc.
/{w
${LXC_PATH}/config-auto
" -e "d
}" "${LXC_PATH}/config
"
534 ## Append the defaults
537 echo "# Distribution configuration"
539 } >> "${LXC_PATH}/config"
541 ## Add the container-specific config
544 echo "# Container specific configuration"
545 if [ -e "${LXC_PATH}/config-auto" ]; then
546 cat "${LXC_PATH}/config-auto"
547 rm "${LXC_PATH}/config-auto"
549 if [ -e "${fstab}" ]; then
550 echo "lxc.mount.fstab = ${LXC_PATH}/fstab"
552 echo "lxc.uts.name = ${LXC_NAME}"
553 } >> "${LXC_PATH}/config"
555 ## Re-add the previously removed network config
556 if [ -e "${LXC_PATH}/config-network" ]; then
559 echo "# Network configuration"
560 cat "${LXC_PATH}/config-network"
561 rm "${LXC_PATH}/config-network"
562 } >> "${LXC_PATH}/config"
565 TEMPLATE_FILES
="${LXC_PATH}/config"
568 if [ -e "${fstab}" ]; then
569 cp "${fstab}" "${LXC_PATH}/fstab"
570 TEMPLATE_FILES
="${TEMPLATE_FILES};${LXC_PATH}/fstab"
573 # Look for extra templates
574 if [ -e "$(relevant_file templates)" ]; then
575 while read -r line
; do
576 fullpath
="${LXC_ROOTFS}/${line}"
577 [ ! -e "${fullpath}" ] && continue
578 TEMPLATE_FILES
="${TEMPLATE_FILES};${fullpath}"
579 done < "$(relevant_file templates)"
582 # Replace variables in all templates
585 for file in ${TEMPLATE_FILES}; do
586 [ ! -f "${file}" ] && continue
587 sed -i "s#LXC_NAME#${LXC_NAME}#g" "${file}"
588 sed -i "s#LXC_PATH#${LXC_PATH}#g" "${file}"
589 sed -i "s#LXC_ROOTFS#${LXC_ROOTFS}#g" "${file}"
590 sed -i "s#LXC_TEMPLATE_CONFIG#${LXC_TEMPLATE_CONFIG}#g" "${file}"
591 sed -i "s#LXC_HOOK_DIR#${LXC_HOOK_DIR}#g" "${file}"
595 # prevent mingetty from calling vhangup(2) since it fails with userns on CentOS / Oracle
596 if [ -f "${LXC_ROOTFS}/etc/init/tty.conf" ]; then
597 sed -i 's|mingetty|mingetty --nohangup|' "${LXC_ROOTFS}/etc/init/tty.conf"
600 if [ -n "${LXC_MAPPED_UID}" ] && [ "${LXC_MAPPED_UID}" != "-1" ]; then
601 chown
"${LXC_MAPPED_UID}" "${LXC_PATH}/config" "${LXC_PATH}/fstab" >/dev
/null
2>&1 ||
:
604 if [ -n "${LXC_MAPPED_GID}" ] && [ "${LXC_MAPPED_GID}" != "-1" ]; then
605 chgrp
"${LXC_MAPPED_GID}" "${LXC_PATH}/config" "${LXC_PATH}/fstab" >/dev
/null
2>&1 ||
:
608 if [ -e "$(relevant_file create-message)" ]; then
611 cat "$(relevant_file create-message)"