sign.py

#!/usr/bin/env python
"""Signingscript task functions."""
import asyncio
import base64
import difflib
import fnmatch
import glob
import hashlib
import json
import logging
import os
import re
import resource
import shutil
import subprocess
import sys
import tarfile
import tempfile
import time
import zipfile
from contextlib import ExitStack
from functools import wraps
from io import BytesIO

import mohawk
import winsign.sign
from mardor.reader import MarReader
from mardor.writer import add_signature_block
from scriptworker.utils import get_single_item_from_sequence, makedirs, raise_future_exceptions, retry_async, rm
from winsign.crypto import load_pem_certs

from signingscript import task, utils
from signingscript.createprecomplete import generate_precomplete
from signingscript.exceptions import SigningScriptError

log = logging.getLogger(__name__)

try:
    # NB. The widevine module needs to be deployed separately
    import widevine
except ImportError:
    log.exception("Could not import widevine")
    widevine = None

sys.path.append(os.path.abspath(os.path.join(os.path.realpath(os.path.dirname(__file__)), "vendored", "mozbuild")))  # append the mozbuild vendor

from mozpack import mozjar  # noqa  # isort:skip

_ZIP_ALIGNMENT = "4"  # Value must always be 4, based on https://developer.android.com/studio/command-line/zipalign.html

# Blessed files call the other widevine files.
_WIDEVINE_BLESSED_FILENAMES = (
    # plugin-container is the top of the calling stack
    "plugin-container",
    "plugin-container.exe",
)
# These are other files that need to be widevine-signed
_WIDEVINE_NONBLESSED_FILENAMES = (
    # firefox
    "firefox",
    "firefox-bin",
    "firefox.exe",
    # xul
    "libxul.so",
    "XUL",
    "xul.dll",
    # clearkey for regression testing.
    "clearkey.dll",
    "libclearkey.dylib",
    "libclearkey.so",
)

# These are the keys used to verify if a keyid isn't specified
_DEFAULT_MAR_VERIFY_KEYS = {
    "autograph_stage_mar384": {"dep-signing": "autograph_stage.pem"},
    "autograph_hash_only_mar384": {"release-signing": "release_primary.pem", "nightly-signing": "nightly_aurora_level3_primary.pem", "dep-signing": "dep1.pem"},
}

# Langpacks expect the following re to match for addon id
LANGPACK_RE = re.compile(r"^langpack-[a-zA-Z]+(?:-[a-zA-Z]+){0,2}@(?:firefox|devedition|pinebuild).mozilla.org$")


def get_rss():
    """Return the maximum resident set size for this process."""
    return resource.getrusage(resource.RUSAGE_SELF).ru_maxrss


def time_async_function(f):
    """Time an async function."""

    @wraps(f)
    async def wrapped(*args, **kwargs):
        start = time.time()
        start_rss = get_rss()
        try:
            return await f(*args, **kwargs)
        finally:
            rss = get_rss()
            log.debug("%s took %.2fs; RSS:%s (%+d)", f.__name__, time.time() - start, rss, rss - start_rss)

    return wrapped


def time_function(f):
    """Time a sync function."""

    @wraps(f)
    def wrapped(*args, **kwargs):
        start = time.time()
        start_rss = get_rss()
        try:
            return f(*args, **kwargs)
        finally:
            rss = get_rss()
            log.debug("%s took %.2fs; RSS:%s (%+d)", f.__name__, time.time() - start, rss, rss - start_rss)

    return wrapped


# get_autograph_config {{{1
def get_autograph_config(autograph_configs, cert_type, signing_formats, raise_on_empty=False):
    """Get the autograph config for given `signing_formats` and `cert_type`.

    Args:
        autograph_configs (dict of lists of lists): the contents of
            `autograph_configs`.
        cert_type (str): the certificate type - essentially signing level,
            separating release vs nightly vs dep.
        signing_formats (list): the signing formats the server needs to support
        raise_on_empty (bool): flag to raise errors. Optional. Defaults to False.

    Raises:
        SigningScriptError: when no suitable signing server is found

    Returns:
        An Autograph object

    """
    for a in autograph_configs.get(cert_type, []):
        if a and (set(a.formats) & set(signing_formats)):
            return a

    if raise_on_empty:
        raise SigningScriptError(f"No autograph config found with cert type {cert_type} and formats {signing_formats}")
    return None


# sign_file {{{1
async def sign_file(context, from_, fmt, to=None, **kwargs):
    """Send the file to autograph to be signed.

    Args:
        context (Context): the signing context
        from_ (str): the source file to sign
        fmt (str): the format to sign with
        to (str, optional): the target path to sign to. If None, overwrite
            `from_`. Defaults to None.

    Raises:
        FailedSubprocess: on subprocess error while signing.

    Returns:
        str: the path to the signed file

    """
    log.info("sign_file(): signing %s with %s... using autograph /sign/file", from_, fmt)
    await sign_file_with_autograph(context, from_, fmt, to=to)
    return to or from_


# sign_gpg {{{1
async def sign_gpg(context, from_, fmt, **kwargs):
    """Create a detached armored signature with the gpg key.

    Because this function returns a list, gpg must be the final signing format.

    Args:
        context (Context): the signing context
        from_ (str): the source file to sign
        fmt (str): the format to sign with

    Returns:
        list: the path to the signed file, and sig.

    """
    to = f"{from_}.asc"
    await sign_file(context, from_, fmt, to=to)
    return [from_, to]


# sign_jar {{{1
async def sign_jar(context, from_, fmt, **kwargs):
    """Sign an apk, and zipalign.

    Args:
        context (Context): the signing context
        from_ (str): the source file to sign
        fmt (str): the format to sign with

    Returns:
        str: the path to the signed file

    """
    await sign_file(context, from_, fmt)
    await zip_align_apk(context, from_)
    return from_


# sign_macapp {{{1
async def sign_macapp(context, from_, fmt, **kwargs):
    """Sign a macapp.

    If given a dmg, convert to a tar.gz file first, then sign the internals.

    Args:
        context (Context): the signing context
        from_ (str): the source file to sign
        fmt (str): the format to sign with

    Returns:
        str: the path to the signed file

    """
    file_base, file_extension = os.path.splitext(from_)
    if file_extension == ".dmg":
        await _convert_dmg_to_tar_gz(context, from_)
        from_ = "{}.tar.gz".format(file_base)
    await sign_file(context, from_, fmt)
    return from_


# sign_xpi {{{1
async def sign_xpi(context, orig_path, fmt, **kwargs):
    """Sign language packs with autograph.

    This validates both the file extension and the language pack ID is sane.

    Args:
        context (Context): the signing context
        orig_path (str): the source file to sign
        fmt (str): the format to sign with

    Returns:
        str: the path to the signed xpi

    """
    file_base, file_extension = os.path.splitext(orig_path)

    if file_extension not in (".xpi", ".zip"):
        raise SigningScriptError("Expected a .xpi")

    ext_id = _extension_id(orig_path, fmt)
    log.info("Identified {} as extension id: {}".format(orig_path, id))
    kwargs = {"extension_id": ext_id}
    # Sign the appropriate inner files
    await sign_file_with_autograph(context, orig_path, fmt, **kwargs)
    return orig_path


