3 a@sddlZddlmZddlmZddlZddlZddlZddlZddlZddl Z ddl m Z m Z ddl mZmZmZmZmZmZddlmZmZmZmZmZy(ddlmZmZmZmZmZm Z m!Z!Wne"k rdd ZYnXd d ej#dd dddgej$j%j&ej'gd d d gej(j)j&dd d d gddZ*ej+e,Z-dZ.dddZ/dZ0d3Z1d4Z2e d"d5Z3Gd$d%d%Z4e5d&d'd(Z6d6d)d*Z7e5d+d,d-Z8d.d/Z9e4d0d1d2Z:dS)7N)datetime)wraps) namedtuple OrderedDict)apt exceptionssnapstatusutilversion)CONFIG_DEFAULTSCONFIG_FIELD_ENVVAR_ALLOWLISTDEFAULT_CONFIG_FILEBASE_CONTRACT_URLBASE_SECURITY_URL)AnycastDictListOptionalTupleUnioncCs|S)N)_xrr1/usr/lib/python3/dist-packages/uaclient/config.pyr!srzUContent provided in json response is currently considered Experimental and may changez0.1F)idname created_atproductstech_support_level)rrrexternal_account_ids)Z_docZ_schema_versionr machine_idattached effectiveexpiresoriginservicesexecution_statusexecution_detailsnoticescontractaccountprivatertype)availableResourcesresourceEntitlementsZ_unset http_proxy https_proxyapt_http_proxyapt_https_proxy contract_urldata_dirfeatureslog_file log_level security_urlsettings_overrides ua_configDataPathfilenamec @seZdZeddeddeddeddeddedded ded ded dd Zd Zd Zd Zdjded dddZ e ddZ e edddZ e edddZ e ddddZejedddZe ddddZejedd dZe ddd!d"Zejedd#d"Ze ddd$d%Zejedd&d%Zd'dd(d)Ze d*d+Ze d,d-Zeed.d/d0Zeed1d2d3Ze d4d5Ze d6d7Ze d8dd9d:Ze d;d<Ze edd=d>Ze d?d@Ze dAdBZdCdDZ dkdedEdFdGZ!ed dHdIdJZ"ed dEdKdLZ#dMdNZ$dlee%dOdPdQdRZ&edSd dTdUdVZ'dddWdXZ(dddYdZZ)ddd[d\Z*d]dd^d_Z+ddd`daZ,dmdddbdcZ-dddeZ.dfdgZ/dndhdiZ0d S)oUAConfigz instance-idTzmachine-access-cis.jsonz machine-idzmachine-token.jsonlockz status.jsonFz notices.jsonzmarker-reboot-cmds-requiredzservices-once-enabled) z instance-idzmachine-access-cisz machine-idz machine-tokenrAz status-cacher+zmarker-reboot-cmdszservices-once-enabledNzDict[str, Any])cfgseriesreturncCs0|rd|_||_nt|_t|j|_||_dS)rN)cfg_pathrBget_config_path parse_configrC)selfrBrCrrr__init__ws  zUAConfig.__init__cCs|jr|jdd}|gSgS)z?Return the list of accounts that apply to this authorized user.machineTokenInfo accountInfo) is_attached machine_token)rHrKrrraccountsszUAConfig.accounts)rDcCs|jjdtS)Nr6)rBgetr)rHrrrr6szUAConfig.contract_urlcCs|jjdtS)Nr;)rBrOr)rHrrrr;szUAConfig.security_urlz Optional[str]cCs|jjdijdS)Nr=r2)rBrO)rHrrrr2szUAConfig.http_proxy)valuecCs.d|jkri|jd<||jdd<|jdS)Nr=r2)rB write_cfg)rHrPrrrr2s  cCs|jjdijdS)Nr=r3)rBrO)rHrrrr3szUAConfig.https_proxycCs.d|jkri|jd<||jdd<|jdS)Nr=r3)rBrQ)rHrPrrrr3s  cCs|jjdijdS)Nr=r4)rBrO)rHrrrr4szUAConfig.apt_http_proxycCs.d|jkri|jd<||jdd<|jdS)Nr=r4)rBrQ)rHrPrrrr4s  cCs|jjdijdS)Nr=r5)rBrO)rHrrrr5szUAConfig.apt_https_proxycCs.d|jkri|jd<||jdd<|jdS)Nr=r5)rBrQ)rHrPrrrr5s  zTuple[int, str]c Cs|jd}d }tjj|s|Stj|}|jd\}}ytjd|gt||fStj k rtj dkrt j d||t||fSt j d||tj||SXd S) 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. rAr:Zpsrz.Found stale lock file previously held by %s:%sz1Removing stale lock file previously held by %s:%sN)rTr) data_pathospathexistsr load_filesplitsubpintProcessExecutionErrorgetuidloggingdebugwarningunlink)rHZ lock_pathZno_lockZ lock_contentlock_pid lock_holderrrrcheck_lock_infos,       zUAConfig.check_lock_infocCs |jdS)Nr7)rB)rHrrrr7szUAConfig.data_dirc Cs>|jjd}ytt|jStk r8tttdSXdS)Nr:)rBrOgetattrr_upperAttributeErrorr )rHr:rrrr:s  zUAConfig.log_level)label descriptioncCs8|jdp g}||g}||kr4|j||jd|dS)zAdd a notice message to notices cache. Such notices are seen in the Notices section from ua status output. They are also present in the JSON status output. r+N) read_cacheappend write_cache)rHrirjr+Znoticerrr add_notices  zUAConfig.add_notice) label_regex descr_regexcCsg}|jd}|rLx8|D]0\}}tj||r:tj||r:q|j||fqW|r^|jd|n"tjj|jdrt j |jddS)zRemove matching notices if present. :param label_regex: Regex used to remove notices with matching labels. :param descr_regex: Regex used to remove notices with matching descriptions. r+N) rkrematchrlrmrVrWrXrUr remove_file)rHrorpr+Zcached_noticesZ notice_labelZ notice_descrrrr remove_notices   zUAConfig.remove_noticecCs|jjdtdS)Nr9)rBrOr )rHrrrr9szUAConfig.log_filecCs|jr |jS|j}|siSi|_|dd}tdd|jdgD}tdd|dD}xH|jD]<\}}d|i}||kr|||d <tj||j||j|<qfW|jS) zReturn a dictionary of entitlements keyed by entitlement name. Return an empty dict if no entitlements are present. rJ contractInfocss|]}|d|dfVqdS)r/tokenNr).0errr #sz(UAConfig.entitlements..ZresourceTokenscss|]}|d|fVqdS)r/Nr)rwrxrrrry'sr1 entitlement resourceToken) _entitlementsrMdictrOitemsr apply_series_overridesrC)rHrMruZtokens_by_nameZ ent_by_nameentitlement_nameZ ent_valueentitlement_cfgrrr entitlementss(  zUAConfig.entitlementsrcCs |js|jddd|_|jS)z6Return a datetime of the attached contract expiration.rJru effectiveTo)_contract_expiry_datetimerM)rHrrrcontract_expiry_datetime3s  z!UAConfig.contract_expiry_datetimecCs t|jS)zReturn a dictionary of any features provided in uaclient.conf.r8zDUnexpected uaclient.conf features value. Expected dict, but found %s)rBrO isinstancer}r_ra)rHr8rrrr8Ms  zUAConfig.featurescCsJ|jsD|jd}|jjd}|r>|r>|j|}|r>t||d||_|jS)zAReturn the machine-token if cached in the machine token response.z machine-tokenmachine_token_overlay) base_dict overlay_dict)_machine_tokenrkr8rOparse_machine_token_overlaydepth_first_merge_overlay_dict)rHZraw_machine_tokenmachine_token_overlay_pathrrrrrM\s zUAConfig.machine_tokencCsvtjj|s tjtjj|dytj |}t j |St k rp}z tjtj jt||dWYdd}~XnXdS)N) file_path)errorr)rVrWrXrUserFacingErrorr &INVALID_PATH_FOR_MACHINE_TOKEN_OVERLAYformatr rYjsonloads ValueErrorERROR_JSON_DECODING_IN_FILEstr)rHrZmachine_token_overlay_contentrxrrrrus   z$UAConfig.parse_machine_token_overlay)keyrDcCsh|jd}|stjj|tS||jkrX|j|}|jrHtjj|t|jStjj||jStjj|t|S)zAReturn the file path in the data directory represented by the keyr7)rBrVrWjoinPRIVATE_SUBDIR data_pathsr.r?)rHrr7rUrrrrUs    zUAConfig.data_path) cache_pathrDcCstjj|rtj|dS)zDelete the given cache_path if it exists. (This is a separate method to allow easier disabling of deletion during tests.) N)rVrWrXrb)rHrrrr_perform_deletes zUAConfig._perform_deletecCsX|s td|jds|dkr,d|_d|_n|dkr@|jdd|j|}|j|dS)zRemove specific cache file.z1Invalid or empty key provided to delete_cache_keyzmachine-accessz machine-tokenNrArzOperation in progress.*) RuntimeError startswithr|rrtrUr)rHrrrrrdelete_cache_keys  zUAConfig.delete_cache_keycCs"x|jjD]}|j|q WdS)z(sz-UAConfig._unattached_status..)r availablerz@Ignoring availability of unknown service %s from contract serverr()rrjr)uaclient.contractrrrrrDEFAULT_STATUSr get_versionr8sortedr UserFacingAvailability AVAILABLErP UNAVAILABLErOLOGr`rlrj)rHrrr resourcesrrrrrr_unattached_statuss(      zUAConfig._unattached_statuszDict[str, Optional[str]]cCszd}d}|j}|tjjkr&tjj}n*|j|krDtjj}||j}n |j\}}|j|j |j |j |||j|krrdnddS)Nryesno)rrjentitledr Zstatus_detailsdescription_overrider) contract_statusr ContractStatus UNENTITLEDrrr INAPPLICABLEuser_facing_statusrjrP)rHentinapplicable_resourcesdetailsrr ent_statusrrr_attached_service_status@s"     z!UAConfig._attached_service_statusc Csddlm}ddlm}tjt}|jd}|d}tj j j }|j t j|jd|dd|jd |jd pjg|d |d |jd d|jdg|d|jdd |jdd |jdjd d|jdjdgdd|jdr|j|d<|jdr|d|d<|jjd}|s||}ddt|dddD}x,|D]$} | |} |dj|j| |q8W|jjdijd } | r| jd!ijd"} | r| |d#d$<|S)%z8Return configuration of attached status as a dictionary.r)r)ENTITLEMENT_CLASSESrJru)r8Z machineIdTr'r+rrZ createdAtrr )rrrr r!ZexternalAccountIDs)rrrr")r r#r$r'r+r,r-rr&Z effectiveFromr%r0cSs$i|]}|ds|jd|dqS)rrjr)rO)rwrrrr sz-UAConfig._attached_status..cSs|dS)Nrr)rrrrrsz+UAConfig._attached_status..)rr(supportrz affordances supportLevelr,r!)rrrrrrrrMr rrrPupdater rr8rOrkrNrrrlrr) rHrrrrJrur!rrrrrrrrr_attached_status[sR                   zUAConfig._attached_statuscCstjdkr*td|jd}|sB|j}n|js:|j}n|j}|j|jtjdkr|j d|t j s|j dt jjddt j|jdd}||O}|s|j|}|S) aReturn status as a dict, using a cache for non-root users When unattached, get available resources from the contract service to report detailed availability of different resources for this machine. Write the status-cache when called by root. rzDict[str, Any]z status-cacherz fix operation)rzfeatures.allow_beta)r path_to_value)rVr^rrkrrLrrrrmr should_rebootrtr rris_config_value_truerBr)rHZ show_betarZconfig_allow_betarrrr s*        zUAConfig.statusc Csddlm}ddlm}||}d}t}||d<x8|D]0}|d|kr8||kr8|}|j|}||} Pq8W|dkrtjdj||j r|j | i} | d} | d|d<| |d<| d kr|j rd |d <n&|d rt j jj} n t j jj} | |d <| j|d <|S)zReturn help information from an uaclient service as a dict :param name: Name of the service for which to return help data. :raises: UserFacingError when no help is available. r)r)rNrzNo help available for '{}'r renabledTbetarhelp)rrrrrrOrrrrLrrr rrrPr help_info) rHrrrrZ help_resourceZ response_dictrZ help_ent_clsZhelp_entservice_statusZ status_msgrrrrrs8           z UAConfig.helpcCsJtjd|jtjtjd|jtjtjd|jtjtjd|jtj t j |j|jg}t j rt j|j|j|j rt jt js|j rt jt jr|jdddlm}|j}|j\}}|tjjkr|j|j|j|j r|j|js|j r|j|jr|jdt|dkrFdj|}ttjj|ddS) Nhttphttpsrr) livepatchrz, )r() r validate_proxyr4PROXY_VALIDATION_APT_HTTP_URLr5PROXY_VALIDATION_APT_HTTPS_URLr2PROXY_VALIDATION_SNAP_HTTP_URLr3PROXY_VALIDATION_SNAP_HTTPS_URLrZsetup_apt_proxyr is_installedZconfigure_snap_proxyZget_config_option_valueZHTTP_PROXY_OPTIONZHTTPS_PROXY_OPTIONrlrrLivepatchEntitlementapplication_statusr ApplicationStatusENABLEDZconfigure_livepatch_proxylenrprint)MESSAGE_PROXY_DETECTED_BUT_NOT_CONFIGUREDr)rHZservices_with_proxiesrZ livepatch_entZlivepatch_statusrr(rrrprocess_configsF           zUAConfig.process_configcs|st}tj}tjj}d|kr.td|d<xd D]}t|||<q4WfddtD|d<|t j |d d 7}t j ||d S) z?Write config values back to config_path or DEFAULT_CONFIG_FILE.r:r6r;r7r9csi|]}t||qSr)rf)rwr)rHrrr<sz&UAConfig.write_cfg..r=F)default_flow_styleN)r6r;r7r9) rr MESSAGE_UACLIENT_CONF_HEADERrrrBr rfUA_CONFIGURABLE_KEYSyamldumpr r)rHrrZcfg_dictattrr)rHrrQ.s     zUAConfig.write_cfg)NN)N)F)F)N)1__name__ __module__ __qualname__r>rr|rrrrIpropertyrNr6r;r2setterr3r4r5rer7r:rnrtr9rrrLr\rr8rMrrUrrrrrkrmrrrrrr rrrQrrrrr@es $          !%#=(4:r@)rDcCsBtjjd}|r|Stjjtjtjjt}tjj|r>|StS)z4Get config path to be used when loading config dict.UA_CONFIG_FILE) rVenvironrOrWrgetcwdrrrX)Z config_fileZ local_cfgrrrrFDs  rFcCstjt}|st}tjd|tjj|rB|jt j t j |i}xtj jD]\}}|j}|jdrR|dd}|jdr|dd}|jdrtjj|rt j t j |}ntjdj|d |kr||i|d <q||d |<qR|tkrR|||<qRW|j|tjj|d |d <x4dD],}t j||s"tjd j|||q"Wx4tt|jjtD]}tjd||j|qjW|S)aParse known UA 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 ua configfile. If unspecified, use DEFAULT_CONFIG_FILE. @return: Dict of configuration values. z(Using UA client configuration file at %sZua_NZ features_ r zCould not find yaml file: {}r8r7r6r;zInvalid url in config. {}: {}z)Ignoring invalid uaclient.conf key: %s=%s)r6r;) rr rFrr`rVrWrXrr  safe_loadr rYrr~lowerrendswithrrrr expanduseris_service_urlrsetr differenceVALID_UA_CONFIG_KEYSr_rapop)rrBZenv_keysrrP field_nameZfeature_field_namerrrrGSsB             rG) override_keycsfdd}|S)aDecorator 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. cstfdd}|S)Ncs,t}|jdijt}|tkr&|SS)Nr<)rGrOUNSET_SETTINGS_OVERRIDE_KEY)rBZvalue_override)fr#rrnew_fs  z>apply_config_settings_override..wrapper..new_f)r)r%r&)r#)r%rwrappers z/apply_config_settings_override..wrapperr)r#r'r)r#rapply_config_settings_overrides r(cCsdd}x|jD]\}}|j|}t|trHt|trHt|||qt|trt|trt|rt|dtr|||||dq|||<q|||<qWdS)aMerge the contents of overlay dict into base_dict not only on top-level keys, but on all on the depths of the overlay_dict object. For example, using these values as entries for the function: base_dict = {"a": 1, "b": {"c": 2, "d": 3}} overlay_dict = {"b": {"c": 10}} Should update base_dict into: {"a": 1, "b": {"c": 10, "d": 3}} @param base_dict: The dict to be updated @param overlay_dict: The dict with information to be added into base_dict c Sstg}tj|}xV|D]N}d}x6t|D]*\}}|j||j|kr&t||d}q&W|s|j|qW|j|dS)NFT)MERGE_ID_KEY_MAPrO enumeraterrlextend) Z base_valuesZoverlay_valuesrZvalues_to_appendZid_keyZ overlay_valueZ was_replacedZbase_value_idx base_valuerrrupdate_dict_lists   z8depth_first_merge_overlay_dict..update_dict_listr)rN)r~rOrr}rlistr)rrr-rrPr,rrrrs  r)rBcCsftjjdzHy$tdttjdd}||Wntk rPtjdYnXWdtjj XdS)zHelper to load and run ua_update_messaging. This is needed because we don't have /usr/lib/ubuntu-advantage python scripts in our path and we don't want to shell out with subp to call python3 /path/to/ua_update_messaging.py. z/usr/lib/ubuntu-advantageZua_update_messagingZupdate_apt_and_motd_messagesz@Unable to update UA messages. Cannot import ua_update_messaging.N) sysrWrl __import__rfmodules ImportErrorr_r`r!)rBZ update_msgsrrrupdate_ua_messagess  r3)r2r3r4r5)r6r7r8r9r:r;r<r=)r?r.)N);rr functoolsrrr_rVrqr/r  collectionsrruaclientrrrr r r uaclient.defaultsr r rrrtypingrrrrrrrr2rrrrPrrrr getLoggerrrrr)r$r r r>r@rrFrGr(rr3rrrrs   (     d A/