3
گaO @ s d Z ddlZddlZddlZddlmZ ddlmZ ddlmZ ddlmZ ddlm Z ddlm
Z
ddl Z dd l m
Z
dd
lmZ dd lmZ dd lmZ dd
lmZ ddlmZ ddlmZ dd lmZ ddlmZ ddlmZ ddlmZ ddl m Z ddl m Z! ej"e#Z$G dd dZ%ej&e j'e(ej)dddZ*eej& ee
ej+ e ee, df ee, dd d Z-eej& ee
ej+ e ee, df ee, dd d Z.eej& ee
ej+ ee, d d!d"Z/eej& ej0d#d$d%Z1eej) e(d&d'd(Z2dS ))zACME AuthHandler. N)Dict)Iterable)List)Optional)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
jejeee
e
j dd d
Ze
jee
e
f d d d
Ze
e
j eeddddZee
j e
ej dddZe e
e e j dddZ e
ej ddddZ e
je
e e
ej ddd Z!e
e
j dd 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.BackwardsCompatibleClientV2 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 "/usr/lib/python3.6/auth_handler.py__init__/ s zAuthHandler.__init__F )orderrconfig best_effort max_retriesr c C s> |j dd }|s tjd| js,tjd| j|}|s>|S tj| j| y$| j j
|}|j rpt j
ddd W n< tjk
r } z tjd tjd |W Y dd}~X nX t|t|kstd x&t||D ]\} }
| jj| j|
qW tjd
| j||| d d |D } | s&tjd
| S Q R X tjddS )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
: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.z\Challenges loaded. Press continue to submit to CA. Pass "-v" for more info about challenges.T)pausez!Failure in setting up challenges.z0Attempting to clean up outstanding challenges...z(Some challenges have not been performed.zWaiting for verification...c S s g | ]}|j jtjkr|qS r )bodystatusr STATUS_VALID).0authzrr r r
l 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 notificationloggercriticalinfolenAssertionErrorzipZanswer_challengechallb_poll_authorizations) r r r! r" r# authzrsachallsZrespserrorachallrespZauthzrs_validatedr r r handle_authorizations7 s:
z!AuthHandler.handle_authorizations)r r c C s | j stjddd |jD }g }g }xf|D ]^}y| j j|}|j| W q. tjk
r } z |j| tjd|j | W Y dd}~X q.X q.W ||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) r r r r* s z?AuthHandler.deactivate_valid_authorizations..z)Failed to deactivate authorization %s: %sN)
r r r- r+ Zdeactivate_authorizationappend acme_errorsr1 debugZuri)r r Z
to_deactivateZ deactivatedZfailedr) er r r deactivate_valid_authorizationsu s
&z+AuthHandler.deactivate_valid_authorizations)r9 r# r" r c
s: j stjddd t|D }g }d}xt|D ]}|dkrJtj| fdd|j D }x |j D ]\}\} }| ||< qjW dd |j D }
x |
D ]} t j
d | j j j
qW |j|
d
d |j D }|sP t fd d |j D } | tjj j }q4W |r& j| |s&tjd
|r6tjddS )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 after a maximum of retries.
z3No ACME client defined, cannot poll authorizations.c S s i | ]\}}|d f|qS )Nr )r( indexr) r r r
s z4AuthHandler._poll_authorizations.. r c s" i | ]\}\}} j j||qS r )r Zpoll)r( rD r) _)r r r rE s c S s" g | ]\}}|j jtjkr|qS r )r% r& r ZSTATUS_INVALID)r( r) rG r r r r* s z4AuthHandler._poll_authorizations..z Challenge failed for domain %sc S s, i | ]$\}\}}|j jtjkr||f|qS r )r% r& r ZSTATUS_PENDING)r( rD r) r= r r r rE s
c 3 s( | ] \}}|d k r j j|dV qd S )N )r retry_after)r( rG r= )r r r s z3AuthHandler._poll_authorizations..z Some challenges have failed.z0All authorizations were not finalized by the CA.N)r r r- enumeraterangetimeZsleepitemsvaluesr1 r3 r%
identifiervalueextendmaxdatetimeZnowZ
total_seconds_report_failed_authzrsr, )
r r9 r# r" Zauthzrs_to_checkZauthzrs_failed_to_reportZ
sleep_secondsrG rD r) Zauthzrs_failedZ
authzr_failedrI r )r r r8 s>
z AuthHandler._poll_authorizations)r9 r c C s | j stjddd |D }g }|r0tjd xn|D ]f}|jj}| j jdkrX|jj}nt dd t
t |D }t || j
|jjj|}|j| j|| q6W |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) r r r r* s z2AuthHandler._choose_challenges..z$Performing the following challenges:rF c s s | ] }|fV qd S )Nr )r( ir r r rJ s z1AuthHandler._choose_challenges..)r r r- r1 r3 r% r Z acme_version combinationstuplerL r4 gen_challenge_path_get_chall_prefrP rQ rR _challenge_factory)r r9 Zpending_authzrsr: r) Zauthzr_challengesrW pathr r r r. s"
z AuthHandler._choose_challenges)domainr c C sr g }| j j|}| jrdtdd |D }x(| jD ] }||kr0|jtjj| q0W |rZ|S tj d|j
| |S )z{Return list of challenge preferences.
:param str domain: domain for which you are requesting preferences
c s s | ] }|j V qd S )N)typ)r( challr r r rJ s z.AuthHandler._get_chall_pref..zENone of the preferred challenges are supported by the selected plugin) r Zget_chall_prefr setr? r ChallengeZTYPESr r, rR )r r] Z chall_prefsZ plugin_prefZplugin_pref_typesr^ r r r rZ s
zAuthHandler._get_chall_pref)r: r c C s t jd | jj| dS )zCleanup challenges.
:param achalls: annotated challenges to cleanup
:type achalls: `list` of :class:`certbot.achallenges.AnnotatedChallenge`
zCleaning up challengesN)r1 r3 r Zcleanup)r r: r r r r/ s
z AuthHandler._cleanup_challenges)r) r\ r c C sN | j stjdg }x4|D ],}|jj| }|jt|| j j|jjj qW |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
zAccount is not set.)
r r r- r% r r? challb_to_achallkeyrP rQ )r r) r\ r: rD r7 r r r r[ s
z AuthHandler._challenge_factory)failed_authzrsr c s j stjdi } fdd|D }x"|D ]}|j|jjg j| q,W d jj dg}x.t |j
dd dD ]\}}|jt | qrW |rt jt
jr|jd jj| d
tjd j| d S )
z.Notifies the user about failed authorizations.zAccount is not set.c s6 g | ].}|j jD ] }|jrt| jj|j jjqqS r )r% r r; rb r rc rP rQ )r( r) r7 )r r r r* 1 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 < s z4AuthHandler._report_failed_authzrs..)rc z
Hint:
N)r r r-
setdefaultr; r^ r? r namesortedrN _generate_failed_chall_msg
isinstance
plugin_commonZPluginZ auth_hintr0 Znotifyjoin)r rd Zproblemsfailed_achallsr< msgrG r: r )r r rU , s
z"AuthHandler._report_failed_authzrs)Fr )#__name__
__module__ __qualname____doc__r Z
Authenticatorr r
ZClientV2r r strr r Z
OrderResourcer ZNamespaceConfigboolintZAuthorizationResourcer> r rC r8 r r
AnnotatedChallenger. r r ra rZ r/ r[ rU r r r r r s "<
B
r )r7 account_keyr] r c C sb | j }tjd|j| t|tjr2tj| ||dS t|tj rLtj | |dS t
j dj |jdS )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)r7 r] rz )r7 r] z+Received unsupported challenge of type: {0}N)
r_ r1 r3 r^ rm r ZKeyAuthorizationChallenger
Z"KeyAuthorizationAnnotatedChallengeZDNSr r- format)r7 rz r] r_ r r r rb G s rb .)challbs preferencesrW r c C s |rt | ||S t| |S )a Generate a plan to get authority over the identity.
.. todo:: This can be possibly be rewritten to use resolved_combinations.
: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)
:param tuple combinations: A collection of sets of challenges from
:class:`acme.messages.Challenge`, each of which would
be sufficient to prove possession of the identifier.
: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.
)_find_smart_path_find_dumb_path)r| r} rW r r r rY _ s rY c C s i }d}x$t |D ]\}}|||< ||7 }qW d}|}d} xF|D ]>}
x$|
D ] } | |j| | jj|7 } qJW | |k rz|
}| }d} q@W |st| |S )zFind challenge path with server hints.
Can be called if combinations is included. Function uses a simple
ranking system to choose the combo with the lowest cost.
rF Nr )rK getr_ __class___report_no_chall_path) r| r} rW Z
chall_costZmax_costrV Z chall_clsZ
best_comboZbest_combo_costZ combo_totalZcomboZchallenge_indexr r r r~ s&
r~ )r| r} r c sN g }xDt | D ]8\} t fdd|D d}|r>|j| qt| qW |S )zFind challenge path without server hints.
Should be called if the combinations hint is not included by the
server. This function either returns a path containing all
challenges provided by the CA or raises an exception.
c 3 s | ]}t j|rd V qdS )TN)rm r_ )r( Zpref_c)r7 r r rJ s z"_find_dumb_path..F)rK nextr? r )r| r} r\ rV Z supportedr )r7 r r s r )r| r c C s> d}t | dkr*t| d jtjr*|d7 }tj| tj|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.rF r zM You may need to use an authenticator plugin that can do challenges over DNS.) r4 rm r_ r ZDNS01r1 r2 r r, )r| rq r r r r s
r )rp r c C sV | d j }|j}tj|r |j}g }x&| D ] }|jd|j||j jf q*W dj|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
rh ) r; r^ r Z
is_acme_errorcoder? r] Zdetailro )rp r; r^ rq r< r r r rl s
rl )3ru rT ZloggingrM Ztypingr r r r r r ZjosepyZrequests.modelsr r r r
r r@ r Zcertbotr
r r Zcertbot._internalr Zcertbot._internal.accountr Zcertbot.displayr r0 Zcertbot.pluginsr rn Z getLoggerrr r1 r Z
ChallengeBodyZJWKrv ry rb ra rx rY r~ r r, r rl r r r r sP
* %