# sign_widevine {{{1
@time_async_function
async def sign_widevine(context, orig_path, fmt, **kwargs):
    """Call the appropriate helper function to do widevine signing.

    Args:
        context (Context): the signing context
        orig_path (str): the source file to sign
        fmt (str): the format to sign with

    Raises:
        SigningScriptError: on unknown suffix.

    Returns:
        str: the path to the signed archive

    """
    file_base, file_extension = os.path.splitext(orig_path)
    # Convert dmg to tarball
    if file_extension == ".dmg":
        await _convert_dmg_to_tar_gz(context, orig_path)
        orig_path = "{}.tar.gz".format(file_base)
    ext_to_fn = {".zip": sign_widevine_zip, ".tar.bz2": sign_widevine_tar, ".tar.gz": sign_widevine_tar}
    for ext, signing_func in ext_to_fn.items():
        if orig_path.endswith(ext):
            return await signing_func(context, orig_path, fmt)
    raise SigningScriptError("Unknown widevine file format for {}".format(orig_path))


# sign_widevine_zip {{{1
@time_async_function
async def sign_widevine_zip(context, orig_path, fmt):
    """Sign the internals of a zipfile with the widevine key.

    Extract the files to sign (see `_WIDEVINE_BLESSED_FILENAMES` and
    `_WIDEVINE_UNBLESSED_FILENAMES), skipping already-signed files.
    The blessed files should be signed with the `widevine_blessed` format.
    Then append the sigfiles to the zipfile.

    Args:
        context (Context): the signing context
        orig_path (str): the source file to sign
        fmt (str): the format to sign with

    Returns:
        str: the path to the signed archive

    """
    # This will get cleaned up when we nuke `work_dir`. Clean up at that point
    # rather than immediately after `sign_widevine`, to optimize task runtime
    # speed over disk space.
    tmp_dir = tempfile.mkdtemp(prefix="wvzip", dir=context.config["work_dir"])
    # Get file list
    all_files = await _get_zipfile_files(orig_path)
    files_to_sign = _get_widevine_signing_files(all_files)
    log.debug("Widevine files to sign: %s", files_to_sign)
    if files_to_sign:
        # Extract all files so we can create `precomplete` with the full
        # file list
        all_files = await _extract_zipfile(context, orig_path, tmp_dir=tmp_dir)
        tasks = []
        # Sign the appropriate inner files
        for from_, fmt in files_to_sign.items():
            from_ = os.path.join(tmp_dir, from_)
            to = f"{from_}.sig"
            tasks.append(asyncio.ensure_future(sign_widevine_with_autograph(context, from_, "blessed" in fmt, to=to)))
            all_files.append(to)
        await raise_future_exceptions(tasks)
        remove_extra_files(tmp_dir, all_files)
        # Regenerate the `precomplete` file, which is used for cleanup before
        # applying a complete mar.
        _run_generate_precomplete(context, tmp_dir)
        await _create_zipfile(context, orig_path, all_files, mode="w", tmp_dir=tmp_dir)
    return orig_path


# sign_widevine_tar {{{1
@time_async_function
async def sign_widevine_tar(context, orig_path, fmt):
    """Sign the internals of a tarfile with the widevine key.

    Extract the entire tarball, but only sign a handful of files (see
    `_WIDEVINE_BLESSED_FILENAMES` and `_WIDEVINE_UNBLESSED_FILENAMES).
    The blessed files should be signed with the `widevine_blessed` format.
    Then recreate the tarball.

    Ideally we would be able to append the sigfiles to the original tarball,
    but that's not possible with compressed tarballs.

    Args:
        context (Context): the signing context
        orig_path (str): the source file to sign
        fmt (str): the format to sign with

    Returns:
        str: the path to the signed archive

    """
    _, compression = os.path.splitext(orig_path)
    # This will get cleaned up when we nuke `work_dir`. Clean up at that point
    # rather than immediately after `sign_widevine`, to optimize task runtime
    # speed over disk space.
    tmp_dir = tempfile.mkdtemp(prefix="wvtar", dir=context.config["work_dir"])
    # Get file list
    all_files = await _get_tarfile_files(orig_path, compression)
    files_to_sign = _get_widevine_signing_files(all_files)
    log.debug("Widevine files to sign: %s", files_to_sign)
    if files_to_sign:
        # Extract all files so we can create `precomplete` with the full
        # file list
        all_files = await _extract_tarfile(context, orig_path, compression, tmp_dir=tmp_dir)
        tasks = []
        # Sign the appropriate inner files
        for from_, fmt in files_to_sign.items():
            from_ = os.path.join(tmp_dir, from_)
            # Don't try to sign directories
            if not os.path.isfile(from_):
                continue
            # Move the sig location on mac. This should be noop on linux.
            to = _get_mac_sigpath(from_)
            log.debug("Adding %s to the sigfile paths...", to)
            makedirs(os.path.dirname(to))
            tasks.append(asyncio.ensure_future(sign_widevine_with_autograph(context, from_, "blessed" in fmt, to=to)))
            all_files.append(to)
        await raise_future_exceptions(tasks)
        remove_extra_files(tmp_dir, all_files)
        # Regenerate the `precomplete` file, which is used for cleanup before
        # applying a complete mar.
        _run_generate_precomplete(context, tmp_dir)
        await _create_tarfile(context, orig_path, all_files, compression, tmp_dir=tmp_dir)
    return orig_path


# sign_omnija {{{1
@time_async_function
async def sign_omnija(context, orig_path, fmt, **kwargs):
    """Call the appropriate helper function to do omnija signing.

    Args:
        context (Context): the signing context
        orig_path (str): the source file to sign
        fmt (str): the format to sign with

    Raises:
        SigningScriptError: on unknown suffix.

    Returns:
        str: the path to the signed archive

    """
    file_base, file_extension = os.path.splitext(orig_path)
    # Convert dmg to tarball
    if file_extension == ".dmg":
        await _convert_dmg_to_tar_gz(context, orig_path)
        orig_path = "{}.tar.gz".format(file_base)
    ext_to_fn = {".zip": sign_omnija_zip, ".tar.bz2": sign_omnija_tar, ".tar.gz": sign_omnija_tar}
    for ext, signing_func in ext_to_fn.items():
        if orig_path.endswith(ext):
            return await signing_func(context, orig_path, fmt)
    raise SigningScriptError("Unknown omnija file format for {}".format(orig_path))


