File: //usr/lib/python3/dist-packages/uaclient/__pycache__/config.cpython-310.pyc
o
nHJek\ � @ sr d dl Z d dlZd dlZd dlZd dlmZ d dlmZmZ d dl m
Z
m Z m Z m
Z
mZmZ d dlmZmZmZmZmZmZmZmZmZ d dlmZm Z m Z m Z m Z m Z m!Z!m"Z"m#Z# d dl$m%Z%m&Z& d dl'm(Z( d d l)m*Z* e�+e�,e-��Z.d
d d �Z/d
Z0dZ1dZ2edd�Z3e�4� Z5ede6d�Z7de de7f de7fdd�Z8G dd� d�Z9de6fdd �Z:d"d d �Z;d e6fd d!�Z<dS )#� N)�
namedtuple)� lru_cache�wraps)�Any�Callable�Dict�Optional�Tuple�TypeVar) �apt� event_logger�
exceptions�files�http�messages�snap�system�util) � APT_NEWS_URL�BASE_CONTRACT_URL�BASE_LIVEPATCH_URL�BASE_SECURITY_URL�CONFIG_DEFAULTS� CONFIG_FIELD_ENVVAR_ALLOWLIST�DEFAULT_CONFIG_FILE�DEFAULT_DATA_DIR�PRIVATE_SUBDIR)�notices� state_files)�Notice)� safe_load�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� ua_config�
livepatch_url�DataPath)�filename�private�S)�bound�func.�returnc C s
t � | �S �N)r )r@ � rC �1/usr/lib/python3/dist-packages/uaclient/config.py� str_cacheS s
rE c @ s~ e Zd Zedd�edd�edd�edd�d�ZdZd Zd
Z d^d ee e
e f d
ee j
dee
dd fdd�Zedd� �Zede
fdd��Zede
fdd��Zede
fdd��Zedee
fdd��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+��Zede fd-d.��Z e jd e fd/d.��Z ede fd0d1��Z e jd e fd2d1��Z ede fd3d4��Z e jd e fd5d4��Z ede fd6d7��Z!e!jd e fd8d7��Z!ede fd9d:��Z"e"jd e fd;d:��Z"ede
fd<d=��Z#e#jd e
fd>d=��Z#de$e e
f fd?d@�Z%edAdB� �Z&edCdD� �Z'ede
fdEdF��Z(edGdH� �Z)edIdJ� �Z*d_dKee
de
fdLdM�Z+dKe
de fdNdO�Z,dKe
dd fdPdQ�Z-dRdS� Z.d`dKe
dTe dee fdUdV�Z/dKe
dWe dd fdXdY�Z0dZd[� Z1d\d]� Z2d S )a�UAConfig� instance-idTzmachine-access-cis.json�lockFz status.json)rG zmachine-access-cisrH z status-cache)r* r+ )r, r- )r( r) N�cfg� user_config�seriesrA c
C s� |r d| _ || _d| _n
t� | _ t| j �\| _| _|r || _n0z tj�� p(t� � | _W n# t
yN } zt j d|d� t � d� t� � | _W Y d}~nd}~ww d| jv rgtj j
i | j�� �| jd �dd�| _|| _d| _dS )� NzError loading user config)�exc_infozUsing default config valuesr9 T)� optional_type_errors_become_null)�cfg_pathrI � invalid_keys�get_config_path� parse_configrJ r �user_config_file�read�UserConfigData� Exception�LOG�warning� from_dict�to_dictrK �_machine_token_file)�selfrI rJ rK �erC rC rD �__init__i s4
�
��
��zUAConfig.__init__c C s$ | j st�| j| j�d��| _ | j S )N�machine_token_overlay)r[ r �MachineTokenFiler3 r4 �get�r\ rC rC rD �machine_token_file� s
�zUAConfig.machine_token_filec C � | j �dt�S )Nr2 )rI ra r rb rC rC rD r2 � � zUAConfig.contract_urlc C rd )Nr7 )rI ra r rb rC rC rD r7 � re zUAConfig.security_urlc C rd )Nr: )rI ra r rb rC rC rD r: � re zUAConfig.livepatch_urlc C � | j jS rB )rJ r& rb rC rC rD r& � � zUAConfig.http_proxy�valuec C � || j _tj�| j � d S rB )rJ r& r rS �write�r\ rh rC rC rD r& � � c C rf rB )rJ r' rb rC rC rD r' � rg zUAConfig.https_proxyc C ri rB )rJ r' r rS rj rk rC rC rD r' � rl c C rf rB )rJ r+ rb rC rC rD r+ � rg zUAConfig.ua_apt_https_proxyc C ri rB )rJ r+ r rS rj rk rC rC rD r+ � rl c C rf rB )rJ r* rb rC rC rD r* � rg zUAConfig.ua_apt_http_proxyc C ri rB )rJ r* r rS rj rk rC rC rD r* � rl c C �: | j j}|r|S | j j}|rt�tjjddd�� |S d S )Nr( r, ��old�new)rJ r, r( �event�infor �WARNING_DEPRECATED_FIELD�format�r\ �
global_val� old_apt_valrC rC rD r, � � ��z UAConfig.global_apt_http_proxyc C �. || j _d | j _tjj�� tj�| j � d S rB ) rJ r, r( rF �fget� cache_clearr rS rj rk rC rC rD r, � � c C rm )Nr) r- rn )rJ r- r) rq rr r rs rt ru rC rC rD r- � rx z UAConfig.global_apt_https_proxyc C ry rB ) rJ r- r) rF rz r{ r rS rj rk rC rC rD r- � r| c C � | j j}|d u r
dS |S )Ni`T )rJ r. �r\ �valrC rC rD r. � � z UAConfig.update_messaging_timerc C ri rB )rJ r. r rS rj rk rC rC rD r. rl c C r} )Ni@8 )rJ r/ r~ rC rC rD r/ r� zUAConfig.metering_timerc C ri rB )rJ r/ r rS rj rk rC rC rD r/ rl c C r} )NF)rJ �poll_for_pro_licenser~ rC rC rD r� s z UAConfig.poll_for_pro_licensec C ri rB )rJ r� r rS rj rk rC rC rD r� rl c C r} )NiX )rJ �polling_error_retry_delayr~ rC rC rD r� " s z"UAConfig.polling_error_retry_delayc C ri rB )rJ r� r rS rj rk rC rC rD r� + rl c C r} )NT)rJ r0 r~ rC rC rD r0 0 r� zUAConfig.apt_newsc C ri rB )rJ r0 r rS rj rk rC rC rD r0 7 rl c C s | j j}|d u r
tS |S rB )rJ r1 r r~ rC rC rD r1 < r� zUAConfig.apt_news_urlc C ri rB )rJ r1 r rS rj rk rC rC rD r1 C rl c C s� | � d�}d}tj�|�s|S t�|�}z |�d�\}}W n ty0 tj tj�
| j d�d��w zt� d|g� t
|�|fW S tjyj t�� sZt�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.
rH )���rL �:)�lock_file_path�psz.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�
ValueErrorr
�InvalidLockFile�joinr3 �subp�int�ProcessExecutionErrorr �we_are_currently_rootrW �debugrX �ensure_file_absent)r\ � lock_path�no_lock� lock_content�lock_pid� lock_holderrC rC rD �check_lock_infoH s>
����
�zUAConfig.check_lock_infoc C rd )Nr3 )rI ra r rb rC rC rD r3 s re zUAConfig.data_dirc C s8 | j �dd�}ztt|�� �W S ty tj Y S w )Nr6 �DEBUG)rI ra �getattr�logging�upper�AttributeErrorr� )r\ r6 rC rC rD r6 w s
�zUAConfig.log_levelc C s | j �dtd �S )Nr5 )rI ra r rb rC rC rD r5 s zUAConfig.log_filec C s. | j �d�}|rt|t�r|S t�d|� i S )z>Return a dictionary of any features provided in uaclient.conf.r4 zDUnexpected uaclient.conf features value. Expected dict, but found %s)rI ra �
isinstance�dictrW rX )r\ r4 rC rC rD r4 � s
�zUAConfig.featuresc C rf )zAReturn the machine-token if cached in the machine token response.)rc �
machine_tokenrb rC rC rD r� � s zUAConfig.machine_token�keyc C sd | j }|s tj�|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 key)r3 r� r� r� r �
data_pathsr= r< )r\ r� r3 r� rC rC rD r� � s
�zUAConfig.data_pathc C s | � |�}tj�|�S rB )r� r� r� r� �r\ r� �
cache_pathrC rC rD �cache_key_exists� s
zUAConfig.cache_key_existsc C sJ |st d��|�d�rd| _n
|dkrt�tj� | �|�}t� |� dS )zRemove specific cache file.z1Invalid or empty key provided to delete_cache_key�machine-accessNrH )
� RuntimeError�
startswithr[ r �remover �OPERATION_IN_PROGRESSr� r r� r� rC rC rD �delete_cache_key� s �
zUAConfig.delete_cache_keyc C s | j �� D ]}| �|� qdS )zN
Remove configuration cached response files class attributes.
N)r� �keysr� )r\ �path_keyrC rC rD � 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� rV r� r� r� rW r� �json�loadsr �DatetimeAwareJSONDecoderr� )r\ r� r� r� �contentrC rC rD �
read_cache� s
� �zUAConfig.read_cacher� c C s� | � |�}tj�|�}tj�|�s&tj|dd� tj�|�tkr&t�|d� |� d�r/d | _
n|dkrDd|v rDt j t
j|�d�d d� t|t�sQtj|tjd �}d
}|| jv r`| j| js`d }tj|||d � d S )
NT)�exist_oki� r� rH r� � )� operationr� i� i� )�mode)r� r� r� �dirnamer� �makedirs�basenamer �chmodr� r[ r �addr r� r� r� �strr� �dumpsr �DatetimeAwareJSONEncoderr� r= r �
write_file)r\ r� r� �filepathr3 r� rC rC rD � write_cache� s*
�
zUAConfig.write_cachec C s dD ]"}t | |�}|d u rt�d|� qt|t�r |dk r$tj||d��q| js+| jr5| j s1| j
r5t� � �t �
d| jt j� t �
d| jt j� t �
d| j t j� t �
d| j
t j� t �
d| jt j� t �
d| jt j� | jsq| jr}t�| j| jtjj� 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#} dd
l$m%} || �}|�&� \}} ||j'kr�|�(| j| j� | js�|� |j �s�| js�|� |j �r�|� d � t)|�dk�r
d �*|�}
t+t,j-j.|
d
�� d S d S )N)r. r/ z1No config set for %s, default value will be used.r �r� rh r �httpsr )� livepatch)�ApplicationStatus)�LivepatchEntitlementr� z, )�services)/r� rW r� r� r� r
�InvalidPosIntConfigValuer, r- r* r+ � InvalidProxyCombinationConfigr �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_snapd_installed�configure_snap_proxy�get_config_option_value�HTTP_PROXY_OPTION�HTTPS_PROXY_OPTION�append�uaclientr� �(uaclient.entitlements.entitlement_statusr� � uaclient.entitlements.livepatchr� �application_status�ENABLED�configure_livepatch_proxy�lenr� �printr �!PROXY_DETECTED_BUT_NOT_CONFIGUREDrt ) r\ �proprh �services_with_proxiesr� r� r� �
livepatch_ent�livepatch_status�_r� rC rC rD �process_config� s�
��� ����
��
�
� � ��
��
�
�������
���zUAConfig.process_configc C s` | j d urt| j �D ]}t�d|� q
d| jv r.t�d� t�d� t�d� t�d� d S d S )Nz&Ignoring invalid uaclient.conf key: %sr9 z)legacy "ua_config" found in uaclient.confzPlease do the following:z� 1. run `pro config set field=value` for each field/value pair present under "ua_config" in /etc/ubuntu-advantage/uaclient.confzQ 2. Delete "ua_config" and all sub-fields in /etc/ubuntu-advantage/uaclient.conf)rP �sortedrW rX rI )r\ � invalid_keyrC rC rD �warn_about_invalid_keysH s
�
���z UAConfig.warn_about_invalid_keys)NNNrB )F)3�__name__�
__module__� __qualname__r; r� �ua_scoped_proxy_options�global_scoped_proxy_options�&deprecated_global_scoped_proxy_optionsr r r� r r rU r^ �propertyrc r2 r7 r: r& �setterr' r+ r* rE r, r- r� r. r/ �boolr� r� r0 r1 r r� r3 r6 r5 r4 r� r� r� r� r� r� r� r� r� rC rC rC rD rF W s� �����
�)
+
grF c C s t j�d�} | r
| S tS )z4Get config path to be used when loading config dict.�UA_CONFIG_FILE)r� �environra r )� config_filerC rC rD rQ ^ s rQ c C sp t � t�}| s
t� } t�d| � tj�| �r |�t t
� | ��� i }tj �
� D ]Q\}}|�� }|�d�rx|dd� }|�d�rp|dd� }|�d�r^tj�|�rXt t
� |��}ntj|d��d |vri||i|d < q'||d |< q'|tv rx|||< q'|�|� d
|v r�tj�|d
�|d
< d D ]}t�|| �s�tj||| 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_� �yaml)r� r4 r3 )r2 r7 r� ) �copyr rQ rW r� r� r� r� �updater r r� r� �items�lowerr� �endswithr
� InvalidFeatureYamlConfigValuer �
expanduserr �is_service_url�InvalidURLConfigValue�setr� �
difference�VALID_UA_CONFIG_KEYS�pop) � config_pathrI �env_keysr� rh �
field_name�feature_field_namerP r� rC rC rD rR g sH
��
� rR � 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 )Nr8 �
cloud_type)rR ra �UNSET_SETTINGS_OVERRIDE_KEY)rI r� �value_override)�fr rC rD �new_f� s
�z>apply_config_settings_override.<locals>.wrapper.<locals>.new_f)r )r r �r )r rD �wrapper� s
z/apply_config_settings_override.<locals>.wrapperrC )r r rC r rD � apply_config_settings_override� s
r rB )=r r� r� r� � collectionsr � functoolsr r �typingr r r r r r
r� r r r
r r r r r r �uaclient.defaultsr r r r r r r r r �uaclient.filesr r �uaclient.files.noticesr �
uaclient.yamlr � getLogger� replace_top_level_logger_namer� rW �MERGE_ID_KEY_MAPr �UA_CONFIGURABLE_KEYSr r; �get_event_loggerrq r� r> rE rF rQ rR r rC rC rC rD �<module> s> ,, �
?