3
گā @ s d Z ddlZddlZddlZddlmZ ddlmZ ddlmZ ddlmZ ddlm Z ddlm
Z
dd lm Z dd
lm Z dd lm
Z
ddlZdd lmZ dd
lmZ ddlZddlZddlmZ ddlmZ ddlmZ ddlm Z ddl Z ddl m Z ddl mZ ddl mZ ddl m Z ddl m!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/m0Z0 dd l1m2Z3 ddl1m!Z4 dd l5m6Z6 ej7e8Z9dBe j:ej;e e j< ej=d!d"d#Z>e j:e?d$d%d&Z@e j:e?d$d'd(ZAG d)d* d*ZBe?d+d,d-ZCdCe j:e6e ee?gdf e e#jDej=f d.d/d0ZEej=e j:e ee?gdf e jZNeOe dd?d@dAZPdS )EzCertbot client API. N)cast)Any)Callable)Dict)IO)List)Optional)Tuple)Union)default_backend)generate_private_key)client) crypto_util)errors)messages)
configuration)
interfaces)util)account) auth_handler)cli) constants)eff)
error_handler)storage)disco) selection)os)ops)AccountStorage)configkeyregrreturnc C sn t j||| j t| d}tj B tjdt t j||| j }|j
dkrXt j d| j t
t j|S Q R X dS )z Wrangle ACME client construction)r Z
verify_ssl
user_agentignore zCertbot is configured to use an ACMEv1 server (%s). ACMEv1 support is deprecated and will soon be removed. See https://community.letsencrypt.org/t/143839 for more information.N) acme_clientZ
ClientNetworkZ
no_verify_ssldetermine_user_agentwarningscatch_warnings simplefilterDeprecationWarningBackwardsCompatibleClientV2serverZ acme_versionloggerwarningr ClientV2)r r! r" netr
r3 /usr/lib/python3.6/client.pyacme_from_config_key0 s
r5 )r r# c C s | j dkrzd}tjjddkr,d}d}d}ntj}tj }tj }|j
t j ||| j
| j| jt| || jrrd| j nd }n| j }|S )
z
Set a user_agent string in the config based on the choice of plugins.
(this wasn't knowable at construction time)
:returns: the client's User-Agent string
:rtype: `str`
Nz\CertbotACMEClient/{0} ({1}; {2}{8}) Authenticator/{3} Installer/{4} ({5}; flags: {6}) Py/{7}Z CERTBOT_DOCS1certbotzOS_NAME OS_VERSIONzmajor.minor.patchlevelz; )r$ r environgetr cli_commandr Zget_os_info_uaplatformpython_versionformatr7 __version__
authenticator installerverbua_flagsZuser_agent_comment)r Zuar; Zos_infor= r3 r3 r4 r( D s
r( c s t trdS g } jr"|jd jr2|jd jrB|jd jrR|jd d} fd d |D }t|rz|jd
dj|S )z@Turn some very important CLI flags into clues in the user agent.FLAGSdupZfrnZasnnprepostrenew manual_authmanual_cleanupc s g | ]}t |d qS )Z_hook)getattr).0h)r r3 r4
r s z ua_flags..hook )rG rH rI rJ rK )
isinstance DummyConfigZ duplicateappendZrenew_by_defaultallow_subset_of_namesnoninteractive_modeanyjoin)r flagsZ
hook_namesZhooksr3 )r r4 rC d s
rC c @ s. e Zd ZdZddddZeedddZdS ) rS z'Shim for computing a sample user agent.N)r# c C s d| _ d| _d | _d| _d S )NZXXXZYYYZ
SUBCOMMAND)r@ rA r$ rB )selfr3 r3 r4 __init__z s zDummyConfig.__init__)namer# c C s dS )z-Any config properties we might have are None.Nr3 )rZ r\ r3 r3 r4 __getattr__ s zDummyConfig.__getattr__)__name__
__module__ __qualname____doc__r[ strr r] r3 r3 r3 r4 rS x s rS )r# c C s t ttjt S )zd}tj| tj|| j sNtj
d | j rZd| _t d| j t
d}tjtj|d}t| |}t|| |}tj||}|j|| tj| | ||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_exponentkey_sizeZbackend)r! )Zfind_allr/ infor. emailZ register_unsafely_without_emailerrorr Errordry_rundebugr rsa_key_sizer joseZJWKRSAZComparableRSAKeyr5 perform_registrationr Accountsaver Zprepare_subscription) r re rf msgZrsa_keyr! acmer" Zaccr3 r3 r4 register s, &
ru )rt r rf r# c C s |j o
|j}|r8| jjj }tjj||j |j| jd}nd}| j rV|sVd}t
j |yJtj j|j
|d}yttj| j||S tk
r t
j dY nX W nf tj k
r } zF|jd kr|jrd|j
}t
j |tjd d
|_
t| ||S W Y dd}~X nX 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_key directoryNzRServer requires external account binding. Please use --eab-kid and --eab-hmac-key.)ri Zexternal_account_bindingzNThe ACME client must be an instance of acme.client.BackwardsCompatibleClientV2 invalidEmailinvalidContactzzThe ACME server believes %s is an invalid email address. Please ensure it is a valid email and attempt registration again.T)Zinvalid)rx ry )Zeab_kidZ eab_hmac_keyr2 r! Z
public_keyr ZExternalAccountBindingZ from_datarw Zexternal_account_requiredr rk ZNewRegistrationri r r' r- Znew_account_and_tosAttributeErrorcoderV display_opsZ get_emailrp ) rt r rf Zeab_credentials_suppliedrv Zeabrs Znewreger3 r3 r4 rp s:
rp c @ s e Zd ZdZd&ejeej ee j
ee j ee j
ddddZd'ejeej eeef dddZd(ee ee eeeejejf d d
d Zeeejd d
dZee ee ee j dddZ ee ee edddZ eeeeeeeeef dddZ ee eeeeddddZ!d)ee eeddd d Z"d*ee eee#ee ef dd d d Z$ee dd!d"d#Z%edd!d$d%Z&dS )+Clienta 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.BackwardsCompatibleClientV2 acme: Optional ACME
client API handle. You might already have one from `register`.
N)r account_authrA rt r# c C sv || _ || _|| _|| _|dkr>| jdk r>t|| jj| jj}|| _| |dk rltj || j| j| j j
| _nd| _dS )zInitialize a client.N) r r r rA r5 r! r" rt r Z AuthHandlerZ pref_challs)rZ r r r rA rt r3 r3 r4 r[ s zClient.__init__)csrorderrr# c C s | j dkr"d}tj| tj|| jdks8| jjdkrBtjd| jdkrVtjdtjd| |dkrz| j |j
dd}t j j t j
| jjd }tjd | | jj||| jjdk d
}|j}| jjr|jrtj|g|j | jj| jj }tj|\}}|j |j 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.zACME client is not set.zCSR: %sF) best_effort)Zsecondsz+Will poll for certificate issuance until %s)Zfetch_alternative_chains)r r/ rj r rk r r" rt rm _get_order_and_authorizationsdatadatetimeZnowZ timedeltar Zissuance_timeoutZfinalize_orderZpreferred_chainZ
fullchain_pemZalternative_fullchains_pemr Zfind_chain_with_issuerrl Z cert_and_chain_from_fullchainencode)rZ r r rs ZdeadlineZ fullchaincertchainr3 r3 r4 obtain_certificate_from_csr0 s.
z"Client.obtain_certificate_from_csr)domains old_keypathr# c s |dk rFt |d}|}|j }W dQ R X tj||d}tjd| nd}| jj}d}t| jj t
rt| jj d | j_ | jj r| jj dkr| jj }d| j_ d | j_
d
| j_n | jjr| jj j d kr| jj}| jjr|ptjdtj||| jj d d}tjdd
tj|j|| jjd} nD|p s z,Client.obtain_certificate..c s g | ]}| kr|qS r3 r3 )rM d) auth_domainsr3 r4 rO s z-Client.obtain_certificate..)'openreadr Keyr/ rh r rn rR r listr Zauth_chain_pathZauth_cert_pathkey_pathlowerrl r Zmake_keyCSRacme_crypto_utilZmake_csrr Z must_stapleZ generate_keyr r Z generate_csrZcsr_dirr r rU authorizationssetr remover obtain_certificater )rZ r r fZkeypathZkeypemr! rg r r r authzrZsuccessful_domainsr r r3 )r r4 r ] s^
zClient.obtain_certificate)csr_pemr r# c C s | j stjdy| j j|}W n tjk
r@ tjdY nX | jsRtjd|r| jjr| jj |\}}|rt
j d | j j|}|rt
j d | jj
|| 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
zACME client is not set.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 )rt r rk Z new_order acme_errorsZWildcardUnsupportedErrorr r rl Z deactivate_valid_authorizationsr/ rm r0 Zhandle_authorizationsupdate)rZ r r r Z deactivatedZfailedr r3 r3 r4 r s"
z$Client._get_order_and_authorizations)r certnamer# c C s| | j |\}}}}| jjtjd ks6| jjtjd kr@tjd | j||}| jj rdtj
d| dS t j 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)r r r r Z CLI_DEFAULTSr r/ rh _choose_lineagenamerl rm r
RenewableCertZ new_lineager )rZ r r r r r! _new_namer3 r3 r4 obtain_and_enroll_certificate s z$Client.obtain_and_enroll_certificatec C s. |r|S t j|d r&|d dd S |d S )a/ 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
r N)r Zis_wildcard_domain)rZ r r r3 r3 r4 r s
zClient._choose_lineagename)cert_pem chain_pem cert_path
chain_pathfullchain_pathr# c
C s x,|||fD ] }t jtjj|d| jj q W td|\}}z|j| W d|j X td|\} }
td|\} } 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 Nr r ) r Zmake_or_verify_dirr pathdirnamer 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_pathr3 r3 r4 save_certificate s
zClient.save_certificate)r privkey_pathr r r r# c C s | j dkr tjd tjd|dkr*dn
tjj|}tj d d}t
j | j |P x<|D ]4}| j j
|tjj|tjj|||d | j j qZW | j jd W dQ R X d}t
j | j| | j j W dQ R X dS ) a 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 chain_path: chain file path
NzANo installer specified, client is unable to deploythe certificatezNo installer availablezDeploying certificatez Could not install certificate)Zdomainr r r r zDeployed ACME CertificatezuWe were unable to install your certificate, however, we successfully restored your server to its prior configuration.)rA r/ rj r rk r r abspath display_utilnotifyr ErrorHandler_recovery_routine_with_msgZ deploy_certrr _rollback_and_restartrestart)rZ r r r r r rs domr3 r3 r4 deploy_certificate9 s$
zClient.deploy_certificateT)r r redirect_defaultr# c C s | j dkr tjd tjdd}ddd d
|fdf}| j j }xb|D ]Z\}}} t| j|}
||kr|dkrv|
dkrv|}
|
r| j||| d
}qD|
rDtjd| qDW d} |rt j
| j | | j j W dQ R X 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.zNo installer availableFhstsensure-http-headerStrict-Transport-SecurityredirectZstaplez staple-ocspuirUpgrade-Insecure-RequestsTzKOption %s is not supported by the selected installer. Skipping enhancement.z$We were unable to restart web server)r r r )r r N)r r r )
rA r/ rj r rk Zsupported_enhancementsrL r apply_enhancementr r r r ) rZ r r r ZenhancedZenhancement_infoZ supportedZ config_nameZenhancement_nameZoptionZ config_valuers r3 r3 r4 enhance_config_ s2
zClient.enhance_config)r enhancementoptionsr# c C s | j stjd|dkr |n|}tj| jd xh|D ]`}y| j j||| W q6 tjk
rp tj d| Y q6 tj
k
r tj d|| Y q6X q6W | j j d| W dQ R X 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.zensure-http-headerNz Enhancement %s was already set.z(Unable to set the %s enhancement for %s.zAdd enhancement )
rA r rk r r r ZenhanceZ PluginEnhancementAlreadyPresentr/ rh Z PluginErrorrj rr )rZ r r r Z enh_labelr r3 r3 r4 r s
zClient.apply_enhancement) success_msgr# c C s" | j r | j j |r tj| dS )zCalls the installer's recovery routine and prints success_msg
:param str success_msg: message to show on successful recovery
N)rA Zrecovery_routiner r )rZ r r3 r3 r4 r s
z!Client._recovery_routine_with_msgc C sP | j rLtjd y| j j | j j W n tjd Y nX tj| 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)rA r/ rh rollback_checkpointsr rj r r )rZ r r3 r3 r4 r s
z Client._rollback_and_restart)N)N)N)T)N)'r^ r_ r` ra r rc r r rq r Z
AuthenticatorZ Installerr' r1 r[ r r r Z
OrderResourcer bytesr r rb r r boolr r r r r r r r r
r r r r3 r3 r3 r4 r~
s( 4+ ]# ""
&,* r~ )privkeyr r# c C s | j r tj| j r tjd|r|jdkrbtjjtjj |j
}tjj tjj |}t
j|j|d}|j
rtj|j
rtjd|j
r| j rtj|j
| j stjddS )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 rk r OpenSSLZcryptoZload_certificate_requestZ
FILETYPE_ASN1r Zdump_certificate_requestZ FILETYPE_PEMr r r Z valid_csrZcsr_matches_pubkey)r r Zcsr_objZ cert_bufferr3 r3 r4 validate_key_csr s
r )default_installer checkpointsr pluginsr# c C s0 t j|| |dd}|dk r,|j| |j 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 rA r3 r3 r4 rollback s
r ) cli_arg_pathpem_pathr# c C sL t j| r&tj|dddtjj|fS tj|dd}|d tjj|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 r& )r Z
set_by_clir Z safe_openr r r Z unique_file)r r Zuniqr3 r3 r4 r s
r )r r r# c
C s z|j | W d|j X 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 r3 r3 r4 r $ s r )N)N)N)Qra r Zloggingr< Ztypingr r r r r r r r r
r) Z cryptography.hazmat.backendsr Z-cryptography.hazmat.primitives.asymmetric.rsar Zjosepyro r rt r
r' r r r r r r7 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^ r/ rc ZJWKZRegistrationResourcer1 r5 rb r( rC rS rd rq ru rp r~ r r r intZPluginsRegistryr r r r r3 r3 r3 r4 sx
E 6 C .