# sign_omnija_zip {{{1
async def sign_omnija_zip(context, orig_path, fmt):
    """Sign the internals of a zipfile with the omnija key for all omni.ja files.

    Extract the files to sign, then sign them with autograph, recreating the omni.ja
    from the original to preserve performance tweeks but adding signing info,
    Then append the sigfiles to the zipfile.

    Args:
        context (Context): the signing context
        orig_path (str): the source file to sign
        fmt (str): the format to sign with

    Returns:
        str: the path to the signed archive

    """
    # This will get cleaned up when we nuke `work_dir`. Clean up at that point
    # rather than immediately after `sign_omnija`, to optimize task runtime
    # speed over disk space.
    tmp_dir = tempfile.mkdtemp(prefix="ojzip", dir=context.config["work_dir"])
    # Get file list
    all_files = await _get_zipfile_files(orig_path)
    files_to_sign = _get_omnija_signing_files(all_files)
    log.debug("Omnija files to sign: %s", files_to_sign)
    if files_to_sign:
        all_files = await _extract_zipfile(context, orig_path, tmp_dir=tmp_dir)
        tasks = []
        # Sign the appropriate inner files
        for from_, fmt in files_to_sign.items():
            from_ = os.path.join(tmp_dir, from_)
            tasks.append(asyncio.ensure_future(sign_omnija_with_autograph(context, from_)))
        await raise_future_exceptions(tasks)
        await _create_zipfile(context, orig_path, all_files, mode="w", tmp_dir=tmp_dir)
    return orig_path


# sign_omnija_tar {{{1
@time_async_function
async def sign_omnija_tar(context, orig_path, fmt):
    """Sign the internals of a tarfile with the omnija key for all omni.ja files.

    Extract the files to sign, then sign them with autograph, recreating the omni.ja
    from the original to preserve performance tweeks but adding signing info.
    Then recreate the tarball.

    Args:
        context (Context): the signing context
        orig_path (str): the source file to sign
        fmt (str): the format to sign with

    Returns:
        str: the path to the signed archive

    """
    _, compression = os.path.splitext(orig_path)
    # This will get cleaned up when we nuke `work_dir`. Clean up at that point
    # rather than immediately after `sign_widevine`, to optimize task runtime
    # speed over disk space.
    tmp_dir = tempfile.mkdtemp(prefix="ojtar", dir=context.config["work_dir"])
    # Get file list
    all_files = await _get_tarfile_files(orig_path, compression)
    files_to_sign = _get_omnija_signing_files(all_files)
    log.debug("Omnija files to sign: %s", files_to_sign)
    if files_to_sign:
        # Extract all files so we can create `precomplete` with the full
        # file list
        all_files = await _extract_tarfile(context, orig_path, compression, tmp_dir=tmp_dir)
        tasks = []
        # Sign the appropriate inner files
        for from_, fmt in files_to_sign.items():
            from_ = os.path.join(tmp_dir, from_)
            # Don't try to sign directories
            if not os.path.isfile(from_):
                continue
            tasks.append(asyncio.ensure_future(sign_omnija_with_autograph(context, from_)))
        await raise_future_exceptions(tasks)
        await _create_tarfile(context, orig_path, all_files, compression, tmp_dir=tmp_dir)
    return orig_path


# _should_sign_windows {{{1
def _should_sign_windows(filename):
    """Return True if filename should be signed."""
    # These should already be signed by Microsoft.
    _dont_sign = ["D3DCompiler_42.dll", "d3dx9_42.dll", "D3DCompiler_43.dll", "d3dx9_43.dll", "msvc*.dll"]
    ext = os.path.splitext(filename)[1]
    b = os.path.basename(filename)
    if ext in (".dll", ".exe", ".msi", ".msix", ".bin") and not any(fnmatch.fnmatch(b, p) for p in _dont_sign):
        return True
    return False


def _extension_id(filename, fmt):
    """Return a list of id's for the langpacks.

    Side effect of additionally verifying langpack manifests.
    """
    xpi = zipfile.ZipFile(filename, "r")
    manifest = {}
    for manifest_name in ("manifest.json", "webextension/manifest.json"):
        try:
            with xpi.open(manifest_name, "r") as f:
                manifest = json.load(f)
                break
        except KeyError:
            log.debug("{} doesn't exist in {}...".format(manifest_name, filename))
    # Check for "browser_specific_settings" key first. Fall back to deprecated "applications" key
    browser_specific_settings = manifest.get("browser_specific_settings", manifest.get("applications", {}))
    gecko_id = browser_specific_settings.get("gecko", {}).get("id")
    if not gecko_id:
        raise SigningScriptError("{} is not a valid xpi".format(filename))
    if "langpack" in fmt and not ("languages" in manifest and "langpack_id" in manifest and LANGPACK_RE.match(gecko_id) and filename.endswith(".xpi")):
        raise SigningScriptError("{} is not a valid langpack".format(filename))
    return gecko_id


# _get_mac_sigpath {{{1
def _get_mac_sigpath(from_):
    """For mac paths, replace the final Contents/MacOS/ with Contents/Resources/."""
    to = from_
    if "Contents/MacOS" in from_:
        parts = from_.split("/")
        parts.reverse()
        i = parts.index("MacOS")
        parts[i] = "Resources"
        parts.reverse()
        to = "/".join(parts)
        log.debug("Sigfile for {} should be {}.sig".format(from_, to))
    return "{}.sig".format(to)


# _get_widevine_signing_files {{{1
def _get_widevine_signing_files(file_list):
    """Return a dict of path:signing_format for each path to be signed."""
    files = {}
    for filename in file_list:
        fmt = None
        base_filename = os.path.basename(filename)
        if base_filename in _WIDEVINE_BLESSED_FILENAMES:
            fmt = "widevine_blessed"
        elif base_filename in _WIDEVINE_NONBLESSED_FILENAMES:
            fmt = "widevine"
        if fmt:
            log.debug("Found {} to sign {}".format(filename, fmt))
            sigpath = _get_mac_sigpath(filename)
            if sigpath not in file_list:
                files[filename] = fmt
            else:
                log.debug("{} is already signed! Skipping...".format(filename))
    return files


# _get_omnija_signing_files {{{1
def _get_omnija_signing_files(file_list):
    """Return a dict of path:signing_format for each path to be signed."""
    files = {}
    for filename in file_list:
        fmt = None
        base_filename = os.path.basename(filename)
        if base_filename in {"omni.ja"}:
            fmt = "omnija"
        if fmt:
            log.debug("Found {} to sign {}".format(filename, fmt))
            files[filename] = fmt
    return files


# _run_generate_precomplete {{{1
def _run_generate_precomplete(context, tmp_dir):
    """Regenerate `precomplete` file with widevine sig paths for complete mar."""
    log.info("Generating `precomplete` file...")
    path = _ensure_one_precomplete(tmp_dir, "before")
    with open(path, "r") as fh:
        before = fh.readlines()
    generate_precomplete(os.path.dirname(path))
    path = _ensure_one_precomplete(tmp_dir, "after")
    with open(path, "r") as fh:
        after = fh.readlines()
    # Create diff file
    diff_path = os.path.join(context.config["work_dir"], "precomplete.diff")
    with open(diff_path, "w") as fh:
        for line in difflib.ndiff(before, after):
            fh.write(line)
    utils.copy_to_dir(diff_path, context.config["artifact_dir"], target="public/logs/precomplete.diff")


