a
}|gG" @ s| d Z ddlmZ ddlZddlZddlZddlZddlm Z ddlm
Z
ddlm Z ddlm Z ddlm
Z
dd lmZ dd
lmZ dd lmZ dd lmZ ddlZddlZdd
lmZ ddlmZ ddlmZ ddlmZ ddl Z ddl m Z ddl m Z ddl mZ ddl m Z ddl m!Z! ddl"m#Z# ddl"m$Z$ ddl"m%Z% ddl"mZ 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/Z0 ddl.m!Z1 dd!l2m3Z4 dd"l2m5Z6 dd#l7m8Z8 dd$l7m9Z9 dd%l7m:Z: dd&l;m dd'l?m@Z@ d(ZAeBeCZDe jEdd)d*d+ZFdejGe jEee
eH eeH ee,jI ee,jI d,d-d.ZJe jEe,jIeKd/d0d1ZLe jEe eH e,jIeeHee,jI f d2d3d4ZMe jEe,jIeeHee,jI f d5d6d7ZNe jEe
eH eeeH ee,jI f d8d9d:ZOe jEe
eH eHeeKee,jI f d;dd?ZQed@ZRe eR e eR ee
eR e
eR f dAdBdCZSeHe eH eHdDdEdFZTe jEe eH eHe eH ddGdHdIZUde jEee jV eeH ee
eH eHf dJdKdLZWde jEeejX ee,jI eKddNdOdPZYde jEeeH eeH eeH ddQdRdSZZe jEeKd)dTdUZ[e jEeeH eeH eeH ddVdWdXZ\e jEee#j]eej^ f d)dYdZZ_e jEdd)d[d\Z`e jEee ja ee jV ejGd]d^d_Zbe jEe4jceeH d`dadbZde jEe4jceeH d`dcddZee jEe4jceeH d`dedfZfe jEe4jceeH d`dgdhZge jEee,jI eeH d5didjZhde jEejGe
eH ee,jI ddkdldmZie jEe4jceeH dndodpZje jEe jEd)dqdrZke jEdd)dsdtZle jEe4jcddndudvZme jEe4jceeH dndwdxZne jEe4jcddndydzZoe jEe4jcdd`d{d|Zpe jEe4jcdd`d}d~Zqe jEe4jcdd`ddZre jEe4jceeH d`ddZse jEe4jceeH dnddZte jEejGeeeH eeH eeH f dddZue jEe4jce,jIddddZve jEe4jcddnddZwe jEe4jcdd`ddZxe jEdd)ddZyeHejzddddZ{e jEe4jcddnddZ|ee jEe
ee0j}e0j~f ddf d)ddZdee
eH eeeHef dddZdS )zCertbot main entry point. )contextmanagerN)cast) Generator)IO)Iterable)List)Optional)Tuple)TypeVar)Union)b64)client)errors)messages)
configuration) crypto_util)
interfaces)util)account) cert_manager)cli) constants)eff)hooks)log)renewal) snap_config)storage)updater)obj)disco) selection)
filesystem)misc)os)ops) enhancementsz?User chose to cancel the operation and may reinvoke the client.)configreturnc C s4 | j dksJ | js| jr dS tjtjddd dS )zPotentially suggest a donation to support Certbot.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:returns: `None`
:rtype: None
renewNzIf you like Certbot, please consider supporting our work by:
* Donating to ISRG / Let's Encrypt: https://letsencrypt.org/donate
* Donating to EFF: https://eff.org/donate-leFpause)verbZstagingquietr Zatexit_register display_util notificationr' r1 :/usr/lib/python3.9/site-packages/certbot/_internal/main.py _suggest_donation_if_appropriate> s r3 ) le_clientr' domainscertnamelineager( c
C s t | g }z|durVtdj|jr*dndt|p:| d t
||| | nz|du rht dtdj|jrzdndt|d |
||}|d u rt d
|durt || |j || W t || nt || 0 |S ) a, Authenticate and enroll certificate.
This method finds the relevant lineage, figures out what to do with it,
then performs that action. Includes calls to hooks, various reports,
checks, and requests for user input.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param domains: List of domain names to get a certificate. Defaults to `None`
:type domains: `list` of `str`
:param certname: Name of new certificate. Defaults to `None`
:type certname: str
:param lineage: Certificate lineage object. Defaults to `None`
:type lineage: storage.RenewableCert
:returns: the issued certificate or `None` if doing a dry run
:rtype: storage.RenewableCert or None
:raises errors.Error: if certificate could not be obtained
N{action} for {domains}z-Simulating renewal of an existing certificatez Renewing an existing certificateactionr5 z5Domain list cannot be none if the lineage is not set. Simulating a certificate requestRequesting a certificateFz!Certificate could not be obtained)r Zpre_hookr. notifyformatdry_runinternal_display_utilsummarize_domain_listnamesr
renew_certr ErrorZ obtain_and_enroll_certificate deploy_hooklive_dirextendZ post_hook)r4 r' r5 r6 r7 renewed_domainsr1 r1 r2 _get_and_save_certX s<
rI )r' certr( c C s | j }|j }||kr dS | do2| d}|sbtjd| d|j d| ddd ddd
rfd S | drtd |j d
| d| d| | _ dS )a
This function ensures that the user will not implicitly migrate an existing key
from one type to another in the situation where a certificate for that lineage
already exist and they have not provided explicitly --key-type and --cert-name.
:param config: Current configuration provided by the client
:param cert: Matching certificate that could be renewed
:returns: Whether a key type migration is going ahead.
:rtype: `bool`
Fkey_typer6 zAn z certificate named z7 already exists. Do you want to update its key type to ?zUpdate key typezKeep existing key type) yes_labelno_labeldefaultforce_interactiveTz?Are you trying to change the key type of the certificate named z from z to zr? Please provide both --cert-name and --key-type on the command line to confirm the change you are trying to make.)
rK upperZprivate_key_type set_by_userr. yesno lineagenamer rD lower)r' rJ Z new_key_typeZ cur_key_typeZis_confirmed_via_clir1 r1 r2 %_handle_unexpected_key_type_migration s2
rV )r' r5 rJ r( c
C s t | | d| }dj|jj|d|tjd}| jsV| j sVt
j |dddddr^d |fS t
d
j|t
jd tjd d
tjd ttd
S )a Figure out what to do if a previous cert had a subset of the names now requested
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param domains: List of domain names
:type domains: `list` of `str`
:param cert: Certificate object
:type cert: storage.RenewableCert
:returns: Tuple of (str action, cert_or_None) as per _find_lineage_for_domains_and_certname
action can be: "newcert" | "renew" | "reinstall"
:rtype: `tuple` of `str`
, a You have an existing certificate that contains a portion of the domains you requested (ref: {0}){br}{br}It contains these names: {1}{br}{br}You requested these names for the new certificate: {2}.{br}{br}Do you want to expand and replace this existing certificate with the new certificate?brZExpandCancelz--expandTZcli_flagrP r) zTo obtain a new certificate that contains these names without replacing your existing certificate for {0}, you must use the --duplicate option.{br}{br}For example:{br}{br}{1} --duplicate {2} N)rV joinrB r>
configfilefilenamer$ linesepexpandZrenew_by_defaultr. rS r= r cli_commandsysargvr rD USER_CANCELLED)r' r5 rJ existingquestionr1 r1 r2 _handle_subset_cert_request s*
ri )r' r7 r( c C s t | |}| sd|fS |s*t| |r2d|fS | jr@d|fS dj|jjtj d}| j
dkrdd}n| j
dksvJ dd }|d
g}t j ||d d d
}|d t j
krtd|d d krd|fS |d dkrd|fS tddS )a Figure out what to do if a lineage has the same names as a previously obtained one
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param lineage: Certificate lineage object
:type lineage: storage.RenewableCert
:returns: Tuple of (str action, cert_or_None) as per _find_lineage_for_domains_and_certname
action can be: "newcert" | "renew" | "reinstall"
:rtype: `tuple` of `str`
reinstallr) zYou have an existing certificate that has exactly the same domains or certificate name you requested and isn't close to expiry.{br}(ref: {0}){br}{br}What would you like to do?rX runz.Attempt to reinstall this existing certificatecertonlyz Unexpected Certbot subcommandz%Keep the existing certificate for nowzBRenew & replace the certificate (may be subject to CA rate limits)r T)rO rP z.Operation canceled. You may re-run the client.r] zThis is impossibleN)rV Zensure_deployedr Z should_renewrj r> r_ r` r$ ra r, r. ZmenuZCANCELr rD AssertionError)r' r7 Zis_key_type_changingrh Zkeep_optchoicesZresponser1 r1 r2 _handle_identical_cert_request s<
ro )r' r5 r( c C sX | j r
dS t| |\}}|du r.|du r.dS |dur@t| |S |durTt| ||S dS )a Determine whether there are duplicated names and how to handle
them (renew, reinstall, newcert, or raising an error to stop
the client run if the user chooses to cancel the operation when
prompted).
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param domains: List of domain names
:type domains: `list` of `str`
:returns: Two-element tuple containing desired new-certificate behavior as
a string token ("reinstall", "renew", or "newcert"), plus either
a RenewableCert instance or `None` if renewal shouldn't occur.
:rtype: `tuple` of `str` and :class:`storage.RenewableCert` or `None`
:raises errors.Error: If the user would like to rerun the client again.
ZnewcertNNNN)Z duplicater Zfind_duplicative_certsro ri )r' r5 Zident_names_certZsubset_names_certr1 r1 r2 _find_lineage_for_domains/ s
rr )r' r5 r6 r( c C s. t | ||\}}|dkr"td |dk|fS )ab Finds an existing certificate object given domains and/or a certificate name.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param domains: List of domain names
:type domains: `list` of `str`
:param certname: Name of certificate
:type certname: str
:returns: Two-element tuple of a boolean that indicates if this function should be
followed by a call to fetch a certificate from the server, and either a
RenewableCert instance or None.
:rtype: `tuple` of `bool` and :class:`storage.RenewableCert` or `None`
rj z Keeping the existing certificate)&_find_lineage_for_domains_and_certnameloggerinfo)r' r5 r6 r: r7 r1 r1 r2
_find_certX s
rv c C s |st | |S t| |}|rp|rft| |}|rft|t|krft| | t| ||| d|fS t| |S |rxdS t
d |dS )a Find appropriate lineage based on given domains and/or certname.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param domains: List of domain names
:type domains: `list` of `str`
:param certname: Name of certificate
:type certname: str
:returns: Two-element tuple containing desired new-certificate behavior as
a string token ("reinstall", "renew", or "newcert"), plus either
a RenewableCert instance or None if renewal should not occur.
:rtype: `tuple` of `str` and :class:`storage.RenewableCert` or `None`
:raises errors.Error: If the user would like to rerun the client again.
r) rp z}No certificate with name {0} found. Use -d to specify domains, or run certbot certificates to see possible certificate names.N) rr r lineage_for_certnamedomains_for_certnamesetrV _ask_user_to_confirm_new_namesrB ro r ConfigurationErrorr> )r' r5 r6 r7 Zcomputed_domainsr1 r1 r2 rs q s$
rs T)afterbeforer( c C s@ t t| t| }t t|t| }| | ||fS )zWGet lists of items removed from `before`
and a lists of items added to `after`
)listry sort)r} r~ addedremovedr1 r1 r2 _get_added_removed s
r ) characterstringsr( c C s( |s
d}ndd | }|j| tjdS )z%Format list with given character
z
{br}(None)z {br}{ch} )ZchrY )r^ r> r$ ra )r r formattedr1 r1 r2 _format_list s r )r' new_domainsr6 old_domainsr( c C sX | j r
dS t||\}}dj|td|td|tjd}tj|dddd sTt d
dS ) a Ask user to confirm update cert certname to contain new_domains.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param new_domains: List of new domain names
:type new_domains: `list` of `str`
:param certname: Name of certificate
:type certname: str
:param old_domains: List of old domain names
:type old_domains: `list` of `str`
:returns: None
:rtype: None
:raises errors.ConfigurationError: if cert name and domains mismatch
NzYou are updating certificate {0} to include new domain(s): {1}{br}{br}You are also removing previously included domain(s): {2}{br}{br}Did you intend to make this change?+-rX zUpdate certificaterZ TrO z2Specified mismatched certificate name and domains.)
Zrenew_with_new_domainsr r> r r$ ra r. rS r r{ )r' r r6 r r r msgr1 r1 r2 rz s rz )r' installerrh r( c C sR d}| j }| jr| j}n|r(t| |}|s8t||}|sJ|sJtd||fS )a Retrieve domains and certname from config or user input.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param installer: Installer object
:type installer: interfaces.Installer
:param `str` question: Overriding default question to ask the user if asked
to choose from domain names.
:returns: Two-part tuple of domains and certname
:rtype: `tuple` of list of `str` and `str`
:raises errors.Error: Usage message, if parameters are not used correctly
NzPlease specify --domains, or --installer that will help in domain names autodiscovery, or --cert-name for an existing certificate name.)r6 r5 r rx display_opsZ choose_namesr rD )r' r rh r5 r6 r1 r1 r2 _find_domains_or_certname s
r T)r'
installer_errr7 new_or_renewed_certr( c
s g }|rV j dkr0|d j d j d n&|d j dtj dt | |r jrl|d n.t r|d tj d
n js|d |sd S fd
dt j
dt j fD \}}}t ||d t
d t |dd |D ]}t
d| q|r t d S )a Displays post-run/certonly advice to the user about renewal and installation.
The output varies by runtime configuration and any errors encountered during installation.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param installer_err: The installer/enhancement error encountered, if any.
:type error: Optional[errors.Error]
:param lineage: The resulting certificate lineage from the issuance, if any.
:type lineage: Optional[storage.RenewableCert]
:param bool new_or_renewed_cert: Whether the verb execution resulted in a certificate
being saved (created or renewed).
rl zMThe certificate was saved, but was not successfully loaded by the installer (z\) due to the installer failing to reload. After fixing the error shown below, try reloading z
manually.zBThe certificate was saved, but could not be installed (installer: zM). After fixing the error shown below, try installing it again by running:
z install --cert-name zCertificates created using --csr will not be renewed automatically by Certbot. You will need to renew the certificate before it expires, by running the same Certbot command again.zThis certificate will not be renewed automatically. Autorenewal of --manual certificates requires the use of an authentication hook script (--manual-auth-hook) but one was not provided. To renew this certificate, repeat this same z. command before the certificate's expiry date.zThe certificate will need to be renewed before it expires. Certbot can automatically renew the certificate in the background, but you may need to take steps to enable that functionality. See https://certbot.org/renewal-setup for instructions.Nc s$ g | ] }t j r js |nd qS ) )rd stdoutisattyr- ).0cr0 r1 r2
J s z&_report_next_steps..
)endz NEXT STEPS:r z- )r, appendr r rc !_cert_name_from_config_or_lineagecsr_is_interactive_only_authpreconfigured_renewalr Z
ANSI_SGR_BOLDZANSI_SGR_RESETprintr. r= ) r' r r7 r ZstepsZbold_onnlZbold_offstepr1 r0 r2 _report_next_steps s\
r )r' cert_pathfullchain_pathkey_pathr( c C s~ | j rtd dS |r |s$J dd}| jr:t| s:d}tdj|t| |r^d|nd|| j dkrpd ndd
dS ) a Reports the creation of a new certificate to the user.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param cert_path: path to certificate
:type cert_path: str
:param fullchain_path: path to full chain
:type fullchain_path: str
:param key_path: path to private key, if available
:type key_path: str
:returns: `None`
:rtype: None
The dry run was successful.N No certificates saved to report.r z_
Certbot has set up a scheduled task to automatically renew this certificate in the background.z
Successfully received certificate.
Certificate is saved at: {cert_path}
{key_msg}This certificate expires on {expiry}.
These files will be updated when the certificate renews.{renewal_msg}{nl}z Key is saved at: {}
rk r )r expiryZkey_msg renewal_msgr )
r? r. r= r r r> r notAfterdater, )r' r r r r r1 r1 r2 _report_new_certX s
r c C s | j dkr| jdu rdS dS )zP Whether the current authenticator params only support interactive renewal.
ZmanualNTF)
authenticatorZmanual_auth_hookr0 r1 r1 r2 r s r )r' r
chain_pathr r( c C sN | j rtd dS |r |s$J dt| }tdj||||d dS )a --csr variant of _report_new_cert.
Until --csr is overhauled (#8332) this is transitional function to report the creation
of a new certificate using --csr.
TODO: remove this function and just call _report_new_cert when --csr is overhauled.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param str cert_path: path to cert.pem
:param str chain_path: path to chain.pem
:param str fullchain_path: path to fullchain.pem
r Nr z
Successfully received certificate.
Certificate is saved at: {cert_path}
Intermediate CA chain is saved at: {chain_path}
Full certificate chain is saved at: {fullchain_path}
This certificate expires on {expiry}.)r r r r )r? r. r= r r r r> )r' r r r r r1 r1 r2 _csr_report_new_cert s
r c
sd t dd fdd }t }d} jdur<| j}n| }t|dkrnt|}|sht d|}nt|dkr|d }nЈ j
du r j st _
z"t
j ||d\}}td W n tjy Y n~ tj tj fyR } z\tjd
d d t|r&tttj |}d
| }nt |}t d| W Y d}~n
d}~0 0 |j _||fS )a Determine which account to use.
If ``config.account`` is ``None``, it will be updated based on the
user input. Same for ``config.email``.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:returns: Account and optionally ACME client API (biproduct of new
registration).
:rtype: tuple of :class:`certbot._internal.account.Account` and :class:`acme.client.Client`
:raises errors.Error: If unable to register an account with ACME server
N)terms_of_servicer( c s6 j r
d S d| }tj|ddd}|s2tdd S )NzpPlease read the Terms of Service at {0}. You must agree in order to register with the ACME server. Do you agree?z --agree-tosTr[ z?Registration cannot proceed without accepting Terms of Service.)Ztosr> r. rS r rD )r r resultr0 r1 r2 _tos_cb s z#_determine_account.._tos_cbr] zNo account has been chosen.r )Ztos_cbzAccount registered.r T)exc_infoz#Error returned by the ACME server: z0Unable to register an account with ACME server. )strr AccountFileStorageloadfind_alllenr Zchoose_accountr rD email register_unsafely_without_email get_emailr
registerr. r= ZMissingCommandlineFlag
acme_messagesrt debugZ
is_acme_errorr@ Zdescribe_acme_errorr id) r' r account_storageacmeaccaccountsZ
potential_accerrerr_msgr1 r0 r2 _determine_account sF
r c
s | j }|du r&d}tj|ddddd}|s.dS | js8J | jsJt| | _tt j
t | | jddd| | j z&t | fd d
gd d
d d
W nh t
jy td
Y dS t y } z.d}|| j| j |}t
|W Y d}~n
d}~0 0 t| dS )a Does the user want to delete their now-revoked certs? If run in non-interactive mode,
deleting happens automatically.
:param config: parsed command line arguments
:type config: configuration.NamespaceConfig
:returns: `None`
:rtype: None
:raises errors.Error: If anything goes wrong, including bad user input, if an overlapping
archive dir is found for the specified lineage, etc ...
Nz{Would you like to delete the certificate(s) you just revoked, along with all earlier and later versions of the certificate?zYes (recommended)ZNoT)rM rN rP rO utf-8encodingZdefault_encodingc s S Nr1 x archive_dirr1 r2 z(_delete_if_appropriate..c S s | j S r r r r1 r1 r2 r r c S s | j S r )rT r r1 r1 r2 r r zhNot deleting revoked certificates due to overlapping archive dirs. More than one certificate is using %sz_config.default_archive_dir: {0}, config.live_dir: {1}, archive_dir: {2},original exception: {3})Zdelete_after_revoker. rS r r6 r cert_path_to_lineager Zfull_archive_path configobj ConfigObjrenewal_file_for_certnameZmatch_and_check_overlapsr ZOverlappingMatchFoundrt Zwarning Exceptionr> Zdefault_archive_dirrF rD delete)r' Zattempt_deletionr er1 r r2 _delete_if_appropriate s@
r )r' r r r( c C s> |dur"t | \}}td| nd\}}tj| ||||dS )a Initialize Let's Encrypt Client
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param authenticator: Acme authentication handler
:type authenticator: Optional[interfaces.Authenticator]
:param installer: Installer object
:type installer: interfaces.Installer
:returns: client: Client object
:rtype: client.Client
NzPicked account: %rrq r )r rt r r
Client)r' r r r r r1 r1 r2 _init_le_client- s
r )r' unused_pluginsr( c
C s t | }| }|s$d| j dS d}tj|dddd}|sBdS t| \}}tj| |d d |d
}|j srt
d |j |j
t | } | | j td d S )
a: Deactivate account on server
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param unused_plugins: List of plugins (deprecated)
:type unused_plugins: plugins_disco.PluginsRegistry
:returns: `None` or a string indicating an error
:rtype: None or str
z+Could not find existing account for server .zCAre you sure you would like to irrevocably deactivate your account?Z
DeactivateZAbortT)rM rN rO zDeactivation aborted.Nr ACME client is not set.zAccount deactivated.)r r r serverr. rS r r
r r r rD Zdeactivate_registrationregrr r= )
r' r r r promptZwants_deactivater r cb_clientZ
account_filesr1 r1 r2
unregisterI s&
r c C s& t | }| }|rdS t| dS )a< Create accounts on the server.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param unused_plugins: List of plugins (deprecated)
:type unused_plugins: plugins_disco.PluginsRegistry
:returns: `None` or a string indicating an error
:rtype: None or str
zmThere is an existing account; registration of a duplicate account with this command is currently unsupported.N)r r r r )r' r r r r1 r1 r2 r t s
r c C s t | }| }|s$d| j dS | jdu rB| jsBtjdd| _t| \}}t j
| |dd|d}|j srt
dd}| jrd d
| jd D }|jj}|j |jj|jjj|d d
|_|jj|d|_|| | jstd n t| | td| j dS )a< Modify accounts on the server.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param unused_plugins: List of plugins (deprecated)
:type unused_plugins: plugins_disco.PluginsRegistry
:returns: `None` or a string indicating an error
:rtype: None or str
.Could not find an existing account for server r NF)Zoptionalr r r1 c S s g | ] }d | qS )mailto:r1 )r r r1 r1 r2 r r z"update_account..,)contact)body)urizFAny contact information associated with this account has been removed.z'Your e-mail address was updated to {0}.)r r r r r r r r r r
r r r rD splitr r Zupdate_registrationupdater Z update_regrr. r= r Zprepare_subscriptionr> ) r' r r r r r r Z acc_contactsZ
prev_regr_urir1 r1 r2 update_account s0
r c C s t | }| }|s$d| j dS t| \}}tj| |dd|d}|jsTt d|j
|j }d| j dd|j g}t
|j } |d | g }
|jjD ] } | d
r|
| d d q|d t|
d
krdndt|
dkrd|
nd td| dS )a^ Fetch account info from the ACME server and show it to the user.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param unused_plugins: List of plugins (deprecated)
:type unused_plugins: plugins_disco.PluginsRegistry
:returns: `None` or a string indicating an error
:rtype: None or str
r r Nr r zAccount details for server :z Account URL: z Account Thumbprint: r z Email contact{}: {}r] sr r rW Znoner )r r r r r r
r r r rD Zquery_registrationr r r Z b64encodekey
thumbprintdecoder r r
startswithr> r r^ r. r= ) r' r r r r r r r outputr Zemailsr r1 r1 r2 show_account s0
r c C s@ |r
|j S | jr| jS zt| }|W S tjy: Y n0 d S r )rT r6 r r r rD )r' r7 Z cert_namer1 r1 r2 r s
r )r' r4 r5 r7 r( c C sF |r|n| }|j dusJ |||j|j |j|j |||j dS )a Install a cert
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param le_client: Client object
:type le_client: client.Client
:param domains: List of domains
:type domains: `list` of `str`
:param lineage: Certificate lineage object. Defaults to `None`
:type lineage: storage.RenewableCert
:returns: `None`
:rtype: None
N)r Zdeploy_certificater r r enhance_config)r' r4 r5 r7 Z
path_providerr1 r1 r2
_install_cert
s
r )r' pluginsr( c
C s( zt | |d\}}W n. tjyD } zt|W Y d}~S d}~0 0 | joP| j}| jsx|sxd}tj | dd|dd | _t
| |st d| jrt
| } nt
| rtd| jr| jrt| t| |\}}t| d|d }t| || n
td
t
| r$t| | j} t
| ||| dS ) a' Install a previously obtained cert in a server.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param plugins: List of plugins
:type plugins: plugins_disco.PluginsRegistry
:returns: `None` or the error message
:rtype: None or str
installNz,Which certificate would you like to install?FZallow_multipleZ
custom_promptr VOne ore more of the requested enhancements are not supported by the selected installerzLOne or more of the requested enhancements require --cert-name to be providedr r zPath to certificate or key was not defined. If your certificate is managed by Certbot, please use --cert-name to define which certificate you would like to install.)plug_selchoose_configurator_pluginsr PluginSelectionErrorr r r r6 r
get_certnamesr&
are_supportedNotSupportedError_populate_from_certname
are_requestedr{ _check_certificate_and_keyr r r rw enable)
r' r r _r Z custom_certcertname_questionr5 r4 r7 r1 r1 r2 r ' s:
r c C sR t | | j}|s| S | js$|j| _| js2|j| _| js@|j| _| jsN|j| _| S )zfHelper function for install to populate missing config values from lineage
defined by --cert-name.)r rw r6 r r r r )r' r7 r1 r1 r2 r d s r c C sP t jt| js&td| jt jt| j sLtd| j d S )Nz-Error while reading certificate from path {0}z-Error while reading private key from path {0})
r$ pathisfiler" realpathr r r{ r> r r0 r1 r1 r2 r v s r c C s t d| j | jdu r g n| j}| |}t d| tjtjdd}| jsh| j sh|t
| dS || t d| | j s|t
| dS | | }t d| |t
| dS )zList server software plugins.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param plugins: List of plugins
:type plugins: plugins_disco.PluginsRegistry
:returns: `None`
:rtype: None
zExpected interfaces: %sNzFiltered plugins: %rFr* zPrepared plugins: %s) rt r ifacesZvisible functoolspartialr. r/ initZpreparer available)r' r r
Zfilteredr= r r1 r1 r2 plugins_cmd s"
r c
s g d}t fdd|D }t sH|sHd}t|tj tdzt
|d\}}W n. tj y } zt |W Y d}~S d}~0 0 t
|stdd }tj dd
|d d _t j} | du rtd
jr| }
n d} t| | }
|
s tdt j} | s*td js:| j _|r`t d|d}
|
j|
jd
d t r|t| |
| dS )a6 Add security enhancements to existing configuration
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param plugins: List of plugins
:type plugins: plugins_disco.PluginsRegistry
:returns: `None` or a string indicating an error
:rtype: None or str
)ZhstsZredirectZuirZstaplec 3 s | ]}t |V qd S r )getattr)r Zenhr0 r1 r2 r zenhance..z|Please specify one or more enhancement types to configure. To list the available enhancement types, run:
%s --help enhance
z#No enhancements requested, exiting.enhanceNr zFWhich certificate would you like to use to enhance your configuration?Fr r zBCould not find the list of domains for the given certificate name.zJWhich domain names would you like to enable the selected enhancements for?zAUser cancelled the domain selection. No domains defined, exiting.z:Could not find the lineage for the given certificate name.r )Zredirect_default) anyr& r rt errorr rc r ZMisconfigurationErrorr r r r r r r r r6 rx rD noninteractive_moder Z
choose_valuesrw r r r r )r' r supported_enhancementsZ oldstyle_enhr r r r r Z cert_domainsr5 Zdomain_questionr7 r4 r1 r0 r2 r sN
r c C s t | j| j| | dS )a Rollback server configuration changes made during install.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param plugins: List of plugins
:type plugins: plugins_disco.PluginsRegistry
:returns: `None`
:rtype: None
N)r
rollbackr Z checkpoints)r' r r1 r1 r2 r s
r c C s t | dS )aZ Rename a certificate
Use the information in the config file to rename an existing
lineage.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param unused_plugins: List of plugins (deprecated)
:type unused_plugins: plugins_disco.PluginsRegistry
:returns: `None`
:rtype: None
N)r Zrename_lineager' r r1 r1 r2 rename s r c C s t | dS )aZ Delete a certificate
Use the information in the config file to delete an existing
lineage.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param unused_plugins: List of plugins (deprecated)
:type unused_plugins: plugins_disco.PluginsRegistry
:returns: `None`
:rtype: None
N)r r r r1 r1 r2 r s r c C s t | dS )a. Display information about certs configured with Certbot
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param unused_plugins: List of plugins (deprecated)
:type unused_plugins: plugins_disco.PluginsRegistry
:returns: `None`
:rtype: None
N)r certificatesr r1 r1 r2 r s r c
C s d | _ | _| jdu rT| jrTtt| | j| }|j| _|jrp| dsp|j| _n | jrf| jrp| jrpt
d| j durt
d| j| j t| j| j t| j d }tj| }W d n1 s0 Y t| |}n,t
d| j t| \}}t| |j|j}t| jd"}t| d }W d n1 sH0 Y t
d| j z | t || j t | W n0 t j y } zt!| W Y d} ~ S d} ~ 0 0 t"#| j dS ) aS Revoke a previously obtained certificate.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param unused_plugins: List of plugins (deprecated)
:type unused_plugins: plugins_disco.PluginsRegistry
:returns: `None` or string indicating error in case of error
:rtype: None or str
Nr zCError! Exactly one of --cert-path or --cert-name must be specified!z$Revoking %s using certificate key %srbz Revoking %s using Account Keyr z Reason code for revocation: %s)$r r r r6 r
RenewableCertr r rR r rD r rt r r Z verify_cert_matches_priv_keyopenjoseZJWKr readr
Zacme_from_config_keyr r r Zpyopenssl_load_certificatereasonrevokeZComparableX509r acme_errorsZ ClientErrorr r Zsuccess_revocation)
r' r r7 fr r r r rJ r r1 r1 r2 r$ . s>
. 2 r$ c C s zt | |d\}}W n. tjyD } zt|W Y d}~S d}~0 0 | jrp|rpd| vrptd| j dt
| |stdt | ||}t | |\}}t
| ||\}} | }
|rt|| ||| }
|
r|
jnd} |
r|
jnd} |
r|
jnd}
|rt| | | |
d}zzZt| |||
t | r>|
r>t |
||| | du sN|sZt| n
t| W n, tjy } z|}W Y d}~n
d}~0 0 W t| ||
|d |r|n t| ||
|d |r|0 t| t | |j dS )zObtain a certificate and install.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param plugins: List of plugins
:type plugins: plugins_disco.PluginsRegistry
:returns: `None`
:rtype: None
rk Nz staple-ocspz_Must-Staple extension requested, but OCSP stapling is not supported by the selected installer (a )
You can either:
* remove the --must-staple option from the command line and obtain a certificate without the Must-Staple extension, or;
* use the `certonly` subcommand and manually install the certificate into the intended service (e.g. webserver). You must also then manually enable OCSP stapling, as it is required for certificates with the Must-Staple extension to function properly.
* choose a different installer plugin (such as --nginx or --apache), if possible.r r ) r r r r r Z must_stapler r r r& r r r rv rI r r r r r r r r Zsuccess_installationZsuccess_renewalrD r r3 r handle_subscriptionr )r' r r r r r4 r5 r6 should_get_certr7 Z new_lineager r r r r1 r1 r2 rk e s`
rk )r' r4 r( c
C s | j \}}t|j}tdj| jr(dndt |d |
|\}}| jr`t d| j
dS |||tj| j
tj| jtj| j\}}} ||| fS )a@ Obtain a cert using a user-supplied CSR
This works differently in the CSR case (for now) because we don't
have the privkey, and therefore can't construct the files for a lineage.
So we just save the cert & chain to disk :/
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param client: Client object
:type client: client.Client
:returns: `cert_path`, `chain_path` and `fullchain_path` as absolute
paths to the actual files, or None for each if it's a dry-run.
:rtype: `tuple` of `str`
r8 r; r< r9 z*Dry run: skipping saving certificate to %s)NNN)Z
actual_csrr Zget_names_from_reqdatar. r= r> r? r@ rA Zobtain_certificate_from_csrrt r r Zsave_certificater$ r
normpathr r )
r' r4 r r Z csr_namesrJ chainr r r r1 r1 r2 _csr_get_and_save_cert s(
r- )r' r r7 r( c C sr t | |d\}}t| ||}t|| |d}|s:td|rn| jsnt| || t
d| j d | dS )a Renew & save an existing cert. Do not install it.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param plugins: List of plugins
:type plugins: plugins_disco.PluginsRegistry
:param lineage: Certificate lineage object
:type lineage: storage.RenewableCert
:returns: `None`
:rtype: None
:raises errors.PluginSelectionError: MissingCommandlineFlag if supplied parameters do not pass
rl )r7 z>An existing certificate for the given name could not be found.z
Reloading z! server after certificate renewalN)
r r r rI r rD r? r Zrun_renewal_deployerr. r= r restart)r' r r7 r authr4 Zrenewed_lineager1 r1 r2 rC s
rC c
C s t | |d\}}t| ||}| jrpt| |\}}}t| ||| t| dd| j d t| t
| |j dS t | |\}} t
| || \}
} |
stjddd dS t|| || | } d} | r|r| jstd| j z | W n, tjy }
z|
} W Y d}
~
n
d}
~
0 0 | r | jnd}| r0| jnd}| r@| jnd}t| ||| t| | | |
of| j d | rv| t| t
| |j dS )a Authenticate & obtain cert, but do not install it.
This implements the 'certonly' subcommand.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param plugins: List of plugins
:type plugins: plugins_disco.PluginsRegistry
:returns: `None`
:rtype: None
:raises errors.Error: If specified plugin could not be used
rl Nr' z5Certificate not yet due for renewal; no action taken.Fr* z.Reloading %s server after certificate issuance)r r r r r- r r r? r3 r r( r r rv r. r/ rI rt ru r r. r rD r r r r )r' r r r/ r4 r r r r5 r6 r) r7 r r r r1 r1 r2 rl sF rl c
C s: g }g }z t | \}}W t|| nt|| 0 dS )a Renew previously-obtained certificates.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param unused_plugins: List of plugins (deprecated)
:type unused_plugins: plugins_disco.PluginsRegistry
:returns: `None`
:rtype: None
N)r Zhandle_renewal_requestr Zrun_saved_post_hooks)r' r rH Zfailed_domainsr1 r1 r2 r) C s
r) c C s t | jtj| j td$ t | jtj| j W d n1 sH0 Y | j | j
| j f}|D ]}t j || jd qfdS )zCreate or verify existence of config, work, and hook directories.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:returns: `None`
:rtype: None
N)strict)
r Zset_up_core_dirZ
config_dirr ZCONFIG_DIRS_MODEZstrict_permissionsr" Z
temp_umaskZwork_dirZrenewal_pre_hooks_dirZrenewal_deploy_hooks_dirZrenewal_post_hooks_dirZmake_or_verify_dir)r' Z hook_dirsZhook_dirr1 r1 r2 make_or_verify_needed_dirsZ s
2r2 ) renewal_fileorig_renewal_confr( c C sj zt j| ddd}W n$ t jy8 td| Y n0 |d }|d }||krXd}nd}t| dS )a@ Reports the outcome of certificate renewal reconfiguration to the user.
:param renewal_file: Path to the cert's renewal file
:type renewal_file: str
:param orig_renewal_conf: Loaded original renewal configuration
:type orig_renewal_conf: configobj.ConfigObj
:returns: `None`
:rtype: None
r r error parsing
renewalparamsz3
No changes were made to the renewal configuration.zT
Successfully updated configuration.
Changes will apply when the certificate renews.N)r r ConfigObjErrorr CertStorageErrorr. r= )r3 r4 Zfinal_renewal_confZorig_renewal_paramsZfinal_renewal_paramsZsuccess_messager1 r1 r2 _report_reconfigure_resultsq s
r9 c C s | j rtd| js2d}tj| dd|dd | _| j}zt| |}W n& tjyn td| dY n0 | j r| j
sd }t j |d
d dd | _
zt
j|d
d
d}W n$ t
jy td| Y n0 t| }zt||}W nD ty, } z*td| d| d| dW Y d} ~ n
d} ~ 0 0 |s>td|d }
|drx|j|
d krx|jdu rx|
d |_dD ]*} t|| |
| kr|d}t|q|t||d\} }
t|}d |_ d |_ t d| t ||
| }t!||||d |"| t#|| dS ) a4 Allow the user to set new configuration options for an existing certificate without
forcing renewal. This can be used for things like authenticator, installer, and hooks,
but not for the domains on the cert, since those are only saved in the cert.
:param config: Configuration object
:type config: configuration.NamespaceConfig
:param plugins: List of plugins
:type plugins: plugins_disco.PluginsRegistry
:raises errors.Error: if the dry run fails
:raises errors.ConfigurationError: if certificate could not be loaded
ak You have specified domains, but this function cannot be used to modify the domains in a certificate. If you would like to do so, follow the instructions at https://certbot.org/change-cert-domain. Otherwise, remove the domains from the command to continue reconfiguring. You can specify which certificate you want on the command line with flag --cert-name instead.z0Which certificate would you like to reconfigure? reconfigureFr r z"An existing certificate with name zO could not be found. Run `certbot certificates` to list available certificates.aa You are attempting to set a --deploy-hook. Would you like Certbot to run deploy hooks when it performs a dry run with the new settings? This will run all relevant deploy hooks, including directory hooks, unless --no-directory-hooks is set. This will use the current active certificate, and not the temporary test certificate acquired during the dry run.zRun deploy hookszDo not run deploy hooksr r r r5 zRenewal configuration file z (cert: z ) produced an unexpected error: r Nz0Could not load certificate. See logs for errors.r6 r r )r r a. Using reconfigure to change the ACME account or server is not supported. If you would like to do so, use renew with the --force-renewal flag instead of reconfigure. Note that doing so will count against any rate limits. For more information on this method, see https://certbot.org/renew-reconfigurationrl T)r6 r7 )$r5 r r{ r6 r r r r r8 rE Zrun_deploy_hooksr. rS r r r7 copydeepcopyr Z reconstituter rR r r r getr r r r? r Zset_test_server_optionsr rI Zsave_new_config_valuesr9 )r' r r r6 r3 r r4 Zlineage_configZrenewal_candidater r6 Zparamr r/ Zdry_run_lineage_configr4 r1 r1 r2 r: sv
r: c c sz d}d}| j r,d| _ttjd}t|}n$| jr@ttj}nt tj| j
}z|V W |rv| n|rt| 0 dS )zCreates a display object appropriate to the flags in the supplied config.
:param config: Configuration object
:returns: Display object
NTw) r- r r r$ devnull display_objNoninteractiveDisplayrd r FileDisplayrP close)r' displayerr? r1 r1 r2 make_displayer s$
rE )cli_argsr( c C s | st jdd } t tjddkr4t| } t j
}t
dtj t
dt jd t
d| t
d | t t|| }t zt| t| W n tjy |jtkrĂ Y n0 t|&}t | |||W d S 1 s 0 Y dS )
zRun Certbot.
:param cli_args: command line to Certbot, defaults to ``sys.argv[1:]``
:type cli_args: `list` of `str`
:returns: value for `sys.exit` about the exit status of Certbot
:rtype: `str` or `int` or `None`
r] NZCERTBOT_SNAPPEDTruezcertbot version: %sz#Location of certbot entry point: %sr z
Arguments: %rzDiscovered plugins: %r) rd re r Zpre_arg_parse_setupr$ environr= r Z prepare_env
plugins_discoPluginsRegistryr rt r certbot __version__r# Zprepare_virtual_consoler Zprepare_and_parse_argsZ+raise_for_non_administrative_windows_rightsZpost_arg_parse_setupr2 r rD funcr rE r@ Z set_display)rF r r' rD r1 r1 r2 main# s,
rN )NNN)N)T)N)N)N)__doc__
contextlibr r; r Zlogging.handlersZloggingrd typingr r r r r r r r
r r Zjosepyr! r r r
Z acme_clientr r% r r rK r r r r Zcertbot._internalr r r r r r r r r r r Zcertbot._internal.displayr r@ r@ Zcertbot._internal.pluginsr rI r! r Zcertbot.compatr" r# r$ Zcertbot.displayr% r r. Zcertbot.pluginsr& rf Z getLogger__name__rt ZNamespaceConfigr3 r r r rI boolrV ri ro rr rv rs r| r r rz Z Installerr rD r r r r ZAccountZClientV2r r Z
Authenticatorr rJ r r r r r r r r r r r r r r r r$ rk r- rC rl r) r2 r r9 r: rA rB rE intrN r1 r1 r1 r2 st
B / 0 6
)
+*
) - P -
& D4
+
6
2
= &
@
7
U ( #> r