Merge branch 'debian'
[live-boot-grml.git] / scripts / live-helpers
index fbf61fe..3109356 100644 (file)
@@ -1,4 +1,4 @@
-# live-initramfs helper functions, used by live-initramfs on boot and by live-snapshot
+# live-boot helper functions, used by live-boot on boot and by live-snapshot
 
 if [ ! -x "/bin/fstype" ]
 then
@@ -26,7 +26,7 @@ subdevices ()
        sysblock=${1}
        r=""
 
-       for dev in "${sysblock}" "${sysblock}"/*
+       for dev in "${sysblock}"/* "${sysblock}"
        do
                if [ -e "${dev}/dev" ]
                then
@@ -37,6 +37,38 @@ subdevices ()
        echo ${r}
 }
 
+storage_devices()
+{
+       black_listed_devices="${1}"
+       white_listed_devices="${2}"
+
+       for sysblock in $(echo /sys/block/* | tr ' ' '\n' | grep -vE "loop|ram|fd")
+       do
+               fulldevname=$(sys2dev "${sysblock}")
+
+               if echo "${black_listed_devices}" | grep -qe "\<${fulldevname}\>" || \
+                       [ -n "${white_listed_devices}" ] && \
+                       echo "${white_listed_devices}" | grep -qve "\<${fulldevname}\>"
+               then
+                       # skip this device entirely
+                       continue
+               fi
+
+               for dev in $(subdevices "${sysblock}")
+               do
+                       devname=$(sys2dev "${dev}")
+
+                       if echo "${black_listed_devices}" | grep -qe "\<${devname}\>"
+                       then
+                               # skip this subdevice
+                               continue
+                       else
+                               echo "${devname}"
+                       fi
+               done
+       done
+}
+
 is_supported_fs ()
 {
        fstype="${1}"
@@ -76,25 +108,7 @@ is_supported_fs ()
 
 get_fstype ()
 {
-       local FSTYPE
-       local FSSIZE
-
-       # fstype misreports LUKS devices
-       if is_luks "${1}"
-       then
-           /lib/udev/vol_id -t ${1} 2>/dev/null
-           return
-       fi
-
-       eval $(fstype ${1} 2>/dev/null)
-
-       if [ "${FSTYPE}" != "unknown" ]
-       then
-               echo ${FSTYPE}
-               return 0
-       fi
-
-       /lib/udev/vol_id -t ${1} 2>/dev/null
+       /sbin/blkid -s TYPE -o value $1 2>/dev/null
 }
 
 where_is_mounted ()
@@ -197,16 +211,13 @@ setup_loop ()
        local encryption=${5}
        local readonly=${6}
 
-       modprobe -q -b "${module}"
+       # the output of setup_loop is evaluated in other functions,
+       # modprobe leaks kernel options like "libata.dma=0"
+       # as "options libata dma=0" on stdout, causing serious
+       # problems therefor, so instead always avoid output to stdout
+       modprobe -q -b "${module}" 1>/dev/null
 
-       if [ -x /sbin/udevadm ]
-       then
-               # lenny
-               udevadm settle
-       else
-               # etch
-               udevsettle
-       fi
+       udevadm settle
 
        for loopdev in ${pattern}
        do
@@ -223,7 +234,7 @@ setup_loop ()
                                fi
                        fi
 
-                       if [ 0 -lt "${offset}" ]
+                       if [ -n "${offset}" ] && [ 0 -lt "${offset}" ]
                        then
                                options="${options} -o ${offset}"
                        fi
@@ -295,154 +306,153 @@ try_mount ()
                then
                        fstype=$(get_fstype "${dev}")
                fi
-               mount -t "${fstype}" -o "${opts}" "${dev}" "${mountp}" || panic "Cannot mount ${dev} on ${mountp}, fstype=${fstype}, options=${opts}"
+               mount -t "${fstype}" -o "${opts}" "${dev}" "${mountp}" || \
+               ( echo "SKIPPING: Cannot mount ${dev} on ${mountp}, fstype=${fstype}, options=${opts}" > live-boot.log && return 0 )
        fi
 }
 
-find_cow_device ()
+open_luks_device ()
 {
-       # Returns a device containing a partition labeled "${pers_label}" or containing a file named the same way
-       #  in the latter case the partition containing the file is left mounted
-       #  if is not in black_listed_devices
-       pers_label="${1}"
-       cow_backing="/${pers_label}-backing"
-       black_listed_devices="${2}"
-
-       if [ -z "${PERSISTENT_PATH}" ]
+       dev="${1}"
+       name="$(basename ${dev})"
+       opts="--key-file=-"
+       if [ -n "${PERSISTENT_READONLY}" ]
        then
-               pers_fpath=${cow_backing}/${pers_label}
-       else
-               pers_fpath=${cow_backing}/${PERSISTENT_PATH}/${pers_label}
+               opts="${opts} --readonly"
        fi
 
-       for sysblock in $(echo /sys/block/* | tr ' ' '\n' | grep -v loop | grep -v ram | grep -v fd)
-       do
-               for dev in $(subdevices "${sysblock}")
-               do
-                       devname=$(sys2dev "${dev}")
-
-                       if echo "${black_listed_devices}" | grep -q "${devname}"
-                       then
-                               # skip this device enterely
-                               break
-                       fi
-
-                       # Checking for a luks device
-                       if [ -e /sbin/cryptsetup ] && /sbin/cryptsetup isLuks ${devname}
-                       then
-                               while true
-                               do
-                                       load_keymap
-
-                                       echo -n "Enter passphrase for ${pers_label} on ${devname}: " >&6
-                                       read -s passphrase
-                                       echo "${passphrase}" > /tmp/passphrase
-                                       unset passphrase
-                                       exec 9</tmp/passphrase
-                                       /sbin/cryptsetup luksOpen ${devname} $(basename ${devname})
-                                       error=${?}
-                                       exec 9<&-
-                                       rm -f /tmp/passphrase
-
-                                       devname="/dev/mapper/$(basename ${devname})"
-
-                                       if [ 0 -eq ${error} ]
-                                       then
-                                               unset error
-                                               break
-                                       fi
-
-                                       echo
-                                       echo -n "There was an error decrypting ${devname} ... Retry? [Y/n] " >&6
-                                       read answer
-
-                                       if [ "$(echo "${answer}" | cut -b1 | tr A-Z a-z)" = "n" ]
-                                       then
-                                               unset answer
-                                               break
-                                       fi
-                               done
-                       fi
+       load_keymap
 
-                       if [ "$(/lib/udev/vol_id -l ${devname} 2>/dev/null)" = "${pers_label}" ]
-                       then
-                               echo "${devname}"
-                               return 0
-                       fi
+       while true
+       do
+               /lib/cryptsetup/askpass "Enter passphrase for ${dev}: " | \
+                       /sbin/cryptsetup -T 1 luksOpen ${dev} ${name} ${opts}
 
-                       if [ "${PERSISTENT}" = "nofiles" ]
-                       then
-                               # do not mount the device to find for image files
-                               # just skip this
-                               break
-                       fi
+               if [ 0 -eq ${?} ]
+               then
+                       luks_device="/dev/mapper/${name}"
+                       echo ${luks_device}
+                       return 0
+               fi
 
-                       case "$(get_fstype ${devname})" in
-                               vfat|ext2|ext3|ext4|jffs2)
-                                       mkdir -p "${cow_backing}"
-                                       if ! try_mount "${devname}" "${cow_backing}" "rw"
-                                       then
-                                               break
-                                       fi
+               echo >&6
+               echo -n "There was an error decrypting ${dev} ... Retry? [Y/n] " >&6
+               read answer
 
-                                       if [ -f "${pers_fpath}" ]
-                                       then
-                                               echo $(setup_loop "${pers_fpath}" "loop" "/sys/block/loop*")
-                                               return 0
-                                       else
-                                               umount ${cow_backing}
-                                       fi
-                                       ;;
-                               *)
-                                       ;;
-                       esac
-               done
+               if [ "$(echo "${answer}" | cut -b1 | tr A-Z a-z)" = "n" ]
+               then
+                       return 2
+               fi
        done
-       return 1
 }
 
-find_files ()
+find_persistent_media ()
 {
-       # return the a string composed by device name, mountpoint an the first of ${filenames} found on a supported partition
-       # FIXME: merge with above function
-
-       filenames="${1}"
-       snap_backing="/snap-backing"
-       black_listed_devices="${2}"
-
-       for sysblock in $(echo /sys/block/* | tr ' ' '\n' | grep -v loop | grep -v ram | grep -v fd)
+       # Scans devices for overlays and snapshots, and returns a whitespace
+       # separated list of how to use them. Only overlays with a partition
+       # label or file name in ${overlays} are returned, and ditto for
+       # snapshots with labels in ${snapshots}.
+       #
+       # When scanning a LUKS device, the user will be asked to enter the
+       # passphrase; on failure to enter it, or if no persistent partitions
+       # or files were found, the LUKS device is closed.
+       #
+       # For a snapshot file the return value is ${label}=${snapdata}", where
+       # ${snapdata} is the parameter used for try_snap().
+       #
+       # For all other cases (overlay/snapshot partition and overlay file) the
+       # return value is "${label}=${device}", where ${device} a device that
+       # can mount the content. In the case of an overlay file, the device
+       # containing the file will remain mounted as a side-effect.
+       #
+       # No devices in ${black_listed_devices} will be scanned, and if
+       # ${white_list_devices} is non-empty, only devices in it will be
+       # scanned.
+
+       overlays="${1}"
+       snapshots="${2}"
+       black_listed_devices="${3}"
+       white_listed_devices="${4}"
+
+       for dev in $(storage_devices "${black_listed_devices}" "${white_listed_devices}")
        do
-               for dev in $(subdevices "${sysblock}")
-               do
-                       devname=$(sys2dev "${dev}")
-                       devfstype="$(get_fstype ${devname})"
+               luks_device=""
 
-                       if echo "${black_listed_devices}" | grep -q "${devname}"
+               # Checking for a luks device
+               if echo ${PERSISTENT_ENCRYPTION} | grep -qe "\<luks\>" && \
+                  /sbin/cryptsetup isLuks ${dev}
+               then
+                       if luks_device=$(open_luks_device "${dev}")
                        then
-                               # skip this device enterely
-                               break
+                               dev="${luks_device}"
+                       else
+                               # skip $dev since we failed/chose not to open it
+                               continue
                        fi
+               elif echo ${PERSISTENT_ENCRYPTION} | grep -qve "\<none\>"
+               then
+                       # skip $dev since we don't allow unencrypted storage
+                       continue
+               fi
+
+               if echo ${PERSISTENT_STORAGE} | grep -qe "\<filesystem\>"
+               then
+                       for label in ${overlays} ${snapshots}
+                       do
+                               if [ "$(/sbin/blkid -s LABEL -o value $dev 2>/dev/null)" = "${label}" ]
+                               then
+                                       overlays=$(echo ${overlays} | sed -e "s|\<${label}\>||")
+                                       snapshots=$(echo ${snapshots} | sed -e "s|\<${label}\>||")
+                                       echo "${label}=${dev}"
+                                       # skip to the next device
+                                       continue 2
+                               fi
+                       done
+               fi
 
-                       if is_supported_fs ${devfstype}
+               if echo ${PERSISTENT_STORAGE} | grep -qe "\<file\>"
+               then
+                       devfstype="$(get_fstype ${dev})"
+                       overlay_on_dev=""
+                       snapshot_on_dev=""
+                       backing="/$(basename ${dev})-backing"
+                       mkdir -p "${backing}"
+                       if is_supported_fs ${devfstype} && try_mount "${dev}" "${backing}" "rw" "${devfstype}"
                        then
-                               mkdir -p "${snap_backing}"
+                               for label in ${overlays}
+                               do
+                                       path=${backing}/${PERSISTENT_PATH}${label}
+                                       if [ -f "${path}" ]
+                                       then
+                                               overlays=$(echo ${overlays} | sed -e "s|\<${label}\>||")
+                                               overlay_on_dev="yes"
+                                               echo "${label}=$(setup_loop "${path}" "loop" "/sys/block/loop*")"
+                                       fi
+                               done
 
-                               if try_mount "${devname}" "${snap_backing}" "ro" "${devfstype}"
-                               then
-                                       for filename in ${filenames}
+                               for label in ${snapshots}
+                               do
+                                       for ext in squashfs cpio.gz ext2 ext3 ext4 jffs2
                                        do
-                                               if [ -f "${snap_backing}/${filename}" ]
+                                               path="${PERSISTENT_PATH}${label}.${ext}"
+                                               if [ -f "${backing}/${path}" ]
                                                then
-                                                       echo "${devname} ${snap_backing} ${filename}"
-                                                       umount ${snap_backing}
-                                                       return 0
+                                                       snapshots=$(echo ${snapshots} | sed -e "s|\<${label}\>||")
+                                                       snapshot_on_dev="yes"
+                                                       echo "${label}=${dev}:${backing}:${path}"
                                                fi
                                        done
+                               done
+                       fi
+                       if [ -z "${overlay_on_dev}" ]
+                       then
+                               umount ${backing} > /dev/null 2>&1 || true
+                               if [ -z "${snapshot_on_dev}" ] && [ -n "${luks_device}" ] && /sbin/cryptsetup status "${luks_device}" 1> /dev/null
+                               then
+                                       /sbin/cryptsetup luksClose "${luks_device}"
                                fi
-
-                               umount ${snap_backing}
                        fi
-               done
+               fi
        done
 }
 
@@ -476,3 +486,73 @@ is_luks()
     fi
 
 }
+
+removable_dev ()
+{
+       output_format="${1}"
+       want_usb="${2}"
+       ret=
+
+       for sysblock in $(echo /sys/block/* | tr ' ' '\n' | grep -vE "/(loop|ram|dm-|fd)")
+       do
+               dev_ok=
+               if [ "$(cat ${sysblock}/removable)" = "1" ]
+               then
+                       if [ -z "${want_usb}" ]
+                       then
+                               dev_ok="yes"
+                       else
+                               if readlink ${sysblock} | grep -q usb
+                               then
+                                       dev_ok="yes"
+                               fi
+                       fi
+               fi
+
+               if [ "${dev_ok}" = "yes" ]
+               then
+                       case "${output_format}" in
+                               sys)
+                                       ret="${ret} ${sysblock}"
+                                       ;;
+                               *)
+                                       devname=$(sys2dev "${sysblock}")
+                                       ret="${ret} ${devname}"
+                                       ;;
+                       esac
+               fi
+       done
+
+       echo "${ret}"
+}
+
+removable_usb_dev ()
+{
+       output_format="${1}"
+
+       removable_dev "${output_format}" "want_usb"
+}
+
+non_removable_dev ()
+{
+       output_format="${1}"
+       ret=
+
+       for sysblock in $(echo /sys/block/* | tr ' ' '\n' | grep -vE "/(loop|ram|dm-|fd)")
+       do
+               if [ "$(cat ${sysblock}/removable)" = "0" ]
+               then
+                       case "${output_format}" in
+                               sys)
+                                       ret="${ret} ${sysblock}"
+                                       ;;
+                               *)
+                                       devname=$(sys2dev "${sysblock}")
+                                       ret="${ret} ${devname}"
+                                       ;;
+                       esac
+               fi
+       done
+
+       echo "${ret}"
+}