a
}|g4 @ s2 d Z ddlZddlZddlZddlmZ ddlmZ ddlmZ ddlmZ ddlm Z ddlm
Z
dd lm Z dd
lm Z dd l
mZ dd lmZ dd
lmZ ddlmZ ddlZddlmZ ddlmZ ddlmZ ddlmZ ddlm Z ddlm Z ddlm Z! ddlm"Z" ddl#Z#ddl#m$Z$ ddl#m Z ddl#m Z ddl#m%Z% ddl#m&Z& ddl'm(Z( ddl'm)Z) dd l'm*Z* dd l'm+Z+ dd l'm,Z, dd l'm-Z- dd l'm.Z. dd!l/m0Z1 dd"l/m2Z3 dd#l4m5Z5 dd$l6m7Z8 ddl6m&Z9 dd%l:m;Z; edGe$j?ej@e e"jA e jBd&d'd(ZCe$j?eDd)d*d+ZEe$j?eDd)d,d-ZFG d.d/ d/ZGeDd0d1d2ZHdHe$j?e;e eeDgdf e e(jIe jBf d3d4d5ZJe jBe$j?e eeDgdf e"jAd6d7d8ZKG d9d: d:ZLdIe&jMe e&jN dd;dd?d@ZRe$j?eDeDe e eDf dAdBdCZSeTe ddDdEdFZUdS )JzCertbot client API. N)Any)Callable)cast)Dict)IO)List)Optional)Tuple)x509)default_backend)
serialization)generate_private_key)ES256)ES384)ES512)RS256)client) crypto_util)errors)messages)
configuration)
interfaces)util)account) auth_handler)cli) constants)eff)
error_handler)storage)disco) selection)os)ops)AccountStorage)configkeyregrreturnc C s |j dkrL|j}|jdkr t}qP|jdkr0t}qP|jdkr@t}qPtdnt}t j
|||| j t | d}t j
| j|}t
||S )z Wrangle ACME client constructionZEC i i z6No matching signing algorithm can be found for the key)algr Z
verify_ssl
user_agent)typr& key_sizer r r r ZNotSupportedErrorr acme_clientZ
ClientNetworkZ
no_verify_ssldetermine_user_agentClientV2Z
get_directoryserver)r% r& r'
public_keyr* net directory r5 { z ua_flags..hook )
isinstance DummyConfigZ duplicateappendZrenew_by_defaultallow_subset_of_namesnoninteractive_modeanyjoin)r% flagsZ
hook_namesZhooksr5 rL r6 rE m s
rE c @ s. e Zd ZdZddddZeedddZdS ) rR z'Shim for computing a sample user agent.Nr( c C s d| _ d| _d | _d| _d S )NZXXXZYYYZ
SUBCOMMAND)rB rC r+ rD )selfr5 r5 r6 __init__ s zDummyConfig.__init__namer( c C s dS )z-Any config properties we might have are None.Nr5 rZ r] r5 r5 r6 __getattr__ s zDummyConfig.__getattr__)__name__
__module__ __qualname____doc__r[ strr r_ r5 r5 r5 r6 rR s rR rY c C s t ttjt S )zd}t| t|| j sNt
d | j rZd| _t d| j t
d}tjt|d}t| |}t|| |}t||}||| t| | ||fS )a Register new account with an ACME CA.
This function takes care of generating fresh private key,
registering the account, optionally accepting CA Terms of Service
and finally saving the account. It should be called prior to
initialization of `Client`, unless account has already been created.
:param certbot.configuration.NamespaceConfig config: Client configuration.
:param .AccountStorage account_storage: Account storage where newly
registered account will be saved to. Save happens only after TOS
acceptance step, so any account private keys or
`.RegistrationResource` will not be persisted if `tos_cb`
returns ``False``.
:param tos_cb: If ACME CA requires the user to accept a Terms of
Service before registering account, client action is
necessary. For example, a CLI tool would prompt the user
acceptance. `tos_cb` must be a callable that should accept
a Term of Service URL as a string, and raise an exception
if the TOS is not accepted by the client. ``tos_cb`` will be
called only if the client action is necessary, i.e. when
``terms_of_service is not None``. This argument is optional,
if not supplied it will default to automatic acceptance!
:raises certbot.errors.Error: In case of any client problems, in
particular registration failure, or unaccepted Terms of Service.
:raises acme.errors.Error: In case of any protocol problems.
:returns: Newly registered and saved account, as well as protocol
API handle (should be used in `Client` initialization).
:rtype: `tuple` of `.Account` and `acme.client.Client`
z*There are already existing accounts for %sNzLNo email was provided and --register-unsafely-without-email was not present.zRegistering without email!i )Zpublic_exponentr- Zbackend)r& )Zfind_allloggerinfor1 emailZ register_unsafely_without_emailerrorr Errordry_rundebugr
rsa_key_sizer joseZJWKRSAZComparableRSAKeyr7 perform_registrationr Accountsaver Zprepare_subscription) r% rg rh msgZrsa_keyr& acmer' Zaccr5 r5 r6 register s. &
rw )rv r% rh r( c
C s
|j o
|j}|r8| jj }tjj||j |j| jd}nd}| rV|sVd}t
|| jj j
}|rp|rp|| z | tjj|jd|dW S tj y } z\|jdv r|jrd|j d}t
|tjdd |_t| ||W Y d}~S W Y d}~n
d}~0 0 dS )
a
Actually register new account, trying repeatedly if there are email
problems
:param acme.client.Client acme: ACME client object.
:param certbot.configuration.NamespaceConfig config: Client configuration.
:param Callable tos_cb: a callback to handle Term of Service agreement.
:returns: Registration Resource.
:rtype: `acme.messages.RegistrationResource`
)account_public_keyZkidZhmac_keyr4 NzRServer requires external account binding. Please use --eab-kid and --eab-hmac-key.T)rk Zterms_of_service_agreedZexternal_account_binding)Z invalidEmailZinvalidContactzThe ACME server believes z_ is an invalid email address. Please ensure it is a valid email and attempt registration again.)Zinvalid)Zeab_kidZ eab_hmac_keyr3 r& r2 r ZExternalAccountBindingZ from_datar4 Zexternal_account_requiredr rm metaZterms_of_serviceZ new_accountZNewRegistrationrk coderU display_opsZ get_emailrr ) rv r% rh Zeab_credentials_suppliedrx Zeabru Ztoser5 r5 r6 rr s8
rr c @ s e Zd ZdZd/ejeej ee j
ee j ee j
ddddZd0ejeej eeef dddZd1ee ee eeeejejf d d
d Zeeejd d
dZee ee ee j dddZ ej ee ee dddZ ee ee eeeejejf dddZ!ee ee edddZ"eeddd Z#eeeeeeeeef d d d Z$ee eeeedd d!d"Z%d2ee eedd$d%d&Z&d3ee eee dd'd(d)Z'ee dd*d+d,Z(edd*d-d.Z)dS )4Clientaw Certbot's client.
:ivar certbot.configuration.NamespaceConfig config: Client configuration.
:ivar .Account account: Account registered with `register`.
:ivar .AuthHandler auth_handler: Authorizations handler that will
dispatch DV challenges to appropriate authenticators
(providing `.Authenticator` interface).
:ivar .Authenticator auth: Prepared (`.Authenticator.prepare`)
authenticator that can solve ACME challenges.
:ivar .Installer installer: Installer.
:ivar acme.client.ClientV2 acme: Optional ACME client API handle. You might
already have one from `register`.
N)r% account_authrC rv r( c C sv || _ || _|| _|| _|du r>| jdur>t|| jj| jj}|| _| |durlt || j| j| j j
| _nd| _dS )zInitialize a client.N) r% r r rC r7 r& r' rv r Z AuthHandlerZ pref_challs)rZ r% r~ r rC rv r5 r5 r6 r[ s zClient.__init__)csrorderrr( c C s | j du r"d}t| t|| jdu s8| jjdu rBtd| jdu rVtdtd| |du rz| j |j
dd}t j t j
| jjd }td | | jj||| jjdud
}|j}| jjr|jrt|g|j | jj| jj }t|\}}| | fS ) aW Obtain certificate.
:param .util.CSR csr: PEM-encoded Certificate Signing
Request. The key used to generate this CSR can be different
than `authkey`.
:param acme.messages.OrderResource orderr: contains authzrs
:returns: certificate and chain as PEM byte strings
:rtype: tuple
Nz>Unable to obtain certificate because authenticator is not set.z+Please register with the ACME server first.ACME client is not set.zCSR: %sF) best_effort)Zsecondsz+Will poll for certificate issuance until %s)Zfetch_alternative_chains)r ri rl r rm r r' rv ro _get_order_and_authorizationsdatadatetimeZnowZ timedeltar% Zissuance_timeoutZfinalize_orderZpreferred_chainZ
fullchain_pemZalternative_fullchains_pemr Zfind_chain_with_issuerrn Z cert_and_chain_from_fullchainencode)rZ r r ru ZdeadlineZ fullchaincertchainr5 r5 r6 obtain_certificate_from_csr4 s4
z"Client.obtain_certificate_from_csr)domains old_keypathr( c
s |durZt |d }|}| }W d n1 s40 Y tj||d}td| nd}| jj}d}t| jj t
r| jj d | j_ | jj r| jj dkr| jj }d| j_ d | j_
d
| j_n | jjr| jj d kr| jj}| jjr.|p
tjdtj||| jj d d}tjdd
t|j|| jjd} n<|pNtj|d| jj || jjd}t||d| jj| jj} z| | j | jj }
W np t j y } zT| jj r| | |} | |krt!| dkr| "|| W Y d} ~ S W Y d} ~ n
d} ~ 0 0 |
j#}
dd |
D fdd|D } | jj r8| |kr8| "|| S z | $| |
\}}|||| fW S t j y } zT| jj r| | |} | |krt!| dkr| "|| W Y d} ~ S W Y d} ~ n
d} ~ 0 0 dS )a Obtains a certificate from the ACME server.
`.register` must be called before `.obtain_certificate`
:param list domains: domains to get a certificate
:returns: certificate as PEM string, chain as PEM string,
newly generated private key (`.util.Key`), and DER-encoded
Certificate Signing Request (`.util.CSR`).
:rtype: tuple
Nrb)filepemz%Reusing existing private key from %s.Z secp256r1r Zecdsaz./chain-ecdsa.pemz./cert-ecdsa.pemz./key-ecdsa.pemZrsa)bitselliptic_curvekey_typer )r formr )r- Zkey_dirr r strict_permissionsc S s h | ]}|j jjqS r5 )body
identifiervalue)rJ ar5 r5 r6 rN z,Client.obtain_certificate..c s g | ]}| v r|qS r5 r5 rJ dZ auth_domainsr5 r6 rM rN z-Client.obtain_certificate..)%openreadr Keyri rj r% rp rQ r listr Zauth_chain_pathZauth_cert_pathkey_pathlowerrn r Zmake_keyCSRacme_crypto_utilZmake_csrr Z must_stapleZ generate_keyr Z generate_csrr r rT r rm _successful_domains_from_errorlen_retry_obtain_certificateauthorizationsr )rZ r r fZkeypathZkeypemr& r- r r r rl successful_domainsauthzrr r r5 r r6 obtain_certificatea s &
zClient.obtain_certificate)csr_pemr r( c C s | j stdz| j |}W n tjy> tdY n0 | jsPtd|r| jjr| j |\}}|rt
d | j |}|rt
d | j
|| j|}|j|dS )ab Request a new order and complete its authorizations.
:param bytes csr_pem: A CSR in PEM format.
:param bool best_effort: True if failing to complete all
authorizations should not raise an exception
:returns: order resource containing its completed authorizations
:rtype: acme.messages.OrderResource
r zWThe currently selected ACME CA endpoint does not support issuing wildcard certificates.z&No authorization handler has been set.z*Recreating order after authz deactivationszCertbot was unable to obtain fresh authorizations for every domain. The dry run will continue, but results may not be accurate.)r )rv r rm Z new_order acme_errorsZWildcardUnsupportedErrorr r% rn Z deactivate_valid_authorizationsri ro ZwarningZhandle_authorizationsupdate)rZ r r r Z deactivatedZfailedr r5 r5 r6 r s"
z$Client._get_order_and_authorizations)r certnamer( c C s| | ||}| |\}}}}| jjtjd ksB| jjtjd krLtd | jj rdt
d| dS t j
|||j|| jS )aF Obtain and enroll certificate.
Get a new certificate for the specified domains using the specified
authenticator and installer, and then create a new renewable lineage
containing it.
:param domains: domains to request a certificate for
:type domains: `list` of `str`
:param certname: requested name of lineage
:type certname: `str` or `None`
:returns: A new :class:`certbot._internal.storage.RenewableCert` instance
referred to the enrolled cert lineage, or None if doing a successful dry run.
config_dirwork_dirzdNon-standard path(s), might not work with crontab installed by your operating system package managerz-Dry run: Skipping creating new lineage for %sN)_choose_lineagenamer r% r r Z CLI_DEFAULTSr ri rj rn ro r
RenewableCertZ new_lineager )rZ r r new_namer r r& _r5 r5 r6 obtain_and_enroll_certificate s z$Client.obtain_and_enroll_certificate)rl r r( c s4 |j d ur0dd |j D fdd|D }|S g S )Nc S s g | ]}|j d ur|j jqS )N)r r )rJ Zproblemr5 r5 r6 rM s
z9Client._successful_domains_from_error..c s g | ]}| vr|qS r5 r5 )rJ xfailed_domainsr5 r6 rM rN )Z subproblems)rZ rl r r r5 r r6 r s
z%Client._successful_domains_from_error)r r r( c s6 fdd|D }d |}td| | S )Nc s g | ]}| vr|qS r5 r5 r r r5 r6 rM ! rN z4Client._retry_obtain_certificate..z, zNUnable to obtain a certificate with every requested domain. Retrying without: )rW display_utilnotifyr )rZ r r r Z domains_listr5 r r6 r s
z Client._retry_obtain_certificatec C sZ d}|r|}n(t |d r.|d dd }n|d }| |rD|S t|rPdnddS )au Chooses a name for the new lineage.
:param domains: domains in certificate request
:type domains: `list` of `str`
:param certname: requested name of lineage
:type certname: `str` or `None`
:returns: lineage name that should be used
:rtype: str
:raises errors.Error: If the chosen lineage name is invalid.
Nr zzThe provided certname cannot be used as a lineage name because it contains an illegal character (i.e. filepath separator).zCannot use domain name as lineage name because it contains an illegal character (i.e. filepath separator). Specify an explicit lineage name with --cert-name.)r Zis_wildcard_domain_is_valid_lineagenamer rm )rZ r r Z lineagenamer5 r5 r6 r ' s
zClient._choose_lineagenamer\ c C s t jj|vS )aN Determines whether the provided name is a valid lineagename. A lineagename
is invalid when it contains filepath separators.
:param name: the lineage name to determine validity for
:type name: `str`
:returns: Whether the provided string constitutes a valid lineage name.
:rtype: bool
)r" pathsepr^ r5 r5 r6 r I s z Client._is_valid_lineagename)cert_pem chain_pem cert_path
chain_pathfullchain_pathr( c
C s |||fD ] }t tj|d| jj q
t| jd|\}}z|| W | n
| 0 t| jd|\} }
t| jd|\} } t
|| t
|| | ||
| fS )a$ Saves the certificate received from the ACME server.
:param bytes cert_pem:
:param bytes chain_pem:
:param str cert_path: Candidate path to a certificate.
:param str chain_path: Candidate path to a certificate chain.
:param str fullchain_path: Candidate path to a full cert chain.
:returns: cert_path, chain_path, and fullchain_path as absolute
paths to the actual files
:rtype: `tuple` of `str`
:raises IOError: If unable to find room to write the cert files
i r r r ) r Zmake_or_verify_dirr" r dirnamer% r _open_pem_filewriteclose _save_chain)
rZ r r r r r r Z cert_fileZ
abs_cert_path
chain_fileZabs_chain_pathZfullchain_fileZabs_fullchain_pathr5 r5 r6 save_certificateV s
zClient.save_certificate)r privkey_pathr r r r( c C s | j du r td td|du r*dn
tj|}t d d}t
| j |V |D ]4}| j j
|tj|tj|||d | j qX| j d W d n1 s0 Y d}t
| j| | j W d n1 s0 Y dS ) ab Install certificate
:param list domains: list of domains to install the certificate
:param str privkey_path: path to certificate private key
:param str cert_path: certificate file path (optional)
:param str fullchain_path: path to the full chain of the certificate
:param str chain_path: chain file path
NzANo installer specified, client is unable to deploythe certificateNo installer availablezDeploying certificatez Could not install certificate)domainr r r r zDeployed ACME CertificatezuWe were unable to install your certificate, however, we successfully restored your server to its prior configuration.)rC ri rl r rm r" r abspathr r r ErrorHandler_recovery_routine_with_msgZ deploy_certrt _rollback_and_restartrestart)rZ r r r r r ru domr5 r5 r6 deploy_certificate{ s&
*zClient.deploy_certificateT)r r redirect_defaultr( c C s | j du r td tdd}dddd|fd f}| j }|D ]Z\}}} t| j|}
||v r|d
krt|
du rt|}
|
r| ||| d }qB|
rBtd | qBd
} |rt
| j | | j W d n1 s0 Y dS )af Enhance the configuration.
:param list domains: list of domains to configure
:param chain_path: chain file path
:type chain_path: `str` or `None`
:param redirect_default: boolean value that the "redirect" flag should default to
:raises .errors.Error: if no installer is specified in the
client.
NzDNo installer is specified, there isn't any configuration to enhance.r F)Zhstsensure-http-headerzStrict-Transport-Security)redirectr NZstaplez staple-ocsp)Zuirr zUpgrade-Insecure-Requestsr TzKOption %s is not supported by the selected installer. Skipping enhancement.z$We were unable to restart web server)
rC ri rl r rm Zsupported_enhancementsrI r% apply_enhancementr r r r ) rZ r r r ZenhancedZenhancement_infoZ supportedZ config_nameZenhancement_nameoptionZ config_valueru r5 r5 r6 enhance_config s6
zClient.enhance_config)r enhancementoptionsr( c
C s | j std|dkr |n|}t| jd |D ]\}z| j ||| W q4 tjyl t d| Y q4 tj
y t d|| Y q40 q4| j d| W d n1 s0 Y dS )a Applies an enhancement on all domains.
:param list domains: list of ssl_vhosts (as strings)
:param str enhancement: name of enhancement, e.g. ensure-http-header
:param str options: options to enhancement, e.g. Strict-Transport-Security
.. note:: When more `options` are needed, make options a list.
:raises .errors.PluginError: If Enhancement is not supported, or if
there is any other problem with the enhancement.
z!No installer plugin has been set.r Nz Enhancement %s was already set.z(Unable to set the %s enhancement for %s.zAdd enhancement )
rC r rm r r r ZenhanceZ PluginEnhancementAlreadyPresentri rj Z PluginErrorrl rt )rZ r r r Z enh_labelr r5 r5 r6 r s
zClient.apply_enhancement) success_msgr( c C s" | j r | j |r t| dS )zCalls the installer's recovery routine and prints success_msg
:param str success_msg: message to show on successful recovery
N)rC Zrecovery_routiner r rZ r r5 r5 r6 r s
z!Client._recovery_routine_with_msgc C sP | j rLtd z| j | j W n td Y n0 t| dS )zRollback the most recent checkpoint and restart the webserver
:param str success_msg: message to show on successful rollback
z0Rolling back to previous server configuration...zAn error occurred and we failed to restore your config and restart your server. Please post to https://community.letsencrypt.org/c/help with details about your configuration and this error you received.N)rC ri rj rollback_checkpointsr rl r r r r5 r5 r6 r s
z Client._rollback_and_restart)N)N)N)T)N)*r` ra rb rc r re r r rs r Z
AuthenticatorZ Installerr. r0 r[ r r r Z
OrderResourcer bytesr r rd r r boolr r r r rm r r r r r r r r r r r5 r5 r5 r6 r} s\
- o $ "
"
%
(
-
r} )privkeyr r( c C s | j r t| j s td|r|jdkrTt|j}| t
j j }t
|j|d}|jrpt|jsptd|jr| j rt|j| j stddS )a Validate Key and CSR files.
Verifies that the client key and csr arguments are valid and correspond to
one another. This does not currently check the names in the CSR due to
the inability to read SANs from CSRs in python crypto libraries.
If csr is left as None, only the key will be validated.
:param privkey: Key associated with CSR
:type privkey: :class:`certbot.util.Key`
:param .util.CSR csr: CSR
:raises .errors.Error: when validation fails
z#The provided key is not a valid keyZderr z#The provided CSR is not a valid CSRz The key and CSR do not matchN)r r Z
valid_privkeyr rm r r
Zload_der_x509_csrr Z public_bytesr ZEncodingZPEMr r r Z valid_csrZcsr_matches_pubkey)r r Zcsr_objr r5 r5 r6 validate_key_csr
s
r )default_installer checkpointsr% pluginsr( c C s0 t j|| |dd}|dur,|| | dS )a Revert configuration the specified number of checkpoints.
:param str default_installer: Default installer name to use for the rollback
:param int checkpoints: Number of checkpoints to revert.
:param config: Configuration.
:type config: :class:`certbot.configuration.NamespaceConfiguration`
:param plugins: Plugins available
:type plugins: :class:`certbot._internal.plugins.disco.PluginsRegistry`
z,Which installer should be used for rollback?)ZquestionN)plugin_selectionZpick_installerr r )r r r% r rC r5 r5 r6 rollback8 s
r )r% cli_arg_pathpem_pathr( c C sL | |r&tj|dddtj|fS t|dd}|d tj|d fS )a' Open a pem file.
If cli_arg_path was set by the client, open that.
Otherwise, uniquify the file path.
:param str cli_arg_path: the cli arg name, e.g. cert_path
:param str pem_path: the pem file path to open
:returns: a tuple of file object and its absolute file path
i wb)chmodmoder )Z set_by_userr Z safe_openr" r r Z unique_file)r% r r Zuniqr5 r5 r6 r Q s
r )r r r( c C s& z| | W | n
| 0 dS )zSaves chain_pem at a unique path based on chain_path.
:param bytes chain_pem: certificate chain in PEM format
:param str chain_file: chain file object
N)r r )r r r5 r5 r6 r e s r )N)N)N)Vrc r Zloggingr> typingr r r r r r r r Z cryptographyr
Z cryptography.hazmat.backendsr Z cryptography.hazmat.primitivesr Z-cryptography.hazmat.primitives.asymmetric.rsar
Zjosepyrq r r r r rv r r. r r r r r r9 r r r Zcertbot._internalr r r r r r r Zcertbot._internal.pluginsr Z plugin_discor! r Zcertbot.compatr" Zcertbot.displayr# r{ r Zcertbot.interfacesr$ Z getLoggerr` ri re ZJWKZRegistrationResourcer0 r7 rd r/ rE rR rf rs rw rr r} r r r intZPluginsRegistryr r r r r5 r5 r5 r6 s
G 2 +