a
}|g 8 @ 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 e e Z G dd de j ej!ej"dZ#G dd dZ$e%ddddZ&e%ddd 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 d e
ddd d
Z e e
j ed d d
Zeeeej dddZddddZedddZe e
j e ej dddZe e
j ddddZejdddd Z ejeeedd d d Z ejeeedd d d!Z eedd"d#d$Z d3eee e egdf dd%d&d'Z!d4eee e"eef e e d(gdf d(d)d*d+Z#e$eed,d-d.Z%e$d5ee e egdf ed/d0d1Z& Z'S )6DNSAuthenticatorz!Base class for DNS AuthenticatorsN)confignamereturnc s t || d| _d S )NF)super__init___attempt_cleanup)selfr r __class__ >/usr/lib/python3.9/site-packages/certbot/plugins/dns_common.pyr # s zDNSAuthenticator.__init__
).N)adddefault_propagation_secondsr c C s |d|t dd d S )Npropagation-secondszjThe number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record.)defaulttypehelp)int)clsr r! r r r add_parser_arguments( s
z%DNSAuthenticator.add_parser_arguments)failed_achallsr c C s( | d}dj| j||dkr dnddS )z,See certbot.plugins.common.Plugin.auth_hint.r" zThe 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 Zsecssuffix)confformatr )r r) Zdelayr r r auth_hint1 s
zDNSAuthenticator.auth_hint)
unused_domainr c C s t jgS N)r ZDNS01)r r1 r r r get_chall_pref; s z DNSAuthenticator.get_chall_pref)r c C s d S r2 r r r r r prepare> s zDNSAuthenticator.preparec C s
t d S r2 NotImplementedErrorr4 r r r more_infoA s zDNSAuthenticator.more_info)achallsr c 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 domainvalidation_domain_name
validation account_key_performappendresponse display_utilnotifyr. r )r r9 Z responsesachallr; r< r= r r r performD s
zDNSAuthenticator.performc C s> | j r:|D ].}|j}||}||j}| ||| q
d S r2 )r r; r< r= r> _cleanup)r r9 rD r; r< r= r r r cleanup\ s
zDNSAuthenticator.cleanupc C s
t dS )z@
Establish credentials, prompting if necessary.
Nr6 r4 r r r r: e s z#DNSAuthenticator._setup_credentials)r; validation_namer= 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
Nr6 r r; rH r= r r r r? l 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.
Nr6 rI r r r rF y s zDNSAuthenticator._cleanup)keylabelr c 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_datasetattrr dest)r rJ rK configured_value new_valuer r r
_configure s
zDNSAuthenticator._configure)rJ rK validatorr c C sB | |}|s>| ||}t| j| |tjtj| 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_filerM r rN r pathabspath
expanduser)r rJ rK rR rO rP r r r _configure_file s
z DNSAuthenticator._configure_fileCredentialsConfiguration)rJ rK required_variablesrR r c sV t dd fdd }||| t|j} rF| 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.
Nfilenamer c s* t | j} r| r&| d S r2 )rX rN require)r[ Zapplied_configurationrY r rR r r __validator s
z.__validator)strrW rX r. rN r\ )r rJ rK rY rR _DNSAuthenticator__validatorZcredentials_configurationr r] r _configure_credentials s
z'DNSAuthenticator._configure_credentials)rK r c sP t dd fdd }tj|d dd\}}|tjkr<|S td 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 d d S )NzPlease enter your {0}.)r PluginErrorr/ )rb rK r r r^ s z6DNSAuthenticator._prompt_for_data..__validatorzInput your {0}TZforce_interactive{0} required to proceed.)r_ r Zvalidated_inputr/ rB OKr rc )rK r` coderA r rd r rL s
z!DNSAuthenticator._prompt_for_data)rK rR r c sR t dd fdd }tj|d dd\}}|tjkr>|S td 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
NrZ c s8 | st d tj| } t| r4| d S )Nz&Please enter a valid path to your {0}.)r rc r/ r rT rV
validate_filer[ rK rR r r r^ s z6DNSAuthenticator._prompt_for_file..__validatorzInput the path to your {0}Tre rf )r_ r Zvalidated_directoryr/ rB rg r rc )rK rR r` rh rA r rk r rS s
z!DNSAuthenticator._prompt_for_file)r )N)NN)N)(__name__
__module__ __qualname____doc__r ZNamespaceConfigr_ r classmethodr r& r( r r
ZAnnotatedChallenger0 r r r Z Challenger3 r5 r8 ZChallengeResponserE rG abcabstractmethodr: r? rF rQ r rW r ra staticmethodrL rS
__classcell__r r r r r sR
(r ) metaclassc @ s e Zd ZdZdd feeegef ddddZeeef ddd d
Zee e d d d
Z
ee d ddZ ee e d ddZ
dS )rX z>Represents a user-supplied filed which stores API credentials.c C s | S r2 r )xr r r z!CredentialsConfiguration.N)r[ mapperr c
C sn t | zt|| _W nJ tjyb } z0tjd||dd td ||W Y d}~n
d}~0 0 || _
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.
z0Error parsing credentials configuration '%s': %sT)exc_infoz0Error parsing credentials configuration '{}': {}N) validate_file_permissions configobjZ ConfigObjconfobjZConfigObjErrorloggerdebugr rc r/ ry )r r[ ry er r r r s" z!CredentialsConfiguration.__init__)rY r c C s g }|D ]R}| |s4|d| ||| q| |s|d| ||| q|rtdt|dkrxdnd| jj d
|dS ) zEnsures 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/ ry _getr rc lenr} r[ join)r rY messagesvarr r r r\ & s$
z CredentialsConfiguration.require)r r c C s
| |S )zFind a configuration value for variable `var`, as transformed by `mapper`.
:param str var: The variable to get.
:returns: The value of the variable, if it exists.
:rtype: str or None
)r r r r r r r. ? s z CredentialsConfiguration.confc C s | || jv S r2 )ry r} r r r r r I s z CredentialsConfiguration._hasc C s | j | |S r2 )r} getry r r r r r L s z CredentialsConfiguration._get)rl rm rn ro r_ r r r r\ r r. boolr r r r r r rX s $
rX rZ c C s< t j| s td| t j| r8td| dS )z&Ensure that the specified file exists.zFile not found: {0}zPath is a directory: {0}N)r rT existsr rc r/ isdirrj r r r ri P s ri c C s" t | t| r td| dS )zHEnsure that the specified file exists and warn about unsafe permissions.z8Unsafe permissions on credentials configuration file: %sN)ri r Zhas_world_permissionsr~ Zwarningrj r r r r{ Z s
r{ )r; r c s& | d fddtdt 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 ).0rb Z fragmentsr r
s rx z,base_domain_name_guesses..r )splitranger )r; r r r base_domain_name_guessesc s
r ))ro rq Zloggingtimer typingr r r r r r r| Zacmer Zcertbotr
r r r
Zcertbot.compatr r Zcertbot.displayr r rB Zcertbot.pluginsr Z getLoggerrl r~ ZPluginZ
AuthenticatorABCMetar rX r_ ri r{ r r r r r s6
jG