# _ensure_one_precomplete {{{1
def _ensure_one_precomplete(tmp_dir, adj):
    """Ensure we only have one `precomplete` file in `tmp_dir`."""
    return get_single_item_from_sequence(
        glob.glob(os.path.join(tmp_dir, "**", "precomplete"), recursive=True),
        condition=lambda _: True,
        ErrorClass=SigningScriptError,
        no_item_error_message='No `precomplete` file found in "{}"'.format(tmp_dir),
        too_many_item_error_message='More than one `precomplete` file {} in "{}"'.format(adj, tmp_dir),
    )


# remove_extra_files {{{1
def remove_extra_files(top_dir, file_list):
    """Find any extra files in `top_dir`, given an expected `file_list`.

    Args:
        top_dir (str): the dir to walk
        file_list (list): the list of expected files

    Returns:
        list: the list of extra files

    """
    all_files = [os.path.realpath(f) for f in glob.glob(os.path.join(top_dir, "**", "*"), recursive=True)]
    good_files = [os.path.realpath(f) for f in file_list]
    extra_files = list(set(all_files) - set(good_files))
    for f in extra_files:
        if os.path.isfile(f):
            log.warning("Extra file to clean up: {}".format(f))
            rm(f)
    return extra_files


# zip_align_apk {{{1
@time_async_function
async def zip_align_apk(context, abs_to):
    """Optimize APK for better run-time performance.

    This is necessary if the APK is uploaded to the Google Play Store.
    https://developer.android.com/studio/command-line/zipalign.html

    Args:
        context (Context): the signing context
        abs_to (str): the absolute path to the apk

    """
    original_apk_location = abs_to
    zipalign_executable_location = context.config["zipalign"]

    with tempfile.TemporaryDirectory() as temp_dir:
        temp_apk_location = os.path.join(temp_dir, "aligned.apk")

        zipalign_command = [zipalign_executable_location]
        if context.config["verbose"] is True:
            zipalign_command += ["-v"]

        zipalign_command += [_ZIP_ALIGNMENT, original_apk_location, temp_apk_location]
        await utils.execute_subprocess(zipalign_command)
        shutil.move(temp_apk_location, abs_to)

    log.info('"{}" has been zip aligned'.format(abs_to))


# _convert_dmg_to_tar_gz {{{1
@time_async_function
async def _convert_dmg_to_tar_gz(context, from_):
    """Explode a dmg and tar up its contents. Return the relative tarball path."""
    work_dir = context.config["work_dir"]
    abs_from = os.path.join(work_dir, from_)
    # replace .dmg suffix with .tar.gz (case insensitive)
    to = re.sub(r"\.dmg$", ".tar.gz", from_, flags=re.I)
    abs_to = os.path.join(work_dir, to)
    dmg_executable_location = context.config["dmg"]
    hfsplus_executable_location = context.config["hfsplus"]

    with tempfile.TemporaryDirectory() as temp_dir:
        app_dir = os.path.join(temp_dir, "app")
        utils.mkdir(app_dir)
        undmg_cmd = [dmg_executable_location, "extract", abs_from, "tmp.hfs"]
        await utils.execute_subprocess(undmg_cmd, cwd=temp_dir, log_level=logging.DEBUG)
        hfsplus_cmd = [hfsplus_executable_location, "tmp.hfs", "extractall", "/", app_dir]
        await utils.execute_subprocess(hfsplus_cmd, cwd=temp_dir, log_level=logging.DEBUG)
        tar_cmd = ["tar", "czf", abs_to, "."]
        await utils.execute_subprocess(tar_cmd, cwd=app_dir)

    return to


# _get_zipfile_files {{{1
@time_async_function
async def _get_zipfile_files(from_):
    with zipfile.ZipFile(from_, mode="r") as z:
        files = z.namelist()
        return files


# _extract_zipfile {{{1
@time_async_function
async def _extract_zipfile(context, from_, files=None, tmp_dir=None):
    work_dir = context.config["work_dir"]
    tmp_dir = tmp_dir or os.path.join(work_dir, "unzipped")
    log.debug("Extracting {} from {} to {}...".format(files or "all files", from_, tmp_dir))
    try:
        extracted_files = []
        rm(tmp_dir)
        utils.mkdir(tmp_dir)
        with zipfile.ZipFile(from_, mode="r") as z:
            if files is not None:
                for name in files:
                    z.extract(name, path=tmp_dir)
                    extracted_files.append(os.path.join(tmp_dir, name))
            else:
                for name in z.namelist():
                    extracted_files.append(os.path.join(tmp_dir, name))
                z.extractall(path=tmp_dir)
        return extracted_files
    except Exception as e:
        raise SigningScriptError(e)


# _create_zipfile {{{1
@time_async_function
async def _create_zipfile(context, to, files, tmp_dir=None, mode="w"):
    work_dir = context.config["work_dir"]
    tmp_dir = tmp_dir or os.path.join(work_dir, "unzipped")
    try:
        log.info("Creating zipfile {}...".format(to))
        with zipfile.ZipFile(to, mode=mode, compression=zipfile.ZIP_DEFLATED) as z:
            for f in files:
                relpath = os.path.relpath(f, tmp_dir)
                z.write(f, arcname=relpath)
        return to
    except Exception as e:
        raise SigningScriptError(e)


# _get_tarfile_compression {{{1
def _get_tarfile_compression(compression):
    compression = compression.lstrip(".")
    if compression not in ("bz2", "gz"):
        raise SigningScriptError("{} not a supported tarfile compression format!".format(compression))
    return compression


# _get_tarfile_files {{{1
@time_async_function
async def _get_tarfile_files(from_, compression):
    compression = _get_tarfile_compression(compression)
    with tarfile.open(from_, mode="r:{}".format(compression)) as t:
        files = t.getmembers()
        return [f.name for f in files if f.isfile()]


# _extract_tarfile {{{1
@time_async_function
async def _extract_tarfile(context, from_, compression, tmp_dir=None):
    work_dir = context.config["work_dir"]
    tmp_dir = tmp_dir or os.path.join(work_dir, "untarred")
    compression = _get_tarfile_compression(compression)
    try:
        files = []
        rm(tmp_dir)
        utils.mkdir(tmp_dir)
        with tarfile.open(from_, mode="r:{}".format(compression)) as t:
            t.extractall(path=tmp_dir)
            for name in t.getnames():
                path = os.path.join(tmp_dir, name)
                os.path.isfile(path) and files.append(path)
        return files
    except Exception as e:
        raise SigningScriptError(e)


