404

D7net
:/ lib / python3 / dist-packages / uaclient /
Filename : security_status.py
back
from collections import defaultdict
from datetime import datetime, timezone
from enum import Enum
from functools import lru_cache
from random import choice
from typing import Any, DefaultDict, Dict, List, Tuple

import apt_pkg  # type: ignore

from uaclient import exceptions, livepatch, messages, util
from uaclient.api.u.pro.security.status.reboot_required.v1 import (
    _reboot_required,
)
from uaclient.api.u.pro.status.is_attached.v1 import _is_attached
from uaclient.apt import (
    PreserveAptCfg,
    get_apt_cache_datetime,
    get_apt_pkg_cache,
    get_esm_apt_pkg_cache,
    get_pkg_candidate_version,
)
from uaclient.config import UAConfig
from uaclient.entitlements import ESMAppsEntitlement, ESMInfraEntitlement
from uaclient.entitlements.entitlement_status import (
    ApplicabilityStatus,
    ApplicationStatus,
    ContractStatus,
)
from uaclient.system import (
    get_distro_info,
    get_kernel_info,
    get_release_info,
    is_current_series_lts,
    is_supported,
)

ESM_SERVICES = ("esm-infra", "esm-apps")


class UpdateStatus(Enum):
    "Represents the availability of a security package."
    AVAILABLE = "upgrade_available"
    AVAILABLE_NOT_PREFERRED = "upgrade_available_not_preferred"
    UNATTACHED = "pending_attach"
    NOT_ENABLED = "pending_enable"
    UNAVAILABLE = "upgrade_unavailable"


def print_package_list(packages):
    print(util.create_package_list_str(packages))


@lru_cache(maxsize=None)
def get_origin_information_to_service_map():
    series = get_release_info().series
    return {
        ("Ubuntu", "{}-security".format(series)): "standard-security",
        ("UbuntuESMApps", "{}-apps-security".format(series)): "esm-apps",
        ("UbuntuESM", "{}-infra-security".format(series)): "esm-infra",
        ("UbuntuESMApps", "{}-apps-updates".format(series)): "esm-apps",
        ("UbuntuESM", "{}-infra-updates".format(series)): "esm-infra",
    }


def get_installed_packages_by_origin() -> (
    DefaultDict["str", List[apt_pkg.Package]]
):
    result = defaultdict(list)

    with PreserveAptCfg(get_apt_pkg_cache) as cache:
        installed_packages = [
            package for package in cache.packages if package.current_ver
        ]
        result["all"] = installed_packages

        dep_cache = apt_pkg.DepCache(cache)

        for package in installed_packages:
            result[
                get_origin_for_installed_package(package, dep_cache)
            ].append(package)

    return result


def get_origin_for_installed_package(
    package: apt_pkg.Package, dep_cache: apt_pkg.DepCache
) -> str:
    """
    Returns the origin for a package installed in the system.

    Technically speaking, packages don't have origins - their versions do.
    We check the available versions (installed, candidate) to determine the
    most reasonable origin for the package.
    """
    # We assume that packages we pass are installed
    if not package.current_ver:
        return ""
    available_origins = package.current_ver.file_list

    # If the installed version for a package has a single origin, it means that
    # only the local dpkg reference is there. Then, we check if there is a
    # candidate version. No candidate means we don't know anything about the
    # package. Otherwise we check for the origins of the candidate version.
    if len(available_origins) == 1:
        candidate = dep_cache.get_candidate_ver(package)
        if not candidate or package.current_ver == candidate:
            return "unknown"
        available_origins = candidate.file_list

    for origin, _ in available_origins:
        service = get_origin_information_to_service_map().get(
            (origin.origin, origin.archive), ""
        )
        if service in ESM_SERVICES:
            return service
        if origin.origin == "Ubuntu":
            return origin.component

    return "third-party"


@lru_cache(maxsize=None)
def _is_candidate_version(pkg: str, version: str) -> bool:
    """Returns True if the package version is a candidate version."""
    candidate_version = get_pkg_candidate_version(pkg, check_esm_cache=False)
    if candidate_version:
        return version == candidate_version
    return False


