a
}|gG @ s d Z ddlZddlZddlZddlZddlmZ ddlmZ ddlmZ ddlm Z ddl
m Z ddl m
Z
dd l mZ dd
lmZ dd lmZ dd lmZ eeZG d
d dejZG dd dZeddddZeedddZ dS )z$Certbot user-supplied configuration. N)Any)Dict)List)Optional)parse)errors)util) constants)misc)osc @ s8 e Zd ZdZe Ze Ze Ze Z e Z
dS )ArgumentSourcez;Enum for describing where a configuration argument was set.N) __name__
__module__ __qualname____doc__enumautoZ COMMAND_LINEZ CONFIG_FILEDEFAULTZENV_VARRUNTIME r r 9/usr/lib/python3.9/site-packages/certbot/configuration.pyr s r c @ sx e Zd ZdZejddddZeee f ddddZ
ee d d
d Z eee
f d d
dZeddddZeeeee f d ddZee
dddZee
ddddZeed ddZejeddd dZeee d d d Zejedd d d Zeed d!d"Zejedd#d$d"Zeed d%d&Zejedd'd(d&Zeed d)d*Zejedd+d,d*Zee d d-d.Z eed d/d0Z eed d1d2Z eed d3d4Z eed d5d6Z eed d7d8Z!eed d9d:Z"ee d d;d<Z#eed d=d>Z$eed d?d@Z%eed dAdBZ&ee'e d dCdDZ(ee d dEdFZ)ee d dGdHZ*ee d dIdJZ+eee d dKdLZ,eed dMdNZ-eedOdPdQZ.eed dRdSZ/eed dTdUZ0eed dVdWZ1eed dXdYZ2eed dZd[Z3eed d\d]Z4eed d^d_Z5eed d`daZ6ee d dbdcZ7e
d dddedfZ8dS )gNamespaceConfiga Configuration wrapper around :class:`argparse.Namespace`.
Please note that the following attributes are dynamically resolved using
:attr:`~certbot.configuration.NamespaceConfig.work_dir` and relative
paths defined in :py:mod:`certbot._internal.constants`:
- `accounts_dir`
- `in_progress_dir`
- `temp_checkpoint_dir`
And the following paths are dynamically resolved using
:attr:`~certbot.configuration.NamespaceConfig.config_dir` and relative
paths defined in :py:mod:`certbot._internal.constants`:
- `default_archive_dir`
- `live_dir`
- `renewal_configs_dir`
:ivar namespace: Namespace typically produced by
:meth:`argparse.ArgumentParser.parse_args`.
:type namespace: :class:`argparse.Namespace`
N) namespacereturnc C sv | t | d| t | dd t | di tj| jj| j_tj| jj| j_tj| jj| j_t | d S )Nr _argument_sources _previously_accessed_mutables)
object __setattr__r pathabspathr
config_dirwork_dirZlogs_dir_check_config_sanity)selfr r r r __init__> s zNamespaceConfig.__init__)argument_sourcesr c C s t | d| dS )al
Associate the NamespaceConfig with a dictionary describing where each of
its arguments came from, e.g. `{ 'email': ArgumentSource.CONFIG_FILE }`.
This is necessary for making runtime evaluations on whether an argument
was specified by the user or not (see `set_by_user`).
For an example of how to build such a dictionary, see
`certbot._internal.cli.helpful.HelpfulArgumentParser._build_sources_dict`
:ivar argument_sources: dictionary of argument names to their :class:`ArgumentSource`
:type argument_sources: :class:`Dict[str, ArgumentSource]`
r N)r r )r# r% r r r set_argument_sourcesL s z$NamespaceConfig.set_argument_sources)varr c C s ddl m} ddl m} ddlm} | jdu r6td||v rBdS |dv rx|| \}}|d krh|duS |d
krx|duS || jv r| j| tj krt
d |t | | d S |
|g D ]*}| |rt
d ||
|g d S qdS )
ad
Return True if a particular config variable has been set by the user
(via CLI or config file) including if the user explicitly set it to the
default, or if it was dynamically set at runtime. Returns False if the
variable was assigned a default value.
Raises an exception if `argument_sources` is not set.
r )DEPRECATED_OPTIONS)
VAR_MODIFIERS) selectionNzoNamespaceConfig.set_by_user called without an ArgumentSources dict. See NamespaceConfig.set_argument_sources().F)
authenticator installerr+ r, zVar %s=%s (set by user).T)Z#certbot._internal.cli.cli_constantsr( r) Zcertbot._internal.pluginsr* r% RuntimeErrorZcli_plugin_requestsr r loggerdebuggetattrget set_by_user)r# r' r( r) r* Zauthinstmodifierr r r r2 ^ s2
zNamespaceConfig.set_by_user)r c C s
t | jS )zQ
Returns a dictionary mapping all argument names to their values
)varsr r# r r r to_dict s zNamespaceConfig.to_dict)namer c C s, | j dur(tj| j |< || jv r(| j|= dS )a)
If an argument_sources dict was set, overwrites an argument's source to
be ArgumentSource.RUNTIME. Used when certbot sets an argument's values
at runtime. This also clears the modified value from
_previously_accessed_mutables since it is no longer needed.
N)r r r r )r# r8 r r r _mark_runtime_override s
z&NamespaceConfig._mark_runtime_overridec C s< | j D ]&\}}t| j|}||kr| | q| jS )zPReturns _argument_sources after handling any changes to accessed mutable values.)r copyitemsr0 r r9 r )r# r8 Z
prev_valueZ
current_valuer r r r% s
z NamespaceConfig.argument_sourcesc C sV | j }t| j|}|d urR||vs0|| tjkrR|| jvrRt|sRt|| j|< |S N) r% r0 r r r r
_is_immutabler: deepcopy)r# r8 Z arg_sourcesvaluer r r __getattr__ s zNamespaceConfig.__getattr__)r8 r? r c C s | | t| j|| d S r< )r9 setattrr )r# r8 r? r r r r s
zNamespaceConfig.__setattr__c C s | j jS )z ACME Directory Resource URI.)r serverr6 r r r rB s zNamespaceConfig.server)server_r c C s | d || j_d S )NrB )r9 r rB )r# rC r r r rB s
c C s | j jS )zEmail used for registration and recovery contact.
Use comma to register multiple emails,
ex: u1@example.com,u2@example.com. (default: Ask).
)r emailr6 r r r rD s zNamespaceConfig.email)mailr c C s | d || j_d S )NrD )r9 r rD )r# rE r r r rD s
c C s | j jS )zSize of the RSA key.)r rsa_key_sizer6 r r r rF s z NamespaceConfig.rsa_key_size)ksizer c C s | d || j_dS )z Set the rsa_key_size propertyrF N)r9 r rF )r# rG r r r rF s
c C s | j jS )z`The SECG elliptic curve name to use.
Please see RFC 8446 for supported values.
)r elliptic_curver6 r r r rH s z NamespaceConfig.elliptic_curve)ecurver c C s | d || j_dS )z Set the elliptic_curve propertyrH N)r9 r rH )r# rI r r r rH s
c C s | j jS )zhType of generated private key.
Only *ONE* per invocation can be provided at this time.
)r key_typer6 r r r rJ s zNamespaceConfig.key_type)ktyper c C s | d || j_dS )zSet the key_type propertyrJ N)r9 r rJ )r# rK r r r rJ s
c C s | j jS )zAdds the OCSP Must-Staple extension to the certificate.
Autoconfigures OCSP Stapling for supported setups
(Apache version >= 2.3.3 ).
)r must_stapler6 r r r rL s zNamespaceConfig.must_staplec C s | j jS )zConfiguration directory.)r r r6 r r r r s zNamespaceConfig.config_dirc C s | j jS )zWorking directory.)r r! r6 r r r r! s zNamespaceConfig.work_dirc C s | | jS )z2Directory where all account information is stored.) accounts_dir_for_server_path server_pathr6 r r r accounts_dir s z NamespaceConfig.accounts_dirc C s t j| jjtjS )z Configuration backups directory.)r r joinr r! r Z
BACKUP_DIRr6 r r r
backup_dir s zNamespaceConfig.backup_dirc C s t j| jjtjS )z:Directory used before a permanent checkpoint is finalized.)r r rP r r! r ZIN_PROGRESS_DIRr6 r r r in_progress_dir s z NamespaceConfig.in_progress_dirc C s t j| jjtjS )z Temporary checkpoint directory.)r r rP r r! r ZTEMP_CHECKPOINT_DIRr6 r r r temp_checkpoint_dir" s
z#NamespaceConfig.temp_checkpoint_dirc C s | j jS )zDisable verification of the ACME server's certificate.
The root certificates trusted by Certbot can be overriden by setting the
REQUESTS_CA_BUNDLE environment variable.
)r
no_verify_sslr6 r r r rT ( s z NamespaceConfig.no_verify_sslc C s | j jS )zPort used in the http-01 challenge.
This only affects the port Certbot listens on.
A conforming ACME server will still attempt to connect on port 80.
)r http01_portr6 r r r rU 1 s zNamespaceConfig.http01_portc C s | j jS )z;The address the server listens to during http-01 challenge.)r http01_addressr6 r r r rV : s z NamespaceConfig.http01_addressc C s | j jS )zPort used to serve HTTPS.
This affects which port Nginx will listen on after a LE certificate
is installed.
)r
https_portr6 r r r rW ? s zNamespaceConfig.https_portc C s | j jS )zuList of user specified preferred challenges.
Sorted with the most preferred challenge listed first.
)r pref_challsr6 r r r rX H s zNamespaceConfig.pref_challsc C s | j jS )a Allow only a subset of names to be authorized to perform validations.
When performing domain validation, do not consider it a failure
if authorizations can not be obtained for a strict subset of
the requested domains. This may be useful for allowing renewals for
multiple domains to succeed even if some domains no longer point
at this system.
)r allow_subset_of_namesr6 r r r rY P s
z%NamespaceConfig.allow_subset_of_namesc C s | j jS )zEnable strict permissions checks.
Require that all configuration files are owned by the current
user; only needed if your config is somewhere unsafe like /tmp/.
)r strict_permissionsr6 r r r rZ \ s z"NamespaceConfig.strict_permissionsc C s | j jS )zDisable renewal updates.
If updates provided by installer enhancements when Certbot is being run
with "renew" verb should be disabled.
)r disable_renew_updatesr6 r r r r[ e s z%NamespaceConfig.disable_renew_updatesc C s | j jS )zSet the preferred certificate chain.
If the CA offers multiple certificate chains, prefer the chain whose
topmost certificate was issued from this Subject Common Name.
If no match, the default offered chain will be used.
)r preferred_chainr6 r r r r\ n s z NamespaceConfig.preferred_chainc C s& t | jj}|j|j dtjjS )z File path based on ``server``./) r urlparser rB netlocr replacer sep)r# parsedr r r rN x s zNamespaceConfig.server_path)rN r c C s t |}tj| jjtj|S )z/Path to accounts directory based on server_path) r
Z.underscores_for_unsupported_characters_in_pathr r rP r r r Z ACCOUNTS_DIR)r# rN r r r rM ~ s
z,NamespaceConfig.accounts_dir_for_server_pathc C s t j| jjtjS r< )r r rP r r r Z ARCHIVE_DIRr6 r r r default_archive_dir s z#NamespaceConfig.default_archive_dirc C s t j| jjtjS r< )r r rP r r r ZLIVE_DIRr6 r r r live_dir s zNamespaceConfig.live_dirc C s t j| jjtjS r< )r r rP r r r ZRENEWAL_CONFIGS_DIRr6 r r r renewal_configs_dir s
z#NamespaceConfig.renewal_configs_dirc C s t j| jjtjS )z>Path to directory with hooks to run with the renew subcommand.)r r rP r r r ZRENEWAL_HOOKS_DIRr6 r r r renewal_hooks_dir s z!NamespaceConfig.renewal_hooks_dirc C s t j| jtjS )z8Path to the pre-hook directory for the renew subcommand.)r r rP rf r ZRENEWAL_PRE_HOOKS_DIRr6 r r r renewal_pre_hooks_dir s
z%NamespaceConfig.renewal_pre_hooks_dirc C s t j| jtjS )z;Path to the deploy-hook directory for the renew subcommand.)r r rP rf r ZRENEWAL_DEPLOY_HOOKS_DIRr6 r r r renewal_deploy_hooks_dir s
z(NamespaceConfig.renewal_deploy_hooks_dirc C s t j| jtjS )z9Path to the post-hook directory for the renew subcommand.)r r rP rf r ZRENEWAL_POST_HOOKS_DIRr6 r r r renewal_post_hooks_dir s
z&NamespaceConfig.renewal_post_hooks_dirc C s | j jS )zuThis option specifies how long (in seconds) Certbot will wait
for the server to issue a certificate.
)r issuance_timeoutr6 r r r rj s z NamespaceConfig.issuance_timeoutc C s | j jS )zThis option specifies whether Certbot should generate a new private
key when replacing a certificate, even if reuse_key is set.
)r new_keyr6 r r r rk s zNamespaceConfig.new_key)_memor c C sH t | j}t| |}t|dt | j t|dt | j |S )Nr r )r: r> r typer r r% r )r# rl Znew_nsZ
new_configr r r __deepcopy__ s
z NamespaceConfig.__deepcopy__)9r
r r r argparse Namespacer$ r strr r& boolr2 r r7 r9 propertyr r% r@ r rB setterrD intrF rH rJ rL r r! rO rQ rR rS rT rU rV rW r rX rY rZ r[ r\ rN rM rc rd re rf rg rh ri rj rk rn r r r r r % s * r )configr c C sF | j | jkr td| j| jjdurB| jjD ]}t| q2dS )zValidate command line options and display error message if
requirements are not met.
:param config: NamespaceConfig instance holding user configuration
:type args: :class:`certbot.configuration.NamespaceConfig`
z;Trying to run http-01 and https-port on the same port ({0})N) rU rW r ZConfigurationErrorformatr Zdomainsr Zenforce_domain_sanity)rv domainr r r r" s r" )r? r c C sL t | tr tdd | D S ttttttt fD ]}t | |r. dS q.| du S )z Is value of an immutable type?c s s | ]}t |V qd S r< )r= ).0Zsubvaluer r r z _is_immutable..TN)
isinstancetupleallru floatcomplexrq bytesrr frozenset)r? Zimmutable_typer r r r= s
r= ) r ro r: r Zloggingtypingr r r r Zurllibr Zcertbotr r Zcertbot._internalr Zcertbot.compatr
r Z getLoggerr
r. Enumr r r" rr r= r r r r s,
"