# _owner_filter {{{1
def _owner_filter(tarinfo_obj):
    """Force file ownership to be root, Bug 1473850."""
    tarinfo_obj.uid = 0
    tarinfo_obj.gid = 0
    tarinfo_obj.uname = ""
    tarinfo_obj.gname = ""
    return tarinfo_obj


# _create_tarfile {{{1
@time_async_function
async def _create_tarfile(context, to, files, compression, tmp_dir=None):
    work_dir = context.config["work_dir"]
    tmp_dir = tmp_dir or os.path.join(work_dir, "untarred")
    compression = _get_tarfile_compression(compression)
    try:
        log.info("Creating tarfile {}...".format(to))
        with tarfile.open(to, mode="w:{}".format(compression)) as t:
            for f in files:
                relpath = os.path.relpath(f, tmp_dir)
                t.add(f, arcname=relpath, filter=_owner_filter)
        return to
    except Exception as e:
        raise SigningScriptError(e)


def _encode_single_file(fp, signing_req):
    """Write signing_req to fp.

    Does proper base64 and json encoding.
    Tries not to hold onto a lot of memory.
    """
    fp.write(b"[{")
    for k, v in signing_req.items():
        fp.write(json.dumps(k).encode("utf8"))
        fp.write(b":")
        if hasattr(v, "read"):
            # Make sure we're always reading from the beginning of the file
            # Sometimes we have to retry the request
            v.seek(0)
            fp.write(b'"')
            while True:
                block = v.read(1020)
                if not block:
                    break
                e = b64encode(block).encode("utf8")
                fp.write(e)
            fp.write(b'"')
        else:
            fp.write(json.dumps(v).encode("utf8"))
        fp.write(b",")
    fp.seek(-1, 1)
    fp.write(b"}]")


def _encode_multiple_files(fp, signing_req):
    """Write signing_req to fp.

    Builds a JSON byte string from the signing_req.
    Does a proper base64 encoding of the binary content in the request's file blobs.
    Doesn't hold onto a lot of memory by chunking the file blobs.
    Writes the request to the binary-stream fp.
    """
    _signing_req = signing_req.copy()
    input_files = _signing_req.pop("files")
    encoded_signing_req_bytes_io = BytesIO()
    encoded_signing_req_bytes_io.write(b"[{")
    for k, v in _signing_req.items():
        encoded_signing_req_bytes_io.write(json.dumps(k).encode("utf8"))
        encoded_signing_req_bytes_io.write(b":")
        encoded_signing_req_bytes_io.write(json.dumps(v).encode("utf8"))
        encoded_signing_req_bytes_io.write(b",")
    encoded_signing_req_bytes_io.write(json.dumps("files").encode("utf8"))
    encoded_signing_req_bytes_io.write(b":")
    encoded_signing_req_bytes_io.write(b"[")
    for input_file in input_files:
        encoded_signing_req_bytes_io.write(b"{")
        encoded_signing_req_bytes_io.write(json.dumps("name").encode("utf8"))
        encoded_signing_req_bytes_io.write(b":")
        encoded_signing_req_bytes_io.write(json.dumps(os.path.basename(input_file["name"])).encode("utf8"))
        encoded_signing_req_bytes_io.write(b",")
        encoded_signing_req_bytes_io.write(json.dumps("content").encode("utf8"))
        encoded_signing_req_bytes_io.write(b":")
        input_file["content"].seek(0)
        encoded_signing_req_bytes_io.write(b'"')
        while True:
            block = input_file["content"].read(1020)
            if not block:
                break
            encoded_block = b64encode(block).encode("utf8")
            encoded_signing_req_bytes_io.write(encoded_block)
        encoded_signing_req_bytes_io.write(b'"')
        encoded_signing_req_bytes_io.write(b"},")
    encoded_signing_req_bytes_io.seek(-2, 1)
    encoded_signing_req_bytes_io.write(b"}]}]")
    encoded_signing_req_bytes_io.seek(0)
    encoded_signing_req_bytes = encoded_signing_req_bytes_io.read()
    fp.write(encoded_signing_req_bytes)


def write_signing_req_to_disk(fp, signing_req):
    """Write signing_req to fp.

    Does proper base64 and json encoding.
    Tries not to hold onto a lot of memory.
    """
    if "files" in signing_req:
        _encode_multiple_files(fp, signing_req)
    else:
        _encode_single_file(fp, signing_req)


def get_hawk_content_hash(request_body, content_type):
    """Generate the content hash of the given request."""
    h = hashlib.new("sha256")
    h.update(b"hawk.1.payload\n")
    h.update(content_type.encode("utf8"))
    h.update(b"\n")
    while True:
        block = request_body.read(1024)
        if not block:
            break
        h.update(block)
    h.update(b"\n")
    return b64encode(h.digest())


def get_hawk_header(url, user, password, content_type, content_hash):
    """Create a HAWK Authentication header."""
    r = mohawk.base.Resource(credentials={"id": user, "key": password, "algorithm": "sha256"}, url=url, method="POST", content_type=content_type)
    r._content_hash = content_hash
    mac = mohawk.util.calculate_mac("header", r, r.content_hash)
    a = mohawk.base.HawkAuthority()
    auth_header = a._make_header(r, mac)
    return auth_header


@time_async_function
async def call_autograph(session, url, user, password, sign_req):
    """Call autograph and return the json response."""
    content_type = "application/json"

    request_body = tempfile.TemporaryFile("w+b")
    write_signing_req_to_disk(request_body, sign_req)
    request_body.seek(0)

    content_hash = get_hawk_content_hash(request_body, content_type)

    auth_header = get_hawk_header(url, user, password, content_type, content_hash)

    request_body.seek(0, 2)
    req_size = request_body.tell()
    log.debug("req_size: %s", req_size)
    request_body.seek(0)

    resp = await session.post(url, data=request_body, headers={"Authorization": auth_header, "Content-Type": content_type, "Content-Length": str(req_size)})
    log.debug("Autograph response: %s", resp.status)
    resp.raise_for_status()
    # TODO: Write this out to temporary file. The responses can be large,
    # especially in the case of APK/omnija signing where the entire file is
    # being sent and returned.
    return await resp.json()


def b64encode(input_bytes):
    """Return a base64 encoded string."""
    return base64.b64encode(input_bytes).decode("ascii")


def _is_xpi_format(fmt):
    if "omnija" in fmt or "langpack" in fmt:
        return True
    if fmt in ("privileged_webextension", "system_addon"):
        return True
    return False


