HEX

File: //usr/lib/python3.9/site-packages/certbot/__pycache__/util.cpython-39.opt-1.pyc
a

}|�ge�@sVUdZddlZddlZddlZddlZddlZddlZddlZddlZddl	Z	ddl
Z
ddlmZddlm
Z
ddlmZddlmZddlmZddlmZdd	lmZdd
lmZddlmZddlmZddlZdd
lmZddlmZddlmZddlmZddlmZe
j�d�Z e �r,ddl!Z!e�"e#�Z$Gdd�de�Z%Gdd�de�Z&Gdd�d�Z'dZ(dZ)dZ*ej+�,d�Z-e�.�Z/iZ0ee1ej2fe3d<e�4dej5�Z6ee1e1fd�d d!�Z7e$j8fee1e
e1gdfee1e1fd"�d#d$�Z9e1e:d%�d&d'�Z;e1dd(�d)d*�Z<dd�d+d,�Z=e1e>e:dd-�d.d/�Z?dxe1e>e:dd-�d2d3�Z@dye1e1ee>ed5�d6d7�ZAe1e
e>ge1fe>e>e1eee1fd8�d9d:�ZBdze1e>e1eee1fd<�d=d>�ZCd{e1e1e>e1eee1fd@�dAdB�ZDe1ddC�dDdE�ZEee1ee1dF�dGdH�ZFee1e1fd�dIdJ�ZGe1d�dKdL�ZHee1d�dMdN�ZId|e1e1e1dP�dQdR�ZJe1e1dS�dTdU�ZKd}e:ee1e1fdV�dWdX�ZLe�4dY�ZMe1e:dZ�d[d\�ZNGd]d^�d^ejO�ZPe
d_e1ee1e>fdd`�dadb�ZQe1e1dc�ddde�ZRee1eSfe1dc�dfdg�ZTe1e:dh�didj�ZUee1eSfe:dc�dkdl�ZVe1e:dm�dndo�ZWe
eeddp�dqdr�ZXe1eee>e1fds�dtdu�ZYe
eeddp�dvdw�ZZdS)~zUtilities for all Certbot.�N)�Any)�Callable)�Dict)�IO)�List)�
NamedTuple)�Optional)�Set)�Tuple)�Union)�errors)�	constants)�lock)�
filesystem)�os�linuxc@s&eZdZUdZeeed<eed<dS)�KeyzPContainer for an optional file path and contents for a PEM-formated private key.�fileZpemN��__name__�
__module__�__qualname__�__doc__r�str�__annotations__�bytes�rr�0/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.r�dataZformNrrrrrr,s
rc@s0eZdZdZedd�dd�Zded�dd�ZdS)	�LooseVersiona�A 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.
    N��version_string�returnc	CsTdd�t�|�D�}t|�D],\}}zt|�||<WqtyFYq0q||_dS)zhParses a version string into its components.

        :param str version_string: version string
        cSsg|]}|r|dkr|�qS)�.r��.0�xrrr�
<listcomp>Hs�z)LooseVersion.__init__.<locals>.<listcomp>N)�_VERSION_COMPONENT_RE�split�	enumerate�int�
ValueError�version_components)�selfr"�
components�i�objrrr�__init__BszLooseVersion.__init__)�otherr#cCspzDtj|j|jdd�D](\}}||kr.WdS||krWdSqWdStyjtd�|j|j���Yn0dS)a�Compares 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)�	fillvalue����z~Cannot meaningfully compare LooseVersion {} with LooseVersion {} due to comparison of version components with different types.N)�	itertools�zip_longestr.�	TypeErrorr-�format)r/r4Zself_vcZother_vcrrr�try_risky_comparisonRs�
�z!LooseVersion.try_risky_comparison)rrrrrr3r,r<rrrrr 4s
r z[1mz[31mz[0m)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#csZtj���d�vsd�vr�SdD]2}|�vr"d��fdd��|�d�D���|<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�	<genexpr>��z1env_no_snap_for_external_calls.<locals>.<genexpr>)r�environ�copy�joinr*)�	path_namerrAr�env_no_snap_for_external_calls�s
(rI)�params�logr#c	Cs�z tj|dtjtjdt�d�}Wn6ttfyVdd�|�}||�t�|��Yn0|j	dkr�dd�|�|j
|jf}||�t�|��|j
|jfS)z�Run 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)�check�stdout�stderr�universal_newlinesrBzUnable to run the command: %s� rzError while running %s.
%s
%s)�
subprocess�run�PIPErI�OSErrorr-rGrZSubprocessError�
returncoderMrN)rJrK�proc�msgrrr�
run_script�s&�

�
rX)�exer#cCsTtj�|�\}}|rt�|�Stjd�tj�D]}t�tj�||��r0dSq0dS)z�Determine 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)r�pathr*rZ
is_executablerE�pathseprG)rYrZ�_rrr�
exe_exists�s	
r])�dir_pathr#cCs&tstt�|tvr"t�|�t|<dS)z�Lock 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^rrr�lock_dir_until_exit�sracCsLt��D]6}z|��Wqd�|�}tj|dd�Yq0qt��dS)Nz(Exception occurred releasing lock: {0!r}T��exc_info)r=�values�releaser;�logger�debug�clear)Zdir_lockrWrrrr`�s
r`)�	directory�mode�strictr#c
Cs`zt|||�t|�WnBtyZ}z*tjddd�t�t�|���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;)rirjrk�errorrrr�set_up_core_dir�srp��Fc
Cspzt�||�WnZtyj}zB|jtjkrT|rVt�||�sVt�d|t|�f��n�WYd}~n
d}~00dS)a�Make 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�makedirsrT�errno�EEXISTZcheck_permissionsrrm�oct)rirjrk�	exceptionrrrrls
��rl�w)rZrj�chmodr#cCsLd}|dur|f}d}tj|tjtjBtjBg|�R�}tj||g|�R�S)z�Safely 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�openr�O_CREAT�O_EXCL�O_RDWR�fdopen)rZrjrxZ	open_argsZfdopen_args�fdrrr�	safe_open&s	"r)rZ�filename_pat�countrxrjr#c
Csptj�|||��}zt|||d�tj�|�fWSty`}z|jtjkrL�WYd}~n
d}~00|d7}qdS)N)rxrjr7)rrZrGr�abspathrTrsrt)rZr�r�rxrjZcurrent_path�errrrr�_unique_file7sr��)rZrxrjr#cs*tj�|�\}�t|�fdd�d||d�S)z�Safely 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

    csd|�fS)Nz%04d_%sr�r���tailrr�<lambda>PrDzunique_file.<locals>.<lambda>r�r�r�rxrj)rrZr*r�)rZrxrjrr�r�unique_fileDs

�r��)rZ�filenamerxrjr#c
srtj�|d��}zt||d�|fWStyV}z|jtjkrB�WYd}~n
d}~00t|�fdd�d||d�S)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)rxNcsd�|fS)Nz%s-%04d.confrr��r�rrr�lrDz%unique_lineage_name.<locals>.<lambda>r7r�)rrZrGrrTrsrtr�)rZr�rxrjZpreferred_pathr�rr�r�unique_lineage_nameTs�r�)rZr#c
CsFzt�|�Wn2ty@}z|jtjkr,�WYd}~n
d}~00dS)z!Remove a file that may not exist.N)r�removerTrs�ENOENT)rZr�rrr�
safely_removeps
r�)�	all_namesr#c	CsLt�}|D]<}z|�t|��Wq
tjyDtjd|dd�Yq
0q
|S)z�Removes 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)�set�add�enforce_le_validityr�ConfigurationErrorrfrg)r�Zfiltered_names�namerrr�get_filtered_namesys	r�cCs
tdd�S)zc
    Get OS name and version

    :returns: (os_name, os_version)
    :rtype: `tuple` of `str`
    F��pretty)�get_python_os_inforrrr�get_os_info�sr�cCs0d}trtjdd�}tr|s,d�tdd��S|S)z_
    Get OS name and version string for User Agent

    :returns: os_ua
    :rtype: `str`

    �Tr�rP)�_USE_DISTRO�distror�rGr�)Zos_inforrr�get_os_info_ua�s
r�cCstrt���d�SgS)z�
    Get a list of strings that indicate the distribution likeness to
    other distributions.

    :returns: List of distribution acronyms
    :rtype: `list` of `str`
    rP)r�r�Zliker*rrrr�get_systemd_os_like�s	r��/etc/os-release)�varname�filepathr#cCs�|d}tj�|�sdSt|d��}|��}Wd�n1s@0Y|D].}|���|�rNt|��t|�d��SqNdS)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`
    �=r��rN)	rrZ�isfilery�	readlines�strip�
