X-Git-Url: http://git.grml.org/?p=grml2usb.git;a=blobdiff_plain;f=grml2usb;h=db067d4d8964671a33379dfc2bf99a6c8bdd102e;hp=e465ebe2528a12fd1a9781b21d07274877289261;hb=25c3bf7f43e285c2a6ab997a44efd8d21a514207;hpb=9cbb2312cb49156f1daa60e1a9f91d0516dc68e3 diff --git a/grml2usb b/grml2usb index e465ebe..db067d4 100755 --- a/grml2usb +++ b/grml2usb @@ -1,4 +1,4 @@ -#!/usr/bin/env python +#!/usr/bin/env python3 # -*- coding: utf-8 -*- # pylint: disable-msg=C0302 """ @@ -7,13 +7,13 @@ grml2usb This script installs a Grml system (either a running system or ISO[s]) to a USB device -:copyright: (c) 2009, 2010, 2011 by Michael Prokop +:copyright: (c) 2009-2019 by Michael Prokop :license: GPL v2 or any later version :bugreports: http://grml.org/bugs/ """ -from __future__ import print_function + from optparse import OptionParser from inspect import isroutine, isclass import datetime @@ -32,7 +32,22 @@ import uuid import shutil # The line following this line is patched by debian/rules and tarball.sh. -PROG_VERSION = '***UNRELEASED***' +PROG_VERSION = '***UNKNOWN***' + +# when running from inside git, try to report version information via git-describe +try: + git_dir = os.path.abspath(os.path.dirname(sys.argv[0])) + with open(os.devnull, 'w') as devnull: + PROG_VERSION = subprocess.check_output(["git", + "-C", + git_dir, + "describe", + "--always", + "--dirty"], + stderr=devnull).strip().decode('utf-8', errors='replace') + \ + " (git)" +except Exception: + pass # global variables MOUNTED = set() # register mountpoints @@ -41,8 +56,8 @@ DATESTAMP = time.mktime(datetime.datetime.now().timetuple()) # unique identifie GRML_FLAVOURS = set() # which flavours are being installed? GRML_DEFAULT = None UUID = None -SYSLINUX_LIBS = "/usr/lib/syslinux/" -GPT_HEADER = "\x55\xaa\x45\x46\x49\x20\x50\x41\x52\x54" # original GPT header +SYSLINUX_LIBS = "/usr/lib/syslinux/modules/bios/" +GPT_HEADER = b"\x55\xaa\x45\x46\x49\x20\x50\x41\x52\x54" # original GPT header GRUB_INSTALL = None RE_PARTITION = re.compile(r'([a-z/]*?)(\d+)$') @@ -67,11 +82,12 @@ def grub_option(option, opt, value, opt_parser): setattr(opt_parser.values, option.dest, True) setattr(opt_parser.values, 'syslinux', False) + # cmdline parsing -USAGE = "Usage: %prog [options] <[ISO[s] | /lib/live/mount/medium]> \n\ +USAGE = "Usage: %prog [options] <[ISO[s] | /run/live/medium]> \n\ \n\ %prog installs Grml ISO[s] to an USB device to be able to boot from it.\n\ -Make sure you have at least one Grml ISO or a running Grml system (/lib/live/mount/medium),\n\ +Make sure you have at least one Grml ISO or a running Grml system (/run/live/medium),\n\ grub or syslinux and root access.\n\ \n\ Run %prog --help for usage hints, further information via: man grml2usb" @@ -186,7 +202,7 @@ def cleanup(): try: unmount(device, "") logging.debug('Unmounted %s' % device) - except StandardError: + except Exception: logging.debug('RuntimeError while umount %s, ignoring' % device) for tmppath in TMPFILES.copy(): @@ -201,7 +217,7 @@ def cleanup(): os.unlink(tmppath) logging.debug('temporary file %s deleted' % tmppath) unregister_tmpfile(tmppath) - except StandardError: + except Exception: msg = 'RuntimeError while removing temporary %s, ignoring' logging.debug(msg % tmppath) @@ -245,7 +261,7 @@ def unregister_mountpoint(target): def get_function_name(obj): - """Helper function for use in execute() to retrive name of a function + """Helper function for use in execute() to retrieve name of a function @obj: the function object """ @@ -314,7 +330,7 @@ def get_defaults_file(iso_mount, flavour, name): return ('', '') -def search_file(filename, search_path='/bin' + os.pathsep + '/usr/bin', lst_return=False): +def search_file(filename, search_path='/bin' + os.pathsep + '/usr/bin', lst_return=False, required=False): """Given a search path, find file @filename: name of file to search for @@ -343,6 +359,10 @@ def search_file(filename, search_path='/bin' + os.pathsep + '/usr/bin', lst_retu retval.append(os.path.abspath(os.path.join(current_dir, filename))) if not lst_return: break + + if required and not retval: + raise CriticalException("Required file %s not found in %s" % (filename, search_path)) + if lst_return: return retval elif retval: @@ -379,19 +399,19 @@ def check_boot_flag(device): if part.getFlag(parted.PARTITION_BOOT): logging.debug("bootflag is enabled on %s" % device) return - except HodorException, e: + except HodorException as e: logging.info("%s, falling back to old bootflag detection", e) - except ImportError, e: + except ImportError as e: logging.debug("could not import parted, falling back to old bootflag detection") - with open(boot_dev, 'r') as image: + with open(boot_dev, 'rb') as image: data = image.read(520) bootcode = data[440:] gpt_data = bootcode[70:80] if gpt_data == GPT_HEADER: logging.info("GPT detected, skipping bootflag check") - elif bootcode[6] == '\x80': + elif bootcode[6] == b"\x80": logging.debug("bootflag is enabled") else: logging.debug("bootflag is NOT enabled") @@ -513,15 +533,16 @@ def install_grub(device): mount(device, device_mountpoint, "") logging.info("Installing grub as bootloader") - for opt in ["", "--force"]: + for opt in ["--", "--force"]: set_rw(device) set_rw(grub_device) - logging.debug("grub-install --recheck %s --no-floppy --root-directory=%s %s", - opt, device_mountpoint, grub_device) - proc = subprocess.Popen([GRUB_INSTALL, "--recheck", opt, + logging.debug("%s --recheck --no-floppy --target=i386-pc --root-directory=%s %s %s", + GRUB_INSTALL, device_mountpoint, opt, grub_device) + proc = subprocess.Popen([GRUB_INSTALL, "--recheck", "--no-floppy", "--target=i386-pc", - "--root-directory=%s" % device_mountpoint, grub_device], - stdout=file(os.devnull, "r+")) + "--root-directory=%s" % device_mountpoint, + opt, grub_device], + stdout=open(os.devnull, "r+")) proc.wait() if proc.returncode == 0: break @@ -630,7 +651,7 @@ def install_mbr(mbrtemplate, device, partition, ismirbsdmbr=True): logging.debug("executing: dd if='%s' of='%s' bs=512 count=1", device, tmpf.name) proc = subprocess.Popen(["dd", "if=%s" % device, "of=%s" % tmpf.name, "bs=512", "count=1"], - stderr=file(os.devnull, "r+")) + stderr=open(os.devnull, "r+")) proc.wait() if proc.returncode != 0: raise Exception("error executing dd (first run)") @@ -638,7 +659,7 @@ def install_mbr(mbrtemplate, device, partition, ismirbsdmbr=True): logging.debug("executing: dd if=%s of=%s bs=%s count=1 conv=notrunc", mbrtemplate, tmpf.name, nmbrbytes) proc = subprocess.Popen(["dd", "if=%s" % mbrtemplate, "of=%s" % tmpf.name, "bs=%s" % nmbrbytes, - "count=1", "conv=notrunc"], stderr=file(os.devnull, "r+")) + "count=1", "conv=notrunc"], stderr=open(os.devnull, "r+")) proc.wait() if proc.returncode != 0: raise Exception("error executing dd (second run)") @@ -649,16 +670,16 @@ def install_mbr(mbrtemplate, device, partition, ismirbsdmbr=True): if partition is not None: if ismirbsdmbr: - mbrcode = mbrcode[0:439] + chr(partition) + \ - mbrcode[440:510] + "\x55\xAA" + mbrcode = mbrcode[0:439] + chr(partition).encode('latin-1') + \ + mbrcode[440:510] + b"\x55\xAA" else: - actives = ["\x00", "\x00", "\x00", "\x00"] - actives[partition] = "\x80" + actives = [b"\x00", b"\x00", b"\x00", b"\x00"] + actives[partition] = b"\x80" mbrcode = mbrcode[0:446] + actives[0] + \ mbrcode[447:462] + actives[1] + \ mbrcode[463:478] + actives[2] + \ mbrcode[479:494] + actives[3] + \ - mbrcode[495:510] + "\x55\xAA" + mbrcode[495:510] + b"\x55\xAA" tmpf.file.seek(0) tmpf.file.truncate() @@ -669,7 +690,7 @@ def install_mbr(mbrtemplate, device, partition, ismirbsdmbr=True): logging.debug("executing: dd if='%s' of='%s' bs=512 count=1 conv=notrunc", tmpf.name, device) proc = subprocess.Popen(["dd", "if=%s" % tmpf.name, "of=%s" % device, "bs=512", "count=1", - "conv=notrunc"], stderr=file(os.devnull, "r+")) + "conv=notrunc"], stderr=open(os.devnull, "r+")) proc.wait() if proc.returncode != 0: raise Exception("error executing dd (third run)") @@ -706,7 +727,7 @@ def mount(source, target, mount_options): # note: options.dryrun does not work here, as we have to # locate files and identify the grml flavour - for x in file('/proc/mounts').readlines(): + for x in open('/proc/mounts', 'r').readlines(): if x.startswith(source): raise CriticalException("Error executing mount: %s already mounted - " % source + "please unmount before invoking grml2usb") @@ -783,9 +804,7 @@ def check_for_fat(partition): " (wrong UID/permissions or device/directory not present?)" % partition) try: - udev_info = subprocess.Popen(["/sbin/blkid", "-s", "TYPE", "-o", "value", partition], - stdout=subprocess.PIPE, stderr=subprocess.PIPE) - filesystem = udev_info.communicate()[0].rstrip() + filesystem = subprocess.check_output(["/sbin/blkid", "-s", "TYPE", "-o", "value", partition]).decode().rstrip() if filesystem != "vfat": raise CriticalException( @@ -793,7 +812,7 @@ def check_for_fat(partition): "(Use --fat16 or run mkfs.vfat %s)" % (partition, partition)) except OSError: - raise CriticalException("Sorry, /sbin/blkid not available (install e2fsprogs?)") + raise CriticalException("Sorry, /sbin/blkid not available (install util-linux?)") def mkdir(directory): @@ -938,7 +957,7 @@ def update_grml_versions(iso_mount, target): # update the existing flavours on the target for line in fileinput.input([target_grml_version_file], inplace=1): flavour = get_flavour(line) - if flavour in iso_versions.keys(): + if flavour in list(iso_versions.keys()): print(iso_versions.pop(flavour)) else: print(line.strip()) @@ -978,22 +997,6 @@ def copy_grml_files(grml_flavour, iso_mount, target): logging.warn("Warning: could not find flavour directory for %s ", grml_flavour) -def handle_addon_copy(filename, dst, iso_mount, ignore_errors=False): - """handle copy of optional addons - - @filename: filename of the addon - @dst: destination directory - @iso_mount: location of the iso mount - @ignore_errors: don't report missing files - """ - file_location = search_file(filename, iso_mount) - if file_location is None: - if not ignore_errors: - logging.warn("Warning: %s not found (that's fine if you don't need it)", filename) - else: - exec_rsync(file_location, dst) - - def copy_addons(iso_mount, target): """copy grml's addons files (like allinoneimg, bsd4grml,..) to a given target @@ -1003,33 +1006,11 @@ def copy_addons(iso_mount, target): addons = target + '/boot/addons/' execute(mkdir, addons) - # grub all-in-one image - handle_addon_copy('allinone.img', addons, iso_mount) - - # bsd image - handle_addon_copy('bsd4grml', addons, iso_mount) - - # DOS image - handle_addon_copy('balder10.imz', addons, iso_mount) - - # syslinux + pci.ids for hdt - for expr in '*.c32', 'pci.ids': - glob_and_copy(iso_mount + '/boot/addons/' + expr, addons) - - # memdisk image - handle_addon_copy('memdisk', addons, iso_mount) - - # memtest86+ image - handle_addon_copy('memtest', addons, iso_mount) - - # gpxe.lkrn: got replaced by ipxe - handle_addon_copy('gpxe.lkrn', addons, iso_mount, ignore_errors=True) - - # ipxe.lkrn - handle_addon_copy('ipxe.lkrn', addons, iso_mount) - - # netboot.xyz - handle_addon_copy('netboot.xyz.lkrn', addons, iso_mount) + for addon_file in glob.glob(iso_mount + '/boot/addons/*'): + filename = os.path.basename(addon_file) + src_file = iso_mount + "/boot/addons/" + os.path.basename(addon_file) + logging.debug("Copying addon file %s" % filename) + exec_rsync(src_file, addons) def build_loopbackcfg(target): @@ -1106,7 +1087,7 @@ def copy_bootloader_files(iso_mount, target, grml_flavour): grub_target = target + '/boot/grub/' execute(mkdir, grub_target) - logo = search_file('logo.16', iso_mount) + logo = search_file('logo.16', iso_mount, required=True) exec_rsync(logo, syslinux_target + 'logo.16') bootx64_efi = search_file('bootx64.efi', iso_mount) @@ -1118,6 +1099,7 @@ def copy_bootloader_files(iso_mount, target, grml_flavour): if efi_img: mkdir(target + '/boot/') exec_rsync(efi_img, target + '/boot/efi.img') + handle_secure_boot(target, efi_img) for ffile in ['f%d' % number for number in range(1, 11)]: search_and_copy(ffile, iso_mount, syslinux_target + ffile) @@ -1156,7 +1138,7 @@ def copy_bootloader_files(iso_mount, target, grml_flavour): # copy all grub files from ISO glob_and_copy(iso_mount + '/boot/grub/*', grub_target) - # finally (after all GRUB files have been been installed) build static loopback.cfg + # finally (after all GRUB files have been installed) build static loopback.cfg build_loopbackcfg(target) @@ -1224,7 +1206,7 @@ def identify_grml_flavour(mountpath): version_files = search_file('grml-version', mountpath, lst_return=True) if not version_files: - if mountpath.startswith("/lib/live/mount/medium"): + if mountpath.startswith("/run/live/medium"): logging.critical("Error: could not find grml-version file.") logging.critical("Looks like your system is running from RAM but required files are not available.") logging.critical("Please either boot without toram=... or use boot option toram instead of toram=...") @@ -1274,6 +1256,7 @@ def handle_grub_config(grml_flavour, device, target): logging.debug("Updating grub configuration") grub_target = target + '/boot/grub/' + secureboot_target = target + '/EFI/ubuntu/' bootid_re = re.compile("bootid=[\w_-]+") live_media_path_re = re.compile("live-media-path=[\w_/-]+") @@ -1288,7 +1271,7 @@ def handle_grub_config(grml_flavour, device, target): remove_regexes.append(re.compile(regex)) shortname = get_shortname(grml_flavour) - for filename in glob.glob(grub_target + '*.cfg'): + for filename in glob.glob(grub_target + '*.cfg') + glob.glob(secureboot_target + '*.cfg'): for line in fileinput.input(filename, inplace=1): line = line.rstrip("\r\n") if option_re.search(line): @@ -1296,6 +1279,10 @@ def handle_grub_config(grml_flavour, device, target): if shortname in filename: line = live_media_path_re.sub('', line) line = line.rstrip() + ' live-media-path=/live/%s/ ' % (grml_flavour) + if bootopt.strip(): + line = line.replace(' {} '.format(bootopt.strip()), ' ') + if line.endswith(bootopt): + line = line[:-len(bootopt)] line = line.rstrip() + r' bootid=%s %s ' % (UUID, bootopt) for regex in remove_regexes: line = regex.sub(' ', line) @@ -1304,7 +1291,7 @@ def handle_grub_config(grml_flavour, device, target): def initial_syslinux_config(target): - """Generates intial syslinux configuration + """Generates initial syslinux configuration @target path of syslinux's configuration files""" @@ -1508,6 +1495,51 @@ def handle_syslinux_config(grml_flavour, target): add_syslinux_entry("%s/additional.cfg" % syslinux_target, flavour_filename) +def handle_secure_boot(target, efi_img): + """Provide secure boot support by extracting files from /boot/efi.img + + @target: path where grml's main files should be copied to + @efi_img: path to the efi.img file that includes the files for secure boot + """ + + mkdir(target + '/efi/boot/') + efi_mountpoint = tempfile.mkdtemp(prefix="grml2usb", dir=os.path.abspath(options.tmpdir)) + logging.debug("efi_mountpoint = %s" % efi_mountpoint) + register_tmpfile(efi_mountpoint) + + try: + logging.debug("mount(%s, %s, ['-o', 'ro', '-t', 'vfat']" % (efi_img, efi_mountpoint)) + mount(efi_img, efi_mountpoint, ['-o', 'ro', '-t', 'vfat']) + except CriticalException as error: + logging.critical("Fatal: %s", error) + sys.exit(1) + + ubuntu_cfg = search_file('grub.cfg', efi_mountpoint + '/EFI/ubuntu') + logging.debug("ubuntu_cfg = %s" % ubuntu_cfg) + if not ubuntu_cfg: + logging.info("No /EFI/ubuntu/grub.cfg found inside EFI image, looks like Secure Boot support is missing.") + else: + mkdir(target + '/efi/ubuntu') + logging.debug("exec_rsync(%s, %s + '/efi/ubuntu/grub.cfg')" % (ubuntu_cfg, target)) + exec_rsync(ubuntu_cfg, target + '/efi/ubuntu/grub.cfg') + + logging.debug("exec_rsync(%s + '/EFI/BOOT/grubx64.efi', %s + '/efi/boot/grubx64.efi')'" % (efi_mountpoint, target)) + exec_rsync(efi_mountpoint + '/EFI/BOOT/grubx64.efi', target + '/efi/boot/grubx64.efi') + + # NOTE - we're overwriting /efi/boot/bootx64.efi from copy_bootloader_files here + logging.debug("exec_rsync(%s + '/EFI/BOOT/bootx64.efi', %s + '/efi/boot/bootx64.efi')'" % (efi_mountpoint, target)) + exec_rsync(efi_mountpoint + '/EFI/BOOT/bootx64.efi', target + '/efi/boot/bootx64.efi') + + try: + unmount(efi_mountpoint, "") + logging.debug('Unmounted %s' % efi_mountpoint) + os.rmdir(efi_mountpoint) + logging.debug('Removed directory %s' % efi_mountpoint) + except Exception: + logging.critical('RuntimeError while umount %s' % efi_mountpoint) + sys.exit(1) + + def handle_bootloader_config(grml_flavour, device, target): """Main handler for generating bootloader's configuration @@ -1548,7 +1580,7 @@ def install(image, device): if options.force or os.path.exists(os.path.join(image, 'live')): logging.info("Using %s as install base", image) else: - q = raw_input("%s does not look like a Grml system. " + q = input("%s does not look like a Grml system. " "Do you really want to use this image? y/N " % image) if q.lower() == 'y': logging.info("Using %s as install base", image) @@ -1579,7 +1611,7 @@ def install(image, device): def install_grml(mountpoint, device): """Main logic for copying files of the currently running Grml system. - @mountpoint: directory where currently running live system resides (usually /lib/live/mount/medium) + @mountpoint: directory where currently running live system resides (usually /run/live/medium) @device: partition where the specified ISO should be installed to""" device_mountpoint = device @@ -1656,7 +1688,7 @@ def handle_mbr(device): mbrcode = mbrpath break - if mbrcode is "": + if not mbrcode: str_locations = " or ".join(['"%s"' % l for l in mbr_locations]) logging.error('Cannot find syslinux MBR, install it at %s)', str_locations) @@ -1688,7 +1720,7 @@ def handle_vfat(device): print("Forcing mkfs.fat16 on %s as requested via option --force." % device) else: # make sure the user is aware of what he is doing - f = raw_input("Are you sure you want to format the specified partition with fat16? y/N ") + f = input("Are you sure you want to format the specified partition with fat16? y/N ") if f == "y" or f == "Y": logging.info("Note: you can skip this question using the option --force") else: @@ -1713,7 +1745,7 @@ def handle_vfat(device): if not os.path.isdir(device) and not check_for_usbdevice(device) and not options.force: print("Warning: the specified device %s does not look like a removable usb device." % device) - f = raw_input("Do you really want to continue? y/N ") + f = input("Do you really want to continue? y/N ") if f.lower() != "y": sys.exit(1) @@ -1729,7 +1761,7 @@ def handle_compat_warning(device): print("Instead of using grml2usb /path/to/iso %s you might" % device) print("want to use grml2usb /path/to/iso /dev/... instead.") print("Please check out the grml2usb manpage for details.") - f = raw_input("Do you really want to continue? y/N ") + f = input("Do you really want to continue? y/N ") if f.lower() != "y": sys.exit(1) @@ -1765,7 +1797,7 @@ def handle_bootloader(device): def check_options(opts): - """Check compability of provided user opts + """Check compatibility of provided user opts @opts option dict from OptionParser """ @@ -1798,14 +1830,14 @@ def check_programs(): def load_loop(): - """Runs modprobe loop and throws away it's output""" + """Runs modprobe loop and throws away its output""" if not which("modprobe"): logging.critical("Fatal: modprobe not available, can not continue - sorry.") logging.critical("Hint: is /sbin missing in PATH?") sys.exit(1) proc = subprocess.Popen(["modprobe", "loop"], stdout=subprocess.PIPE, stderr=subprocess.PIPE) - proc.wait() + proc.communicate() def main(): @@ -1875,6 +1907,8 @@ def main(): except Exception as error: logging.critical("Fatal: %s", str(error)) + if options.verbose: + logging.exception("Exception:") sys.exit(1)