File manager - Edit - /usr/lib/python3/dist-packages/uaclient/api/u/pro/security/fix/cve/execute/__pycache__/v1.cpython-310.pyc
Back
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 �� �� �
| ver. 1.4 |
Github
|
.
| PHP 8.2.28 | Generation time: 0.02 |
proxy
|
phpinfo
|
Settings