Edit File: dns_common.cpython-36.pyc
3 گa�5 � @ sT d Z ddlZddlZddlmZ ddlmZ ddlmZ ddlmZ ddlm Z ddlm Z dd lm Z ddl Z dd l mZ dd lmZ dd lmZ dd lmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlm Z ej e �Z G dd� de j ej!ej"d�Z#G dd� d�Z$e%dd�dd�Z&e%dd�d d �Z'e%ee% d �d d �Z(dS )!z*Common code for DNS Authenticator Plugins.� N)�sleep)�Callable)�Iterable)�List)�Mapping)�Optional)�Type)� challenges)� achallenges)� configuration)�errors)� interfaces)� filesystem)�os)�ops)�util)�commonc s� e Zd ZdZejedd�� fdd� Zed2e d3 e dd�d d ��Z e e j ed �d d �Zeeeej d�dd�Zdd�dd�Zed�dd�Ze e j e ej d�dd�Ze e j dd�dd�Zejdd�dd ��Z ejeeedd �d d ��Z ejeeedd �d d!��Z eedd"�d#d$�Z d4eee e egdf dd%�d&d'�Z!d5eee e"eef e e d(gdf d(d)�d*d+�Z#e$eed,�d-d.��Z%e$d6ee e egdf ed/�d0d1��Z&� Z'S )7�DNSAuthenticatorz!Base class for DNS AuthenticatorsN)�config�name�returnc s t � j||� d| _d S )NF)�super�__init__�_attempt_cleanup)�selfr r )� __class__� � /usr/lib/python3.6/dns_common.pyr s zDNSAuthenticator.__init__� .)�add�default_propagation_secondsr c C s |d|t dd� d S )Nzpropagation-secondszjThe number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record.)�default�type�help)�int)�clsr r r r r �add_parser_arguments$ s z%DNSAuthenticator.add_parser_arguments)�failed_achallsr c C s( | j d�}dj| j||dkr dndd�S )z,See certbot.plugins.common.Plugin.auth_hint.zpropagation-secondsz�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 Zsecs�suffix)�conf�formatr )r r' Zdelayr r r � auth_hint- s zDNSAuthenticator.auth_hint)� unused_domainr c C s t jgS )N)r ZDNS01)r r/ r r r �get_chall_pref7 s z DNSAuthenticator.get_chall_pref)r c C s d S )Nr )r r r r �prepare: s zDNSAuthenticator.preparec C s t � �d S )N)�NotImplementedError)r r r r � more_info= s zDNSAuthenticator.more_info)�achallsr c C s� | j � d| _g }xH|D ]@}|j}|j|�}|j|j�}| j|||� |j|j|j�� qW t j d| j d� � t | j d�� |S )NTz/Waiting %d seconds for DNS changes to propagatezpropagation-seconds) �_setup_credentialsr �domain�validation_domain_name� validation� account_key�_perform�append�response� display_utilZnotifyr, r )r r4 Z responses�achallr6 r7 r8 r r r �perform@ s zDNSAuthenticator.performc C sB | j r>x6|D ].}|j}|j|�}|j|j�}| j|||� q W d S )N)r r6 r7 r8 r9 �_cleanup)r r4 r> r6 r7 r8 r r r �cleanupX s zDNSAuthenticator.cleanupc C s t � �dS )z@ Establish credentials, prompting if necessary. N)r2 )r r r r r5 a s z#DNSAuthenticator._setup_credentials)r6 �validation_namer8 r c 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 N)r2 )r r6 rB r8 r r r r: h 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. N)r2 )r r6 rB r8 r r r r@ u s zDNSAuthenticator._cleanup)�key�labelr c C s0 | j |�}|s,| j|�}t| j| 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 rC rD �configured_value� new_valuer r r � _configure� s zDNSAuthenticator._configure)rC rD � validatorr c C sB | j |�}|s>| j||�}t| j| j|�tjjtjj|��� 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_filerF r rG r �path�abspath� expanduser)r rC rD rK rH rI r r r �_configure_file� s z DNSAuthenticator._configure_file�CredentialsConfiguration)rC rD �required_variablesrK r c sV t dd�� ��fdd� }�j|||� t�j|��j�}� rF|j� � �rR�|� |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. N)�filenamer c s* t | �j�}� r|j� � �r&�|� d S )N)rQ rG �require)rS Zapplied_configuration)rR r rK r r � __validator� s z<DNSAuthenticator._configure_credentials.<locals>.__validator)�strrP rQ r, rG rT )r rC rD rR rK � _DNSAuthenticator__validatorZcredentials_configurationr )rR r rK r �_configure_credentials� s z'DNSAuthenticator._configure_credentials)rD r c sP t dd�� fdd� }tj|dj� �dd�\}}|tjkr<|S tjdj� ���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 N)�ir c s | st jdj� ���d S )NzPlease enter your {0}.)r � PluginErrorr- )rY )rD r r rU � s z6DNSAuthenticator._prompt_for_data.<locals>.__validatorzInput your {0}T)�force_interactivez{0} required to proceed.)rV r Zvalidated_inputr- r= �OKr rZ )rD rW �coder< r )rD r rE � s z!DNSAuthenticator._prompt_for_data)rD rK r c sR t dd�� �fdd� }tj|dj� �dd�\}}|tjkr>|S tjdj� ���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 N)rS r c s8 | st jdj� ���tjj| �} t| � �r4�| � d S )Nz&Please enter a valid path to your {0}.)r rZ r- r rM rO � validate_file)rS )rD rK r r rU � s z6DNSAuthenticator._prompt_for_file.<locals>.__validatorzInput the path to your {0}T)r[ z{0} required to proceed.)rV r Zvalidated_directoryr- r= r\ r rZ )rD rK rW r] r< r )rD rK r rL � s z!DNSAuthenticator._prompt_for_file)r ).N)N)NN)N)(�__name__� __module__� __qualname__�__doc__r ZNamespaceConfigrV r � classmethodr r$ r& r r ZAnnotatedChallenger. r r r Z Challenger0 r1 r3 ZChallengeResponser? rA �abc�abstractmethodr5 r: r@ rJ r rP r rX � staticmethodrE rL � __classcell__r r )r r r s8 $ $%r )� metaclassc @ s| e Zd ZdZdd� feeegef dd�dd�Zeeef dd�d d �Zeed �d d �Z ee d �dd�Z eed �dd�Z dS )rQ z>Represents a user-supplied filed which stores API credentials.c C s | S )Nr )�xr r r �<lambda> s z!CredentialsConfiguration.<lambda>N)rS �mapperr c C sh t |� ytj|�| _W nD tjk r\ } z&tjd|dd� tjdj |���W Y dd}~X 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�confobjZConfigObjError�logger�debugr rZ r- rk )r rS rk �er r r r s "z!CredentialsConfiguration.__init__)rR r c C s� g }xZ|D ]R}| j |�s6|jdj| j|�|| �� q | j|�s |jdj| j|�|| �� q W |r�tjdjt|�dkr|dnd| jj dj |����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( �propertyZ propertiesz * N) �_hasr; r- rk �_getr rZ �lenro rS �join)r rR Zmessages�varr r r rT s z CredentialsConfiguration.require)rx r c C s | j |�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 )ru )r rx r r r r, 1 s z CredentialsConfiguration.confc C s | j |�| jkS )N)rk ro )r rx r r r rt ; s z CredentialsConfiguration._hasc C s | j j| j|��S )N)ro �getrk )r rx r r r ru > s z CredentialsConfiguration._get) r_ r` ra rb rV r r r rT r, �boolrt ru r r r r rQ s $ rQ )rS r c C s< t jj| �s tjdj| ���t jj| �r8tjdj| ���dS )z&Ensure that the specified file exists.zFile not found: {0}zPath is a directory: {0}N)r rM �existsr rZ r- �isdir)rS r r r r^ B s r^ c C s" t | � tj| �r tjd| � dS )zHEnsure that the specified file exists and warn about unsafe permissions.z8Unsafe permissions on credentials configuration file: %sN)r^ r Zhas_world_permissionsrp Zwarning)rS r r r rm L s rm )r6 r c s& | j 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 j � |d� ��qS )r} N)rw )�.0rY )� fragmentsr r � <listcomp>e s z,base_domain_name_guesses.<locals>.<listcomp>r )�split�rangerv )r6 r )r r �base_domain_name_guessesU s r� ))rb rd ZloggingZtimer Ztypingr r r r r r rn Zacmer Zcertbotr r r r Zcertbot.compatr r Zcertbot.displayr r r= Zcertbot.pluginsr Z getLoggerr_ rp ZPluginZ Authenticator�ABCMetar rQ rV r^ rm r� r r r r �<module> s6 j=
Back to File Manager