a }|ge@sVUdZddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl Z ddl m Z ddl m Z ddl mZddl mZddl mZddl mZdd l mZdd l mZdd l mZdd l mZddlZdd lmZddlmZddlmZddlmZddlmZe jdZ e r,ddl!Z!e"e#Z$GdddeZ%GdddeZ&GdddZ'dZ(dZ)dZ*ej+,dZ-e.Z/iZ0ee1ej2fe3d<e4dej5Z6ee1e1fdd d!Z7e$j8fee1e e1gdfee1e1fd"d#d$Z9e1e:d%d&d'Z;e1dd(d)d*Ze:dd-d.d/Z?dxe1e>e:dd-d2d3Z@dye1e1ee>ed5d6d7ZAe1e e>ge1fe>e>e1eee1fd8d9d:ZBdze1e>e1eee1fd<d=d>ZCd{e1e1e>e1eee1fd@dAdBZDe1ddCdDdEZEee1ee1dFdGdHZFee1e1fddIdJZGe1ddKdLZHee1ddMdNZId|e1e1e1dPdQdRZJe1e1dSdTdUZKd}e:ee1e1fdVdWdXZLe4dYZMe1e:dZd[d\ZNGd]d^d^ejOZPe d_e1ee1e>fdd`dadbZQe1e1dcdddeZRee1eSfe1dcdfdgZTe1e:dhdidjZUee1eSfe:dcdkdlZVe1e:dmdndoZWe e e ddpdqdrZXe1eee>e1fdsdtduZYe e e ddpdvdwZZdS)~zUtilities for all Certbot.N)Any)Callable)Dict)IO)List) NamedTuple)Optional)Set)Tuple)Union)errors) constants)lock) filesystem)oslinuxc@s&eZdZUdZeeed<eed<dS)KeyzPContainer for an optional file path and contents for a PEM-formated private key.fileZpemN__name__ __module__ __qualname____doc__rstr__annotations__bytesrr0/usr/lib/python3.9/site-packages/certbot/util.pyr&s  rc@s.eZdZUdZeeed<eed<eed<dS)CSRzPContainer for an optional file path and contents for a PEM or DER-formatted CSR.rdataZformNrrrrrr,s  rc@s0eZdZdZeddddZdedddZdS) LooseVersionaA version with loose rules, i.e. any given string is a valid version number. but regular comparison is not supported. Instead, the `try_risky_comparison` method is provided, which may return an error if two LooseVersions are 'incomparible'. For example when integer and string version components are present in the same position. Differences with old distutils.version.LooseVersion: (https://github.com/python/cpython/blob/v3.10.0/Lib/distutils/version.py#L269) Most version comparisons should give the same result. However, if a version has multiple trailing zeroes, not all of them are used in the comparison. This ensure that, for example, "2.0" and "2.0.0" are equal. Nversion_stringreturnc CsTddt|D}t|D],\}}zt|||<WqtyFYq0q||_dS)zhParses a version string into its components. :param str version_string: version string cSsg|]}|r|dkr|qS).r.0xrrr Hs z)LooseVersion.__init__..N)_VERSION_COMPONENT_REsplit enumerateint ValueErrorversion_components)selfr" componentsiobjrrr__init__Bs zLooseVersion.__init__)otherr#cCspzDtj|j|jddD](\}}||kr.WdS||krWdSqWdStyjtd|j|jYn0dS)aCompares the LooseVersion to another value. If the other value is another LooseVersion, the version components are compared. Otherwise, an exception is raised. Comparison is performed element-wise. If the version components being compared are of different types, the two versions are considered incomparible. Otherwise, if either of the components is not equal to the other, less or greater is returned based on the comparison's result. In case the two versions are of different lengths, some elements in the longer version have not yet been compared. If these are all equal to zero, the two versions are equal. Otherwise, the longer version is greater. If the two versions are incomparible, an exception is raised. Otherwise, the returned integer indicates the result of the comparison. If self == other, 0 is returned. If self > other, 1 is returned. If self < other -1 is returned. Examples: Equality: - LooseVersion('1.0').try_risky_comparison(LooseVersion('1.0')) -> 0 - LooseVersion('2.0.0a').try_risky_comparison(LooseVersion('2.0.0a')) -> 0 Inequality: - LooseVersion('2.0.0').try_risky_comparison(LooseVersion('1.0')) -> 1 - LooseVersion('1.0.1').try_risky_comparison(LooseVersion('2.0a')) -> -1 Incomparability: - LooseVersion('1a').try_risky_comparison(LooseVersion('1.0')) -> ValueError r) fillvaluez~Cannot meaningfully compare LooseVersion {} with LooseVersion {} due to comparison of version components with different types.N) itertools zip_longestr. TypeErrorr-format)r/r4Zself_vcZother_vcrrrtry_risky_comparisonRs  z!LooseVersion.try_risky_comparison)rrrrrr3r,r<rrrrr 4s r zzz)z$The following error was encountered:z{0}zWEither run as root, or set --config-dir, --work-dir, and --logs-dir to writeable paths._LOCKSz(\d+ | [a-z]+ | \.))r#csZtjdvsdvrSdD]2}|vr"dfdd|dD|<q"S)a When Certbot is run inside a Snap, certain environment variables are modified. But Certbot sometimes calls out to external programs, since it uses classic confinement. When we do that, we must modify the env to remove our modifications so it will use the system's libraries, since they may be incompatible with the versions of libraries included in the Snap. For example, apachectl, Nginx, and anything run from inside a hook should call this function and pass the results into the ``env`` argument of ``subprocess.Popen``. :returns: A modified copy of os.environ ready to pass to Popen :rtype: dict SNAPZCERTBOT_SNAPPED)PATHZLD_LIBRARY_PATH:c3s|]}d|vr|VqdS)r>Nrr%envrr z1env_no_snap_for_external_calls..)renvironcopyjoinr*) path_namerrArenv_no_snap_for_external_callss (rI)paramslogr#c Csz tj|dtjtjdtd}Wn6ttfyVdd|}||t|Yn0|j dkrdd||j |j f}||t||j |j fS)zRun the script with the given params. :param list params: List of parameters to pass to subprocess.run :param callable log: Logger method to use for errors FT)checkstdoutstderruniversal_newlinesrBzUnable to run the command: %s rzError while running %s. %s %s) subprocessrunPIPErIOSErrorr-rGr ZSubprocessError returncoderMrN)rJrKprocmsgrrr run_scripts&   rX)exer#cCsTtj|\}}|rt|StjdtjD]}ttj||r0dSq0dS)zDetermine whether path/name refers to an executable. :param str exe: Executable path or name :returns: If exe is a valid executable :rtype: bool r?TF)rpathr*rZ is_executablerEpathseprG)rYrZ_rrr exe_existss  r])dir_pathr#cCs&ts tt|tvr"t|t|<dS)zLock the directory at dir_path until program exit. :param str dir_path: path to directory :raises errors.LockError: if the lock is held by another process N)r=atexit_register_release_locksrZlock_dir)r^rrrlock_dir_until_exitsracCsLtD]6}z |Wqd|}tj|ddYq0qtdS)Nz(Exception occurred releasing lock: {0!r}Texc_info)r=valuesreleaser;loggerdebugclear)Zdir_lockrWrrrr`s   r`) directorymodestrictr#c Cs`zt|||t|WnBtyZ}z*tjdddtt|WYd}~n d}~00dS)ahEnsure directory exists with proper permissions and is locked. :param str directory: Path to a directory. :param int mode: Directory mode. :param bool strict: require directory to be owned by current user :raises .errors.LockError: if the directory cannot be locked :raises .errors.Error: if the directory cannot be made or verified zException was:TrbN) make_or_verify_dirrarTrfrgr Error PERM_ERR_FMTr;)rirjrkerrorrrrset_up_core_dirs   rpFc Cspzt||WnZtyj}zB|jtjkrT|rVt||sVtd|t|fnWYd}~n d}~00dS)aMake sure directory exists with proper permissions. :param str directory: Path to a directory. :param int mode: Directory mode. :param bool strict: require directory to be owned by current user :raises .errors.Error: if a directory already exists, but has wrong permissions or owner :raises OSError: if invalid or inaccessible file names and paths, or other arguments that have the correct type, but are not accepted by the operating system. zE%s exists, but it should be owned by current user with permissions %sN) rmakedirsrTerrnoEEXISTZcheck_permissionsr rmoct)rirjrk exceptionrrrrl s  rlw)rZrjchmodr#cCsLd}|dur|f}d}tj|tjtjBtjBg|R}tj||g|RS)zSafely open a file. :param str path: Path to a file. :param str mode: Same os `mode` for `open`. :param int chmod: Same as `mode` for `filesystem.open`, uses Python defaults if ``None``. rN)ropenrO_CREATO_EXCLO_RDWRfdopen)rZrjrxZ open_argsZ fdopen_argsfdrrr safe_open&s "r)rZ filename_patcountrxrjr#c Csptj|||}zt|||dtj|fWSty`}z|jtjkrLWYd}~n d}~00|d7}qdS)N)rxrjr7)rrZrGrabspathrTrsrt)rZrrrxrjZ current_patherrrrr _unique_file7s r)rZrxrjr#cs*tj|\}t|fddd||dS)zSafely finds a unique file. :param str path: path/filename.ext :param int chmod: File mode :param str mode: Open mode :returns: tuple of file object and file name cs d|fS)Nz%04d_%srrtailrrPrDzunique_file..rrrrxrj)rrZr*r)rZrxrjrrr unique_fileDs  r)rZfilenamerxrjr#c srtj|d}zt||d|fWStyV}z|jtjkrBWYd}~n d}~00t|fddd||dS)aSafely finds a unique file using lineage convention. :param str path: directory path :param str filename: proposed filename :param int chmod: file mode :param str mode: open mode :returns: tuple of file object and file name (which may be modified from the requested one by appending digits to ensure uniqueness) :raises OSError: if writing files fails for an unanticipated reason, such as a full disk or a lack of permission to write to specified location. z%s.conf)rxNcs d|fS)Nz %s-%04d.confrrrrrrlrDz%unique_lineage_name..r7r)rrZrGrrTrsrtr)rZrrxrjZpreferred_pathrrrrunique_lineage_nameTs  r)rZr#c CsFzt|Wn2ty@}z|jtjkr,WYd}~n d}~00dS)z!Remove a file that may not exist.N)rremoverTrsENOENT)rZrrrr safely_removeps  r) all_namesr#c CsLt}|D]<}z|t|Wq tjyDtjd|ddYq 0q |S)zRemoves names that aren't considered valid by Let's Encrypt. :param set all_names: all names found in the configuration :returns: all found names that are considered valid by LE :rtype: set zNot suggesting name "%s"Trb)setaddenforce_le_validityr ConfigurationErrorrfrg)rZfiltered_namesnamerrrget_filtered_namesys rcCs tddS)zc Get OS name and version :returns: (os_name, os_version) :rtype: `tuple` of `str` Fpretty)get_python_os_inforrrr get_os_infosrcCs0d}trtjdd}tr|s,dtddS|S)z_ Get OS name and version string for User Agent :returns: os_ua :rtype: `str` TrrP) _USE_DISTROdistrorrGr)Zos_inforrrget_os_info_uas  rcCstrtdSgS)z Get a list of strings that indicate the distribution likeness to other distributions. :returns: List of distribution acronyms :rtype: `list` of `str` rP)rrZliker*rrrrget_systemd_os_likes r/etc/os-release)varnamefilepathr#cCs|d}tj|sdSt|d}|}Wdn1s@0Y|D].}||rNt|t|dSqNdS)z Get single value from a file formatted like systemd /etc/os-release :param str varname: Name of variable to fetch :param str filepath: File path of os-release file :returns: requested value :rtype: `str` =rrN) rrZisfilery readlinesstrip startswith_normalize_stringlen)rrZ var_stringZfhcontentslinerrrget_var_from_files   &r)origr#cCs|ddddS)zV Helper function for get_var_from_file() to remove quotes and whitespaces "r')replacer)rrrrrsr)rr#c Cs,tttt}|\}}}|}|drjtrj|rFt nt t}}|r`|}|rh|}n|drz$t j ddgt j t j ddtd}Wn2tyt j ddgt j t j ddtd}Yn0|jd }nJ|d r|d d }|d d }n tdr td}nd}||fS)z Get Operating System type/distribution and major version using python platform module :param bool pretty: If the returned OS name should be in longer (pretty) form :returns: (os_name, os_version) :rtype: `tuple` of `str` rdarwinz/usr/bin/sw_versz-productVersionFT)rMrNrLrOrBZsw_vers Zfreebsd-rr$r7r)platformZ system_aliassystemreversionlowerrrrridrQrRrSrIrTrMrstrip partitionZ win32_ver)rinfoZos_typeZos_verr\Z distro_nameZdistro_versionrVrrrrsH       rz![a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+$)emailr#cCs2t|dur"|d o d|vStd|dS)z$Scrub email address before using it.Nr$z..zInvalid email address: %s.F) EMAIL_REGEXmatchrrfro)rrrr safe_email s rc@s,eZdZdZdeeeeeddddZdS)DeprecatedArgumentActionz1Action to log a warning when an argument is used.N)unused1unused2unused3 option_stringr#cCstd|dS)NzUse of %s is deprecated.)rfZwarning)r/rrrrrrr__call__sz!DeprecatedArgumentAction.__call__)N)rrrrrrrrrrrrrs r).N) add_argument argument_namenargsr#cCsJttjvr4ttjtr$tjtntjtf7_||ttj|ddS)aAdds a deprecated argument with the name argument_name. Deprecated arguments are not shown in the help. If they are used on the command line, a warning is shown stating that the argument is deprecated and no other action is taken. :param callable add_argument: Function that adds arguments to an argument parser/group. :param str argument_name: Name of deprecated argument. :param nargs: Value for nargs when adding the argument to argparse. )actionhelprN)rconfigargparseZ#ACTION_TYPES_THAT_DONT_NEED_A_VALUE isinstancerrargparseSUPPRESS)rrrrrradd_deprecated_arguments  r)domainr#cCst|}td|s$td||d}t|dkrJtd||D]<}|drntd||| drNtd||qN|S) ahChecks that Let's Encrypt will consider domain to be valid. :param str domain: FQDN to check :type domain: `str` :returns: The domain cast to `str`, with ASCII-only contents :rtype: str :raises ConfigurationError: for invalid domains and cases where Let's Encrypt currently will not issue certificates z^[A-Za-z0-9.-]*$zP{0} contains an invalid character. Valid characters are A-Z, a-z, 0-9, ., and -.r$z{0} needs at least two labelsrz1label "{0}" in domain "{1}" cannot start with "-"z/label "{0}" in domain "{1}" cannot end with "-") enforce_domain_sanityrerr rr;r*rrendswith)rlabelsZlabelrrrr5s4      rcCsz"t|tr|d}|dWnty>tdYn0|}|dr^|ddn|}dD]&}| d |rftd ||qft |rtd |d |}t |d krtd || d}|D]6}|std |t |dkrtd ||q|S)aMethod which validates domain value and errors out if the requirements are not met. :param domain: Domain to check :type domain: `str` or `bytes` :raises ConfigurationError: for invalid domains and cases where Let's Encrypt currently will not issue certificates :returns: The domain cast to `str`, with ASCII-only contents :rtype: str zutf-8asciizbNon-ASCII domain names not supported. To issue for an Internationalized Domain Name, use Punycode.r$Nr6)httphttpsz{0}://z[Requested name {0} appears to be a URL, not a FQDN. Try again without the leading "{1}://".zRequested name {0} is an IP address. The Let's Encrypt certificate authority will not issue certificates for a bare IP address.z*Requested domain {0} is not a FQDN becausez{0} it is too long.z{0} it contains an empty label.?z{0} label {1} is too long.)rrdecodeencode UnicodeErrorr rrrrr; is_ipaddressrr*)rschemerWrlrrrrWs>        r)addressr#c CsZzttj|WdStyTzttj|WYdStyNYYdS0Yn0dS)zIs given address string form of IP(v4 or v6) address? :param address: address to check :type address: `str` :returns: True if address is valid IP address, otherwise return False. :rtype: bool TFN)socketZ inet_ptonZAF_INETrTZAF_INET6)rrrrrs   rcCst|tr|dS|dS)z"Is domain a wildcard domain? :param domain: domain to check :type domain: `bytes` or `str` :returns: True if domain is a wildcard, otherwise, False :rtype: bool z*.s*.)rrr)rrrris_wildcard_domains  r)srvr#cCs|tjkpd|vS)z Determine whether a given ACME server is a known test / staging server. :param str srv: the URI for the ACME server :returns: True iff srv is a known test / staging server :rtype bool: Zstaging)r Z STAGING_URI)rrrr is_stagingsr)funcargskwargsr#cOstjt|g|Ri|dS)aSets func to be called before the program exits. Special care is taken to ensure func is only called when the process that first imports this module exits rather than any child processes. :param function func: function to be called in case of an error N)atexitregister _atexit_callrrrrrrr_s r_r!cCst|}|jS)aParses a version string into its components. This code and the returned tuple is based on the now deprecated distutils.version.LooseVersion class from the Python standard library. Two LooseVersion classes and two lists as returned by this function should compare in the same way. See https://github.com/python/cpython/blob/v3.10.0/Lib/distutils/version.py#L205-L347. :param str version_string: version string :returns: list of parsed version string components :rtype: list )r r.)r"Z loose_versionrrrparse_loose_versions rcOsttkr||i|dS)N) _INITIAL_PIDrgetpidrrrrrs r)rqF)rwN)rrw)rrw)r)F)[rrrrsr8ZloggingrrrrQsystypingrrrrrrrr r r rZcertbotr Zcertbot._internalr rZcertbot.compatrrrrrZ getLoggerrrfrrr Z ANSI_SGR_BOLDZ ANSI_SGR_REDZANSI_SGR_RESETlineseprGrnrrr=rZLockFilercompileVERBOSEr)rIrorXboolr]rar`r,rprlrrrrrrrrrrrrrrActionrrrrrrrrr_rrrrrrs                 K .      8  ";