def get_update_status(
    service_name: str,
    ua_info: Dict[str, Any],
    version: apt_pkg.Version,
) -> str:
    """Defines the update status for a package based on the service name.

    For ESM-[Infra|Apps] packages, first checks if Pro is attached. If this is
    the case, also check for availability of the service.
    """
    if service_name in ("standard-security", "standard-updates") or (
        ua_info["attached"] and service_name in ua_info["enabled_services"]
    ):
        is_candidate = _is_candidate_version(
            version.parent_pkg.name, version.ver_str
        )
        return (
            UpdateStatus.AVAILABLE.value
            if is_candidate
            else UpdateStatus.AVAILABLE_NOT_PREFERRED.value
        )
    if not ua_info["attached"]:
        return UpdateStatus.UNATTACHED.value
    if service_name in ua_info["entitled_services"]:
        return UpdateStatus.NOT_ENABLED.value
    return UpdateStatus.UNAVAILABLE.value


def filter_updates(
    packages: List[apt_pkg.Package],
) -> DefaultDict[str, List[Tuple[apt_pkg.Version, str]]]:
    """Filters a list of packages looking for available updates.

    All versions greater than the installed one are reported, based on where
    it is provided, including ESM pockets, excluding backports.
    """
    result = defaultdict(list)

    # This esm_cache will only be usefull for the situation where
    # the user does not have the esm (infra or apps) services enabled,
    # but has be advertised about esm packages. Since those
    # sources live in a private folder, we need a different apt cache
    # to access them.
    with PreserveAptCfg(get_esm_apt_pkg_cache) as esm_cache:
        for package in packages:
            # We only care about installed packages here
            if package.current_ver:
                for version in package.version_list:
                    # Seems mypy cannot understand we can compare these :/
                    if version > package.current_ver:  # type: ignore
                        counted_as_security = False
                        for origin, _ in version.file_list:
                            service = (
                                get_origin_information_to_service_map().get(
                                    (origin.origin, origin.archive)
                                )
                            )
                            if service:
                                result[service].append((version, origin.site))
                                counted_as_security = True
                                # No need to loop through all the origins
                                break
                        # Also no need to report backports at least for now...
                        expected_origin = version.file_list[0][0]
                        if (
                            not counted_as_security
                            and "backports" not in expected_origin.archive
                        ):
                            result["standard-updates"].append(
                                (version, expected_origin.site)
                            )

                # This loop should be only used if the user does not have esm
                # (infra or apps) enabled, and it is shorter than the
                # previous one
                if package.name in esm_cache:
                    esm_package = esm_cache[package.name]
                    for version in esm_package.version_list:
                        if version > package.current_ver:  # type: ignore
                            for origin, _ in version.file_list:
                                service = get_origin_information_to_service_map().get(  # noqa: E501
                                    (origin.origin, origin.archive)
                                )
                                if service:
                                    result[service].append(
                                        (version, origin.site)
                                    )
                                    break

    return result


def get_ua_info(cfg: UAConfig) -> Dict[str, Any]:
    """Returns the Pro information based on the config object."""
    is_attached = _is_attached(cfg).is_attached
    ua_info = {
        "attached": is_attached,
        "enabled_services": [],
        "entitled_services": [],
    }  # type: Dict[str, Any]

    if is_attached:
        infra_entitlement = ESMInfraEntitlement(cfg)
        apps_entitlement = ESMAppsEntitlement(cfg)

        if apps_entitlement.contract_status() == ContractStatus.ENTITLED:
            ua_info["entitled_services"].append("esm-apps")
        if (
            apps_entitlement.application_status()[0]
            == ApplicationStatus.ENABLED
        ):
            ua_info["enabled_services"].append("esm-apps")

        if infra_entitlement.contract_status() == ContractStatus.ENTITLED:
            ua_info["entitled_services"].append("esm-infra")
        if (
            infra_entitlement.application_status()[0]
            == ApplicationStatus.ENABLED
        ):
            ua_info["enabled_services"].append("esm-infra")

    return ua_info