@time_function
def make_signing_req(input_file, fmt, keyid=None, extension_id=None):
    """Make a signing request object to pass to autograph."""
    if isinstance(input_file, list):
        sign_req = {"files": []}
        for f in input_file:
            sign_req["files"].append({"name": f.name, "content": f})
    else:
        sign_req = {"input": input_file}

    if keyid:
        sign_req["keyid"] = keyid

    # TODO: Is this the right place to do this?
    if utils.is_apk_autograph_signing_format(fmt):
        # We don't want APKs to have their compression changed
        sign_req["options"] = {"zip": "passthrough"}

        if utils.is_sha1_apk_autograph_signing_format(fmt):
            # We ask for a SHA1 digest from Autograph
            # https://github.com/mozilla-services/autograph/pull/166/files
            sign_req["options"]["pkcs7_digest"] = "SHA1"

    if _is_xpi_format(fmt):
        sign_req.setdefault("options", {})
        # https://bugzilla.mozilla.org/show_bug.cgi?id=1533818#c9
        sign_req["options"]["id"] = extension_id
        sign_req["options"]["cose_algorithms"] = ["ES256"]
        sign_req["options"]["pkcs7_digest"] = "SHA256"

    return sign_req


@time_async_function
async def sign_with_autograph(session, server, input_file, fmt, autograph_method, keyid=None, extension_id=None):
    """Signs data with autograph and returns the result.

    Args:
        session (aiohttp.ClientSession): client session object
        server (Autograph): the server to connect to sign
        input_file (file object): the source data to sign
        fmt (str): the format to sign with
        autograph_method (str): which autograph method to use to sign. must be
                                one of 'file', 'hash', or 'data'
        keyid (str): which key to use on autograph (optional)
        extension_id (str): which id to send to autograph for the extension (optional)

    Raises:
        aiohttp.ClientError: on failure
        SigningScriptError: when no suitable signing server is found for fmt

    Returns:
        bytes: the signed data

    """
    if autograph_method not in {"file", "hash", "data", "files"}:
        raise SigningScriptError(f"Unsupported autograph method: {autograph_method}")

    keyid = keyid or server.key_id
    sign_req = make_signing_req(input_file, fmt, keyid, extension_id)

    url = f"{server.url}/sign/{autograph_method}"

    sign_resp = await retry_async(
        call_autograph, args=(session, url, server.client_id, server.access_key, sign_req), attempts=3, sleeptime_kwargs={"delay_factor": 2.0}
    )

    if autograph_method == "file":
        return sign_resp[0]["signed_file"]
    elif autograph_method == "files":
        return sign_resp[0]["signed_files"]
    else:
        return sign_resp[0]["signature"]


@time_async_function
async def sign_file_with_autograph(context, from_, fmt, to=None, extension_id=None):
    """Signs file with autograph and writes the results to a file.

    Args:
        context (Context): the signing context
        from_ (str): the source file to sign
        fmt (str): the format to sign with
        to (str, optional): the target path to sign to. If None, overwrite
                            `from_`. Defaults to None.
        extension_id (str, optional): the extension id to use when signing.

    Raises:
        aiohttp.ClientError: on failure
        SigningScriptError: when no suitable signing server is found for fmt

    Returns:
        str: the path to the signed file

    """
    cert_type = task.task_cert_type(context)
    a = get_autograph_config(context.autograph_configs, cert_type, [fmt], raise_on_empty=True)
    to = to or from_
    input_file = open(from_, "rb")
    signed_bytes = base64.b64decode(await sign_with_autograph(context.session, a, input_file, fmt, "file", extension_id=extension_id))
    with open(to, "wb") as fout:
        fout.write(signed_bytes)
    return to


@time_async_function
async def sign_gpg_with_autograph(context, from_, fmt, **kwargs):
    """Signs file with autograph and writes the results to a file.

    Args:
        context (Context): the signing context
        from_ (str): the source file to sign
        fmt (str): the format to sign with

    Raises:
        aiohttp.ClientError: on failure
        SigningScriptError: when no suitable signing server is found for fmt

    Returns:
        list: the path to the signed file, and sig.

    """
    cert_type = task.task_cert_type(context)
    a = get_autograph_config(context.autograph_configs, cert_type, [fmt], raise_on_empty=True)
    to = f"{from_}.asc"
    input_file = open(from_, "rb")
    signature = await sign_with_autograph(context.session, a, input_file, fmt, "data")
    with open(to, "w") as fout:
        fout.write(signature)
    return [from_, to]


@time_async_function
async def sign_hash_with_autograph(context, hash_, fmt, keyid=None):
    """Signs hash with autograph and returns the result.

    Args:
        context (Context): the signing context
        hash_ (bytes): the input hash to sign
        fmt (str): the format to sign with
        keyid (str): which key to use on autograph (optional)

    Raises:
        aiohttp.ClientError: on failure
        SigningScriptError: when no suitable signing server is found for fmt

    Returns:
        bytes: the signature

    """
    cert_type = task.task_cert_type(context)
    a = get_autograph_config(context.autograph_configs, cert_type, [fmt], raise_on_empty=True)
    input_file = BytesIO(hash_)
    signature = base64.b64decode(await sign_with_autograph(context.session, a, input_file, fmt, "hash", keyid))
    return signature


@time_async_function
async def sign_file_detached(context, file_, fmt, keyid=None, **kwargs):
    """Signs the sha256 hash of a file and returns is along with a detached signature.

    Args:
        context (Context): the signing context
        hash_ (bytes): the input hash to sign
        fmt (str): the format to sign with
        keyid (str): which key to use on autograph (optional)

    Raises:
        aiohttp.ClientError: on failure
        SigningScriptError: when no suitable signing server is found for fmt

    Returns:
        list: path to the original file and its detached signature named `file.sig`.
    """
    h = hashlib.sha256()
    with open(file_, "rb") as fh:
        h.update(fh.read())

    signature = await sign_hash_with_autograph(context, h.digest(), fmt, keyid=keyid)
    detached_signature = f"{file_}.sig"
    with open(detached_signature, "wb") as fh:
        fh.write(signature)

    log.info(f"Wrote autograph detached signature to {detached_signature}")
    return [file_, detached_signature]


def get_mar_verification_key(cert_type, fmt, keyid):
    """Get the public key file for the format/cert_type.

    Args:
        cert_type (str): the cert scope string
        fmt (str): the signing format
        keyid (str): the key id to use (can be None)

    Raises:
        SigningScriptError: if no key is found

    Returns:
        str: the public key to use with ``-k``

    """
    # Cert types are like ...
    cert_type = cert_type.split(":")[-1]
    data_dir = os.path.join(os.path.dirname(__file__), "data")
    try:
        if keyid is None:
            return os.path.join(data_dir, _DEFAULT_MAR_VERIFY_KEYS[fmt][cert_type])
        else:
            # Make sure you can't try and read outside of the data directory
            if "/" in keyid:
                raise SigningScriptError("/ not allowed in keyids")
            keyid = os.path.basename(keyid)
            return os.path.join(data_dir, f"{keyid}.pem")
    except KeyError as err:
        raise SigningScriptError(f"Can't find mar verify key for {fmt}, {cert_type} ({keyid}):\n{err}")


