File: //lib/python3/dist-packages/uaclient/__pycache__/config.cpython-310.pyc
o
S��c�a � @ sL d dl Z d dlZd dlZd dlZd dlmZ d dlmZmZ d dl m
Z
m Z m Z m
Z
mZmZ d dlZd dlmZmZmZmZmZmZmZmZ d dlmZm Z m Z m Z m Z m Z d dl!m"Z" e�#e$�Z%dZ&d d
d �Z'd Z(d
Z)dZ*edd�Z+e�,� Z-ede.d�Z/de de/f de/fdd�Z0G dd� d�Z1de.fdd�Z2d!d d �Z3d e.fd d �Z4dS )"� N)�
namedtuple)� lru_cache�wraps)�Any�Callable�Dict�Optional�Tuple�TypeVar)�apt� event_logger�
exceptions�files�messages�snap�system�util)� APT_NEWS_URL�BASE_CONTRACT_URL�BASE_SECURITY_URL�CONFIG_DEFAULTS� CONFIG_FIELD_ENVVAR_ALLOWLIST�DEFAULT_CONFIG_FILE)�
NoticeFile�private�name�type)�availableResources�resourceEntitlements�_unset) �
http_proxy� https_proxy�apt_http_proxy�apt_https_proxy�ua_apt_http_proxy�ua_apt_https_proxy�global_apt_http_proxy�global_apt_https_proxy�update_messaging_timer�metering_timer�apt_news� apt_news_url)
� contract_url�data_dir�features�log_file� log_level� security_url�settings_overrides�timer_log_file�daemon_log_file� ua_config�DataPath)�filenamer � permanent�S)�bound�func.�returnc C s
t � | �S �N)r )r; � r> �1/usr/lib/python3/dist-packages/uaclient/config.py� str_cacheR s
r@ c @ s� e Zd Zeddd�eddd�eddd�eddd�eddd�eddd�d �Zd
Zd Zd Z
dmdee e
e f dee
de dd
fdd�Z
edd� �Zedd� �Zede
fdd��Zede
fdd��Zedee
fd d ��Zejd e
fd d ��Zedee
fd d!��Zejd e
fd"d!��Zedee
fd#d$��Zejd e
fd%d$��Zedee
fd&d'��Zejd e
fd(d'��Zeedee
fd)d*���Zejd e
fd+d*��Zeedee
fd,d-���Zejd e
fd.d-��Zedee fd/d0��Z e jd efd1d0��Z ednd3d4��Z e jd efd5d4��Z ede fd6d7��Z e jd e fd8d7��Z edefd9d:��Z e jd efd;d:��Z ede fd<d=��Z e jd e fd>d=��Z ede
fd?d@��Z!e!jd e
fdAd@��Z!de"ee
f fdBdC�Z#edDdE� �Z$edFdG� �Z%ede
fdHdI��Z&ede
fdJdK��Z'edLdM� �Z(edNdO� �Z)edPdQ� �Z*edRdS� �Z+dodTee
de
fdUdV�Z,dTe
de fdWdX�Z-dYe
dd
fdZd[�Z.dTe
dd
fd\d]�Z/dpd^e fd_d`�Z0dpdTe
dae dee fdbdc�Z1dTe
dde dd
fdedf�Z2dgdh� Z3dodidj�Z4dkdl� Z5d
S )q�UAConfig� instance-idTFzmachine-access-cis.json�lockz status.jsonz notices.jsonzmarker-reboot-cmds-required)rB zmachine-access-cisrC z status-cache�noticeszmarker-reboot-cmds)r$ r% )r& r' )r" r# N�cfg�series� root_moder< c C sN |r d| _ || _d| _n
t� | _ t| j �\| _| _|| _|| _d| _d| _dS )� N) �cfg_pathrE � invalid_keys�get_config_path� parse_configrF rG �_machine_token_file� _notice_file)�selfrE rF rG r> r> r? �__init__m s �
zUAConfig.__init__c C s( | j st�| j| j| j�d��| _ | j S )N�machine_token_overlay)rM r �MachineTokenFiler- rG r. �get�rO r> r> r? �machine_token_file� s
�zUAConfig.machine_token_filec C s | j s t| j| j�| _ | j S r= )rN r r- rG rT r> r> r? � notice_file� s zUAConfig.notice_filec C � | j �dt�S )Nr, )rE rS r rT r> r> r? r, � � zUAConfig.contract_urlc C rW )Nr1 )rE rS r rT r> r> r? r1 � rX zUAConfig.security_urlc C � | j �di ��d�S �Nr5 r �rE rS rT r> r> r? r � � zUAConfig.http_proxy�valuec C �. d| j vr
i | j d< || j d d< | �� d S rZ �rE � write_cfg�rO r] r> r> r? r � �
c C rY �Nr5 r! r[ rT r> r> r? r! � r\ zUAConfig.https_proxyc C r^ rc r_ ra r> r> r? r! � rb c C rY �Nr5 r% r[ rT r> r> r? r% � r\ zUAConfig.ua_apt_https_proxyc C r^ rd r_ ra r> r> r? r% � rb c C rY �Nr5 r$ r[ rT r> r> r? r$ � r\ zUAConfig.ua_apt_http_proxyc C r^ re r_ ra r> r> r? r$ � rb c C �H | j �di ��d�}|r|S | j �di ��d�}|r"t�tj� |S d S �Nr5 r& r" )rE rS �event�infor �WARNING_DEPRECATED_APT_HTTP�rO �
global_val� old_apt_valr> r> r? r& � s z UAConfig.global_apt_http_proxyc C �H d| j vr
i | j d< || j d d< d | j d d< tjj�� | �� d S rg )rE rA r& �fget� cache_clearr` ra r> r> r? r& � �
c C rf �Nr5 r' r# )rE rS rh ri r � WARNING_DEPRECATED_APT_HTTPSrk r> r> r? r' � s � z UAConfig.global_apt_https_proxyc C rn rr )rE rA r' ro rp r` ra r> r> r? r' � rq c C rY �Nr5 r( r[ rT r> r> r? r( � r\ z UAConfig.update_messaging_timerc C r^ rt r_ ra r> r> r? r( � rb �
Optional[int]c C rY �Nr5 r) r[ rT r> r> r? r) r\ zUAConfig.metering_timerc C r^ rv r_ ra r> r> r? r) rb c C � | j �di ��dd�S )Nr5 �poll_for_pro_licenseFr[ rT r> r> r? rx s z UAConfig.poll_for_pro_licensec C r^ )Nr5 rx r_ ra r> r> r? rx rb c C rw )Nr5 �polling_error_retry_delayiX r[ rT r> r> r? ry s �z"UAConfig.polling_error_retry_delayc C r^ )Nr5 ry r_ ra r> r> r? ry ! rb c C rw )Nr5 r* Tr[ rT r> r> r? r* ( � zUAConfig.apt_newsc C r^ )Nr5 r* r_ ra r> r> r? r* , rb c C s | j �di ��dt�S �Nr5 r+ )rE rS r rT r> r> r? r+ 3 rz zUAConfig.apt_news_urlc C r^ r{ r_ ra r> r> r? r+ 7 rb c C s� | � d�}d}tj�|�s|S t�|�}|�d�\}}zt�d|g� t|�|fW S t j
yV t� � dkrFt �
d||� t|�|f Y S t �d||� t�|� | Y S w )a] Return lock info if config lock file is present the lock is active.
If process claiming the lock is no longer present, remove the lock file
and log a warning.
:param lock_path: Full path to the lock file.
:return: A tuple (pid, string describing lock holder)
If no active lock, pid will be -1.
rC )���rH �:�psr z.Found stale lock file previously held by %s:%sz1Removing stale lock file previously held by %s:%s)� data_path�os�path�existsr � load_file�split�subp�intr
�ProcessExecutionError�getuid�logging�debug�warning�ensure_file_absent)rO � lock_path�no_lock� lock_content�lock_pid� lock_holderr> r> r? �check_lock_info> s2
��
�zUAConfig.check_lock_infoc C s
| j d S )Nr- )rE rT r> r> r? r- b s
zUAConfig.data_dirc C s@ | j �dd�}ztt|�� �W S ty tttd � Y S w )Nr0 �DEBUG)rE rS �getattrr� �upper�AttributeErrorr )rO r0 r> r> r? r0 f s �zUAConfig.log_levelc C � | j �dtd �S )Nr/ �rE rS r rT r> r> r? r/ n s zUAConfig.log_filec C r� )Nr3 r� rT r> r> r? r3 r � �zUAConfig.timer_log_filec C r� )Nr4 r� rT r> r> r? r4 x r� zUAConfig.daemon_log_filec C s
t | j�S )z<Report whether this machine configuration is attached to UA.)�bool�
machine_tokenrT r> r> r? � is_attached~ s
zUAConfig.is_attachedc C s. | j �d�}|rt|t�r|S t�d|� i S )z>Return a dictionary of any features provided in uaclient.conf.r. zDUnexpected uaclient.conf features value. Expected dict, but found %s)rE rS �
isinstance�dictr� r� )rO r. r> r> r? r. � s
�zUAConfig.featuresc C s | j jS )zAReturn the machine-token if cached in the machine token response.)rU r� rT r> r> r? r� � s zUAConfig.machine_token�keyc C sh | j d }|stj�|t�S || jv r,| j| }|jr$tj�|t|j�S tj�||j�S tj�|t|�S )zAReturn the file path in the data directory represented by the keyr- )rE r� r� �join�PRIVATE_SUBDIR�
data_pathsr r7 )rO r� r- r r> r> r? r � s
�zUAConfig.data_pathc C s | � |�}tj�|�S r= )r r� r� r� �rO r� �
cache_pathr> r> r? �cache_key_exists� s
zUAConfig.cache_key_existsr� c C s t �|� dS )z�Delete the given cache_path if it exists.
(This is a separate method to allow easier disabling of deletion during
tests.)
N)r r� )rO r� r> r> r? �_perform_delete� s zUAConfig._perform_deletec C sL |st d��|�d�rd| _n |dkr| j�dd� | �|�}| �|� dS )zRemove specific cache file.z1Invalid or empty key provided to delete_cache_key�machine-accessNrC rH zOperation in progress.*)� RuntimeError�
startswithrM rV �remover r� r� r> r> r? �delete_cache_key� s �
zUAConfig.delete_cache_key�delete_permanentc C s. | j �� D ]}|s| j | js| �|� qdS )z�
Remove configuration cached response files class attributes.
:param delete_permanent: even delete the "permanent" files
N)r� �keysr8 r� )rO r� �path_keyr> r> r? � delete_cache� s
��zUAConfig.delete_cache�silentc C st | � |�}zt�|�}W n ty$ tj�|�s!|s!t�d|� Y d S w z t j
|t j d�W S t
y9 | Y S w )NzFile does not exist: %s��cls)r r r� � Exceptionr� r� r� r� r� �json�loadsr �DatetimeAwareJSONDecoder�
ValueError)rO r� r� r� �contentr> r> r? �
read_cache� s
� �zUAConfig.read_cacher� c C s� | � |�}tj�|�}tj�|�s&tj|dd� tj�|�tkr&t�|d� |� d�r/d | _
n|dkrFd|v rF| j � dd�
|�d�d �� t|t�sStj|tjd
�}d }|| jv rb| j| jsbd }tj|||d
� d S )NT)�exist_oki� r� rC r} rH zOperation in progress: {}� r� i� i� )�mode)r r� r� �dirnamer� �makedirs�basenamer� �chmodr� rM rV �add�formatr� r� �strr� �dumpsr �DatetimeAwareJSONEncoderr� r r �
write_file)rO r� r� �filepathr- r� r> r> r? � write_cache� s*
�
zUAConfig.write_cachec C s dD ]$}t | |�}|d u rt�d� qt|t�r |dk r&d�|�}t�|��q| js-| j r9| j
s3| j r9t�t j
��t�d| jtj� t�d| j tj� t�d| j
tj� t�d| j tj� t�d| jtj� t�d| jtj� | jsu| j r�t�| j| j tjj� n| j
s�| j r�t�| j
| j tjj� g }t� � r�t� | j| j� | js�t� tj �s�| js�t� tj �r�|�!d� ddl"m#} dd l$m%} |�&� }|�'� \}} ||j(kr�|�)| j| j� | js�|� |j �s�| js�|� |j �r�|�!d
� t*|�dk�rd �+|�}
t,t j-j|
d �� d S d S )
N)r( r) z1No config set for {}, default value will be used.r zQValue for the {} interval must be a positive integer. Default value will be used.�http�httpsr )� livepatch)�ApplicationStatusr� z, )�services).r� r� r� r� r� r� r
�UserFacingErrorr& r' r$ r% r �ERROR_PROXY_CONFIGURATIONr �validate_proxy� PROXY_VALIDATION_APT_HTTP_URL� PROXY_VALIDATION_APT_HTTPS_URLr � PROXY_VALIDATION_SNAP_HTTP_URLr! � PROXY_VALIDATION_SNAP_HTTPS_URLr �setup_apt_proxy�
AptProxyScope�GLOBAL�UACLIENTr � is_installed�configure_snap_proxy�get_config_option_value�HTTP_PROXY_OPTION�HTTPS_PROXY_OPTION�append�uaclient.entitlementsr� �(uaclient.entitlements.entitlement_statusr� �LivepatchEntitlement�application_status�ENABLED�configure_livepatch_proxy�lenr� �print�!PROXY_DETECTED_BUT_NOT_CONFIGURED) rO �propr] � error_msg�services_with_proxiesr� r� �
livepatch_ent�livepatch_status�_r� r> r> r? �process_config� s�
��
� �����
��
�
� � ��
��
�
�������
���zUAConfig.process_configc s~ |st }tj}t�� j�}d|vrtd |d< dD ] }t� |�||< q� fdd�tD �|d< |t j
|dd�7 }t � ||� dS ) z?Write config values back to config_path or DEFAULT_CONFIG_FILE.r0 )r, r1 r- r/ r3 r4 c s i | ] }|t � |d ��qS r= )r� )�.0r� rT r> r? �
<dictcomp>k s �z&UAConfig.write_cfg.<locals>.<dictcomp>r5 F)�default_flow_styleN)
r r �UACLIENT_CONF_HEADER�copy�deepcopyrE r r� �UA_CONFIGURABLE_KEYS�yaml�dumpr r� )rO � config_pathr� �cfg_dict�attrr> rT r? r` V s
�zUAConfig.write_cfgc C s. | j d urt| j �D ]
}t�d|� q
d S d S )Nz&Ignoring invalid uaclient.conf key: %s)rJ �sortedr� r� )rO � invalid_keyr> r> r? �warn_about_invalid_keysr s
��z UAConfig.warn_about_invalid_keys)NNF)r< ru r= )F)6�__name__�
__module__� __qualname__r6 r� �ua_scoped_proxy_options�global_scoped_proxy_options�&deprecated_global_scoped_proxy_optionsr r r� r r� rP �propertyrU rV r, r1 r �setterr! r% r$ r@ r& r' r� r( r) rx ry r* r+ r r� r- r0 r/ r3 r4 r� r. r� r r� r� r� r� r� r� r� r` r� r> r> r> r? rA V s�
�� ����
�
$
j rA c C sB t j�d�} | r
| S t j�t �� t j�t��}t j�|�r |S tS )z4Get config path to be used when loading config dict.�UA_CONFIG_FILE) r� �environrS r� r� �getcwdr� r r� )� config_file� local_cfgr> r> r? rK z s � rK c C st t � t�}| s
t� } t�d| � tj�| �r!|�t �
t � | ��� i }tj
�� D ]T\}}|�� }|�d�r||dd� }|�d�rt|dd� }|�d�rbtj�|�rZt �
t � |��}nt�d�|���d |vrm||i|d < q(||d |< q(|tv r||||< q(|�|� tj�|d
�|d
< d D ]}t�|| �s�t�d �||| ���q�t|�� ��t �}|D ]}|� |� q�||fS )
a� Parse known Pro config file
Attempt to find configuration in cwd and fallback to DEFAULT_CONFIG_FILE.
Any missing configuration keys will be set to CONFIG_DEFAULTS.
Values are overridden by any environment variable with prefix 'UA_'.
@param config_path: Fullpath to pro configfile. If unspecified, use
DEFAULT_CONFIG_FILE.
@return: Dict of configuration values.
z%Using client configuration file at %s�ua_� N� features_� r� z Could not find yaml file: {}r. r- )r, r1 z Invalid url in config. {}: {}) r� r rK �LOGr� r� r� r� �updater� � safe_loadr r� r �items�lowerr� �endswithr
r� r� r �
expanduserr �is_service_url�setr� �
difference�VALID_UA_CONFIG_KEYS�pop) r� rE �env_keysr� r] �
field_name�feature_field_namerJ r� r> r> r? rL � sJ
��
�� rL � override_keyc s � fdd�}|S )a� Decorator used to override function return by config settings.
To identify if we should override the function return, we check
if the config object has the expected override key, we use it
has, we will use the key value as the function return. Otherwise
we will call the function normally.
@param override_key: key to be looked for in the settings_override
entry in the config dict. If that key is present, we will return
its value as the function return.
c s t � �� �fdd��}|S )Nc s@ t � \} }| �di ���t�}|tkr �dkr|d fS |S � � S )Nr2 �
cloud_type)rL rS �UNSET_SETTINGS_OVERRIDE_KEY)rE r� �value_override)�fr r> r? �new_f� s
�z>apply_config_settings_override.<locals>.wrapper.<locals>.new_f)r )r" r# �r )r" r? �wrapper� s
z/apply_config_settings_override.<locals>.wrapperr> )r r% r> r$ r? � apply_config_settings_override� s
r& r= )5r� r� r� r� � collectionsr � functoolsr r �typingr r r r r r
r� �uaclientr r r
r r r r r �uaclient.defaultsr r r r r r �uaclient.filesr � getLoggerr� r r� �MERGE_ID_KEY_MAPr r� r r6 �get_event_loggerrh r� r9 r@ rA rK rL r& r> r> r> r? �<module> s> (
�
(
@