o w7eq @sLUdZddlZddlZddlZddlZddlZddlmZddlm Z ddlm Z ddlm Z m Z mZddlmZddlmZdd lmZmZdd lmZe eZd Zd Zd ZdZeZddgZ dddede edgegdZ!ee"d<ee!ZdZ#dZ$dZ%dZ&dddZ'dddZ(d d!gZ)gd"Z*dgd#d$Z+d%e,d&ed'ed(e-d)df d*d+Z.d,d-Z/d.d/Z0dhd0d1Z1dhd2d3Z2dhd4d5Z3d6d7Z4d8d9Z5d:d;Z6dd?Z8d@dAZ9dBdCZ:didEdFZ;djdGdHZdMdNZ?dOdPZ@dQdRZAdSdTZBdUdVZCdWdXZDdYdZZEd[d\ZFd]d^ZGdhd_d`ZHdadbZI cdldddeZJdfe4iZKdS)mz*Apt Configure: Configure apt for the user.N)dedent)gpg)log)subp templaterutil)Cloud)Config) MetaSchema get_meta_doc) PER_INSTANCEz ^[\w-]+:\wz/etc/apt/trusted.gpgz/etc/apt/trusted.gpg.d/z/etc/apt/cloud-init.gpg.d/ubuntudebiancc_apt_configurez Apt ConfigurezConfigure apt for the usera This module handles both configuration of apt options and adding source lists. There are configuration options such as ``apt_get_wrapper`` and ``apt_get_command`` that control how cloud-init invokes apt-get. These configuration options are handled on a per-distro basis, so consult documentation for cloud-init's distro support for instructions on using these config options. .. note:: To ensure that apt configuration is valid yaml, any strings containing special characters, especially ``:`` should be quoted. .. note:: For more information about apt configuration, see the ``Additional apt configuration`` example.a- apt: preserve_sources_list: false disable_suites: - $RELEASE-updates - backports - $RELEASE - mysuite primary: - arches: - amd64 - i386 - default uri: 'http://us.archive.ubuntu.com/ubuntu' search: - 'http://cool.but-sometimes-unreachable.com/ubuntu' - 'http://us.archive.ubuntu.com/ubuntu' search_dns: false - arches: - s390x - arm64 uri: 'http://archive-to-use-for-arm64.example.com/ubuntu' security: - arches: - default search_dns: true sources_list: | deb $MIRROR $RELEASE main restricted deb-src $MIRROR $RELEASE main restricted deb $PRIMARY $RELEASE universe restricted deb $SECURITY $RELEASE-security multiverse debconf_selections: set1: the-package the-package/some-flag boolean true conf: | APT { Get { Assume-Yes 'true'; Fix-Broken 'true'; } } proxy: 'http://[[user][:pass]@]host[:port]/' http_proxy: 'http://[[user][:pass]@]host[:port]/' ftp_proxy: 'ftp://[[user][:pass]@]host[:port]/' https_proxy: 'https://[[user][:pass]@]host[:port]/' sources: source1: keyid: 'keyid' keyserver: 'keyserverurl' source: 'deb [signed-by=$KEY_FILE] http:/// bionic main' source2: source: 'ppa:' source3: source: 'deb $MIRROR $RELEASE multiverse' key: | ------BEGIN PGP PUBLIC KEY BLOCK------- ------END PGP PUBLIC KEY BLOCK------- source4: source: 'deb $MIRROR $RELEASE multiverse' append: false key: | ------BEGIN PGP PUBLIC KEY BLOCK------- ------END PGP PUBLIC KEY BLOCK-------)idnametitle descriptiondistrosexamples frequencyactivate_by_schema_keysmetaz/var/lib/apt/listsz'/etc/apt/apt.conf.d/94cloud-init-configz)/etc/apt/apt.conf.d/90cloud-init-aptproxyzkeyserver.ubuntu.comz!http://archive.ubuntu.com/ubuntu/z"http://security.ubuntu.com/ubuntu/PRIMARYSECURITYz$http://ports.ubuntu.com/ubuntu-portsamd64i386)s390xarm64armhfpowerpcppc64elriscv64cCs>|dur t|}|tvrtS|tvrtStd|)zreturns the default mirrors for the target. These depend on the architecture, for more see: https://wiki.ubuntu.com/UbuntuDevelopment/PackageArchive#PortsNz#No default mirror known for arch %s)rget_dpkg_architecturePRIMARY_ARCHESPRIMARY_ARCH_MIRRORScopy PORTS_ARCHES PORTS_MIRRORS ValueError)archtargetr-C/usr/lib/python3/dist-packages/cloudinit/config/cc_apt_configure.pyget_default_mirrorss  r/rcfgcloudargsreturncCsPd}t|}|di}t|tstdjt|dt||t|||dS)zprocess the config for apt_config. This can be called from curthooks if a global apt config was provided or via the "apt" standalone command.Naptz9Expected dictionary for 'apt' config, found {config_type}) config_type) convert_to_v3_apt_formatget isinstancedictr*formattypeapply_debconf_selections apply_apt)rr0r1r2r,apt_cfgr-r-r.handles   r?cCs(trdStdstdsdSdS)N)Fzsystem is snappy.zapt-getr4)Fzno apt commands.)TzApt is available.)rsystem_is_snappyrwhichr-r-r-r._should_configure_on_empty_apts rBc Cs|st\}}|std|dStd|tj|dd}t|}t|||d}td|t|ddrLt ||t ||||t |||zt |t tWnttfydtd Ynwd |vr|}||d <|d |d <d} |d t} | rt| j} t|d |||| dtjgd|dddgd\} } td| } dd| D}|rtd||D] }t|tjqdS)Nz#Nothing to do: No apt config and %szhandling apt config: %sr,codename)r+zApt Mirror info: %spreserve_sources_listFz)Failed to apply proxy or apt config info:sourcesRELEASEMIRRORadd_apt_repo_match)r,template_params aa_repo_match)psz-ozppid,pid-CdirmngrrMz gpg-agentTr)r,capturercsz(?P\d+)\s+(?P\d+)cSs$g|]}|ddkrt|dqS)r1rO)int).0pidr-r-r. s$zapply_apt..z&Killing gpg-agent and dirmngr pids: %s)rBLOGdebugr lsb_releaser$find_apt_mirror_infois_falser7add_mirror_keysgenerate_sources_listrename_apt_listsapply_apt_config APT_PROXY_FN APT_CONFIG_FNIOErrorOSError exceptionADD_APT_REPO_MATCHrecompilesearchadd_apt_sourcesrfindalloskillsignalSIGKILL)r0r1r, should_configmsgreleaser+mirrorsparamsmatchermatchcfggpg_process_out_errgpg_pids root_gpg_pidsgpg_pidr-r-r.r=s^             r=cCs*|ds |d7}tjdg||dddS)N zdebconf-set-selectionsTdatar,rP)endswithr) selectionsr,r-r-r.debconf_set_selectionss  rcCsg}g}|D]}|tvrtd|t||||q||qt|r.td|t|rCtjddgt|d|dddSdS)Nzunconfiguring %szSThe following packages were installed and preseeded, but cannot be unconfigured: %szdpkg-reconfigurez--frontend=noninteractiveTr|)CONFIG_CLEANERSrWrXappendlenwarningrlist)packagesr, unhandled to_configpkgr-r-r.dpkg_reconfigures.     rc s|dstddSdfddtD}t||dt} D]\}}| D]}| dr=q5t d d |}||q5q-t|}td |||} t| d krhtd dSt| |ddS)z2apply_debconf_selections - push content to debconfdebconf_selectionsz(debconf_selections was not set in configN csg|]}|qSr-r-)rTkeyselsetsr-r.rV=sz,apply_debconf_selections..rC#z[:\s].*z pkgs_cfgd: %srzno need for reconfig)r7rWrXjoinsortedkeysrencodesetitems splitlines startswithrfsubaddrget_installed_packages intersectionrr) r0r,r pkgs_cfgd_keycontentlinerpkgs_installed need_reconfigr-rr.r<2s*           r<cCs6tt|d}td||D]}t|qdS)z%clean out any local cloud-init configz/etc/cloud/cloud.cfg.d/*dpkg*z#cleaning cloud-init config from: %sN)globr target_pathrWrXrkunlink)r,flistdpkg_cfgr-r-r.clean_cloud_initUs   rcCsL|}|dr |dd}|d}|dkr||dd}|dd}|S)zmirrorurl_to_apt_fileprefix Convert a mirror url to the file prefix used by apt on disk to store cache information for that mirror. To do so do: - take off ???:// - drop tailing / - convert in string / to _/rz://N_)r~findreplace)mirrorstringposr-r-r.mirrorurl_to_apt_fileprefix`s    rc Cst|}t|t}|D]\\}}||}|sq|tjjt |}|tjjt |} || kr3qt |} t d|D]+} d| | | df} t d| | zt| | Wq>tyit jdddYq>wqdS)z>rename_apt_lists - rename apt lists to preserve old cache dataz%s_*z%s%sNzRenaming apt list %s to %szFailed to rename apt list:T)exc_info)r/rr APT_LISTSrr7rkpathseprrrrWrXrenamercr) new_mirrorsr,r+default_mirrorspreromirrornmirroroprefixnprefixolenfilenamenewnamer-r-r.r^rs*   r^cCs8dddddd}z||}W|Sty|}Y|Sw)zthere are a few default names which will be auto-extended. This comes at the inability to use those names literally as suites, but on the other hand increases readability of the cfg quite a lotz$RELEASE-updatesz$RELEASE-backportsz$RELEASE-securityz$RELEASE-proposedz$RELEASE)updates backportssecurityproposedrq)KeyError)suitemappingretsuiter-r-r.map_known_suitess  rc Cs|s|S|}|D]`}t|}t|d|i}td||d}|dD]A}|dr0||7}q$|}t|dkrad} |ddrW|dd D] } | d7} | d rVnqI|| |krad |}||7}q$|}q|S) zRreads the config for suites to be disabled and removes those from the templaterGzDisabling suite %s as %srTrrO[N]z"# suite disabled by cloud-init: %s) rr render_stringrWrXrrsplitrr~) disabledsrcrqretsrcr releasesuitenewsrcrcolspcolcolr-r-r.disable_suitess4     rcCs.dD]}||gD] }t|||dq qdS)z=Adds any keys included in the primary/security mirror clauses)primaryr) file_nameN)r7 add_apt_key)r0r,rrr-r-r.r\s r\c Csd}||d}|D]}||||<||||<q |dd}|durGtd|d|jj}|s9|d}|sBtddSt |}t ||} t |d | |} tj || d d dS) zgenerate_sources_list create a source.list file based on a custom or default template by replacing mirrors and release in the templatez/etc/apt/sources.list)rGrD sources_listNz1No custom template provided, fall back to builtinzsources.list.%sz sources.listz6No template found, not rendering /etc/apt/sources.listri)mode)lowerr7rWinfoget_template_filenamedistrorrr load_filerrr write_file) r0rqrrr1aptsrcrsktmpl template_fnrenderedrr-r-r.r]s,        r]FcCsHtd|zt|j}td|||dWStjy#tdw)zM actual adding of a key as defined in key argument to the system zAdding key: '%s'r) output_filer}hardenedz(failed to add apt GPG Key to apt keyring) rWrXpathlibPathstemapt_keyrProcessExecutionErrorrd)rrrr,rr-r-r.add_apt_key_raws   rcCs^d|vrd|vrt}d|vr|d}t|d||d<d|vr-t|d|p)|d|dSdS)z Add key to the system as defined in ent (if any). Supports raw keys or keyid's The latter will as a first step fetched to get the raw key keyidr keyserverrrN)DEFAULT_KEYSERVERr getkeybyidr)entr,rrrr-r-r.rsrcCs|jdSN)rupdate_package_sources)r1r-r-r.update_packages src Cs|duri}|durtdt|tstd||D]}||}td|d|vr/||d<d|vrEd|dvrEt||dd }||d <nt||}d|vrOq|d}t||}|d d skt j d |d|d<|d d sz|dd 7<||rz tjdd|g|dWntjytdwqt||d} zd|} d} d|vr|dsd} tj| | | dWqty} ztd| | d} ~ wwt|dS)a install keys and repo source .list files defined in 'sources' for each 'source' entry in the config: 1. expand template variables and write source .list file in /etc/apt/sources.list.d/ 2. install defined keys 3. update packages via distro-specific method (i.e. apt-key update) @param srcdict: a dict containing elements required @param cloud: cloud instance object Example srcdict value: { 'rio-grande-repo': { 'source': 'deb [signed-by=$KEY_FILE] $MIRROR $RELEASE main', 'keyid': 'B59D 5F15 97A5 04B7 E230 6DCA 0620 BBCF 0368 3F77', 'keyserver': 'pgp.mit.edu' } } Note: Deb822 format is not supported Nz did not get a valid repo matcherzunknown apt format: %szadding source/key '%s'rsourcez $KEY_FILETrKEY_FILErz/etc/apt/sources.list.d/z.listzadd-apt-repositoryz --no-updaterCzadd-apt-repository failed.z%s arw)omodezfailed write to file %s: %s)r*r8r9 TypeErrorrWrXrrrrrkrrr~rrrdrrrrbr) srcdictr1r,rJrKrrkey_filersourcefncontentsrdetailr-r-r.ri sd        ricCs~i}tjddddt|tr2td|D]}d|vr'd|d<t|d}n|d}|||<q|St|tr;|}|Std) z1convert v1 apt format to v2 (dict in apt_sources)zConfig key 'apt_sources'22.1zUse 'apt' instead) deprecateddeprecated_version extra_messagez9apt config: convert V1 to V2 format (source list to dict)rzcloud_config_sources.listzunknown apt_sources format) r deprecater8rrWrX rand_dict_keyr9r*)srclistrsrcentrr-r-r.convert_v1_to_v2_apt_formatfs&    rcCs,||ddur||||<||=dSdS)ziconvert an old key to the new one if the old one exists returns true if a key was found and convertedNTFr7)oldcfgaptcfgoldkeynewkeyr-r-r. convert_keys rcCsLgd}d}ddgi}|D] \}}t||||rd}q |r$|g|d<dSdS)zBconvert old apt_mirror keys into the new more advanced mirror spec)) apt_mirroruri)apt_mirror_searchrh)apt_mirror_search_dns search_dnsFarchesdefaultTrN)r)rrkeymap convertednewmcfgrrr-r-r.convert_mirrors  rc CsVddddddddddd d }g}|D]}||vr'||d vr"||=q||q|s,|Stjd |d d|dd}|durwtjdd d|D]+}||}||}||=|dusb||ddurcqI|||krttd||||fqI|Si}|D]}||durt|||||q{t|||D]}||ddurtd|q||d<|S)z:convert old to new keys and adapt restructured mirror specrFNproxy http_proxy https_proxy ftp_proxyrErrI) apt_sourcesrrr apt_proxyapt_http_proxy apt_ftp_proxyapt_https_proxyapt_preserve_sources_listapt_custom_sources_listrI)NrzThe following config key(s): r)rrr4z0Support for combined old and new apt module keysz@Old and New apt format defined with unequal values %s vs %s @ %sz&old apt key '%s' left after conversion)rrr r7r*rr)r mapoldkeys needtoconvertr newaptcfgrverifyrr-r-r.convert_v2_to_v3_apt_formatsr         r/cCs,|dd}|durt||d<t|}|S)zconvert the old list based format to the new dict based one. After that convert the old dict keys/format to v3 a.k.a 'new apt config'r$N)r7rr/)r0r$r-r-r.r6s  r6c Csd}|rZd}g}|dkrd}n |dkrd}ntdt||j}d|dd d}|r6|d ||d g} |jj } d | |d | f} |D] } | | | qKt | }|S)zG Try to resolve a list of predefines DNS names to pick mirrors Nrrrrzsecurity-mirrorzunknown mirror type.rOz.%s)z .localdomainrzhttp://%s-%s%s/%sz%s) r*rget_hostname_fqdnfqdnrrrextendrrsearch_for_mirror) configured mirrortyper0r1rmydomdoms mirrordnsr2 mirror_listr mirrorfmtpostr-r-r.search_for_mirror_dnss. r=cCsX|dur|dur |}||dS|j}|r(|}|d|d<|d|d<|St|S)z^sets security mirror to primary if not defined. returns defaults if no mirrors are definedNrrrrr) datasourceget_package_mirror_infor'r/)pmirrorsmirrorr+r1 mirror_infomr-r-r.update_mirror_info s    rDcCsT||d}|dur dSd}|D]}|dpg}||vr!|Sd|vr'|}q|S)zuout of a list of potential mirror configurations select and return the one matching the architecture (or default)Nrrr)r0r6r+mirror_cfg_listrmirror_cfg_elemrr-r-r.get_arch_mirrorconfig8s rGcCs`t|||}|dur dS|dd}|durt|dd}|dur.t|dd|||}|S)zpass the three potential stages of mirror specification returns None is neither of them found anything otherwise the first hit is returnedNrrhr)rGr7rr4r=)r0r6r+r1mcfgrr-r-r. get_mirrorKs  rIcCsn|durt}td|t|d||}td|t|d||}td|t||||}|d|d<|S) afind_apt_mirror_info find an apt_mirror given the cfg provided. It can check for separate config of primary and security mirrors If only primary is given security is assumed to be equal to primary If the generic apt_mirror is given that is defining for both Nz!got arch for mirror selection: %srzgot primary mirror: %srzgot security mirror: %srrH)rr$rWrXrIrD)r0r1r+r@rArBr-r-r.rZes    rZcsd}fdd|D}t|r!td|t|d|dntj|r2t |td| ddrItd |t| ddStj|r\t |td |dSdS) zHapply_apt_config Applies any apt*proxy config from if specified ))r Acquire::http::Proxy "%s";)r!rJ)r#zAcquire::ftp::Proxy "%s";)r"zAcquire::https::Proxy "%s";cs(g|]\}}|r||qSr-r)rTrfmtr0r-r.rVs(z$apply_apt_config..zwrite apt proxy info to %srz#no apt proxy configured, removed %sconfNzwrite apt config info to %sz$no apt config configured, removed %s) rrWrXrrrrkrisfiledel_filer7)r0 proxy_fname config_fnamecfgsproxiesr-rLr.r_}s        r_TcsRddfdd}fdd}|dkr|S|dks"|d kr%|Std ) adapt-key replacement commands implemented: 'add', 'list', 'finger' @param output_file: name of output gpg file (without .gpg or .asc) @param data: key contents @param human_output: list keys formatted for human parsing @param hardened: write keys to to /etc/apt/cloud-init.gpg.d/ (referred to with [signed-by] in sources file) cSsJtjtr tgng}ttD]}|dr|t|q|r#|SdS)zreturn all apt keys /etc/apt/trusted.gpg (if it exists) and all keyfiles (and symlinks to keyfiles) in /etc/apt/trusted.gpg.d/ are returned based on apt-key implementation )z.gpgz.ascr)rkrrNAPT_LOCAL_KEYSlistdirAPT_TRUSTED_GPG_DIRr~r) key_filesfiler-r-r._get_key_filess   zapt_key.._get_key_filesc sd}sttd|Szrtnt}t}d|}t||W|St j y=ttdY|St yOttdY|Sw)ziapt-key add returns filepath to new keyring, or '/dev/null' when an error occurs z /dev/nullz)Unknown filename, failed to add key: "{}"z{}{}.gpgz Gpg error, failed to add key: {}z#Decode error, failed to add key: {}) rlogexcrWr:CLOUD_INIT_GPG_DIRrVrdearmorrrrUnicodeDecodeError)rkey_dirstdout)r}rrr-r. apt_key_adds0        zapt_key..apt_key_addc sfg}D](}z |tj|dWqtjy-}z td||WYd}~qd}~wwd|S)zapt-key list returns string of all trusted keys (in /etc/apt/trusted.gpg and /etc/apt/trusted.gpg.d/) ) human_outputzFailed to list key "%s": %sNr)rrrrrrWrr)key_listrerror)rYrar-r. apt_key_lists  zapt_key..apt_key_listrfingerrz@apt_key() commands add, list, and finger are currently supported)r*)commandrr}rrar`rdr-)rYr}rrarr.rsrz cloud-init)NNr)FN)NFN)NNN)NNFT)L__doc__rrkrrfrmtextwrapr cloudinitrrloggingrrrcloudinit.cloudrcloudinit.configr cloudinit.config.schemar r cloudinit.settingsr getLogger__name__rWrerTrVr[rrr__annotations__rrar`rr&r)r%r(r/strrr?rBr=rrr<rrr^rrr\r]rrrrirrrr/r6r=rDrGrIrZr_rrr-r-r-r.s       E`   ; !# &   Y J)  R