def verify_mar_signature(cert_type, fmt, mar, keyid=None):
    """Verify a mar signature, via mardor.

    Args:
        cert_type (str): the cert scope string
        fmt (str): the signing format
        mar (str): the path to the mar file
        keyid (str, optional): the key id to use (can be None)

    Raises:
        SigningScriptError: if the signature doesn't verify, or the nick isn't found

    """
    mar_verify_key = get_mar_verification_key(cert_type, fmt, keyid)
    try:
        mar_path = os.path.join(os.path.dirname(sys.executable), "mar")
        cmd = [mar_path, "-k", mar_verify_key, "-v", mar]
        log.info("Running %s", cmd)
        subprocess.check_call(cmd, stdout=sys.stdout, stderr=sys.stderr)
        log.info("Verified signature.")
    except subprocess.CalledProcessError as e:
        raise SigningScriptError(e)


@time_async_function
async def sign_mar384_with_autograph_hash(context, from_, fmt, to=None, **kwargs):
    """Signs a hash with autograph, injects it into the file, and writes the result to arg `to` or `from_` if `to` is None.

    Args:
        context (Context): the signing context
        from_ (str): the source file to sign
        fmt (str): the format to sign with
        to (str, optional): the target path to sign to. If None, overwrite
            `from_`. Defaults to None.

    Raises:
        aiohttp.ClientError: on failure
        SigningScriptError: when no suitable signing server is found for fmt

    Returns:
        str: the path to the signed file

    """
    cert_type = task.task_cert_type(context)
    # Get any key id that the task may have specified
    fmt, keyid = utils.split_autograph_format(fmt)
    # Call to check that we have a server available
    get_autograph_config(context.autograph_configs, cert_type, [fmt], raise_on_empty=True)

    hash_algo, expected_signature_length = "sha384", 512

    # Add a dummy signature into a temporary file (TODO: dedup with mardor.cli do_hash)
    with tempfile.TemporaryFile() as tmp:
        with open(from_, "rb") as f:
            add_signature_block(f, tmp, hash_algo)

        tmp.seek(0)

        with MarReader(tmp) as m:
            hashes = m.calculate_hashes()
        h = hashes[0][1]

    signature = await sign_hash_with_autograph(context, h, fmt, keyid)

    # Add a signature to the MAR file (TODO: dedup with mardor.cli do_add_signature)
    if len(signature) != expected_signature_length:
        raise SigningScriptError(
            "signed mar hash signature has invalid length for hash algo {}. Got {} expected {}.".format(hash_algo, len(signature), expected_signature_length)
        )

    # use the tmp file in case param `to` is `from_` which causes stream errors
    tmp_dst = tempfile.NamedTemporaryFile(mode="w+b", delete=False)
    with open(tmp_dst.name, "w+b") as dst:
        with open(from_, "rb") as src:
            add_signature_block(src, dst, hash_algo, signature)

    to = to or from_
    shutil.copyfile(tmp_dst.name, to)
    os.unlink(tmp_dst.name)

    verify_mar_signature(cert_type, fmt, to, keyid)

    log.info("wrote mar with autograph signed hash %s to %s", from_, to)
    return to


@time_async_function
async def sign_widevine_with_autograph(context, from_, blessed, to=None):
    """Create a widevine signature using autograph as a backend.

    Args:
        context (Context): the signing context
        from_ (str): the source file to sign
        fmt (str): the format to sign with
        blessed (bool): whether to use blessed signing or not
        to (str, optional): the target path to sign to. If None, write to
            `{from_}.sig`. Defaults to None.

    Raises:
        aiohttp.ClientError: on failure
        SigningScriptError: when no suitable signing server is found for fmt

    Returns:
        str: the path to the signature file

    """
    if not widevine:
        raise ImportError("widevine module not available")

    to = to or f"{from_}.sig"
    flags = 1 if blessed else 0
    fmt = "autograph_widevine"

    h = widevine.generate_widevine_hash(from_, flags)

    signature = await sign_hash_with_autograph(context, h, fmt)

    with open(to, "wb") as fout:
        certificate = open(context.config["widevine_cert"], "rb").read()
        sig = widevine.generate_widevine_signature(signature, certificate, flags)
        fout.write(sig)
    return to


@time_async_function
async def sign_omnija_with_autograph(context, from_):
    """Sign the omnija file specified using autograph.

    This function overwrites from_
    rebuild it using the signed meta-data and the original omni.ja
    in order to facilitate the performance wins we do as part of the build

    Args:
        context (Context): the signing context
        from_ (str): the source file to sign (overwrites)

    Raises:
        aiohttp.ClientError: on failure
        SigningScriptError: when no suitable signing server is found for fmt

    Returns:
        str: the path to the signature file

    """
    signed_out = tempfile.mkstemp(prefix="oj_signed", suffix=".ja", dir=context.config["work_dir"])[1]
    merged_out = tempfile.mkstemp(prefix="oj_merged", suffix=".ja", dir=context.config["work_dir"])[1]

    await sign_file_with_autograph(context, from_, "autograph_omnija", to=signed_out, extension_id="omni.ja@mozilla.org")
    await merge_omnija_files(orig=from_, signed=signed_out, to=merged_out)
    with open(from_, "wb") as fout:
        with open(merged_out, "rb") as fin:
            fout.write(fin.read())
    return from_


@time_async_function
async def merge_omnija_files(orig, signed, to):
    """Merge multiple omnijar files together.

    This takes the original file, and reads it in, including performance
    characteristics (e.g. jarlog ordering for preloading),
    then adds data from the "signed" copy (the META-INF folder)
    and finally writes it all out to a new omni.ja file.

    Args:
        context (Context): the signing context
        orig (str): the source file to sign
        signed (str): the signed file, without optimizations
        to (str): the output path for the merge

    Returns:
        bool: always True if function succeeded.

    """
    orig_jarreader = mozjar.JarReader(orig)
    with mozjar.JarWriter(to, compress=orig_jarreader.compression) as to_writer:
        for origjarfile in orig_jarreader:
            to_writer.add(origjarfile.filename, origjarfile, compress=origjarfile.compress)
        # Use ZipFile here because mozjar can't read the signed copies
        signed_zip = zipfile.ZipFile(signed, "r")
        for fname in signed_zip.namelist():
            if fname.startswith("META-INF"):
                to_writer.add(fname, signed_zip.open(fname, "r"))
        if orig_jarreader.last_preloaded:
            jarlog = list(orig_jarreader.entries.keys())
            preloads = jarlog[: jarlog.index(orig_jarreader.last_preloaded) + 1]
            to_writer.preload(preloads)
    return True


# sign_authenticode_file {{{1
async def _winsign_helper(error_message, *args, **kwargs):
    """Raise an exception if winsign.sign.sign_file returns False to enable retries."""
    if not await winsign.sign.sign_file(*args, **kwargs):
        raise SigningScriptError(error_message)