# Yeah Any is bad, but so is python<3.8 without TypedDict
def get_livepatch_fixed_cves() -> List[Dict[str, Any]]:
    try:
        lp_status = livepatch.status()
    except exceptions.ProcessExecutionError:
        return []

    our_kernel_version = get_kernel_info().proc_version_signature_version
    if (
        lp_status is not None
        and our_kernel_version is not None
        and our_kernel_version == lp_status.kernel
        and lp_status.livepatch is not None
        and lp_status.livepatch.state == "applied"
        and lp_status.livepatch.fixes is not None
        and len(lp_status.livepatch.fixes) > 0
    ):
        return [
            {"name": fix.name or "", "patched": fix.patched or False}
            for fix in lp_status.livepatch.fixes
        ]

    return []


def create_updates_list(
    upgradable_versions: DefaultDict[str, List[Tuple[apt_pkg.Version, str]]],
    ua_info: Dict[str, Any],
) -> List[Dict[str, Any]]:
    updates = []
    for service, version_list in upgradable_versions.items():
        for version, origin in version_list:
            status = get_update_status(service, ua_info, version)
            updates.append(
                {
                    "package": version.parent_pkg.name,
                    "version": version.ver_str,
                    "service_name": service,
                    "status": status,
                    "origin": origin,
                    "download_size": version.size,
                }
            )

    return updates


def security_status_dict(cfg: UAConfig) -> Dict[str, Any]:
    """Returns the status of security updates on a system.

    The returned dict has a 'packages' key with a list of all installed
    packages which can receive security updates, with or without ESM,
    reflecting the availability of the update based on the Pro status.

    There is also a summary with the Ubuntu Pro information and the package
    counts.
    """
    ua_info = get_ua_info(cfg)

    summary = {"ua": ua_info}  # type: Dict[str, Any]
    packages_by_origin = get_installed_packages_by_origin()

    installed_packages = packages_by_origin["all"]
    summary["num_installed_packages"] = len(installed_packages)

    upgradable_versions = filter_updates(installed_packages)
    # This version of security-status only cares about security updates
    upgradable_versions["standard-updates"] = []

    updates = create_updates_list(upgradable_versions, ua_info)

    summary["num_main_packages"] = len(packages_by_origin["main"])
    summary["num_restricted_packages"] = len(packages_by_origin["restricted"])
    summary["num_universe_packages"] = len(packages_by_origin["universe"])
    summary["num_multiverse_packages"] = len(packages_by_origin["multiverse"])
    summary["num_third_party_packages"] = len(
        packages_by_origin["third-party"]
    )
    summary["num_unknown_packages"] = len(packages_by_origin["unknown"])
    summary["num_esm_infra_packages"] = len(packages_by_origin["esm-infra"])
    summary["num_esm_apps_packages"] = len(packages_by_origin["esm-apps"])

    summary["num_esm_infra_updates"] = len(upgradable_versions["esm-infra"])
    summary["num_esm_apps_updates"] = len(upgradable_versions["esm-apps"])
    summary["num_standard_security_updates"] = len(
        upgradable_versions["standard-security"]
    )
    summary["reboot_required"] = _reboot_required(cfg).reboot_required

    return {
        "_schema_version": "0.1",
        "summary": summary,
        "packages": updates,
        "livepatch": {"fixed_cves": get_livepatch_fixed_cves()},
    }


