3
گaD @ s" d Z ddlmZ ddlmZ ddlmZ ddlZddlmZ ddl m
Z
ddl m Z dd l m Z dd
l m
Z
dd l mZ dd l mZ dd
l mZ ddl mZ ddlZddlZddlmZ ddlmZ ddlmZ ddlmZ ddl m Z erddl m Z G dd dedZ G dd dej!j"Z#G dd dej!j"Z$G d d d ej!j"Z%G d d d edZ&G d d! d!e%Z'G d"d# d#e&Z(G d$d% d%e%Z)G d&d' d'e&Z*G d(d) d)ej!j"Z+G d*d+ d+ej!j"Z,G d,d- d-edZ-G d.d/ d/edZ.G d0d1 d1edZ/G d2d3 d3Z0e ee0ej1e2 ej1e2< dS )4zCertbot client interfaces. )ABCMeta)abstractmethod)ArgumentParserN)
ModuleType)Any)cast)Iterable)List)Optional)Type)
TYPE_CHECKING)Union) Challenge)ChallengeResponse)
ClientBase)
configuration)AnnotatedChallenge)Accountc @ sP e Zd ZdZeed dddZeeddddZede d d
d d Z
d S )
AccountStoragezAccounts storage interface.r )returnc C s
t dS )zXFind all accounts.
:returns: All found accounts.
:rtype: list
N)NotImplementedError)self r /usr/lib/python3.6/interfaces.pyfind_all s zAccountStorage.find_all)
account_idr c C s
t dS )zLoad an account by its id.
:raises .AccountNotFound: if account could not be found
:raises .AccountStorageError: if account could not be loaded
:returns: The account loaded
:rtype: .Account
N)r )r r r r r load* s zAccountStorage.loadN)accountclientr c C s
t dS )z\Save account.
:raises .AccountStorageError: if account could not be saved
N)r )r r r r r r save7 s zAccountStorage.save) __name__
__module__ __qualname____doc__r r r strr r r r r r r r s r ) metaclassc @ s e Zd ZdZdS )IConfigz>Deprecated, use certbot.configuration.NamespaceConfig instead.N)r r! r" r# r r r r r& A s r& c @ s e Zd ZdZdS )IPluginFactoryz9Deprecated, use certbot.interfaces.Plugin as ABC instead.N)r r! r" r# r r r r r' E s r' c @ s e Zd ZdZdS )IPluginz9Deprecated, use certbot.interfaces.Plugin as ABC instead.N)r r! r" r# r r r r r( I s r( c s e Zd ZU dZeZeeZeee e
j edd fdd Z eddddZ
eedd d
Zeeeedd d d
Z ZS )Plugina- Certbot plugin.
Objects providing this interface will be called without satisfying
any entry point "extras" (extra dependencies) you might have defined
for your plugin, e.g (excerpt from ``setup.py`` script)::
setup(
...
entry_points={
'certbot.plugins': [
'name=example_project.plugin[plugin_deps]',
],
},
extras_require={
'plugin_deps': ['dep1', 'dep2'],
}
)
Therefore, make sure such objects are importable and usable without
extras. This is necessary, because CLI does the following operations
(in order):
- loads an entry point,
- calls `inject_parser_options`,
- requires an entry point,
- creates plugin instance (`__call__`).
N)confignamer c s t j dS )zCreate a new `Plugin`.
:param configuration.NamespaceConfig config: Configuration.
:param str name: Unique plugin name.
N)super__init__)r r* r+ ) __class__r r r- q s zPlugin.__init__)r c C s dS )a Prepare the plugin.
Finish up any additional initialization.
:raises .PluginError:
when full initialization cannot be completed.
:raises .MisconfigurationError:
when full initialization cannot be completed. Plugin will
be displayed on a list of available plugins.
:raises .NoInstallationError:
when the necessary programs/files cannot be located. Plugin
will NOT be displayed on a list of available plugins.
:raises .NotSupportedError:
when the installation is recognized, but the version is not
currently supported.
Nr )r r r r prepare{ s zPlugin.preparec C s dS )zHuman-readable string to help the user.
Should describe the steps taken and any relevant info to help the user
decide which plugin to use.
:rtype str:
Nr )r r r r more_info s zPlugin.more_info)parserr+ r c C s dS )a Inject argument parser options (flags).
1. Be nice and prepend all options and destinations with
`~.common.option_namespace` and `~common.dest_namespace`.
2. Inject options (flags) only. Positional arguments are not
allowed, as this would break the CLI.
:param ArgumentParser parser: (Almost) top-level CLI parser.
:param str name: Unique plugin name.
Nr )clsr1 r+ r r r inject_parser_options s z Plugin.inject_parser_options)r r! r" r# NotImplemented descriptionr$ r+ r r
r ZNamespaceConfigr- r/ r0 classmethodr r3
__classcell__r r )r. r r) M s
r) c @ s e Zd ZdZdS )IAuthenticatorz@Deprecated, use certbot.interfaces.Authenticator as ABC instead.N)r r! r" r# r r r r r8 s r8 c @ s` e Zd ZdZeeeee dddZ ee
e e
e dddZ
ee
e ddd d
ZdS )
AuthenticatorzGeneric Certbot Authenticator.
Class represents all possible tools processes that have the
ability to perform challenges and attain a certificate.
)domainr c C s dS )a Return `collections.Iterable` of challenge preferences.
:param str domain: Domain for which challenge preferences are sought.
:returns: `collections.Iterable` of challenge types (subclasses of
:class:`acme.challenges.Challenge`) with the most
preferred challenges first. If a type is not specified, it means the
Authenticator cannot perform the challenge.
:rtype: `collections.Iterable`
Nr )r r: r r r get_chall_pref s z Authenticator.get_chall_pref)achallsr c C s dS )a Perform the given challenge.
:param list achalls: Non-empty (guaranteed) list of
:class:`~certbot.achallenges.AnnotatedChallenge`
instances, such that it contains types found within
:func:`get_chall_pref` only.
:returns: list of ACME
:class:`~acme.challenges.ChallengeResponse` instances corresponding to each provided
:class:`~acme.challenges.Challenge`.
:rtype: :class:`collections.List` of
:class:`acme.challenges.ChallengeResponse`,
where responses are required to be returned in
the same order as corresponding input challenges
:raises .PluginError: If some or all challenges cannot be performed
Nr )r r< r r r perform s zAuthenticator.performNc C s dS )a Revert changes and shutdown after challenges complete.
This method should be able to revert all changes made by
perform, even if perform exited abnormally.
:param list achalls: Non-empty (guaranteed) list of
:class:`~certbot.achallenges.AnnotatedChallenge`
instances, a subset of those previously passed to :func:`perform`.
:raises PluginError: if original configuration cannot be restored
Nr )r r< r r r cleanup s zAuthenticator.cleanup)r r! r" r# r r$ r r r r; r r r r= r> r r r r r9 s
r9 c @ s e Zd ZdZdS )
IInstallerz sL $^;G