File: //usr/lib/python3/dist-packages/certbot/plugins/__pycache__/dns_common.cpython-38.pyc
U
�]�. � @ s� d Z ddlZddlZddlmZ ddlZddlZddlm Z ddl
m Z ddl
m Z ddl
mZ ddl
mZ dd lmZ dd
lmZ dd lmZ e�e�Zej�e j�ej� e j �G d d
� d
ej ���Z G dd� de �Z!dd� Z"dd� Z#dd� Z$dS )z*Common code for DNS Authenticator Plugins.� N)�sleep)�
challenges)�errors)�
interfaces)�
filesystem)�os)�ops)�util)�commonc s� e Zd ZdZ� fdd�Zed dd��Zdd� Zd d
� Zd d � Z d
d� Z
e j dd� �Z
e j dd� �Ze j dd� �Zdd� Zd!dd�Zd"dd�Zed d � �Zed#d d ��Z� ZS )$�DNSAuthenticatorz"Base class for DNS Authenticatorsc s t t| ��||� d| _d S )NF)�superr �__init__�_attempt_cleanup)�self�config�name�� __class__� �</usr/lib/python3/dist-packages/certbot/plugins/dns_common.pyr
s zDNSAuthenticator.__init__�
c C s |d|t dd� d S )N�propagation-secondszjThe number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record.)�default�type�help)�int)�cls�addZdefault_propagation_secondsr r r �add_parser_arguments! s
�z%DNSAuthenticator.add_parser_argumentsc C s t jgS �N)r ZDNS01)r Z
unused_domainr r r �get_chall_pref) s z DNSAuthenticator.get_chall_prefc C s d S r r �r r r r �prepare, s zDNSAuthenticator.preparec C s| | � � d| _g }|D ]@}|j}|�|�}|�|j�}| �|||� |�|�|j�� qt �
d| � d�� t | � d�� |S )NTz/Waiting %d seconds for DNS changes to propagater )
�_setup_credentialsr �domain�validation_domain_name�
validation� account_key�_perform�append�response�logger�info�confr )r �achallsZ responses�achallr$ r% r& r r r �perform/ s
�zDNSAuthenticator.performc C s> | j r:|D ].}|j}|�|�}|�|j�}| �|||� q
d S r )r r$ r% r& r' �_cleanup)r r. r/ r$ r% r& r r r �cleanupF s
zDNSAuthenticator.cleanupc C s
t � �dS )z@
Establish credentials, prompting if necessary.
N��NotImplementedErrorr! r r r r# O s z#DNSAuthenticator._setup_credentialsc C s
t � �dS )aX
Performs a dns-01 challenge by creating a DNS TXT record.
:param str domain: The domain being validated.
:param str validation_domain_name: The validation record domain name.
:param str validation: The validation record content.
:raises errors.PluginError: If the challenge cannot be performed
Nr3 �r r$ Zvalidation_namer& r r r r( V s
zDNSAuthenticator._performc C s
t � �dS )aX
Deletes the DNS TXT record which would have been created by `_perform_achall`.
Fails gracefully if no such record exists.
:param str domain: The domain being validated.
:param str validation_domain_name: The validation record domain name.
:param str validation: The validation record content.
Nr3 r5 r r r r1 b s zDNSAuthenticator._cleanupc C s0 | � |�}|s,| �|�}t| j| �|�|� dS )a
Ensure that a configuration value is available.
If necessary, prompts the user and stores the result.
:param str key: The configuration key.
:param str label: The user-friendly label for this piece of information.
N)r- �_prompt_for_data�setattrr �dest)r �key�label�configured_value� new_valuer r r �
_configureo s
zDNSAuthenticator._configureNc C sB | � |�}|s>| �||�}t| j| �|�tj�tj�|��� dS )a
Ensure that a configuration value is available for a path.
If necessary, prompts the user and stores the result.
:param str key: The configuration key.
:param str label: The user-friendly label for this piece of information.
N) r- �_prompt_for_filer7 r r8 r �path�abspath�
expanduser)r r9 r: � validatorr; r< r r r �_configure_file s
z DNSAuthenticator._configure_filec sN � ��fdd�}�� |||� t��|��j�}� r>|�� � �rJ�|� |S )a�
As `_configure_file`, but for a credential configuration file.
If necessary, prompts the user and stores the result.
Always stores absolute paths to avoid issues during renewal.
:param str key: The configuration key.
:param str label: The user-friendly label for this piece of information.
:param dict required_variables: Map of variable which must be present to error to display.
:param callable validator: A method which will be called to validate the
`CredentialsConfiguration` resulting from the supplied input after it has been validated
to contain the `required_variables`. Should throw a `~certbot.errors.PluginError` to
indicate any issue.
c s* t | �j�}� r|�� � �r&�|� d S r )�CredentialsConfigurationr8 �require)�filenameZ
configuration��required_variablesr rB r r � __validator� s
z<DNSAuthenticator._configure_credentials.<locals>.__validator)rC rD r- r8 rE )r r9 r: rH rB � _DNSAuthenticator__validatorZcredentials_configurationr rG r �_configure_credentials� s
z'DNSAuthenticator._configure_credentialsc sH � fdd�}t j|d�� �dd�\}}|tjkr4|S t�d�� ���dS )z�
Prompt the user for a piece of information.
:param str label: The user-friendly label for this piece of information.
:returns: The user's response (guaranteed non-empty).
:rtype: str
c s | st �d�� ���d S )NzPlease enter your {0}.)r � PluginError�format)�i�r: r r rI � s z6DNSAuthenticator._prompt_for_data.<locals>.__validatorzInput your {0}T�Zforce_interactive�{0} required to proceed.N)r Zvalidated_inputrM � display_util�OKr rL )r: rJ �coder* r rO r r6 � s
�
z!DNSAuthenticator._prompt_for_datac sJ � �fdd�}t j|d�� �dd�\}}|tjkr6|S t�d�� ���dS )a�
Prompt the user for a path.
:param str label: The user-friendly label for the file.
:param callable validator: A method which will be called to validate the supplied input
after it has been validated to be a non-empty path to an existing file. Should throw a
`~certbot.errors.PluginError` to indicate any issue.
:returns: The user's response (guaranteed to exist).
:rtype: str
c s8 | st �d�� ���tj�| �} t| � �r4�| � d S )Nz&Please enter a valid path to your {0}.)r rL rM r r? rA �
validate_file�rF �r: rB r r rI � s z6DNSAuthenticator._prompt_for_file.<locals>.__validatorzInput the path to your {0}TrP rQ N)r Zvalidated_directoryrM rR rS r rL )r: rB rJ rT r* r rW r r> � s
�
z!DNSAuthenticator._prompt_for_file)r )N)NN)N)�__name__�
__module__� __qualname__�__doc__r
� classmethodr r r" r0 r2 �abc�abstractmethodr# r( r1 r= rC rK � staticmethodr6 r> �
__classcell__r r r r r s*
%
r c @ s@ e Zd ZdZdd� fdd�Zdd� Zdd � Zd
d � Zd d
� ZdS )rD z>Represents a user-supplied filed which stores API credentials.c C s | S r r )�xr r r �<lambda>� � z!CredentialsConfiguration.<lambda>c
C sh t |� zt�|�| _W nD tjk
r\ } z$tjd|dd� t�d� |���W 5 d}~X Y nX || _
dS )z�
:param str filename: A path to the configuration file.
:param callable mapper: A transformation to apply to configuration key names
:raises errors.PluginError: If the file does not exist or is not a valid format.
z+Error parsing credentials configuration: %sT)�exc_infoz,Error parsing credentials configuration: {0}N) �validate_file_permissions� configobjZ ConfigObj�confobjZConfigObjErrorr+ �debugr rL rM �mapper)r rF ri �er r r r
� s "z!CredentialsConfiguration.__init__c C s� g }|D ]R}| � |�s4|�d�| �|�|| �� q| �|�s|�d�| �|�|| �� q|r�t�d�t|�dkrxdnd| jj d�
|����dS ) z�Ensures that the supplied set of variables are all present in the file.
:param dict required_variables: Map of variable which must be present to error to display.
:raises errors.PluginError: If one or more are missing.
z)Property "{0}" not found (should be {1}).z'Property "{0}" not set (should be {1}).z9Missing {0} in credentials configuration file {1}:
* {2}� �propertyZ
propertiesz
* N) �_hasr) rM ri �_getr rL �lenrg rF �join)r rH Zmessages�varr r r rE s(
�
���z CredentialsConfiguration.requirec C s
| � |�S )z�Find a configuration value for variable `var`, as transformed by `mapper`.
:param str var: The variable to get.
:returns: The value of the variable.
:rtype: str
)rn �r rq r r r r- s z CredentialsConfiguration.confc C s | � |�| jkS r )ri rg rr r r r rm % s z CredentialsConfiguration._hasc C s | j �| �|��S r )rg �getri rr r r r rn ( s z CredentialsConfiguration._getN) rX rY rZ r[ r
rE r- rm rn r r r r rD � s
rD c C s< t j�| �s t�d�| ���t j�| �r8t�d�| ���dS )z&Ensure that the specified file exists.zFile not found: {0}zPath is a directory: {0}N)r r? �existsr rL rM �isdirrV r r r rU , s rU c C s" t | � t�| �r t�d| � dS )zHEnsure that the specified file exists and warn about unsafe permissions.z8Unsafe permissions on credentials configuration file: %sN)rU r Zhas_world_permissionsr+ ZwarningrV r r r re 6 s
re c s& | � d�� � fdd�tdt� ��D �S )a� Return a list of progressively less-specific domain names.
One of these will probably be the domain name known to the DNS provider.
:Example:
>>> base_domain_name_guesses('foo.bar.baz.example.com')
['foo.bar.baz.example.com', 'bar.baz.example.com', 'baz.example.com', 'example.com', 'com']
:param str domain: The domain for which to return guesses.
:returns: The a list of less specific domain names.
:rtype: list
�.c s g | ]}d � � |d� ��qS )rv N)rp )�.0rN �Z fragmentsr r �
<listcomp>O s z,base_domain_name_guesses.<locals>.<listcomp>r )�split�rangero )r$ r rx r �base_domain_name_guesses? s
r| )%r[ r] Zlogging�timer rf Zzope.interface�zopeZacmer Zcertbotr r Zcertbot.compatr r Zcertbot.displayr r rR Zcertbot.pluginsr
Z getLoggerrX r+ Z interfaceZ implementerZIAuthenticatorZproviderZIPluginFactoryZPluginr �objectrD rU re r| r r r r �<module> s,
W=