a
}|gPR @ s d Z ddlZddlZddlZddlmZ ddlmZ ddlmZ ddlmZ ddlm Z ddlm
Z
dd lm Z ddl Z dd
l
mZ dd lmZ dd lmZ dd
lmZ ddlmZ ddlmZ ddlmZ dd
lmZ ddlmZ ddlmZ ddlm Z ddl m Z ddl m!Z" e#e$Z%G dd dZ&ej'e j(e)ej*dddZ+eej' ee ej, e
e-df d d d Z.eej' ej/d d d!Z0eej* e)d"d#d$Z1dS )%zACME AuthHandler. N)Dict)Iterable)List)Optional)Sequence)Tuple)Type)Response)
challenges)client)errors)messages) achallenges)
configuration)
interfaces)
error_handler)Account)util)commonc @ s* e Zd ZdZejeej ee e
e ddddZ d#e
jejeeee
e
j dd d
Ze
jee
e
f d d d
Ze
e
j eeeddddZee
j e
ej dddZ e e
e e j dddZ e
ej ddddZ!e
je"e e
ej ddd Z#e
e
j dd d d Z$e
ej eje d d!d"Z%dS )$ AuthHandlera ACME Authorization Handler for a client.
:ivar auth: Authenticator capable of solving
:class:`~acme.challenges.Challenge` types
:type auth: certbot.interfaces.Authenticator
:ivar acme.client.ClientV2 acme_client: ACME client API.
:ivar account: Client's Account
:type account: :class:`certbot._internal.account.Account`
:ivar list pref_challs: sorted user specified preferred challenges
type strings with the most preferred challenge listed first
N)auth acme_clientaccount pref_challsreturnc C s || _ || _|| _|| _d S N)r acmer r )selfr r r r r B/usr/lib/python3.9/site-packages/certbot/_internal/auth_handler.py__init__0 s zAuthHandler.__init__F )orderrconfig best_effort max_retries
max_time_minsr c
C sL |j dd }|s td| js,td| |}|s>|S t| j| z0| j
|}|j r|t j
d| || dd W n> tjy } z$td td | W Y d} ~ n
d} ~ 0 0 t||D ]\}
} | j|
j| qtd | |||| d
d |D } | std | W d S 1 s40 Y td
dS )a
Retrieve all authorizations, perform all challenges required to validate
these authorizations, then poll and wait for the authorization to be checked.
:param acme.messages.OrderResource orderr: must have authorizations filled in
:param certbot.configuration.NamespaceConfig config: current Certbot configuration
:param bool best_effort: if True, not all authorizations need to be validated (eg. renew)
:param int max_retries: maximum number of retries to poll authorizations
:param float max_time_mins: maximum time (in minutes) to poll authorizations
:returns: list of all validated authorizations
:rtype: List
:raises .AuthorizationError: If unable to retrieve all authorizations
NzNo authorization to handle.z9No ACME client defined, authorizations cannot be handled.z3Challenges loaded. Press continue to submit to CA.
T)pausez!Failure in setting up challenges.z0Attempting to clean up outstanding challenges...zWaiting for verification...c S s g | ]}|j jtjkr|qS r bodystatusr
Z STATUS_VALID.0authzrr r r
o s z5AuthHandler.handle_authorizations..zAll challenges have failed.z?An unexpected error occurred while handling the authorizations.)authorizationsr AuthorizationErrorr Error_choose_challengesr Z ExitHandler_cleanup_challengesr ZperformZdebug_challenges display_utilZ notification_debug_challenges_msgloggercriticalinfozipZanswer_challengechallb_poll_authorizations)
r r" r# r$ r% r& authzrsachallsZrespserrorachallrespZauthzrs_validatedr r r handle_authorizations8 s>
$z!AuthHandler.handle_authorizations)r" r c C s | j stddd |jD }g }g }|D ]`}z| j |}|| W q, tjy } z&|| td|j | W Y d}~q,d}~0 0 q,||fS )a~
Deactivate all `valid` authorizations in the order, so that they cannot be re-used
in subsequent orders.
:param messages.OrderResource orderr: must have authorizations filled in
:returns: tuple of list of successfully deactivated authorizations, and
list of unsuccessfully deactivated authorizations.
:rtype: tuple
z?No ACME client defined, cannot deactivate valid authorizations.c S s g | ]}|j jtjkr|qS r r( r+ r r r r. s z?AuthHandler.deactivate_valid_authorizations..z)Failed to deactivate authorization %s: %sN)
r r r1 r/ Zdeactivate_authorizationappend acme_errorsr6 debuguri)r r" Z
to_deactivateZ deactivatedZfailedr- er r r deactivate_valid_authorizationsx s
(z+AuthHandler.deactivate_valid_authorizations)r< r% deadline_minutesr$ r c s` j stddd t|D }g }tj tj|d }d}t|D ]} |dkr^t | fdd|
D }|
D ]\}
\} } | ||
< q|dd | D } | D ]}
t
d
|
jjj q|| d d |
D }|rtj |kr q,t fd d
| D }t||}|tj }qH|rL | |sLtd|r\tddS )a#
Poll the ACME CA server, to wait for confirmation that authorizations have their challenges
all verified. The poll may occur several times, until all authorizations are checked
(valid or invalid), or a maximum of retries, or the polling deadline is reached.
z3No ACME client defined, cannot poll authorizations.c S s i | ]\}}||d fqS r r )r, indexr- r r r
s z4AuthHandler._poll_authorizations..)Zminutes r c s" i | ]\}\}}| j |qS r )r Zpoll)r, rI r- _r r r rJ c S s" g | ]\}}|j jtjkr|qS r )r) r* r
ZSTATUS_INVALID)r, r- rL r r r r. s z4AuthHandler._poll_authorizations..z Challenge failed for domain %sc S s, i | ]$\}\}}|j jtjkr|||fqS r )r) r* r
ZSTATUS_PENDING)r, rI r- r@ r r r rJ s c 3 s( | ] \}}|d ur j |dV qd S )N )r retry_after)r, rL r@ rM r r s z3AuthHandler._poll_authorizations..z Some challenges have failed.z0All authorizations were not finalized by the CA.N)r r r1 enumeratedatetimeZnowZ timedeltarangetimesleepitemsvaluesr6 r8 r)
identifiervalueextendmaxminZ
total_seconds_report_failed_authzrsr0 )r r< r% rH r$ Zauthzrs_to_checkZauthzrs_failed_to_reportZdeadlineZ
sleep_secondsrL rI r- Zauthzrs_failedZ
authzr_failedrP r rM r r; sN
z AuthHandler._poll_authorizations)r< r c C sn | j stddd |D }g }|r0td |D ]4}|jj}t|| |jj j
}| | || q4|S )z
Retrieve necessary and pending challenges to satisfy server.
NB: Necessary and already validated challenges are not retrieved,
as they can be reused for a certificate issuance.
z5No ACME client defined, cannot choose the challenges.c S s g | ]}|j jtjkr|qS r r( r+ r r r r. s z2AuthHandler._choose_challenges..z$Performing the following challenges:)
r r r1 r6 r8 r) r
gen_challenge_path_get_chall_prefrY rZ r[ _challenge_factory)r r< Zpending_authzrsr= r- Zauthzr_challengespathr r r r2 s
z AuthHandler._choose_challenges)domainr c C sj g }| j |}| jr\dd |D }| jD ] }||v r*|tjj| q*|rR|S td| | |S )z{Return list of challenge preferences.
:param str domain: domain for which you are requesting preferences
c S s h | ]
}|j qS r )typ)r, challr r r rN z.AuthHandler._get_chall_pref..zENone of the preferred challenges are supported by the selected plugin)
r Zget_chall_prefr rB r
ChallengeZTYPESr r0 r[ )r rc Z chall_prefsZ plugin_prefZplugin_pref_typesrd r r r r` s
zAuthHandler._get_chall_pref)r= r c C s t d | j| dS )zCleanup challenges.
:param achalls: annotated challenges to cleanup
:type achalls: `list` of :class:`certbot.achallenges.AnnotatedChallenge`
zCleaning up challengesN)r6 r8 r Zcleanup)r r= r r r r3
s
z AuthHandler._cleanup_challenges)r- rb r c C sJ | j stdg }|D ],}|jj| }|t|| j j|jjj q|S )at Construct Namedtuple Challenges
:param messages.AuthorizationResource authzr: authorization
:param list path: List of indices from `challenges`.
:returns: achalls, list of challenge type
:class:`certbot.achallenges.AnnotatedChallenge`
:rtype: list
:raises .errors.Error: if challenge type is not recognized
Account is not set.)
r r r1 r) r
rB challb_to_achallkeyrY rZ )r r- rb r= rI r: r r r ra s
z AuthHandler._challenge_factory)failed_authzrsr c s j stdi } fdd|D }|D ]}||jjg | q*d jj dg}t |
dd dD ]\}}|t | ql|rt jt
jr|d j| d
td | d S )
z.Notifies the user about failed authorizations.rh c s6 g | ].}|j jD ] }|jrt| jj|j jjqqS r )r) r
r> ri r rj rY rZ )r, r- r: rM r r r. 3 s z6AuthHandler._report_failed_authzrs..z=
Certbot failed to authenticate some domains (authenticator: z5). The Certificate Authority reported these problems:c S s | d S )Nr r )itemr r r > rN z4AuthHandler._report_failed_authzrs..)rj z
Hint:
N)r r r1
setdefaultr> rd rB r namesortedrW _generate_failed_chall_msg
isinstance
plugin_commonZPluginZ auth_hintr4 notifyjoin)r rk Zproblemsfailed_achallsr? msgrL r= r rM r r^ . s
z"AuthHandler._report_failed_authzrs)r= r# r c C s |j dkrg }i }i }|D ]Z}t|jtjrJ||jd ||j|j< t|jtj r||jd ||
|j< q|r| d | D ] \}}| d| d| q|r| d | D ] \} }
| d| d|
qdd
| S dS d S )
aE Construct message for debug challenges prompt
:param list achalls: A list of
:class:`certbot.achallenges.AnnotatedChallenge`.
:param certbot.configuration.NamespaceConfig config: current Certbot configuration
:returns: Message containing challenge debug info
:rtype: str
r rn zZThe following URLs should be accessible from the internet and return the value mentioned:
zURL: z
Expected value: zRThe following FQDNs should return a TXT resource record with the value mentioned:
zFQDN: z)Pass "-v" for more info about challenges.N)Z
verbose_countrt re r
ZHTTP01Z
validation account_keyrE rc DNS01Zvalidation_domain_namerB rW rw ) r r= r# ry Zhttp01_achallsZ
dns01_achallsr? rE Z key_authzZfqdnZkey_authz_hashr r r r5 H s*
z!AuthHandler._debug_challenges_msg)Fr! r! )&__name__
__module__ __qualname____doc__r Z
Authenticatorr r ZClientV2r r strr r
Z
OrderResourcer ZNamespaceConfigboolintfloatZAuthorizationResourcerA r rG r; r r AnnotatedChallenger2 r r
rg r` r3 r ra r^ r5 r r r r r s8
@
G
r )r: rz rc r c C s^ | j }td|j| t|tjr2tj| ||dS t|tj rLtj | |dS tj
| |dS dS )a: Converts a ChallengeBody object to an AnnotatedChallenge.
:param .ChallengeBody challb: ChallengeBody
:param .JWK account_key: Authorized Account Key
:param str domain: Domain of the challb
:returns: Appropriate AnnotatedChallenge
:rtype: :class:`certbot.achallenges.AnnotatedChallenge`
z%s challenge for %s)r: rc rz )r: rc N) re r6 r8 rd rt r
ZKeyAuthorizationChallenger Z"KeyAuthorizationAnnotatedChallengeZDNSZOther)r: rz rc re r r r ri o s ri .)challbs preferencesr c C s i }d}t |D ]\}}|||< ||7 }qd}|}tdd tt| D }d} |D ]:}
|
D ] } | || | jj|7 } q\| |k r|
}| }d} qT|st| |S )a Generate a plan to get authority over the identity.
:param tuple challbs: A tuple of challenges
(:class:`acme.messages.Challenge`) from
:class:`acme.messages.AuthorizationResource` to be
fulfilled by the client in order to prove possession of the
identifier.
:param list preferences: List of challenge preferences for domain
(:class:`acme.challenges.Challenge` subclasses)
:returns: list of indices from ``challenges``.
:rtype: list
:raises certbot.errors.AuthorizationError: If a
path cannot be created that satisfies the CA given the preferences and
combinations.
rK Nc s s | ] }|fV qd S r r )r, ir r r rQ rN z%gen_challenge_path..r )rR tuplerT lengetre __class___report_no_chall_path) r r Z
chall_costZmax_costr Z chall_clsZ
best_comboZbest_combo_cost combinationsZ combo_totalZcomboZchallenge_indexr r r r_ s.
r_ )r r c C s> d}t | dkr*t| d jtjr*|d7 }t| t|S )zLogs and return a raisable error reporting that no satisfiable chall path exists.
:param challbs: challenges from the authorization that can't be satisfied
:returns: An authorization error
:rtype: certbot.errors.AuthorizationError
zyClient with the currently selected authenticator does not support any combination of challenges that will satisfy the CA.rK r zM You may need to use an authenticator plugin that can do challenges over DNS.) r rt re r
r{ r6 r7 r r0 )r ry r r r r s
r )rx r c C sR | d j }|j}t|r |j}g }| D ] }|d|j||j jf q(d|S )a Creates a user friendly error message about failed challenges.
:param list failed_achalls: A list of failed
:class:`certbot.achallenges.AnnotatedChallenge` with the same error
type.
:returns: A formatted error message for the client.
:rtype: str
r z(
Domain: %s
Type: %s
Detail: %s
ro ) r> rd r
Z
is_acme_errorcoderB rc Zdetailrw )rx r> rd ry r? r r r rs s
rs )2r rS ZloggingrU typingr r r r r r r ZjosepyZrequests.modelsr r r
r r rC r
Zcertbotr r r Zcertbot._internalr Zcertbot._internal.accountr Zcertbot.displayr r4 Zcertbot.pluginsr ru Z getLoggerr| r6 r Z
ChallengeBodyZJWKr r ri rg r r_ r0 r rs r r r r sH
Q 5