def _print_package_summary(
    package_lists: DefaultDict[str, List[apt_pkg.Package]],
    show_items: str = "all",
    always_show: bool = False,
) -> None:
    total_packages = len(package_lists["all"])
    print(messages.SS_SUMMARY_TOTAL.format(count=total_packages))

    offset = " " * (len(str(total_packages)) + 1)

    if show_items in ("all", "esm-infra"):
        packages_mr = (
            len(package_lists["main"])
            + len(package_lists["restricted"])
            + len(package_lists["esm-infra"])
        )
        print(
            messages.SS_SUMMARY_ARCHIVE.pluralize(packages_mr).format(
                offset=offset,
                count=packages_mr,
                repository="Main/Restricted",
            )
        )

    if show_items in ("all", "esm-apps"):
        packages_um = (
            len(package_lists["universe"])
            + len(package_lists["multiverse"])
            + len(package_lists["esm-apps"])
        )
        if packages_um or always_show:
            print(
                messages.SS_SUMMARY_ARCHIVE.pluralize(packages_um).format(
                    offset=offset,
                    count=packages_um,
                    repository="Universe/Multiverse",
                )
            )

    if show_items in ("all", "third-party"):
        packages_thirdparty = len(package_lists["third-party"])
        if packages_thirdparty or always_show:
            print(
                messages.SS_SUMMARY_THIRD_PARTY.pluralize(
                    packages_thirdparty
                ).format(offset=offset, count=packages_thirdparty)
            )

    if show_items in ("all", "unknown"):
        packages_unknown = len(package_lists["unknown"])
        if packages_unknown or always_show:
            print(
                messages.SS_SUMMARY_UNAVAILABLE.pluralize(
                    packages_unknown
                ).format(
                    offset=offset,
                    count=packages_unknown,
                )
            )

    print("")


def _print_interim_release_support():
    series = get_release_info().series
    eol_date = get_distro_info(series).eol
    date = "{}/{}".format(str(eol_date.month), str(eol_date.year))
    print(messages.SS_INTERIM_SUPPORT.format(date=date))
    print("")


def _print_lts_support():
    series = get_release_info().series
    if is_supported(series):
        eol_date = get_distro_info(series).eol
        print(messages.SS_LTS_SUPPORT.format(date=str(eol_date.year)))
    else:
        print(messages.SS_NO_SECURITY_COVERAGE)


def _print_service_support(
    service: str,
    repository: str,
    service_status: ApplicationStatus,
    service_applicability: ApplicabilityStatus,
    installed_updates: int,
    available_updates: int,
    is_attached: bool,
):
    series = get_release_info().series
    eol_date_esm = get_distro_info(series).eol_esm
    if service_status == ApplicationStatus.ENABLED:
        message = messages.SS_SERVICE_ENABLED.format(
            repository=repository,
            service=service,
            year=str(eol_date_esm.year),
        )
    else:
        message = messages.SS_SERVICE_ADVERTISE.format(
            service=service,
            repository=repository,
            year=str(eol_date_esm.year),
        )

    if installed_updates:
        message += " " + messages.SS_SERVICE_ENABLED_COUNTS.pluralize(
            installed_updates
        ).format(
            updates=installed_updates,
        )

    if available_updates:
        message += " " + messages.SS_SERVICE_ADVERTISE_COUNTS.pluralize(
            available_updates
        ).format(
            updates=available_updates,
        )
    print(message)

    if (
        is_attached
        and service_status == ApplicationStatus.DISABLED
        and service_applicability == ApplicabilityStatus.APPLICABLE
    ):
        print("")
        print(messages.SS_SERVICE_COMMAND.format(service=service))

    print("")


def _print_apt_update_call():
    last_apt_update = get_apt_cache_datetime()
    if last_apt_update is None:
        print(messages.SS_UPDATE_UNKNOWN)
        print("")
        return

    now = datetime.now(timezone.utc)
    time_since_update = now - last_apt_update
    if time_since_update.days > 0:
        print(messages.SS_UPDATE_DAYS.format(days=time_since_update.days))
        print("")


