a
oep> @ s d Z ddlZddlZddlZddlZddlmZ ddlmZ ddlmZ ddlm Z ddlm
Z
ddlm Z dd lm Z dd
lm
Z
dd lmZ dd lmZ dd
lmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlm Z ddlm Z ddl m Z ddl m Z! ddl"m#Z# ddl"m Z ddl$m%Z% e&e'Z(dZ)dd gZ*G d d d e#j+ej,Z,G d d d ej-Z.G d!d" d"ej-Z/e0e0d#d$d%Z1dS )&zWebroot plugin. N)Any)Callable) DefaultDict)Dict)Iterable)List)Optional)Sequence)Set)Type)Union)
challenges) crypto_util)errors)
interfaces)cli)AnnotatedChallenge)
filesystem)os)ops)util)common) safe_opena!
Z@20c5ca1bd58fa8ad5f07a2f1be8b7cbb707c20fcb607a8fc8db9393952846a97Z@8d31383d3a079d2098a9d0c0921f4ab87e708b9868dc3f314d54094c2fe70336c sT e Zd ZdZdZdZedddZee d dd d
d Z
e e ed d
dZ
eeeej dddZeedd fdd ZddddZe e e ej dddZee ddddZee e ee d d d Zee e ee d d d Zd/ee ee d"d#d$Z ddd%d&Z ee ed'd(d)Z e ejd*d+d,Z e e ddd-d.Z! Z"S )0
AuthenticatorzWebroot Authenticator.zSaves the necessary validation files to a .well-known/acme-challenge/ directory within the nominated webroot path. A seperate HTTP server must be running and serving files from the webroot path. HTTP challenge only (wildcards not supported).zAuthenticator plugin that performs http-01 challenge by saving
necessary validation resources to appropriate paths on the file
system. It expects that there is some other HTTP server configured
to serve all files under specified web root ({0}).)returnc C s | j | dS )Npath) MORE_INFOformatconfself r! BC:\Program Files\Certbot\pkgs\certbot\_internal\plugins\webroot.py more_infoF s zAuthenticator.more_info).NN)addr c C s& |ddg t dd |di tdd d S )Nr z-wa public_html / webroot path. This can be specified multiple times to handle different domains; each domain will have the webroot path that preceded it. For instance: `-w /var/www/example -d example.com -d www.example.com -w /var/www/thing -d thing.net -d m.thing.net` (default: Ask))defaultactionhelpmapa JSON dictionary mapping domains to webroot paths; this implies -d for each entry. You may need to escape this from your shell. E.g.: --webroot-map '{"eg1.is,m.eg1.is":"/www/eg1/", "eg2.is":"/www/eg2"}' This option is merged with, but takes precedence over, -w / -d entries. At present, if you put webroot-map in a config file, it needs to be on a single line, like: webroot-map = {"example.com":"/var/www"}.)_WebrootPathAction_WebrootMapAction)clsr$ r! r! r" add_parser_argumentsI s
z"Authenticator.add_parser_arguments)failed_achallsr c C s dS )NzThe Certificate Authority failed to download the temporary challenge files created by Certbot. Ensure that the listed domains serve their content from the provided --webroot-path/-w and that files created there can be downloaded from the internet.r! )r r- r! r! r" auth_hint[ s zAuthenticator.auth_hint)domainr c C s t jgS N)r
HTTP01)r r/ r! r! r" get_chall_prefa s z Authenticator.get_chall_prefargskwargsr c s. t j|i | i | _tt| _g | _d S r0 )super__init__
full_roots collections defaultdictset performed
_created_dirsr r4 r5 __class__r! r" r7 e s zAuthenticator.__init__c C s d S r0 r! r r! r! r" preparel s zAuthenticator.prepare)achallsr c s$ | fdd|D S )Nc s g | ]} |qS r! )_perform_single).0achallr r! r"
t z)Authenticator.perform..)
_set_webroots_create_challenge_dirs)r rB r! r r" performo s
zAuthenticator.performc C s | drD| dd }td| |D ]}| d|j| q(n|tt| d }|D ]`}|j| dvr^| |j|}z| | W n t
y Y n0 | d| || d|j< q^d S )Nr z4Using the webroot path %s for all unmatched domains.r( r ) r loggerinfo
setdefaultr/ listr; values_prompt_for_webrootremove
ValueErrorinsert)r rB webroot_pathrE known_webrootsZ new_webrootr! r! r" rH v s&
zAuthenticator._set_webroots)r/ rV r c C sB d }|d u r>|r0| ||}|d u r<| |}q| |d}q|S )NT)_prompt_with_webroot_list_prompt_for_new_webroot)r r/ rV webrootr! r! r" rQ s z!Authenticator._prompt_for_webrootc C s\ d| d }tjd|dg| |dd\}}|tjkrDtd|dkrPd S ||d S )
Nz--r zSelect the webroot for {0}:zEnter a new webrootT)Zcli_flagforce_interactiveIEvery requested domain must have a webroot when using the webroot plugin.r )Z option_name display_utilZmenur CANCELr PluginError)r r/ rV Z path_flagcodeindexr! r! r" rW s
z'Authenticator._prompt_with_webroot_listF)r/
allowraiser c C s> t jtd|dd\}}|tjkr6|s,d S tdt|S )NzInput the webroot for {0}:T)rZ r[ )r Zvalidated_directory_validate_webrootr r] r^ r r_ )r r/ rb r` rY r! r! r" rX s
z%Authenticator._prompt_for_new_webrootc
C s | d}|std| D ]\}}tj|tjtj j
| j |< t
d| j | td tt| j | d d tdD ]}tj|rqzvt|d | j| ztj||dddd W n@ ttfy } z"t d
t
d | W Y d }~n
d }~0 0 W q tyH } z td ||W Y d }~qd }~0 0 qW d n1 sb0 Y tj s tj| j | d
}tj |rt d| j | q t d| j | t |ddd}|!t" W d q 1 s0 Y q d S )Nr( zMissing parts of webroot configuration; please set either --webroot-path and --domains, or --webroot-map. Run with --help webroot for examples.z-Creating root challenges validation dir at %s rK )keyi T)Z copy_userZ
copy_groupz3Unable to change owner and uid of webroot directory
Error was: %sz=Couldn't create root for {0} http-01 challenge responses: {1}
web.configzPA web.config file has not been created in %s because another one already exists.zGCreating a web.config file in %s to allow IIS to serve challenge files.w modechmod)#r r r_ itemsr r joinnormcaser
r1 Z
URI_ROOT_PATHr8 rL debugr
temp_umasksortedr Z get_prefixeslenisdirmkdirr= appendZ copy_ownership_and_apply_modeOSErrorAttributeErrorZwarningr
POSIX_MODEexistsrM r write_WEB_CONFIG_CONTENT)r Zpath_mapnamer prefix exceptionweb_config_pathZ
web_configr! r! r" rI sX
$
&<z$Authenticator._create_challenge_dirs) root_pathrE r c C s t j||jdS )Ntoken)r r rn Zchallencode)r r rE r! r! r" _get_validation_path s z"Authenticator._get_validation_path)rE r c C s | \}}| j|j }| ||}td| tdL t|ddd }| |
W d n1 sn0 Y W d n1 s0 Y | j | | |S )Nz#Attempting to save validation to %srd wbri rj )
Zresponse_and_validationr8 r/ r rL rp r rq r r{ r r< r$ )r rE ZresponseZ
validationr validation_pathZvalidation_filer! r! r" rC s Jz Authenticator._perform_singlec
C s0 |D ]}| j |jd }|d ur| ||}td| t| | j| | t j
stj |d}tj
|rt|}|tv rtd| t| qtd| qg }| jr | j }zt| W q ty } z0|d| td| td| W Y d } ~ qd } ~ 0 0 q|| _td d S ) Nz Removing %srg z4Cleaning web.config file generated by Certbot in %s.zQNot cleaning up the web.config file in %s because it is not generated by Certbot.r z3Challenge directory %s was not empty, didn't removerf zAll challenges cleaned up)r8 getr/ r rL rp r rR r< r ry r rn rz r sha256sum_WEB_CONFIG_SHA256SUMSrM r= poprmdirrw rT )
r rB rE r r r r Z not_removedr excr! r! r" cleanup s<
$zAuthenticator.cleanup)F)#__name__
__module__ __qualname____doc__ descriptionr strr# classmethodr r, r r r. r r r
Z Challenger2 r r7 rA ZChallengeResponserJ rH r rQ rW boolrX rI r rC r
__classcell__r! r! r? r" r 8 s*
7r c @ s> e Zd ZdZdejejeee e
df e e ddddZ dS )r* z%Action class for parsing webroot_map.N)parser namespace webroot_map
option_stringr c sV |d u r d S t t| D ]2\} t |j fddt||D q d S )Nc 3 s | ]}| fV qd S r0 r! )rD drU r! r" , s z-_WebrootMapAction.__call__..) jsonloadsr rm rc r updater Z add_domains)r r r r r domainsr! r r" __call__% s
z_WebrootMapAction.__call__)N)
r r r r argparseArgumentParser Namespacer r r r r r r! r! r! r" r* " s
r* c sX e Zd ZdZeedd fdd Zd ejeje e
e e df e e
ddddZ
ZS )
r) z&Action class for parsing webroot_path.Nr3 c s t j|i | d| _d S )NF)r6 r7 _domain_before_webrootr> r? r! r" r7 3 s z_WebrootPathAction.__init__)r r rU r r c C sl |d u r d S | j r td|jrH|jd }|jD ]}|j|| q2n |jrTd| _ |jtt | d S )NzPIf you specify multiple webroot paths, one of them must precede all domain flagsrK T)
r r r_ rU r r rN rv rc r )r r r rU r Z prev_webrootr/ r! r! r" r 7 s
z_WebrootPathAction.__call__)N)r r r r r r7 r r r r r r r r r r! r! r? r" r) 0 s
r) )rU r c C s& t j| st| d t j| S )zValidates and returns the absolute path of webroot_path.
:param str webroot_path: path to the webroot directory
:returns: absolute path of webroot_path
:rtype: str
z% does not exist or is not a directory)r r rt r r_ abspathr r! r! r" rc M s rc )2r r r9 r Zloggingtypingr r r r r r r r r
r r Zacmer
Zcertbotr r r Zcertbot._internalr Zcertbot.achallengesr Zcertbot.compatr r Zcertbot.displayr r r] Zcertbot.pluginsr Z certbot.utilr Z getLoggerr rL r| r ZPluginr Actionr* r) r rc r! r! r! r" sL
k