Your IP : 216.73.216.14
U
8�-d�a � @ sf d dl Z d dlZd dlZd dlZd dlmZ d dlmZmZ d dl m
Z
m Z m Z m
Z
mZmZ d dlmZmZmZmZmZmZmZmZ d dlmZmZm 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*�Z+d
Z,d d d
�Z-dZ.dZ/dZ0edd�Z1e�2� Z3ede4d�Z5e de5f e5d�dd�Z6G dd� d�Z7e4d�d d �Z8d#d d �Z9e4d �d!d"�Z:dS )$� 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_LIVEPATCH_URL�BASE_SECURITY_URL�CONFIG_DEFAULTS� CONFIG_FIELD_ENVVAR_ALLOWLIST�DEFAULT_CONFIG_FILE�DEFAULT_DATA_DIR)�notices� state_files)�Notice)� safe_load�private�name�type)ZavailableResourcesZresourceEntitlementsZ_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�
livepatch_url�DataPath)�filenamer � permanent�S)Zbound.)�func�returnc C s
t � | �S �N)r )r= � r@ �1/usr/lib/python3/dist-packages/uaclient/config.py� str_cacheU s rB c @ s� e Zd Zeddd�eddd�eddd�eddd�eddd�d�Zd Zd
Zd Zdgee e
e f ee j
ee
d d
�dd�Zedd� �Zee
d�dd��Zee
d�dd��Zee
d�dd��Zeee
d�dd��Zeje
d�d d��Zeee
d�d d ��Zeje
d�d d ��Zeee
d�d d!��Zeje
d�d"d!��Zeee
d�d#d$��Zeje
d�d%d$��Zeeee
d�d&d'���Zeje
d�d(d'��Zeeee
d�d)d*���Zeje
d�d+d*��Zee d�d,d-��Z e je d�d.d-��Z ee d�d/d0��Z e je d�d1d0��Z ee d�d2d3��Z e je d�d4d3��Z ee d�d5d6��Z!e!je d�d7d6��Z!ee d�d8d9��Z"e"je d�d:d9��Z"ee
d�d;d<��Z#e#je
d�d=d<��Z#e$e e
f d�d>d?�Z%ed@dA� �Z&edBdC� �Z'ee
d�dDdE��Z(ee
d�dFdG��Z)edHdI� �Z*edJdK� �Z+edLdM� �Z,edNdO� �Z-dhee
e
dP�dQdR�Z.e
e dP�dSdT�Z/e
d dU�dVdW�Z0e
d dP�dXdY�Z1die dZ�d[d\�Z2dje
e ee d]�d^d_�Z3e
e d d`�dadb�Z4dcdd� Z5dedf� Z6d S )k�UAConfig� instance-idTFzmachine-access-cis.json�lockz status.jsonzmarker-reboot-cmds-required)rD zmachine-access-cisrE z status-cachezmarker-reboot-cmds)r& r' )r( r) )r$ r% N)�cfg� user_config�seriesr> c C s� |rd| _ || _d| _nt� | _ t| j �\| _| _|r>|| _ntztj�� pPt� � | _W nZ t
k
r� } z<t � � � t
�d�|�� t
�d� W 5 Q R X t� � | _W 5 d}~X Y nX d| jkr�tj j| j�� | jd �dd�| _|| _d| _dS )� Nz Error loading user config: {}zUsing default config valuesr7 T)Z optional_type_errors_become_null)Zcfg_pathrF � invalid_keys�get_config_path� parse_configrG r �user_config_file�read�UserConfigData� Exceptionr Zdisable_log_to_console�logging�warning�formatZ from_dictZto_dictrH �_machine_token_file)�selfrF rG rH �er@ r@ rA �__init__o s2
�
��zUAConfig.__init__c C s$ | j s t�| j| j�d��| _ | j S )NZmachine_token_overlay)rT r ZMachineTokenFiler/ r0 �get�rU r@ r@ rA �machine_token_file� s
�zUAConfig.machine_token_file�r> c C s | j �dt�S )Nr. )rF rX r rY r@ r@ rA r. � s zUAConfig.contract_urlc C s | j �dt�S )Nr3 )rF rX r rY r@ r@ rA r3 � s zUAConfig.security_urlc C s | j �dt�S )Nr8 )rF rX r rY r@ r@ rA r8 � s zUAConfig.livepatch_urlc C s | j jS r? )rG r" rY r@ r@ rA r" � s zUAConfig.http_proxy)�valuec C s || j _tj�| j � d S r? )rG r" r rM �write�rU r\ r@ r@ rA r" � s c C s | j jS r? )rG r# rY r@ r@ rA r# � s zUAConfig.https_proxyc C s || j _tj�| j � d S r? )rG r# r rM r] r^ r@ r@ rA r# � s c C s | j jS r? )rG r' rY r@ r@ rA r' � s zUAConfig.ua_apt_https_proxyc C s || j _tj�| j � d S r? )rG r' r rM r] r^ r@ r@ rA r' � s c C s | j jS r? )rG r& rY r@ r@ rA r& � s zUAConfig.ua_apt_http_proxyc C s || j _tj�| j � d S r? )rG r& r rM r] r^ r@ r@ rA r& � s c C s0 | j j}|r|S | j j}|r,t�tj� |S d S r? )rG r( r$ �event�infor ZWARNING_DEPRECATED_APT_HTTP�rU Z
global_valZ old_apt_valr@ r@ rA r( � s z UAConfig.global_apt_http_proxyc C s. || j _d | j _tjj�� tj�| j � d S r? ) rG r( r$ rC �fget� cache_clearr rM r] r^ r@ r@ rA r( � s c C s0 | j j}|r|S | j j}|r,t�tj� |S d S r? )rG r) r% r_ r` r Z WARNING_DEPRECATED_APT_HTTPSra r@ r@ rA r) � s z UAConfig.global_apt_https_proxyc C s. || j _d | j _tjj�� tj�| j � d S r? ) rG r) r% rC rb rc r rM r] r^ r@ r@ rA r) � s c C s | j j}|d krdS |S )Ni`T )rG r* �rU �valr@ r@ rA r* � s z UAConfig.update_messaging_timerc C s || j _tj�| j � d S r? )rG r* r rM r] r^ r@ r@ rA r* s c C s | j j}|d krdS |S )Ni@8 )rG r+ rd r@ r@ rA r+ s zUAConfig.metering_timerc C s || j _tj�| j � d S r? )rG r+ r rM r] r^ r@ r@ rA r+
s c C s | j j}|d krdS |S )NF)rG �poll_for_pro_licenserd r@ r@ rA rf s z UAConfig.poll_for_pro_licensec C s || j _tj�| j � d S r? )rG rf r rM r] r^ r@ r@ rA rf s c C s | j j}|d krdS |S )NiX )rG �polling_error_retry_delayrd r@ r@ rA rg ! s z"UAConfig.polling_error_retry_delayc C s || j _tj�| j � d S r? )rG rg r rM r] r^ r@ r@ rA rg * s c C s | j j}|d krdS |S )NT)rG r, rd r@ r@ rA r, / s zUAConfig.apt_newsc C s || j _tj�| j � d S r? )rG r, r rM r] r^ r@ r@ rA r, 6 s c C s | j j}|d krtS |S r? )rG r- r rd r@ r@ rA r- ; s zUAConfig.apt_news_urlc C s || j _tj�| j � d S r? )rG r- r rM r] r^ r@ r@ rA r- B s c C s� | � d�}d}tj�|�s |S t�|�}z|�d�\}}W n* tk
rd t� tj�
| j d���Y nX z t� d|g� t
|�|fW S tjk
r� t�� s�t�d||� t
|�|f Y S t�d||� t�|� | Y S X dS )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.
rE )���rI �:Zpsz.Found stale lock file previously held by %s:%sz1Removing stale lock file previously held by %s:%sN)� data_path�os�path�existsr � load_file�split�
ValueErrorr
ZInvalidLockFile�joinr/ Zsubp�intZProcessExecutionErrorr Zwe_are_currently_rootrQ �debugrR �ensure_file_absent)rU Z lock_pathZno_lockZ lock_contentZlock_pidZ lock_holderr@ r@ rA �check_lock_infoG s:
�
��
zUAConfig.check_lock_infoc C s | j �dt�S )Nr/ )rF rX r rY r@ r@ rA r/ r s zUAConfig.data_dirc C s> | j �dd�}ztt|�� �W S tk
r8 tj Y S X d S )Nr2 �DEBUG)rF rX �getattrrQ �upper�AttributeErrorrv )rU r2 r@ r@ rA r2 v s
zUAConfig.log_levelc C s | j �dtd �S )Nr1 �rF rX r rY r@ r@ rA r1 ~ s zUAConfig.log_filec C s | j �dtd �S )Nr5 rz rY r@ r@ rA r5 � s �zUAConfig.timer_log_filec C s | j �dtd �S )Nr6 rz rY r@ r@ rA r6 � s �zUAConfig.daemon_log_filec C s
t | j�S )z<Report whether this machine configuration is attached to UA.)�bool�
machine_tokenrY r@ r@ rA � is_attached� s zUAConfig.is_attachedc C s. | j �d�}|r*t|t�r |S t�d|� i S )z>Return a dictionary of any features provided in uaclient.conf.r0 zDUnexpected uaclient.conf features value. Expected dict, but found %s)rF rX �
isinstance�dictrQ rR )rU r0 r@ r@ rA r0 � s
�zUAConfig.featuresc C s | j jS )zAReturn the machine-token if cached in the machine token response.)rZ r| rY r@ r@ rA r| � s zUAConfig.machine_token)�keyr> c C sd | j }|stj�|t�S || jkrT| j| }|jrDtj�|t|j�S tj�||j�S tj�|t|�S )zAReturn the file path in the data directory represented by the key)r/ rk rl rq �PRIVATE_SUBDIR�
data_pathsr r: )rU r� r/ rj r@ r@ rA rj � s
�zUAConfig.data_pathc C s | � |�}tj�|�S r? )rj rk rl rm �rU r� �
cache_pathr@ r@ rA �cache_key_exists� s
zUAConfig.cache_key_exists)r� r> 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 rt )rU r� r@ r@ rA �_perform_delete� s zUAConfig._perform_deletec C sJ |s t d��|�d�r d| _n|dkr2t�tj� | �|�}| �|� dS )zRemove specific cache file.z1Invalid or empty key provided to delete_cache_key�machine-accessNrE ) � RuntimeError�
startswithrT r �remover �OPERATION_IN_PROGRESSrj r� r� r@ r@ rA �delete_cache_key� s �
zUAConfig.delete_cache_key)�delete_permanentc C s. | j �� D ] }|s | j | js
| �|� q
dS )z�
Remove configuration cached response files class attributes.
:param delete_permanent: even delete the "permanent" files
N)r� �keysr; r� )rU r� Zpath_keyr@ r@ rA � delete_cache� s zUAConfig.delete_cache)r� �silentr> c C s| | � |�}zt�|�}W n2 tk
rJ tj�|�sD|sDt�d|� Y d S X zt j
|t j d�W S t
k
rv | Y S X d S )NzFile does not exist: %s��cls)rj r rn rP rk rl rm rQ rs �json�loadsr ZDatetimeAwareJSONDecoderrp )rU r� r� r� �contentr@ r@ rA �
read_cache� s
zUAConfig.read_cache)r� r� r> c C s� | � |�}tj�|�}tj�|�sLtj|dd� tj�|�tkrLt�|d� |� d�r^d | _
n*|dkr�d|kr�t j t
j|�d�d d� t|t�s�tj|tjd �}d
}|| jkr�| j| js�d }tj|||d � d S )
NT)�exist_oki� r� rE ri � )Z operationr� i� i� )�mode)rj rk rl �dirnamerm �makedirs�basenamer� �chmodr� rT r �addr r� ro r~ �strr� �dumpsr ZDatetimeAwareJSONEncoderr� r r Z
write_file)rU r� r� �filepathr/ r� r@ r@ rA � write_cache� s*
�
zUAConfig.write_cachec C s4 dD ]H}t | |�}|d kr&t�d� qt|t�r8|dk rd�|�}t�|��q| jsZ| j rr| j
sf| j rrt�t j
��t�d| jtj� t�d| j tj� t�d| j
tj� t�d| j tj� t�d| jtj� t�d| jtj� | js�| j �rt�| j| j tjj� n&| j
�s| j �r*t�| j
| j tjj� g }t� � �r~t� | j| j� | j�s^t� tj ��st| j�s~t� tj ��r~|�!d� ddl"m#} dd l$m%} dd
l&m'} |� }|�(� \} }
| |j)k�r|�*| j| j� | j�s�|� |j ��s�| j�s|� |j ��r|�!d � t+|�dk�r0d �,|�} t-t j.j| d
�� 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.ZhttpZhttpsr )� livepatch)�ApplicationStatus)�LivepatchEntitlementr� z, )�services)/rw rQ rs r~ rr rS r
�UserFacingErrorr( r) r& r' r ZERROR_PROXY_CONFIGURATIONr Zvalidate_proxyZ PROXY_VALIDATION_APT_HTTP_URLZ PROXY_VALIDATION_APT_HTTPS_URLr" Z PROXY_VALIDATION_SNAP_HTTP_URLr# Z PROXY_VALIDATION_SNAP_HTTPS_URLr Zsetup_apt_proxyZ
AptProxyScopeZGLOBALZUACLIENTr Z is_installedZconfigure_snap_proxyZget_config_option_valueZHTTP_PROXY_OPTIONZHTTPS_PROXY_OPTION�append�uaclientr� Z(uaclient.entitlements.entitlement_statusr� Z uaclient.entitlements.livepatchr� Zapplication_statusZENABLEDZconfigure_livepatch_proxy�lenrq �printZ!PROXY_DETECTED_BUT_NOT_CONFIGURED) rU Zpropr\ Z error_msgZservices_with_proxiesr� r� r� Z
livepatch_entZlivepatch_status�_r� r@ r@ rA �process_config� s�
��� ����� �� � ���
�
��
�
�������
��zUAConfig.process_configc C s\ | j d k r&t| j �D ]}t�d|� qd| jkrXt�d� t�d� t�d� t�d� d S )Nz&Ignoring invalid uaclient.conf key: %sr7 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)rJ �sortedrQ rR rF )rU � invalid_keyr@ r@ rA �warn_about_invalid_keysg s
�
��z UAConfig.warn_about_invalid_keys)NNN)N)F)F)7�__name__�
__module__� __qualname__r9 r� Zua_scoped_proxy_optionsZglobal_scoped_proxy_optionsZ&deprecated_global_scoped_proxy_optionsr r r� r r rO rW �propertyrZ r. r3 r8 r" �setterr# r' r& rB r( r) rr r* r+ r{ rf rg r, r- r ru r/ r2 r1 r5 r6 r} r0 r| rj r� r� r� r� r� r� r� r� r@ r@ r@ rA rC Y s�
��
�� *
+
krC r[ 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.ZUA_CONFIG_FILE) rk �environrX rl rq �getcwdr� r rm )Z config_fileZ local_cfgr@ r@ rA rK } s
� rK c C s� t � t�}| st� } t�d| � tj�| �r@|�t t
� | ��� i }tj �
� D ]�\}}|�� }|�d�rN|dd� }|�d�r�|dd� }|�d�r�tj�|�r�t t
� |��}nt�d�|���d |kr�||i|d < q�||d |< qN|tkrN|||< qN|�|� d
|k�r tj�|d
�|d
< d D ],}t�|| ��s"t�d �||| ����q"t|�� ��t�}|D ]}|� |� �qf||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 %sZua_� NZ features_� Zyamlz Could not find yaml file: {}r0 r/ )r. r3 z Invalid url in config. {}: {}) �copyr rK �LOGrs rk rl rm �updater r rn r� �items�lowerr� �endswithr
r� rS r �
expanduserr Zis_service_url�setr� �
difference�VALID_UA_CONFIG_KEYS�pop) Z config_pathrF Zenv_keysr� r\ Z
field_nameZfeature_field_namerJ r� r@ r@ rA rL � sH
�
�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:�dkr6|d fS |S � � S )Nr4 Z
cloud_type)rL rX �UNSET_SETTINGS_OVERRIDE_KEY)rF r� Zvalue_override)�fr� r@ rA �new_f� s
�z>apply_config_settings_override.<locals>.wrapper.<locals>.new_f)r )r� r� r� )r� rA �wrapper� s
z/apply_config_settings_override.<locals>.wrapperr@ )r� r� r@ r� rA � apply_config_settings_override� s
r� )N);r� r� rQ rk � collectionsr � functoolsr r �typingr r r r r r
r� r r r
r r r r r Zuaclient.defaultsr r r r r r r r Zuaclient.filesr r Zuaclient.files.noticesr Z
uaclient.yamlr Z getLoggerr� r� r� ZMERGE_ID_KEY_MAPr� ZUA_CONFIGURABLE_KEYSr� r9 Zget_event_loggerr_ r� r< rB rC rK rL r� r@ r@ r@ rA �<module> s> (
(
�
(
A