def security_status(cfg: UAConfig):
    esm_infra_ent = ESMInfraEntitlement(cfg)
    esm_apps_ent = ESMAppsEntitlement(cfg)

    esm_infra_status = esm_infra_ent.application_status()[0]
    esm_infra_applicability = esm_infra_ent.applicability_status()[0]
    esm_apps_status = esm_apps_ent.application_status()[0]
    esm_apps_applicability = esm_apps_ent.applicability_status()[0]

    series = get_release_info().series
    is_lts = is_current_series_lts()
    is_attached = get_ua_info(cfg)["attached"]

    packages_by_origin = get_installed_packages_by_origin()
    security_upgradable_versions_infra = filter_updates(
        packages_by_origin["main"]
        + packages_by_origin["restricted"]
        + packages_by_origin["esm-infra"],
    )["esm-infra"]

    security_upgradable_versions_apps = filter_updates(
        packages_by_origin["universe"]
        + packages_by_origin["multiverse"]
        + packages_by_origin["esm-apps"],
    )["esm-apps"]

    _print_package_summary(packages_by_origin)

    print(messages.SS_HELP_CALL)
    print("")

    _print_apt_update_call()

    if not is_lts:
        if is_supported(series):
            _print_interim_release_support()
        print(messages.SS_NO_INTERIM_PRO_SUPPORT)
        return

    if esm_infra_status == ApplicationStatus.DISABLED:
        _print_lts_support()

    if is_attached:
        print(messages.SS_IS_ATTACHED)
    else:
        print(messages.SS_IS_NOT_ATTACHED)
    print("")

    _print_service_support(
        service="esm-infra",
        repository="Main/Restricted",
        service_status=esm_infra_status,
        service_applicability=esm_infra_applicability,
        installed_updates=len(packages_by_origin["esm-infra"]),
        available_updates=len(security_upgradable_versions_infra),
        is_attached=is_attached,
    )

    if (
        packages_by_origin["universe"]
        or packages_by_origin["multiverse"]
        or packages_by_origin["esm-apps"]
    ):
        _print_service_support(
            service="esm-apps",
            repository="Universe/Multiverse",
            service_status=esm_apps_status,
            service_applicability=esm_apps_applicability,
            installed_updates=len(packages_by_origin["esm-apps"]),
            available_updates=len(security_upgradable_versions_apps),
            is_attached=is_attached,
        )

    if not is_attached:
        print(messages.SS_LEARN_MORE)


def list_third_party_packages():
    packages_by_origin = get_installed_packages_by_origin()
    third_party_packages = packages_by_origin["third-party"]
    package_names = [package.name for package in third_party_packages]

    _print_package_summary(
        packages_by_origin, show_items="third-party", always_show=True
    )

    if third_party_packages:
        print(messages.SS_THIRD_PARTY)

        print("")
        print(messages.SS_PACKAGES_HEADER)
        print_package_list(package_names)
        print(messages.SS_SHOW_HINT.format(package=choice(package_names)))
    else:
        print(messages.SS_NO_THIRD_PARTY)


def list_unavailable_packages():
    packages_by_origin = get_installed_packages_by_origin()
    unknown_packages = packages_by_origin["unknown"]
    package_names = [package.name for package in unknown_packages]

    _print_package_summary(
        packages_by_origin, show_items="unknown", always_show=True
    )

    if unknown_packages:
        print(messages.SS_UNAVAILABLE)
        print("")

        print(messages.SS_PACKAGES_HEADER)
        print_package_list(package_names)
        print(messages.SS_SHOW_HINT.format(package=choice(package_names)))

    else:
        print(messages.SS_NO_UNAVAILABLE)


