scripts/live-helpers

   1 # live-boot helper functions, used by live-boot on boot and by live-snapshot
   2
   3 if [ ! -x "/bin/fstype" ]
   4 then
   5         # klibc not in path -> not in initramfs
   6         export PATH="${PATH}:/usr/lib/klibc/bin"
   7 fi
   8
   9 # handle upgrade path from old udev (using udevinfo) to
  10 # recent versions of udev (using udevadm info)
  11 if [ -x /sbin/udevadm ]
  12 then
  13         udevinfo='/sbin/udevadm info'
  14 else
  15         udevinfo='udevinfo'
  16 fi
  17
  18 sys2dev ()
  19 {
  20         sysdev=${1#/sys}
  21         echo "/dev/$($udevinfo -q name -p ${sysdev} 2>/dev/null|| echo ${sysdev##*/})"
  22 }
  23
  24 subdevices ()
  25 {
  26         sysblock=${1}
  27         r=""
  28
  29         for dev in "${sysblock}"/* "${sysblock}"
  30         do
  31                 if [ -e "${dev}/dev" ]
  32                 then
  33                         r="${r} ${dev}"
  34                 fi
  35         done
  36
  37         echo ${r}
  38 }
  39
  40 storage_devices()
  41 {
  42         black_listed_devices="${1}"
  43         white_listed_devices="${2}"
  44
  45         for sysblock in $(echo /sys/block/* | tr ' ' '\n' | grep -vE "loop|ram|fd")
  46         do
  47                 fulldevname=$(sys2dev "${sysblock}")
  48
  49                 if echo "${black_listed_devices}" | grep -qe "\<${fulldevname}\>" || \
  50                         [ -n "${white_listed_devices}" ] && \
  51                         echo "${white_listed_devices}" | grep -qve "\<${fulldevname}\>"
  52                 then
  53                         # skip this device entirely
  54                         continue
  55                 fi
  56
  57                 for dev in $(subdevices "${sysblock}")
  58                 do
  59                         devname=$(sys2dev "${dev}")
  60
  61                         if echo "${black_listed_devices}" | grep -qe "\<${devname}\>"
  62                         then
  63                                 # skip this subdevice
  64                                 continue
  65                         else
  66                                 echo "${devname}"
  67                         fi
  68                 done
  69         done
  70 }
  71
  72 is_supported_fs ()
  73 {
  74         fstype="${1}"
  75
  76         # Validate input first
  77         if [ -z "${fstype}" ]
  78         then
  79                 return 1
  80         fi
  81
  82         # Try to look if it is already supported by the kernel
  83         if grep -q ${fstype} /proc/filesystems
  84         then
  85                 return 0
  86         else
  87                 # Then try to add support for it the gentle way using the initramfs capabilities
  88                 modprobe ${fstype}
  89                 if grep -q ${fstype} /proc/filesystems
  90                 then
  91                         return 0
  92                 # Then try the hard way if /root is already reachable
  93                 else
  94                         kmodule="/root/lib/modules/`uname -r`/${fstype}/${fstype}.ko"
  95                         if [ -e "${kmodule}" ]
  96                         then
  97                                 insmod "${kmodule}"
  98                                 if grep -q ${fstype} /proc/filesystems
  99                                 then
 100                                         return 0
 101                                 fi
 102                         fi
 103                 fi
 104         fi
 105
 106         return 1
 107 }
 108
 109 get_fstype ()
 110 {
 111         /sbin/blkid -s TYPE -o value $1 2>/dev/null
 112 }
 113
 114 where_is_mounted ()
 115 {
 116         device=${1}
 117
 118         if grep -q "^${device} " /proc/mounts
 119         then
 120                 # return the first found
 121                 grep -m1 "^${device} " /proc/mounts | cut -f2 -d ' '
 122         fi
 123 }
 124
 125 lastline ()
 126 {
 127         while read lines
 128         do
 129                 line=${lines}
 130         done
 131
 132         echo "${line}"
 133 }
 134
 135 base_path ()
 136 {
 137         testpath="${1}"
 138         mounts="$(awk '{print $2}' /proc/mounts)"
 139         testpath="$(busybox realpath ${testpath})"
 140
 141         while true
 142         do
 143                 if echo "${mounts}" | grep -qs "^${testpath}"
 144                 then
 145                         set -- $(echo "${mounts}" | grep "^${testpath}" | lastline)
 146                         echo ${1}
 147                         break
 148                 else
 149                         testpath=$(dirname $testpath)
 150                 fi
 151         done
 152 }
 153
 154 fs_size ()
 155 {
 156         # Returns used/free fs kbytes + 5% more
 157         # You could pass a block device as ${1} or the mount point as ${2}
 158
 159         dev="${1}"
 160         mountp="${2}"
 161         used="${3}"
 162
 163         if [ -z "${mountp}" ]
 164         then
 165                 mountp="$(where_is_mounted ${dev})"
 166
 167                 if [ -z "${mountp}" ]
 168                 then
 169                         mountp="/mnt/tmp_fs_size"
 170
 171                         mkdir -p "${mountp}"
 172                         mount -t $(get_fstype "${dev}") -o ro "${dev}" "${mountp}" || log_warning_msg "cannot mount -t $(get_fstype ${dev}) -o ro ${dev} ${mountp}"
 173
 174                         doumount=1
 175                 fi
 176         fi
 177
 178         if [ "${used}" = "used" ]
 179         then
 180                 size=$(du -ks ${mountp} | cut -f1)
 181                 size=$(expr ${size} + ${size} / 20 ) # FIXME: 5% more to be sure
 182         else
 183                 # free space
 184                 size="$(df -k | grep -s ${mountp} | awk '{print $4}')"
 185         fi
 186
 187         if [ -n "${doumount}" ]
 188         then
 189                 umount "${mountp}" || log_warning_msg "cannot umount ${mountp}"
 190                 rmdir "${mountp}"
 191         fi
 192
 193         echo "${size}"
 194 }
 195
 196 load_keymap ()
 197 {
 198         # Load custom keymap
 199         if [ -x /bin/loadkeys -a -r /etc/boottime.kmap.gz ]
 200         then
 201                 loadkeys /etc/boottime.kmap.gz
 202         fi
 203 }
 204
 205 setup_loop ()
 206 {
 207         local fspath=${1}
 208         local module=${2}
 209         local pattern=${3}
 210         local offset=${4}
 211         local encryption=${5}
 212         local readonly=${6}
 213
 214         # the output of setup_loop is evaluated in other functions,
 215         # modprobe leaks kernel options like "libata.dma=0"
 216         # as "options libata dma=0" on stdout, causing serious
 217         # problems therefor, so instead always avoid output to stdout
 218         modprobe -q -b "${module}" 1>/dev/null
 219
 220         udevadm settle
 221
 222         for loopdev in ${pattern}
 223         do
 224                 if [ "$(cat ${loopdev}/size)" -eq 0 ]
 225                 then
 226                         dev=$(sys2dev "${loopdev}")
 227                         options=''
 228
 229                         if [ -n "${readonly}" ]
 230                         then
 231                                 if losetup --help 2>&1 | grep -q -- "-r\b"
 232                                 then
 233                                         options="${options} -r"
 234                                 fi
 235                         fi
 236
 237                         if [ -n "${offset}" ] && [ 0 -lt "${offset}" ]
 238                         then
 239                                 options="${options} -o ${offset}"
 240                         fi
 241
 242                         if [ -z "${encryption}" ]
 243                         then
 244                                 losetup ${options} "${dev}" "${fspath}"
 245                         else
 246                                 # Loop AES encryption
 247                                 while true
 248                                 do
 249                                         load_keymap
 250
 251                                         echo -n "Enter passphrase for root filesystem: " >&6
 252                                         read -s passphrase
 253                                         echo "${passphrase}" > /tmp/passphrase
 254                                         unset passphrase
 255                                         exec 9</tmp/passphrase
 256                                         /sbin/losetup ${options} -e "${encryption}" -p 9 "${dev}" "${fspath}"
 257                                         error=${?}
 258                                         exec 9<&-
 259                                         rm -f /tmp/passphrase
 260
 261                                         if [ 0 -eq ${error} ]
 262                                         then
 263                                                 unset error
 264                                                 break
 265                                         fi
 266
 267                                         echo
 268                                         echo -n "There was an error decrypting the root filesystem ... Retry? [Y/n] " >&6
 269                                         read answer
 270
 271                                         if [ "$(echo "${answer}" | cut -b1 | tr A-Z a-z)" = "n" ]
 272                                         then
 273                                                 unset answer
 274                                                 break
 275                                         fi
 276                                 done
 277                         fi
 278
 279                         echo "${dev}"
 280                         return 0
 281                 fi
 282         done
 283
 284         panic "No loop devices available"
 285 }
 286
 287 try_mount ()
 288 {
 289         dev="${1}"
 290         mountp="${2}"
 291         opts="${3}"
 292         fstype="${4}"
 293
 294         old_mountp="$(where_is_mounted ${dev})"
 295
 296         if [ -n "${old_mountp}" ]
 297         then
 298                 if [ "${opts}" != "ro" ]
 299                 then
 300                         mount -o remount,"${opts}" "${dev}" "${old_mountp}" || panic "Remounting ${dev} ${opts} on ${old_mountp} failed"
 301                 fi
 302
 303                 mount -o bind "${old_mountp}" "${mountp}" || panic "Cannot bind-mount ${old_mountp} on ${mountp}"
 304         else
 305                 if [ -z "${fstype}" ]
 306                 then
 307                         fstype=$(get_fstype "${dev}")
 308                 fi
 309                 mount -t "${fstype}" -o "${opts}" "${dev}" "${mountp}" || \
 310                 ( echo "SKIPPING: Cannot mount ${dev} on ${mountp}, fstype=${fstype}, options=${opts}" > live-boot.log && return 0 )
 311         fi
 312 }
 313
 314 open_luks_device ()
 315 {
 316         dev="${1}"
 317         name="$(basename ${dev})"
 318         opts="--key-file=-"
 319         if [ -n "${PERSISTENT_READONLY}" ]
 320         then
 321                 opts="${opts} --readonly"
 322         fi
 323
 324         load_keymap
 325
 326         while true
 327         do
 328                 /lib/cryptsetup/askpass "Enter passphrase for ${dev}: " | \
 329                         /sbin/cryptsetup -T 1 luksOpen ${dev} ${name} ${opts}
 330
 331                 if [ 0 -eq ${?} ]
 332                 then
 333                         luks_device="/dev/mapper/${name}"
 334                         echo ${luks_device}
 335                         return 0
 336                 fi
 337
 338                 echo >&6
 339                 echo -n "There was an error decrypting ${dev} ... Retry? [Y/n] " >&6
 340                 read answer
 341
 342                 if [ "$(echo "${answer}" | cut -b1 | tr A-Z a-z)" = "n" ]
 343                 then
 344                         return 2
 345                 fi
 346         done
 347 }
 348
 349 find_persistent_media ()
 350 {
 351         # Scans devices for overlays and snapshots, and returns a whitespace
 352         # separated list of how to use them. Only overlays with a partition
 353         # label or file name in ${overlays} are returned, and ditto for
 354         # snapshots with labels in ${snapshots}.
 355         #
 356         # When scanning a LUKS device, the user will be asked to enter the
 357         # passphrase; on failure to enter it, or if no persistent partitions
 358         # or files were found, the LUKS device is closed.
 359         #
 360         # For a snapshot file the return value is ${label}=${snapdata}", where
 361         # ${snapdata} is the parameter used for try_snap().
 362         #
 363         # For all other cases (overlay/snapshot partition and overlay file) the
 364         # return value is "${label}=${device}", where ${device} a device that
 365         # can mount the content. In the case of an overlay file, the device
 366         # containing the file will remain mounted as a side-effect.
 367         #
 368         # No devices in ${black_listed_devices} will be scanned, and if
 369         # ${white_list_devices} is non-empty, only devices in it will be
 370         # scanned.
 371
 372         overlays="${1}"
 373         snapshots="${2}"
 374         black_listed_devices="${3}"
 375         white_listed_devices="${4}"
 376
 377         for dev in $(storage_devices "${black_listed_devices}" "${white_listed_devices}")
 378         do
 379                 luks_device=""
 380
 381                 # Checking for a luks device
 382                 if echo ${PERSISTENT_ENCRYPTION} | grep -qe "\<luks\>" && \
 383                    /sbin/cryptsetup isLuks ${dev}
 384                 then
 385                         if luks_device=$(open_luks_device "${dev}")
 386                         then
 387                                 dev="${luks_device}"
 388                         else
 389                                 # skip $dev since we failed/chose not to open it
 390                                 continue
 391                         fi
 392                 elif echo ${PERSISTENT_ENCRYPTION} | grep -qve "\<none\>"
 393                 then
 394                         # skip $dev since we don't allow unencrypted storage
 395                         continue
 396                 fi
 397
 398                 if echo ${PERSISTENT_STORAGE} | grep -qe "\<filesystem\>"
 399                 then
 400                         for label in ${overlays} ${snapshots}
 401                         do
 402                                 if [ "$(/sbin/blkid -s LABEL -o value $dev 2>/dev/null)" = "${label}" ]
 403                                 then
 404                                         overlays=$(echo ${overlays} | sed -e "s|\<${label}\>||")
 405                                         snapshots=$(echo ${snapshots} | sed -e "s|\<${label}\>||")
 406                                         echo "${label}=${dev}"
 407                                         # skip to the next device
 408                                         continue 2
 409                                 fi
 410                         done
 411                 fi
 412
 413                 if echo ${PERSISTENT_STORAGE} | grep -qe "\<file\>"
 414                 then
 415                         devfstype="$(get_fstype ${dev})"
 416                         overlay_on_dev=""
 417                         snapshot_on_dev=""
 418                         backing="/$(basename ${dev})-backing"
 419                         mkdir -p "${backing}"
 420                         if is_supported_fs ${devfstype} && try_mount "${dev}" "${backing}" "rw" "${devfstype}"
 421                         then
 422                                 for label in ${overlays}
 423                                 do
 424                                         path=${backing}/${PERSISTENT_PATH}${label}
 425                                         if [ -f "${path}" ]
 426                                         then
 427                                                 overlays=$(echo ${overlays} | sed -e "s|\<${label}\>||")
 428                                                 overlay_on_dev="yes"
 429                                                 echo "${label}=$(setup_loop "${path}" "loop" "/sys/block/loop*")"
 430                                         fi
 431                                 done
 432
 433                                 for label in ${snapshots}
 434                                 do
 435                                         for ext in squashfs cpio.gz ext2 ext3 ext4 jffs2
 436                                         do
 437                                                 path="${PERSISTENT_PATH}${label}.${ext}"
 438                                                 if [ -f "${backing}/${path}" ]
 439                                                 then
 440                                                         snapshots=$(echo ${snapshots} | sed -e "s|\<${label}\>||")
 441                                                         snapshot_on_dev="yes"
 442                                                         echo "${label}=${dev}:${backing}:${path}"
 443                                                 fi
 444                                         done
 445                                 done
 446                         fi
 447                         if [ -z "${overlay_on_dev}" ]
 448                         then
 449                                 umount ${backing} > /dev/null 2>&1 || true
 450                                 if [ -z "${snapshot_on_dev}" ] && [ -n "${luks_device}" ] && /sbin/cryptsetup status "${luks_device}" 1> /dev/null
 451                                 then
 452                                         /sbin/cryptsetup luksClose "${luks_device}"
 453                                 fi
 454                         fi
 455                 fi
 456         done
 457 }
 458
 459 get_mac ()
 460 {
 461         mac=""
 462
 463         for adaptor in /sys/class/net/*
 464         do
 465                 status="$(cat ${adaptor}/iflink)"
 466
 467                 if [ "${status}" -eq 2 ]
 468                 then
 469                         mac="$(cat ${adaptor}/address)"
 470                         mac="$(echo ${mac} | sed 's/:/-/g' | tr '[a-z]' '[A-Z]')"
 471                 fi
 472         done
 473
 474         echo ${mac}
 475 }
 476
 477 is_luks()
 478 {
 479     devname="${1}"
 480     if [ -x /sbin/cryptsetup ]
 481     then
 482         /sbin/cryptsetup isLuks "${devname}" 2>/dev/null || ret=${?}
 483         return ${ret}
 484     else
 485         return 1
 486     fi
 487
 488 }
 489
 490 removable_dev ()
 491 {
 492         output_format="${1}"
 493         want_usb="${2}"
 494         ret=
 495
 496         for sysblock in $(echo /sys/block/* | tr ' ' '\n' | grep -vE "/(loop|ram|dm-|fd)")
 497         do
 498                 dev_ok=
 499                 if [ "$(cat ${sysblock}/removable)" = "1" ]
 500                 then
 501                         if [ -z "${want_usb}" ]
 502                         then
 503                                 dev_ok="yes"
 504                         else
 505                                 if readlink ${sysblock} | grep -q usb
 506                                 then
 507                                         dev_ok="yes"
 508                                 fi
 509                         fi
 510                 fi
 511
 512                 if [ "${dev_ok}" = "yes" ]
 513                 then
 514                         case "${output_format}" in
 515                                 sys)
 516                                         ret="${ret} ${sysblock}"
 517                                         ;;
 518                                 *)
 519                                         devname=$(sys2dev "${sysblock}")
 520                                         ret="${ret} ${devname}"
 521                                         ;;
 522                         esac
 523                 fi
 524         done
 525
 526         echo "${ret}"
 527 }
 528
 529 removable_usb_dev ()
 530 {
 531         output_format="${1}"
 532
 533         removable_dev "${output_format}" "want_usb"
 534 }
 535
 536 non_removable_dev ()
 537 {
 538         output_format="${1}"
 539         ret=
 540
 541         for sysblock in $(echo /sys/block/* | tr ' ' '\n' | grep -vE "/(loop|ram|dm-|fd)")
 542         do
 543                 if [ "$(cat ${sysblock}/removable)" = "0" ]
 544                 then
 545                         case "${output_format}" in
 546                                 sys)
 547                                         ret="${ret} ${sysblock}"
 548                                         ;;
 549                                 *)
 550                                         devname=$(sys2dev "${sysblock}")
 551                                         ret="${ret} ${devname}"
 552                                         ;;
 553                         esac
 554                 fi
 555         done
 556
 557         echo "${ret}"
 558 }