File manager - Edit - /home/newsbmcs.com/public_html/static/img/logo/u.tar
Back
apt_news/__pycache__/__init__.cpython-310.pyc 0000644 00000000237 15030103444 0015030 0 ustar 00 o �ϴf � @ s d S )N� r r r �B/usr/lib/python3/dist-packages/uaclient/api/u/apt_news/__init__.py�<module> s apt_news/current_news/v1.py 0000644 00000003366 15030103444 0012004 0 ustar 00 from typing import Optional from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo from uaclient.config import UAConfig from uaclient.data_types import DataObject, Field, StringDataValue from uaclient.files.state_files import apt_news_raw_file class CurrentNewsResult(DataObject, AdditionalInfo): fields = [ Field( "current_news", StringDataValue, required=False, doc=( "The current APT News to be displayed for the system. This" " could be a str with up to three lines (i.e. up to two" " ``\\n`` characters). If there is no APT News to be" " displayed, this will be ``None``." ), ), ] def __init__(self, *, current_news: Optional[str]): self.current_news = current_news def current_news() -> CurrentNewsResult: return _current_news(UAConfig()) def _current_news(cfg: UAConfig) -> CurrentNewsResult: """ This endpoint returns the current APT News that gets displayed in `apt upgrade`. """ return CurrentNewsResult(current_news=apt_news_raw_file.read()) endpoint = APIEndpoint( version="v1", name="CurrentNews", fn=_current_news, options_cls=None, ) _doc = { "introduced_in": "29", "requires_network": False, "example_python": """ from uaclient.api.u.apt_news.current_news.v1 import current_news result = current_news().current_news """, "result_class": CurrentNewsResult, "exceptions": [], "example_cli": "pro api u.apt_news.current_news.v1", "example_json": """ { "current_news":"This is a news message.\\nThis is the second line of the message.\\nAnd this is the third line." } """, # noqa: E501 } apt_news/current_news/__pycache__/__init__.cpython-310.pyc 0000644 00000000254 15030103444 0017545 0 ustar 00 o �ϴf � @ s d S )N� r r r �O/usr/lib/python3/dist-packages/uaclient/api/u/apt_news/current_news/__init__.py�<module> s apt_news/current_news/__pycache__/v1.cpython-310.pyc 0000644 00000003741 15030103444 0016340 0 ustar 00 o �(�f� � @ s� d dl mZ d dlmZ d dlmZ d dlmZ d dlm Z m Z m Z d dl m Z G dd� de e�Zd efd d �Zd ed efd d�Zeddedd�Zdddeg ddd�ZdS )� )�Optional)� APIEndpoint)�AdditionalInfo)�UAConfig)� DataObject�Field�StringDataValue)�apt_news_raw_filec @ s0 e Zd Zededdd�gZdee fdd�ZdS )�CurrentNewsResult� current_newsFz�The current APT News to be displayed for the system. This could be a str with up to three lines (i.e. up to two ``\n`` characters). If there is no APT News to be displayed, this will be ``None``.)�required�docc C s || _ d S �N�r )�selfr � r �I/usr/lib/python3/dist-packages/uaclient/api/u/apt_news/current_news/v1.py�__init__ � zCurrentNewsResult.__init__N) �__name__� __module__� __qualname__r r �fieldsr �strr r r r r r s ��r �returnc C s t t� �S r )� _current_newsr r r r r r r r �cfgc C s t t�� d�S )z^ This endpoint returns the current APT News that gets displayed in `apt upgrade`. r )r r �read)r r r r r ! s r �v1� CurrentNewsN)�version�name�fn� options_cls�29Fzh from uaclient.api.u.apt_news.current_news.v1 import current_news result = current_news().current_news z"pro api u.apt_news.current_news.v1zx { "current_news":"This is a news message.\nThis is the second line of the message.\nAnd this is the third line." } )� introduced_in�requires_network�example_python� result_class� exceptions� example_cli� example_json)�typingr �uaclient.api.apir �uaclient.api.data_typesr �uaclient.configr �uaclient.data_typesr r r �uaclient.files.state_filesr r r r �endpoint�_docr r r r �<module> s. � � apt_news/current_news/__init__.py 0000644 00000000000 15030103444 0013173 0 ustar 00 apt_news/__init__.py 0000644 00000000000 15030103444 0010455 0 ustar 00 __pycache__/__init__.cpython-310.pyc 0000644 00000000226 15030103444 0013206 0 ustar 00 o �ϴf � @ s d S )N� r r r �9/usr/lib/python3/dist-packages/uaclient/api/u/__init__.py�<module> s security/__pycache__/__init__.cpython-310.pyc 0000644 00000000237 15030103444 0015057 0 ustar 00 o �ϴf � @ s d S )N� r r r �B/usr/lib/python3/dist-packages/uaclient/api/u/security/__init__.py�<module> s security/package_manifest/v1.py 0000644 00000004137 15030103444 0012573 0 ustar 00 from uaclient import apt, snap from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo from uaclient.config import UAConfig from uaclient.data_types import DataObject, Field, StringDataValue class PackageManifestResult(DataObject, AdditionalInfo): fields = [ Field( "manifest_data", StringDataValue, doc=( "Manifest of ``apt`` and ``snap`` packages installed on the" " system" ), ), ] def __init__(self, manifest_data: str): self.manifest_data = manifest_data # The return class was once called PackageManifestResults # We are keeping compatibility PackageManifestResults = PackageManifestResult def package_manifest() -> PackageManifestResult: return _package_manifest(UAConfig()) def _package_manifest(cfg: UAConfig) -> PackageManifestResult: """ This endpoint returns the status of installed packages (``apt`` and ``snap``), formatted as a manifest file (i.e., ``package_name\\tversion``). """ manifest = "" apt_pkgs = apt.get_installed_packages() for apt_pkg in apt_pkgs: arch = "" if apt_pkg.arch == "all" else ":" + apt_pkg.arch manifest += "{}{}\t{}\n".format(apt_pkg.name, arch, apt_pkg.version) pkgs = snap.get_installed_snaps() for pkg in pkgs: manifest += "snap:{name}\t{channel}\t{revision}\n".format( name=pkg.name, channel=pkg.channel, revision=pkg.revision, ) return PackageManifestResult(manifest_data=manifest) endpoint = APIEndpoint( version="v1", name="Packages", fn=_package_manifest, options_cls=None, ) _doc = { "introduced_in": "27.12", "requires_network": False, "example_python": """ from uaclient.api.u.security.package_manifest.v1 import package_manifest result = package_manifest() """, "result_class": PackageManifestResult, "exceptions": [], "example_cli": "pro api u.security.package_manifest.v1", "example_json": """ { "package_manifest":"package1\\t1.0\\npackage2\\t2.3\\n" } """, } security/package_manifest/__pycache__/__init__.cpython-310.pyc 0000644 00000000260 15030103444 0020334 0 ustar 00 o �ϴf � @ s d S )N� r r r �S/usr/lib/python3/dist-packages/uaclient/api/u/security/package_manifest/__init__.py�<module> s security/package_manifest/__pycache__/v1.cpython-310.pyc 0000644 00000004241 15030103444 0017126 0 ustar 00 o �(�f_ � @ s� d dl mZmZ d dlmZ d dlmZ d dlmZ d dl m Z m Z m Z G dd� de e�Z e Zde fd d �Zd ede fd d �Zeddedd�Zddde g ddd�ZdS )� )�apt�snap)� APIEndpoint)�AdditionalInfo)�UAConfig)� DataObject�Field�StringDataValuec @ s* e Zd Zededd�gZdefdd�ZdS )�PackageManifestResult� manifest_datazAManifest of ``apt`` and ``snap`` packages installed on the system)�docc C s || _ d S �N�r )�selfr � r �M/usr/lib/python3/dist-packages/uaclient/api/u/security/package_manifest/v1.py�__init__ � z PackageManifestResult.__init__N)�__name__� __module__� __qualname__r r �fields�strr r r r r r s �� r �returnc C s t t� �S r )�_package_manifestr r r r r �package_manifest r r �cfgc C sz d}t �� }|D ]}|jdkrdnd|j }|d�|j||j�7 }qt�� }|D ]}|dj|j|j|j d�7 }q(t |d�S )z� This endpoint returns the status of installed packages (``apt`` and ``snap``), formatted as a manifest file (i.e., ``package_name\tversion``). � �all�:z{}{} {} z!snap:{name} {channel} {revision} )�name�channel�revisionr ) r �get_installed_packages�arch�formatr �versionr �get_installed_snapsr! r" r )r �manifest�apt_pkgs�apt_pkgr$ �pkgs�pkgr r r r ! s � r �v1�PackagesN)r& r �fn� options_clsz27.12Fzg from uaclient.api.u.security.package_manifest.v1 import package_manifest result = package_manifest() z&pro api u.security.package_manifest.v1z= { "package_manifest":"package1\t1.0\npackage2\t2.3\n" } )� introduced_in�requires_network�example_python� result_class� exceptions� example_cli� example_json)�uaclientr r �uaclient.api.apir �uaclient.api.data_typesr �uaclient.configr �uaclient.data_typesr r r r �PackageManifestResultsr r �endpoint�_docr r r r �<module> s. � � security/package_manifest/__init__.py 0000644 00000000000 15030103444 0013765 0 ustar 00 security/__init__.py 0000644 00000000000 15030103444 0010504 0 ustar 00 pro/detach/v1.py 0000644 00000010406 15030103444 0007467 0 ustar 00 from typing import List from uaclient import ( daemon, entitlements, exceptions, lock, messages, timer, util, ) from uaclient.api import ProgressWrapper from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo, ErrorWarningObject 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.config import UAConfig from uaclient.data_types import ( BoolDataValue, DataObject, Field, StringDataValue, data_list, ) from uaclient.files import machine_token, notices, state_files from uaclient.timer.update_messaging import update_motd_messages class DetachResult(DataObject, AdditionalInfo): fields = [ Field( "disabled", data_list(StringDataValue), doc="The services disabled during the detach operation", ), Field( "reboot_required", BoolDataValue, doc=( "True if the system requires a reboot after the detach" " operation" ), ), ] def __init__(self, disabled: List[str], reboot_required: bool): self.disabled = disabled self.reboot_required = reboot_required def detach() -> DetachResult: return _detach(UAConfig()) def _detach(cfg: UAConfig) -> DetachResult: """ This endpoint allows the user to detach the machine from a Pro subscription. """ if not util.we_are_currently_root(): raise exceptions.NonRootUserError try: with lock.RetryLock( lock_holder="pro.api.u.pro.detach.v1", ): ret = _detach_in_lock(cfg) except Exception as e: lock.clear_lock_file_if_present() raise e return ret def _detach_in_lock(cfg: UAConfig) -> DetachResult: if not _is_attached(cfg).is_attached: return DetachResult( disabled=[], reboot_required=False, ) disabled = [] warnings = [] # type: List[ErrorWarningObject] for ent_name in entitlements.entitlements_disable_order(cfg): try: ent = entitlements.entitlement_factory(cfg=cfg, name=ent_name) except exceptions.EntitlementNotFoundError: continue # For detach, we should not consider that a service # cannot be disabled because of dependent services, # since we are going to disable all of them anyway can_disable, _ = ent.can_disable(ignore_dependent_services=True) if can_disable: ret, reason = ent.disable(ProgressWrapper()) if not ret: if reason and reason.message: msg = reason.message.msg code = reason.message.name else: msg = messages.DISABLE_FAILED_TMPL.format(title=ent_name) code = "" warnings.append( ErrorWarningObject( title=msg, code=code, meta={"service": ent_name}, ) ) else: disabled.append(ent_name) notices.remove(notices.Notice.LIMITED_TO_RELEASE) state_files.delete_state_files() machine_token.get_machine_token_file().delete() update_motd_messages(cfg) daemon.start() timer.stop() reboot_required_result = _reboot_required(cfg) result = DetachResult( disabled=sorted(disabled), reboot_required=reboot_required_result.reboot_required == "yes", ) result.warnings = warnings return result endpoint = APIEndpoint( version="v1", name="Detach", fn=_detach, options_cls=None, ) _doc = { "introduced_in": "32", "requires_network": True, "example_python": """ from uaclient.api.u.pro.detach.v1 import detach result = detach() """, # noqa: E501 "result_class": DetachResult, "exceptions": [ ( exceptions.NonRootUserError, ("Raised if a non-root user executes this endpoint."), ), ], "example_cli": "pro api u.pro.detach.v1", "example_json": """ { "disabled": ["service1", "service2"], "reboot_required": false } """, } pro/detach/__pycache__/__init__.cpython-310.pyc 0000644 00000000241 15030103444 0015233 0 ustar 00 o �ϴf � @ s d S )N� r r r �D/usr/lib/python3/dist-packages/uaclient/api/u/pro/detach/__init__.py�<module> s pro/detach/__pycache__/v1.cpython-310.pyc 0000644 00000007323 15030103444 0014032 0 ustar 00 o �(�f � @ s, d dl mZ d dlmZmZmZmZmZmZm Z d dl m Z d dl m Z d dlmZmZ d dlmZ d dlmZ d dlmZ d d lmZmZmZmZm Z d d l m Z m Z m Z d d l!m"Z" G d d � d ee�Z#de#fdd�Z$dede#fdd�Z%dede#fdd�Z&e dde%dd�Z'ddd e#ej(d fgd d d �Z)dS )!� )�List)�daemon� entitlements� exceptions�lock�messages�timer�util)�ProgressWrapper)� APIEndpoint)�AdditionalInfo�ErrorWarningObject)�_reboot_required)� _is_attached)�UAConfig)� BoolDataValue� DataObject�Field�StringDataValue� data_list)� machine_token�notices� state_files)�update_motd_messagesc @ sB e Zd Zedee�dd�ededd�gZdee de fdd�Z dS ) � DetachResult�disabledz1The services disabled during the detach operation)�doc�reboot_requiredz?True if the system requires a reboot after the detach operationc C s || _ || _d S �N�r r )�selfr r � r! �>/usr/lib/python3/dist-packages/uaclient/api/u/pro/detach/v1.py�__init__0 s zDetachResult.__init__N) �__name__� __module__� __qualname__r r r r �fieldsr �str�boolr# r! r! r! r" r s ���r �returnc C s t t� �S r )�_detachr r! r! r! r" �detach5 s r, �cfgc C sr t �� stj�z tjdd�� t| �}W d � W |S 1 s w Y W |S ty8 } zt�� |�d}~ww )zZ This endpoint allows the user to detach the machine from a Pro subscription. zpro.api.u.pro.detach.v1)� lock_holderN) r �we_are_currently_rootr �NonRootUserErrorr � RetryLock�_detach_in_lock� Exception�clear_lock_file_if_present)r- �ret�er! r! r" r+ 9 s � �����r+ c C s2 t | �js tg dd�S g }g }t�| �D ]S}z tj| |d�}W n tjy) Y qw |jdd�\}}|rg|� t � �\}}|sb|rL|j rL|j j } |j j } n tjj|d�} d} |�t| | d|id �� q|�|� qt�tjj� t�� t�� �� t | � t � � t � � t!| �} tt"|�| j#d kd�} || _$| S ) NFr )r- �nameT)�ignore_dependent_services)�title� �service)r9 �code�meta�yes)%r � is_attachedr r �entitlements_disable_order�entitlement_factoryr �EntitlementNotFoundError� can_disable�disabler �message�msgr7 r �DISABLE_FAILED_TMPL�format�appendr r �remove�Notice�LIMITED_TO_RELEASEr �delete_state_filesr �get_machine_token_file�deleter r �startr �stopr �sortedr �warnings) r- r rS �ent_name�entrC �_r5 �reasonrF r< �reboot_required_result�resultr! r! r" r2 L sX �� �� � �r2 �v1�DetachN)�versionr7 �fn� options_cls�32TzD from uaclient.api.u.pro.detach.v1 import detach result = detach() z1Raised if a non-root user executes this endpoint.zpro api u.pro.detach.v1zL { "disabled": ["service1", "service2"], "reboot_required": false } )� introduced_in�requires_network�example_python� result_classr � example_cli� example_json)*�typingr �uaclientr r r r r r r � uaclient.apir �uaclient.api.apir �uaclient.api.data_typesr r �5uaclient.api.u.pro.security.status.reboot_required.v1r �(uaclient.api.u.pro.status.is_attached.v1r �uaclient.configr �uaclient.data_typesr r r r r �uaclient.filesr r r � uaclient.timer.update_messagingr r r, r+ r2 �endpointr0 �_docr! r! r! r" �<module> s@ $ 9��� � pro/detach/__init__.py 0000644 00000000000 15030103444 0010665 0 ustar 00 pro/attach/__pycache__/__init__.cpython-310.pyc 0000644 00000000241 15030103444 0015247 0 ustar 00 o �ϴf � @ s d S )N� r r r �D/usr/lib/python3/dist-packages/uaclient/api/u/pro/attach/__init__.py�<module> s pro/attach/token/__pycache__/__init__.cpython-310.pyc 0000644 00000000247 15030103444 0016375 0 ustar 00 o �ϴf � @ s d S )N� r r r �J/usr/lib/python3/dist-packages/uaclient/api/u/pro/attach/token/__init__.py�<module> s pro/attach/token/full_token_attach/v1.py 0000644 00000013731 15030103444 0014315 0 ustar 00 from typing import Dict, List # noqa: F401 from uaclient import exceptions, lock, util from uaclient.actions import attach_with_token from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo, ErrorWarningObject from uaclient.api.u.pro.security.status.reboot_required.v1 import ( _reboot_required, ) from uaclient.api.u.pro.status.enabled_services.v1 import _enabled_services from uaclient.api.u.pro.status.is_attached.v1 import _is_attached from uaclient.config import UAConfig from uaclient.data_types import ( BoolDataValue, DataObject, Field, StringDataValue, data_list, ) class FullTokenAttachOptions(DataObject): fields = [ Field( "token", StringDataValue, doc="The token associated with a Pro subscription", ), Field( "auto_enable_services", BoolDataValue, False, doc=( "If false, the attach operation will not enable any service" " during the operation (default: true)" ), ), ] def __init__(self, token: str, auto_enable_services: bool = True): self.token = token self.auto_enable_services = auto_enable_services class FullTokenAttachResult(DataObject, AdditionalInfo): fields = [ Field( "enabled", data_list(StringDataValue), doc="The services enabled during the attach operation", ), Field( "reboot_required", BoolDataValue, doc=( "True if the system requires a reboot after the attach" " operation" ), ), ] def __init__( self, enabled: List[str], reboot_required: bool, ): self.enabled = enabled self.reboot_required = reboot_required def _full_token_attach( options: FullTokenAttachOptions, cfg: UAConfig ) -> FullTokenAttachResult: """ This endpoint allows the user to attach to a Pro subscription using a token. """ if not util.we_are_currently_root(): raise exceptions.NonRootUserError if _is_attached(cfg).is_attached: return FullTokenAttachResult( enabled=[], reboot_required=False, ) try: with lock.RetryLock( lock_holder="pro.api.u.pro.attach.token.full_token_attach.v1", ): ret = _full_token_attach_in_lock(options, cfg) except Exception as e: lock.clear_lock_file_if_present() raise e return ret def _full_token_attach_in_lock( options: FullTokenAttachOptions, cfg: UAConfig ) -> FullTokenAttachResult: failed_services = [] # type: List[Dict[str, str]] auto_enable_services = options.auto_enable_services if auto_enable_services is None: auto_enable_services = True try: attach_with_token( cfg, options.token, allow_enable=auto_enable_services, silent=True, ) except ( exceptions.AttachFailureUnknownError, exceptions.AttachFailureDefaultServices, ) as exc: failed_services = exc.additional_info.get("services", []) enabled_services = [ service.name for service in _enabled_services(cfg).enabled_services ] reboot_required_result = _reboot_required(cfg) result = FullTokenAttachResult( enabled=enabled_services, reboot_required=reboot_required_result.reboot_required == "yes", ) if failed_services: result.warnings = [ ErrorWarningObject( title=service["title"], code=service["code"], meta={"service": service["name"]}, ) for service in failed_services ] return result def full_token_attach( options: FullTokenAttachOptions, ) -> FullTokenAttachResult: return _full_token_attach(options, UAConfig()) endpoint = APIEndpoint( version="v1", name="FullTokenAttach", fn=_full_token_attach, options_cls=FullTokenAttachOptions, ) _doc = { "introduced_in": "32", "requires_network": True, "example_python": """ from uaclient.api.u.pro.attach.token.full_token_attach.v1 import full_token_attach, FullTokenAttachOptions options = FullTokenAttachOptions(token="TOKEN") result = full_token_attach(options) """, # noqa: E501 "result_class": FullTokenAttachResult, "exceptions": [ ( exceptions.ConnectivityError, ( "Raised if it is not possible to connect to the contracts" " service." ), ), ( exceptions.ContractAPIError, ( "Raised if there is an unexpected error in the contracts" " service interaction." ), ), ( exceptions.LockHeldError, ( "Raised if another Client process is holding the lock on the" " machine." ), ), ( exceptions.NonRootUserError, ("Raised if a non-root user executes this endpoint."), ), ], "example_cli": "pro api u.pro.attach.token.full_token_attach.v1 --data -", "example_cli_extra": """ Note that it is generally not recommended to pass secrets such as the token on the command line. The example uses the arguments ``--data -`` which causes ``pro`` to read the input data from ``stdin``. Then the arguments can be written as JSON to ``stdin`` of the process. For example, if we define a JSON file (i.e. ``file.json``) with the same attributes as the options for this endpoint: .. code-block:: json { "token": "TOKEN", "auto_enable_services": false } Then we can call the API like this: .. code-block:: bash cat file.json | pro api u.pro.attach.token.full_token_attach.v1 --data - """, "example_json": """ { "enabled": ["service1", "service2"], "reboot_required": false } """, } pro/attach/token/full_token_attach/__pycache__/__init__.cpython-310.pyc 0000644 00000000271 15030103444 0022060 0 ustar 00 o �ϴf � @ s d S )N� r r r �\/usr/lib/python3/dist-packages/uaclient/api/u/pro/attach/token/full_token_attach/__init__.py�<module> s pro/attach/token/full_token_attach/__pycache__/v1.cpython-310.pyc 0000644 00000012566 15030103444 0020661 0 ustar 00 o �(�f� � @ sB d dl mZmZ d dlmZmZmZ d dlmZ d dl m Z d dl m Z m Z d dlmZ d dlmZ d dlmZ d d lmZ d d lmZmZmZmZmZ G d d � d e�Z G d d� dee �Z de dede fdd�Z de dede fdd�Z de de fdd�Z e dde e d�Z!dd d e ej"d fej#d fej$d fej%d!fgd"d#d$d%�Z&d&S )'� )�Dict�List)� exceptions�lock�util)�attach_with_token)� APIEndpoint)�AdditionalInfo�ErrorWarningObject)�_reboot_required)�_enabled_services)� _is_attached)�UAConfig)� BoolDataValue� DataObject�Field�StringDataValue� data_listc @ s> e Zd Zededd�ededdd�gZd dedefdd �Z d S ) �FullTokenAttachOptions�tokenz,The token associated with a Pro subscription��doc�auto_enable_servicesFz_If false, the attach operation will not enable any service during the operation (default: true)Tc C � || _ || _d S �N)r r )�selfr r � r �V/usr/lib/python3/dist-packages/uaclient/api/u/pro/attach/token/full_token_attach/v1.py�__init__( s z FullTokenAttachOptions.__init__N)T) �__name__� __module__� __qualname__r r r �fields�str�boolr r r r r r s ���r c @ sB e Zd Zedee�dd�ededd�gZdee de fdd�Z dS ) �FullTokenAttachResult�enabledz0The services enabled during the attach operationr �reboot_requiredz?True if the system requires a reboot after the attach operationc C r r �r& r' )r r& r' r r r r > s z FullTokenAttachResult.__init__N) r r r! r r r r r" r r# r$ r r r r r r% - s" �����r% �options�cfg�returnc C s� t �� stj�t|�jrtg dd�S z tjdd�� t | |�}W d � W |S 1 s+w Y W |S t yD } zt� � |�d}~ww )zZ This endpoint allows the user to attach to a Pro subscription using a token. Fr( z/pro.api.u.pro.attach.token.full_token_attach.v1)� lock_holderN) r �we_are_currently_rootr �NonRootUserErrorr � is_attachedr% r � RetryLock�_full_token_attach_in_lock� Exception�clear_lock_file_if_present)r) r* �ret�er r r �_full_token_attachG s* �� �����r6 c C s� g }| j }|d u r d}z t|| j|dd� W n tjtjfy3 } z |j�dg �}W Y d }~nd }~ww dd� t|�j D �}t |�}t ||j dkd�}|rUdd� |D �|_ |S ) NT)� allow_enable�silent�servicesc S s g | ]}|j �qS r )�name��.0�servicer r r � <listcomp>x s �z._full_token_attach_in_lock.<locals>.<listcomp>�yesr( c S s* g | ]}t |d |d d|d id��qS )�title�coder= r: )r@ rA �meta)r r; r r r r> � s � ��)r r r r �AttachFailureUnknownError� AttachFailureDefaultServices�additional_info�getr �enabled_servicesr r% r' �warnings)r) r* �failed_servicesr �excrG �reboot_required_result�resultr r r r1 b s> � ������ r1 c C s t | t� �S r )r6 r )r) r r r �full_token_attach� s rM �v1�FullTokenAttach)�versionr: �fn� options_cls�32Tz� from uaclient.api.u.pro.attach.token.full_token_attach.v1 import full_token_attach, FullTokenAttachOptions options = FullTokenAttachOptions(token="TOKEN") result = full_token_attach(options) zARaised if it is not possible to connect to the contracts service.zLRaised if there is an unexpected error in the contracts service interaction.zDRaised if another Client process is holding the lock on the machine.z1Raised if a non-root user executes this endpoint.z8pro api u.pro.attach.token.full_token_attach.v1 --data -at Note that it is generally not recommended to pass secrets such as the token on the command line. The example uses the arguments ``--data -`` which causes ``pro`` to read the input data from ``stdin``. Then the arguments can be written as JSON to ``stdin`` of the process. For example, if we define a JSON file (i.e. ``file.json``) with the same attributes as the options for this endpoint: .. code-block:: json { "token": "TOKEN", "auto_enable_services": false } Then we can call the API like this: .. code-block:: bash cat file.json | pro api u.pro.attach.token.full_token_attach.v1 --data - zK { "enabled": ["service1", "service2"], "reboot_required": false } )� introduced_in�requires_network�example_python� result_classr � example_cli�example_cli_extra� example_jsonN)'�typingr r �uaclientr r r �uaclient.actionsr �uaclient.api.apir �uaclient.api.data_typesr r �5uaclient.api.u.pro.security.status.reboot_required.v1r �-uaclient.api.u.pro.status.enabled_services.v1r �(uaclient.api.u.pro.status.is_attached.v1r �uaclient.configr �uaclient.data_typesr r r r r r r% r6 r1 rM �endpoint�ConnectivityError�ContractAPIError� LockHeldErrorr. �_docr r r r �<module> st �� ��� �-� ������� � pro/attach/token/full_token_attach/__init__.py 0000644 00000000000 15030103444 0015507 0 ustar 00 pro/attach/token/__init__.py 0000644 00000000000 15030103444 0012021 0 ustar 00 pro/attach/magic/__pycache__/__init__.cpython-310.pyc 0000644 00000000247 15030103444 0016335 0 ustar 00 o �ϴf � @ s d S )N� r r r �J/usr/lib/python3/dist-packages/uaclient/api/u/pro/attach/magic/__init__.py�<module> s pro/attach/magic/wait/v1.py 0000644 00000013133 15030103444 0011527 0 ustar 00 import time from uaclient import exceptions, secret_manager from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo from uaclient.config import UAConfig from uaclient.contract import UAContractClient from uaclient.data_types import ( DataObject, Field, IntDataValue, StringDataValue, ) MAXIMUM_ATTEMPTS = 70 class MagicAttachWaitOptions(DataObject): fields = [ Field( "magic_token", StringDataValue, doc="The Token provided by the initiate endpoint.", ), ] def __init__(self, magic_token: str): self.magic_token = magic_token class MagicAttachWaitResult(DataObject, AdditionalInfo): fields = [ Field( "user_code", StringDataValue, doc=( "Code the user will see in the UI when confirming the Magic" " Attach" ), ), Field( "token", StringDataValue, doc="The same Magic Token that was sent as an argument", ), Field( "expires", StringDataValue, doc="Timestamp of the Magic Attach process expiration", ), Field( "expires_in", IntDataValue, doc="Seconds before the Magic Attach process expires", ), Field( "contract_id", StringDataValue, doc="ID of the contract the machine will be attached to", ), Field( "contract_token", StringDataValue, doc="The contract Token to attach the machine", ), ] def __init__( self, user_code: str, token: str, expires: str, expires_in: int, contract_id: str, contract_token: str, ): self.user_code = user_code self.token = token self.expires = expires self.expires_in = expires_in self.contract_id = contract_id self.contract_token = contract_token def wait( options: MagicAttachWaitOptions, ) -> MagicAttachWaitResult: return _wait(options, UAConfig()) def _wait( options: MagicAttachWaitOptions, cfg: UAConfig ) -> MagicAttachWaitResult: """ This endpoint polls the contracts service waiting for the user to confirm the Magic Attach. """ contract = UAContractClient(cfg) num_attempts = 0 num_connection_errors = 0 wait_time = 10 secret_manager.secrets.add_secret(options.magic_token) while num_attempts < MAXIMUM_ATTEMPTS: wait_resp = None try: wait_resp = contract.get_magic_attach_token_info( magic_token=options.magic_token ) num_connection_errors = 0 except exceptions.MagicAttachTokenError: break # If the server is unavailable we will bump the wait # time. We will return to the normal amount if we can # successfully reach the server and we verify that # the contractToken information is still not being # returned except exceptions.MagicAttachUnavailable: wait_time = 30 # If we have a flaky connectivity error, this part of the code # will make sure that we try at least three more times before # raising a ConnectivityError. except exceptions.ConnectivityError as e: if num_connection_errors < 3: num_connection_errors += 1 else: raise e if wait_resp and wait_resp.get("contractToken") is not None: return MagicAttachWaitResult( user_code=wait_resp["userCode"], token=wait_resp["token"], expires=wait_resp["expires"], expires_in=int(wait_resp["expiresIn"]), contract_id=wait_resp["contractID"], contract_token=wait_resp["contractToken"], ) elif wait_resp: wait_time = 10 time.sleep(wait_time) num_attempts += 1 raise exceptions.MagicAttachTokenError() endpoint = APIEndpoint( version="v1", name="MagicAttachWait", fn=_wait, options_cls=MagicAttachWaitOptions, ) _doc = { "introduced_in": "27.11", "requires_network": True, "example_python": """ from uaclient.api.u.pro.attach.magic.wait.v1 import MagicAttachWaitOptions, wait options = MagicAttachWaitOptions(magic_token="<magic_token>") result = wait(options) """, # noqa: E501 "result_class": MagicAttachWaitResult, "exceptions": [ ( exceptions.ConnectivityError, ( "Raised if it is not possible to connect to the contracts" " service." ), ), ( exceptions.ContractAPIError, ( "Raised if there is an unexpected error in the contracts" " service interaction." ), ), ( exceptions.MagicAttachTokenError, "Raised when an invalid/expired Token is sent.", ), ( exceptions.MagicAttachUnavailable, ( "Raised if the Magic Attach service is busy or unavailable at" " the moment." ), ), ], "example_cli": "pro api u.pro.attach.magic.wait.v1 --args magic_token=<magic_token>", # noqa: E501 "example_json": """ { "user_code":"<UI_code>", "token":"<magic_token>", "expires": "<yyyy-MM-dd>T<HH:mm:ss>.<TZ>", "expires_in": 500, "contract_id": "<Contract-ID>", "contract_token": "<attach_token>", } """, } pro/attach/magic/wait/__pycache__/__init__.cpython-310.pyc 0000644 00000000254 15030103444 0017277 0 ustar 00 o �ϴf � @ s d S )N� r r r �O/usr/lib/python3/dist-packages/uaclient/api/u/pro/attach/magic/wait/__init__.py�<module> s pro/attach/magic/wait/__pycache__/v1.cpython-310.pyc 0000644 00000010115 15030103444 0016063 0 ustar 00 o �(�f[ � @ s� d dl Z d dlmZmZ d dlmZ d dlmZ d dlm Z d dl m Z d dl m Z mZmZmZ dZG d d � d e �ZG d d � d e e�Zd edefdd�Zd ede defdd�Zeddeed�Zdddeejdfejdfejd fejd fgd d d �ZdS )!� N)� exceptions�secret_manager)� APIEndpoint)�AdditionalInfo)�UAConfig)�UAContractClient)� DataObject�Field� IntDataValue�StringDataValue�F c @ s* e Zd Zededd�gZdefdd�ZdS )�MagicAttachWaitOptions� magic_tokenz,The Token provided by the initiate endpoint.��docc C s || _ d S �N�r )�selfr � r �I/usr/lib/python3/dist-packages/uaclient/api/u/pro/attach/magic/wait/v1.py�__init__ s z MagicAttachWaitOptions.__init__N)�__name__� __module__� __qualname__r r �fields�strr r r r r r s ��r c @ sz e Zd Zededd�ededd�ededd�eded d�ed ed d�ed ed d�gZdedededed ed ef dd�Z dS )�MagicAttachWaitResult� user_codezACode the user will see in the UI when confirming the Magic Attachr �tokenz1The same Magic Token that was sent as an argument�expiresz0Timestamp of the Magic Attach process expiration� expires_inz/Seconds before the Magic Attach process expires� contract_idz2ID of the contract the machine will be attached to�contract_tokenz(The contract Token to attach the machinec C s( || _ || _|| _|| _|| _|| _d S r �r r r r r! r" )r r r r r r! r" r r r r D s z MagicAttachWaitResult.__init__N) r r r r r r r r �intr r r r r r sZ �������$������r �options�returnc C s t | t� �S r )�_waitr )r% r r r �waitU s r( �cfgc C s t |�}d}d}d}tj�| j� |tk r�d}z |j| jd�}d}W n5 tjy/ Y t�� � tj y: d}Y n tj yW } z|dk rK|d7 }n|�W Y d}~nd}~ww |ry|� d�duryt |d |d |d t |d �|d |d d�S |r}d}t�|� |d7 }|tk st�� �)zi This endpoint polls the contracts service waiting for the user to confirm the Magic Attach. r � Nr � � � � contractToken�userCoder r � expiresIn� contractIDr# )r r �secrets� add_secretr �MAXIMUM_ATTEMPTS�get_magic_attach_token_infor �MagicAttachTokenError�MagicAttachUnavailable�ConnectivityError�getr r$ �time�sleep)r% r) �contract� num_attempts�num_connection_errors� wait_time� wait_resp�er r r r' [ sN � � ��� � �)r' �v1�MagicAttachWait)�version�name�fn� options_clsz27.11Tz� from uaclient.api.u.pro.attach.magic.wait.v1 import MagicAttachWaitOptions, wait options = MagicAttachWaitOptions(magic_token="<magic_token>") result = wait(options) zARaised if it is not possible to connect to the contracts service.zLRaised if there is an unexpected error in the contracts service interaction.z-Raised when an invalid/expired Token is sent.zHRaised if the Magic Attach service is busy or unavailable at the moment.zCpro api u.pro.attach.magic.wait.v1 --args magic_token=<magic_token>z� { "user_code":"<UI_code>", "token":"<magic_token>", "expires": "<yyyy-MM-dd>T<HH:mm:ss>.<TZ>", "expires_in": 500, "contract_id": "<Contract-ID>", "contract_token": "<attach_token>", } )� introduced_in�requires_network�example_python� result_classr � example_cli� example_json) r: �uaclientr r �uaclient.api.apir �uaclient.api.data_typesr �uaclient.configr �uaclient.contractr �uaclient.data_typesr r r r r4 r r r( r' �endpointr8 �ContractAPIErrorr6 r7 �_docr r r r �<module> s` 6� ��� �:������ � pro/attach/magic/wait/__init__.py 0000644 00000000000 15030103444 0012725 0 ustar 00 pro/attach/magic/initiate/v1.py 0000644 00000006524 15030103444 0012377 0 ustar 00 from uaclient import secret_manager from uaclient.api import exceptions from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo from uaclient.config import UAConfig from uaclient.contract import UAContractClient from uaclient.data_types import ( DataObject, Field, IntDataValue, StringDataValue, ) class MagicAttachInitiateResult(DataObject, AdditionalInfo): fields = [ Field( "user_code", StringDataValue, doc=( "Code the user will see in the UI when confirming the Magic" " Attach" ), ), Field( "token", StringDataValue, doc=( "Magic Token that can be used in either" " `u.pro.attach.magic.revoke.v1`_ or" " `u.pro.attach.magic.wait.v1`_" ), ), Field( "expires", StringDataValue, doc="Timestamp of the Magic Attach process expiration", ), Field( "expires_in", IntDataValue, doc="Seconds before the Magic Attach process expires", ), ] def __init__( self, user_code: str, token: str, expires: str, expires_in: int, ): self.user_code = user_code self.token = token self.expires = expires self.expires_in = expires_in def initiate() -> MagicAttachInitiateResult: return _initiate(UAConfig()) def _initiate(cfg: UAConfig) -> MagicAttachInitiateResult: """ This endpoint initiates the Magic Attach flow, retrieving the User Code to confirm the operation and the Token used to proceed. """ contract = UAContractClient(cfg) initiate_resp = contract.new_magic_attach_token() secret_manager.secrets.add_secret(initiate_resp["token"]) secret_manager.secrets.add_secret(initiate_resp["userCode"]) return MagicAttachInitiateResult( user_code=initiate_resp["userCode"], token=initiate_resp["token"], expires=initiate_resp["expires"], expires_in=int(initiate_resp["expiresIn"]), ) endpoint = APIEndpoint( version="v1", name="MagicAttachInitiate", fn=_initiate, options_cls=None, ) _doc = { "introduced_in": "27.11", "requires_network": True, "example_python": """ from uaclient.api.u.pro.attach.magic.initiate.v1 import initiate result = initiate() """, "result_class": MagicAttachInitiateResult, "exceptions": [ ( exceptions.ConnectivityError, ( "Raised if it is not possible to connect to the contracts" " service." ), ), ( exceptions.ContractAPIError, ( "Raised if there is an unexpected error in the contracts" " service interaction." ), ), ( exceptions.MagicAttachUnavailable, ( "Raised if the Magic Attach service is busy or unavailable at" " the moment." ), ), ], "example_cli": "pro api u.pro.attach.magic.initiate.v1", "example_json": """ { "user_code":"<UI_code>", "token":"<magic_token>", "expires": "<yyyy-MM-dd>T<HH:mm:ss>.<TZ>", "expires_in": 600 } """, } pro/attach/magic/initiate/__pycache__/__init__.cpython-310.pyc 0000644 00000000260 15030103444 0020136 0 ustar 00 o �ϴf � @ s d S )N� r r r �S/usr/lib/python3/dist-packages/uaclient/api/u/pro/attach/magic/initiate/__init__.py�<module> s pro/attach/magic/initiate/__pycache__/v1.cpython-310.pyc 0000644 00000005532 15030103444 0016734 0 ustar 00 o �(�fT � @ s� d dl mZ d dlmZ d dlmZ d dlmZ d dlm Z d dl m Z d dl m Z mZmZmZ G dd � d e e�Zd efd d �Zd e d efdd�Zeddedd�Zdddeejdfejdfejdfgddd �ZdS ) � )�secret_manager)� exceptions)� APIEndpoint)�AdditionalInfo)�UAConfig)�UAContractClient)� DataObject�Field� IntDataValue�StringDataValuec @ sZ e Zd Zededd�ededd�ededd�eded d�gZdedededefd d �Z d S ) �MagicAttachInitiateResult� user_codezACode the user will see in the UI when confirming the Magic Attach)�doc�tokenzgMagic Token that can be used in either `u.pro.attach.magic.revoke.v1`_ or `u.pro.attach.magic.wait.v1`_�expiresz0Timestamp of the Magic Attach process expiration� expires_inz/Seconds before the Magic Attach process expiresc C s || _ || _|| _|| _d S �N�r r r r )�selfr r r r � r �M/usr/lib/python3/dist-packages/uaclient/api/u/pro/attach/magic/initiate/v1.py�__init__. s z"MagicAttachInitiateResult.__init__N) �__name__� __module__� __qualname__r r r �fields�str�intr r r r r r s> �� ��� ����r �returnc C s t t� �S r )� _initiater r r r r �initiate; s r �cfgc C sT t | �}|�� }tj�|d � tj�|d � t|d |d |d t|d �d�S )z� This endpoint initiates the Magic Attach flow, retrieving the User Code to confirm the operation and the Token used to proceed. r �userCoder � expiresInr )r �new_magic_attach_tokenr �secrets� add_secretr r )r! �contract� initiate_respr r r r ? s �r �v1�MagicAttachInitiateN)�version�name�fn� options_clsz27.11TzW from uaclient.api.u.pro.attach.magic.initiate.v1 import initiate result = initiate() zARaised if it is not possible to connect to the contracts service.zLRaised if there is an unexpected error in the contracts service interaction.zHRaised if the Magic Attach service is busy or unavailable at the moment.z&pro api u.pro.attach.magic.initiate.v1z� { "user_code":"<UI_code>", "token":"<magic_token>", "expires": "<yyyy-MM-dd>T<HH:mm:ss>.<TZ>", "expires_in": 600 } )� introduced_in�requires_network�example_python� result_classr � example_cli� example_json)�uaclientr � uaclient.apir �uaclient.api.apir �uaclient.api.data_typesr �uaclient.configr �uaclient.contractr �uaclient.data_typesr r r r r r r �endpoint�ConnectivityError�ContractAPIError�MagicAttachUnavailable�_docr r r r �<module> sB ,����� � pro/attach/magic/initiate/__init__.py 0000644 00000000000 15030103444 0013567 0 ustar 00 pro/attach/magic/revoke/v1.py 0000644 00000005122 15030103444 0012055 0 ustar 00 from uaclient.api import exceptions from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo from uaclient.config import UAConfig from uaclient.contract import UAContractClient from uaclient.data_types import DataObject, Field, StringDataValue class MagicAttachRevokeOptions(DataObject): fields = [ Field( "magic_token", StringDataValue, doc="The Token provided by the initiate endpoint.", ), ] def __init__(self, magic_token): self.magic_token = magic_token class MagicAttachRevokeResult(DataObject, AdditionalInfo): pass def revoke(options: MagicAttachRevokeOptions) -> MagicAttachRevokeResult: return _revoke(options, UAConfig()) def _revoke( options: MagicAttachRevokeOptions, cfg: UAConfig ) -> MagicAttachRevokeResult: """ This endpoint revokes a Magic Attach Token. """ contract = UAContractClient(cfg) contract.revoke_magic_attach_token(options.magic_token) return MagicAttachRevokeResult() endpoint = APIEndpoint( version="v1", name="MagicAttachRevoke", fn=_revoke, options_cls=MagicAttachRevokeOptions, ) _doc = { "introduced_in": "27.11", "requires_network": True, "example_python": """ from uaclient.api.u.pro.attach.magic.revoke.v1 import MagicAttachRevokeOptions, revoke options = MagicAttachWaitOptions(magic_token="<magic_token>") result = revoke(options) """, # noqa: E501 "result_class": MagicAttachRevokeResult, "exceptions": [ ( exceptions.ConnectivityError, ( "Raised if it is not possible to connect to the contracts" " service." ), ), ( exceptions.ContractAPIError, ( "Raised if there is an unexpected error in the contracts" " service interaction." ), ), ( exceptions.MagicAttachTokenAlreadyActivated, ( "Raised when trying to revoke a Token which was already" " activated through the UI." ), ), ( exceptions.MagicAttachTokenError, "Raised when an invalid/expired Token is sent.", ), ( exceptions.MagicAttachUnavailable, ( "Raised if the Magic Attach service is busy or unavailable at" " the moment." ), ), ], "example_cli": "pro api u.pro.attach.magic.revoke.v1 --args magic_token=<token>", # noqa: E501 "example_json": """ {} """, } pro/attach/magic/revoke/__pycache__/__init__.cpython-310.pyc 0000644 00000000256 15030103444 0017630 0 ustar 00 o �ϴf � @ s d S )N� r r r �Q/usr/lib/python3/dist-packages/uaclient/api/u/pro/attach/magic/revoke/__init__.py�<module> s pro/attach/magic/revoke/__pycache__/v1.cpython-310.pyc 0000644 00000005003 15030103444 0016412 0 ustar 00 o �(�fR � @ s� d dl mZ d dlmZ d dlmZ d dlmZ d dlm Z d dl m Z m Z m Z G dd� de �ZG d d � d e e�Zd ed efd d�Zd eded efdd�Zeddeed�Zdddeejdfejdfejdfejdfejd fgd d d �Zd S )!� )� exceptions)� APIEndpoint)�AdditionalInfo)�UAConfig)�UAContractClient)� DataObject�Field�StringDataValuec @ s$ e Zd Zededd�gZdd� ZdS )�MagicAttachRevokeOptions� magic_tokenz,The Token provided by the initiate endpoint.)�docc C s || _ d S �N)r )�selfr � r �K/usr/lib/python3/dist-packages/uaclient/api/u/pro/attach/magic/revoke/v1.py�__init__ s z!MagicAttachRevokeOptions.__init__N)�__name__� __module__� __qualname__r r �fieldsr r r r r r s �� r c @ s e Zd ZdS )�MagicAttachRevokeResultN)r r r r r r r r s r �options�returnc C s t | t� �S r )�_revoker )r r r r �revoke s r �cfgc C s t |�}|�| j� t� S )z5 This endpoint revokes a Magic Attach Token. )r �revoke_magic_attach_tokenr r )r r �contractr r r r s r �v1�MagicAttachRevoke)�version�name�fn� options_clsz27.11Tz� from uaclient.api.u.pro.attach.magic.revoke.v1 import MagicAttachRevokeOptions, revoke options = MagicAttachWaitOptions(magic_token="<magic_token>") result = revoke(options) zARaised if it is not possible to connect to the contracts service.zLRaised if there is an unexpected error in the contracts service interaction.zPRaised when trying to revoke a Token which was already activated through the UI.z-Raised when an invalid/expired Token is sent.zHRaised if the Magic Attach service is busy or unavailable at the moment.z?pro api u.pro.attach.magic.revoke.v1 --args magic_token=<token>z {} )� introduced_in�requires_network�example_python� result_classr � example_cli� example_jsonN)� uaclient.apir �uaclient.api.apir �uaclient.api.data_typesr �uaclient.configr �uaclient.contractr �uaclient.data_typesr r r r r r r �endpoint�ConnectivityError�ContractAPIError� MagicAttachTokenAlreadyActivated�MagicAttachTokenError�MagicAttachUnavailable�_docr r r r �<module> sZ �� � �������" � pro/attach/magic/revoke/__init__.py 0000644 00000000000 15030103444 0013254 0 ustar 00 pro/attach/magic/__init__.py 0000644 00000000000 15030103444 0011761 0 ustar 00 pro/attach/auto/full_auto_attach/v1.py 0000644 00000015673 15030103444 0014004 0 ustar 00 from typing import List, Optional, Tuple from uaclient import actions, contract, event_logger, lock, messages, util from uaclient.api import exceptions from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo from uaclient.api.u.pro.status.is_attached.v1 import _is_attached from uaclient.clouds import identity from uaclient.config import UAConfig from uaclient.data_types import DataObject, Field, StringDataValue, data_list from uaclient.entitlements import order_entitlements_for_enabling from uaclient.entitlements.entitlement_status import CanEnableFailure from uaclient.files import machine_token event = event_logger.get_event_logger() class FullAutoAttachOptions(DataObject): fields = [ Field( "enable", data_list(StringDataValue), False, doc="Optional list of services to enable after auto-attaching.", ), Field( "enable_beta", data_list(StringDataValue), False, doc=( "Optional list of beta services to enable after" " auto-attaching." ), ), Field( "cloud_override", StringDataValue, False, doc=( "Ignore the result of ``cloud-id`` and act as if running on" " this cloud." ), ), ] def __init__( self, enable: Optional[List[str]] = None, enable_beta: Optional[List[str]] = None, cloud_override: Optional[str] = None, ): self.enable = enable self.enable_beta = enable_beta self.cloud_override = cloud_override class FullAutoAttachResult(DataObject, AdditionalInfo): pass def _enable_services_by_name( cfg: UAConfig, services: List[str] ) -> List[Tuple[str, messages.NamedMessage]]: failed_services = [] for name in order_entitlements_for_enabling(cfg, services): try: ent_ret, reason = actions.enable_entitlement_by_name(cfg, name) except exceptions.UbuntuProError as e: failed_services.append( (name, messages.NamedMessage(e.msg_code or "unknown", e.msg)) ) continue if not ent_ret: if ( reason is not None and isinstance(reason, CanEnableFailure) and reason.message is not None ): failed_services.append((name, reason.message)) else: failed_services.append( ( name, messages.NamedMessage("unknown", "failed to enable"), ) ) return failed_services def full_auto_attach(options: FullAutoAttachOptions) -> FullAutoAttachResult: return _full_auto_attach(options, UAConfig()) def _full_auto_attach( options: FullAutoAttachOptions, cfg: UAConfig, *, mode: event_logger.EventLoggerMode = event_logger.EventLoggerMode.JSON ) -> FullAutoAttachResult: """ This endpoint runs the whole auto-attach process on the system. """ try: with lock.RetryLock( lock_holder="pro.api.u.pro.attach.auto.full_auto_attach.v1", ): ret = _full_auto_attach_in_lock(options, cfg, mode=mode) except Exception as e: lock.clear_lock_file_if_present() raise e return ret def _full_auto_attach_in_lock( options: FullAutoAttachOptions, cfg: UAConfig, mode: event_logger.EventLoggerMode, ) -> FullAutoAttachResult: event.set_event_mode(mode) machine_token_file = machine_token.get_machine_token_file(cfg) if _is_attached(cfg).is_attached: raise exceptions.AlreadyAttachedError( account_name=machine_token_file.account.get("name", "") ) if util.is_config_value_true( config=cfg.cfg, path_to_value="features.disable_auto_attach" ): raise exceptions.AutoAttachDisabledError() instance = identity.cloud_instance_factory( cloud_override=options.cloud_override ) enable_default_services = ( options.enable is None and options.enable_beta is None ) actions.auto_attach(cfg, instance, allow_enable=enable_default_services) failed = [] if options.enable is not None: failed += _enable_services_by_name(cfg, options.enable) if options.enable_beta is not None: failed += _enable_services_by_name(cfg, options.enable_beta) contract_client = contract.UAContractClient(cfg) contract_client.update_activity_token() if len(failed) > 0: raise exceptions.EntitlementsNotEnabledError(failed) return FullAutoAttachResult() endpoint = APIEndpoint( version="v1", name="FullAutoAttach", fn=_full_auto_attach, options_cls=FullAutoAttachOptions, ) _doc = { "introduced_in": "27.11", "requires_network": True, "extra_args_content": """ .. note:: If none of the lists are set, the services will be enabled based on the contract definitions. """, "example_python": """ from uaclient.api.u.pro.attach.auto.full_auto_attach.v1 import full_auto_attach, FullAutoAttachOptions options = FullAutoAttachOptions(enable=["<service1>", "<service2>"], enable_beta=["<beta_service3>"]) result = full_auto_attach(options) """, # noqa: E501 "result_class": FullAutoAttachResult, "exceptions": [ ( exceptions.AlreadyAttachedError, ( "Raised if running on a machine which is already attached to a" " Pro subscription." ), ), ( exceptions.AutoAttachDisabledError, "Raised if ``disable_auto_attach: true`` in ``uaclient.conf``.", ), ( exceptions.ConnectivityError, ( "Raised if it is not possible to connect to the contracts" " service." ), ), ( exceptions.ContractAPIError, ( "Raised if there is an unexpected error in the contracts" " service interaction." ), ), ( exceptions.EntitlementsNotEnabledError, ( "Raised if the Client fails to enable any of the entitlements" " (whether present in any of the lists or listed in the" " contract)." ), ), ( exceptions.LockHeldError, ( "Raised if another Client process is holding the lock on the" " machine." ), ), ( exceptions.NonAutoAttachImageError, ( "Raised if the cloud where the system is running does not" " support auto-attach." ), ), ], "example_cli": 'pro api u.pro.attach.auto.full_auto_attach.v1 --data {"enable": ["esm-infra", "esm-apps"]}', # noqa: E501 "example_json": """ {} """, } pro/attach/auto/full_auto_attach/__pycache__/__init__.cpython-310.pyc 0000644 00000000267 15030103444 0021545 0 ustar 00 o �ϴf � @ s d S )N� r r r �Z/usr/lib/python3/dist-packages/uaclient/api/u/pro/attach/auto/full_auto_attach/__init__.py�<module> s pro/attach/auto/full_auto_attach/__pycache__/v1.cpython-310.pyc 0000644 00000013165 15030103444 0020335 0 ustar 00 o �(�f� � @ s� d dl mZmZmZ d dlmZmZmZmZm Z m Z d dl m Z d dl mZ d dlmZ d dlmZ d dlmZ d dlmZ d d lmZmZmZmZ d d l m Z d d l m Z d d l m!Z! e�"� Z#G d d� de�Z$G dd� dee�Z%dedee& deee&e j'f fdd�Z(de$de%fdd�Z)ej*j+d�de$dedej*de%fdd �Z,de$dedej*de%fd d �Z-ed d e,e$d!�Z.d"d#d$d%e%e j/d&fe j0d'fe j1d(fe j2d)fe j3d*fe j4d+fe j5d,fgd-d.d/�Z6d0S )1� )�List�Optional�Tuple)�actions�contract� event_logger�lock�messages�util)� exceptions)� APIEndpoint)�AdditionalInfo)� _is_attached)�identity)�UAConfig)� DataObject�Field�StringDataValue� data_list)� order_entitlements_for_enabling)�CanEnableFailure)� machine_tokenc @ st e Zd Zedee�ddd�edee�ddd�ededdd�gZ d deee deee dee fd d �Z d S ) �FullAutoAttachOptions�enableFz9Optional list of services to enable after auto-attaching.)�doc� enable_betaz>Optional list of beta services to enable after auto-attaching.�cloud_overridezFIgnore the result of ``cloud-id`` and act as if running on this cloud.Nc C s || _ || _|| _d S �N)r r r )�selfr r r � r �T/usr/lib/python3/dist-packages/uaclient/api/u/pro/attach/auto/full_auto_attach/v1.py�__init__. s z FullAutoAttachOptions.__init__)NNN) �__name__� __module__� __qualname__r r r �fieldsr r �strr! r r r r r s< �� �� � � ��r c @ s e Zd ZdS )�FullAutoAttachResultN)r" r# r$ r r r r r' 9 s r' �cfg�services�returnc C s� g }t | |�D ]S}z t�| |�\}}W n" tjy5 } z|�|t�|jp%d|j �f� W Y d }~qd }~ww |sZ|d urOt |t �rO|j d urO|�||j f� q|�|t�dd�f� q|S )N�unknownzfailed to enable) r r �enable_entitlement_by_namer �UbuntuProError�appendr � NamedMessage�msg_code�msg� isinstancer �message)r( r) �failed_services�name�ent_ret�reason�er r r �_enable_services_by_name= s0 � ��� ���r9 �optionsc C s t | t� �S r )�_full_auto_attachr )r: r r r �full_auto_attachZ s r< ��moder> c C sj z"t jdd�� t| ||d�}W d � W |S 1 sw Y W |S ty4 } zt �� |�d}~ww )zI This endpoint runs the whole auto-attach process on the system. z-pro.api.u.pro.attach.auto.full_auto_attach.v1)� lock_holderr= N)r � RetryLock�_full_auto_attach_in_lock� Exception�clear_lock_file_if_present)r: r( r> �retr8 r r r r; ^ s � �����r; c C s� t �|� t�|�}t|�jrtj|j� dd�d��t j |j dd�r&t� � �tj| jd�}| jd u o6| jd u }tj|||d� g }| jd urN|t|| j�7 }| jd ur[|t|| j�7 }t�|�}|�� t|�dkrot�|��t� S ) Nr5 � )� account_namez features.disable_auto_attach)�config� path_to_value)r )� allow_enabler ) �event�set_event_moder �get_machine_token_filer � is_attachedr �AlreadyAttachedError�account�getr �is_config_value_truer( �AutoAttachDisabledErrorr �cloud_instance_factoryr r r r � auto_attachr9 r �UAContractClient�update_activity_token�len�EntitlementsNotEnabledErrorr' )r: r( r> �machine_token_file�instance�enable_default_services�failed�contract_clientr r r rA r s4 ���� rA �v1�FullAutoAttach)�versionr5 �fn� options_clsz27.11Tzr .. note:: If none of the lists are set, the services will be enabled based on the contract definitions. z� from uaclient.api.u.pro.attach.auto.full_auto_attach.v1 import full_auto_attach, FullAutoAttachOptions options = FullAutoAttachOptions(enable=["<service1>", "<service2>"], enable_beta=["<beta_service3>"]) result = full_auto_attach(options) zORaised if running on a machine which is already attached to a Pro subscription.z=Raised if ``disable_auto_attach: true`` in ``uaclient.conf``.zARaised if it is not possible to connect to the contracts service.zLRaised if there is an unexpected error in the contracts service interaction.z}Raised if the Client fails to enable any of the entitlements (whether present in any of the lists or listed in the contract).zDRaised if another Client process is holding the lock on the machine.zMRaised if the cloud where the system is running does not support auto-attach.zZpro api u.pro.attach.auto.full_auto_attach.v1 --data {"enable": ["esm-infra", "esm-apps"]}z {} )� introduced_in�requires_network�extra_args_content�example_python� result_classr � example_cli� example_jsonN)7�typingr r r �uaclientr r r r r r � uaclient.apir �uaclient.api.apir �uaclient.api.data_typesr �(uaclient.api.u.pro.status.is_attached.v1r �uaclient.cloudsr �uaclient.configr �uaclient.data_typesr r r r �uaclient.entitlementsr �(uaclient.entitlements.entitlement_statusr �uaclient.filesr �get_event_loggerrJ r r' r& r/ r9 r< �EventLoggerMode�JSONr; rA �endpointrN rR �ConnectivityError�ContractAPIErrorrX � LockHeldError�NonAutoAttachImageError�_docr r r r �<module> s� '�� � ���� ���� �)������ ���1 � pro/attach/auto/full_auto_attach/__init__.py 0000644 00000000000 15030103444 0015167 0 ustar 00 pro/attach/auto/__pycache__/__init__.cpython-310.pyc 0000644 00000000246 15030103444 0016224 0 ustar 00 o �ϴf � @ s d S )N� r r r �I/usr/lib/python3/dist-packages/uaclient/api/u/pro/attach/auto/__init__.py�<module> s pro/attach/auto/configure_retry_service/v1.py 0000644 00000005303 15030103444 0015401 0 ustar 00 from uaclient import system from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo from uaclient.api.u.pro.attach.auto.full_auto_attach.v1 import ( FullAutoAttachOptions, ) from uaclient.config import UAConfig from uaclient.daemon import retry_auto_attach from uaclient.data_types import DataObject from uaclient.files import state_files ConfigureRetryServiceOptions = FullAutoAttachOptions class ConfigureRetryServiceResult(DataObject, AdditionalInfo): pass def configure_retry_service( options: ConfigureRetryServiceOptions, ) -> ConfigureRetryServiceResult: return _configure_retry_service(options, UAConfig()) def _configure_retry_service( options: ConfigureRetryServiceOptions, cfg: UAConfig ) -> ConfigureRetryServiceResult: """ This endpoint configures options for the retry auto-attach functionality, and creates files that will activate the retry auto-attach functionality if ``ubuntu-advantage.service`` runs. Note that this does not start ``ubuntu-advantage.service``. This makes it useful for calling during the boot process ``Before: ubuntu-advantage.service`` so that when ``ubuntu-advantage.service`` starts, its ``ConditionPathExists`` check passes and activates the retry auto-attach function. If you call this function outside of the boot process and would like the retry auto-attach functionality to actually start, you'll need to call something like ``systemctl start ubuntu-advantage.service``. """ state_files.retry_auto_attach_options_file.write( state_files.RetryAutoAttachOptions( enable=options.enable, enable_beta=options.enable_beta ) ) system.create_file(retry_auto_attach.FLAG_FILE_PATH) return ConfigureRetryServiceResult() endpoint = APIEndpoint( version="v1", name="ConfigureRetryService", fn=_configure_retry_service, options_cls=ConfigureRetryServiceOptions, ) _doc = { "introduced_in": "27.12", "requires_network": False, "extra_args_content": """ .. note:: If none of the lists are set, the services will be enabled based on the contract definitions. """, "example_python": """ from uaclient.api.u.pro.attach.auto.configure_retry_service.v1 import configure_retry_service, ConfigureRetryServiceOptions options = ConfigureRetryServiceOptions(enable=["<service1>", "<service2>"], enable_beta=["<beta_service3>"]) result = configure_retry_service(options) """, # noqa: E501 "result_class": ConfigureRetryServiceResult, "exceptions": [], "example_cli": 'pro api u.pro.attach.auto.configure_retry_service.v1 --data {"enable": ["esm-infra", "esm-apps"]}', # noqa: E501 "example_json": """ {} """, } pro/attach/auto/configure_retry_service/__pycache__/__init__.cpython-310.pyc 0000644 00000000276 15030103444 0023155 0 ustar 00 o �ϴf � @ s d S )N� r r r �a/usr/lib/python3/dist-packages/uaclient/api/u/pro/attach/auto/configure_retry_service/__init__.py�<module> s pro/attach/auto/configure_retry_service/__pycache__/v1.cpython-310.pyc 0000644 00000005517 15030103444 0021747 0 ustar 00 o �(�f� � @ s� d dl mZ d dlmZ d dlmZ d dlmZ d dlm Z d dl m Z d dl m Z d dlmZ eZG d d � d e e�Zd ed efd d�Zd ede d efdd�Zeddeed�Zddddeg ddd�Zd S ) � )�system)� APIEndpoint)�AdditionalInfo)�FullAutoAttachOptions)�UAConfig)�retry_auto_attach)� DataObject)� state_filesc @ s e Zd ZdS )�ConfigureRetryServiceResultN)�__name__� __module__� __qualname__� r r �[/usr/lib/python3/dist-packages/uaclient/api/u/pro/attach/auto/configure_retry_service/v1.pyr s r �options�returnc C s t | t� �S )N)�_configure_retry_servicer )r r r r �configure_retry_service s r �cfgc C s, t j�t j| j| jd�� t�tj � t � S )a� This endpoint configures options for the retry auto-attach functionality, and creates files that will activate the retry auto-attach functionality if ``ubuntu-advantage.service`` runs. Note that this does not start ``ubuntu-advantage.service``. This makes it useful for calling during the boot process ``Before: ubuntu-advantage.service`` so that when ``ubuntu-advantage.service`` starts, its ``ConditionPathExists`` check passes and activates the retry auto-attach function. If you call this function outside of the boot process and would like the retry auto-attach functionality to actually start, you'll need to call something like ``systemctl start ubuntu-advantage.service``. )�enable� enable_beta) r � retry_auto_attach_options_file�write�RetryAutoAttachOptionsr r r � create_filer �FLAG_FILE_PATHr )r r r r r r s �� r �v1�ConfigureRetryService)�version�name�fn� options_clsz27.12Fzr .. note:: If none of the lists are set, the services will be enabled based on the contract definitions. a from uaclient.api.u.pro.attach.auto.configure_retry_service.v1 import configure_retry_service, ConfigureRetryServiceOptions options = ConfigureRetryServiceOptions(enable=["<service1>", "<service2>"], enable_beta=["<beta_service3>"]) result = configure_retry_service(options) zapro api u.pro.attach.auto.configure_retry_service.v1 --data {"enable": ["esm-infra", "esm-apps"]}z {} )� introduced_in�requires_network�extra_args_content�example_python� result_class� exceptions� example_cli� example_jsonN)�uaclientr �uaclient.api.apir �uaclient.api.data_typesr �2uaclient.api.u.pro.attach.auto.full_auto_attach.v1r �uaclient.configr �uaclient.daemonr �uaclient.data_typesr �uaclient.filesr � ConfigureRetryServiceOptionsr r r �endpoint�_docr r r r �<module> sJ � ��� �� � pro/attach/auto/configure_retry_service/__init__.py 0000644 00000000000 15030103444 0016577 0 ustar 00 pro/attach/auto/should_auto_attach/v1.py 0000644 00000003417 15030103444 0014331 0 ustar 00 from uaclient import exceptions from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo from uaclient.apt import is_installed from uaclient.clouds.identity import cloud_instance_factory from uaclient.config import UAConfig from uaclient.data_types import BoolDataValue, DataObject, Field class ShouldAutoAttachResult(DataObject, AdditionalInfo): fields = [ Field( "should_auto_attach", BoolDataValue, doc="True if the system should run auto-attach on boot", ), ] def __init__(self, should_auto_attach: bool): self.should_auto_attach = should_auto_attach def should_auto_attach() -> ShouldAutoAttachResult: return _should_auto_attach(UAConfig()) def _should_auto_attach(cfg: UAConfig) -> ShouldAutoAttachResult: """ This endpoint checks if a given system should run auto-attach on boot. """ try: cloud_instance_factory() except exceptions.CloudFactoryError: return ShouldAutoAttachResult( should_auto_attach=False, ) return ShouldAutoAttachResult( should_auto_attach=is_installed("ubuntu-advantage-pro") or is_installed("ubuntu-pro-auto-attach"), ) endpoint = APIEndpoint( version="v1", name="ShouldAutoAttach", fn=_should_auto_attach, options_cls=None, ) _doc = { "introduced_in": "27.11", "requires_network": False, "example_python": """ from uaclient.api.u.pro.attach.auto.should_auto_attach.v1 import should_auto_attach result = should_auto_attach() """, # noqa: E501 "result_class": ShouldAutoAttachResult, "exceptions": [], "example_cli": "pro api u.pro.attach.auto.should_auto_attach.v1", "example_json": """ { "should_auto_attach": false } """, } pro/attach/auto/should_auto_attach/__pycache__/__init__.cpython-310.pyc 0000644 00000000271 15030103444 0022074 0 ustar 00 o �ϴf � @ s d S )N� r r r �\/usr/lib/python3/dist-packages/uaclient/api/u/pro/attach/auto/should_auto_attach/__init__.py�<module> s pro/attach/auto/should_auto_attach/__pycache__/v1.cpython-310.pyc 0000644 00000003726 15030103444 0020673 0 ustar 00 o �(�f � @ s� d dl mZ d dlmZ d dlmZ d dlmZ d dlm Z d dl m Z d dl m Z mZmZ G dd � d ee�Zd efd d �Zd e d efdd�Zeddedd�Zdddeg ddd�ZdS )� )� exceptions)� APIEndpoint)�AdditionalInfo)� is_installed)�cloud_instance_factory)�UAConfig)� BoolDataValue� DataObject�Fieldc @ s* e Zd Zededd�gZdefdd�ZdS )�ShouldAutoAttachResult�should_auto_attachz1True if the system should run auto-attach on boot)�docc C s || _ d S �N�r )�selfr � r �V/usr/lib/python3/dist-packages/uaclient/api/u/pro/attach/auto/should_auto_attach/v1.py�__init__ � z ShouldAutoAttachResult.__init__N)�__name__� __module__� __qualname__r r �fields�boolr r r r r r s ��r �returnc C s t t� �S r )�_should_auto_attachr r r r r r r r �cfgc C s@ zt � W n tjy tdd� Y S w ttd�p td�d�S )zP This endpoint checks if a given system should run auto-attach on boot. Fr zubuntu-advantage-prozubuntu-pro-auto-attach)r r �CloudFactoryErrorr r )r r r r r s ���r �v1�ShouldAutoAttachN)�version�name�fn� options_clsz27.11Fzt from uaclient.api.u.pro.attach.auto.should_auto_attach.v1 import should_auto_attach result = should_auto_attach() z/pro api u.pro.attach.auto.should_auto_attach.v1z% { "should_auto_attach": false } )� introduced_in�requires_network�example_python� result_classr � example_cli� example_json)�uaclientr �uaclient.api.apir �uaclient.api.data_typesr � uaclient.aptr �uaclient.clouds.identityr �uaclient.configr �uaclient.data_typesr r r r r r �endpoint�_docr r r r �<module> s0 � � pro/attach/auto/should_auto_attach/__init__.py 0000644 00000000000 15030103444 0015523 0 ustar 00 pro/attach/auto/__init__.py 0000644 00000000000 15030103444 0011651 0 ustar 00 pro/attach/__init__.py 0000644 00000000000 15030103444 0010701 0 ustar 00 pro/__pycache__/__init__.cpython-310.pyc 0000644 00000000232 15030103444 0014003 0 ustar 00 o �ϴf � @ s d S )N� r r r �=/usr/lib/python3/dist-packages/uaclient/api/u/pro/__init__.py�<module> s pro/packages/__pycache__/__init__.cpython-310.pyc 0000644 00000000243 15030103444 0015563 0 ustar 00 o �ϴf � @ s d S )N� r r r �F/usr/lib/python3/dist-packages/uaclient/api/u/pro/packages/__init__.py�<module> s pro/packages/updates/v1.py 0000644 00000013350 15030103444 0011463 0 ustar 00 from typing import List from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo from uaclient.config import UAConfig from uaclient.data_types import ( DataObject, Field, IntDataValue, StringDataValue, data_list, ) from uaclient.security_status import ( create_updates_list, filter_updates, get_installed_packages_by_origin, get_ua_info, ) class UpdateSummary(DataObject): fields = [ Field( "num_updates", IntDataValue, doc="Total count of available updates" ), Field( "num_esm_apps_updates", IntDataValue, doc="Count of available updates from ``esm-apps``", ), Field( "num_esm_infra_updates", IntDataValue, doc="Count of available updates from ``esm-infra``", ), Field( "num_standard_security_updates", IntDataValue, doc="Count of available updates from the ``-security`` pocket", ), Field( "num_standard_updates", IntDataValue, doc="Count of available updates from the ``-updates`` pocket", ), ] def __init__( self, num_updates: int, num_esm_apps_updates: int, num_esm_infra_updates: int, num_standard_security_updates: int, num_standard_updates: int, ): self.num_updates = num_updates self.num_esm_apps_updates = num_esm_apps_updates self.num_esm_infra_updates = num_esm_infra_updates self.num_standard_security_updates = num_standard_security_updates self.num_standard_updates = num_standard_updates class UpdateInfo(DataObject): fields = [ Field( "download_size", IntDataValue, doc="Download size for the update in bytes", ), Field( "origin", StringDataValue, doc="Where the update is downloaded from", ), Field( "package", StringDataValue, doc="Name of the package to be updated" ), Field( "provided_by", StringDataValue, doc="Service which provides the update", ), Field( "status", StringDataValue, doc="Whether this update is ready for download or not", ), Field("version", StringDataValue, doc="Version of the update"), ] def __init__( self, download_size: int, origin: str, package: str, provided_by: str, status: str, version: str, ): self.download_size = download_size self.origin = origin self.package = package self.provided_by = provided_by self.status = status self.version = version class PackageUpdatesResult(DataObject, AdditionalInfo): fields = [ Field( "summary", UpdateSummary, doc="Summary of all available updates" ), Field( "updates", data_list(UpdateInfo), doc="Detailed list of all available updates", ), ] def __init__(self, summary: UpdateSummary, updates: List[UpdateInfo]): self.summary = summary self.updates = updates def updates() -> PackageUpdatesResult: return _updates(UAConfig()) def _updates(cfg: UAConfig) -> PackageUpdatesResult: """ This endpoint shows available updates for packages in a system, categorised by where they can be obtained. """ ua_info = get_ua_info(cfg) packages = get_installed_packages_by_origin() upgradable_versions = filter_updates(packages["all"]) update_list = create_updates_list(upgradable_versions, ua_info) num_esm_apps_updates = len(upgradable_versions["esm-apps"]) num_esm_infra_updates = len(upgradable_versions["esm-infra"]) num_standard_security_updates = len( upgradable_versions["standard-security"] ) num_standard_updates = len(upgradable_versions["standard-updates"]) summary = UpdateSummary( num_updates=num_esm_apps_updates + num_esm_infra_updates + num_standard_security_updates + num_standard_updates, num_esm_apps_updates=num_esm_apps_updates, num_esm_infra_updates=num_esm_infra_updates, num_standard_security_updates=num_standard_security_updates, num_standard_updates=num_standard_updates, ) updates = [ UpdateInfo( download_size=update["download_size"], origin=update["origin"], package=update["package"], provided_by=update["service_name"], status=update["status"], version=update["version"], ) for update in update_list ] return PackageUpdatesResult(summary=summary, updates=updates) endpoint = APIEndpoint( version="v1", name="PackageUpdates", fn=_updates, options_cls=None, ) _doc = { "introduced_in": "27.12", "requires_network": False, "example_python": """ from uaclient.api.u.pro.packages.updates.v1 import updates result = updates() """, # noqa: E501 "result_class": PackageUpdatesResult, "exceptions": [], "example_cli": "pro api u.pro.packages.updates.v1", "example_json": """ { "summary": { "num_updates": 1, "num_esm_apps_updates": 2, "num_esm_infra_updates": 3, "num_standard_security_updates": 4, "num_standard_updates": 5, }, "updates": [ { "download_size": 6, "origin": "<some site>", "package": "<package name>", "provided_by": "<service name>", "status": "<update status>", "version": "<updated version>", }, ] } """, } pro/packages/updates/__pycache__/__init__.cpython-310.pyc 0000644 00000000253 15030103444 0017231 0 ustar 00 o �ϴf � @ s d S )N� r r r �N/usr/lib/python3/dist-packages/uaclient/api/u/pro/packages/updates/__init__.py�<module> s pro/packages/updates/__pycache__/v1.cpython-310.pyc 0000644 00000011225 15030103444 0016021 0 ustar 00 o �(�f� � @ s� d dl mZ d dlmZ d dlmZ d dlmZ d dlm Z m Z m Z m Z m Z d dlmZmZmZmZ G dd� de �ZG d d � d e �ZG d d � d e e�Zd efdd�Zded efdd�Zeddedd�Zdddeg ddd �ZdS ) � )�List)� APIEndpoint)�AdditionalInfo)�UAConfig)� DataObject�Field� IntDataValue�StringDataValue� data_list)�create_updates_list�filter_updates� get_installed_packages_by_origin� get_ua_infoc @ sj e Zd Zededd�ededd�ededd�eded d�ed ed d�gZdedededed ef d d �ZdS )� UpdateSummary� num_updatesz Total count of available updates��doc�num_esm_apps_updatesz,Count of available updates from ``esm-apps``�num_esm_infra_updatesz-Count of available updates from ``esm-infra``� num_standard_security_updatesz8Count of available updates from the ``-security`` pocket�num_standard_updatesz7Count of available updates from the ``-updates`` pocketc C s" || _ || _|| _|| _|| _d S �N�r r r r r )�selfr r r r r � r �H/usr/lib/python3/dist-packages/uaclient/api/u/pro/packages/updates/v1.py�__init__0 s zUpdateSummary.__init__N)�__name__� __module__� __qualname__r r �fields�intr r r r r r sH �����������r c @ sz e Zd Zededd�ededd�ededd�eded d�ed ed d�ed ed d�gZdedededed ed ef dd�Z dS )� UpdateInfo� download_sizez%Download size for the update in bytesr �originz#Where the update is downloaded from�packagez!Name of the package to be updated� provided_byz!Service which provides the update�statusz0Whether this update is ready for download or not�versionzVersion of the updatec C s( || _ || _|| _|| _|| _|| _d S r �r# r$ r% r& r' r( )r r# r$ r% r& r' r( r r r r [ s zUpdateInfo.__init__N) r r r r r r r r! �strr r r r r r" ? sN ����� �������r" c @ sB e Zd Zededd�edee�dd�gZdedee fdd�Z dS ) �PackageUpdatesResult�summaryz Summary of all available updatesr �updatesz&Detailed list of all available updatesc C s || _ || _d S r �r, r- )r r, r- r r r r x s z PackageUpdatesResult.__init__N) r r r r r r r" r r r r r r r r+ l s ��� r+ �returnc C s t t� �S r )�_updatesr r r r r r- } s r- �cfgc C s� t | �}t� }t|d �}t||�}t|d �}t|d �}t|d �}t|d �}t|| | | ||||d�} dd� |D �} t| | d �S ) zx This endpoint shows available updates for packages in a system, categorised by where they can be obtained. �allzesm-appsz esm-infrazstandard-securityzstandard-updatesr c S s8 g | ]}t |d |d |d |d |d |d d��qS )r# r$ r% � service_namer' r( r) )r" )�.0�updater r r � <listcomp>� s ���z _updates.<locals>.<listcomp>r. )r r r r �lenr r+ ) r1 �ua_info�packages�upgradable_versions� update_listr r r r r, r- r r r r0 � s6 � ���� � r0 �v1�PackageUpdatesN)r( �name�fn� options_clsz27.12FzP from uaclient.api.u.pro.packages.updates.v1 import updates result = updates() z!pro api u.pro.packages.updates.v1a� { "summary": { "num_updates": 1, "num_esm_apps_updates": 2, "num_esm_infra_updates": 3, "num_standard_security_updates": 4, "num_standard_updates": 5, }, "updates": [ { "download_size": 6, "origin": "<some site>", "package": "<package name>", "provided_by": "<service name>", "status": "<update status>", "version": "<updated version>", }, ] } )� introduced_in�requires_network�example_python� result_class� exceptions� example_cli� example_json)�typingr �uaclient.api.apir �uaclient.api.data_typesr �uaclient.configr �uaclient.data_typesr r r r r �uaclient.security_statusr r r r r r" r+ r- r0 �endpoint�_docr r r r �<module> s2 *-*� � pro/packages/updates/__init__.py 0000644 00000000000 15030103444 0012660 0 ustar 00 pro/packages/summary/v1.py 0000644 00000010764 15030103444 0011521 0 ustar 00 from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo from uaclient.config import UAConfig from uaclient.data_types import DataObject, Field, IntDataValue from uaclient.security_status import get_installed_packages_by_origin class PackageSummary(DataObject): fields = [ Field( "num_installed_packages", IntDataValue, doc="Total count of installed packages", ), Field( "num_esm_apps_packages", IntDataValue, doc="Count of packages installed from ``esm-apps``", ), Field( "num_esm_infra_packages", IntDataValue, doc="Count of packages installed from ``esm-infra``", ), Field( "num_main_packages", IntDataValue, doc="Count of packages installed from ``main``", ), Field( "num_multiverse_packages", IntDataValue, doc="Count of packages installed from ``multiverse``", ), Field( "num_restricted_packages", IntDataValue, doc="Count of packages installed from ``restricted``", ), Field( "num_third_party_packages", IntDataValue, doc="Count of packages installed from third party sources", ), Field( "num_universe_packages", IntDataValue, doc="Count of packages installed from ``universe``", ), Field( "num_unknown_packages", IntDataValue, doc="Count of packages installed from unknown sources", ), ] def __init__( self, num_installed_packages: int, num_esm_apps_packages: int, num_esm_infra_packages: int, num_main_packages: int, num_multiverse_packages: int, num_restricted_packages: int, num_third_party_packages: int, num_universe_packages: int, num_unknown_packages: int, ): self.num_installed_packages = num_installed_packages self.num_esm_apps_packages = num_esm_apps_packages self.num_esm_infra_packages = num_esm_infra_packages self.num_main_packages = num_main_packages self.num_multiverse_packages = num_multiverse_packages self.num_restricted_packages = num_restricted_packages self.num_third_party_packages = num_third_party_packages self.num_universe_packages = num_universe_packages self.num_unknown_packages = num_unknown_packages class PackageSummaryResult(DataObject, AdditionalInfo): fields = [ Field( "summary", PackageSummary, doc=("Summary of all installed packages"), ) ] def __init__(self, summary): self.summary = summary def summary() -> PackageSummaryResult: return _summary(UAConfig()) def _summary(cfg: UAConfig) -> PackageSummaryResult: """ This endpoint shows a summary of installed packages in the system, categorised by origin. """ packages = get_installed_packages_by_origin() summary = PackageSummary( num_installed_packages=len(packages["all"]), num_esm_apps_packages=len(packages["esm-apps"]), num_esm_infra_packages=len(packages["esm-infra"]), num_main_packages=len(packages["main"]), num_multiverse_packages=len(packages["multiverse"]), num_restricted_packages=len(packages["restricted"]), num_third_party_packages=len(packages["third-party"]), num_universe_packages=len(packages["universe"]), num_unknown_packages=len(packages["unknown"]), ) return PackageSummaryResult(summary=summary) endpoint = APIEndpoint( version="v1", name="PackageSummary", fn=_summary, options_cls=None, ) _doc = { "introduced_in": "27.12", "requires_network": False, "example_python": """ from uaclient.api.u.pro.packages.summary.v1 import summary result = summary() """, # noqa: E501 "result_class": PackageSummaryResult, "exceptions": [], "example_cli": "pro api u.pro.packages.summary.v1", "example_json": """ { "summary":{ "num_installed_packages": 1, "num_esm_apps_packages": 2, "num_esm_infra_packages": 3, "num_main_packages": 4, "num_multiverse_packages": 5, "num_restricted_packages": 6, "num_third_party_packages": 7, "num_universe_packages": 8, "num_unknown_packages": 9, }, } """, } pro/packages/summary/__pycache__/__init__.cpython-310.pyc 0000644 00000000253 15030103444 0017261 0 ustar 00 o �ϴf � @ s d S )N� r r r �N/usr/lib/python3/dist-packages/uaclient/api/u/pro/packages/summary/__init__.py�<module> s pro/packages/summary/__pycache__/v1.cpython-310.pyc 0000644 00000007010 15030103444 0016046 0 ustar 00 o �(�f� � @ s� d dl mZ d dlmZ d dlmZ d dlmZmZm Z d dl m Z G dd� de�Z G dd � d ee�Z d e fd d �Zd ed e fdd�Zeddedd�Zddde g ddd�ZdS )� )� APIEndpoint)�AdditionalInfo)�UAConfig)� DataObject�Field� IntDataValue)� get_installed_packages_by_originc @ s� e Zd Zededd�ededd�ededd�eded d�ed ed d�ed ed d�ededd�ededd�ededd�g Zdedededed ed edededefdd�ZdS )�PackageSummary�num_installed_packagesz!Total count of installed packages��doc�num_esm_apps_packagesz-Count of packages installed from ``esm-apps``�num_esm_infra_packagesz.Count of packages installed from ``esm-infra``�num_main_packagesz)Count of packages installed from ``main``�num_multiverse_packagesz/Count of packages installed from ``multiverse``�num_restricted_packagesz/Count of packages installed from ``restricted``�num_third_party_packagesz4Count of packages installed from third party sources�num_universe_packagesz-Count of packages installed from ``universe``�num_unknown_packagesz0Count of packages installed from unknown sourcesc C s: || _ || _|| _|| _|| _|| _|| _|| _| | _d S �N� r r r r r r r r r ) �selfr r r r r r r r r � r �H/usr/lib/python3/dist-packages/uaclient/api/u/pro/packages/summary/v1.py�__init__9 s zPackageSummary.__init__N)�__name__� __module__� __qualname__r r �fields�intr r r r r r s� ����������0������� � �r c @ s$ e Zd Zededd�gZdd� ZdS )�PackageSummaryResult�summaryz!Summary of all installed packagesr c C s || _ d S r �r! )r r! r r r r Y � z PackageSummaryResult.__init__N)r r r r r r r r r r r r P s �� r �returnc C s t t� �S r )�_summaryr r r r r r! ] r# r! �cfgc C sr t � }tt|d �t|d �t|d �t|d �t|d �t|d �t|d �t|d �t|d �d � }t|d �S ) zg This endpoint shows a summary of installed packages in the system, categorised by origin. �allzesm-appsz esm-infra�main� multiverse� restrictedz third-party�universe�unknownr r" )r r �lenr )r& �packagesr! r r r r% a s � r% �v1N)�version�name�fn� options_clsz27.12FzP from uaclient.api.u.pro.packages.summary.v1 import summary result = summary() z!pro api u.pro.packages.summary.v1ad { "summary":{ "num_installed_packages": 1, "num_esm_apps_packages": 2, "num_esm_infra_packages": 3, "num_main_packages": 4, "num_multiverse_packages": 5, "num_restricted_packages": 6, "num_third_party_packages": 7, "num_universe_packages": 8, "num_unknown_packages": 9, }, } )� introduced_in�requires_network�example_python� result_class� exceptions� example_cli� example_json)�uaclient.api.apir �uaclient.api.data_typesr �uaclient.configr �uaclient.data_typesr r r �uaclient.security_statusr r r r! r% �endpoint�_docr r r r �<module> s. H � � pro/packages/summary/__init__.py 0000644 00000000000 15030103444 0012710 0 ustar 00 pro/packages/__init__.py 0000644 00000000000 15030103444 0011213 0 ustar 00 pro/version/v1.py 0000644 00000003067 15030103444 0007731 0 ustar 00 from uaclient import messages from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo from uaclient.api.errors import APIError from uaclient.config import UAConfig from uaclient.data_types import DataObject, Field, StringDataValue from uaclient.version import get_version class VersionError(APIError): _formatted_msg = messages.E_API_VERSION_ERROR class VersionResult(DataObject, AdditionalInfo): fields = [ Field( "installed_version", StringDataValue, doc="The current installed version", ), ] def __init__(self, *, installed_version: str): self.installed_version = installed_version def version() -> VersionResult: return _version(UAConfig()) def _version(cfg: UAConfig) -> VersionResult: """ This endpoint shows the installed Pro Client version. """ try: version = get_version() except Exception as e: raise VersionError(error_msg=str(e)) return VersionResult(installed_version=version) endpoint = APIEndpoint( version="v1", name="Version", fn=_version, options_cls=None, ) _doc = { "introduced_in": "27.11", "requires_network": False, "example_python": """ from uaclient.api.u.pro.version.v1 import version result = version() """, "result_class": VersionResult, "exceptions": [ (VersionError, "Raised if the Client cannot determine the version.") ], "example_cli": "pro api u.pro.version.v1", "example_json": """ { "installed_version": "32.3~24.04" } """, } pro/version/__pycache__/__init__.cpython-310.pyc 0000644 00000000242 15030103444 0015471 0 ustar 00 o �ϴf � @ s d S )N� r r r �E/usr/lib/python3/dist-packages/uaclient/api/u/pro/version/__init__.py�<module> s pro/version/__pycache__/v1.cpython-310.pyc 0000644 00000003770 15030103444 0014271 0 ustar 00 o �(�f7 � @ s� d dl mZ d dlmZ d dlmZ d dlmZ d dlm Z d dl m Z m Z m Z d dlmZ G dd � d e�ZG d d � d e e�Zd efd d�Zde d efdd�Zeddedd�Zdddeedfgddd �ZdS ) � )�messages)� APIEndpoint)�AdditionalInfo)�APIError)�UAConfig)� DataObject�Field�StringDataValue)� get_versionc @ s e Zd ZejZdS )� VersionErrorN)�__name__� __module__� __qualname__r �E_API_VERSION_ERROR�_formatted_msg� r r �?/usr/lib/python3/dist-packages/uaclient/api/u/pro/version/v1.pyr s r c @ s* e Zd Zededd�gZdefdd�ZdS )� VersionResult�installed_versionz The current installed version)�docc C s || _ d S �N�r )�selfr r r r �__init__ � zVersionResult.__init__N)r r r r r �fields�strr r r r r r s ��r �returnc C s t t� �S r )�_versionr r r r r �version r r �cfgc C s< zt � }W n ty } ztt|�d��d}~ww t|d�S )z? This endpoint shows the installed Pro Client version. )� error_msgNr )r � Exceptionr r r )r r �er r r r s �� r �v1�VersionN)r �name�fn� options_clsz27.11FzG from uaclient.api.u.pro.version.v1 import version result = version() z2Raised if the Client cannot determine the version.zpro api u.pro.version.v1z+ { "installed_version": "32.3~24.04" } )� introduced_in�requires_network�example_python� result_class� exceptions� example_cli� example_json)�uaclientr �uaclient.api.apir �uaclient.api.data_typesr �uaclient.api.errorsr �uaclient.configr �uaclient.data_typesr r r �uaclient.versionr r r r r �endpoint�_docr r r r �<module> s4 �� � pro/version/__init__.py 0000644 00000000000 15030103444 0011122 0 ustar 00 pro/security/__pycache__/__init__.cpython-310.pyc 0000644 00000000243 15030103444 0015654 0 ustar 00 o �ϴf � @ s d S )N� r r r �F/usr/lib/python3/dist-packages/uaclient/api/u/pro/security/__init__.py�<module> s pro/security/fix/_common/__pycache__/__init__.cpython-310.pyc 0000644 00000051551 15030103444 0020101 0 ustar 00 o �P�f�h � @ sZ d dl Z d dlZd dlZd dlmZ d dlmZmZmZm Z m Z m Z d dl m Z mZmZmZmZmZ d dlmZ dZdZdZd Zd Zd Zd Zd Z e dde fde fde fg�Z e dde fde fg�Z G dd� dej �Z!G dd� dej"�Z#G dd� d�Z$G dd � d �Z%G d d � d �Z&d e%d ee ee e f f d!ee e$f fd"d#�Z'd!ee ee e f f fd$d%�Z(d&d'� Z)d(d)� Z*d*d+� Z+d,e&d ee ee e f f d!ee e$f fd-d.�Z,d/e$d0ee ee e f f d!e$fd1d2�Z-d3d4� Z.d5ee& d6ee e/f d!ee ee ee e f f f fd7d8�Z0d9e d!e e e! e e f fd:d;�Z1dCd<e e fd=d>�Z2d?e d@e d!e fdAdB�Z3dS )D� N)� defaultdict)�Any�Dict�List� NamedTuple�Optional�Tuple)�apt� exceptions� livepatch�messages�system�util)� serviceclientz=((CVE|cve)-\d{4}-\d{4,7}$|(USN|usn|LSN|lsn)-\d{1,5}-\d{1,2}$)z cves.jsonzcves/{cve}.jsonz notices.jsonznotices/{notice}.jsonzstandard-updates� esm-infra�esm-apps�BinaryPackageFix� source_pkg� binary_pkg� fixed_version�UnfixedPackage�pkg�unfixed_reasonc @ sZ e Zd ZdZG dd� d�Zedd�Zedd�Zedd�Zed d �Ze d d � �Z d d� Z dS )� FixStatuszD An enum to represent the system status after fix operation c @ s e Zd Zdedefdd�ZdS )zFixStatus._Value�value�msgc C s || _ || _d S �N�r r )�selfr r � r �R/usr/lib/python3/dist-packages/uaclient/api/u/pro/security/fix/_common/__init__.py�__init__/ � zFixStatus._Value.__init__N)�__name__� __module__� __qualname__�int�strr! r r r r �_Value. s r( r �fixed� not-affected� zstill-affected� zaffected-until-rebootc C s | j j S r )r �r r r r � exit_code8 s zFixStatus.exit_codec C s | j jS r r r- r r r �__str__< s zFixStatus.__str__N) r# r$ r% �__doc__r( �SYSTEM_NON_VULNERABLE�SYSTEM_NOT_AFFECTED�SYSTEM_STILL_VULNERABLE� SYSTEM_VULNERABLE_UNTIL_REBOOT�propertyr. r/ r r r r r ) s r c s0 e Zd ZdZdZdeeef deeef fdd�Ze j e j g d�d� d#� fd d � �Z d$d ee d ee dee dee dee dee dee deee ded fdd�Zdeddfdd�Z d%dee dee dee dee d ee ded f d d �Zd edd fd!d"�Z� ZS )&�UASecurityClient� � security_url� query_params�returnc C s. | j j �di ��di �}|r|�|� |S |S )zD Update query params with data from feature config. �features�extra_security_params)�cfg�get�update)r r9 r< r r r �_get_query_paramsE s � z"UASecurityClient._get_query_params)r+ � � )� retry_sleepsNc s" | � |�}t� j|||||dd�S )NF)�path�data�headers�methodr9 �log_response_body)r@ �super� request_url)r rD rE rF rG r9 �� __class__r r rJ U s �z UASecurityClient.request_url�query�priority�package�limit�offset� component�version�status�CVEc sV ||||||||d�} � j t| d�} | jdkr!tjt| j| jd��� fdd�| jD �S )znQuery to match multiple-CVEs. @return: List of CVE instances based on the the JSON response. )�qrN rO rP rQ rR rS rT �r9 �� ��url�code�bodyc s g | ]}t � |d ��qS )��client�response)rU )�.0�cve_mdr- r r � <listcomp>� s �z-UASecurityClient.get_cves.<locals>.<listcomp>)rJ � API_V1_CVESr[ r �SecurityAPIErrorr\ � json_list) r rM rN rO rP rQ rR rS rT r9 r_ r r- r �get_cvesc s" � � �zUASecurityClient.get_cves�cve_idc C �B t j|d�}| �|�}|jdkrtj||j|jd��t| |jd�S )zkQuery to match single-CVE. @return: CVE instance for JSON response from the Security API. )�cverX rY r] ) �API_V1_CVE_TMPL�formatrJ r[ r rd r\ rU � json_dict)r rg rZ r_ r r r �get_cve� � �zUASecurityClient.get_cve�cves�release�order�USNc sf � ||||d�}�j t|d�}|jdkr tjt|j|jd��t� �fdd�|j�dg �D �dd � d �S ) zuQuery to match multiple-USNs. @return: Sorted list of USN instances based on the the JSON response. )ro rp rP rQ rq rW rX rY c sB g | ] }� d u s� |� dg �v r|� dd��d�rt�|d��qS )N�cves_ids�id� �USN-r] )r> � startswithrr )r` �usn_md�ro r r r rb � s � �z0UASecurityClient.get_notices.<locals>.<listcomp>�noticesc S � | j S r �rt ��xr r r �<lambda>� � z.UASecurityClient.get_notices.<locals>.<lambda>��key) rJ �API_V1_NOTICESr[ r rd r\ �sortedrl r> )r ro rp rP rQ rq r9 r_ r ry r � get_notices� s" � � ��z UASecurityClient.get_notices� notice_idc C rh )zbQuery to match single-USN. @return: USN instance representing the JSON response. )�noticerX rY r] ) �API_V1_NOTICE_TMPLrk rJ r[ r rd r\ rr rl )r r� rZ r_ r r r � get_notice� rn zUASecurityClient.get_notice)NNNN)NNNNNNNN)NNNNN)r# r$ r% � url_timeout�cfg_url_base_attrr r' r r@ r �retry�socket�timeoutrJ r r& r rf rm r� r� � __classcell__r r rK r r6 @ st � ���������� � �"������ �#r6 c @ s� e Zd ZdZdeeef fdd�Zedd� �Z edd� �Z ed d � �Z ed d � �Z ed d� �Z edd� �Zedefdd��Zedd� �ZdS )�CVEPackageStatuszAClass representing specific CVE PackageStatus on an Ubuntu series� cve_responsec C s || _ d S r �r_ )r r� r r r r! � s zCVEPackageStatus.__init__c C � | j d S �N� descriptionr� r- r r r r� � � z CVEPackageStatus.descriptionc C r{ r )r� r- r r r r � s z CVEPackageStatus.fixed_versionc C r� )N�pocketr� r- r r r r� � r� zCVEPackageStatus.pocketc C r� )N�release_codenamer� r- r r r r� � r� z!CVEPackageStatus.release_codenamec C r� )NrT r� r- r r r rT � r� zCVEPackageStatus.statusc C s� | j dkrtjS | j dkrtjS | j dkrtjS | j dv r tjS | j dkr(tjS | j dkr0tjS | j dkr=tjj | j d�S tj j | j d �S � N�neededz needs-triage�pending)�ignored�deferred�DNEr* �released)� fix_stream)rT ) rT r �SECURITY_CVE_STATUS_NEEDED�SECURITY_CVE_STATUS_TRIAGE�SECURITY_CVE_STATUS_PENDING�SECURITY_CVE_STATUS_IGNORED�SECURITY_CVE_STATUS_DNE� SECURITY_CVE_STATUS_NOT_AFFECTED�SECURITY_FIX_RELEASE_STREAMrk � pocket_source�SECURITY_CVE_STATUS_UNKNOWNr- r r r �status_message� s" �z CVEPackageStatus.status_messager: c C s t | jtjk�S )z?Return True if the package requires an active Pro subscription.)�boolr� r �'SECURITY_UBUNTU_STANDARD_UPDATES_POCKETr- r r r � requires_ua� s ��z CVEPackageStatus.requires_uac C sZ | j dkr tj}|S | j dkrtj}|S | j dv r tj}|S d| jv r(tj}|S tj}|S )z>Human-readable string representing where the fix is published.r r )�updates�security�esm)r� r �SECURITY_UA_INFRA_POCKET�SECURITY_UA_APPS_POCKETr� r )r � fix_sourcer r r r� � s � � ��z CVEPackageStatus.pocket_sourceN)r# r$ r% r0 r r' r r! r5 r� r r� r� rT r� r� r� r� r r r r r� � s& r� c @ s� e Zd ZdZdedeeef fdd�Zde fdd�Z e d d � �Z e de e fd d ��Ze de d fdd��Ze dd� �Ze deeef fdd��ZdS )rU z7Class representing CVE response from the SecurityClientr^ r_ c C � || _ || _d S r �r_ r^ �r r^ r_ r r r r! r" z CVE.__init__r: c C � t |t�sdS | j|jkS �NF)� isinstancerU r_ �r �otherr r r �__eq__ � z CVE.__eq__c C � | j �dd��� S )Nrt �UNKNOWN_CVE_ID�r_ r> �upperr- r r r rt � zCVE.idc C � | j �dg �S )N� notices_ids�r_ r> r- r r r r� s zCVE.notices_idsrr c �< t � d�st� fdd�� j�dg �D �dd� dd�� _� jS ) z�Return a list of USN instances from API response 'notices'. Cache the value to avoid extra work on multiple calls. �_noticesc s. g | ]}|r|� d d��d�rt� j|��qS )rt ru rv )r> rw rr r^ )r` r� r- r r rb ( s �� �z CVE.notices.<locals>.<listcomp>rz c S r{ r r| ��nr r r r - r� z CVE.notices.<locals>.<lambda>T�r� �reverse)�hasattrr� r_ r> r� r- r r- r rz s �� z CVE.noticesc C � | j �d�S r� r� r- r r r r� 2 � zCVE.descriptionc C sb t | d�r| jS i | _t�� j}| jd D ]}|d D ]}|d |kr,t|�| j|d < qq| jS )z�Dict of package status dicts for the current Ubuntu series. Top-level keys are source packages names and each value is a CVEPackageStatus object �_packages_status�packages�statusesr� �name)r� r� r �get_release_info�seriesr_ r� )r r� rO � pkg_statusr r r �packages_status6 s ���zCVE.packages_statusN)r# r$ r% r0 r6 r r' r r! r� r� r5 rt r r� rz r� r� r� r r r r rU s rU c @ s� e Zd ZdZdedeeef fdd�Zde fdd�Z e defd d ��Z e de e fd d ��Ze de e fd d��Ze dd� �Ze dd� �Ze deeeeeeef f f fdd��ZdS )rr z7Class representing USN response from the SecurityClientr^ r_ c C r� r r� r� r r r r! M r" z USN.__init__r: c C r� r� )r� rr r_ r� r r r r� Q r� z USN.__eq__c C r� )Nrt �UNKNOWN_USN_IDr� r- r r r rt V r� zUSN.idc C r� )z$List of CVE IDs related to this USN.rs r� r- r r r rs Z s z USN.cves_idsc r� ) z�List of CVE instances based on API response 'cves' key. Cache the values to avoid extra work for multiple call-sites. �_cvesc s g | ]}t � j|��qS r )rU r^ )r` ri r- r r rb g s ��z USN.cves.<locals>.<listcomp>ro c S r{ r r| r� r r r r k r� zUSN.cves.<locals>.<lambda>Tr� )r� r� r_ r> r� r- r r- r ro _ s ��zUSN.cvesc C r� )N�titler� r- r r r r� p r� z USN.titlec C r� )N� referencesr� r- r r r r� t r� zUSN.referencesc C sN t | d�r| jS t�� j}i | _| j�di ��|g �D ]�}|�d�rW|d | jv rMd| j|d v rCtjdj | j |d d�| j dd ��|| j|d d< qd|i| j|d < q|�d �smtjd j | j |d d �| j dd ��d |d vr�tjdj | j |d |d d�| j dd ��|d � d �d }|| jvr�i | j|< || j| |d < q| jS )aW Binary package information available for this release. Reformat the USN.release_packages response to key it based on source package name and related binary package names. :return: Dict keyed by source package name. The second-level key will be binary package names generated from that source package and the values will be the dict response from USN.release_packages for that binary package. The binary metadata contains the following keys: name, version. Optional additional keys: pocket and component. �_release_packages�release_packages� is_sourcer� �sourcez6{usn} metadata defines duplicate source packages {pkg})�usnr ru �� error_msg�issue� extra_info� source_linkzL{issue} metadata does not define release_packages source_link for {bin_pkg}.)r� �bin_pkg�/zX{issue} metadata has unexpected release_packages source_link value for {bin_pkg}: {link})r� r� �link���) r� r� r r� r� r_ r> r �SecurityAPIMetadataErrorrk rt �split)r r� r �source_pkg_namer r r r� x sR �� �� �� zUSN.release_packagesN)r# r$ r% r0 r6 r r' r r! r� r� r5 rt r rs rU ro r� r� r� r r r r rr J s ,rr ri �installed_packagesr: c C s8 i }| j �� D ]\}}|jdkrq||v r|||< q|S )z�Get a dict of any CVEPackageStatuses affecting this Ubuntu release. :return: Dict of active CVEPackageStatus keyed by source package names. r* )r� �itemsrT )ri r� �affected_pkg_versionsr �package_statusr r r �'get_cve_affected_source_packages_status� s �r� c C s| d} t �dd| d dg�\}}i }|�� D ]%}|�d�\}}}}|s%|}d|vr*q||v r5||| |< q||i||< q|S )z�Return a dict of all source packages installed on the system. The dict keys will be source package name: "krb5". The value will be a dict with keys binary_pkg and version. z${db:Status-Status}z dpkg-queryz#-f=${Package},${Source},${Version},� z-W�,� installed)r �subp� splitlinesr� ) � status_field�out�_errr� �pkg_line�pkg_namer� � pkg_versionrT r r r �#query_installed_source_pkg_versions� s$ �� r� c C sn | j sg S i }| j D ] }|jD ]}|�d�sq|| jkr q||vr)|j|d�||< qq tt|�� dd� d��S )z�For a give usn, get the related USNs for it. For each CVE associated with the given USN, we capture other USNs that are related to the CVE. We consider those USNs related to the original USN. rv )r� c S r{ r r| r} r r r r r� z"get_related_usns.<locals>.<lambda>r� )ro r� rw rt r� �listr� �values)r� r^ � related_usnsri �related_usn_idr r r �get_related_usns� s ��� r c C s` i }| D ])}t ||��� D ] \}}||vr|||< q || j}t�||j�dkr,|||< q q|S )Nr )r� r� r r �version_compare)ro r� � affected_pkgsri r� r� � current_verr r r � get_affected_packages_from_cves s" � � ��� r c C s� i }| j �� D ]6\}}||vrqtt�}d|d< dd� |�� D �}|s0tjd�| j�| jdd��|�� |d< t |d �||< q|S ) Nr� rT c S s" h | ] \}}|� d �r|d �qS )r� �r> )r` �_� pkg_bin_infor r r � <setcomp>' s ��z1get_affected_packages_from_usn.<locals>.<setcomp>zC{} metadata defines no pocket information for any release packages.ru r� r� )r� ) r� r� r r' r r� rk rt �popr� )r� r� r r� �pkg_infor� � all_pocketsr r r � get_affected_packages_from_usn s& �� r r� c C s | j r t| j |�S t| |�S )z�Walk CVEs related to a USN and return a dict of all affected packages. :return: Dict keyed on source package name, with active CVEPackageStatus for the current Ubuntu release. )ro r r )r� r� r r r � get_usn_affected_packages_status< s r r� �usn_src_released_pkgsc C sh t �| �}|r2|�d�r2d|jd< |d d |jd< |�� D ]\}}|�d�}|r1||jd< |S q |S )a� Parse release status based on both pkg_status and USN.release_packages. Since some source packages in universe are not represented in CVEPackageStatus, rely on presence of such source packages in usn_src_released_pkgs to represent package as a "released" status. :param pkg_status: the CVEPackageStatus for this source package. :param usn_src_released_pkgs: The USN.release_packages representing only this source package. Normally, release_packages would have data on multiple source packages. :return: Tuple of: human-readable status message, boolean whether released, boolean whether the fix requires access to UA r� r� rT rS r� r� )�copy�deepcopyr> r_ r� )r� r �usn_pkg_statusr� �usn_released_pkgr� r r r �#override_usn_release_package_statusJ s � � �r c C sd i }t | �� �D ]'\}}|�|i �}t||�}|j�dd�}||vr&g ||< || �||f� q|S )Nr� r� )r� r� r> r rT �replace�append)�affected_pkg_status�usn_released_pkgs� status_groups�src_pkgr� �usn_released_srcr � status_groupr r r �group_by_usn_package_statusm s �r �usns� beta_pocketsc s� i }| D ]R}|j �� D ]J\}}� fdd�|�� D �}||vr%|r%|||< q ||v rU|| }|�� D ]#\}} ||vr>| ||< q1|| d } | d } t�| | �dkrT| ||< q1q q|S )a Walk related USNs, merging the released binary package versions. For each USN, iterate over release_packages to collect released binary package names and required fix version. If multiple related USNs require different version fixes to the same binary package, track the maximum version required across all USNs. :param usns: List of USN response instances from which to calculate merge. :param beta_pockets: Dict keyed on service name: esm-infra, esm-apps the values of which will be true of USN response instances from which to calculate merge. :return: Dict keyed by source package name. Under each source package will be a dict with binary package name as keys and binary package metadata as the value. c s. i | ]\}}d � � |� dd�d �u r||�qS )Fr� �Noner )r` � bin_pkg_name� bin_pkg_md�r r r � <dictcomp>� s ��z>merge_usn_released_binary_package_versions.<locals>.<dictcomp>rS r )r� r� r r ) r r �usn_pkg_versionsr� r �binary_pkg_versions�public_bin_pkg_versions� usn_src_pkgr� � binary_pkg_md� prev_version�current_versionr r# r �*merge_usn_released_binary_package_versions{ s, � ���r, �issue_idc C sf t �� }|d ur1|j d ur1|j jd ur1|j jD ]}|j| �� kr0|jr0|j jp(d}tj|f S qdS )NzN/A)NN) r rT �fixesr� �lower�patchedrS r r1 )r- � lp_status�fixrS r r r � _check_cve_fixed_by_livepatch� s �r3 r� c C s| | dkrt jS | dkrt jS | dkrt jS | dv r t jS | dkr#t jS | dkr*t jS | dkr7|r7t jj|d�S t j j| d �S r� ) r r� r� r� r� r� r� r� rk r� )rT r� r r r r� � s" �r� �current_fix_status� fix_statusc C sB | s|S |t jjjt jjjfv r | t jjjkr | |kr |S | S |S r )r r1 r r r2 )r4 r5 r r r �get_expected_overall_status� s �r6 r )4r �enumr� � collectionsr �typingr r r r r r �uaclientr r r r r r � uaclient.httpr �CVE_OR_USN_REGEXrc rj r� r� �STANDARD_UPDATES_POCKET�ESM_INFRA_POCKET�ESM_APPS_POCKETr' r r �Enumr �UAServiceClientr6 r� rU rr r� r� r r r r r r r� r, r3 r� r6 r r r r �<module> s� ��� �� H>t�� � �� ��� �#� � �2� ���� pro/security/fix/_common/plan/v1.py 0000644 00000110146 15030103444 0013257 0 ustar 00 import enum import re from collections import defaultdict from datetime import datetime, timezone from typing import Any, Dict, List, NamedTuple, Optional, Tuple from uaclient import apt, exceptions, messages from uaclient.api.u.pro.security.fix._common import ( CVE, CVE_OR_USN_REGEX, USN, BinaryPackageFix, CVEPackageStatus, FixStatus, UASecurityClient, _check_cve_fixed_by_livepatch, get_affected_packages_from_usn, get_cve_affected_source_packages_status, get_related_usns, group_by_usn_package_status, merge_usn_released_binary_package_versions, query_installed_source_pkg_versions, ) from uaclient.api.u.pro.status.enabled_services.v1 import _enabled_services from uaclient.api.u.pro.status.is_attached.v1 import ( ContractExpiryStatus, _is_attached, ) from uaclient.config import UAConfig from uaclient.data_types import ( DataObject, Field, IntDataValue, StringDataValue, data_list, ) STANDARD_UPDATES_POCKET = "standard-updates" ESM_INFRA_POCKET = "esm-infra" ESM_APPS_POCKET = "esm-apps" UnfixedPackage = NamedTuple( "UnfixedPackage", [ ("source_package", str), ("binary_package", str), ("version", Optional[str]), ], ) @enum.unique class FixStepType(enum.Enum): ATTACH = "attach" ENABLE = "enable" NOOP = "no-op" APT_UPGRADE = "apt-upgrade" @enum.unique class FixPlanNoOpStatus(enum.Enum): ALREADY_FIXED = "cve-already-fixed" NOT_AFFECTED = "system-not-affected" FIXED_BY_LIVEPATCH = "cve-fixed-by-livepatch" @enum.unique class FixPlanAttachReason(enum.Enum): EXPIRED_CONTRACT = "expired-contract-token" REQUIRED_PRO_SERVICE = "required-pro-service" @enum.unique class FixWarningType(enum.Enum): PACKAGE_CANNOT_BE_INSTALLED = "package-cannot-be-installed" SECURITY_ISSUE_NOT_FIXED = "security-issue-not-fixed" FAIL_UPDATING_ESM_CACHE = "fail-updating-esm-cache" class FixPlanStep(DataObject): fields = [ Field( "operation", StringDataValue, doc=( "The operation that would be performed to fix the issue. This" " can be either an attach, enable, apt-upgrade or a no-op type" ), ), Field( "order", IntDataValue, doc="The execution order of the operation" ), Field( "data", DataObject, doc=( "A data object that can be either an ``AptUpgradeData``," " ``AttachData``, ``EnableData``, ``NoOpData``" ), ), ] def __init__(self, *, operation: str, order: int): self.operation = operation self.order = order class AptUpgradeData(DataObject): fields = [ Field( "binary_packages", data_list(StringDataValue), doc="A list of binary packages that need to be upgraded", ), Field( "source_packages", data_list(StringDataValue), doc="A list of source packages that need to be upgraded", ), Field( "pocket", StringDataValue, doc="The pocket where the packages will be installed from", ), ] def __init__( self, *, binary_packages: List[str], source_packages: List[str], pocket: str ): self.binary_packages = binary_packages self.source_packages = source_packages self.pocket = pocket class FixPlanAptUpgradeStep(FixPlanStep): fields = [ Field("operation", StringDataValue), Field("data", AptUpgradeData), Field("order", IntDataValue), ] def __init__(self, *, data: AptUpgradeData, order: int): super().__init__(operation=FixStepType.APT_UPGRADE.value, order=order) self.data = data class AttachData(DataObject): fields = [ Field( "reason", StringDataValue, doc="The reason why an attach operation is needed", ), Field( "required_service", StringDataValue, doc="The required service that requires the attach operation", ), Field( "source_packages", data_list(StringDataValue), doc="The source packages that require the attach operation", ), ] def __init__( self, *, reason: str, source_packages: List[str], required_service: str ): self.reason = reason self.source_packages = source_packages self.required_service = required_service class FixPlanAttachStep(FixPlanStep): fields = [ Field("operation", StringDataValue), Field("data", AttachData), Field("order", IntDataValue), ] def __init__(self, *, data: AttachData, order: int): super().__init__(operation=FixStepType.ATTACH.value, order=order) self.data = data class EnableData(DataObject): fields = [ Field( "service", StringDataValue, doc="The service that needs to be enabled", ), Field( "source_packages", data_list(StringDataValue), doc="The source packages that require the service to be enabled", ), ] def __init__(self, *, service: str, source_packages: List[str]): self.service = service self.source_packages = source_packages class FixPlanEnableStep(FixPlanStep): fields = [ Field("operation", StringDataValue), Field("data", EnableData), Field("order", IntDataValue), ] def __init__(self, *, data: EnableData, order: int): super().__init__(operation=FixStepType.ENABLE.value, order=order) self.data = data class NoOpData(DataObject): fields = [ Field( "status", StringDataValue, doc="The status of the issue when no operation can be performed", ), ] def __init__(self, *, status: str): self.status = status class FixPlanNoOpStep(FixPlanStep): fields = [ Field("operation", StringDataValue), Field("data", NoOpData), Field("order", IntDataValue), ] def __init__(self, *, data: NoOpData, order: int): super().__init__(operation=FixStepType.NOOP.value, order=order) self.data = data class NoOpLivepatchFixData(NoOpData): fields = [ Field( "status", StringDataValue, doc="The status of the CVE when no operation can be performed", ), Field( "patch_version", StringDataValue, doc="Version of the patch from Livepatch that fixed the CVE", ), ] def __init__(self, *, status: str, patch_version: str): super().__init__(status=status) self.patch_version = patch_version class FixPlanNoOpLivepatchFixStep(FixPlanNoOpStep): fields = [ Field("operation", StringDataValue), Field("data", NoOpLivepatchFixData), Field("order", IntDataValue), ] def __init__(self, *, data: NoOpLivepatchFixData, order: int): super().__init__(data=data, order=order) class NoOpAlreadyFixedData(NoOpData): fields = [ Field( "status", StringDataValue, doc="The status of the issue when no operation can be performed", ), Field( "source_packages", data_list(StringDataValue), doc="The source packages that are already fixed", ), Field( "pocket", StringDataValue, doc="The pocket where the packages would have been installed from", ), ] def __init__( self, *, status: str, source_packages: List[str], pocket: str ): super().__init__(status=status) self.source_packages = source_packages self.pocket = pocket class FixPlanNoOpAlreadyFixedStep(FixPlanNoOpStep): fields = [ Field("operation", StringDataValue), Field("data", NoOpLivepatchFixData), Field("order", IntDataValue), ] def __init__(self, *, data: NoOpAlreadyFixedData, order: int): super().__init__(data=data, order=order) class FixPlanWarning(DataObject): fields = [ Field("warning_type", StringDataValue, doc="The type of warning"), Field( "order", IntDataValue, doc="The execution order of the operation" ), Field( "data", DataObject, doc="A data object that represents either a" " ``PackageCannotBeInstalledData`` or a" " ``SecurityIssueNotFixedData``", ), ] def __init__(self, *, warning_type: str, order: int): self.warning_type = warning_type self.order = order class SecurityIssueNotFixedData(DataObject): fields = [ Field( "source_packages", data_list(StringDataValue), doc="A list of source packages that cannot be fixed at the moment", ), Field( "status", StringDataValue, doc="The status of the CVE regarding those packages", ), ] def __init__(self, *, source_packages: List[str], status: str): self.source_packages = source_packages self.status = status class FixPlanWarningSecurityIssueNotFixed(FixPlanWarning): fields = [ Field("warning_type", StringDataValue), Field("order", IntDataValue), Field("data", SecurityIssueNotFixedData), ] def __init__(self, *, order: int, data: SecurityIssueNotFixedData): super().__init__( warning_type=FixWarningType.SECURITY_ISSUE_NOT_FIXED.value, order=order, ) self.data = data class PackageCannotBeInstalledData(DataObject): fields = [ Field( "binary_package", StringDataValue, doc="The binary package that cannot be installed", ), Field( "binary_package_version", StringDataValue, doc="The version of the binary package that cannot be installed", ), Field( "source_package", StringDataValue, doc="The source package associated with the binary package", ), Field( "related_source_packages", data_list(StringDataValue), doc=( "A list of source packages that come from the same pocket as" " the affected package" ), ), Field( "pocket", StringDataValue, doc=( "The pocket where the affected package should be installed" " from" ), ), ] def __init__( self, *, binary_package: str, binary_package_version: str, source_package: str, pocket: str, related_source_packages: List[str] ): self.source_package = source_package self.binary_package = binary_package self.binary_package_version = binary_package_version self.pocket = pocket self.related_source_packages = related_source_packages class FixPlanWarningPackageCannotBeInstalled(FixPlanWarning): fields = [ Field("warning_type", StringDataValue), Field("order", IntDataValue), Field("data", SecurityIssueNotFixedData), ] def __init__(self, *, order: int, data: PackageCannotBeInstalledData): super().__init__( warning_type=FixWarningType.PACKAGE_CANNOT_BE_INSTALLED.value, order=order, ) self.data = data class FailUpdatingESMCacheData(DataObject): fields = [ Field("title", StringDataValue), Field("code", StringDataValue), ] def __init__(self, *, title: str, code: str): self.title = title self.code = code class FixPlanWarningFailUpdatingESMCache(FixPlanWarning): fields = [ Field("warning_type", StringDataValue), Field("order", IntDataValue), Field("data", FailUpdatingESMCacheData), ] def __init__(self, *, order: int, data: FailUpdatingESMCacheData): super().__init__( warning_type=FixWarningType.FAIL_UPDATING_ESM_CACHE.value, order=order, ) self.data = data class FixPlanError(DataObject): fields = [ Field("msg", StringDataValue, doc="The error message"), Field("code", StringDataValue, required=False, doc="The message code"), ] def __init__(self, *, msg: str, code: Optional[str]): self.msg = msg self.code = code class AdditionalData(DataObject): pass class USNAdditionalData(AdditionalData): fields = [ Field( "associated_cves", data_list(StringDataValue), doc="The associated CVEs for the USN", ), Field( "associated_launchpad_bugs", data_list(StringDataValue), doc="The associated Launchpad bugs for the USN", ), ] def __init__( self, *, associated_cves: List[str], associated_launchpad_bugs: List[str] ): self.associated_cves = associated_cves self.associated_launchpad_bugs = associated_launchpad_bugs class FixPlanResult(DataObject): fields = [ Field("title", StringDataValue, doc="The title of the issue"), Field( "description", StringDataValue, required=False, doc="The description of the issue", ), Field( "current_status", StringDataValue, required=False, doc="The current status of the issue on the system", ), Field( "expected_status", StringDataValue, doc="The expected status of fixing the issue", ), Field( "affected_packages", data_list(StringDataValue), required=False, doc="A list of package names affected by the issue", ), Field( "plan", data_list(FixPlanStep), doc="A list of ``FixPlanStep`` objects", ), Field( "warnings", data_list(FixPlanWarning), required=False, doc="A list of ``FixPlanWarning`` objects", ), Field( "error", FixPlanError, required=False, doc="A ``FixPlanError`` object, if an error occurred.", ), Field( "additional_data", AdditionalData, required=False, doc="Additional data for the issue", ), ] def __init__( self, *, title: str, expected_status: str, plan: List[FixPlanStep], warnings: List[FixPlanWarning], error: Optional[FixPlanError], additional_data: AdditionalData, description: Optional[str] = None, affected_packages: Optional[List[str]] = None, current_status: Optional[str] = None ): self.title = title self.description = description self.current_status = current_status self.expected_status = expected_status self.affected_packages = affected_packages self.plan = plan self.warnings = warnings self.error = error self.additional_data = additional_data class FixPlanUSNResult(DataObject): fields = [ Field( "target_usn_plan", FixPlanResult, doc="A ``FixPlanResult`` object for the target USN", ), Field( "related_usns_plan", data_list(FixPlanResult), required=False, doc="A list of ``FixPlanResult`` objects for the related USNs", ), ] def __init__( self, *, target_usn_plan: FixPlanResult, related_usns_plan: List[FixPlanResult] ): self.target_usn_plan = target_usn_plan self.related_usns_plan = related_usns_plan class FixPlan: def __init__( self, title: str, description: Optional[str], affected_packages: Optional[List[str]] = None, current_status: Optional[str] = None, ): self.order = 1 self.title = title self.description = description self.affected_packages = affected_packages self.current_status = current_status self.fix_steps = [] # type: List[FixPlanStep] self.fix_warnings = [] # type: List[FixPlanWarning] self.error = None # type: Optional[FixPlanError] self.additional_data = AdditionalData() def register_step( self, operation: FixStepType, data: Dict[str, Any], ): # just to make mypy happy fix_step = None # type: Optional[FixPlanStep] if operation == FixStepType.ATTACH: fix_step = FixPlanAttachStep( order=self.order, data=AttachData.from_dict(data) ) elif operation == FixStepType.ENABLE: fix_step = FixPlanEnableStep( order=self.order, data=EnableData.from_dict(data) ) elif operation == FixStepType.NOOP: if "patch_version" in data: fix_step = FixPlanNoOpLivepatchFixStep( order=self.order, data=NoOpLivepatchFixData.from_dict(data) ) elif "source_packages" in data: fix_step = FixPlanNoOpAlreadyFixedStep( order=self.order, data=NoOpAlreadyFixedData.from_dict(data) ) else: fix_step = FixPlanNoOpStep( order=self.order, data=NoOpData.from_dict(data) ) else: fix_step = FixPlanAptUpgradeStep( order=self.order, data=AptUpgradeData.from_dict(data) ) self.fix_steps.append(fix_step) self.order += 1 def register_warning( self, warning_type: FixWarningType, data: Dict[str, Any] ): fix_warning = None # type: Optional[FixPlanWarning] if warning_type == FixWarningType.SECURITY_ISSUE_NOT_FIXED: fix_warning = FixPlanWarningSecurityIssueNotFixed( order=self.order, data=SecurityIssueNotFixedData.from_dict(data), ) elif warning_type == FixWarningType.PACKAGE_CANNOT_BE_INSTALLED: fix_warning = FixPlanWarningPackageCannotBeInstalled( order=self.order, data=PackageCannotBeInstalledData.from_dict(data), ) else: fix_warning = FixPlanWarningFailUpdatingESMCache( order=self.order, data=FailUpdatingESMCacheData.from_dict(data), ) self.fix_warnings.append(fix_warning) self.order += 1 def register_error(self, error_msg: str, error_code: Optional[str]): self.error = FixPlanError(msg=error_msg, code=error_code) def register_additional_data(self, additional_data: Dict[str, Any]): self.additional_data = AdditionalData(**additional_data) def _get_expected_status(self) -> str: if self.error: return "error" if ( len(self.fix_steps) == 1 and isinstance(self.fix_steps[0], FixPlanNoOpStep) and self.fix_steps[0].data.status == "system-not-affected" ): return FixStatus.SYSTEM_NOT_AFFECTED.value.msg elif self.fix_warnings: return FixStatus.SYSTEM_STILL_VULNERABLE.value.msg else: return FixStatus.SYSTEM_NON_VULNERABLE.value.msg @property def fix_plan(self): return FixPlanResult( title=self.title, description=self.description, expected_status=self._get_expected_status(), current_status=self.current_status, affected_packages=self.affected_packages, plan=self.fix_steps, warnings=self.fix_warnings, error=self.error, additional_data=self.additional_data, ) class USNFixPlan(FixPlan): def register_additional_data(self, additional_data: Dict[str, Any]): self.additional_data = USNAdditionalData(**additional_data) def get_fix_plan( title: str, description: Optional[str] = None, affected_packages: Optional[List[str]] = None, ): if not title or "cve" in title.lower(): return FixPlan( title=title, description=description, affected_packages=affected_packages, ) return USNFixPlan( title=title, description=description, affected_packages=affected_packages, ) def _get_cve_data( issue_id: str, client: UASecurityClient, ) -> Tuple[CVE, List[USN]]: try: cve = client.get_cve(cve_id=issue_id) usns = client.get_notices(cves=issue_id) except exceptions.SecurityAPIError as e: if e.code == 404: raise exceptions.SecurityIssueNotFound(issue_id=issue_id) raise e return cve, usns def _get_usn_data( issue_id: str, client: UASecurityClient ) -> Tuple[USN, List[USN]]: try: usn = client.get_notice(notice_id=issue_id) usns = get_related_usns(usn, client) except exceptions.SecurityAPIError as e: if e.code == 404: raise exceptions.SecurityIssueNotFound(issue_id=issue_id) raise e if not usn.response["release_packages"]: # Since usn.release_packages filters to our current release only # check overall metadata and error if empty. raise exceptions.SecurityAPIMetadataError( error_msg="metadata defines no fixed package versions.", issue=issue_id, extra_info="", ) return usn, usns def _get_upgradable_pkgs( binary_pkgs: List[BinaryPackageFix], check_esm_cache: bool, ) -> Tuple[List[str], List[UnfixedPackage]]: upgrade_pkgs = [] unfixed_pkgs = [] for binary_pkg in sorted(binary_pkgs): candidate_version = apt.get_pkg_candidate_version( binary_pkg.binary_pkg, check_esm_cache=check_esm_cache ) if ( candidate_version and apt.version_compare( binary_pkg.fixed_version, candidate_version ) <= 0 ): upgrade_pkgs.append(binary_pkg.binary_pkg) else: unfixed_pkgs.append( UnfixedPackage( source_package=binary_pkg.source_pkg, binary_package=binary_pkg.binary_pkg, version=binary_pkg.fixed_version, ) ) return upgrade_pkgs, unfixed_pkgs def _get_upgradable_package_candidates_by_pocket( pkg_status_group: List[Tuple[str, CVEPackageStatus]], usn_released_pkgs: Dict[str, Dict[str, Dict[str, str]]], installed_pkgs: Dict[str, Dict[str, str]], ): binary_pocket_pkgs = defaultdict(list) src_pocket_pkgs = defaultdict(list) for src_pkg, pkg_status in pkg_status_group: src_pocket_pkgs[pkg_status.pocket_source].append((src_pkg, pkg_status)) for binary_pkg, version in installed_pkgs[src_pkg].items(): usn_released_src = usn_released_pkgs.get(src_pkg, {}) if binary_pkg not in usn_released_src: continue fixed_version = usn_released_src.get(binary_pkg, {}).get( "version", "" ) if apt.version_compare(fixed_version, version) > 0: binary_pocket_pkgs[pkg_status.pocket_source].append( BinaryPackageFix( source_pkg=src_pkg, binary_pkg=binary_pkg, fixed_version=fixed_version, ) ) return src_pocket_pkgs, binary_pocket_pkgs def _get_cve_description( cve: CVE, installed_pkgs: Dict[str, Dict[str, str]], ): if not cve.notices: return cve.description for notice in cve.notices: usn_pkgs = notice.release_packages.keys() for pkg in usn_pkgs: if pkg in installed_pkgs: return notice.title return cve.notices[0].title def _fix_plan_cve(issue_id: str, cfg: UAConfig) -> FixPlanResult: livepatch_cve_status, patch_version = _check_cve_fixed_by_livepatch( issue_id ) if livepatch_cve_status: fix_plan = get_fix_plan(title=issue_id) fix_plan.current_status = FixStatus.SYSTEM_NON_VULNERABLE.value.msg fix_plan.register_step( operation=FixStepType.NOOP, data={ "status": FixPlanNoOpStatus.FIXED_BY_LIVEPATCH.value, "patch_version": patch_version, }, ) return fix_plan.fix_plan client = UASecurityClient(cfg=cfg) installed_pkgs = query_installed_source_pkg_versions() try: cve, usns = _get_cve_data(issue_id=issue_id, client=client) except ( exceptions.SecurityIssueNotFound, exceptions.SecurityAPIError, ) as e: fix_plan = get_fix_plan(title=issue_id) fix_plan.register_error(error_msg=e.msg, error_code=e.msg_code) return fix_plan.fix_plan affected_pkg_status = get_cve_affected_source_packages_status( cve=cve, installed_packages=installed_pkgs ) usn_released_pkgs = merge_usn_released_binary_package_versions( usns, beta_pockets={} ) cve_description = _get_cve_description(cve, installed_pkgs) return _generate_fix_plan( issue_id=issue_id, issue_description=cve_description, affected_pkg_status=affected_pkg_status, usn_released_pkgs=usn_released_pkgs, installed_pkgs=installed_pkgs, cfg=cfg, ) def _fix_plan_usn(issue_id: str, cfg: UAConfig) -> FixPlanUSNResult: client = UASecurityClient(cfg=cfg) installed_pkgs = query_installed_source_pkg_versions() try: usn, related_usns = _get_usn_data(issue_id=issue_id, client=client) except ( exceptions.SecurityIssueNotFound, exceptions.SecurityAPIError, ) as e: fix_plan = get_fix_plan(title=issue_id) fix_plan.register_error(error_msg=e.msg, error_code=e.msg_code) return FixPlanUSNResult( target_usn_plan=fix_plan.fix_plan, related_usns_plan=[], ) affected_pkg_status = get_affected_packages_from_usn( usn=usn, installed_packages=installed_pkgs ) usn_released_pkgs = merge_usn_released_binary_package_versions( [usn], beta_pockets={} ) additional_data = { "associated_cves": [] if not usn.cves_ids else usn.cves_ids, "associated_launchpad_bugs": ( [] if not usn.references else usn.references ), } target_usn_plan = _generate_fix_plan( issue_id=issue_id, issue_description=usn.title, affected_pkg_status=affected_pkg_status, usn_released_pkgs=usn_released_pkgs, installed_pkgs=installed_pkgs, cfg=cfg, additional_data=additional_data, ) related_usns_plan = [] # type: List[FixPlanResult] for usn in related_usns: affected_pkg_status = get_affected_packages_from_usn( usn=usn, installed_packages=installed_pkgs ) usn_released_pkgs = merge_usn_released_binary_package_versions( [usn], beta_pockets={} ) additional_data = { "associated_cves": [] if not usn.cves_ids else usn.cves_ids, "associated_launchpad_bugs": ( [] if not usn.references else usn.references ), } related_usns_plan.append( _generate_fix_plan( issue_id=usn.id, issue_description=usn.title, affected_pkg_status=affected_pkg_status, usn_released_pkgs=usn_released_pkgs, installed_pkgs=installed_pkgs, cfg=cfg, additional_data=additional_data, ) ) return FixPlanUSNResult( target_usn_plan=target_usn_plan, related_usns_plan=related_usns_plan, ) def fix_plan_cve(issue_id: str, cfg: UAConfig) -> FixPlanResult: if not issue_id or not re.match(CVE_OR_USN_REGEX, issue_id): fix_plan = get_fix_plan(title=issue_id) msg = messages.INVALID_SECURITY_ISSUE.format(issue_id=issue_id) fix_plan.register_error(error_msg=msg.msg, error_code=msg.name) return fix_plan.fix_plan issue_id = issue_id.upper() return _fix_plan_cve(issue_id, cfg) def fix_plan_usn(issue_id: str, cfg: UAConfig) -> FixPlanUSNResult: if not issue_id or not re.match(CVE_OR_USN_REGEX, issue_id): fix_plan = get_fix_plan(title=issue_id) msg = messages.INVALID_SECURITY_ISSUE.format(issue_id=issue_id) fix_plan.register_error(error_msg=msg.msg, error_code=msg.name) return FixPlanUSNResult( target_usn_plan=fix_plan.fix_plan, related_usns_plan=[], ) issue_id = issue_id.upper() return _fix_plan_usn(issue_id, cfg) def get_pocket_short_name(pocket: str): if pocket == messages.SECURITY_UBUNTU_STANDARD_UPDATES_POCKET: return STANDARD_UPDATES_POCKET elif pocket == messages.SECURITY_UA_INFRA_POCKET: return ESM_INFRA_POCKET elif pocket == messages.SECURITY_UA_APPS_POCKET: return ESM_APPS_POCKET else: return pocket def _should_update_esm_cache( check_esm_cache: bool, esm_cache_updated: bool, cfg: UAConfig, ) -> bool: if ( check_esm_cache and not esm_cache_updated and not _is_attached(cfg).is_attached ): last_apt_update = apt.get_apt_cache_datetime() if last_apt_update is None: return True now = datetime.now(timezone.utc) time_since_update = now - last_apt_update if time_since_update.days > 2: return True return False def _generate_fix_plan( *, issue_id: str, issue_description: str, affected_pkg_status: Dict[str, CVEPackageStatus], usn_released_pkgs: Dict[str, Dict[str, Dict[str, str]]], installed_pkgs: Dict[str, Dict[str, str]], cfg: UAConfig, additional_data=None ) -> FixPlanResult: count = len(affected_pkg_status) src_pocket_pkgs = defaultdict(list) esm_cache_updated = False fix_plan = get_fix_plan( title=issue_id, description=issue_description, affected_packages=sorted(list(affected_pkg_status.keys())), ) if additional_data: fix_plan.register_additional_data(additional_data) if count == 0: fix_plan.current_status = FixStatus.SYSTEM_NOT_AFFECTED.value.msg fix_plan.register_step( operation=FixStepType.NOOP, data={"status": FixPlanNoOpStatus.NOT_AFFECTED.value}, ) return fix_plan.fix_plan else: fix_plan.current_status = FixStatus.SYSTEM_STILL_VULNERABLE.value.msg pkg_status_groups = group_by_usn_package_status( affected_pkg_status, usn_released_pkgs ) for status_value, pkg_status_group in sorted(pkg_status_groups.items()): if status_value != "released": fix_plan.register_warning( warning_type=FixWarningType.SECURITY_ISSUE_NOT_FIXED, data={ "source_packages": [ src_pkg for src_pkg, _ in pkg_status_group ], "status": status_value, }, ) fix_plan.current_status = ( FixStatus.SYSTEM_STILL_VULNERABLE.value.msg ) else: ( src_pocket_pkgs, binary_pocket_pkgs, ) = _get_upgradable_package_candidates_by_pocket( pkg_status_group, usn_released_pkgs, installed_pkgs, ) if not src_pocket_pkgs: return fix_plan.fix_plan for pocket in [ messages.SECURITY_UBUNTU_STANDARD_UPDATES_POCKET, messages.SECURITY_UA_INFRA_POCKET, messages.SECURITY_UA_APPS_POCKET, ]: pkg_src_group = src_pocket_pkgs[pocket] binary_pkgs = binary_pocket_pkgs[pocket] source_pkgs = [src_pkg for src_pkg, _ in pkg_src_group] pocket_name = get_pocket_short_name(pocket) if not binary_pkgs: if source_pkgs: fix_plan.current_status = ( FixStatus.SYSTEM_NON_VULNERABLE.value.msg ) fix_plan.register_step( operation=FixStepType.NOOP, data={ "status": FixPlanNoOpStatus.ALREADY_FIXED.value, "source_packages": source_pkgs, "pocket": pocket_name, }, ) continue check_esm_cache = ( pocket != messages.SECURITY_UBUNTU_STANDARD_UPDATES_POCKET ) if _should_update_esm_cache(check_esm_cache, esm_cache_updated, cfg): try: apt.update_esm_caches(cfg) esm_cache_updated = True except Exception as e: error_msg = messages.E_UPDATING_ESM_CACHE.format( error=getattr(e, "msg", str(e)) ) fix_plan.register_warning( warning_type=FixWarningType.FAIL_UPDATING_ESM_CACHE, data={ "title": error_msg.msg, "code": error_msg.name, }, ) upgrade_pkgs, unfixed_pkgs = _get_upgradable_pkgs( binary_pkgs, check_esm_cache ) if unfixed_pkgs: fix_plan.current_status = ( FixStatus.SYSTEM_STILL_VULNERABLE.value.msg ) for unfixed_pkg in unfixed_pkgs: fix_plan.register_warning( warning_type=FixWarningType.PACKAGE_CANNOT_BE_INSTALLED, data={ "binary_package": unfixed_pkg.binary_package, "binary_package_version": unfixed_pkg.version, "source_package": unfixed_pkg.source_package, "related_source_packages": source_pkgs, "pocket": pocket_name, }, ) if pocket != messages.SECURITY_UBUNTU_STANDARD_UPDATES_POCKET: if pocket == messages.SECURITY_UA_INFRA_POCKET: service_to_check = "esm-infra" else: service_to_check = "esm-apps" if not _is_attached(cfg).is_attached: fix_plan.register_step( operation=FixStepType.ATTACH, data={ "reason": "required-pro-service", "source_packages": source_pkgs, "required_service": service_to_check, }, ) else: contract_expiry_status = _is_attached(cfg).contract_status if contract_expiry_status != ContractExpiryStatus.ACTIVE.value: fix_plan.register_step( operation=FixStepType.ATTACH, data={ "reason": FixPlanAttachReason.EXPIRED_CONTRACT.value, # noqa "source_packages": source_pkgs, }, ) enabled_services = _enabled_services(cfg).enabled_services or [] enabled_services_names = ( [service.name for service in enabled_services] if enabled_services else [] ) if service_to_check not in enabled_services_names: fix_plan.register_step( operation=FixStepType.ENABLE, data={ "service": service_to_check, "source_packages": source_pkgs, }, ) fix_plan.register_step( operation=FixStepType.APT_UPGRADE, data={ "binary_packages": upgrade_pkgs, "source_packages": source_pkgs, "pocket": pocket_name, }, ) return fix_plan.fix_plan pro/security/fix/_common/plan/__pycache__/__init__.cpython-310.pyc 0000644 00000000264 15030103444 0021026 0 ustar 00 o �ϴf � @ s d S )N� r r r �W/usr/lib/python3/dist-packages/uaclient/api/u/pro/security/fix/_common/plan/__init__.py�<module> s pro/security/fix/_common/plan/__pycache__/v1.cpython-310.pyc 0000644 00000062566 15030103444 0017632 0 ustar 00 o �P�ff� � @ s d dl Z d dlZd dlmZ d dlmZmZ d dlmZmZm Z m Z m Z m Z d dl mZmZmZ d dlmZmZmZmZmZmZmZmZmZmZm Z m Z m Z m Z d dl m!Z! d dl"m#Z#m$Z$ d d l%m&Z& d d l'm(Z(m)Z)m*Z*m+Z+m,Z, d Z-d Z.d Z/e dde0fde0fde e0 fg�Z1e j2G dd� de j3��Z4e j2G dd� de j3��Z5e j2G dd� de j3��Z6e j2G dd� de j3��Z7G dd� de(�Z8G d d � d e(�Z9G d d � d e8�Z:G d d!� d!e(�Z;G d"d#� d#e8�Z<G d$d%� d%e(�Z=G d&d'� d'e8�Z>G d(d)� d)e(�Z?G d*d+� d+e8�Z@G d,d-� d-e?�ZAG d.d/� d/e@�ZBG d0d1� d1e?�ZCG d2d3� d3e@�ZDG d4d5� d5e(�ZEG d6d7� d7e(�ZFG d8d9� d9eE�ZGG d:d;� d;e(�ZHG d<d=� d=eE�ZIG d>d?� d?e(�ZJG d@dA� dAeE�ZKG dBdC� dCe(�ZLG dDdE� dEe(�ZMG dFdG� dGeM�ZNG dHdI� dIe(�ZOG dJdK� dKe(�ZPG dLdM� dM�ZQG dNdO� dOeQ�ZR d|dPe0dQe e0 dRe e e0 fdSdT�ZSdUe0dVedWe ee e f fdXdY�ZTdUe0dVedWe ee e f fdZd[�ZUd\e e d]eVdWe e e0 e e1 f fd^d_�ZWd`e e e0ef daee0ee0ee0e0f f f dbee0ee0e0f f fdcdd�ZXdeedbee0ee0e0f f fdfdg�ZYdUe0dhe&dWeOfdidj�ZZdUe0dhe&dWePfdkdl�Z[dUe0dhe&dWeOfdmdn�Z\dUe0dhe&dWePfdodp�Z]dqe0fdrds�Z^d]eVdteVdhe&dWeVfdudv�Z_ddw�dUe0dxe0dyee0ef daee0ee0ee0e0f f f dbee0ee0e0f f dhe&dWeOfdzd{�Z`dS )}� N)� defaultdict)�datetime�timezone)�Any�Dict�List� NamedTuple�Optional�Tuple)�apt� exceptions�messages)�CVE�CVE_OR_USN_REGEX�USN�BinaryPackageFix�CVEPackageStatus� FixStatus�UASecurityClient� _check_cve_fixed_by_livepatch� get_affected_packages_from_usn�'get_cve_affected_source_packages_status�get_related_usns�group_by_usn_package_status�*merge_usn_released_binary_package_versions�#query_installed_source_pkg_versions)�_enabled_services)�ContractExpiryStatus� _is_attached)�UAConfig)� DataObject�Field� IntDataValue�StringDataValue� data_listzstandard-updates� esm-infra�esm-apps�UnfixedPackage�source_package�binary_package�versionc @ s e Zd ZdZdZdZdZdS )� FixStepType�attach�enablezno-opz apt-upgradeN)�__name__� __module__� __qualname__�ATTACH�ENABLE�NOOP� APT_UPGRADE� r5 r5 �Q/usr/lib/python3/dist-packages/uaclient/api/u/pro/security/fix/_common/plan/v1.pyr+ 4 s r+ c @ � e Zd ZdZdZdZdS )�FixPlanNoOpStatuszcve-already-fixed�system-not-affectedzcve-fixed-by-livepatchN)r. r/ r0 � ALREADY_FIXED� NOT_AFFECTED�FIXED_BY_LIVEPATCHr5 r5 r5 r6 r8 < � r8 c @ s e Zd ZdZdZdS )�FixPlanAttachReasonzexpired-contract-token�required-pro-serviceN)r. r/ r0 �EXPIRED_CONTRACT�REQUIRED_PRO_SERVICEr5 r5 r5 r6 r> C s r> c @ r7 )�FixWarningTypezpackage-cannot-be-installedzsecurity-issue-not-fixedzfail-updating-esm-cacheN)r. r/ r0 �PACKAGE_CANNOT_BE_INSTALLED�SECURITY_ISSUE_NOT_FIXED�FAIL_UPDATING_ESM_CACHEr5 r5 r5 r6 rB I r= rB c @ �F e Zd Zededd�ededd�ededd�gZdede fdd �Z d S ) � FixPlanStep� operationzyThe operation that would be performed to fix the issue. This can be either an attach, enable, apt-upgrade or a no-op type��doc�order�$The execution order of the operation�datazdA data object that can be either an ``AptUpgradeData``, ``AttachData``, ``EnableData``, ``NoOpData``c C � || _ || _d S �N�rH rK )�selfrH rK r5 r5 r6 �__init__g � zFixPlanStep.__init__N� r. r/ r0 r! r# r" r �fields�str�intrR r5 r5 r5 r6 rG P s ����rG c @ sZ e Zd Zedee�dd�edee�dd�ededd�gZdee dee defdd �Z d S ) �AptUpgradeData�binary_packagesz2A list of binary packages that need to be upgradedrI �source_packagesz2A list of source packages that need to be upgraded�pocketz4The pocket where the packages will be installed fromc C � || _ || _|| _d S rO �rY rZ r[ )rQ rY rZ r[ r5 r5 r6 rR s zAptUpgradeData.__init__N� r. r/ r0 r! r$ r# rU r rV rR r5 r5 r5 r6 rX l s0 �������rX c �B e Zd Zede�ede�ede�gZdedef� fdd� Z � Z S )�FixPlanAptUpgradeSteprH rM rK c � t � jtjj|d� || _d S �NrP )�superrR r+ r4 �valuerM �rQ rM rK �� __class__r5 r6 rR � � z FixPlanAptUpgradeStep.__init__) r. r/ r0 r! r# rX r" rU rW rR � __classcell__r5 r5 rf r6 r` � � � r` c @ sR e Zd Zededd�ededd�edee�dd�gZdedee defdd �Z d S ) � AttachData�reasonz,The reason why an attach operation is neededrI �required_servicez7The required service that requires the attach operationrZ z5The source packages that require the attach operationc C r\ rO �rl rZ rm )rQ rl rZ rm r5 r5 r6 rR � s zAttachData.__init__N� r. r/ r0 r! r# r$ rU rV r rR r5 r5 r5 r6 rk � s0 �������rk c r_ )�FixPlanAttachSteprH rM rK c ra rb )rc rR r+ r1 rd rM re rf r5 r6 rR � rh zFixPlanAttachStep.__init__) r. r/ r0 r! r# rk r" rU rW rR ri r5 r5 rf r6 rp � rj rp c @ sB e Zd Zededd�edee�dd�gZdedee fdd�Z dS ) � EnableData�servicez$The service that needs to be enabledrI rZ z:The source packages that require the service to be enabledc C rN rO �rr rZ )rQ rr rZ r5 r5 r6 rR � rS zEnableData.__init__Nro r5 r5 r5 r6 rq � s ��� rq c r_ )�FixPlanEnableSteprH rM rK c ra rb )rc rR r+ r2 rd rM re rf r5 r6 rR � rh zFixPlanEnableStep.__init__) r. r/ r0 r! r# rq r" rU rW rR ri r5 r5 rf r6 rt � rj rt c @ s* e Zd Zededd�gZdefdd�ZdS )�NoOpData�status�:The status of the issue when no operation can be performedrI c C s || _ d S rO �rv )rQ rv r5 r5 r6 rR � s zNoOpData.__init__N�r. r/ r0 r! r# rU rV rR r5 r5 r5 r6 ru � s ��ru c r_ )�FixPlanNoOpSteprH rM rK c ra rb )rc rR r+ r3 rd rM re rf r5 r6 rR � rh zFixPlanNoOpStep.__init__) r. r/ r0 r! r# ru r" rU rW rR ri r5 r5 rf r6 rz � rj rz c sB e Zd Zededd�ededd�gZdedef� fdd� Z� ZS )�NoOpLivepatchFixDatarv z8The status of the CVE when no operation can be performedrI � patch_versionz6Version of the patch from Livepatch that fixed the CVEc s t � j|d� || _d S �Nrx )rc rR r| )rQ rv r| rf r5 r6 rR s z NoOpLivepatchFixData.__init__) r. r/ r0 r! r# rU rV rR ri r5 r5 rf r6 r{ � s ��� r{ c r_ )�FixPlanNoOpLivepatchFixSteprH rM rK c � t � j||d� d S �N)rM rK �rc rR re rf r5 r6 rR � z$FixPlanNoOpLivepatchFixStep.__init__) r. r/ r0 r! r# r{ r" rU rW rR ri r5 r5 rf r6 r~ rj r~ c sZ e Zd Zededd�edee�dd�ededd�gZdedee def� fdd � Z � Z S ) �NoOpAlreadyFixedDatarv rw rI rZ z*The source packages that are already fixedr[ z<The pocket where the packages would have been installed fromc s t � j|d� || _|| _d S r} )rc rR rZ r[ )rQ rv rZ r[ rf r5 r6 rR ' s z NoOpAlreadyFixedData.__init__) r. r/ r0 r! r# r$ rU rV r rR ri r5 r5 rf r6 r� s0 �������r� c �B e Zd Zede�ede�ede�gZdede f� fdd� Z � Z S )�FixPlanNoOpAlreadyFixedSteprH rM rK c r r� r� re rf r5 r6 rR 6 r� z$FixPlanNoOpAlreadyFixedStep.__init__) r. r/ r0 r! r# r{ r" rU r� rW rR ri r5 r5 rf r6 r� / rj r� c @ rF ) �FixPlanWarning� warning_typezThe type of warningrI rK rL rM zjA data object that represents either a ``PackageCannotBeInstalledData`` or a ``SecurityIssueNotFixedData``c C rN rO �r� rK )rQ r� rK r5 r5 r6 rR I rS zFixPlanWarning.__init__NrT r5 r5 r5 r6 r� : s ���r� c @ sB e Zd Zedee�dd�ededd�gZdee defdd�Z dS ) �SecurityIssueNotFixedDatarZ z<A list of source packages that cannot be fixed at the momentrI rv z.The status of the CVE regarding those packagesc C rN rO �rZ rv )rQ rZ rv r5 r5 r6 rR \ rS z"SecurityIssueNotFixedData.__init__Nr^ r5 r5 r5 r6 r� N s ��� r� c �B e Zd Zede�ede�ede�gZdedef� fdd� Z � Z S )�#FixPlanWarningSecurityIssueNotFixedr� rK rM c � t � jtjj|d� || _d S �Nr� )rc rR rB rD rd rM �rQ rK rM rf r5 r6 rR h � � z,FixPlanWarningSecurityIssueNotFixed.__init__) r. r/ r0 r! r# r" r� rU rW rR ri r5 r5 rf r6 r� a rj r� c @ sr e Zd Zededd�ededd�ededd�edee�d d�ed ed d�gZdededed edee f d d �Z dS )� PackageCannotBeInstalledDatar) z+The binary package that cannot be installedrI �binary_package_versionz:The version of the binary package that cannot be installedr( z5The source package associated with the binary package�related_source_packageszPA list of source packages that come from the same pocket as the affected packager[ z>The pocket where the affected package should be installed fromc C s" || _ || _|| _|| _|| _d S rO )r( r) r� r[ r� )rQ r) r� r( r[ r� r5 r5 r6 rR � s z%PackageCannotBeInstalledData.__init__Nro r5 r5 r5 r6 r� p sL ������"�����r� c r� )�&FixPlanWarningPackageCannotBeInstalledr� rK rM c r� r� )rc rR rB rC rd rM r� rf r5 r6 rR � r� z/FixPlanWarningPackageCannotBeInstalled.__init__) r. r/ r0 r! r# r" r� rU rW r� rR ri r5 r5 rf r6 r� � rj r� c @ s2 e Zd Zede�ede�gZdedefdd�ZdS )�FailUpdatingESMCacheData�title�codec C rN rO �r� r� )rQ r� r� r5 r5 r6 rR � rS z!FailUpdatingESMCacheData.__init__Nry r5 r5 r5 r6 r� � s �r� c r� )�"FixPlanWarningFailUpdatingESMCacher� rK rM c r� r� )rc rR rB rE rd rM r� rf r5 r6 rR � r� z+FixPlanWarningFailUpdatingESMCache.__init__) r. r/ r0 r! r# r" r� rU rW rR ri r5 r5 rf r6 r� � rj r� c @ s@ e Zd Zededd�ededdd�gZdedee fdd �Zd S ) � FixPlanError�msgzThe error messagerI r� FzThe message code��requiredrJ c C rN rO �r� r� )rQ r� r� r5 r5 r6 rR � rS zFixPlanError.__init__N) r. r/ r0 r! r# rU rV r rR r5 r5 r5 r6 r� � s �r� c @ s e Zd ZdS )�AdditionalDataN)r. r/ r0 r5 r5 r5 r6 r� � s r� c @ sJ e Zd Zedee�dd�edee�dd�gZdee dee fdd�Z dS ) �USNAdditionalData�associated_cvesz The associated CVEs for the USNrI �associated_launchpad_bugsz)The associated Launchpad bugs for the USNc C rN rO �r� r� )rQ r� r� r5 r5 r6 rR � � zUSNAdditionalData.__init__Nr^ r5 r5 r5 r6 r� � s" ��� ��r� c @ s� e Zd Zededd�ededdd�ededd d�ed ed d�ed ee�dd d�edee�dd�edee�ddd�ededdd�ede ddd�g Z dddd�de d e de e de e de e de de e d e e e de e fdd�ZdS )� FixPlanResultr� zThe title of the issuerI � descriptionFz The description of the issuer� �current_statusz-The current status of the issue on the system�expected_statusz'The expected status of fixing the issue�affected_packagesz-A list of package names affected by the issue�planz!A list of ``FixPlanStep`` objects�warningsz$A list of ``FixPlanWarning`` objects�errorz0A ``FixPlanError`` object, if an error occurred.�additional_dataz Additional data for the issueN)r� r� r� c C s: || _ || _| | _|| _|| _|| _|| _|| _|| _d S rO ) r� r� r� r� r� r� r� r� r� ) rQ r� r� r� r� r� r� r� r� r� r5 r5 r6 rR ' s zFixPlanResult.__init__)r. r/ r0 r! r# r$ rG r� r� r� rU rV r r rR r5 r5 r5 r6 r� � s� ���������;������� � � �r� c @ sD e Zd Zededd�edee�ddd�gZdedee fdd �Zd S ) �FixPlanUSNResult�target_usn_planz-A ``FixPlanResult`` object for the target USNrI �related_usns_planFz8A list of ``FixPlanResult`` objects for the related USNsr� c C rN rO �r� r� )rQ r� r� r5 r5 r6 rR N r� zFixPlanUSNResult.__init__N) r. r/ r0 r! r� r$ rU r rR r5 r5 r5 r6 r� ? s$ �����r� c @ s� e Zd Z ddedee deee dee fdd�Zded eee f fd d �Z d e d eee f fd d�Z dedee fdd�Z deee f fdd�Zdefdd�Zedd� �ZdS ) �FixPlanNr� r� r� r� c C s< d| _ || _|| _|| _|| _g | _g | _d | _t� | _ d S )N� ) rK r� r� r� r� � fix_steps� fix_warningsr� r� r� )rQ r� r� r� r� r5 r5 r6 rR Y s zFixPlan.__init__rH rM c C s� d }|t jkrt| jt�|�d�}nH|t jkr"t| jt�|�d�}n8|t j krPd|v r6t | jt �|�d�}n$d|v rEt | jt �|�d�}nt| jt�|�d�}n t| jt�|�d�}| j�|� | jd7 _d S )N�rK rM r| rZ r� )r+ r1 rp rK rk � from_dictr2 rt rq r3 r~ r{ r� r� rz ru r` rX r� �append)rQ rH rM �fix_stepr5 r5 r6 � register_stepj s4 � � � � � � zFixPlan.register_stepr� c C sv d }|t jkrt| jt�|�d�}n|t jkr"t| jt�|�d�}n t | jt �|�d�}| j � |� | jd7 _d S )Nr� r� ) rB rD r� rK r� r� rC r� r� r� r� r� r� )rQ r� rM � fix_warningr5 r5 r6 �register_warning� s" � �� zFixPlan.register_warning� error_msg� error_codec C s t ||d�| _d S )Nr� )r� r� )rQ r� r� r5 r5 r6 �register_error� s zFixPlan.register_errorr� c C � t di |��| _d S �Nr5 )r� r� �rQ r� r5 r5 r6 �register_additional_data� r� z FixPlan.register_additional_data�returnc C s^ | j rdS t| j�dkr"t| jd t�r"| jd jjdkr"tjj j S | j r*tj j j S tj j j S )Nr� r� r r9 )r� �lenr� � isinstancerz rM rv r �SYSTEM_NOT_AFFECTEDrd r� r� �SYSTEM_STILL_VULNERABLE�SYSTEM_NON_VULNERABLE�rQ r5 r5 r6 �_get_expected_status� s � z FixPlan._get_expected_statusc C s. t | j| j| �� | j| j| j| j| j| j d� S )N) r� r� r� r� r� r� r� r� r� ) r� r� r� r� r� r� r� r� r� r� r� r5 r5 r6 �fix_plan� s �zFixPlan.fix_plan�NN)r. r/ r0 rV r r rR r+ r r r� rB r� r� r� r� �propertyr� r5 r5 r5 r6 r� X s6 ��� � �� �%� �r� c @ s" e Zd Zdeeef fdd�ZdS )� USNFixPlanr� c C r� r� )r� r� r� r5 r5 r6 r� � r� z#USNFixPlan.register_additional_dataN)r. r/ r0 r rV r r� r5 r5 r5 r6 r� � s r� r� r� r� c C s, | rd| � � v rt| ||d�S t| ||d�S )N�cve�r� r� r� )�lowerr� r� r� r5 r5 r6 � get_fix_plan� s ��r� �issue_id�clientr� c C sX z|j | d�}|j| d�}W ||fS tjy+ } z |jdkr%tj| d��|�d }~ww )N)�cve_id)�cves� �r� )�get_cve� get_noticesr �SecurityAPIErrorr� �SecurityIssueNotFound)r� r� r� �usns�er5 r5 r6 � _get_cve_data� s � ��r� c C sr z |j | d�}t||�}W n tjy' } z |jdkr!tj| d��|�d }~ww |jd s5tjd| dd��||fS )N)� notice_idr� r� �release_packagesz+metadata defines no fixed package versions.� )r� �issue� extra_info)� get_noticer r r� r� r� �response�SecurityAPIMetadataError)r� r� �usnr� r� r5 r5 r6 � _get_usn_data� s �� �r� � binary_pkgs�check_esm_cachec C sl g }g }t | �D ])}tj|j|d�}|r$t�|j|�dkr$|�|j� q|�t|j|j|jd�� q||fS )N)r� r )r( r) r* ) �sortedr �get_pkg_candidate_version� binary_pkg�version_compare� fixed_versionr� r' � source_pkg)r� r� � upgrade_pkgs� unfixed_pkgsr� �candidate_versionr5 r5 r6 �_get_upgradable_pkgs s, ������r� �pkg_status_group�usn_released_pkgs�installed_pkgsc C s� t t�}t t�}| D ]C\}}||j �||f� || �� D ].\}}|�|i �} || vr-q | �|i ��dd�} t�| |�dkrL||j �t||| d�� q q ||fS )Nr* r� r )r� r� r� ) r �list� pocket_sourcer� �items�getr r� r ) r� r� r� �binary_pocket_pkgs�src_pocket_pkgs�src_pkg� pkg_statusr� r* �usn_released_srcr� r5 r5 r6 �,_get_upgradable_package_candidates_by_pocket( s, � ����r r� c C sN | j s| jS | j D ]}|j�� }|D ] }||v r |j S qq | j d jS )Nr )�noticesr� r� �keysr� )r� r� �notice�usn_pkgs�pkgr5 r5 r6 �_get_cve_descriptionF s �� r �cfgc C s� t | �\}}|r#t| d�}tjjj|_|jtj t j j|d�d� |j S t |d�}t� }z t| |d�\}}W n' tjtjfy\ } zt| d�}|j| j| jd� |j W Y d } ~ S d } ~ ww t||d�} t|i d�} t||�} t| | | | ||d �S ) N�r� )rv r| �rH rM �r �r� r� �r� r� )r� �installed_packages�� beta_pockets)r� �issue_description�affected_pkg_statusr� r� r )r r� r r� rd r� r� r� r+ r3 r8 r< r� r r r� r r� r� r� �msg_coder r r �_generate_fix_plan) r� r �livepatch_cve_statusr| r� r� r� r� r� r� r r� �cve_descriptionr5 r5 r6 � _fix_plan_cveV sR � �� � ���� �r c C sF t |d�}t� }z t| |d�\}}W n+ tjtjfy= } zt| d�}|j|j|j d� t |j g d�W Y d }~S d }~ww t ||d�}t |gi d�} |jsPg n|j|jsWg n|jd�} t| |j|| ||| d �} g } |D ]0}t ||d�}t |gi d�} |js�g n|j|js�g n|jd�} | �t|j|j|| ||| d �� qlt | | d�S ) Nr r r r r� )r� r r r� )r� r r r� r� r r� )r r r� r r� r� r� r� r� r r� r� r r �cves_ids� referencesr r� r� �id) r� r r� r� r� � related_usnsr� r� r r� r� r� r� r5 r5 r6 � _fix_plan_usn� sx � ��� ���� ����� �r c C sR | rt �t| �s t| d�}tjj| d�}|j|j|j d� |j S | � � } t | |�S )Nr r� r ) �re�matchr r� r �INVALID_SECURITY_ISSUE�formatr� r� �namer� �upperr �r� r r� r� r5 r5 r6 � fix_plan_cve� s r& c C sZ | rt �t| �s$t| d�}tjj| d�}|j|j|j d� t |j g d�S | � � } t | |�S )Nr r� r r� )r r r r� r r! r" r� r� r# r� r� r$ r r% r5 r5 r6 � fix_plan_usn� s � r' r[ c C s. | t jkrtS | t jkrtS | t jkrtS | S rO )r �'SECURITY_UBUNTU_STANDARD_UPDATES_POCKET�STANDARD_UPDATES_POCKET�SECURITY_UA_INFRA_POCKET�ESM_INFRA_POCKET�SECURITY_UA_APPS_POCKET�ESM_APPS_POCKET)r[ r5 r5 r6 �get_pocket_short_name� s r. �esm_cache_updatedc C sL | r$|s$t |�js$t�� }|d u rdS t�tj�}|| }|jdkr$dS dS )NT� F) r � is_attachedr �get_apt_cache_datetimer �nowr �utc�days)r� r/ r �last_apt_updater3 �time_since_updater5 r5 r6 �_should_update_esm_cache� s ��� r8 )r� r r c C s t |�}tt�}d} t| |tt|�� ��d�} |r | �|� |dkr7tjj j | _ | j t jdtjj id� | jS tjj j | _ t||�} t| �� �D ]'\} } | dkrg| jtjdd� | D �| d �d � tjj j | _ qHt| ||�\}}qH|su| jS tjtjtj fD �]}|| }|| }d d� |D �}t |�}|s�|r�tj j j | _ | j t jtj j ||d �d� q}|tjk}t || |�r�z t!�"|� d } W n, t#y� } z tj$j%t&|dt'|��d�}| jtj(|j |j)d�d � W Y d }~nd }~ww t*||�\}}|�rtjj j | _ |D ]}| jtj+|j,|j-|j.||d�d � q�|tjk�rt|tjk�r"d}nd}t/|�j0�s7| j t j1d||d�d� nt/|�j2}|t3j4j k�rP| j t j1t5j6j |d�d� t7|�j8�pWg } | �rbdd� | D �ng } || v�rt| j t j9||d�d� | j t j:|||d�d� q}| jS )NFr� r rv r �releasedc S � g | ]\}}|�qS r5 r5 ��.0r �_r5 r5 r6 � <listcomp>4 s �z&_generate_fix_plan.<locals>.<listcomp>r� )r� rM c S r: r5 r5 r; r5 r5 r6 r> Q s )rv rZ r[ Tr� )r� r� )r) r� r( r� r[ r% r& r? rn )rl rZ c S s g | ]}|j �qS r5 )r# )r< rr r5 r5 r6 r> � s rs r] );r� r r� r� r� r r� r r� rd r� r� r� r+ r3 r8 r; r� r� r r� r� rB rD r r r( r* r, r. r� r: r8 r �update_esm_caches� Exception�E_UPDATING_ESM_CACHEr" �getattrrV rE r# r� rC r) r* r( r r1 r1 �contract_statusr �ACTIVEr> r@ r �enabled_servicesr2 r4 ) r� r r r� r� r r� �countr� r/ r� �pkg_status_groups� status_valuer� r� r[ � pkg_src_groupr� � source_pkgs� pocket_namer� r� r� r� r� � unfixed_pkg�service_to_check�contract_expiry_statusrE �enabled_services_namesr5 r5 r6 r s � � ���� ��� ����� ����� ���� �� ���� ���� r r� )a�enumr � collectionsr r r �typingr r r r r r �uaclientr r r �'uaclient.api.u.pro.security.fix._commonr r r r r r r r r r r r r r �-uaclient.api.u.pro.status.enabled_services.v1r �(uaclient.api.u.pro.status.is_attached.v1r r �uaclient.configr �uaclient.data_typesr r! r" r# r$ r) r+ r- rV r' �unique�Enumr+ r8 r> rB rG rX r` rk rp rq rt ru rz r{ r~ r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� �boolr� r r r r r& r' r. r8 r r5 r5 r5 r6 �<module> s @ �� 3 Ks��� ��� ��� ��� � �� � � �1I ��� � ��� ���� � pro/security/fix/_common/plan/__init__.py 0000644 00000000000 15030103444 0014453 0 ustar 00 pro/security/fix/_common/execute/v1.py 0000644 00000023233 15030103444 0013767 0 ustar 00 from typing import List, Optional from uaclient import apt, messages, util from uaclient.api.u.pro.security.fix._common import FixStatus, status_message from uaclient.api.u.pro.security.fix._common.plan.v1 import ( FixPlanAptUpgradeStep, FixPlanAttachStep, FixPlanEnableStep, FixPlanNoOpStatus, FixPlanNoOpStep, FixPlanResult, FixPlanWarningPackageCannotBeInstalled, FixPlanWarningSecurityIssueNotFixed, ) from uaclient.data_types import DataObject, Field, StringDataValue, data_list class UpgradedPackage(DataObject): fields = [ Field("name", StringDataValue, doc="The name of the package"), Field( "version", StringDataValue, doc="The version that the package was upgraded to", ), Field( "pocket", StringDataValue, doc="The pocket which contained the package upgrade", ), ] def __init__(self, name: str, version: str, pocket: str): self.name = name self.version = version self.pocket = pocket class FailedUpgrade(DataObject): fields = [ Field("name", StringDataValue, doc="The name of the package"), Field( "pocket", StringDataValue, required=False, doc="The pocket which contained the package upgrade", ), ] def __init__(self, name: str, pocket: Optional[str] = None): self.name = name self.pocket = pocket class FixExecuteError(DataObject): fields = [ Field("error_type", StringDataValue, doc="The type of the error"), Field( "reason", StringDataValue, doc="The reason why the error occurred" ), Field( "failed_upgrades", data_list(FailedUpgrade), required=False, doc="A list of ``FailedUpgrade`` objects", ), ] def __init__( self, error_type: str, reason: str, failed_upgrades: Optional[List[FailedUpgrade]] = None, ): self.error_type = error_type self.reason = reason self.failed_upgrades = failed_upgrades class FixExecuteResult(DataObject): fields = [ Field("title", StringDataValue, doc="The title of the CVE"), Field( "description", StringDataValue, required=False, doc="The description of the CVE", ), Field("status", StringDataValue, doc="The status of fixing the CVE"), Field( "upgraded_packages", data_list(UpgradedPackage), required=False, doc="A list of ``UpgradedPackage`` objects", ), Field( "errors", data_list(FixExecuteError), required=False, doc="A list of ``FixExecuteError`` objects", ), ] def __init__( self, title: str, status: str, description: Optional[str] = None, upgraded_packages: Optional[List[UpgradedPackage]] = None, errors: Optional[List[FixExecuteError]] = None, ): self.title = title self.description = description self.status = status self.upgraded_packages = upgraded_packages self.errors = errors class ExecuteContext: def __init__(self): self.require_enable = False self.require_attach = False self.status = FixStatus.SYSTEM_NON_VULNERABLE.value.msg self.upgraded_pkgs = [] # type: List[UpgradedPackage] self.errors = [] # type: List[FixExecuteError] def _handle_error( execute_context: ExecuteContext, security_issue: FixPlanResult ): if security_issue.error: execute_context.errors.append( FixExecuteError( error_type=security_issue.error.code or "unexpected-error", reason=security_issue.error.msg, ) ) execute_context.status = "error" def _handle_security_issue_not_fixed( execute_context: ExecuteContext, warning: FixPlanWarningSecurityIssueNotFixed, ): execute_context.errors.append( FixExecuteError( error_type=warning.warning_type, reason=status_message(warning.data.status), failed_upgrades=[ FailedUpgrade(name=pkg) for pkg in warning.data.source_packages ], ) ) execute_context.status = FixStatus.SYSTEM_STILL_VULNERABLE.value.msg def _handle_package_cannot_be_installed( execute_context: ExecuteContext, warning: FixPlanWarningPackageCannotBeInstalled, ): execute_context.errors.append( FixExecuteError( error_type=warning.warning_type, reason=messages.FIX_CANNOT_INSTALL_PACKAGE.format( package=warning.data.binary_package, version=warning.data.binary_package_version, ), failed_upgrades=[ FailedUpgrade( name=warning.data.binary_package, pocket=warning.data.pocket, ) ], ) ) execute_context.status = FixStatus.SYSTEM_STILL_VULNERABLE.value.msg def _handle_attach(execute_context: ExecuteContext, step: FixPlanAttachStep): execute_context.errors.append( FixExecuteError( error_type="fix-requires-attach", reason=messages.SECURITY_UPDATE_NOT_INSTALLED_SUBSCRIPTION, failed_upgrades=[ FailedUpgrade(name=pkg, pocket=step.data.required_service) for pkg in step.data.source_packages ], ) ) execute_context.require_attach = True execute_context.status = FixStatus.SYSTEM_STILL_VULNERABLE.value.msg def _handle_enable(execute_context: ExecuteContext, step: FixPlanEnableStep): if execute_context.require_attach: return execute_context.errors.append( FixExecuteError( error_type="fix-requires-enable", reason=messages.SECURITY_SERVICE_DISABLED.format( service=step.data.service ), failed_upgrades=[ FailedUpgrade(name=pkg, pocket=step.data.service) for pkg in step.data.source_packages ], ) ) execute_context.require_enable = True execute_context.status = FixStatus.SYSTEM_STILL_VULNERABLE.value.msg def _handle_apt_upgrade( execute_context: ExecuteContext, step: FixPlanAptUpgradeStep ): if execute_context.require_attach or execute_context.require_enable: return if not step.data.binary_packages: return if not util.we_are_currently_root(): execute_context.errors.append( FixExecuteError( error_type="fix-require-root", reason=messages.SECURITY_APT_NON_ROOT, failed_upgrades=[ FailedUpgrade(name=pkg, pocket=step.data.pocket) for pkg in step.data.source_packages ], ) ) execute_context.status = "error" return try: apt.run_apt_update_command() apt.run_apt_command( cmd=["apt-get", "install", "--only-upgrade", "-y"] + step.data.binary_packages, override_env_vars={"DEBIAN_FRONTEND": "noninteractive"}, ) for pkg in step.data.binary_packages: pkg_version = apt.get_pkg_version(pkg) if pkg_version: execute_context.upgraded_pkgs.append( UpgradedPackage( name=pkg, version=pkg_version, pocket=step.data.pocket, ) ) except Exception as e: msg = getattr(e, "msg", str(e)) execute_context.status = FixStatus.SYSTEM_STILL_VULNERABLE.value.msg execute_context.errors.append( FixExecuteError( error_type="fix-error-installing-pkg", reason=msg, failed_upgrades=[ FailedUpgrade(name=pkg, pocket=step.data.pocket) for pkg in step.data.source_packages ], ) ) def _handle_noop(execute_context: ExecuteContext, step: FixPlanNoOpStep): if step.data.status == FixPlanNoOpStatus.NOT_AFFECTED.value: execute_context.status = FixStatus.SYSTEM_NOT_AFFECTED.value.msg def _execute_fix(security_issue: FixPlanResult) -> FixExecuteResult: execute_context = ExecuteContext() if security_issue.error: _handle_error(execute_context, security_issue) if security_issue.warnings: for warning in security_issue.warnings: if isinstance(warning, FixPlanWarningSecurityIssueNotFixed): _handle_security_issue_not_fixed(execute_context, warning) elif isinstance(warning, FixPlanWarningPackageCannotBeInstalled): _handle_package_cannot_be_installed(execute_context, warning) if security_issue.plan: for step in security_issue.plan: if isinstance(step, FixPlanAttachStep): _handle_attach(execute_context, step) elif isinstance(step, FixPlanEnableStep): _handle_enable(execute_context, step) elif isinstance(step, FixPlanAptUpgradeStep): _handle_apt_upgrade(execute_context, step) elif isinstance(step, FixPlanNoOpStep): _handle_noop(execute_context, step) return FixExecuteResult( title=security_issue.title, description=security_issue.description, status=execute_context.status, upgraded_packages=execute_context.upgraded_pkgs, errors=None if not execute_context.errors else execute_context.errors, ) pro/security/fix/_common/execute/__pycache__/__init__.cpython-310.pyc 0000644 00000000267 15030103444 0021541 0 ustar 00 o �ϴf � @ s d S )N� r r r �Z/usr/lib/python3/dist-packages/uaclient/api/u/pro/security/fix/_common/execute/__init__.py�<module> s pro/security/fix/_common/execute/__pycache__/v1.cpython-310.pyc 0000644 00000017224 15030103444 0020331 0 ustar 00 o �(�f�& � @ sV d dl mZmZ d dlmZmZmZ d dlmZm Z d dl m Z m Z m Z mZmZmZmZmZ d dlmZmZmZmZ G dd� de�ZG dd � d e�ZG d d � d e�ZG d d � d e�ZG dd� d�Z de defdd�Z de defdd�Z de defdd�Z de de fdd�Z de de fd d �Z!de de fd d �Z"de defd d!�Z#ded"efd#d$�Z$d%S )&� )�List�Optional)�apt�messages�util)� FixStatus�status_message)�FixPlanAptUpgradeStep�FixPlanAttachStep�FixPlanEnableStep�FixPlanNoOpStatus�FixPlanNoOpStep� FixPlanResult�&FixPlanWarningPackageCannotBeInstalled�#FixPlanWarningSecurityIssueNotFixed)� DataObject�Field�StringDataValue� data_listc @ sJ e Zd Zededd�ededd�ededd�gZdededefdd �Zd S ) �UpgradedPackage�name�The name of the package��doc�versionz,The version that the package was upgraded to�pocket�.The pocket which contained the package upgradec C � || _ || _|| _d S �N�r r r )�selfr r r � r! �T/usr/lib/python3/dist-packages/uaclient/api/u/pro/security/fix/_common/execute/v1.py�__init__! s zUpgradedPackage.__init__N)�__name__� __module__� __qualname__r r �fields�strr# r! r! r! r" r s ���r c @ sB e Zd Zededd�ededdd�gZd dedee fd d �ZdS ) � FailedUpgrader r r r Fr ��requiredr Nc C s || _ || _d S r �r r )r r r r! r! r" r# 2 s zFailedUpgrade.__init__r ) r$ r% r& r r r' r( r r# r! r! r! r" r) ' s �� r) c @ s\ e Zd Zededd�ededd�edee�ddd �gZ d dedede e e fd d �Z d S )�FixExecuteError� error_typezThe type of the errorr �reasonz!The reason why the error occurred�failed_upgradesFz#A list of ``FailedUpgrade`` objectsr* Nc C r r �r. r/ r0 )r r. r/ r0 r! r! r" r# E s zFixExecuteError.__init__r ) r$ r% r& r r r r) r' r( r r r# r! r! r! r" r- 7 s( ������ �r- c @ s� e Zd Zededd�ededdd�eded d�ed ee�dd d�ed ee�dd d�gZ dde de de e d e e e d e e e f dd�Z dS )�FixExecuteResult�titlezThe title of the CVEr � descriptionFzThe description of the CVEr* �statusz The status of fixing the CVE�upgraded_packagesz%A list of ``UpgradedPackage`` objects�errorsz%A list of ``FixExecuteError`` objectsNc C s" || _ || _|| _|| _|| _d S r �r3 r4 r5 r6 r7 )r r3 r5 r4 r6 r7 r! r! r" r# h s zFixExecuteResult.__init__)NNN) r$ r% r& r r r r r- r' r( r r r# r! r! r! r" r2 P sH � ������� � �r2 c @ s e Zd Zdd� ZdS )�ExecuteContextc C s( d| _ d| _tjjj| _g | _g | _d S )NF) �require_enable�require_attachr �SYSTEM_NON_VULNERABLE�value�msgr5 � upgraded_pkgsr7 )r r! r! r" r# x s zExecuteContext.__init__N)r$ r% r& r# r! r! r! r" r9 w s r9 �execute_context�security_issuec C s4 |j r| j�t|j jp d|j jd�� d| _d S d S )Nzunexpected-error)r. r/ �error)rB r7 �appendr- �coder> r5 )r@ rA r! r! r" � _handle_error� s �� �rE �warningc C s> | j �t|jt|jj�dd� |jjD �d�� tj j j | _d S )Nc S s g | ]}t |d ��qS ))r )r) ��.0�pkgr! r! r" � <listcomp>� s �z4_handle_security_issue_not_fixed.<locals>.<listcomp>r1 ) r7 rC r- � warning_typer �datar5 �source_packagesr �SYSTEM_STILL_VULNERABLEr= r> �r@ rF r! r! r" � _handle_security_issue_not_fixed� s ��� rP c C sN | j �t|jtjj|jj|jj d�t |jj|jj d�gd�� t j jj| _d S )N)�packager r, r1 )r7 rC r- rK r �FIX_CANNOT_INSTALL_PACKAGE�formatrL �binary_package�binary_package_versionr) r r rN r= r> r5 rO r! r! r" �#_handle_package_cannot_be_installed� s �����rV �stepc s@ | j �tdtj� fdd�� jjD �d�� d| _tj j j | _ d S )Nzfix-requires-attachc � g | ] }t |� jjd ��qS �r, )r) rL �required_servicerG �rW r! r" rJ � � ��z"_handle_attach.<locals>.<listcomp>r1 T) r7 rC r- r �*SECURITY_UPDATE_NOT_INSTALLED_SUBSCRIPTIONrL rM r; r rN r= r> r5 �r@ rW r! r[ r" �_handle_attach� s ��� r_ c sV | j rd S | j�tdtjj� jjd�� fdd�� jj D �d�� d| _ t j j j| _d S )Nzfix-requires-enable)�servicec rX rY )r) rL r` rG r[ r! r" rJ � r\ z"_handle_enable.<locals>.<listcomp>r1 T)r; r7 rC r- r �SECURITY_SERVICE_DISABLEDrS rL r` rM r: r rN r= r> r5 r^ r! r[ r" �_handle_enable� s � ��� rb c s& | j s| jrd S � jjsd S t�� s,| j�tdt j � fdd�� jj D �d�� d| _ d S z1t �� t jg d�� jj ddid � � jjD ]}t �|�}|rZ| j�t||� jjd �� qDW d S ty� } z)t|d t|��}tjjj| _ | j�td |� fd d�� jj D �d�� W Y d }~d S d }~ww )Nzfix-require-rootc rX rY �r) rL r rG r[ r! r" rJ � r\ z'_handle_apt_upgrade.<locals>.<listcomp>r1 rB )zapt-get�installz--only-upgradez-y�DEBIAN_FRONTEND�noninteractive)�cmd�override_env_varsr r> zfix-error-installing-pkgc rX rY rc rG r[ r! r" rJ r\ )r; r: rL �binary_packagesr �we_are_currently_rootr7 rC r- r �SECURITY_APT_NON_ROOTrM r5 r �run_apt_update_command�run_apt_command�get_pkg_versionr? r r � Exception�getattrr( r rN r= r> )r@ rW rI � pkg_version�er> r! r[ r" �_handle_apt_upgrade� sd ��� �� ���� �����rs c C s$ |j jtjjkrtjjj| _d S d S r )rL r5 r � NOT_AFFECTEDr= r �SYSTEM_NOT_AFFECTEDr> r^ r! r! r" � _handle_noop s �rv �returnc C s� t � }| jr t|| � | jr)| jD ]}t|t�r t||� qt|t�r(t||� q| j r]| j D ]-}t|t �r<t ||� q/t|t �rGt ||� q/t|t�rRt||� q/t|t�r\t||� q/t| j| j|j|j|jsmd d�S |jd�S )Nr8 )r9 rB rE �warnings� isinstancer rP r rV �planr r_ r rb r rs r rv r2 r3 r4 r5 r? r7 )rA r@ rF rW r! r! r" � _execute_fix s< � ���r{ N)%�typingr r �uaclientr r r �'uaclient.api.u.pro.security.fix._commonr r �/uaclient.api.u.pro.security.fix._common.plan.v1r r r r r r r r �uaclient.data_typesr r r r r r) r- r2 r9 rE rP rV r_ rb rs rv r{ r! r! r! r" �<module> sD ( ' � � � �� �� �: pro/security/fix/_common/execute/__init__.py 0000644 00000000000 15030103444 0015163 0 ustar 00 pro/security/fix/_common/__init__.py 0000644 00000064315 15030103444 0013544 0 ustar 00 import copy import enum import socket from collections import defaultdict from typing import Any, Dict, List, NamedTuple, Optional, Tuple from uaclient import apt, exceptions, livepatch, messages, system, util from uaclient.http import serviceclient CVE_OR_USN_REGEX = ( r"((CVE|cve)-\d{4}-\d{4,7}$|(USN|usn|LSN|lsn)-\d{1,5}-\d{1,2}$)" ) API_V1_CVES = "cves.json" API_V1_CVE_TMPL = "cves/{cve}.json" API_V1_NOTICES = "notices.json" API_V1_NOTICE_TMPL = "notices/{notice}.json" STANDARD_UPDATES_POCKET = "standard-updates" ESM_INFRA_POCKET = "esm-infra" ESM_APPS_POCKET = "esm-apps" BinaryPackageFix = NamedTuple( "BinaryPackageFix", [ ("source_pkg", str), ("binary_pkg", str), ("fixed_version", str), ], ) UnfixedPackage = NamedTuple( "UnfixedPackage", [ ("pkg", str), ("unfixed_reason", str), ], ) class FixStatus(enum.Enum): """ An enum to represent the system status after fix operation """ class _Value: def __init__(self, value: int, msg: str): self.value = value self.msg = msg SYSTEM_NON_VULNERABLE = _Value(0, "fixed") SYSTEM_NOT_AFFECTED = _Value(0, "not-affected") SYSTEM_STILL_VULNERABLE = _Value(1, "still-affected") SYSTEM_VULNERABLE_UNTIL_REBOOT = _Value(2, "affected-until-reboot") @property def exit_code(self): return self.value.value def __str__(self): return self.value.msg class UASecurityClient(serviceclient.UAServiceClient): url_timeout = 20 cfg_url_base_attr = "security_url" def _get_query_params( self, query_params: Dict[str, Any] ) -> Dict[str, Any]: """ Update query params with data from feature config. """ extra_security_params = self.cfg.cfg.get("features", {}).get( "extra_security_params", {} ) if query_params: query_params.update(extra_security_params) return query_params return extra_security_params @util.retry(socket.timeout, retry_sleeps=[1, 3, 5]) def request_url( self, path, data=None, headers=None, method=None, query_params=None ): query_params = self._get_query_params(query_params) return super().request_url( path=path, data=data, headers=headers, method=method, query_params=query_params, log_response_body=False, ) def get_cves( self, query: Optional[str] = None, priority: Optional[str] = None, package: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, component: Optional[str] = None, version: Optional[str] = None, status: Optional[List[str]] = None, ) -> List["CVE"]: """Query to match multiple-CVEs. @return: List of CVE instances based on the the JSON response. """ query_params = { "q": query, "priority": priority, "package": package, "limit": limit, "offset": offset, "component": component, "version": version, "status": status, } response = self.request_url(API_V1_CVES, query_params=query_params) if response.code != 200: raise exceptions.SecurityAPIError( url=API_V1_CVES, code=response.code, body=response.body ) return [ CVE(client=self, response=cve_md) for cve_md in response.json_list ] def get_cve(self, cve_id: str) -> "CVE": """Query to match single-CVE. @return: CVE instance for JSON response from the Security API. """ url = API_V1_CVE_TMPL.format(cve=cve_id) response = self.request_url(url) if response.code != 200: raise exceptions.SecurityAPIError( url=url, code=response.code, body=response.body ) return CVE(client=self, response=response.json_dict) def get_notices( self, cves: Optional[str] = None, release: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, order: Optional[str] = None, ) -> List["USN"]: """Query to match multiple-USNs. @return: Sorted list of USN instances based on the the JSON response. """ query_params = { "cves": cves, "release": release, "limit": limit, "offset": offset, "order": order, } response = self.request_url(API_V1_NOTICES, query_params=query_params) if response.code != 200: raise exceptions.SecurityAPIError( url=API_V1_NOTICES, code=response.code, body=response.body ) return sorted( [ USN(client=self, response=usn_md) for usn_md in response.json_dict.get("notices", []) if (cves is None or cves in usn_md.get("cves_ids", [])) and usn_md.get("id", "").startswith("USN-") ], key=lambda x: x.id, ) def get_notice(self, notice_id: str) -> "USN": """Query to match single-USN. @return: USN instance representing the JSON response. """ url = API_V1_NOTICE_TMPL.format(notice=notice_id) response = self.request_url(url) if response.code != 200: raise exceptions.SecurityAPIError( url=url, code=response.code, body=response.body ) return USN(client=self, response=response.json_dict) # Model for Security API responses class CVEPackageStatus: """Class representing specific CVE PackageStatus on an Ubuntu series""" def __init__(self, cve_response: Dict[str, Any]): self.response = cve_response @property def description(self): return self.response["description"] @property def fixed_version(self): return self.description @property def pocket(self): return self.response["pocket"] @property def release_codename(self): return self.response["release_codename"] @property def status(self): return self.response["status"] @property def status_message(self): if self.status == "needed": return messages.SECURITY_CVE_STATUS_NEEDED elif self.status == "needs-triage": return messages.SECURITY_CVE_STATUS_TRIAGE elif self.status == "pending": return messages.SECURITY_CVE_STATUS_PENDING elif self.status in ("ignored", "deferred"): return messages.SECURITY_CVE_STATUS_IGNORED elif self.status == "DNE": return messages.SECURITY_CVE_STATUS_DNE elif self.status == "not-affected": return messages.SECURITY_CVE_STATUS_NOT_AFFECTED elif self.status == "released": return messages.SECURITY_FIX_RELEASE_STREAM.format( fix_stream=self.pocket_source ) return messages.SECURITY_CVE_STATUS_UNKNOWN.format(status=self.status) @property def requires_ua(self) -> bool: """Return True if the package requires an active Pro subscription.""" return bool( self.pocket_source != messages.SECURITY_UBUNTU_STANDARD_UPDATES_POCKET ) @property def pocket_source(self): """Human-readable string representing where the fix is published.""" if self.pocket == "esm-infra": fix_source = messages.SECURITY_UA_INFRA_POCKET elif self.pocket == "esm-apps": fix_source = messages.SECURITY_UA_APPS_POCKET elif self.pocket in ("updates", "security"): fix_source = messages.SECURITY_UBUNTU_STANDARD_UPDATES_POCKET else: # TODO(GH: #1376 drop this when esm* pockets supplied by API) if "esm" in self.fixed_version: fix_source = messages.SECURITY_UA_INFRA_POCKET else: fix_source = messages.SECURITY_UBUNTU_STANDARD_UPDATES_POCKET return fix_source class CVE: """Class representing CVE response from the SecurityClient""" def __init__(self, client: UASecurityClient, response: Dict[str, Any]): self.response = response self.client = client def __eq__(self, other) -> bool: if not isinstance(other, CVE): return False return self.response == other.response @property def id(self): return self.response.get("id", "UNKNOWN_CVE_ID").upper() @property def notices_ids(self) -> List[str]: return self.response.get("notices_ids", []) @property def notices(self) -> List["USN"]: """Return a list of USN instances from API response 'notices'. Cache the value to avoid extra work on multiple calls. """ if not hasattr(self, "_notices"): self._notices = sorted( [ USN(self.client, notice) for notice in self.response.get("notices", []) if notice and notice.get("id", "").startswith("USN-") ], key=lambda n: n.id, reverse=True, ) return self._notices @property def description(self): return self.response.get("description") @property def packages_status(self) -> Dict[str, CVEPackageStatus]: """Dict of package status dicts for the current Ubuntu series. Top-level keys are source packages names and each value is a CVEPackageStatus object """ if hasattr(self, "_packages_status"): return self._packages_status # type: ignore self._packages_status = {} series = system.get_release_info().series for package in self.response["packages"]: for pkg_status in package["statuses"]: if pkg_status["release_codename"] == series: self._packages_status[package["name"]] = CVEPackageStatus( pkg_status ) return self._packages_status class USN: """Class representing USN response from the SecurityClient""" def __init__(self, client: UASecurityClient, response: Dict[str, Any]): self.response = response self.client = client def __eq__(self, other) -> bool: if not isinstance(other, USN): return False return self.response == other.response @property def id(self) -> str: return self.response.get("id", "UNKNOWN_USN_ID").upper() @property def cves_ids(self) -> List[str]: """List of CVE IDs related to this USN.""" return self.response.get("cves_ids", []) @property def cves(self) -> List[CVE]: """List of CVE instances based on API response 'cves' key. Cache the values to avoid extra work for multiple call-sites. """ if not hasattr(self, "_cves"): self._cves = sorted( [ CVE(self.client, cve) for cve in self.response.get("cves", []) ], key=lambda n: n.id, reverse=True, ) # type: List[CVE] return self._cves @property def title(self): return self.response.get("title") @property def references(self): return self.response.get("references") @property def release_packages(self) -> Dict[str, Dict[str, Dict[str, str]]]: """Binary package information available for this release. Reformat the USN.release_packages response to key it based on source package name and related binary package names. :return: Dict keyed by source package name. The second-level key will be binary package names generated from that source package and the values will be the dict response from USN.release_packages for that binary package. The binary metadata contains the following keys: name, version. Optional additional keys: pocket and component. """ if hasattr(self, "_release_packages"): return self._release_packages series = system.get_release_info().series self._release_packages = {} # type: Dict[str, Dict[str, Any]] # Organize source and binary packages under a common source package key for pkg in self.response.get("release_packages", {}).get(series, []): if pkg.get("is_source"): # Create a "source" key under src_pkg_name with API response if pkg["name"] in self._release_packages: if "source" in self._release_packages[pkg["name"]]: raise exceptions.SecurityAPIMetadataError( error_msg=( "{usn} metadata defines duplicate source" " packages {pkg}" ).format(usn=self.id, pkg=pkg["name"]), issue=self.id, extra_info="", ) self._release_packages[pkg["name"]]["source"] = pkg else: self._release_packages[pkg["name"]] = {"source": pkg} else: # is_source == False or None, then this is a binary package. # If processed before a source item, the top-level key will # not exist yet. # TODO(GH: 1465: determine if this is expected on kern pkgs) if not pkg.get("source_link"): raise exceptions.SecurityAPIMetadataError( error_msg=( "{issue} metadata does not define release_packages" " source_link for {bin_pkg}." ).format(issue=self.id, bin_pkg=pkg["name"]), issue=self.id, extra_info="", ) elif "/" not in pkg["source_link"]: raise exceptions.SecurityAPIMetadataError( error_msg=( "{issue} metadata has unexpected release_packages" " source_link value for {bin_pkg}: {link}" ).format( issue=self.id, bin_pkg=pkg["name"], link=pkg["source_link"], ), issue=self.id, extra_info="", ) source_pkg_name = pkg["source_link"].split("/")[-1] if source_pkg_name not in self._release_packages: self._release_packages[source_pkg_name] = {} self._release_packages[source_pkg_name][pkg["name"]] = pkg return self._release_packages def get_cve_affected_source_packages_status( cve: CVE, installed_packages: Dict[str, Dict[str, str]] ) -> Dict[str, CVEPackageStatus]: """Get a dict of any CVEPackageStatuses affecting this Ubuntu release. :return: Dict of active CVEPackageStatus keyed by source package names. """ affected_pkg_versions = {} for source_pkg, package_status in cve.packages_status.items(): if package_status.status == "not-affected": continue if source_pkg in installed_packages: affected_pkg_versions[source_pkg] = package_status return affected_pkg_versions def query_installed_source_pkg_versions() -> Dict[str, Dict[str, str]]: """Return a dict of all source packages installed on the system. The dict keys will be source package name: "krb5". The value will be a dict with keys binary_pkg and version. """ status_field = "${db:Status-Status}" out, _err = system.subp( [ "dpkg-query", "-f=${Package},${Source},${Version}," + status_field + "\n", "-W", ] ) installed_packages = {} # type: Dict[str, Dict[str, str]] for pkg_line in out.splitlines(): pkg_name, source_pkg_name, pkg_version, status = pkg_line.split(",") if not source_pkg_name: # some package don't define the Source source_pkg_name = pkg_name if "installed" not in status: continue if source_pkg_name in installed_packages: installed_packages[source_pkg_name][pkg_name] = pkg_version else: installed_packages[source_pkg_name] = {pkg_name: pkg_version} return installed_packages def get_related_usns(usn, client): """For a give usn, get the related USNs for it. For each CVE associated with the given USN, we capture other USNs that are related to the CVE. We consider those USNs related to the original USN. """ # If the usn does not have any associated cves on it, # we cannot establish a relation between USNs if not usn.cves: return [] related_usns = {} for cve in usn.cves: for related_usn_id in cve.notices_ids: # We should ignore any other item that is not a USN # For example, LSNs if not related_usn_id.startswith("USN-"): continue if related_usn_id == usn.id: continue if related_usn_id not in related_usns: related_usns[related_usn_id] = client.get_notice( notice_id=related_usn_id ) return list(sorted(related_usns.values(), key=lambda x: x.id)) def get_affected_packages_from_cves(cves, installed_packages): affected_pkgs = {} # type: Dict[str, CVEPackageStatus] for cve in cves: for pkg_name, pkg_status in get_cve_affected_source_packages_status( cve, installed_packages ).items(): if pkg_name not in affected_pkgs: affected_pkgs[pkg_name] = pkg_status else: current_ver = affected_pkgs[pkg_name].fixed_version if ( apt.version_compare(current_ver, pkg_status.fixed_version) > 0 ): affected_pkgs[pkg_name] = pkg_status return affected_pkgs def get_affected_packages_from_usn(usn, installed_packages): affected_pkgs = {} # type: Dict[str, CVEPackageStatus] for pkg_name, pkg_info in usn.release_packages.items(): if pkg_name not in installed_packages: continue cve_response = defaultdict(str) cve_response["status"] = "released" # Here we are assuming that the pocket will be the same one across # all the different binary packages. all_pockets = { pkg_bin_info["pocket"] for _, pkg_bin_info in pkg_info.items() if pkg_bin_info.get("pocket") } if not all_pockets: raise exceptions.SecurityAPIMetadataError( error_msg=( "{} metadata defines no pocket information for " "any release packages." ).format(usn.id), issue=usn.id, extra_info="", ) cve_response["pocket"] = all_pockets.pop() affected_pkgs[pkg_name] = CVEPackageStatus(cve_response=cve_response) return affected_pkgs def get_usn_affected_packages_status( usn: USN, installed_packages: Dict[str, Dict[str, str]] ) -> Dict[str, CVEPackageStatus]: """Walk CVEs related to a USN and return a dict of all affected packages. :return: Dict keyed on source package name, with active CVEPackageStatus for the current Ubuntu release. """ if usn.cves: return get_affected_packages_from_cves(usn.cves, installed_packages) else: return get_affected_packages_from_usn(usn, installed_packages) def override_usn_release_package_status( pkg_status: CVEPackageStatus, usn_src_released_pkgs: Dict[str, Dict[str, str]], ) -> CVEPackageStatus: """Parse release status based on both pkg_status and USN.release_packages. Since some source packages in universe are not represented in CVEPackageStatus, rely on presence of such source packages in usn_src_released_pkgs to represent package as a "released" status. :param pkg_status: the CVEPackageStatus for this source package. :param usn_src_released_pkgs: The USN.release_packages representing only this source package. Normally, release_packages would have data on multiple source packages. :return: Tuple of: human-readable status message, boolean whether released, boolean whether the fix requires access to UA """ usn_pkg_status = copy.deepcopy(pkg_status) if usn_src_released_pkgs and usn_src_released_pkgs.get("source"): usn_pkg_status.response["status"] = "released" usn_pkg_status.response["description"] = usn_src_released_pkgs[ "source" ]["version"] for pkg_name, usn_released_pkg in usn_src_released_pkgs.items(): # Copy the pocket from any valid binary package pocket = usn_released_pkg.get("pocket") if pocket: usn_pkg_status.response["pocket"] = pocket break return usn_pkg_status def group_by_usn_package_status(affected_pkg_status, usn_released_pkgs): status_groups = {} # type: Dict[str, List[Tuple[str, CVEPackageStatus]]] for src_pkg, pkg_status in sorted(affected_pkg_status.items()): usn_released_src = usn_released_pkgs.get(src_pkg, {}) usn_pkg_status = override_usn_release_package_status( pkg_status, usn_released_src ) status_group = usn_pkg_status.status.replace("ignored", "deferred") if status_group not in status_groups: status_groups[status_group] = [] status_groups[status_group].append((src_pkg, usn_pkg_status)) return status_groups def merge_usn_released_binary_package_versions( usns: List[USN], beta_pockets: Dict[str, bool] ) -> Dict[str, Dict[str, Dict[str, str]]]: """Walk related USNs, merging the released binary package versions. For each USN, iterate over release_packages to collect released binary package names and required fix version. If multiple related USNs require different version fixes to the same binary package, track the maximum version required across all USNs. :param usns: List of USN response instances from which to calculate merge. :param beta_pockets: Dict keyed on service name: esm-infra, esm-apps the values of which will be true of USN response instances from which to calculate merge. :return: Dict keyed by source package name. Under each source package will be a dict with binary package name as keys and binary package metadata as the value. """ usn_pkg_versions = {} for usn in usns: # Aggregate USN.release_package binary versions into usn_pkg_versions for src_pkg, binary_pkg_versions in usn.release_packages.items(): public_bin_pkg_versions = { bin_pkg_name: bin_pkg_md for bin_pkg_name, bin_pkg_md in binary_pkg_versions.items() if False is beta_pockets.get(bin_pkg_md.get("pocket", "None"), False) } if src_pkg not in usn_pkg_versions and public_bin_pkg_versions: usn_pkg_versions[src_pkg] = public_bin_pkg_versions elif src_pkg in usn_pkg_versions: # Since src_pkg exists, only record this USN's binary version # when it is greater than the previous version in usn_src_pkg. usn_src_pkg = usn_pkg_versions[src_pkg] for bin_pkg, binary_pkg_md in public_bin_pkg_versions.items(): if bin_pkg not in usn_src_pkg: usn_src_pkg[bin_pkg] = binary_pkg_md else: prev_version = usn_src_pkg[bin_pkg]["version"] current_version = binary_pkg_md["version"] if ( apt.version_compare(current_version, prev_version) > 0 ): # binary_version is greater than prev_version usn_src_pkg[bin_pkg] = binary_pkg_md return usn_pkg_versions def _check_cve_fixed_by_livepatch( issue_id: str, ) -> Tuple[Optional[FixStatus], Optional[str]]: # Check livepatch status for CVE in fixes before checking CVE api lp_status = livepatch.status() if ( lp_status is not None and lp_status.livepatch is not None and lp_status.livepatch.fixes is not None ): for fix in lp_status.livepatch.fixes: if fix.name == issue_id.lower() and fix.patched: version = lp_status.livepatch.version or "N/A" return (FixStatus.SYSTEM_NON_VULNERABLE, version) return (None, None) def status_message(status, pocket_source: Optional[str] = None): if status == "needed": return messages.SECURITY_CVE_STATUS_NEEDED elif status == "needs-triage": return messages.SECURITY_CVE_STATUS_TRIAGE elif status == "pending": return messages.SECURITY_CVE_STATUS_PENDING elif status in ("ignored", "deferred"): return messages.SECURITY_CVE_STATUS_IGNORED elif status == "DNE": return messages.SECURITY_CVE_STATUS_DNE elif status == "not-affected": return messages.SECURITY_CVE_STATUS_NOT_AFFECTED elif status == "released" and pocket_source: return messages.SECURITY_FIX_RELEASE_STREAM.format( fix_stream=pocket_source ) return messages.SECURITY_CVE_STATUS_UNKNOWN.format(status=status) def get_expected_overall_status( current_fix_status: str, fix_status: str ) -> str: if not current_fix_status: return fix_status if fix_status in ( FixStatus.SYSTEM_NON_VULNERABLE.value.msg, FixStatus.SYSTEM_NOT_AFFECTED.value.msg, ): if ( current_fix_status == FixStatus.SYSTEM_NOT_AFFECTED.value.msg and current_fix_status != fix_status ): return fix_status else: return current_fix_status else: # This means the system is still affected and we must # priotize this as the global state return fix_status pro/security/fix/usn/__pycache__/__init__.cpython-310.pyc 0000644 00000000253 15030103444 0017250 0 ustar 00 o �ϴf � @ s d S )N� r r r �N/usr/lib/python3/dist-packages/uaclient/api/u/pro/security/fix/usn/__init__.py�<module> s pro/security/fix/usn/plan/v1.py 0000644 00000011360 15030103444 0012433 0 ustar 00 from typing import List from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo from uaclient.api.u.pro.security.fix._common import get_expected_overall_status # Some of these imports are intentionally not used in this module. # The rationale is that we want users to import such Data Objects # directly from the associated endpoints and not through the _common module from uaclient.api.u.pro.security.fix._common.plan.v1 import ( # noqa: F401 AdditionalData, AptUpgradeData, AttachData, EnableData, FixPlanError, FixPlanResult, FixPlanStep, FixPlanUSNResult, FixPlanWarning, NoOpAlreadyFixedData, NoOpData, PackageCannotBeInstalledData, SecurityIssueNotFixedData, USNAdditionalData, fix_plan_usn, ) from uaclient.config import UAConfig from uaclient.data_types import DataObject, Field, StringDataValue, data_list class USNFixPlanOptions(DataObject): fields = [ Field( "usns", data_list(StringDataValue), doc="A list of USNs (i.e. USN-6119-1) titles", ), ] def __init__(self, usns: List[str]): self.usns = usns class USNFixPlanResult(DataObject): fields = [ Field( "expected_status", StringDataValue, doc="The expected status of fixing the USNs", ), Field( "usns", data_list(FixPlanUSNResult), doc="A list of ``FixPlanUSNResult`` objects", ), ] def __init__(self, *, expected_status: str, usns: List[FixPlanUSNResult]): self.expected_status = expected_status self.usns = usns class USNSFixPlanResult(DataObject, AdditionalInfo): fields = [ Field( "usns_data", USNFixPlanResult, doc="A list of ``USNFixPlanResult`` objects", ), ] def __init__(self, *, usns_data: USNFixPlanResult): self.usns_data = usns_data def plan(options: USNFixPlanOptions) -> USNSFixPlanResult: return _plan(options, UAConfig()) def _plan(options: USNFixPlanOptions, cfg: UAConfig) -> USNSFixPlanResult: """ This endpoint shows the necessary steps required to fix USNs in the system without executing any of those steps. """ usns = [] # type: List[FixPlanUSNResult] expected_status = "" for usn in options.usns: usn_plan = fix_plan_usn(usn, cfg=cfg) expected_status = get_expected_overall_status( expected_status, usn_plan.target_usn_plan.expected_status ) usns.append(usn_plan) return USNSFixPlanResult( usns_data=USNFixPlanResult( expected_status=expected_status, usns=usns, ) ) endpoint = APIEndpoint( version="v1", name="USNFixPlan", fn=_plan, options_cls=USNFixPlanOptions, ) _doc = { "introduced_in": "29", "requires_network": True, "example_python": """ from uaclient.api.u.pro.security.fix.usn.plan.v1 import plan, USNFixPlanOptions options = USNFixPlanOptions(cves=["USN-1234-1", "USN-1235-1"]) result = plan(options) """, # noqa: E501 "result_class": USNSFixPlanResult, "ignore_result_classes": [DataObject, AdditionalData], "extra_result_classes": [ USNAdditionalData, AptUpgradeData, AttachData, EnableData, NoOpData, NoOpAlreadyFixedData, PackageCannotBeInstalledData, SecurityIssueNotFixedData, ], "exceptions": [], "example_cli": """pro api u.pro.security.fix.usn.plan.v1 --data '{"usns": ["USN-1234-1", "USN-1235-1"]}'""", # noqa: E501 "example_json": """ { "usns_data": { "expected_status": "fixed", "usns": [ { "related_usns_plan": [], "target_usn_plan": { "title": "USN-1234-5", "expected_status": "fixed", "plan": [ { "operation": "apt-upgrade", "order": 1, "data": { "binary_packages": ["pkg1"], "source_packages": ["pkg1"], "pocket": "standard-updates" } } ], "warnings": [], "error": null, "additional_data": { "associated_cves": [ "CVE-1234-56789" ], "associated_launchpad_bus": [ "https://launchpad.net/bugs/BUG_ID" ] } }, } ] } } """, } pro/security/fix/usn/plan/__pycache__/__init__.cpython-310.pyc 0000644 00000000260 15030103444 0020200 0 ustar 00 o �ϴf � @ s d S )N� r r r �S/usr/lib/python3/dist-packages/uaclient/api/u/pro/security/fix/usn/plan/__init__.py�<module> s pro/security/fix/usn/plan/__pycache__/v1.cpython-310.pyc 0000644 00000011116 15030103444 0016771 0 ustar 00 o �(�f� � @ s2 d dl mZ d dlmZ d dlmZ d dlmZ d dlm Z m Z m Z m Z m Z mZmZmZmZmZmZmZmZmZmZ d dlmZ d dlmZm Z m Z m Z G dd � d e�Z G d d � d e�Z G d d � d ee�Z!de de!fdd�Z"de dede!fdd�Z#edde#e d�Z$ddde!ee gee e e eeeegg dd d � Z%d S ) � )�List)� APIEndpoint)�AdditionalInfo)�get_expected_overall_status)�AdditionalData�AptUpgradeData� AttachData� EnableData� FixPlanError� FixPlanResult� FixPlanStep�FixPlanUSNResult�FixPlanWarning�NoOpAlreadyFixedData�NoOpData� PackageCannotBeInstalledData�SecurityIssueNotFixedData�USNAdditionalData� fix_plan_usn)�UAConfig)� DataObject�Field�StringDataValue� data_listc @ s2 e Zd Zedee�dd�gZdee fdd�Z dS )�USNFixPlanOptions�usnsz'A list of USNs (i.e. USN-6119-1) titles��docc C � || _ d S �N)r )�selfr � r! �M/usr/lib/python3/dist-packages/uaclient/api/u/pro/security/fix/usn/plan/v1.py�__init__( � zUSNFixPlanOptions.__init__N) �__name__� __module__� __qualname__r r r �fieldsr �strr# r! r! r! r" r s ��r c @ sB e Zd Zededd�edee�dd�gZdede e fdd�Z dS ) �USNFixPlanResult�expected_statusz&The expected status of fixing the USNsr r z&A list of ``FixPlanUSNResult`` objectsc C s || _ || _d S r �r+ r )r r+ r r! r! r" r# : s zUSNFixPlanResult.__init__N) r% r& r' r r r r r( r) r r# r! r! r! r" r* , s ��� r* c @ s* e Zd Zededd�gZdefdd�ZdS )�USNSFixPlanResult� usns_dataz&A list of ``USNFixPlanResult`` objectsr c C r r �r. )r r. r! r! r" r# H r$ zUSNSFixPlanResult.__init__N)r% r& r' r r* r( r# r! r! r! r" r- ? s ��r- �options�returnc C s t | t� �S r )�_planr )r0 r! r! r" �planL s r3 �cfgc C sJ g }d}| j D ]}t||d�}t||jj�}|�|� qtt||d�d�S )z~ This endpoint shows the necessary steps required to fix USNs in the system without executing any of those steps. � )r4 r, r/ )r r r �target_usn_planr+ �appendr- r* )r0 r4 r r+ �usn�usn_planr! r! r" r2 P s � ��r2 �v1� USNFixPlan)�version�name�fn� options_cls�29Tz� from uaclient.api.u.pro.security.fix.usn.plan.v1 import plan, USNFixPlanOptions options = USNFixPlanOptions(cves=["USN-1234-1", "USN-1235-1"]) result = plan(options) zVpro api u.pro.security.fix.usn.plan.v1 --data '{"usns": ["USN-1234-1", "USN-1235-1"]}'a� { "usns_data": { "expected_status": "fixed", "usns": [ { "related_usns_plan": [], "target_usn_plan": { "title": "USN-1234-5", "expected_status": "fixed", "plan": [ { "operation": "apt-upgrade", "order": 1, "data": { "binary_packages": ["pkg1"], "source_packages": ["pkg1"], "pocket": "standard-updates" } } ], "warnings": [], "error": null, "additional_data": { "associated_cves": [ "CVE-1234-56789" ], "associated_launchpad_bus": [ "https://launchpad.net/bugs/BUG_ID" ] } }, } ] } } ) � introduced_in�requires_network�example_python� result_class�ignore_result_classes�extra_result_classes� exceptions� example_cli� example_jsonN)&�typingr �uaclient.api.apir �uaclient.api.data_typesr �'uaclient.api.u.pro.security.fix._commonr �/uaclient.api.u.pro.security.fix._common.plan.v1r r r r r r r r r r r r r r r �uaclient.configr �uaclient.data_typesr r r r r r* r- r3 r2 �endpoint�_docr! r! r! r" �<module> sH D �� � pro/security/fix/usn/plan/__init__.py 0000644 00000000000 15030103444 0013631 0 ustar 00 pro/security/fix/usn/execute/v1.py 0000644 00000021235 15030103444 0013145 0 ustar 00 from typing import List, Optional from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo from uaclient.api.u.pro.security.fix._common import ( FixStatus, get_expected_overall_status, ) # Some of these imports are intentionally not used in this module. # The rationale is that we want users to import such Data Objects # directly from the associated endpoints and not through the _common module from uaclient.api.u.pro.security.fix._common.execute.v1 import ( # noqa: F401 FailedUpgrade, FixExecuteError, FixExecuteResult, UpgradedPackage, _execute_fix, ) from uaclient.api.u.pro.security.fix.usn.plan.v1 import ( USNFixPlanOptions, _plan, ) from uaclient.config import UAConfig from uaclient.data_types import DataObject, Field, StringDataValue, data_list class USNFixExecuteOptions(DataObject): fields = [ Field( "usns", data_list(StringDataValue), doc="A list of USNs (i.e. USN-6188-1) titles", ), ] def __init__(self, usns: List[str]): self.usns = usns class FixExecuteUSNResult(DataObject): fields = [ Field( "target_usn", FixExecuteResult, doc="The ``FixExecuteResult`` for the target USN", ), Field( "related_usns", data_list(FixExecuteResult), required=False, doc="A list of ``FixExecuteResult`` objects for the related USNs", ), ] def __init__( self, target_usn: FixExecuteResult, related_usns: Optional[List[FixExecuteResult]] = None, ): self.target_usn = target_usn self.related_usns = related_usns class USNAPIFixExecuteResult(DataObject): fields = [ Field("status", StringDataValue, doc="The status of fixing the USNs"), Field( "usns", data_list(FixExecuteUSNResult), doc="A list of ``FixExecuteUSNResult`` objects", ), ] def __init__(self, status: str, usns: List[FixExecuteUSNResult]): self.status = status self.usns = usns class USNSAPIFixExecuteResult(DataObject, AdditionalInfo): fields = [ Field( "usns_data", USNAPIFixExecuteResult, doc="A list of ``USNAPIFixExecuteResult`` objects", ) ] def __init__(self, usns_data: USNAPIFixExecuteResult): self.usns_data = usns_data def execute(options: USNFixExecuteOptions) -> USNSAPIFixExecuteResult: return _execute(options, UAConfig()) def _execute( options: USNFixExecuteOptions, cfg: UAConfig ) -> USNSAPIFixExecuteResult: """ This endpoint fixes the specified USNs on the machine. """ fix_plan = _plan(USNFixPlanOptions(usns=options.usns), cfg=cfg) usns_result = [] # type: List[FixExecuteUSNResult] all_usns_status = FixStatus.SYSTEM_NOT_AFFECTED.value.msg for usn in fix_plan.usns_data.usns: target_usn_result = _execute_fix(usn.target_usn_plan) all_usns_status = get_expected_overall_status( all_usns_status, target_usn_result.status ) usn_fix_execute_result = FixExecuteUSNResult( target_usn=target_usn_result ) if ( target_usn_result.status != FixStatus.SYSTEM_STILL_VULNERABLE.value.msg ): related_usns_result = [] # type: List[FixExecuteResult] for related_usn in usn.related_usns_plan: related_usns_result.append(_execute_fix(related_usn)) usn_fix_execute_result.related_usns = related_usns_result usns_result.append(usn_fix_execute_result) return USNSAPIFixExecuteResult( usns_data=USNAPIFixExecuteResult( status=all_usns_status, usns=usns_result ) ) endpoint = APIEndpoint( version="v1", name="USNFixExecute", fn=_execute, options_cls=USNFixExecuteOptions, ) _doc = { "introduced_in": "30", "requires_network": True, "example_python": """ from uaclient.api.u.pro.security.fix.usn.execute.v1 import execute, USNFixExecuteOptions options = USNFixExecuteOptions(usns=["USN-1234-1", "USN-1235-1"]) result = execute(options) """, # noqa: E501 "result_class": USNSAPIFixExecuteResult, "exceptions": [], "example_cli": """pro api u.pro.security.fix.usn.execute.v1 --data '{"usns": ["USN-1234-1", "USN-1235-1"]}'""", # noqa: E501 "example_json": """ { "usns_data": { "status": "fixed", "usns": [ { "target_usn": { "title": "CVE-1234-56789", "status": "fixed", "upgraded_packages": { "name": "pkg1", "version": "1.1", "pocket": "standard-updates" }, "error": null }, "related_usns": [] } ] } } """, "extra": """ .. tab-item:: Explanation :sync: explanation When using the USN endpoint, the expected output is as follows: .. code-block:: json { "usns_data": { "status": "fixed", "usns": [ { "target_usn": { "title": "CVE-1234-56789", "status": "fixed", "upgraded_packages": { "name": "pkg1", "version": "1.1", "pocket": "standard-updates" }, "error": null }, "related_usns": [] } ] } } From this output, we can see that the **usns_data** object contains two attributes: * **usns**: A list of USN objects detailing what happened during the fix operation. * **status**: The status of the fix operation considering **all** USNs. This means that if one USN cannot be fixed, this field will reflect that. Note that related USNs don't interfere with this attribute, meaning that a related USN can fail to be fixed without modifying the **status** value. Each **usn** object contains a reference for both **target_usn** and **related_usns**. The target is the USN requested to be fixed by the user, while related USNs are USNs that are related to the main USN and an attempt to fix them will be performed by the endpoint too. To better understand that distinction, please refer to :ref:`our explanation of CVEs and USNs <expl-cve-usn>`. With that said both **target_usn** object and any object from **related_usns** follow this structure: * **title**: The title of the USN. * **description**: The USN description. * **error**: Any error captured when fixing the USN will appear here. The error object will be detailed in a following section. * **status**: The expected status of the USN after the fix operation. There are three possible scenarios: **fixed**, **still-affected** and **not-affected**. The system is considered **still-affected** if there is something that prevents any required packages from being upgraded. The system is considered **not-affected** if the USN doesn't affect the system at all. * **upgraded_packages**: A list of UpgradedPackage objects referencing each package that was upgraded during the fix operation. The UpgradedPackage object always contain the **name** of the package, the **version** it was upgraded to and the **pocket** where the package upgrade came from. **What errors can be generated?** There some errors that can happen when executing this endpoint. For example, the system might require the user to attach to a Pro subscription to install the upgrades, or the user might run the command as non-root when a package upgrade is needed. In those situations, the error JSON error object will follow this representation: .. code-block:: json { "error_type": "error-type", "reason": "reason", "failed_upgrades": [ { "name": "pkg1", "pocket": "esm-infra" } ] } We can see that the representation has the following fields: * **error_type**: The error type * **reason**: The explanation of why the error happened * **failed_upgrade**: A list of objects that always contain the name of the package that was not upgraded and the pocket where the upgrade would have come from. """, } pro/security/fix/usn/execute/__pycache__/__init__.cpython-310.pyc 0000644 00000000263 15030103444 0020713 0 ustar 00 o �ϴf � @ s d S )N� r r r �V/usr/lib/python3/dist-packages/uaclient/api/u/pro/security/fix/usn/execute/__init__.py�<module> s pro/security/fix/usn/execute/__pycache__/v1.cpython-310.pyc 0000644 00000020537 15030103444 0017510 0 ustar 00 o �(�f�" � @ s d dl mZmZ d dlmZ d dlmZ d dlmZm Z d dl m Z m Z m Z mZmZ d dlmZmZ d dlmZ d dlmZmZmZmZ G d d � d e�ZG d d � d e�ZG d d� de�Z G dd� dee�Z dede fdd�Z dedede fdd�Z edde ed�Z dd d e g d d d d!�Z!d"S )#� )�List�Optional)� APIEndpoint)�AdditionalInfo)� FixStatus�get_expected_overall_status)� FailedUpgrade�FixExecuteError�FixExecuteResult�UpgradedPackage� _execute_fix)�USNFixPlanOptions�_plan)�UAConfig)� DataObject�Field�StringDataValue� data_listc @ s2 e Zd Zedee�dd�gZdee fdd�Z dS )�USNFixExecuteOptions�usnsz'A list of USNs (i.e. USN-6188-1) titles��docc C � || _ d S �N�r )�selfr � r �P/usr/lib/python3/dist-packages/uaclient/api/u/pro/security/fix/usn/execute/v1.py�__init__% � z USNFixExecuteOptions.__init__N) �__name__� __module__� __qualname__r r r �fieldsr �strr r r r r r s ��r c @ sL e Zd Zededd�edee�ddd�gZ d dedeee fd d �Z dS ) �FixExecuteUSNResult� target_usnz+The ``FixExecuteResult`` for the target USNr � related_usnsFz;A list of ``FixExecuteResult`` objects for the related USNs)�requiredr Nc C � || _ || _d S r )r& r' )r r& r' r r r r 8 s z FixExecuteUSNResult.__init__r ) r r! r" r r r r# r r r r r r r r% ) s& ����� �r% c @ sB e Zd Zededd�edee�dd�gZdede e fdd�Z dS ) �USNAPIFixExecuteResult�statusz The status of fixing the USNsr r z)A list of ``FixExecuteUSNResult`` objectsc C r) r �r+ r )r r+ r r r r r K s z USNAPIFixExecuteResult.__init__N) r r! r" r r r r% r# r$ r r r r r r r* A s �� r* c @ s* e Zd Zededd�gZdefdd�ZdS )�USNSAPIFixExecuteResult� usns_dataz,A list of ``USNAPIFixExecuteResult`` objectsr c C r r �r. )r r. r r r r Y r z USNSAPIFixExecuteResult.__init__N)r r! r" r r* r# r r r r r r- P s ��r- �options�returnc C s t | t� �S r )�_executer )r0 r r r �execute] s r3 �cfgc C s� t t| jd�|d�}g }tjjj}|jjD ]1}t|j �}t ||j �}t |d�}|j tj jjkrAg }|jD ] } |�t| �� q4||_|�|� qtt||d�d�S )z@ This endpoint fixes the specified USNs on the machine. r )r4 )r& r, r/ )r r r r �SYSTEM_NOT_AFFECTED�value�msgr. r �target_usn_planr r+ r% �SYSTEM_STILL_VULNERABLE�related_usns_plan�appendr' r- r* ) r0 r4 �fix_plan� usns_result�all_usns_status�usn�target_usn_result�usn_fix_execute_result�related_usns_result� related_usnr r r r2 a s0 ��� ��r2 �v1� USNFixExecute)�version�name�fn� options_cls�30Tz� from uaclient.api.u.pro.security.fix.usn.execute.v1 import execute, USNFixExecuteOptions options = USNFixExecuteOptions(usns=["USN-1234-1", "USN-1235-1"]) result = execute(options) zYpro api u.pro.security.fix.usn.execute.v1 --data '{"usns": ["USN-1234-1", "USN-1235-1"]}'a { "usns_data": { "status": "fixed", "usns": [ { "target_usn": { "title": "CVE-1234-56789", "status": "fixed", "upgraded_packages": { "name": "pkg1", "version": "1.1", "pocket": "standard-updates" }, "error": null }, "related_usns": [] } ] } } a� .. tab-item:: Explanation :sync: explanation When using the USN endpoint, the expected output is as follows: .. code-block:: json { "usns_data": { "status": "fixed", "usns": [ { "target_usn": { "title": "CVE-1234-56789", "status": "fixed", "upgraded_packages": { "name": "pkg1", "version": "1.1", "pocket": "standard-updates" }, "error": null }, "related_usns": [] } ] } } From this output, we can see that the **usns_data** object contains two attributes: * **usns**: A list of USN objects detailing what happened during the fix operation. * **status**: The status of the fix operation considering **all** USNs. This means that if one USN cannot be fixed, this field will reflect that. Note that related USNs don't interfere with this attribute, meaning that a related USN can fail to be fixed without modifying the **status** value. Each **usn** object contains a reference for both **target_usn** and **related_usns**. The target is the USN requested to be fixed by the user, while related USNs are USNs that are related to the main USN and an attempt to fix them will be performed by the endpoint too. To better understand that distinction, please refer to :ref:`our explanation of CVEs and USNs <expl-cve-usn>`. With that said both **target_usn** object and any object from **related_usns** follow this structure: * **title**: The title of the USN. * **description**: The USN description. * **error**: Any error captured when fixing the USN will appear here. The error object will be detailed in a following section. * **status**: The expected status of the USN after the fix operation. There are three possible scenarios: **fixed**, **still-affected** and **not-affected**. The system is considered **still-affected** if there is something that prevents any required packages from being upgraded. The system is considered **not-affected** if the USN doesn't affect the system at all. * **upgraded_packages**: A list of UpgradedPackage objects referencing each package that was upgraded during the fix operation. The UpgradedPackage object always contain the **name** of the package, the **version** it was upgraded to and the **pocket** where the package upgrade came from. **What errors can be generated?** There some errors that can happen when executing this endpoint. For example, the system might require the user to attach to a Pro subscription to install the upgrades, or the user might run the command as non-root when a package upgrade is needed. In those situations, the error JSON error object will follow this representation: .. code-block:: json { "error_type": "error-type", "reason": "reason", "failed_upgrades": [ { "name": "pkg1", "pocket": "esm-infra" } ] } We can see that the representation has the following fields: * **error_type**: The error type * **reason**: The explanation of why the error happened * **failed_upgrade**: A list of objects that always contain the name of the package that was not upgraded and the pocket where the upgrade would have come from. )� introduced_in�requires_network�example_python� result_class� exceptions� example_cli� example_json�extraN)"�typingr r �uaclient.api.apir �uaclient.api.data_typesr �'uaclient.api.u.pro.security.fix._commonr r �2uaclient.api.u.pro.security.fix._common.execute.v1r r r r r �+uaclient.api.u.pro.security.fix.usn.plan.v1r r �uaclient.configr �uaclient.data_typesr r r r r r% r* r- r3 r2 �endpoint�_docr r r r �<module> sF �� �)� � pro/security/fix/usn/execute/__init__.py 0000644 00000000000 15030103444 0014341 0 ustar 00 pro/security/fix/usn/__init__.py 0000644 00000000000 15030103444 0012677 0 ustar 00 pro/security/fix/__pycache__/__init__.cpython-310.pyc 0000644 00000000766 15030103444 0016454 0 ustar 00 o �ϴf� � @ s< d dl mZmZmZmZmZmZmZmZm Z m Z g d�Z dS )� ) �AptUpgradeData� AttachData� EnableData� FixPlanError� FixPlanResult� FixPlanStep�FixPlanWarning�NoOpData� PackageCannotBeInstalledData�SecurityIssueNotFixedDataN) �/uaclient.api.u.pro.security.fix._common.plan.v1r r r r r r r r r r �__all__� r r �J/usr/lib/python3/dist-packages/uaclient/api/u/pro/security/fix/__init__.py�<module> s 0 pro/security/fix/cve/__pycache__/__init__.cpython-310.pyc 0000644 00000000253 15030103444 0017220 0 ustar 00 o �ϴf � @ s d S )N� r r r �N/usr/lib/python3/dist-packages/uaclient/api/u/pro/security/fix/cve/__init__.py�<module> s pro/security/fix/cve/plan/v1.py 0000644 00000010370 15030103444 0012403 0 ustar 00 from typing import List from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo from uaclient.api.u.pro.security.fix._common import get_expected_overall_status # Some of these imports are intentionally not used in this module. # The rationale is that we want users to import such Data Objects # directly from the associated endpoints and not through the _common module from uaclient.api.u.pro.security.fix._common.plan.v1 import ( # noqa: F401 AptUpgradeData, AttachData, EnableData, FixPlanError, FixPlanResult, FixPlanStep, FixPlanWarning, NoOpAlreadyFixedData, NoOpData, NoOpLivepatchFixData, PackageCannotBeInstalledData, SecurityIssueNotFixedData, fix_plan_cve, ) from uaclient.config import UAConfig from uaclient.data_types import DataObject, Field, StringDataValue, data_list class CVEFixPlanOptions(DataObject): fields = [ Field( "cves", data_list(StringDataValue), doc="A list of CVE (i.e. CVE-2023-2650) titles", ), ] def __init__(self, cves: List[str]): self.cves = cves class CVEFixPlanResult(DataObject): fields = [ Field( "expected_status", StringDataValue, doc="The expected status of fixing the CVEs", ), Field( "cves", data_list(FixPlanResult), doc="A list of ``FixPlanResult`` objects", ), ] def __init__(self, *, expected_status: str, cves: List[FixPlanResult]): self.expected_status = expected_status self.cves = cves class CVESFixPlanResult(DataObject, AdditionalInfo): fields = [ Field( "cves_data", CVEFixPlanResult, doc="A list of ``CVEFixPlanResult`` objects", ), ] def __init__(self, *, cves_data: CVEFixPlanResult): self.cves_data = cves_data def plan(options: CVEFixPlanOptions) -> CVESFixPlanResult: return _plan(options, UAConfig()) def _plan(options: CVEFixPlanOptions, cfg: UAConfig) -> CVESFixPlanResult: """ This endpoint shows the necessary steps required to fix CVEs in the system without executing any of those steps. """ cves = [] # type: List[FixPlanResult] expected_status = "" for cve in options.cves: cve_plan = fix_plan_cve(cve, cfg=cfg) expected_status = get_expected_overall_status( expected_status, cve_plan.expected_status ) cves.append(cve_plan) return CVESFixPlanResult( cves_data=CVEFixPlanResult( expected_status=expected_status, cves=cves, ) ) endpoint = APIEndpoint( version="v1", name="CVEFixPlan", fn=_plan, options_cls=CVEFixPlanOptions, ) _doc = { "introduced_in": "29", "requires_network": True, "example_python": """ from uaclient.api.u.pro.security.fix.cve.plan.v1 import plan, CVEFixPlanOptions options = CVEFixPlanOptions(cves=["CVE-1234-1234", "CVE-1234-1235"]) result = plan(options) """, # noqa: E501 "result_class": CVESFixPlanResult, "ignore_result_classes": [DataObject], "extra_result_classes": [ AptUpgradeData, AttachData, EnableData, NoOpData, NoOpAlreadyFixedData, NoOpLivepatchFixData, PackageCannotBeInstalledData, SecurityIssueNotFixedData, ], "exceptions": [], "example_cli": """pro api u.pro.security.fix.cve.plan.v1 --data '{"cves": ["CVE-1234-56789", "CVE-1234-1235"]}'""", # noqa: E501 "example_json": """ { "cves_data": { "expected_status": "fixed", "cves": [ { "title": "CVE-1234-56789", "expected_status": "fixed", "plan": [ { "operation": "apt-upgrade", "order": 1, "data": { "binary_packages": ["pkg1"], "source_packages": ["pkg1"], "pocket": "standard-updates", } } ], "warnings": [], "error": null, "additional_data": {} } ] } } """, } pro/security/fix/cve/plan/__pycache__/__init__.cpython-310.pyc 0000644 00000000260 15030103444 0020150 0 ustar 00 o �ϴf � @ s d S )N� r r r �S/usr/lib/python3/dist-packages/uaclient/api/u/pro/security/fix/cve/plan/__init__.py�<module> s pro/security/fix/cve/plan/__pycache__/v1.cpython-310.pyc 0000644 00000010136 15030103444 0016742 0 ustar 00 o �(�f� � @ s( d dl mZ d dlmZ d dlmZ d dlmZ d dlm Z m Z m Z m Z m Z mZmZmZmZmZmZmZmZ d dlmZ d dlmZmZmZm Z G dd � d e�Z G d d � d e�Z G d d � d ee�Z de de fdd�Z de dede fdd�Z!edde!e d�Z"ddde ege e e eeeeegg dd d � Z#d S ) � )�List)� APIEndpoint)�AdditionalInfo)�get_expected_overall_status) �AptUpgradeData� AttachData� EnableData� FixPlanError� FixPlanResult� FixPlanStep�FixPlanWarning�NoOpAlreadyFixedData�NoOpData�NoOpLivepatchFixData� PackageCannotBeInstalledData�SecurityIssueNotFixedData� fix_plan_cve)�UAConfig)� DataObject�Field�StringDataValue� data_listc @ s2 e Zd Zedee�dd�gZdee fdd�Z dS )�CVEFixPlanOptions�cvesz)A list of CVE (i.e. CVE-2023-2650) titles��docc C � || _ d S �N)r )�selfr � r �M/usr/lib/python3/dist-packages/uaclient/api/u/pro/security/fix/cve/plan/v1.py�__init__& � zCVEFixPlanOptions.__init__N) �__name__� __module__� __qualname__r r r �fieldsr �strr! r r r r r s ��r c @ sB e Zd Zededd�edee�dd�gZdede e fdd�Z dS ) �CVEFixPlanResult�expected_statusz&The expected status of fixing the CVEsr r z#A list of ``FixPlanResult`` objectsc C s || _ || _d S r �r) r )r r) r r r r r! 8 s zCVEFixPlanResult.__init__N) r# r$ r% r r r r r& r' r r! r r r r r( * s ��� r( c @ s* e Zd Zededd�gZdefdd�ZdS )�CVESFixPlanResult� cves_dataz&A list of ``CVEFixPlanResult`` objectsr c C r r �r, )r r, r r r r! F r" zCVESFixPlanResult.__init__N)r# r$ r% r r( r& r! r r r r r+ = s ��r+ �options�returnc C s t | t� �S r )�_planr )r. r r r �planJ s r1 �cfgc C sH g }d}| j D ]}t||d�}t||j�}|�|� qtt||d�d�S )z~ This endpoint shows the necessary steps required to fix CVEs in the system without executing any of those steps. � )r2 r* r- )r r r r) �appendr+ r( )r. r2 r r) �cve�cve_planr r r r0 N s � ��r0 �v1� CVEFixPlan)�version�name�fn� options_cls�29Tz� from uaclient.api.u.pro.security.fix.cve.plan.v1 import plan, CVEFixPlanOptions options = CVEFixPlanOptions(cves=["CVE-1234-1234", "CVE-1234-1235"]) result = plan(options) z]pro api u.pro.security.fix.cve.plan.v1 --data '{"cves": ["CVE-1234-56789", "CVE-1234-1235"]}'a� { "cves_data": { "expected_status": "fixed", "cves": [ { "title": "CVE-1234-56789", "expected_status": "fixed", "plan": [ { "operation": "apt-upgrade", "order": 1, "data": { "binary_packages": ["pkg1"], "source_packages": ["pkg1"], "pocket": "standard-updates", } } ], "warnings": [], "error": null, "additional_data": {} } ] } } ) � introduced_in�requires_network�example_python� result_class�ignore_result_classes�extra_result_classes� exceptions� example_cli� example_jsonN)$�typingr �uaclient.api.apir �uaclient.api.data_typesr �'uaclient.api.u.pro.security.fix._commonr �/uaclient.api.u.pro.security.fix._common.plan.v1r r r r r r r r r r r r r �uaclient.configr �uaclient.data_typesr r r r r r( r+ r1 r0 �endpoint�_docr r r r �<module> sH < �� � pro/security/fix/cve/plan/__init__.py 0000644 00000000000 15030103444 0013601 0 ustar 00 pro/security/fix/cve/execute/v1.py 0000644 00000016517 15030103444 0013124 0 ustar 00 from typing import List from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo from uaclient.api.u.pro.security.fix._common import ( FixStatus, get_expected_overall_status, ) # Some of these imports are intentionally not used in this module. # The rationale is that we want users to import such Data Objects # directly from the associated endpoints and not through the _common module from uaclient.api.u.pro.security.fix._common.execute.v1 import ( # noqa: F401 FailedUpgrade, FixExecuteError, FixExecuteResult, UpgradedPackage, _execute_fix, ) from uaclient.api.u.pro.security.fix.cve.plan.v1 import ( CVEFixPlanOptions, _plan, ) from uaclient.config import UAConfig from uaclient.data_types import DataObject, Field, StringDataValue, data_list class CVEFixExecuteOptions(DataObject): fields = [ Field( "cves", data_list(StringDataValue), doc="A list of CVE (i.e. CVE-2023-2650) titles", ), ] def __init__(self, cves: List[str]): self.cves = cves class CVEAPIFixExecuteResult(DataObject): fields = [ Field("status", StringDataValue, doc="The status of fixing the CVEs"), Field( "cves", data_list(FixExecuteResult), doc="A list of ``FixExecuteResult`` objects", ), ] def __init__(self, status: str, cves: List[FixExecuteResult]): self.status = status self.cves = cves class CVESAPIFixExecuteResult(DataObject, AdditionalInfo): fields = [ Field( "cves_data", CVEAPIFixExecuteResult, doc="A list of ``CVEAPIFixExecuteResult`` objects", ) ] def __init__(self, cves_data: CVEAPIFixExecuteResult): self.cves_data = cves_data def execute(options: CVEFixExecuteOptions) -> CVESAPIFixExecuteResult: return _execute(options, UAConfig()) def _execute( options: CVEFixExecuteOptions, cfg: UAConfig ) -> CVESAPIFixExecuteResult: """ This endpoint fixes the specified CVEs on the machine. """ fix_plan = _plan(CVEFixPlanOptions(cves=options.cves), cfg=cfg) cves_result = [] # type: List[FixExecuteResult] all_cves_status = FixStatus.SYSTEM_NOT_AFFECTED.value.msg for cve in fix_plan.cves_data.cves: cve_result = _execute_fix(cve) all_cves_status = get_expected_overall_status( all_cves_status, cve_result.status ) cves_result.append(cve_result) return CVESAPIFixExecuteResult( cves_data=CVEAPIFixExecuteResult( status=all_cves_status, cves=cves_result ) ) endpoint = APIEndpoint( version="v1", name="CVEFixExecute", fn=_execute, options_cls=CVEFixExecuteOptions, ) _doc = { "introduced_in": "30", "requires_network": True, "example_python": """ from uaclient.api.u.pro.security.fix.cve.execute.v1 import execute, CVEFixExecuteOptions options = CVEFixExecuteOptions(cves=["CVE-1234-1234", "CVE-1234-1235"]) result = execute(options) """, # noqa: E501 "result_class": CVESAPIFixExecuteResult, "exceptions": [], "example_cli": """pro api u.pro.security.fix.cve.execute.v1 --data '{"cves": ["CVE-1234-1234", "CVE-1234-1235"]}'""", # noqa: E501 "example_json": """ { "cves_data": { "status": "fixed", "cves": [ { "title": "CVE-1234-56789", "description": "..." "status": "fixed", "upgraded_packages": { "name": "pkg1", "version": "1.1", "pocket": "standard-updates" }, "errors": [] } ] } } """, "extra": """ .. tab-item:: Explanation :sync: explanation When using the CVE endpoint, the expected output is as follows: .. code-block:: json { "_schema_version": "v1", "data": { "attributes": { "cves_data": { "cves": [ { "description": "description", "errors": null, "status": "fixed", "title": "CVE-2021-27135", "upgraded_packages": [ { "name": "xterm", "pocket": "standard-updates", "version": "VERSION" } ] } ], "status": "fixed" } }, "meta": { "environment_vars": [] }, "type": "CVEFixExecute" }, "errors": [], "result": "success", "version": "30", "warnings": [] } From this output, we can see that the **cves_data** object contains two attributes: * **cves**: A list of CVE objects detailing what happened during the fix operation. * **status**: The status of the fix operation considering **all** CVEs. This means that if one CVE cannot be fixed, this field will reflect that. If we take a look at a CVE object, we will see the following structure: * **title**: The title of the CVE. * **description**: The CVE description. * **error**: Any error captured when fixing the CVE will appear here. The error object will be detailed in a following section. * **status**: The expected status of the CVE after the fix operation. There are three possible scenarios: **fixed**, **still-affected** and **not-affected**. The system is considered **still-affected** if there is something that prevents any required packages from being upgraded. The system is considered **not-affected** if the CVE doesn't affect the system at all. * **upgraded_packages**: A list of UpgradedPackage objects referencing each package that was upgraded during the fix operation. The UpgradedPackage object always contain the **name** of the package, the **version** it was upgraded to and the **pocket** where the package upgrade came from. **What errors can be generated?** There some errors that can happen when executing this endpoint. For example, the system might require the user to attach to a Pro subscription to install the upgrades, or the user might run the command as non-root when a package upgrade is needed. In those situations, the error JSON error object will follow this representation: .. code-block:: json { "error_type": "error-type", "reason": "reason", "failed_upgrades": [ { "name": "pkg1", "pocket": "esm-infra" } ] } We can see that the representation has the following fields: * **error_type**: The error type * **reason**: The explanation of why the error happened * **failed_upgrade**: A list of objects that always contain the name of the package that was not upgraded and the pocket where the upgrade would have come from. """, } pro/security/fix/cve/execute/__pycache__/__init__.cpython-310.pyc 0000644 00000000263 15030103444 0020663 0 ustar 00 o �ϴf � @ s d S )N� r r r �V/usr/lib/python3/dist-packages/uaclient/api/u/pro/security/fix/cve/execute/__init__.py�<module> s pro/security/fix/cve/execute/__pycache__/v1.cpython-310.pyc 0000644 00000016600 15030103444 0017454 0 ustar 00 o �(�fO � @ s d dl mZ d dlmZ d dlmZ d dlmZmZ d dl m Z m Z m Z m Z mZ d dlmZmZ d dlmZ d dlmZmZmZmZ G d d � d e�ZG d d � d e�ZG d d� dee�Zdedefdd�Z dededefdd�Z edde ed�Z dddeg d d d d �Z d S )!� )�List)� APIEndpoint)�AdditionalInfo)� FixStatus�get_expected_overall_status)� FailedUpgrade�FixExecuteError�FixExecuteResult�UpgradedPackage� _execute_fix)�CVEFixPlanOptions�_plan)�UAConfig)� DataObject�Field�StringDataValue� data_listc @ s2 e Zd Zedee�dd�gZdee fdd�Z dS )�CVEFixExecuteOptions�cvesz)A list of CVE (i.e. CVE-2023-2650) titles��docc C � || _ d S �N�r )�selfr � r �P/usr/lib/python3/dist-packages/uaclient/api/u/pro/security/fix/cve/execute/v1.py�__init__% � z CVEFixExecuteOptions.__init__N) �__name__� __module__� __qualname__r r r �fieldsr �strr r r r r r s ��r c @ sB e Zd Zededd�edee�dd�gZdede e fdd�Z dS ) �CVEAPIFixExecuteResult�statusz The status of fixing the CVEsr r z&A list of ``FixExecuteResult`` objectsc C s || _ || _d S r �r% r )r r% r r r r r 3 s z CVEAPIFixExecuteResult.__init__N) r r r! r r r r r" r# r r r r r r r$ ) s �� r$ c @ s* e Zd Zededd�gZdefdd�ZdS )�CVESAPIFixExecuteResult� cves_dataz,A list of ``CVEAPIFixExecuteResult`` objectsr c C r r �r( )r r( r r r r A r z CVESAPIFixExecuteResult.__init__N)r r r! r r$ r" r r r r r r' 8 s ��r' �options�returnc C s t | t� �S r )�_executer )r* r r r �executeE s r- �cfgc C s` t t| jd�|d�}g }tjjj}|jjD ]}t|�}t ||j �}|� |� qt t ||d�d�S )z@ This endpoint fixes the specified CVEs on the machine. r )r. r& r) )r r r r �SYSTEM_NOT_AFFECTED�value�msgr( r r r% �appendr' r$ )r* r. �fix_plan� cves_result�all_cves_status�cve� cve_resultr r r r, I s � ��r, �v1� CVEFixExecute)�version�name�fn� options_cls�30Tz� from uaclient.api.u.pro.security.fix.cve.execute.v1 import execute, CVEFixExecuteOptions options = CVEFixExecuteOptions(cves=["CVE-1234-1234", "CVE-1234-1235"]) result = execute(options) z_pro api u.pro.security.fix.cve.execute.v1 --data '{"cves": ["CVE-1234-1234", "CVE-1234-1235"]}'a� { "cves_data": { "status": "fixed", "cves": [ { "title": "CVE-1234-56789", "description": "..." "status": "fixed", "upgraded_packages": { "name": "pkg1", "version": "1.1", "pocket": "standard-updates" }, "errors": [] } ] } } at .. tab-item:: Explanation :sync: explanation When using the CVE endpoint, the expected output is as follows: .. code-block:: json { "_schema_version": "v1", "data": { "attributes": { "cves_data": { "cves": [ { "description": "description", "errors": null, "status": "fixed", "title": "CVE-2021-27135", "upgraded_packages": [ { "name": "xterm", "pocket": "standard-updates", "version": "VERSION" } ] } ], "status": "fixed" } }, "meta": { "environment_vars": [] }, "type": "CVEFixExecute" }, "errors": [], "result": "success", "version": "30", "warnings": [] } From this output, we can see that the **cves_data** object contains two attributes: * **cves**: A list of CVE objects detailing what happened during the fix operation. * **status**: The status of the fix operation considering **all** CVEs. This means that if one CVE cannot be fixed, this field will reflect that. If we take a look at a CVE object, we will see the following structure: * **title**: The title of the CVE. * **description**: The CVE description. * **error**: Any error captured when fixing the CVE will appear here. The error object will be detailed in a following section. * **status**: The expected status of the CVE after the fix operation. There are three possible scenarios: **fixed**, **still-affected** and **not-affected**. The system is considered **still-affected** if there is something that prevents any required packages from being upgraded. The system is considered **not-affected** if the CVE doesn't affect the system at all. * **upgraded_packages**: A list of UpgradedPackage objects referencing each package that was upgraded during the fix operation. The UpgradedPackage object always contain the **name** of the package, the **version** it was upgraded to and the **pocket** where the package upgrade came from. **What errors can be generated?** There some errors that can happen when executing this endpoint. For example, the system might require the user to attach to a Pro subscription to install the upgrades, or the user might run the command as non-root when a package upgrade is needed. In those situations, the error JSON error object will follow this representation: .. code-block:: json { "error_type": "error-type", "reason": "reason", "failed_upgrades": [ { "name": "pkg1", "pocket": "esm-infra" } ] } We can see that the representation has the following fields: * **error_type**: The error type * **reason**: The explanation of why the error happened * **failed_upgrade**: A list of objects that always contain the name of the package that was not upgraded and the pocket where the upgrade would have come from. )� introduced_in�requires_network�example_python� result_class� exceptions� example_cli� example_json�extraN) �typingr �uaclient.api.apir �uaclient.api.data_typesr �'uaclient.api.u.pro.security.fix._commonr r �2uaclient.api.u.pro.security.fix._common.execute.v1r r r r r �+uaclient.api.u.pro.security.fix.cve.plan.v1r r �uaclient.configr �uaclient.data_typesr r r r r r$ r' r- r, �endpoint�_docr r r r �<module> sD �� �� � pro/security/fix/cve/execute/__init__.py 0000644 00000000000 15030103444 0014311 0 ustar 00 pro/security/fix/cve/__init__.py 0000644 00000000000 15030103444 0012647 0 ustar 00 pro/security/fix/__init__.py 0000644 00000000775 15030103444 0012115 0 ustar 00 from uaclient.api.u.pro.security.fix._common.plan.v1 import ( AptUpgradeData, AttachData, EnableData, FixPlanError, FixPlanResult, FixPlanStep, FixPlanWarning, NoOpData, PackageCannotBeInstalledData, SecurityIssueNotFixedData, ) __all__ = [ "AptUpgradeData", "AttachData", "EnableData", "FixPlanError", "FixPlanResult", "FixPlanStep", "FixPlanWarning", "NoOpData", "PackageCannotBeInstalledData", "SecurityIssueNotFixedData", ] pro/security/status/__pycache__/__init__.cpython-310.pyc 0000644 00000000252 15030103444 0017177 0 ustar 00 o �ϴf � @ s d S )N� r r r �M/usr/lib/python3/dist-packages/uaclient/api/u/pro/security/status/__init__.py�<module> s pro/security/status/reboot_required/v1.py 0000644 00000016017 15030103444 0014627 0 ustar 00 from enum import Enum from typing import List, Optional from uaclient import exceptions, livepatch from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo from uaclient.config import UAConfig from uaclient.data_types import ( BoolDataValue, DataObject, Field, StringDataValue, data_list, ) from uaclient.system import ( get_kernel_info, get_reboot_required_pkgs, should_reboot, ) class RebootRequiredPkgs(DataObject): fields = [ Field( "standard_packages", data_list(StringDataValue), False, doc="Non-kernel packages that require a reboot", ), Field( "kernel_packages", data_list(StringDataValue), False, doc="Kernel packages that require a reboot", ), ] def __init__( self, standard_packages: Optional[List[str]], kernel_packages: Optional[List[str]], ): self.standard_packages = standard_packages self.kernel_packages = kernel_packages class RebootRequiredResult(DataObject, AdditionalInfo): fields = [ Field( "reboot_required", StringDataValue, doc="Either 'yes', 'no', or 'yes-kernel-livepatches-applied'", ), Field( "reboot_required_packages", RebootRequiredPkgs, doc="The packages that require a reboot", ), Field( "livepatch_enabled_and_kernel_patched", BoolDataValue, doc="True if livepatch is enabled and working", ), Field( "livepatch_enabled", BoolDataValue, doc="True if livepatch is enabled", ), Field( "livepatch_state", StringDataValue, False, doc="The state of livepatch as reported by the livepatch client", ), Field( "livepatch_support", StringDataValue, False, doc="Whether livepatch covers the current kernel", ), ] def __init__( self, reboot_required: str, reboot_required_packages: RebootRequiredPkgs, livepatch_enabled_and_kernel_patched: bool, livepatch_enabled: bool, livepatch_state: Optional[str], livepatch_support: Optional[str], ): self.reboot_required = reboot_required self.reboot_required_packages = reboot_required_packages self.livepatch_enabled_and_kernel_patched = ( livepatch_enabled_and_kernel_patched ) self.livepatch_enabled = livepatch_enabled self.livepatch_state = livepatch_state self.livepatch_support = livepatch_support class RebootStatus(Enum): REBOOT_REQUIRED = "yes" REBOOT_NOT_REQUIRED = "no" REBOOT_REQUIRED_LIVEPATCH_APPLIED = "yes-kernel-livepatches-applied" def _get_reboot_status(): if not should_reboot(): return RebootStatus.REBOOT_NOT_REQUIRED reboot_required_pkgs = get_reboot_required_pkgs() if not reboot_required_pkgs: return RebootStatus.REBOOT_REQUIRED # We will only check the Livepatch state if all the # packages that require a reboot are kernel related if reboot_required_pkgs.standard_packages: return RebootStatus.REBOOT_REQUIRED # If there are no kernel packages to cover or livepatch is not installed, # we should only return that a reboot is required if ( not reboot_required_pkgs.kernel_packages or not livepatch.is_livepatch_installed() ): return RebootStatus.REBOOT_REQUIRED our_kernel_version = get_kernel_info().proc_version_signature_version try: lp_status = livepatch.status() except exceptions.ProcessExecutionError: return RebootStatus.REBOOT_REQUIRED 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" or lp_status.livepatch.state == "nothing-to-apply" ) and lp_status.supported == "supported" ): return RebootStatus.REBOOT_REQUIRED_LIVEPATCH_APPLIED # Any other Livepatch status will not be considered here to modify the # reboot state return RebootStatus.REBOOT_REQUIRED def reboot_required() -> RebootRequiredResult: return _reboot_required(UAConfig()) def _reboot_required(cfg: UAConfig) -> RebootRequiredResult: """ This endpoint informs if the system should be rebooted or not. Possible outputs are: #. ``yes``: The system should be rebooted. #. ``no``: There is no known need to reboot the system. #. ``yes-kernel-livepatches-applied``: There are Livepatch patches applied to the current kernel, but a reboot is required for an update to take place. This reboot can wait until the next maintenance window. """ reboot_status = _get_reboot_status() reboot_required_pkgs = get_reboot_required_pkgs() livepatch_status = livepatch.status() if not livepatch_status: livepatch_enabled_and_kernel_patched = False livepatch_enabled = False livepatch_state = None livepatch_support = None else: livepatch_enabled = True livepatch_support = livepatch_status.supported livepatch_state = ( livepatch_status.livepatch.state if livepatch_status.livepatch else None ) if ( livepatch_state not in ("applied", "nothing-to-apply") and livepatch_support != "supported" ): livepatch_enabled_and_kernel_patched = False else: livepatch_enabled_and_kernel_patched = True return RebootRequiredResult( reboot_required=reboot_status.value, reboot_required_packages=RebootRequiredPkgs( standard_packages=( reboot_required_pkgs.standard_packages if reboot_required_pkgs else None ), kernel_packages=( reboot_required_pkgs.kernel_packages if reboot_required_pkgs else None ), ), livepatch_enabled_and_kernel_patched=livepatch_enabled_and_kernel_patched, # noqa livepatch_enabled=livepatch_enabled, livepatch_state=livepatch_state, livepatch_support=livepatch_support, ) endpoint = APIEndpoint( version="v1", name="RebootRequired", fn=_reboot_required, options_cls=None, ) _doc = { "introduced_in": "27.12", "requires_network": False, "example_python": """ from uaclient.api.u.pro.security.status.reboot_required.v1 import reboot_required result = reboot_required() """, # noqa: E501 "result_class": RebootRequiredResult, "exceptions": [], "example_cli": "pro api u.pro.security.status.reboot_required.v1", "example_json": """ { "reboot_required": "yes|no|yes-kernel-livepatches-applied" } """, } pro/security/status/reboot_required/__pycache__/__init__.cpython-310.pyc 0000644 00000000272 15030103444 0022373 0 ustar 00 o �ϴf � @ s d S )N� r r r �]/usr/lib/python3/dist-packages/uaclient/api/u/pro/security/status/reboot_required/__init__.py�<module> s pro/security/status/reboot_required/__pycache__/v1.cpython-310.pyc 0000644 00000011227 15030103444 0021164 0 ustar 00 o �(�f � @ s d dl mZ d dlmZmZ d dlmZmZ d dlm Z d dl m Z d dl m Z d dlmZmZmZmZmZ d dlmZmZmZ G d d � d e�ZG d d � d ee �ZG d d� de�Zdd� Zdefdd�Z de defdd�Z e dde dd�Z dd d eg d d d �Z dS )!� )�Enum)�List�Optional)� exceptions� livepatch)� APIEndpoint)�AdditionalInfo)�UAConfig)� BoolDataValue� DataObject�Field�StringDataValue� data_list)�get_kernel_info�get_reboot_required_pkgs� should_rebootc @ sV e Zd Zedee�ddd�edee�ddd�gZdeee deee fdd�Z d S ) �RebootRequiredPkgs�standard_packagesFz)Non-kernel packages that require a reboot��doc�kernel_packagesz%Kernel packages that require a rebootc C s || _ || _d S �N�r r )�selfr r � r �W/usr/lib/python3/dist-packages/uaclient/api/u/pro/security/status/reboot_required/v1.py�__init__& s zRebootRequiredPkgs.__init__N) �__name__� __module__� __qualname__r r r �fieldsr r �strr r r r r r s& ��� � �r c @ s� e Zd Zededd�ededd�ededd�eded d�ed ed d d�ed ed dd�gZdedede de d e e d e e f dd�Z dS )�RebootRequiredResult�reboot_requiredz7Either 'yes', 'no', or 'yes-kernel-livepatches-applied'r �reboot_required_packagesz"The packages that require a reboot�$livepatch_enabled_and_kernel_patchedz(True if livepatch is enabled and working�livepatch_enabledz True if livepatch is enabled�livepatch_stateFz:The state of livepatch as reported by the livepatch client�livepatch_supportz+Whether livepatch covers the current kernelc C s( || _ || _|| _|| _|| _|| _d S r �r# r$ r% r& r' r( )r r# r$ r% r& r' r( r r r r S s � z RebootRequiredResult.__init__N) r r r r r r r r r! �boolr r r r r r r" / s^ �������#������r" c @ s e Zd ZdZdZdZdS )� RebootStatus�yes�noz yes-kernel-livepatches-appliedN)r r r �REBOOT_REQUIRED�REBOOT_NOT_REQUIRED�!REBOOT_REQUIRED_LIVEPATCH_APPLIEDr r r r r+ f s r+ c C s� t � stjS t� } | stjS | jrtjS | jrt�� s tjS t � j }zt� � }W n t j y5 tj Y S w |d ur\|d ur\||jkr\|jd ur\|jjdksT|jjdkr\|jdkr\tjS tjS )N�applied�nothing-to-apply� supported)r r+ r/ r r. r r r �is_livepatch_installedr � proc_version_signature_version�statusr �ProcessExecutionError�kernel�stater3 r0 )�reboot_required_pkgs�our_kernel_version� lp_statusr r r �_get_reboot_statusl s6 �� � r= �returnc C s t t� �S r )�_reboot_requiredr r r r r r# � s r# �cfgc C s� t � }t� }t�� }|sd}d}d}d}nd}|j}|jr!|jjnd}|dvr.|dkr.d}nd}t|jt|r9|j nd|r?|j ndd�||||d�S )a� This endpoint informs if the system should be rebooted or not. Possible outputs are: #. ``yes``: The system should be rebooted. #. ``no``: There is no known need to reboot the system. #. ``yes-kernel-livepatches-applied``: There are Livepatch patches applied to the current kernel, but a reboot is required for an update to take place. This reboot can wait until the next maintenance window. FNT)r1 r2 r3 r r) ) r= r r r6 r3 r9 r" �valuer r r )r@ � reboot_statusr: �livepatch_statusr% r& r' r( r r r r? � sB ����� �r? �v1�RebootRequiredN)�version�name�fn� options_clsz27.12Fzo from uaclient.api.u.pro.security.status.reboot_required.v1 import reboot_required result = reboot_required() z0pro api u.pro.security.status.reboot_required.v1zD { "reboot_required": "yes|no|yes-kernel-livepatches-applied" } )� introduced_in�requires_network�example_python� result_classr � example_cli� example_json) �enumr �typingr r �uaclientr r �uaclient.api.apir �uaclient.api.data_typesr �uaclient.configr �uaclient.data_typesr r r r r �uaclient.systemr r r r r" r+ r= r# r? �endpoint�_docr r r r �<module> s8 7/9� � pro/security/status/reboot_required/__init__.py 0000644 00000000000 15030103444 0016021 0 ustar 00 pro/security/status/livepatch_cves/v1.py 0000644 00000004144 15030103444 0014432 0 ustar 00 from typing import List from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo from uaclient.config import UAConfig from uaclient.data_types import ( BoolDataValue, DataObject, Field, StringDataValue, data_list, ) from uaclient.security_status import get_livepatch_fixed_cves class LivepatchCVEObject(DataObject): fields = [ Field("name", StringDataValue, doc="Name (ID) of the CVE"), Field("patched", BoolDataValue, doc="Livepatch has patched the CVE"), ] def __init__(self, name: str, patched: bool): self.name = name self.patched = patched class LivepatchCVEsResult(DataObject, AdditionalInfo): fields = [ Field( "fixed_cves", data_list(LivepatchCVEObject), doc="List of Livepatch patches for the given system", ), ] def __init__( self, fixed_cves: List[LivepatchCVEObject], ): self.fixed_cves = fixed_cves def livepatch_cves() -> LivepatchCVEsResult: return _livepatch_cves(UAConfig()) def _livepatch_cves(cfg: UAConfig) -> LivepatchCVEsResult: """ This endpoint lists Livepatch patches for the currently-running kernel. """ return LivepatchCVEsResult( fixed_cves=[ LivepatchCVEObject(name=cve["name"], patched=cve["patched"]) for cve in get_livepatch_fixed_cves() ] ) endpoint = APIEndpoint( version="v1", name="LivepatchCVEs", fn=_livepatch_cves, options_cls=None, ) _doc = { "introduced_in": "27.12", "requires_network": False, "example_python": """ from uaclient.api.u.pro.security.status.livepatch_cves.v1 import livepatch_cves result = livepatch_cves() """, # noqa: E501 "result_class": LivepatchCVEsResult, "exceptions": [], "example_cli": "pro api u.pro.security.status.livepatch_cves.v1", "example_json": """ { "fixed_cves":[ { "name": "<CVE Name>", "patched": true }, { "name": "<Other CVE Name>", "patched": false }, ] } """, } pro/security/status/livepatch_cves/__pycache__/__init__.cpython-310.pyc 0000644 00000000271 15030103444 0022177 0 ustar 00 o �ϴf � @ s d S )N� r r r �\/usr/lib/python3/dist-packages/uaclient/api/u/pro/security/status/livepatch_cves/__init__.py�<module> s pro/security/status/livepatch_cves/__pycache__/v1.cpython-310.pyc 0000644 00000005152 15030103444 0020771 0 ustar 00 o �(�fd � @ s� d dl mZ d dlmZ d dlmZ d dlmZ d dlm Z m Z m Z m Z m Z d dlmZ G dd� de �ZG d d � d e e�Zd efd d �Zded efdd�Zeddedd�Zdddeg ddd�ZdS )� )�List)� APIEndpoint)�AdditionalInfo)�UAConfig)� BoolDataValue� DataObject�Field�StringDataValue� data_list)�get_livepatch_fixed_cvesc @ s: e Zd Zededd�ededd�gZdedefdd�Z dS ) �LivepatchCVEObject�namezName (ID) of the CVE��doc�patchedz Livepatch has patched the CVEc C s || _ || _d S �N�r r )�selfr r � r �V/usr/lib/python3/dist-packages/uaclient/api/u/pro/security/status/livepatch_cves/v1.py�__init__ s zLivepatchCVEObject.__init__N) �__name__� __module__� __qualname__r r r �fields�str�boolr r r r r r s �r c @ s2 e Zd Zedee�dd�gZdee fdd�ZdS )�LivepatchCVEsResult� fixed_cvesz.List of Livepatch patches for the given systemr c C s || _ d S r �r )r r r r r r $ s z LivepatchCVEsResult.__init__N) r r r r r r r r r r r r r r s ���r �returnc C s t t� �S r )�_livepatch_cvesr r r r r �livepatch_cves+ s r" �cfgc C s t dd� t� D �d�S )zQ This endpoint lists Livepatch patches for the currently-running kernel. c S s g | ] }t |d |d d��qS )r r r )r )�.0�cver r r � <listcomp>4 s ��z#_livepatch_cves.<locals>.<listcomp>r )r r )r# r r r r! / s ��r! �v1� LivepatchCVEsN)�versionr �fn� options_clsz27.12Fzl from uaclient.api.u.pro.security.status.livepatch_cves.v1 import livepatch_cves result = livepatch_cves() z/pro api u.pro.security.status.livepatch_cves.v1z� { "fixed_cves":[ { "name": "<CVE Name>", "patched": true }, { "name": "<Other CVE Name>", "patched": false }, ] } )� introduced_in�requires_network�example_python� result_class� exceptions� example_cli� example_json)�typingr �uaclient.api.apir �uaclient.api.data_typesr �uaclient.configr �uaclient.data_typesr r r r r �uaclient.security_statusr r r r" r! �endpoint�_docr r r r �<module> s0 � � pro/security/status/livepatch_cves/__init__.py 0000644 00000000000 15030103444 0015626 0 ustar 00 pro/security/status/__init__.py 0000644 00000000000 15030103444 0012627 0 ustar 00 pro/security/__init__.py 0000644 00000000000 15030103444 0011304 0 ustar 00 pro/services/disable/v1.py 0000644 00000011763 15030103444 0011474 0 ustar 00 import logging from typing import List, Optional from uaclient import entitlements, lock, messages, status, util from uaclient.api import AbstractProgress, ProgressWrapper, exceptions from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo from uaclient.api.u.pro.status.enabled_services.v1 import _enabled_services from uaclient.api.u.pro.status.is_attached.v1 import _is_attached from uaclient.config import UAConfig from uaclient.data_types import ( BoolDataValue, DataObject, Field, StringDataValue, data_list, ) LOG = logging.getLogger(util.replace_top_level_logger_name(__name__)) class DisableOptions(DataObject): fields = [ Field("service", StringDataValue, doc="Pro service to disable"), Field( "purge", BoolDataValue, False, doc=( "Also remove all packages that were installed from this" " service. Only supported by some services. (default: false)" ), ), ] def __init__(self, *, service: str, purge: bool = False): self.service = service self.purge = purge class DisableResult(DataObject, AdditionalInfo): fields = [ Field( "disabled", data_list(StringDataValue), doc="List of services disabled", ), ] def __init__(self, *, disabled: List[str]): self.disabled = disabled def _enabled_services_names(cfg: UAConfig) -> List[str]: return [s.name for s in _enabled_services(cfg).enabled_services] def disable( options: DisableOptions, progress_object: Optional[AbstractProgress] = None ) -> DisableResult: return _disable(options, UAConfig(), progress_object=progress_object) def _disable( options: DisableOptions, cfg: UAConfig, progress_object: Optional[AbstractProgress] = None, ) -> DisableResult: """ Disable a Pro service. This will automatically disable any services that depend on the target service. """ progress = ProgressWrapper(progress_object) if not util.we_are_currently_root(): raise exceptions.NonRootUserError() if not _is_attached(cfg).is_attached: raise exceptions.UnattachedError() entitlement = entitlements.entitlement_factory( cfg=cfg, name=options.service, purge=options.purge, ) enabled_services_before = _enabled_services_names(cfg) # Do this after getting the class so that the factory can raise an # exception for invalid service names if options.service not in enabled_services_before: # nothing to do return DisableResult( disabled=[], ) variant = entitlement.enabled_variant if variant is not None: entitlement = variant progress.total_steps = entitlement.calculate_total_disable_steps() success = False fail_reason = None try: with lock.RetryLock( lock_holder="u.pro.services.disable.v1", ): success, fail_reason = entitlement.disable(progress) except Exception as e: lock.clear_lock_file_if_present() raise e if not success: if fail_reason is not None and fail_reason.message is not None: reason = fail_reason.message else: reason = messages.GENERIC_UNKNOWN_ISSUE raise exceptions.EntitlementNotDisabledError( service=options.service, reason=reason ) enabled_services_after = _enabled_services_names(cfg) status.status(cfg=cfg) # Update the status cache progress.finish() return DisableResult( disabled=sorted( list( set(enabled_services_before).difference( set(enabled_services_after) ) ) ), ) endpoint = APIEndpoint( version="v1", name="DisableService", fn=_disable, options_cls=DisableOptions, supports_progress=True, ) _doc = { "introduced_in": "32", "requires_network": True, "example_python": """ from uaclient.api.u.pro.services.disable.v1 import disable, DisableOptions result = disable(DisableOptions(service="usg")) """, "result_class": DisableResult, "exceptions": [ (exceptions.NonRootUserError, "When called as non-root user"), ( exceptions.UnattachedError, ( "When called on a machine that is not attached to a Pro" " subscription" ), ), ( exceptions.EntitlementNotFoundError, "When the service argument is not a valid Pro service name", ), ( exceptions.LockHeldError, "When another Ubuntu Pro related operation is in progress", ), ( exceptions.EntitlementNotDisabledError, "When the service fails to disable", ), ], "example_cli": "pro api u.pro.services.disable.v1 --args service=usg", "example_json": """ { "disabled": [ "usg" ] } """, } pro/services/disable/__pycache__/__init__.cpython-310.pyc 0000644 00000000253 15030103444 0017234 0 ustar 00 o �ϴf � @ s d S )N� r r r �N/usr/lib/python3/dist-packages/uaclient/api/u/pro/services/disable/__init__.py�<module> s pro/services/disable/__pycache__/v1.cpython-310.pyc 0000644 00000011033 15030103444 0016021 0 ustar 00 o �(�f� � @ sz d dl Z d dlmZmZ d dlmZmZmZmZm Z d dl m Z m Z m Z d dlmZ d dlmZ d dlmZ d dlmZ d d lmZ d d lmZmZmZm Z m Z e � e � e ��Z!G d d � d e�Z"G d d� dee�Z#dedee$ fdd�Z% d'de"dee de#fdd�Z& d'de"dedee de#fdd�Z'edde'e"dd �Z(d dd e#e j)d fe j*d fe j+d!fe j,d"fe j-d#fgd$d%d&�Z.dS )(� N)�List�Optional)� entitlements�lock�messages�status�util)�AbstractProgress�ProgressWrapper� exceptions)� APIEndpoint)�AdditionalInfo)�_enabled_services)� _is_attached)�UAConfig)� BoolDataValue� DataObject�Field�StringDataValue� data_listc @ sB e Zd Zededd�ededdd�gZdd�dedefdd �Z d S ) �DisableOptions�servicezPro service to disable��doc�purgeFzqAlso remove all packages that were installed from this service. Only supported by some services. (default: false))r c C s || _ || _d S �N)r r )�selfr r � r �H/usr/lib/python3/dist-packages/uaclient/api/u/pro/services/disable/v1.py�__init__$ s zDisableOptions.__init__N) �__name__� __module__� __qualname__r r r �fields�str�boolr r r r r r s �� r c @ s2 e Zd Zedee�dd�gZdee fdd�Z dS )� DisableResult�disabledzList of services disabledr c C s || _ d S r �r' )r r' r r r r 2 s zDisableResult.__init__N) r r! r" r r r r# r r$ r r r r r r& ) s ��r& �cfg�returnc C s dd� t | �jD �S )Nc S s g | ]}|j �qS r )�name)�.0�sr r r � <listcomp>7 s z+_enabled_services_names.<locals>.<listcomp>)r �enabled_services�r) r r r �_enabled_services_names6 s r1 �options�progress_objectc C s t | t� |d�S )N)r3 )�_disabler )r2 r3 r r r �disable: s r5 c C sR t |�}t�� s t�� �t|�jst�� �tj || j | j d�}t |�}| j |vr-t g d�S |j}|dur6|}|�� |_d}d}z tjdd�� |�|�\}}W d � n1 sXw Y W n typ } zt�� | �d} ~ ww |s�|dur�|jdur�|j} ntj} tj| j | d��t |�} tj|d� |�� t t t t |�� t | ����d�S ) zt Disable a Pro service. This will automatically disable any services that depend on the target service. )r) r+ r r( NFzu.pro.services.disable.v1)� lock_holder)r �reasonr0 ) r r �we_are_currently_rootr �NonRootUserErrorr � is_attached�UnattachedErrorr �entitlement_factoryr r r1 r& �enabled_variant� calculate_total_disable_steps� total_stepsr � RetryLockr5 � Exception�clear_lock_file_if_present�messager �GENERIC_UNKNOWN_ISSUE�EntitlementNotDisabledErrorr �finish�sorted�list�set� difference) r2 r) r3 �progress� entitlement�enabled_services_before�variant�success� fail_reason�er7 �enabled_services_afterr r r r4 @ sh � � � ����� ����r4 �v1�DisableServiceT)�versionr+ �fn� options_cls�supports_progress�32z| from uaclient.api.u.pro.services.disable.v1 import disable, DisableOptions result = disable(DisableOptions(service="usg")) z When called as non-root userzCWhen called on a machine that is not attached to a Pro subscriptionz9When the service argument is not a valid Pro service namez8When another Ubuntu Pro related operation is in progressz!When the service fails to disablez4pro api u.pro.services.disable.v1 --args service=usgz+ { "disabled": [ "usg" ] } )� introduced_in�requires_network�example_python� result_classr � example_cli� example_jsonr )/�logging�typingr r �uaclientr r r r r � uaclient.apir r r �uaclient.api.apir �uaclient.api.data_typesr �-uaclient.api.u.pro.status.enabled_services.v1r �(uaclient.api.u.pro.status.is_attached.v1r �uaclient.configr �uaclient.data_typesr r r r r � getLogger� replace_top_level_logger_namer �LOGr r& r$ r1 r5 r4 �endpointr9 r; �EntitlementNotFoundError� LockHeldErrorrE �_docr r r r �<module> sx ��� � ���� �L� ����� � pro/services/disable/__init__.py 0000644 00000000000 15030103444 0012663 0 ustar 00 pro/services/__pycache__/__init__.cpython-310.pyc 0000644 00000000243 15030103444 0015630 0 ustar 00 o �ϴf � @ s d S )N� r r r �F/usr/lib/python3/dist-packages/uaclient/api/u/pro/services/__init__.py�<module> s pro/services/dependencies/v1.py 0000644 00000012445 15030103444 0012515 0 ustar 00 import logging from typing import List from uaclient import entitlements, util from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo from uaclient.config import UAConfig from uaclient.data_types import DataObject, Field, StringDataValue, data_list LOG = logging.getLogger(util.replace_top_level_logger_name(__name__)) class Reason(DataObject): fields = [ Field( "code", StringDataValue, doc="Short string that represents the reason", ), Field( "title", StringDataValue, doc="Longer string describing the reason - possibly translated", ), ] def __init__(self, *, code: str, title: str): self.code = code self.title = title class ServiceWithReason(DataObject): fields = [ Field( "name", StringDataValue, doc="Name of the Pro service this item corresponds to", ), Field( "reason", Reason, doc="Reason that this service is in the list it is in", ), ] def __init__(self, *, name: str, reason: Reason): self.name = name self.reason = reason class ServiceWithDependencies(DataObject): fields = [ Field( "name", StringDataValue, doc="Name of the Pro service this item corresponds to", ), Field( "incompatible_with", data_list(ServiceWithReason), doc=( "List of Pro services this service is incompatible with. That" " means they cannot be enabled at the same time." ), ), Field( "depends_on", data_list(ServiceWithReason), doc=( "List of Pro services this service depends on. The services" " in this list must be enabled for this service to be enabled." ), ), ] def __init__( self, *, name: str, incompatible_with: List[ServiceWithReason], depends_on: List[ServiceWithReason] ): self.name = name self.incompatible_with = incompatible_with self.depends_on = depends_on class DependenciesResult(DataObject, AdditionalInfo): fields = [ Field( "services", data_list(ServiceWithDependencies), doc="Each Pro service gets an item in this list", ), ] def __init__(self, *, services: List[ServiceWithDependencies]): self.services = services def dependencies() -> DependenciesResult: return _dependencies(UAConfig()) def _dependencies(cfg: UAConfig) -> DependenciesResult: """ This endpoint will return a full list of all service dependencies, regardless of the current system state. That means it will always return the same thing until new services are added, or until we add/remove dependencies between services. """ services = [] for ent_cls in entitlements.ENTITLEMENT_CLASSES: ent = ent_cls(cfg) incompatible_with = [] depends_on = [] for ent_with_reason in ent.incompatible_services: incompatible_with.append( ServiceWithReason( name=ent_with_reason.entitlement.name, reason=Reason( code=ent_with_reason.named_msg.name, title=ent_with_reason.named_msg.msg, ), ) ) for ent_with_reason in ent.required_services: depends_on.append( ServiceWithReason( name=ent_with_reason.entitlement.name, reason=Reason( code=ent_with_reason.named_msg.name, title=ent_with_reason.named_msg.msg, ), ) ) services.append( ServiceWithDependencies( name=ent_cls.name, incompatible_with=incompatible_with, depends_on=depends_on, ) ) return DependenciesResult(services=services) endpoint = APIEndpoint( version="v1", name="ServiceDependencies", fn=_dependencies, options_cls=None, ) _doc = { "introduced_in": "32", "requires_network": False, "example_python": """ from uaclient.api.u.pro.services.dependencies.v1 import dependencies result = dependencies() """, "result_class": DependenciesResult, "example_cli": "pro api u.pro.services.dependencies.v1", "example_json": """ { "services": [ { "name": "one", "depends_on": [ { "name": "zero", "reason": { "code": "one-and-zero", "title": "Service One requires service Zero." } }, ... ], "incompatible_with": [ { "name": "two", "reason": { "code": "one-and-two", "title": "Services One and Two are not compatible." } }, ... ] }, ... ] } """, } pro/services/dependencies/__pycache__/__init__.cpython-310.pyc 0000644 00000000260 15030103444 0020255 0 ustar 00 o �ϴf � @ s d S )N� r r r �S/usr/lib/python3/dist-packages/uaclient/api/u/pro/services/dependencies/__init__.py�<module> s pro/services/dependencies/__pycache__/v1.cpython-310.pyc 0000644 00000011272 15030103444 0017051 0 ustar 00 o �(�f% � @ s� d dl Z d dlmZ d dlmZmZ d dlmZ d dlm Z d dl m Z d dl m Z mZmZmZ e �e�e��ZG dd � d e �ZG d d � d e �ZG d d � d e �ZG dd� de e �Zdefdd�Zde defdd�Zeddedd�Zddded d d �Z dS ) � N)�List)� entitlements�util)� APIEndpoint)�AdditionalInfo)�UAConfig)� DataObject�Field�StringDataValue� data_listc @ s: e Zd Zededd�ededd�gZdedefdd�ZdS ) �Reason�codez'Short string that represents the reason��doc�titlez9Longer string describing the reason - possibly translatedc C � || _ || _d S �N�r r )�selfr r � r �M/usr/lib/python3/dist-packages/uaclient/api/u/pro/services/dependencies/v1.py�__init__ � zReason.__init__N)�__name__� __module__� __qualname__r r �fields�strr r r r r r � ��� r c @ s: e Zd Zededd�ededd�gZdedefdd�ZdS ) �ServiceWithReason�name�0Name of the Pro service this item corresponds tor �reasonz0Reason that this service is in the list it is inc C r r �r r" )r r r" r r r r . r zServiceWithReason.__init__N) r r r r r r r r r r r r r r r r c @ sZ e Zd Zededd�edee�dd�edee�dd�gZdede e de e fdd �Z d S ) �ServiceWithDependenciesr r! r �incompatible_withzkList of Pro services this service is incompatible with. That means they cannot be enabled at the same time.� depends_onzwList of Pro services this service depends on. The services in this list must be enabled for this service to be enabled.c C s || _ || _|| _d S r �r r% r& )r r r% r& r r r r L s z ServiceWithDependencies.__init__N) r r r r r r r r r r r r r r r r$ 3 s0 �������r$ c @ s2 e Zd Zedee�dd�gZdee fdd�ZdS )�DependenciesResult�servicesz*Each Pro service gets an item in this listr c C s || _ d S r �r) )r r) r r r r a � zDependenciesResult.__init__N) r r r r r r$ r r r r r r r r( X s ��r( �returnc C s t t� �S r )� _dependenciesr r r r r � dependenciese r+ r. �cfgc C s� g }t jD ]G}|| �}g }g }|jD ]}|�t|jjt|jj|jj d�d�� q|j D ]}|�t|jjt|jj|jj d�d�� q+|�t |j||d�� qt |d�S )a This endpoint will return a full list of all service dependencies, regardless of the current system state. That means it will always return the same thing until new services are added, or until we add/remove dependencies between services. r r# r' r* ) r �ENTITLEMENT_CLASSES�incompatible_services�appendr � entitlementr r � named_msg�msg�required_servicesr$ r( )r/ r) �ent_cls�entr% r& �ent_with_reasonr r r r- i sB ��� ��� �� r- �v1�ServiceDependencies)�versionr �fn� options_cls�32Fz^ from uaclient.api.u.pro.services.dependencies.v1 import dependencies result = dependencies() z&pro api u.pro.services.dependencies.v1a� { "services": [ { "name": "one", "depends_on": [ { "name": "zero", "reason": { "code": "one-and-zero", "title": "Service One requires service Zero." } }, ... ], "incompatible_with": [ { "name": "two", "reason": { "code": "one-and-two", "title": "Services One and Two are not compatible." } }, ... ] }, ... ] } )� introduced_in�requires_network�example_python� result_class� example_cli� example_json) �logging�typingr �uaclientr r �uaclient.api.apir �uaclient.api.data_typesr �uaclient.configr �uaclient.data_typesr r r r � getLogger� replace_top_level_logger_namer �LOGr r r$ r( r. r- �endpoint�_docr r r r �<module> s6 % *� � pro/services/dependencies/__init__.py 0000644 00000000000 15030103444 0013706 0 ustar 00 pro/services/enable/v1.py 0000644 00000023030 15030103444 0011305 0 ustar 00 import logging from typing import Iterable, List, Optional, Tuple, Type from uaclient import entitlements, lock, messages, status, util from uaclient.api import AbstractProgress, ProgressWrapper, exceptions from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo, ErrorWarningObject from uaclient.api.u.pro.status.enabled_services.v1 import _enabled_services from uaclient.api.u.pro.status.is_attached.v1 import _is_attached from uaclient.config import UAConfig from uaclient.data_types import ( BoolDataValue, DataObject, Field, StringDataValue, data_list, ) LOG = logging.getLogger(util.replace_top_level_logger_name(__name__)) class EnableOptions(DataObject): fields = [ Field("service", StringDataValue, doc="Pro service to be enabled"), Field( "variant", StringDataValue, False, doc="Optional variant of the Pro service to be enabled.", ), Field( "access_only", BoolDataValue, False, doc=( "If true and the target service supports it, only enable" " access to the service (default: false)" ), ), ] def __init__( self, *, service: str, variant: Optional[str] = None, access_only: bool = False ): self.service = service self.variant = variant self.access_only = access_only class EnableResult(DataObject, AdditionalInfo): fields = [ Field( "enabled", data_list(StringDataValue), doc="List of services that were enabled.", ), Field( "disabled", data_list(StringDataValue), doc="List of services that were disabled.", ), Field( "reboot_required", BoolDataValue, doc=( "True if one of the services that was enabled requires a" " reboot." ), ), Field( "messages", data_list(StringDataValue), doc=( "List of information message strings about the service that" " was just enabled. Possibly translated." ), ), ] def __init__( self, *, enabled: List[str], disabled: List[str], reboot_required: bool, messages: List[str] ): self.enabled = enabled self.disabled = disabled self.reboot_required = reboot_required self.messages = messages def _auto_select_variant( cfg: UAConfig, progress: ProgressWrapper, entitlement: entitlements.UAEntitlement, available_variants: Iterable[Type[entitlements.UAEntitlement]], access_only: bool, ) -> Tuple[entitlements.UAEntitlement, Optional[ErrorWarningObject]]: variant = None for v_cls in available_variants: v = v_cls(cfg=cfg, access_only=access_only) if ( v.applicability_status()[0] == entitlements.ApplicabilityStatus.APPLICABLE and v.variant_auto_select() ): variant = v break if variant is None and entitlement.default_variant is not None: variant = entitlement.default_variant(cfg=cfg, access_only=access_only) if variant is not None: progress.emit( "message_operation", [ ( util.prompt_for_confirmation, { "msg": messages.AUTO_SELECTING_VARIANT.format( variant=messages.TxtColor.BOLD + variant.variant_name + messages.TxtColor.ENDC ), }, ) ], ) warning = messages.AUTO_SELECTED_VARIANT_WARNING.format( variant_name=variant.variant_name ) return variant, ErrorWarningObject( title=warning.msg, code=warning.name, meta={"variant_name": variant.variant_name}, ) else: return entitlement, None def _enabled_services_names(cfg: UAConfig) -> List[str]: return [s.name for s in _enabled_services(cfg).enabled_services] def enable( options: EnableOptions, progress_object: Optional[AbstractProgress] = None ) -> EnableResult: return _enable(options, UAConfig(), progress_object=progress_object) def _enable( options: EnableOptions, cfg: UAConfig, progress_object: Optional[AbstractProgress] = None, ) -> EnableResult: """ Enable a Pro service. This will automatically disable incompatible services and enable required services that that target service depends on. """ progress = ProgressWrapper(progress_object) warnings = [] if not util.we_are_currently_root(): raise exceptions.NonRootUserError() if not _is_attached(cfg).is_attached: raise exceptions.UnattachedError() if options.service == "landscape": raise exceptions.NotSupported() enabled_services_before = _enabled_services_names(cfg) already_enabled = next( ( s for s in _enabled_services(cfg).enabled_services if s.name == options.service and ( not options.variant or (s.variant_enabled and s.variant_name == options.variant) ) ), None, ) if already_enabled: # nothing to do return EnableResult( enabled=[], disabled=[], reboot_required=False, messages=[], ) entitlement = entitlements.entitlement_factory( cfg=cfg, name=options.service, variant=options.variant or "", access_only=options.access_only, ) applicability, _ = entitlement.applicability_status() available_variants = entitlement.variants if all( [ applicability == entitlements.ApplicabilityStatus.APPLICABLE, not entitlement.is_variant, available_variants, ] ): entitlement, auto_select_warning = _auto_select_variant( cfg=cfg, progress=progress, entitlement=entitlement, available_variants=available_variants.values(), access_only=options.access_only, ) if auto_select_warning: warnings.append(auto_select_warning) progress.total_steps = entitlement.calculate_total_enable_steps() success = False fail_reason = None try: with lock.RetryLock( lock_holder="u.pro.services.enable.v1", ): success, fail_reason = entitlement.enable(progress) except Exception as e: lock.clear_lock_file_if_present() raise e if not success: if fail_reason is not None and fail_reason.message is not None: reason = fail_reason.message else: reason = messages.GENERIC_UNKNOWN_ISSUE raise exceptions.EntitlementNotEnabledError( service=options.service, reason=reason ) enabled_services_after = _enabled_services_names(cfg) post_enable_messages = [ msg for msg in (entitlement.messaging.get("post_enable", []) or []) if isinstance(msg, str) ] status.status(cfg=cfg) # Update the status cache progress.finish() result = EnableResult( enabled=sorted( list( set(enabled_services_after).difference( set(enabled_services_before) ) ) ), disabled=sorted( list( set(enabled_services_before).difference( set(enabled_services_after) ) ) ), reboot_required=entitlement._check_for_reboot(), messages=post_enable_messages, ) result.warnings = warnings return result endpoint = APIEndpoint( version="v1", name="EnableService", fn=_enable, options_cls=EnableOptions, supports_progress=True, ) _doc = { "introduced_in": "32", "requires_network": True, "example_python": """ from uaclient.api.u.pro.services.enable.v1 import enable, EnableOptions result = enable(EnableOptions(service="usg")) """, "result_class": EnableResult, "exceptions": [ (exceptions.NonRootUserError, "When called as non-root user"), ( exceptions.UnattachedError, ( "When called on a machine that is not attached to a Pro" " subscription" ), ), ( exceptions.NotSupported, ( "When called for a service that doesn't support being enabled" " via API (currently only Landscape)" ), ), ( exceptions.EntitlementNotFoundError, ( "When the service argument is not a valid Pro service name or" " if the variant is not a valid variant of the target service" ), ), ( exceptions.LockHeldError, "When another Ubuntu Pro related operation is in progress", ), ( exceptions.EntitlementNotEnabledError, "When the service fails to enable", ), ], "example_cli": "pro api u.pro.services.enable.v1 --args service=usg", "example_json": """ { "disabled": [], "enabled": [ "usg" ], "messages": [], "reboot_required": false } """, } pro/services/enable/__pycache__/__init__.cpython-310.pyc 0000644 00000000252 15030103444 0017056 0 ustar 00 o �ϴf � @ s d S )N� r r r �M/usr/lib/python3/dist-packages/uaclient/api/u/pro/services/enable/__init__.py�<module> s pro/services/enable/__pycache__/v1.cpython-310.pyc 0000644 00000016305 15030103444 0015653 0 ustar 00 o �(�f& � @ s� d dl Z d dlmZmZmZmZmZ d dlmZm Z m Z m Z m Z d dl mZmZmZ d dlmZ d dlmZmZ d dlmZ d dlmZ d d lmZ d d l m Z m Z m Z m Z m!Z! e �"e �#e$��Z%G d d � d e �Z&G d d� de e�Z'dededej(deeej( de)deej(ee f f dd�Z*dedee+ fdd�Z, d.de&dee de'fdd �Z- d.de&dedee de'fd d �Z.ed d e.e&d!d"�Z/d#d!d$e'ej0d%fej1d&fej2d'fej3d(fej4d)fej5d*fgd+d,d-�Z6dS )/� N)�Iterable�List�Optional�Tuple�Type)� entitlements�lock�messages�status�util)�AbstractProgress�ProgressWrapper� exceptions)� APIEndpoint)�AdditionalInfo�ErrorWarningObject)�_enabled_services)� _is_attached)�UAConfig)� BoolDataValue� DataObject�Field�StringDataValue� data_listc @ sZ e Zd Zededd�ededdd�ededdd�gZd dd �dedee de fd d �Z d S ) � EnableOptions�servicezPro service to be enabled��doc�variantFz2Optional variant of the Pro service to be enabled.� access_onlyz^If true and the target service supports it, only enable access to the service (default: false)N)r r c C s || _ || _|| _d S �N)r r r )�selfr r r � r" �G/usr/lib/python3/dist-packages/uaclient/api/u/pro/services/enable/v1.py�__init__* s zEnableOptions.__init__) �__name__� __module__� __qualname__r r r �fields�strr �boolr$ r" r" r" r# r s0 �������r c @ sr e Zd Zedee�dd�edee�dd�ededd�edee�d d�gZdee dee de dee fd d �Z d S ) � EnableResult�enabledz#List of services that were enabled.r �disabledz$List of services that were disabled.�reboot_requiredz?True if one of the services that was enabled requires a reboot.r zaList of information message strings about the service that was just enabled. Possibly translated.c C s || _ || _|| _|| _d S r �r, r- r. r )r! r, r- r. r r" r" r# r$ T s zEnableResult.__init__N) r% r& r' r r r r r( r r) r* r$ r" r" r" r# r+ 6 s> ����� ����r+ �cfg�progress� entitlement�available_variantsr �returnc C s� d }|D ]}|| |d�}|� � d tjjkr |�� r |} nq|d u r/|jd ur/|j| |d�}|d urc|�dtjdt j j t j j |j t j j d�ifg� t jj |jd�}|t|j|jd|jid�fS |d fS ) N)r0 r r �message_operation�msg)r )� variant_namer7 )�title�code�meta)�applicability_statusr �ApplicabilityStatus� APPLICABLE�variant_auto_select�default_variant�emitr �prompt_for_confirmationr �AUTO_SELECTING_VARIANT�format�TxtColor�BOLDr7 �ENDC� AUTO_SELECTED_VARIANT_WARNINGr r6 �name) r0 r1 r2 r3 r r �v_cls�v�warningr" r" r# �_auto_select_variantb sJ ������������rL c C s dd� t | �jD �S )Nc S s g | ]}|j �qS r" )rH ��.0�sr" r" r# � <listcomp>� s z+_enabled_services_names.<locals>.<listcomp>)r �enabled_services�r0 r" r" r# �_enabled_services_names� s rS �options�progress_objectc C s t | t� |d�S )N)rU )�_enabler )rT rU r" r" r# �enable� s rW c s t |�}g }t�� st�� �t|�jst�� �� jdkr t� � �t |�}t � fdd�t |�j D �d�}|r=tg g dg d�S tj|� j� jpFd� jd�}|�� \}} |j} t|tjjk|j | g�rvt|||| �� � jd �\}} | rv|�| � |� � |_ d} d} z t j d d �� |� |�\} } W d � n1 s�w Y W n t!y� } zt �"� |�d}~ww | s�| dur�| j#dur�| j#}nt$j%}tj&� j|d ��t |�}d d� |j'�(dg �p�g D �}t)j)|d� |�*� tt+t,t-|��.t-|����t+t,t-|��.t-|����|�/� |d�}||_0|S )z� Enable a Pro service. This will automatically disable incompatible services and enable required services that that target service depends on. � landscapec 3 s8 � | ]}|j � jkr� jr|jr|j� jkr|V qd S r )rH r r �variant_enabledr7 rM �rT r" r# � <genexpr>� s � �� ��z_enable.<locals>.<genexpr>NFr/ � )r0 rH r r )r0 r1 r2 r3 r zu.pro.services.enable.v1)� lock_holder)r �reasonc S s g | ] }t |t�r|�qS r" )� isinstancer) )rN r6 r" r" r# rP � s ��z_enable.<locals>.<listcomp>� post_enablerR )1r r �we_are_currently_rootr �NonRootUserErrorr � is_attached�UnattachedErrorr � NotSupportedrS �nextr rQ r+ r �entitlement_factoryr r r; �variants�allr< r= � is_variantrL �values�append� calculate_total_enable_steps� total_stepsr � RetryLockrW � Exception�clear_lock_file_if_present�messager �GENERIC_UNKNOWN_ISSUE�EntitlementNotEnabledError� messaging�getr �finish�sorted�list�set� difference�_check_for_reboot�warnings)rT r0 rU r1 r} �enabled_services_before�already_enabledr2 � applicability�_r3 �auto_select_warning�success� fail_reason�er^ �enabled_services_after�post_enable_messages�resultr" rZ r# rV � s� � � �� �� � � ������ �������rV �v1� EnableServiceT)�versionrH �fn� options_cls�supports_progress�32zw from uaclient.api.u.pro.services.enable.v1 import enable, EnableOptions result = enable(EnableOptions(service="usg")) z When called as non-root userzCWhen called on a machine that is not attached to a Pro subscriptionz_When called for a service that doesn't support being enabled via API (currently only Landscape)zxWhen the service argument is not a valid Pro service name or if the variant is not a valid variant of the target servicez8When another Ubuntu Pro related operation is in progressz When the service fails to enablez3pro api u.pro.services.enable.v1 --args service=usgzp { "disabled": [], "enabled": [ "usg" ], "messages": [], "reboot_required": false } )� introduced_in�requires_network�example_python� result_classr � example_cli� example_jsonr )7�logging�typingr r r r r �uaclientr r r r r � uaclient.apir r r �uaclient.api.apir �uaclient.api.data_typesr r �-uaclient.api.u.pro.status.enabled_services.v1r �(uaclient.api.u.pro.status.is_attached.v1r �uaclient.configr �uaclient.data_typesr r r r r � getLogger� replace_top_level_logger_namer% �LOGr r+ � UAEntitlementr* rL r) rS rW rV �endpointrb rd re �EntitlementNotFoundError� LockHeldErrorrt �_docr" r" r" r# �<module> s� ,��� �� �/��� � ���� �~� ������ � pro/services/enable/__init__.py 0000644 00000000000 15030103444 0012506 0 ustar 00 pro/services/__init__.py 0000644 00000000000 15030103444 0011260 0 ustar 00 pro/status/__pycache__/__init__.cpython-310.pyc 0000644 00000000241 15030103444 0015326 0 ustar 00 o �ϴf � @ s d S )N� r r r �D/usr/lib/python3/dist-packages/uaclient/api/u/pro/status/__init__.py�<module> s pro/status/is_attached/v1.py 0000644 00000011474 15030103444 0012040 0 ustar 00 import enum from typing import Optional, Tuple from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo from uaclient.config import UAConfig from uaclient.data_types import ( BoolDataValue, DataObject, Field, IntDataValue, StringDataValue, ) from uaclient.defaults import ( CONTRACT_EXPIRY_GRACE_PERIOD_DAYS, CONTRACT_EXPIRY_PENDING_DAYS, ) from uaclient.files import machine_token class IsAttachedResult(DataObject, AdditionalInfo): fields = [ Field( "is_attached", BoolDataValue, doc=( "True if the machine is attached to an Ubuntu Pro subscription" ), ), Field( "contract_status", StringDataValue, False, doc="Status of the Ubuntu Pro subscription", ), Field( "contract_remaining_days", IntDataValue, doc="Number of days left in the Ubuntu Pro subscription", ), Field( "is_attached_and_contract_valid", BoolDataValue, doc=( "True if the machine is attached to an Ubuntu Pro subscription" " and that subscription is not expired" ), ), ] def __init__( self, *, is_attached: bool, contract_status: Optional[str], contract_remaining_days: int, is_attached_and_contract_valid: bool ): self.is_attached = is_attached self.contract_status = contract_status self.contract_remaining_days = contract_remaining_days self.is_attached_and_contract_valid = is_attached_and_contract_valid @enum.unique class ContractExpiryStatus(enum.Enum): NONE = None ACTIVE = "active" ACTIVE_EXPIRED_SOON = "active-soon-to-expire" EXPIRED_GRACE_PERIOD = "grace-period" EXPIRED = "expired" def _get_contract_expiry_status( cfg: UAConfig, is_machine_attached: bool, remaining_days: Optional[int], ) -> Tuple[ContractExpiryStatus, int]: """Return a tuple [ContractExpiryStatus, num_days]""" if not is_machine_attached: return ContractExpiryStatus.NONE, 0 grace_period = CONTRACT_EXPIRY_GRACE_PERIOD_DAYS pending_expiry = CONTRACT_EXPIRY_PENDING_DAYS # if unknown assume the worst if remaining_days is None: return ContractExpiryStatus.EXPIRED, -grace_period if 0 <= remaining_days <= pending_expiry: return ContractExpiryStatus.ACTIVE_EXPIRED_SOON, remaining_days elif -grace_period <= remaining_days < 0: return ContractExpiryStatus.EXPIRED_GRACE_PERIOD, remaining_days elif remaining_days < -grace_period: return ContractExpiryStatus.EXPIRED, remaining_days return ContractExpiryStatus.ACTIVE, remaining_days def is_attached() -> IsAttachedResult: return _is_attached(UAConfig()) def _is_attached(cfg: UAConfig) -> IsAttachedResult: """ This endpoint shows if the machine is attached to a Pro subscription. """ machine_token_file = machine_token.get_machine_token_file(cfg) is_machine_attached = bool(machine_token_file.machine_token) contract_status, remaining_days = _get_contract_expiry_status( cfg, is_machine_attached, machine_token_file.contract_remaining_days ) is_attached_and_contract_valid = True if ( not is_machine_attached or contract_status == ContractExpiryStatus.EXPIRED ): is_attached_and_contract_valid = False return IsAttachedResult( is_attached=is_machine_attached, contract_status=contract_status.value, contract_remaining_days=remaining_days, is_attached_and_contract_valid=is_attached_and_contract_valid, ) endpoint = APIEndpoint( version="v1", name="IsAttached", fn=_is_attached, options_cls=None, ) _doc = { "introduced_in": "28", "requires_network": False, "example_python": """ from uaclient.api.u.pro.status.is_attached.v1 import is_attached result = is_attached() """, # noqa: E501 "result_class": IsAttachedResult, "exceptions": [], "example_cli": "pro api u.pro.status.is_attached.v1", "example_json": """ { "contract_remaining_days": 360, "contract_status": "active", "is_attached": true, "is_attached_and_contract_valid": true } """, "extra": """ .. tab-item:: Explanation :sync: explanation The ``contract_status`` field can return 4 different states, they are: * **active**: The contract is currently valid. * **grace-period**: The contract is in the grace period. This means that it is expired, but there are still some days where the contract will be valid. * **active-soon-to-expire**: The contract is almost expired, but still valid. * **expired**: The contract is expired and no longer valid. """, } pro/status/is_attached/__pycache__/__init__.cpython-310.pyc 0000644 00000000255 15030103444 0017603 0 ustar 00 o �ϴf � @ s d S )N� r r r �P/usr/lib/python3/dist-packages/uaclient/api/u/pro/status/is_attached/__init__.py�<module> s pro/status/is_attached/__pycache__/v1.cpython-310.pyc 0000644 00000007650 15030103444 0016400 0 ustar 00 o �(�f< � @ s d dl Z d dlmZmZ d dlmZ d dlmZ d dlm Z d dl m Z m Z m Z mZmZ d dlmZmZ d dlmZ G d d � d e e�Ze jG d d � d e j��Zd e dedee deeef fdd�Zdefdd�Z d e defdd�Z edde dd�Z ddd eg d d d d �Z dS )!� N)�Optional�Tuple)� APIEndpoint)�AdditionalInfo)�UAConfig)� BoolDataValue� DataObject�Field� IntDataValue�StringDataValue)�!CONTRACT_EXPIRY_GRACE_PERIOD_DAYS� CONTRACT_EXPIRY_PENDING_DAYS)� machine_tokenc @ s` e Zd Zededd�ededdd�ededd�ed ed d�gZdede e de d efd d �Z d S )�IsAttachedResult� is_attachedz=True if the machine is attached to an Ubuntu Pro subscription)�doc�contract_statusFz%Status of the Ubuntu Pro subscription�contract_remaining_daysz2Number of days left in the Ubuntu Pro subscription� is_attached_and_contract_validzbTrue if the machine is attached to an Ubuntu Pro subscription and that subscription is not expiredc C s || _ || _|| _|| _d S �N�r r r r )�selfr r r r � r �J/usr/lib/python3/dist-packages/uaclient/api/u/pro/status/is_attached/v1.py�__init__3 s zIsAttachedResult.__init__N) �__name__� __module__� __qualname__r r r r �fields�boolr �str�intr r r r r r s@ ����� ����r c @ s e Zd ZdZdZdZdZdZdS )�ContractExpiryStatusN�activezactive-soon-to-expirez grace-period�expired)r r r �NONE�ACTIVE�ACTIVE_EXPIRED_SOON�EXPIRED_GRACE_PERIOD�EXPIREDr r r r r" A s r" �cfg�is_machine_attached�remaining_days�returnc C s� |st jdfS t}t}|du rt j| fS d| kr |kr&n nt j|fS | | kr1dk r8n nt j|fS || k rBt j|fS t j|fS )z/Return a tuple [ContractExpiryStatus, num_days]r N)r" r% r r r) r' r( r& )r* r+ r, � grace_period�pending_expiryr r r �_get_contract_expiry_statusJ s r0 c C s t t� �S r )� _is_attachedr r r r r r c s r c C sN t �| �}t|j �}t| ||j�\}}d}|r |tjkr d}t||j||d�S )zO This endpoint shows if the machine is attached to a Pro subscription. TFr ) r �get_machine_token_filer r0 r r" r) r �value)r* �machine_token_filer+ r r, r r r r r1 g s �� �r1 �v1� IsAttached)�version�name�fn� options_cls�28FzZ from uaclient.api.u.pro.status.is_attached.v1 import is_attached result = is_attached() z#pro api u.pro.status.is_attached.v1z� { "contract_remaining_days": 360, "contract_status": "active", "is_attached": true, "is_attached_and_contract_valid": true } a� .. tab-item:: Explanation :sync: explanation The ``contract_status`` field can return 4 different states, they are: * **active**: The contract is currently valid. * **grace-period**: The contract is in the grace period. This means that it is expired, but there are still some days where the contract will be valid. * **active-soon-to-expire**: The contract is almost expired, but still valid. * **expired**: The contract is expired and no longer valid. )� introduced_in�requires_network�example_python� result_class� exceptions� example_cli� example_json�extra) �enum�typingr r �uaclient.api.apir �uaclient.api.data_typesr �uaclient.configr �uaclient.data_typesr r r r r �uaclient.defaultsr r �uaclient.filesr r �unique�Enumr" r r! r0 r r1 �endpoint�_docr r r r �<module> sJ ,��� �� � pro/status/is_attached/__init__.py 0000644 00000000000 15030103444 0013230 0 ustar 00 pro/status/enabled_services/v1.py 0000644 00000010152 15030103444 0013055 0 ustar 00 from typing import List, Optional from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo, ErrorWarningObject from uaclient.api.u.pro.status.is_attached.v1 import _is_attached from uaclient.config import UAConfig from uaclient.data_types import ( BoolDataValue, DataObject, Field, StringDataValue, data_list, ) class EnabledService(DataObject): fields = [ Field("name", StringDataValue, doc="Name of the service"), Field( "variant_enabled", BoolDataValue, doc="If a variant of the service is enabled", ), Field( "variant_name", StringDataValue, False, doc="Name of the variant, if a variant is enabled", ), ] def __init__( self, *, name: str, variant_enabled: bool = False, variant_name: Optional[str] = None ): self.name = name self.variant_enabled = variant_enabled self.variant_name = variant_name class EnabledServicesResult(DataObject, AdditionalInfo): fields = [ Field( "enabled_services", data_list(EnabledService), doc="A list of ``EnabledService`` objects", ), ] def __init__(self, *, enabled_services: List[EnabledService]): self.enabled_services = enabled_services def enabled_services() -> EnabledServicesResult: return _enabled_services(UAConfig()) def _enabled_services(cfg: UAConfig) -> EnabledServicesResult: """ This endpoint shows the Pro services that are enabled on the machine. """ from uaclient.entitlements import ENTITLEMENT_CLASSES from uaclient.entitlements.entitlement_status import UserFacingStatus if not _is_attached(cfg).is_attached: return EnabledServicesResult(enabled_services=[]) enabled_services = [] # type: List[EnabledService] warnings = [] # type: List[ErrorWarningObject] for ent_cls in ENTITLEMENT_CLASSES: ent = ent_cls(cfg) ent_status, details = ent.user_facing_status() if ent_status in (UserFacingStatus.ACTIVE, UserFacingStatus.WARNING): ent_name = ent.presentation_name enabled_service = EnabledService(name=ent_name) for _, variant_cls in ent.variants.items(): variant = variant_cls(cfg) if variant.user_facing_status()[0] == UserFacingStatus.ACTIVE: enabled_service = EnabledService( name=ent_name, variant_enabled=True, variant_name=variant.variant_name, ) break enabled_services.append(enabled_service) if ent_status == UserFacingStatus.WARNING and details: warnings.append( ErrorWarningObject( title=details.msg or "", code=details.name or "", meta={"service": ent_name}, ) ) result = EnabledServicesResult( enabled_services=sorted(enabled_services, key=lambda x: x.name), ) result.warnings = warnings return result endpoint = APIEndpoint( version="v1", name="EnabledServices", fn=_enabled_services, options_cls=None, ) _doc = { "introduced_in": "28", "requires_network": False, "example_python": """ from uaclient.api.u.pro.status.enabled_services.v1 import enabled_services result = enabled_services() """, # noqa: E501 "result_class": EnabledServicesResult, "exceptions": [], "example_cli": "pro api u.pro.status.enabled_services.v1", "example_json": """ { "enabled_services": [ { "name": "esm-apps", "variant_enabled": false, "variant_name": null }, { "name": "esm-infra", "variant_enabled": false, "variant_name": null }, { "name": "realtime-kernel", "variant_enabled": true, "variant_name": "raspi" } ] } """, } pro/status/enabled_services/__pycache__/__init__.cpython-310.pyc 0000644 00000000262 15030103444 0020626 0 ustar 00 o �ϴf � @ s d S )N� r r r �U/usr/lib/python3/dist-packages/uaclient/api/u/pro/status/enabled_services/__init__.py�<module> s pro/status/enabled_services/__pycache__/v1.cpython-310.pyc 0000644 00000007256 15030103444 0017427 0 ustar 00 o �(�fj � @ s� d dl mZmZ d dlmZ d dlmZmZ d dlm Z d dl m Z d dl m Z mZmZmZmZ G dd� de�ZG d d � d ee�Zd efd d �Zde d efdd�Zeddedd�Zdddeg ddd�ZdS )� )�List�Optional)� APIEndpoint)�AdditionalInfo�ErrorWarningObject)� _is_attached)�UAConfig)� BoolDataValue� DataObject�Field�StringDataValue� data_listc @ sX e Zd Zededd�ededd�ededdd�gZdd d �dedede e fd d �Z d S ) �EnabledService�namezName of the service��doc�variant_enabledz&If a variant of the service is enabled� variant_nameFz,Name of the variant, if a variant is enabledN)r r c C s || _ || _|| _d S �N�r r r )�selfr r r � r �O/usr/lib/python3/dist-packages/uaclient/api/u/pro/status/enabled_services/v1.py�__init__ s zEnabledService.__init__) �__name__� __module__� __qualname__r r r �fields�str�boolr r r r r r r s. �������r c @ s2 e Zd Zedee�dd�gZdee fdd�ZdS )�EnabledServicesResult�enabled_servicesz$A list of ``EnabledService`` objectsr c C s || _ d S r �r! )r r! r r r r 5 � z EnabledServicesResult.__init__N) r r r r r r r r r r r r r r , s ��r �returnc C s t t� �S r )�_enabled_servicesr r r r r r! 9 r# r! �cfgc C s ddl m} ddlm} t| �jstg d�S g }g }|D ][}|| �}|�� \}}||j|j fv rw|j } t | d�} |j � � D ]\} } | | �} | �� d |jkrXt | d| jd�} nq=|�| � ||j krw|rw|�t|jpld|jppdd | id �� q tt|d d � d �d�}||_|S )zO This endpoint shows the Pro services that are enabled on the machine. r )�ENTITLEMENT_CLASSES)�UserFacingStatusr" �r Tr � �service)�title�code�metac S s | j S r r) )�xr r r �<lambda>h s z#_enabled_services.<locals>.<lambda>)�key)�uaclient.entitlementsr' �(uaclient.entitlements.entitlement_statusr( r � is_attachedr �user_facing_status�ACTIVE�WARNING�presentation_namer �variants�itemsr �appendr �msgr �sorted�warnings)r& r' r( r! r> �ent_cls�ent� ent_status�details�ent_name�enabled_service�_� variant_cls�variant�resultr r r r% = sJ �� ����r% �v1�EnabledServicesN)�versionr �fn� options_cls�28Fzi from uaclient.api.u.pro.status.enabled_services.v1 import enabled_services result = enabled_services() z(pro api u.pro.status.enabled_services.v1a� { "enabled_services": [ { "name": "esm-apps", "variant_enabled": false, "variant_name": null }, { "name": "esm-infra", "variant_enabled": false, "variant_name": null }, { "name": "realtime-kernel", "variant_enabled": true, "variant_name": "raspi" } ] } )� introduced_in�requires_network�example_python� result_class� exceptions� example_cli� example_json)�typingr r �uaclient.api.apir �uaclient.api.data_typesr r �(uaclient.api.u.pro.status.is_attached.v1r �uaclient.configr �uaclient.data_typesr r r r r r r r! r% �endpoint�_docr r r r �<module> s0 2� � pro/status/enabled_services/__init__.py 0000644 00000000000 15030103444 0014255 0 ustar 00 pro/status/__init__.py 0000644 00000000000 15030103444 0010760 0 ustar 00 pro/__init__.py 0000644 00000000000 15030103444 0007435 0 ustar 00 unattended_upgrades/__pycache__/__init__.cpython-310.pyc 0000644 00000000252 15030103444 0017232 0 ustar 00 o �ϴf � @ s d S )N� r r r �M/usr/lib/python3/dist-packages/uaclient/api/u/unattended_upgrades/__init__.py�<module> s unattended_upgrades/status/v1.py 0000644 00000026403 15030103444 0013013 0 ustar 00 import datetime import os from typing import Dict, List, Optional, Tuple, Union from uaclient import apt, exceptions, messages, system from uaclient.api.api import APIEndpoint from uaclient.api.data_types import AdditionalInfo from uaclient.api.exceptions import UnattendedUpgradesError from uaclient.apt import get_apt_config_keys, get_apt_config_values from uaclient.config import UAConfig from uaclient.data_types import ( BoolDataValue, DataObject, DatetimeDataValue, Field, IntDataValue, StringDataValue, data_list, ) UNATTENDED_UPGRADES_CONFIG_KEYS = [ "APT::Periodic::Enable", "APT::Periodic::Update-Package-Lists", "APT::Periodic::Unattended-Upgrade", "Unattended-Upgrade::Allowed-Origins", ] UNATTENDED_UPGRADES_STAMP_PATH = "/var/lib/apt/periodic/upgrade-stamp" class UnattendedUpgradesDisabledReason(DataObject): fields = [ Field("msg", StringDataValue, doc="Human readable reason"), Field("code", StringDataValue, doc="Reason code"), ] def __init__(self, msg: str, code: str): self.msg = msg self.code = code class UnattendedUpgradesStatusResult(DataObject, AdditionalInfo): fields = [ Field( "systemd_apt_timer_enabled", BoolDataValue, doc="Indicate if the ``apt-daily.timer`` jobs are enabled", ), Field( "apt_periodic_job_enabled", BoolDataValue, doc=( "Indicate if the ``APT::Periodic::Enabled`` configuration is" " turned off" ), ), Field( "package_lists_refresh_frequency_days", IntDataValue, doc=( "The value of the ``APT::Periodic::Update-Package-Lists``" " configuration" ), ), Field( "unattended_upgrades_frequency_days", IntDataValue, doc=( "The value of the ``APT::Periodic::Unattended-Upgrade``" " configuration" ), ), Field( "unattended_upgrades_allowed_origins", data_list(StringDataValue), doc=( "The value of the ``Unattended-Upgrade::Allowed-Origins``" " configuration" ), ), Field( "unattended_upgrades_running", BoolDataValue, doc=( "Indicate if the ``unattended-upgrade`` service is correctly" " configured and running" ), ), Field( "unattended_upgrades_disabled_reason", UnattendedUpgradesDisabledReason, required=False, doc=( "Object that explains why ``unattended-upgrades`` is not" " running -- if the application is running, the object will be" " null" ), ), Field( "unattended_upgrades_last_run", DatetimeDataValue, required=False, doc="The last time ``unattended-upgrades`` ran", ), ] def __init__( self, *, systemd_apt_timer_enabled: bool, apt_periodic_job_enabled: bool, package_lists_refresh_frequency_days: int, unattended_upgrades_frequency_days: int, unattended_upgrades_allowed_origins: List[str], unattended_upgrades_running: bool, unattended_upgrades_disabled_reason: Optional[ UnattendedUpgradesDisabledReason ], unattended_upgrades_last_run: Optional[datetime.datetime] ): self.systemd_apt_timer_enabled = systemd_apt_timer_enabled self.apt_periodic_job_enabled = apt_periodic_job_enabled self.package_lists_refresh_frequency_days = ( package_lists_refresh_frequency_days ) self.unattended_upgrades_frequency_days = ( unattended_upgrades_frequency_days ) self.unattended_upgrades_allowed_origins = ( unattended_upgrades_allowed_origins ) self.unattended_upgrades_running = unattended_upgrades_running self.unattended_upgrades_disabled_reason = ( unattended_upgrades_disabled_reason ) self.unattended_upgrades_last_run = unattended_upgrades_last_run def _get_apt_daily_job_status() -> bool: try: apt_daily_job_enabled = system.is_systemd_unit_active( "apt-daily.timer" ) apt_daily_upgrade_job_enabled = system.is_systemd_unit_active( "apt-daily-upgrade.timer" ) systemd_apt_timer_enabled = ( apt_daily_job_enabled and apt_daily_upgrade_job_enabled ) except exceptions.ProcessExecutionError as e: raise UnattendedUpgradesError(error_msg=str(e)) return systemd_apt_timer_enabled def _is_unattended_upgrades_running( systemd_apt_timer_enabled: bool, unattended_upgrades_cfg: Dict[str, Union[str, List[str]]], ) -> Tuple[bool, Optional[messages.NamedMessage]]: if not systemd_apt_timer_enabled: return (False, messages.UNATTENDED_UPGRADES_SYSTEMD_JOB_DISABLED) for key, value in unattended_upgrades_cfg.items(): if not value: return ( False, messages.UNATTENDED_UPGRADES_CFG_LIST_VALUE_EMPTY.format( cfg_name=key ), ) if isinstance(value, str) and value == "0": return ( False, messages.UNATTENDED_UPGRADES_CFG_VALUE_TURNED_OFF.format( cfg_name=key ), ) return (True, None) def _get_unattended_upgrades_last_run() -> Optional[datetime.datetime]: try: creation_epoch = os.path.getctime(UNATTENDED_UPGRADES_STAMP_PATH) except FileNotFoundError: return None return datetime.datetime.fromtimestamp(creation_epoch) def status() -> UnattendedUpgradesStatusResult: return _status(UAConfig()) def _status(cfg: UAConfig) -> UnattendedUpgradesStatusResult: """ This endpoint returns the status around ``unattended-upgrades``. The focus of the endpoint is to verify if the application is running and how it is configured on the machine. .. important:: For this endpoint, we deliver a unique key under ``meta`` called ``raw_config``. This field contains all related ``unattended-upgrades`` configurations, unparsed. This means that this field will maintain both original name and values for those configurations. """ if not apt.is_installed("unattended-upgrades"): return UnattendedUpgradesStatusResult( systemd_apt_timer_enabled=False, apt_periodic_job_enabled=False, package_lists_refresh_frequency_days=0, unattended_upgrades_frequency_days=0, unattended_upgrades_allowed_origins=[], unattended_upgrades_disabled_reason=UnattendedUpgradesDisabledReason( # noqa msg=messages.UNATTENDED_UPGRADES_UNINSTALLED.msg, code=messages.UNATTENDED_UPGRADES_UNINSTALLED.name, ), unattended_upgrades_running=False, unattended_upgrades_last_run=None, ) systemd_apt_timer_enabled = _get_apt_daily_job_status() unattended_upgrades_last_run = _get_unattended_upgrades_last_run() unattended_upgrades_cfg = get_apt_config_values( set( UNATTENDED_UPGRADES_CONFIG_KEYS + get_apt_config_keys("Unattended-Upgrade") ) ) # If that key is not present on the APT Config, we assume it # that the config is "enabled", as by default this configuration # will not be present in APT unattended_upgrades_cfg["APT::Periodic::Enable"] = ( unattended_upgrades_cfg["APT::Periodic::Enable"] or "1" ) ( unattended_upgrades_running, disabled_reason, ) = _is_unattended_upgrades_running( systemd_apt_timer_enabled, unattended_upgrades_cfg ) if disabled_reason: unattended_upgrades_disabled_reason = UnattendedUpgradesDisabledReason( msg=disabled_reason.msg, code=disabled_reason.name, ) else: unattended_upgrades_disabled_reason = None unattended_upgrades_result = UnattendedUpgradesStatusResult( systemd_apt_timer_enabled=systemd_apt_timer_enabled, apt_periodic_job_enabled=str( unattended_upgrades_cfg.get("APT::Periodic::Enable", "") ) == "1", package_lists_refresh_frequency_days=int( unattended_upgrades_cfg.get( # type: ignore "APT::Periodic::Update-Package-Lists", 0 ) ), unattended_upgrades_frequency_days=int( unattended_upgrades_cfg.get( # type: ignore "APT::Periodic::Unattended-Upgrade", 0 ) ), unattended_upgrades_allowed_origins=list( unattended_upgrades_cfg.get("Unattended-Upgrade::Allowed-Origins") or [] ), unattended_upgrades_disabled_reason=( unattended_upgrades_disabled_reason ), unattended_upgrades_running=unattended_upgrades_running, unattended_upgrades_last_run=unattended_upgrades_last_run, ) unattended_upgrades_result.meta = {"raw_config": unattended_upgrades_cfg} return unattended_upgrades_result endpoint = APIEndpoint( version="v1", name="UnattendedUpgradesStatus", fn=_status, options_cls=None, ) _doc = { "introduced_in": "27.14", "requires_network": False, "example_python": """ from uaclient.api.u.unattended_upgrades.status.v1 import status result = status() """, "result_class": UnattendedUpgradesStatusResult, "exceptions": [ ( UnattendedUpgradesError, "Raised if we cannot run a necessary command to show the status of ``unattended-upgrades``", # noqa: E501 ) ], "example_cli": "pro api u.unattended_upgrades.status.v1", "example_json": """ { "apt_periodic_job_enabled": true, "package_lists_refresh_frequency_days": 1, "systemd_apt_timer_enabled": true, "unattended_upgrades_allowed_origins": [ "${distro_id}:${distro_codename}", "${distro_id}:${distro_codename}-security", "${distro_id}ESMApps:${distro_codename}-apps-security", "${distro_id}ESM:${distro_codename}-infra-security" ], "unattended_upgrades_disabled_reason": null, "unattended_upgrades_frequency_days": 1, "unattended_upgrades_last_run": null, "unattended_upgrades_running": true } """, "extra": """ - Possible attributes in JSON ``meta`` field: .. code-block:: json { "meta": { "environment_vars": [], "raw_config": { "APT::Periodic::Enable": "1", "APT::Periodic::Unattended-Upgrade": "1", "APT::Periodic::Update-Package-Lists": "1", "Unattended-Upgrade::Allowed-Origins": [ "${distro_id}:${distro_codename}", "${distro_id}:${distro_codename}-security", "${distro_id}ESMApps:${distro_codename}-apps-security", "${distro_id}ESM:${distro_codename}-infra-security" ] } } } """, "extra_indent": 2, } unattended_upgrades/status/__pycache__/__init__.cpython-310.pyc 0000644 00000000261 15030103444 0020555 0 ustar 00 o �ϴf � @ s d S )N� r r r �T/usr/lib/python3/dist-packages/uaclient/api/u/unattended_upgrades/status/__init__.py�<module> s unattended_upgrades/status/__pycache__/v1.cpython-310.pyc 0000644 00000017202 15030103444 0017347 0 ustar 00 o �(�f- � @ s� d dl Z d dlZd dlmZmZmZmZmZ d dlm Z m Z m Z m Z d dl mZ d dlmZ d dlmZ d dlmZmZ d dlmZ d d lmZmZmZm Z m Z m Z m Z g d �Z d Z!G d d � d e�Z"G dd� dee�Z#de$fdd�Z%de$dee&ee&ee& f f dee$ee j' f fdd�Z(dee j fdd�Z)de#fdd�Z*dede#fd d �Z+ed d e+dd �Z,d!d"d#e#ed$fgd%d&d'd(d)� Z-dS )*� N)�Dict�List�Optional�Tuple�Union)�apt� exceptions�messages�system)� APIEndpoint)�AdditionalInfo)�UnattendedUpgradesError)�get_apt_config_keys�get_apt_config_values)�UAConfig)� BoolDataValue� DataObject�DatetimeDataValue�Field� IntDataValue�StringDataValue� data_list)�APT::Periodic::Enable�#APT::Periodic::Update-Package-Lists�!APT::Periodic::Unattended-Upgrade�#Unattended-Upgrade::Allowed-Originsz#/var/lib/apt/periodic/upgrade-stampc @ s: e Zd Zededd�ededd�gZdedefdd�ZdS ) � UnattendedUpgradesDisabledReason�msgzHuman readable reason��doc�codez Reason codec C s || _ || _d S �N�r r )�selfr r � r$ �N/usr/lib/python3/dist-packages/uaclient/api/u/unattended_upgrades/status/v1.py�__init__% s z)UnattendedUpgradesDisabledReason.__init__N)�__name__� __module__� __qualname__r r �fields�strr& r$ r$ r$ r% r s �r c @ s� e Zd Zededd�ededd�ededd�eded d�ed ee�d d�ed ed d�ededdd�ede ddd�gZ de de de de d e e d e dee deej fdd�ZdS )� UnattendedUpgradesStatusResult�systemd_apt_timer_enabledz4Indicate if the ``apt-daily.timer`` jobs are enabledr �apt_periodic_job_enabledzFIndicate if the ``APT::Periodic::Enabled`` configuration is turned off�$package_lists_refresh_frequency_dayszFThe value of the ``APT::Periodic::Update-Package-Lists`` configuration�"unattended_upgrades_frequency_dayszDThe value of the ``APT::Periodic::Unattended-Upgrade`` configuration�#unattended_upgrades_allowed_originszFThe value of the ``Unattended-Upgrade::Allowed-Origins`` configuration�unattended_upgrades_runningzRIndicate if the ``unattended-upgrade`` service is correctly configured and running�#unattended_upgrades_disabled_reasonFzyObject that explains why ``unattended-upgrades`` is not running -- if the application is running, the object will be null)�requiredr � unattended_upgrades_last_runz)The last time ``unattended-upgrades`` ranc C s4 || _ || _|| _|| _|| _|| _|| _|| _d S r! )r- r. r/ r0 r1 r2 r3 r5 ) r# r- r. r/ r0 r1 r2 r3 r5 r$ r$ r% r& k s ���� z'UnattendedUpgradesStatusResult.__init__N)r' r( r) r r r r r r r r* �bool�intr r+ r �datetimer& r$ r$ r$ r% r, * s~ ������� ��@������ �� �r, �returnc C sL zt �d�} t �d�}| o|}W |S tjy% } ztt|�d��d }~ww )Nzapt-daily.timerzapt-daily-upgrade.timer)� error_msg)r �is_systemd_unit_activer �ProcessExecutionErrorr r+ )�apt_daily_job_enabled� apt_daily_upgrade_job_enabledr- �er$ r$ r% �_get_apt_daily_job_status� s ������r@ r- �unattended_upgrades_cfgc C sf | sdt jfS |�� D ]%\}}|s dt jj|d�f S t|t�r0|dkr0dt jj|d�f S q dS )NF)�cfg_name�0)TN)r �(UNATTENDED_UPGRADES_SYSTEMD_JOB_DISABLED�items�(UNATTENDED_UPGRADES_CFG_LIST_VALUE_EMPTY�format� isinstancer+ �(UNATTENDED_UPGRADES_CFG_VALUE_TURNED_OFF)r- rA �key�valuer$ r$ r% � _is_unattended_upgrades_running� s" �����rL c C s2 zt j�t�} W n ty Y d S w tj�| �S r! )�os�path�getctime� UNATTENDED_UPGRADES_STAMP_PATH�FileNotFoundErrorr8 � fromtimestamp)�creation_epochr$ r$ r% �!_get_unattended_upgrades_last_run� s � rT c C s t t� �S r! )�_statusr r$ r$ r$ r% �status� s rV �cfgc C s� t �d�stddddg ttjjtjjd�ddd�S t� }t � }t t t t d� ��}|d p.d |d< t||�\}}|rCt|j|jd�}nd}t|t|�dd ��d kt|�d d��t|�d d��t|�d �peg �|||d�}d|i|_|S )a� This endpoint returns the status around ``unattended-upgrades``. The focus of the endpoint is to verify if the application is running and how it is configured on the machine. .. important:: For this endpoint, we deliver a unique key under ``meta`` called ``raw_config``. This field contains all related ``unattended-upgrades`` configurations, unparsed. This means that this field will maintain both original name and values for those configurations. zunattended-upgradesFr r" N)r- r. r/ r0 r1 r3 r2 r5 zUnattended-Upgrader �1� r r r � raw_config)r � is_installedr, r r � UNATTENDED_UPGRADES_UNINSTALLEDr �namer@ rT r �set� UNATTENDED_UPGRADES_CONFIG_KEYSr rL r+ �getr7 �list�meta)rW r- r5 rA r2 �disabled_reasonr3 �unattended_upgrades_resultr$ r$ r% rU � s� ����� ���� ������ �� rU �v1�UnattendedUpgradesStatus)�versionr] �fn� options_clsz27.14FzT from uaclient.api.u.unattended_upgrades.status.v1 import status result = status() zYRaised if we cannot run a necessary command to show the status of ``unattended-upgrades``z'pro api u.unattended_upgrades.status.v1a@ { "apt_periodic_job_enabled": true, "package_lists_refresh_frequency_days": 1, "systemd_apt_timer_enabled": true, "unattended_upgrades_allowed_origins": [ "${distro_id}:${distro_codename}", "${distro_id}:${distro_codename}-security", "${distro_id}ESMApps:${distro_codename}-apps-security", "${distro_id}ESM:${distro_codename}-infra-security" ], "unattended_upgrades_disabled_reason": null, "unattended_upgrades_frequency_days": 1, "unattended_upgrades_last_run": null, "unattended_upgrades_running": true } a� - Possible attributes in JSON ``meta`` field: .. code-block:: json { "meta": { "environment_vars": [], "raw_config": { "APT::Periodic::Enable": "1", "APT::Periodic::Unattended-Upgrade": "1", "APT::Periodic::Update-Package-Lists": "1", "Unattended-Upgrade::Allowed-Origins": [ "${distro_id}:${distro_codename}", "${distro_id}:${distro_codename}-security", "${distro_id}ESMApps:${distro_codename}-apps-security", "${distro_id}ESM:${distro_codename}-infra-security" ] } } } � ) � introduced_in�requires_network�example_python� result_classr � example_cli� example_json�extra� extra_indent).r8 rM �typingr r r r r �uaclientr r r r �uaclient.api.apir �uaclient.api.data_typesr �uaclient.api.exceptionsr � uaclient.aptr r �uaclient.configr �uaclient.data_typesr r r r r r r r_ rP r r, r6 r@ r+ � NamedMessagerL rT rV rU �endpoint�_docr$ r$ r$ r% �<module> sX $ a�� � [��� � unattended_upgrades/status/__init__.py 0000644 00000000000 15030103444 0014205 0 ustar 00 unattended_upgrades/__init__.py 0000644 00000000000 15030103444 0012662 0 ustar 00 __init__.py 0000644 00000000000 15030103444 0006635 0 ustar 00
| ver. 1.4 |
Github
|
.
| PHP 8.2.28 | Generation time: 0.03 |
proxy
|
phpinfo
|
Settings