startswith�_normalize_string�len)r�r�Z
var_stringZfh�contents�linerrr�get_var_from_file�s
&r�)�origr#cCs|�dd��dd���S)zV
    Helper function for get_var_from_file() to remove quotes
    and whitespaces
    �"r��')�replacer�)r�rrrr��sr�)r�r#cCs,t�t��t��t���}|\}}}|��}|�d�rjtrj|rFt�	�nt�
�t��}}|r`|}|rh|}n�|�d�r�z$tjddgtj
tj
ddt�d�}Wn2ty�tjddgtj
tj
ddt�d�}Yn0|j�d	�}nJ|�d
��r|�d�d}|�d
�d}n t��d�r t��d}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�darwinz/usr/bin/sw_versz-productVersionFT)rMrNrLrOrBZsw_vers�
Zfreebsd�-rr$r7r�)�platformZsystem_alias�systemre�version�lowerr�r�r�r��idrQrRrSrIrTrM�rstrip�	partitionZ	win32_ver)r��infoZos_typeZos_verr\Zdistro_nameZdistro_versionrVrrrr��sH
�

�
�r�z![a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+$)�emailr#cCs2t�|�dur"|�d�o d|vSt�d|�dS)z$Scrub email address before using it.Nr$z..zInvalid email address: %s.F)�EMAIL_REGEX�matchr�rfro)r�rrr�
safe_emailsr�c@s,eZdZdZdeeeeedd�dd�ZdS)�DeprecatedArgumentActionz1Action to log a warning when an argument is used.N)�unused1�unused2�unused3�
option_stringr#cCst�d|�dS)NzUse of %s is deprecated.)rfZwarning)r/r�r�r�r�rrr�__call__sz!DeprecatedArgumentAction.__call__)N)rrrrrrrr�rrrrr�s
��r�).N)�add_argument�
argument_name�nargsr#cCsJttjvr4ttjt�r$tj�t�ntjtf7_||ttj|d�dS)a�Adds 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.

    )�action�helpr�N)r��configargparseZ#ACTION_TYPES_THAT_DONT_NEED_A_VALUE�
isinstancer�r��argparse�SUPPRESS)r�r�r�rrr�add_deprecated_arguments
���r�)�domainr#cCs�t|�}t�d|�s$t�d�|���|�d�}t|�dkrJt�d�|���|D]<}|�d�rnt�d�||���|�	d�rNt�d�||���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 labelsr�z1label "{0}" in domain "{1}" cannot start with "-"z/label "{0}" in domain "{1}" cannot end with "-")
�enforce_domain_sanity�rer�rr�r;r*r�r��endswith)r��labelsZlabelrrrr�5s4��
�
��
��r�cCsz"t|t�r|�d�}|�d�Wnty>t�d��Yn0|��}|�d�r^|dd�n|}dD]&}|�	d�
|��rft�d	�
||���qft|�r�t�d
�
|���d�
|�}t|�dkr�t�d
�
|���|�
d�}|D]6}|s�t�d�
|���t|�dkr�t�d�
||���q�|S)a�Method 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-8�asciizbNon-ASCII domain names not supported. To issue for an Internationalized Domain Name, use Punycode.r$Nr6)�http�httpsz{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 because�z{0} it is too long.z{0} it contains an empty label.�?z{0} label {1} is too long.)r�r�decode�encode�UnicodeErrorrr�r�r�r�r;�is_ipaddressr�r*)r��schemerWr��lrrrr�Ws>

����

r�)�addressr#cCsZzt�tj|�WdStyTzt�tj|�WYdStyNYYdS0Yn0dS)z�Is 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)r�rrrr��s
r�cCst|t�r|�d�S|�d�S)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*.)r�rr�)r�rrr�is_wildcard_domain�s


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
ZSTAGING_URI)r�rrr�
is_staging�sr�)�func�args�kwargsr#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)�atexit�register�_atexit_call�r�r�r�rrrr_�s	r_r!cCst|�}|jS)a�Parses 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_versionrrr�parse_loose_version�sr�cOstt��kr||i|��dS)N)�_INITIAL_PIDr�getpidr�rrrr��sr�)rqF)rwN)r�rw)r�rw)r�)F)[rr�r�rsr8Zloggingr�r�r�rQ�sys�typingrrrrrrrr	r
rr�ZcertbotrZcertbot._internalr
rZcertbot.compatrrr�r�r�Z	getLoggerrrfrrr Z
ANSI_SGR_BOLDZANSI_SGR_REDZANSI_SGR_RESET�lineseprGrnr�r�r=rZLockFiler�compile�VERBOSEr)rIrorX�boolr]rar`r,rprlrr�r�r�r�r�r�r�r�r�r�r�r�r��Actionr�r�r�rr�r�r�r�r_r�r�rrrr�<module>s�
K.
�
��	

8
�";