CasperSecurity
o
6��a@Q � @ s~ U d Z ddlZddlZddlZddlZddlZddlZddlZddl Z ddl
Z
ddl Z ddl Z ddl
mZ ddl
mZ ddl
mZ ddl
mZ ddl
mZ ddlZddlZddlmZ dd lmZ dd
lmZ dd lmZ dd lm Z e j� d
�Z e rddl Z e� e!�Z"e�#dd�Z$e�#dd�Z%dZ&dZ'dZ(e j)�*d�Z+e �,� Z-i Z.ee/ej0f e1d< dd� Z2e"j3fdd�Z4dd � Z5d d � Z6d d � Z7d!d"� Z8d]d%d&�Z9d^d(e/d)e/d*efd+d,�Z:d-d.� Z;d_d0d1�Z<d`d3d4�Z=d5d6� Z>d7d8� Z?d9d:� Z@d;d<� ZAd=d>� ZBdad@dA�ZCdBdC� ZDdbdDdE�ZEe �FdF�ZGdGdH� ZHG dIdJ� dJejI�ZJdKdL� ZKdMdN� ZLdOdP� ZMdQdR� ZNdSdT� ZOdUdV� ZPdWdX� ZQdYdZ� ZRd[d\� ZSdS )czUtilities for all Certbot.� N)�Dict)�IO)�Text)�Tuple)�Union)�errors)� constants)�lock)�
filesystem)�os�linux�Keyzfile pem�CSRzfile data formz[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.�_LOCKSc sZ t j�� � d� vs
d� vr� S dD ]} | � v r*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
�SNAP�CERTBOT_SNAPPED)�PATH�LD_LIBRARY_PATH�:c 3 s � | ] }� d |vr|V qdS )r N� )�.0�x��envr �./usr/lib/python3/dist-packages/certbot/util.py� <genexpr>W s � z1env_no_snap_for_external_calls.<locals>.<genexpr>)r �environ�copy�join�split)� path_namer r r � env_no_snap_for_external_callsB s
&�r! c C s� zt j| dt jt jdt� d�}W n ttfy) dd�| � }||� t�|��w |j dkrDdd�| �|j
|j f }||� t�|��|j
|j fS )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_newlinesr z Unable to run the command: %s� r z Error while running %s.
%s
%s) �
subprocess�run�PIPEr! �OSError�
ValueErrorr r �SubprocessError�
returncoder# r$ )�params�log�proc�msgr r r �
run_script[ s(
�
�
�
r2 c C sT t j�| �\}}|rt�| �S t jd �t j�D ]}t�t j�|| ��r' dS qdS )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 r
�
is_executabler �pathsepr )�exer3 �_r r r �
exe_existsy s
�r8 c C s* t stt� | t vrt�| �t | < dS 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_locksr �lock_dir)�dir_pathr r r �lock_dir_until_exit� s
�r= c C sH t �� D ]} z| �� W q d�| �}tj|dd� Y qt �� d S )Nz(Exception occurred releasing lock: {0!r}T��exc_info)r �values�release�format�logger�debug�clear)�dir_lockr1 r r r r: � s
r: c
C sR z
t | ||� t| � W dS ty( } ztjddd� t�t�|���d}~ww )ah Ensure 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= r* rC rD r �Error� PERM_ERR_FMTrB )� directory�mode�strict�errorr r r �set_up_core_dir� s ��rN �� Fc
C sp z t �| |� W dS ty7 } z"|jtjkr+|r*t �| |�s*t�d| t|�f ��n� W Y d}~dS d}~ww )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
�makedirsr* �errno�EEXIST�check_permissionsr rH �oct)rJ rK rL � exceptionr r r rG � s
�����rG �wr3 rK �returnc C sL d}|dur |f}d}t j| tjtjB tjB g|�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``.
r N)r
�openr �O_CREAT�O_EXCL�O_RDWR�fdopen)r3 rK �chmod� open_args� fdopen_args�fdr r r � safe_open� s "ra c
C sn t j�| ||��}zt|||d�t j�|�fW S ty1 } z
|jtjkr'� W Y d }~nd }~ww |d7 }q)NT)r] rK � )r r3 r ra �abspathr* rQ rR )r3 � filename_pat�countr] rK � current_path�errr r r � _unique_file� s
� ����rh � c s* t j�| �\} � 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
c s d| � f S )Nz%04d_%sr �re ��tailr r �<lambda>� � z unique_file.<locals>.<lambda>r �rd re r] rK )r r3 r rh )r3 r] rK r rk r � unique_file� s
�rp � c
sr t j�| d� �}z t||d�|fW S ty+ } z
|jtjkr!� W Y d}~nd}~ww t| � fdd�d||d�S )a Safely 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)r] Nc s d� | f S )Nz %s-%04d.confr rj ��filenamer r rm rn z%unique_lineage_name.<locals>.<lambda>rb ro )r r3 r ra r* rQ rR rh )r3 rs r] rK �preferred_pathrg r rr r �unique_lineage_name s ��� �ru c
C sF zt �| � W dS ty" } z|jtjkr� W Y d}~dS d}~ww )z!Remove a file that may not exist.N)r �remover* rQ �ENOENT)r3 rg r r r �
safely_remove s ���rx c C sJ t � }| D ] }z |�t|�� W q tjy" tjd|dd� Y qw |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"Tr> )�set�add�enforce_le_validityr �ConfigurationErrorrC rD )� all_names�filtered_names�namer r r �get_filtered_names% s �r� c C s
t dd�S )zc
Get OS name and version
:returns: (os_name, os_version)
:rtype: `tuple` of `str`
F��pretty)�get_python_os_infor r r r � get_os_info6 s
r� c C s, t rtjdd�} t r | sd�tdd��S | S )z^
Get OS name and version string for User Agent
:returns: os_ua
:rtype: `str`
Tr� r& )� _USE_DISTRO�distror r r� )�os_infor r r �get_os_info_ua@ s
r� c C s t r t�� �d�S g S )z�
Get a list of strings that indicate the distribution likeness to
other distributions.
:returns: List of distribution acronyms
:rtype: `list` of `str`
r& )r� r� �liker r r r r �get_systemd_os_likeN s r� �/etc/os-releasec C s� | d }t j�|�s dS t|d�� }|�� }W d � n1 s w Y |D ]}|�� �|�r>t|�� t|�d� � S q'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) r r3 �isfilerX � readlines�strip�
startswith�_normalize_string�len)�varname�filepath�
var_string�fh�contents�liner r r �get_var_from_file[ s
� �r� c C s | � dd�� dd��� S )zV
Helper function for get_var_from_file() to remove quotes
and whitespaces
�"r� �')�replacer� )�origr r r r� q s r� c C s@ t �t �� t �� t �� �}|\}}}|�� }|�d�r8tr8| r#t� � nt�
� t�� }}|r0|}|r4|}||fS |�d�rszt j ddgt j
t j
ddt� d�}W n tyh t j ddgt j
t j
ddt� d�}Y nw |j�d �}||fS |�d
�r�|�d �d }|�d
�d }||fS t �� d r�t �� d }||fS d}||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)r# r$ r" r% r �sw_vers�
�freebsd�-r �.rb r� )�platform� system_alias�systemrA �version�lowerr� r� r� r �idr' r( r) r! r* r# �rstrip� partition� win32_ver)r� �info�os_type�os_verr7 � distro_name�distro_versionr0 r r r r� x sR
�
�
�
��
� � �r� z![a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+$c C s2 t �| �dur| �d� od| vS t�d| � dS )z$Scrub email address before using it.Nr� z..zInvalid email address: %s.F)� EMAIL_REGEX�matchr� rC rM )�emailr r r �
safe_email� s r� c @ s e Zd ZdZddd�ZdS )�DeprecatedArgumentActionz1Action to log a warning when an argument is used.Nc C s t �d| t� d S )NzUse of %s is deprecated.)�warnings�warn�DeprecationWarning)�self�unused1�unused2�unused3�
option_stringr r r �__call__� s z!DeprecatedArgumentAction.__call__�N)�__name__�
__module__� __qualname__�__doc__r� r r r r r� � s r� c C sJ t tjvrttjt�rtj�t � nt jt f7 _| |t tj|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�help�nargsN)r� �configargparse�#ACTION_TYPES_THAT_DONT_NEED_A_VALUE�
isinstancery rz �argparse�SUPPRESS)� add_argument�
argument_namer� r r r �add_deprecated_argument� s
��
�r� c C s� t | �} t�d| �st�d�| ���| �d�}t|�dk r%t�d�| ���|D ] }|�d�r7t�d�|| ���|� d�rEt�d�|| ���q'| S ) au Checks 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 -.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� r r| rB r r� r� �endswith)�domain�labels�labelr r r r{ � s4 �
�
��
���r{ c C s zt | t�r | �d�} | �d� W n ty t�d��w | �� } | �d�r-| dd� n| } dD ]}| � d�
|��rDt�d �
| |���q1t | �rQt�d
�
| ���d �
| �}t | �d krdt�d
�
|���| �
d�}|D ]}|swt�d�
|���t |�dkr�t�d�
||���qk| 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 `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-8�asciizbNon-ASCII domain names not supported. To issue for an Internationalized Domain Name, use Punycode.r� N���)�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� �bytes�decode�encode� UnicodeErrorr r| r� r� r� rB � is_ipaddressr� r )r� �schemer1 r� �lr r r r� � sD
�����
�r� c C sV z
t �t j| � W dS t jy* z t �t j| � W Y dS t jy) Y Y dS w w )z�Is given address string form of IP(v4 or v6) address?
:param address: address to check
:type address: `str` or `unicode`
:returns: True if address is valid IP address, otherwise return False.
:rtype: bool
TF)�socket� inet_pton�AF_INETrM �AF_INET6)�addressr r r r� 7 s
��r� c C s d}t | t�r d}| �|�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
s *.z*.)r� �strr� )r� �wildcard_markerr r r �is_wildcard_domainN s
r� c C s t j�| �dd��S )z�Converts a normalized version to a strict version.
:param str normalized: normalized version string
:returns: An equivalent strict version
:rtype: distutils.version.StrictVersion
z.dev�a)� distutilsr� �
StrictVersionr� )�
normalizedr r r �get_strict_version^ s
r� c C s | t jkpd| v S )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:
�staging)r � STAGING_URI)�srvr r r �
is_stagingk s r� c O s t jt| g|�R i |�� dS )a Sets 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��func�args�kwargsr r r r9 v s r9 c O s" t t�� kr| |i |�� d S d S r� )� _INITIAL_PIDr �getpidr� r r r r� � s �r� )rO F)rV N)ri rV )rq rV )r� )F)Tr� r� r� � collections�distutils.versionr� rQ �loggingr� r� r� r' �sys�typingr r r r r r� r� �certbotr �certbot._internalr r �certbot.compatr
r r� r� r� � getLoggerr� rC �
namedtupler
r �
ANSI_SGR_BOLD� ANSI_SGR_RED�ANSI_SGR_RESET�linesepr rI r� r� r r� �LockFile�__annotations__r! rM r2 r8 r= r: rN rG ra rh rp ru rx r� r� r� r� r� r� r� �compiler� r� �Actionr� r� r{ r� r� r� r� r� r9 r� r r r r �<module> s�
8!;