Current File : //lib/python3/dist-packages/uaclient/security_status.py
from collections import defaultdict
from enum import Enum
from typing import Any, DefaultDict, Dict, List, Tuple # noqa: F401
from apt import Cache # type: ignore
from apt import package as apt_package
from uaclient.config import UAConfig
from uaclient.status import status
from uaclient.util import get_platform_info
series = get_platform_info()["series"]
ESM_SERVICES = ("esm-infra", "esm-apps")
ORIGIN_INFORMATION_TO_SERVICE = {
("Ubuntu", "{}-security".format(series)): "standard-security",
("UbuntuESMApps", "{}-apps-security".format(series)): "esm-apps",
("UbuntuESM", "{}-infra-security".format(series)): "esm-infra",
}
class UpdateStatus(Enum):
"Represents the availability of a security package."
AVAILABLE = "upgrade_available"
UNATTACHED = "pending_attach"
NOT_ENABLED = "pending_enable"
UNAVAILABLE = "upgrade_unavailable"
def get_origin_for_package(package: apt_package.Package) -> 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.
"""
available_origins = package.installed.origins
# 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:
if package.installed == package.candidate:
return "unknown"
available_origins = package.candidate.origins
for origin in available_origins:
service = ORIGIN_INFORMATION_TO_SERVICE.get(
(origin.origin, origin.archive), ""
)
if service in ESM_SERVICES:
return service
if origin.origin == "Ubuntu":
return origin.component
return "third-party"
def get_service_name(origins: List[apt_package.Origin]) -> Tuple[str, str]:
"Translates the archive name in the version origin to a UA service name."
for origin in origins:
service = ORIGIN_INFORMATION_TO_SERVICE.get(
(origin.origin, origin.archive)
)
if service:
return service, origin.site
return ("", "")
def get_update_status(service_name: str, ua_info: Dict[str, Any]) -> str:
"""Defines the update status for a package based on the service name.
For ESM-[Infra|Apps] packages, first checks if UA is attached. If this is
the case, also check for availability of the service.
"""
if service_name == "standard-security" or (
ua_info["attached"] and service_name in ua_info["enabled_services"]
):
return UpdateStatus.AVAILABLE.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_security_updates(
packages: List[apt_package.Package],
) -> List[apt_package.Version]:
"""Filters a list of packages looking for available security updates.
Checks if the package has a greater version available, and if the origin of
this version matches any of the series' security repositories.
"""
return [
version
for package in packages
for version in package.versions
if version > package.installed
and any(
(origin.origin, origin.archive) in ORIGIN_INFORMATION_TO_SERVICE
for origin in version.origins
)
]
def get_ua_info(cfg: UAConfig) -> Dict[str, Any]:
"""Returns the UA information based on the config object."""
ua_info = {
"attached": False,
"enabled_services": [],
"entitled_services": [],
} # type: Dict[str, Any]
status_dict = status(cfg=cfg, show_beta=True)
if status_dict["attached"]:
ua_info["attached"] = True
for service in status_dict["services"]:
if service["name"] in ESM_SERVICES:
if service["entitled"] == "yes":
ua_info["entitled_services"].append(service["name"])
if service["status"] == "enabled":
ua_info["enabled_services"].append(service["name"])
return ua_info
def security_status(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 UA status.
There is also a summary with the UA information and the package counts.
"""
ua_info = get_ua_info(cfg)
summary = {"ua": ua_info} # type: Dict[str, Any]
packages = []
cache = Cache()
installed_packages = [package for package in cache if package.is_installed]
summary["num_installed_packages"] = len(installed_packages)
package_count = defaultdict(int) # type: DefaultDict[str, int]
update_count = defaultdict(int) # type: DefaultDict[str, int]
for package in installed_packages:
package_origin = get_origin_for_package(package)
package_count[package_origin] += 1
security_upgradable_versions = filter_security_updates(installed_packages)
for candidate in security_upgradable_versions:
service_name, origin_site = get_service_name(candidate.origins)
status = get_update_status(service_name, ua_info)
update_count[service_name] += 1
packages.append(
{
"package": candidate.package.name,
"version": candidate.version,
"service_name": service_name,
"status": status,
"origin": origin_site,
}
)
summary["num_main_packages"] = package_count["main"]
summary["num_restricted_packages"] = package_count["restricted"]
summary["num_universe_packages"] = package_count["universe"]
summary["num_multiverse_packages"] = package_count["multiverse"]
summary["num_third_party_packages"] = package_count["third-party"]
summary["num_unknown_packages"] = package_count["unknown"]
summary["num_esm_infra_packages"] = package_count["esm-infra"]
summary["num_esm_apps_packages"] = package_count["esm-apps"]
summary["num_esm_infra_updates"] = update_count["esm-infra"]
summary["num_esm_apps_updates"] = update_count["esm-apps"]
summary["num_standard_security_updates"] = update_count[
"standard-security"
]
return {"_schema_version": "0.1", "summary": summary, "packages": packages}
Mini Shell