CasperSecurity
o
6��a�1 � @ s� d Z ddlZddlZddlmZ ddlZddlmZ ddlm Z ddlm
Z
ddl m Z ddl m
Z
dd lmZ dd
lmZ dd lmZ e�e�ZG d d
� d
eje
jejd�ZG dd� d�Zdd� 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
e
fdd�Z dd� Z dd� Z
ejdd� �Zejdd� �Zejdd� �Zdd� Zd'd d �Z d( d)d d!�Zed"d#� �Zed'd$d%��Z� ZS )*�DNSAuthenticatorz!Base class for DNS Authenticatorsc s t � �||� d| _d S )NF)�super�__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�add�default_propagation_secondsr r r �add_parser_arguments s
�z%DNSAuthenticator.add_parser_argumentsc C s, | � d�}dj| j||dkrdd�S dd�S )z,See certbot.plugins.common.Plugin.auth_hint.r z�The Certificate Authority failed to verify the DNS TXT records created by --{name}. Ensure the above domains are hosted by this DNS provider, or try increasing --{name}-propagation-seconds (currently {secs} second{suffix}).� �s� )r �secs�suffix)�conf�formatr )r �failed_achalls�delayr r r � auth_hint% s
����zDNSAuthenticator.auth_hintc C s t jgS �N)r �DNS01)r �
unused_domainr r r �get_chall_pref/ s z DNSAuthenticator.get_chall_prefc C s d S r* r �r r r r �prepare2 s zDNSAuthenticator.prepare�returnc C � t � �r* ��NotImplementedErrorr. r r r � more_info5 s zDNSAuthenticator.more_infoc C s~ | � � d| _g }|D ] }|j}|�|�}|�|j�}| �|||� |�|�|j�� q t �
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� display_util�notifyr% r )r �achalls� responses�achallr6 r7 r8 r r r �perform8 s
�zDNSAuthenticator.performc C sB | j r |D ]}|j}|�|�}|�|j�}| �|||� qd S d S r* )r r6 r7 r8 r9 �_cleanup)r r? rA r6 r7 r8 r r r �cleanupO s
�zDNSAuthenticator.cleanupc C r1 )z@
Establish credentials, prompting if necessary.
r2 r. r r r r5 X s z#DNSAuthenticator._setup_credentialsc C r1 )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
r2 �r r6 �validation_namer8 r r r r: _ s
zDNSAuthenticator._performc C r1 )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.
r2 rE r r r rC k s zDNSAuthenticator._cleanupc C s4 | � |�}|s| �|�}t| j| �|�|� dS 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 �
_configurex s
�zDNSAuthenticator._configureNc C sF | � |�}|s!| �||�}t| j| �|�tj�tj�|��� dS 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_filerH r rI r �path�abspath�
expanduser)r rJ rK � validatorrL rM r r r �_configure_file� s
(�z DNSAuthenticator._configure_file�CredentialsConfigurationc sN � ��fdd�}�� |||� t��|��j�}� r |�� � �r%�|� |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 d S r* )rU rI �require)�filename�
configuration��required_variablesr rS r r � __validator� s
�z<DNSAuthenticator._configure_credentials.<locals>.__validator)rT rU r% rI rV )r rJ rK rZ rS � _DNSAuthenticator__validator�credentials_configurationr rY r �_configure_credentials� s
z'DNSAuthenticator._configure_credentialsc sD � fdd�}t j|d�� �dd�\}}|tjkr|S t�d�� ���)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 | s
t �d�� ���d S )NzPlease enter your {0}.)r � PluginErrorr& )�i�rK r r r[ � s �z6DNSAuthenticator._prompt_for_data.<locals>.__validatorzInput your {0}T��force_interactive�{0} required to proceed.)r �validated_inputr& r= �OKr r_ )rK r\ �coder< r ra r rG � s
�
z!DNSAuthenticator._prompt_for_datac sF � �fdd�}t j|d�� �dd�\}}|tjkr|S t�d�� ���)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 s< | s
t �d�� ���tj�| �} t| � �r �| � d S d S )Nz&Please enter a valid path to your {0}.)r r_ r& r rP rR �
validate_file�rW �rK rS r r r[ � s �z6DNSAuthenticator._prompt_for_file.<locals>.__validatorzInput the path to your {0}Trb rd )r �validated_directoryr& r= rf r r_ )rK rS r\ rg r< r rj r rO � s
�
z!DNSAuthenticator._prompt_for_file)r r* )NN)r0 rU )�__name__�
__module__� __qualname__�__doc__r
� classmethodr r) r- r/ �strr4 rB rD �abc�abstractmethodr5 r: rC rN rT r^ � staticmethodrG rO �
__classcell__r r r r r s8
�
�&
r )� metaclassc @ s@ e Zd ZdZdd� fdd�Zdd� Zdd � Zd
d � Zd d
� ZdS )rU z>Represents a user-supplied filed which stores API credentials.c C s | S r* r )�xr r r �<lambda>� s z!CredentialsConfiguration.<lambda>c
C s^ t |� zt�|�| _W n tjy) } ztjd|dd� t�d� |���d}~ww || _
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� configobj� ConfigObj�confobj�ConfigObjError�logger�debugr r_ r& �mapper)r rW r� �er r r r
� s ��
z!CredentialsConfiguration.__init__c C s� g }|D ])}| � |�s|�d�| �|�|| �� q| �|�s-|�d�| �|�|| �� q|rGt�d�t|�dkr<dnd| 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}r �property�
propertiesz
* N) �_hasr; r& r� �_getr r_ �lenr} rW �join)r rZ �messages�varr r r rV
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
)r� �r r� r r r r% # s
z CredentialsConfiguration.confc C s | � |�| jv S r* )r� r} r� r r r r� - s z CredentialsConfiguration._hasc C s | j �| �|��S r* )r} �getr� r� r r r r� 0 s z CredentialsConfiguration._getN) rl rm rn ro r
rV r% r� r� r r r r rU � s
rU c C s< t j�| �st�d�| ���t j�| �r t�d�| ���dS )z&Ensure that the specified file exists.zFile not found: {0}zPath is a directory: {0}N)r rP �existsr r_ r& �isdirri r r r rh 4 s
�rh c C s& t | � t�| �rt�d| � dS dS )zHEnsure that the specified file exists and warn about unsafe permissions.z8Unsafe permissions on credentials configuration file: %sN)rh r �has_world_permissionsr �warningri r r r rz > s
�rz 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 )r� N)r� )�.0r` �� fragmentsr r �
<listcomp>W s z,base_domain_name_guesses.<locals>.<listcomp>r )�split�ranger� )r6 r r� r �base_domain_name_guessesG s
r� ) ro rr �logging�timer r{ �acmer �certbotr r �certbot.compatr r �certbot.displayr r r= �certbot.pluginsr
� getLoggerrl r �Plugin�
Authenticator�ABCMetar rU rh rz r� r r r r �<module> s(
c=