U ]\L@sDdZddlZddlZddlZddlmZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddl Z ddlZddlZddlZddlmZmZddlmZddlmZddlmZddlmZdd lmZe j d rddlZd Znd ZeeZ e!d dZ"e!ddZ#dZ$dZ%dZ&ej'(dZ)e*Z+eZ,e j-fddZ.ddZ/ddZ0ddZ1ddZ2dUd d!Z3dVd#d$Z4d%d&Z5dWd(d)Z6dXd+d,Z7d-d.Z8d/d0Z9d1d2Z:d3d4Z;d5d6Zdd?Z@e Ad@ZBdAdBZCGdCdDdDejDZEdEdFZFdGdHZGdIdJZHdKdLZIdMdNZJdOdPZKdQdRZLdSdTZMdS)[zUtilities for all Certbot.N) OrderedDict)TupleUnion) constants)errors)lock)os) filesystemlinuxTFKeyzfile pemCSRzfile data formzzz)z$The following error was encountered:z{0}zWEither run as root, or set --config-dir, --work-dir, and --logs-dir to writeable paths.c Csztj|tjtjdd}Wn8ttfk rRdd|}||t|YnX|\}}|j dkrdd|||f}||t|||fS)zRun the script with the given params. :param list params: List of parameters to pass to Popen :param callable log: Logger method to use for errors T)stdoutstderruniversal_newlineszUnable to run the command: %s rzError while running %s. %s %s) subprocessPopenPIPEOSError ValueErrorjoinrZSubprocessError communicate returncode)Zparamslogprocmsgr rr./usr/lib/python3/dist-packages/certbot/util.py run_scriptCs(    rcCsTtj|\}}|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 PATHTF)rpathsplitr Z is_executableenvironpathsepr)exer _rrr exe_existsas  r&cCs&ts tt|tkr"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)_LOCKSatexit_register_release_locksrZlock_dir)Zdir_pathrrrlock_dir_until_exitusr*cCsNttD]6}z |Wq d|}tj|ddYq Xq tdS)Nz(Exception occurred releasing lock: {0!r}Texc_info)sixZ itervaluesr'releaseformatloggerdebugclear)Zdir_lockrrrrr)s  r)c Cs^zt|||t|Wn@tk rX}z"tjdddtt|W5d}~XYnXdS)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:Tr+N) make_or_verify_dirr*rr0r1rError PERM_ERR_FMTr/) directorymodestricterrorrrrset_up_core_dirs   r:c Csnzt||WnXtk rh}z:|jtjkrV|rXt||sXtd|t|fnW5d}~XYnXdS)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) r makedirsrerrnoEEXISTZcheck_permissionsrr4oct)r6r7r8Z exceptionrrrr3s  r3wcCsHd}|dk r|f}d}tj|tjtjBtjBf|}tj||f|S)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)r openrO_CREATO_EXCLO_RDWRfdopen)r r7chmodZ open_argsZ fdopen_argsfdrrr safe_opens  rHc Csntj|||}zt|||dtj|fWStk r^}z|jtjkrNW5d}~XYnX|d7}qdS)N)rFr7)rr rrHabspathrr=r>)r filename_patcountrFr7Z current_patherrrrr _unique_files   rNcs*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_%srrLtailrrzunique_file..rrKrLrFr7)rr r!rN)r rFr7rrQr unique_files  rVc sptj|d}zt||d|fWStk rT}z|jtjkrDW5d}~XYnXt|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)rFNcs d|fS)Nz %s-%04d.confrrPfilenamerrrSrTz%unique_lineage_name..rIrU)rr rrHrr=r>rN)r rYrFr7Zpreferred_pathrMrrXrunique_lineage_names  rZc CsDzt|Wn0tk r>}z|jtjkr.W5d}~XYnXdS)z!Remove a file that may not exist.N)rremoverr=ZENOENT)r rMrrr safely_removes  r\c CsNt}|D]>}z|t|Wq tjk rFtjd|ddYq Xq |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"Tr+)setaddenforce_le_validityrConfigurationErrorr0r1)Z all_namesZfiltered_namesnamerrrget_filtered_namess rbcCs tddS)zc Get OS name and version :returns: (os_name, os_version) :rtype: `tuple` of `str` Fpretty)get_python_os_inforrrr get_os_infosrfcCs,trtjdd}tr|s(dtddS|S)z^ Get OS name and version string for User Agent :returns: os_ua :rtype: `str` Trcr) _USE_DISTROdistrorarre)Zos_inforrrget_os_info_ua)s  ricCstjdtddtddS)z Parse systemd /etc/os-release for distribution information :returns: (os_name, os_version) :rtype: `tuple` of `str` zXThe get_sytemd_os_like() function is deprecated and will be removed in a future release.) stacklevelN)warningswarnDeprecationWarningrfrrrrget_systemd_os_info7s rocCstrtdSgS)z Get a list of strings that indicate the distribution likeness to other distributions. :returns: List of distribution acronyms :rtype: `list` of `str` r)rgrhZliker!rrrrget_systemd_os_likeDs rp/etc/os-releasec Csn|d}tj|sdSt|d}|}W5QRX|D].}||r:t|t|dSq:dS)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` =rN) rr isfilerA readlinesstrip startswith_normalize_stringlen)ZvarnamefilepathZ var_stringZfhcontentslinerrrget_var_from_fileQs   r~cCs|ddddS)zV Helper function for get_var_from_file() to remove quotes and whitespaces "rs')replacerw)ZorigrrrrygsrycCstttt}|\}}}|}|drftrft |}|drT|d}|drd|d}n|drzt j ddgt j dd}Wn*t k rt j d dgt j dd}YnX|dd }nH|d r|d d}|d d}n tdrtd}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` r rrIdarwinz/usr/bin/sw_versz-productVersionT)r rZsw_vers Zfreebsd-.rs)platformZ system_aliassystemr.versionlowerrxrgrhZlinux_distributionrrrrrrstrip partitionZ win32_ver)rdinfoZos_typeZos_verr%rrrrrensD        rez![a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+$cCs2t|dk r"|d o d|kStd|dS)z$Scrub email address before using it.Nrz..zInvalid email address: %s.F) EMAIL_REGEXmatchrxr0warning)Zemailrrr safe_emails rc@seZdZdZdddZdS) _ShowWarningz1Action to log a warning when an argument is used.NcCstd|dS)NzUse of %s is deprecated.)r0r)selfZunused1Zunused2Zunused3Z option_stringrrr__call__sz_ShowWarning.__call__)N)__name__ __module__ __qualname____doc__rrrrrrsrcCsJttjkr4ttjtr$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. )actionhelpnargsN)rconfigargparseZ#ACTION_TYPES_THAT_DONT_NEED_A_VALUE isinstancer]r^argparseZSUPPRESS) add_argumentZ argument_namerrrradd_deprecated_arguments  rcCst|}td|s$td||d}t|dkrJtd||D]<}|drntd||| drNtd||qN|S) auChecks that Let's Encrypt will consider domain to be valid. :param str domain: FQDN to check :type domain: `str` or `unicode` :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 -.rrjz{0} needs at least two labelsrz1label "{0}" in domain "{1}" cannot start with "-"z/label "{0}" in domain "{1}" cannot end with "-") enforce_domain_sanityrerrr`r/r!rzrxendswith)domainlabelsZlabelrrrr_s8      r_cCs<z$t|tjr|d}|dWntk rBtdYnX|}| drb|ddn|}dD]&}| d |rjtd ||qjzt |td |Wnt jk rYnXd |}t|d krtd ||d}|D]:}|std |qt|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 `unicode` :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.rN)ZhttpZhttpsz{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.)rr-Z binary_typedecodeencode UnicodeErrorrr`rrrxr/socketZ inet_atonr9rzr!)rZschemerrlrrrrsF         rcCs t|tjrd}nd}||S)z"Is domain a wildcard domain? :param domain: domain to check :type domain: `bytes` or `str` or `unicode` :returns: True if domain is a wildcard, otherwise, False :rtype: bool z*.s*.)rr-Z text_typerx)rZwildcard_markerrrris_wildcard_domain0s rcCstj|ddS)zConverts a normalized version to a strict version. :param str normalized: normalized version string :returns: An equivalent strict version :rtype: distutils.version.StrictVersion z.deva) distutilsrZ StrictVersionr)Z normalizedrrrget_strict_versionBs rcCs|tjkpd|kS)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)rZ STAGING_URI)Zsrvrrr is_stagingPsrcOstjt|f||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_callfuncargskwargsrrrr([s r(cOsttkr|||dS)N) _INITIAL_PIDrgetpidrrrrrgs r)r;F)r@N)rOr@)rWr@)rq)F)Nrrr collectionsrZdistutils.versionrr=Zloggingrrrrsysrlrr-Zacme.magic_typingrrZcertbotrrrZcertbot.compatrr rxrhrgZ getLoggerrr0 namedtupler r Z ANSI_SGR_BOLDZ ANSI_SGR_REDZANSI_SGR_RESETlineseprr5rrr'r9rr&r*r)r:r3rHrNrVrZr\rbrfrirorpr~ryrecompilerrZActionrrr_rrrrr(rrrrrs                     5  A