a
}|gy. @ s d Z ddlZddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ dd lm Z dd
l
m Z dd l m
Z
dd l mZ dd
l mZ ddl mZ ddl mZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddl m Z e e Z!G dd de j"ej#Z#dS )zManual authenticator plugin N)Any)Callable)Dict)Iterable)List)Tuple)Type)
challenges) achallenges)errors)
interfaces)reverter)util)hooks)
cli_constants)misc)os)ops)commonc s8 e Zd ZdZdZdZdZdZdZdZ dZ
d Z e e d
d fd d
Z
eed d
dddZd
dddZd
dddZedddZeej edddZeeeej d d d Z e ej e ej d d d!Z eje ej d
d"d#d$Z d.eje!d
d&d'd(Z"eej d
d d)d*Z#eee$eef d+d,d-Z% Z&S )/
AuthenticatorzManual authenticator
This plugin allows the user to perform the domain validation
challenge(s) themselves. This either be done manually by the user or
through shell scripts provided to Certbot.
z2Manual configuration or run your own shell scriptsTa Authenticate through manual configuration or custom shell scripts. When using shell scripts, an authenticator script must be provided. The environment variables available to this script depend on the type of challenge. $CERTBOT_DOMAIN will always contain the domain being authenticated. For HTTP-01 and DNS-01, $CERTBOT_VALIDATION is the validation string, and $CERTBOT_TOKEN is the filename of the resource requested when performing an HTTP-01 challenge. An additional cleanup script can also be provided and can use the additional variable $CERTBOT_AUTH_OUTPUT which contains the stdout output from the auth script. For both authenticator and cleanup script, on HTTP-01 and DNS-01 challenges, $CERTBOT_REMAINING_CHALLENGES will be equal to the number of challenges that remain after the current one, and $CERTBOT_ALL_DOMAINS contains a comma-separated list of all domains that are challenged for the current certificate.zcPlease deploy a DNS TXT record under the name:
{domain}.
with the following value:
{validation}
a
Before continuing, verify the TXT record has been deployed. Depending on the DNS
provider, this may take some time, from a few seconds to multiple minutes. You can
check if it has finished deploying with aid of online tools, such as the Google
Admin Toolbox: https://toolbox.googleapps.com/apps/dig/#TXT/{domain}.
Look for one or more bolded line(s) below the line ';ANSWER'. It should show the
value(s) you've just added.
zuCreate a file containing just this data:
{validation}
And make it available on your web server at this URL:
{uri}
z
(This must be set up in addition to the previous challenges; do not remove,
replace, or undo the previous challenge tasks yet.)
z
(This must be set up in addition to the previous challenges; do not remove,
replace, or undo the previous challenge tasks yet. Note that you might be
asked to create multiple distinct TXT records with the same name. This is
permitted by DNS standards.)
N)argskwargsreturnc s@ t j|i | t| j| _| j i | _d| _d| _d S )NF) super__init__r
ZReverterconfigrecovery_routineenvsubsequent_dns_challengesubsequent_any_challenge)selfr r __class__ D/usr/lib/python3.9/site-packages/certbot/_internal/plugins/manual.pyr a s
zAuthenticator.__init__).N)addr c C s |ddd |ddd d S )N auth-hookz8Path or command to execute for the authentication script)help cleanup-hookz1Path or command to execute for the cleanup scriptr# )clsr% r# r# r$ add_parser_argumentsi s z"Authenticator.add_parser_arguments)r c C s4 | j jr(| ds(td| d| d S )Nr& zdAn authentication script must be provided with --{0} when using the manual plugin non-interactively.)r Znoninteractive_modeconfr Z PluginErrorformat option_name_validate_hooksr r# r# r$ preparep s zAuthenticator.preparec C sL | j jrHdD ]:}| |}|d ur | |d td }t|| q d S )N)r& r( z-hook)r Zvalidate_hooksr+ r- lenr Z
validate_hook)r namehookZ hook_prefixr# r# r$ r. x s
z Authenticator._validate_hooksc C s dS )NzThis plugin allows the user to customize setup for domain validation challenges either through shell scripts provided by the user or by performing the setup manually.r# r/ r# r# r$ more_info s zAuthenticator.more_info)failed_achallsr c s t tj td fdd tj}tjdtjdtjdi}dtfdd | D }|
d
r~d j t j
||rvd nd
dS dj ||rdnd
dS d S )N)r) r c s t fddD S )Nc 3 s | ]}t |j V qd S N)
isinstancechall).0achallr) r# r$ z=Authenticator.auth_hint..has_chall..)anyr; )r5 r; r$ has_chall s z*Authenticator.auth_hint..has_challzDNS TXT recordszchallenge fileszTLS-ALPN certificatesz and c s g | ]\}} |r|qS r# r# )r9 kv)r? r# r$
r= z+Authenticator.auth_hint..r& zThe Certificate Authority failed to verify the {resources} created by the --manual-auth-hook. Ensure that this hook is functioning correctly{dns_hint}. Refer to "{certbot} --help manual" and the Certbot User Guide.zD and that it waits a sufficient duration of time for DNS propagation )certbot resourcesdns_hintzThe Certificate Authority failed to verify the manually created {resources}. Ensure that you created these in the correct location{dns_hint}.z?, or try waiting longer for DNS propagation on the next attempt)rE rF )r r ChallengeboolDNS01HTTP01Z TLSALPN01joinsorteditemsr+ r, r Z cli_command)r r5 Zhas_dnsZresource_namesrE r# )r5 r? r$ auth_hint s6
zAuthenticator.auth_hint)domainr c C s t jt jgS r6 )r rJ rI )r rO r# r# r$ get_chall_pref s z Authenticator.get_chall_pref)achallsr c C s| g }d}t |D ]\}}t|jtjr|}qt |D ]B\}}| drT| || n| |||k || |j
q4|S )Nr r& ) enumerater7 r8 r rI r+ _perform_achall_with_script_perform_achall_manuallyappendZresponse account_key)r rQ Z responseslast_dns_achallir: r# r# r$ perform s
zAuthenticator.perform)r: rQ r c C s |j ||jddd |D tt||| d d}t|jt j
r^|j d|d< nt j
dd t j
| | d|j \}}| |d < || j|< d S )
N,c s s | ] }|j V qd S r6 rO )r9 Z
one_achallr# r# r$ r< r= z. )ZCERTBOT_DOMAINZCERTBOT_VALIDATIONZCERTBOT_ALL_DOMAINSZ CERTBOT_REMAINING_CHALLENGEStoken
CERTBOT_TOKENr& ZCERTBOT_AUTH_OUTPUT)rO
validationrV rK strr1 indexr7 r8 r rJ encoder environpopupdate
_execute_hookstripr )r r: rQ r _outr# r# r$ rS s
z)Authenticator._perform_achall_with_scriptF)r: rW r c C s | |j}t|jtjrH| jj||jd| j j
|j |j |d}n| j
j||j |d}t|jtjr| jr|| j7 }n| jr|| j7 }d| _|r|| jj||j d7 }n| jr|| j7 }tj|ddd d| _d S )Nr] )r: Z
encoded_tokenporturir_ )rO r_ Tr[ F)wrapZforce_interactive)r_ rV r7 r8 r rJ _HTTP_INSTRUCTIONSr, rb r Z http01_portrk rO _DNS_INSTRUCTIONSZvalidation_domain_namerI r &_SUBSEQUENT_DNS_CHALLENGE_INSTRUCTIONSr "_SUBSEQUENT_CHALLENGE_INSTRUCTIONS_DNS_VERIFY_INSTRUCTIONS display_utilZ notification)r r: rW r_ msgr# r# r$ rT s2
z&Authenticator._perform_achall_manuallyc C s^ | drP|D ]@}| j|}d|vr4tjdd tj| | d|j q| j d S )Nr( r^ )
r+ r rd r rc re rf rO r
r )r rQ r: r r# r# r$ cleanup s
zAuthenticator.cleanup) hook_name
achall_domainr c C sJ t j| || |t d\}}}td| d| ||| ||fS )N)r zHook '--manual-z' for )r Zexecute_command_statusr- r+ r Z env_no_snap_for_external_calls display_opsZreport_executed_command)r ru rv
returncodeerrri r# r# r$ rf s zAuthenticator._execute_hook)F)'__name__
__module__ __qualname____doc__ descriptionZhiddenZlong_descriptionrn rq rm rp ro r r classmethodr r* r0 r. r` r4 r r
ZAnnotatedChallengerN r r rG rP r ZChallengeResponserY rS rH rT rt r rf
__classcell__r# r# r! r$ r s< %
r )$r} Zloggingtypingr r r r r r r Zacmer rD r
r r r
r Zcertbot._internalr Zcertbot._internal.clir Zcertbot.compatr r Zcertbot.displayr rw rr Zcertbot.pluginsr Z getLoggerrz loggerZPluginr r# r# r# r$ s.