@time_async_function
async def sign_authenticode_file(context, orig_path, fmt, *, authenticode_comment=None):
    """Sign a file in-place with authenticode, using autograph as a backend.

    Args:
        context (Context): the signing context
        orig_path (str): the source file to sign
        fmt (str): the format to sign with
        comment (str): The authenticode comment to sign with, if present.
                       currently only used for msi files.
                       (Defaults to None)

    Returns:
        True on success, False otherwise

    """
    if winsign.osslsigncode.is_signed(orig_path):
        log.info("%s is already signed", orig_path)
        return True

    fmt, keyid = utils.split_autograph_format(fmt)

    async def signer(digest, digest_algo):
        try:
            return await sign_hash_with_autograph(context, digest, fmt, keyid)
        except Exception:
            log.exception("Error signing authenticode hash with autograph")
            raise

    infile = orig_path
    outfile = orig_path + "-new"
    if fmt in ["autograph_authenticode", "autograph_authenticode_stub"]:
        digest_algo = "sha1"
    else:
        digest_algo = "sha256"

    timestampfile = context.config["authenticode_ca_timestamp"]

    cafile_key = "authenticode_ca"
    cert_key = "authenticode_cert"

    if fmt == "autograph_authenticode_ev":
        cafile_key = f"{cafile_key}_ev"
        cert_key = f"{cert_key}_ev"

    if keyid:
        # Sometimes a given keyid may chain up to a shared intermediate, and
        # sometimes it may not. Check if a ca.crt with the given keyid exists
        # and fallback to the regular one if it doesn't.
        cafile = context.config.get(f"{cafile_key}_{keyid}", context.config[cafile_key])
        certs = load_pem_certs(open(context.config[f"{cert_key}_{keyid}"], "rb").read())
    else:
        cafile = context.config[cafile_key]
        certs = load_pem_certs(open(context.config[cert_key], "rb").read())

    url = context.config["authenticode_url"]
    if fmt == "autograph_authenticode_sha2_rfc3161_stub":
        fmt = "autograph_authenticode_sha2_stub"
        timestamp_style = "rfc3161"
    else:
        timestamp_style = context.config["authenticode_timestamp_style"]
    timestamp_url = context.config["authenticode_timestamp_url"]
    if fmt.endswith(("authenticode_stub", "authenticode_sha2_stub")):
        crosscert = context.config["authenticode_cross_cert"]
    else:
        crosscert = None

    if authenticode_comment and orig_path.endswith(".msi"):
        log.info("Using comment '%s' to sign %s", authenticode_comment, orig_path)
    elif authenticode_comment:
        log.info("Not using specified comment to sign %s, not yet implemented for non *.msi files.", orig_path)
        authenticode_comment = None

    winsign_kwargs = {
        "cafile": cafile,
        "timestampfile": timestampfile,
        "url": url,
        "comment": authenticode_comment,
        "crosscert": crosscert,
        "timestamp_style": timestamp_style,
        "timestamp_url": timestamp_url,
    }
    log.info(f"running winsign.sign.sign_file with kwargs {winsign_kwargs}...")
    # Retry winsign.sign.sign_file, because the timestamp server can hiccup
    await retry_async(
        _winsign_helper,
        args=(f"Couldn't sign {orig_path}", infile, outfile, digest_algo, certs, signer),
        kwargs=winsign_kwargs,
    )
    os.rename(outfile, infile)

    return True


# sign_authenticode {{{1
@time_async_function
async def sign_authenticode(context, orig_path, fmt, *, authenticode_comment=None, **kwargs):
    """Sign a file with authenticode, using autograph as a backend.

    Supported formats are a single file or a zip.

    If a zip is passed in, extract it and only sign unsigned files that don't
    match certain patterns (see `_should_sign_windows`). Then recreate the zip.

    Args:
        context (Context): the signing context
        orig_path (str): the source file to sign
        fmt (str): the format to sign with
        comment (str): The authenticode comment to sign with, if present.
                       currently only used for msi files.
                       (Defaults to None)

    Returns:
        str: the path to the signed file or re-created zip

    """
    _, file_extension = os.path.splitext(orig_path)
    # This will get cleaned up when we nuke `work_dir`. Clean up at that point
    # rather than immediately after `sign_signcode`, to optimize task runtime
    # speed over disk space.
    tmp_dir = None
    # Extract the zipfile
    if file_extension == ".zip":
        tmp_dir = tempfile.mkdtemp(prefix="zip", dir=context.config["work_dir"])
        files = await _extract_zipfile(context, orig_path, tmp_dir=tmp_dir)
    else:
        files = [orig_path]
    files_to_sign = [file for file in files if _should_sign_windows(file)]
    if not files_to_sign:
        raise SigningScriptError("Did not find any files to sign, all files: {}".format(files))

    # Sign the appropriate inner files
    tasks = [asyncio.create_task(sign_authenticode_file(context, file_, fmt, authenticode_comment=authenticode_comment)) for file_ in files_to_sign]
    done, pending = await asyncio.wait(tasks, return_when=asyncio.FIRST_EXCEPTION)
    [f.result() for f in done]
    if file_extension == ".zip":
        # Recreate the zipfile
        await _create_zipfile(context, orig_path, files, tmp_dir=tmp_dir)
    return orig_path


@time_async_function
async def sign_debian_pkg(context, path, fmt, *args, **kwargs):
    """
    Sign a debian package using autograph's debsign support.

    Unpacks a tarball and signs the .dsc .buildinfo .changes files using the autograph /sign/files end-point.
    Then, it re-compresses the tarball and uploads the new tarball with the signed files as an artifact.
    """
    cert_type = task.task_cert_type(context)
    autograph_config = get_autograph_config(context.autograph_configs, cert_type, [fmt], raise_on_empty=True)
    cert_type = task.task_cert_type(context)
    _, compression = os.path.splitext(path)
    # Find *.dsc *.buildinfo *.changes. These are the files in the debian package we need to sign.
    extensions = (".dsc", ".buildinfo", ".changes")
    tmp_dir = os.path.join(context.config["work_dir"], "untarred")
    all_file_names = await _extract_tarfile(context, path, compression, tmp_dir=tmp_dir)
    input_file_names = [input_file_name for input_file_name in all_file_names if input_file_name.endswith(extensions)]
    basename_to_file_name = {os.path.basename(input_file_name): input_file_name for input_file_name in input_file_names}
    with ExitStack() as stack:
        input_files = [stack.enter_context(open(input_file_name, "rb")) for input_file_name in input_file_names]
        signed_files = await sign_with_autograph(
            context.session,
            autograph_config,
            input_files,
            fmt,
            "files",
        )
    # go from base64 back to bytes before writing the files to disk
    signed_files = [{"name": basename_to_file_name[signed_file["name"]], "content": base64.b64decode(signed_file["content"])} for signed_file in signed_files]
    for signed_file in signed_files:
        with open(signed_file["name"], "wb") as output_file:
            output_file.write(signed_file["content"])
    await _create_tarfile(context, path, all_file_names, compression, tmp_dir=tmp_dir)
    return path