def list_esm_infra_packages(cfg):
    packages_by_origin = get_installed_packages_by_origin()
    infra_packages = packages_by_origin["esm-infra"]
    mr_packages = packages_by_origin["main"] + packages_by_origin["restricted"]

    all_infra_packages = infra_packages + mr_packages

    infra_updates = set()
    security_upgradable_versions = filter_updates(all_infra_packages)[
        "esm-infra"
    ]
    for update, _ in security_upgradable_versions:
        infra_updates.add(update.parent_pkg)

    series = get_release_info().series
    is_lts = is_current_series_lts()

    esm_infra_ent = ESMInfraEntitlement(cfg)
    esm_apps_ent = ESMAppsEntitlement(cfg)

    esm_infra_status = esm_infra_ent.application_status()[0]
    esm_infra_applicability = esm_apps_ent.applicability_status()[0]

    installed_package_names = sorted(
        [package.name for package in infra_packages]
    )
    available_package_names = sorted(
        [package.name for package in infra_updates]
    )
    remaining_package_names = sorted(
        [
            package.name
            for package in all_infra_packages
            if package.name not in installed_package_names
            and package.name not in available_package_names
        ]
    )

    _print_package_summary(
        packages_by_origin, show_items="esm-infra", always_show=True
    )

    if not is_lts:
        if is_supported(series):
            _print_interim_release_support()
        print(messages.SS_NO_INTERIM_PRO_SUPPORT)
        return

    if esm_infra_status == ApplicationStatus.DISABLED:
        _print_lts_support()
        print("")

    _print_service_support(
        service="esm-infra",
        repository="Main/Restricted",
        service_status=esm_infra_status,
        service_applicability=esm_infra_applicability,
        installed_updates=len(infra_packages),
        available_updates=len(infra_updates),
        is_attached=False,  # don't care about the `enable` message
    )
    print(messages.SS_SERVICE_HELP.format(service="esm-infra"))
    print("")

    if not is_supported(series):
        if available_package_names:
            print(messages.SS_UPDATES_AVAILABLE.format(service="esm-infra"))
            print_package_list(available_package_names)

        if installed_package_names:
            print(messages.SS_UPDATES_INSTALLED.format(service="esm-infra"))
            print_package_list(installed_package_names)

        hint_list = available_package_names or installed_package_names
        # Check names because packages may have been already listed
        if remaining_package_names:
            if hint_list:
                msg = messages.SS_FURTHER_OTHER_PACKAGES.format(
                    service="esm-infra"
                )
            else:
                msg = messages.SS_OTHER_PACKAGES.format(service="esm-infra")
            print(msg)
            print_package_list(remaining_package_names)

        if hint_list:
            print(messages.SS_SHOW_HINT.format(package=choice(hint_list)))


def list_esm_apps_packages(cfg):
    packages_by_origin = get_installed_packages_by_origin()
    apps_packages = packages_by_origin["esm-apps"]
    um_packages = (
        packages_by_origin["universe"] + packages_by_origin["multiverse"]
    )

    all_apps_packages = apps_packages + um_packages

    apps_updates = set()
    security_upgradable_versions = filter_updates(all_apps_packages)[
        "esm-apps"
    ]
    for update, _ in security_upgradable_versions:
        apps_updates.add(update.parent_pkg)

    is_lts = is_current_series_lts()

    esm_apps_ent = ESMAppsEntitlement(cfg)
    esm_apps_status = esm_apps_ent.application_status()[0]
    esm_apps_applicability = esm_apps_ent.applicability_status()[0]

    installed_package_names = sorted(
        [package.name for package in apps_packages]
    )
    available_package_names = sorted(
        [package.name for package in apps_updates]
    )
    remaining_package_names = sorted(
        [
            package.name
            for package in all_apps_packages
            if package.name not in installed_package_names
            and package.name not in available_package_names
        ]
    )

    _print_package_summary(
        packages_by_origin, show_items="esm-apps", always_show=True
    )

    if not is_lts:
        print(messages.SS_NO_INTERIM_PRO_SUPPORT)
        return

    _print_service_support(
        service="esm-apps",
        repository="Universe/Multiverse",
        service_status=esm_apps_status,
        service_applicability=esm_apps_applicability,
        installed_updates=len(apps_packages),
        available_updates=len(apps_updates),
        is_attached=False,  # don't care about the `enable` message
    )
    print(messages.SS_SERVICE_HELP.format(service="esm-apps"))
    print("")

    if all_apps_packages:
        if available_package_names:
            print(messages.SS_UPDATES_AVAILABLE.format(service="esm-apps"))
            print_package_list(available_package_names)

        if installed_package_names:
            print(messages.SS_UPDATES_INSTALLED.format(service="esm-apps"))
            print_package_list(installed_package_names)

        hint_list = available_package_names or installed_package_names

        # Check names because packages may have been already listed
        if remaining_package_names:
            if hint_list:
                msg = messages.SS_FURTHER_OTHER_PACKAGES.format(
                    service="esm-apps"
                )
            else:
                msg = messages.SS_OTHER_PACKAGES.format(service="esm-apps")
            print(msg)
            print_package_list(remaining_package_names)

        if hint_list:
            print(messages.SS_SHOW_HINT.format(package=choice(hint_list)))