3
گa�D � @ 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 er�ddl m Z G dd� ded�Z G dd� dej!j"�Z#G dd� dej!j"�Z$G d d � d ej!j"�Z%G d d � d ed�Z&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-ed�Z-G d.d/� d/ed�Z.G d0d1� d1ed�Z/G d2d3� d3�Z0e 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 d�dd��Zeedd�dd��Zede 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.py�find_all s zAccountStorage.find_all)�
account_idr c C s
t � �dS )z�Load 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)�account�clientr 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 edd�dd��Z
eed�d 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)�config�namer c s t � j� dS )z�Create 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 )z�Human-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 d�dd��Z ee
e e
e d�dd��Z
ee
e dd�d d
��ZdS ) �
Authenticatorz�Generic 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<Deprecated, use certbot.interfaces.Installer as ABC instead.N)r r! r" r# r r r r r? � s r? c @ s� e Zd ZdZeee d�dd��Zeeeeeedd�dd��Zed eee e
e e ef dd �d
d ��Z ee e d�d d
��Z
ed e e edd�dd��Zed edd�dd��Zedd�dd��Zedd�dd��Zedd�dd��ZdS ) � Installera� Generic Certbot Installer Interface.
Represents any server that an X509 certificate can be placed.
It is assumed that :func:`save` is the only method that finalizes a
checkpoint. This is important to ensure that checkpoints are
restored in a consistent manner if requested by the user or in case
of an error.
Using :class:`certbot.reverter.Reverter` to implement checkpoints,
rollback, and recovery can dramatically simplify plugin development.
)r c C s dS )zgReturns all names that may be authenticated.
:rtype: `collections.Iterable` of `str`
Nr )r r r r �
get_all_names� s zInstaller.get_all_namesN)r: � cert_path�key_path�
chain_path�fullchain_pathr c C s dS )a� Deploy certificate.
:param str domain: domain to deploy certificate file
:param str cert_path: absolute path to the certificate file
:param str key_path: absolute path to the private key file
:param str chain_path: absolute path to the certificate chain file
:param str fullchain_path: absolute path to the certificate fullchain
file (cert plus chain)
:raises .PluginError: when cert cannot be deployed
Nr )r r: rB rC rD rE r r r � deploy_cert s zInstaller.deploy_cert)r: � enhancement�optionsr c C s dS )aG Perform a configuration enhancement.
:param str domain: domain for which to provide enhancement
:param str enhancement: An enhancement as defined in
:const:`~certbot.plugins.enhancements.ENHANCEMENTS`
:param options: Flexible options parameter for enhancement.
Check documentation of
:const:`~certbot.plugins.enhancements.ENHANCEMENTS`
for expected options for each enhancement.
:raises .PluginError: If Enhancement is not supported, or if
an error occurs during the enhancement.
Nr )r r: rG rH r r r �enhance s zInstaller.enhancec C s dS )a Returns a `collections.Iterable` of supported enhancements.
:returns: supported enhancements which should be a subset of
:const:`~certbot.plugins.enhancements.ENHANCEMENTS`
:rtype: :class:`collections.Iterable` of :class:`str`
Nr )r r r r �supported_enhancements' s z Installer.supported_enhancementsF)�title� temporaryr c C s dS )a1 Saves all changes to the configuration files.
Both title and temporary are needed because a save may be
intended to be permanent, but the save is not ready to be a full
checkpoint.
It is assumed that at most one checkpoint is finalized by this
method. Additionally, if an exception is raised, it is assumed a
new checkpoint was not finalized.
:param str title: The title of the save. If a title is given, the
configuration will be saved as a new checkpoint and put in a
timestamped directory. `title` has no effect if temporary is true.
:param bool temporary: Indicates whether the changes made will
be quickly reversed in the future (challenges)
:raises .PluginError: when save is unsuccessful
Nr )r rK rL r r r r 1 s zInstaller.save� )�rollbackr c C s dS )z�Revert `rollback` number of configuration checkpoints.
:raises .PluginError: when configuration cannot be fully reverted
Nr )r rN r r r �rollback_checkpointsH s z Installer.rollback_checkpointsc C s dS )aA Revert configuration to most recent finalized checkpoint.
Remove all changes (temporary and permanent) that have not been
finalized. This is useful to protect against crashes and other
execution interruptions.
:raises .errors.PluginError: If unable to recover the configuration
Nr )r r r r �recovery_routineP s zInstaller.recovery_routinec C s dS )z�Make sure the configuration is valid.
:raises .MisconfigurationError: when the config is not in a usable state
Nr )r r r r � config_test\ s zInstaller.config_testc C s dS )zoRestart or refresh the server content.
:raises .PluginError: when server cannot be restarted
Nr )r r r r �restartd s zInstaller.restart)N)NF)rM )r r! r" r# r r r$ rA rF r
r
r rI rJ �boolr �intrO rP rQ rR r r r r r@ � s(
( r@ c @ s e Zd ZdZdS )�IDisplayz8Deprecated, use your own Display implementation instead.N)r r! r" r# r r r r rU m s rU c @ s e Zd ZdZdS )� IReporterz9Deprecated, use your own Reporter implementation instead.N)r r! r" r# r r r r rV q s rV c @ s� e Zd ZdZeeed�dd���Zeeed�dd���Zeeed�dd���Z eeed�d d
���Z
eeed�d d ���Z ee e d�d
d��Z
dS )�
RenewableCertz#Interface to a certificate lineage.)r c C s dS )z<Path to the certificate file.
:rtype: str
Nr )r r r r rB x s zRenewableCert.cert_pathc C s dS )z<Path to the private key file.
:rtype: str
Nr )r r r r rC � s zRenewableCert.key_pathc C s dS )zBPath to the certificate chain file.
:rtype: str
Nr )r r r r rD � s zRenewableCert.chain_pathc C s dS )z�Path to the full chain file.
The full chain is the certificate file plus the chain file.
:rtype: str
Nr )r r r r rE � s z RenewableCert.fullchain_pathc C s dS )zEName given to the certificate lineage.
:rtype: str
Nr )r r r r � lineagename� s zRenewableCert.lineagenamec C s dS )z�What are the subject names of this certificate?
:returns: the subject names
:rtype: `list` of `str`
:raises .CertStorageError: if could not find cert file.
Nr )r r r r �names� s zRenewableCert.namesN)r r! r" r# �propertyr r$ rB rC rD rE rX r rY r r r r rW u s$ rW c @ s( e Zd ZdZeeeedd�dd��ZdS )�GenericUpdateraI Interface for update types not currently specified by Certbot.
This class allows plugins to perform types of updates that Certbot hasn't
defined (yet).
To make use of this interface, the installer should implement the interface
methods, and interfaces.GenericUpdater.register(InstallerClass) should
be called from the installer code.
The plugins implementing this enhancement are responsible of handling
the saving of configuration checkpoints as well as other calls to
interface methods of `interfaces.Installer` such as prepare() and restart()
N)�lineage�args�kwargsr c O s dS )a� Perform any update types defined by the installer.
If an installer is a subclass of the class containing this method, this
function will always be called when "certbot renew" is run. If the
update defined by the installer should be run conditionally, the
installer needs to handle checking the conditions itself.
This method is called once for each lineage.
:param lineage: Certificate lineage object
:type lineage: RenewableCert
Nr )r r\ r] r^ r r r �generic_updates� s z GenericUpdater.generic_updates)r r! r" r# r rW r r_ r r r r r[ � s
r[ c @ s( e Zd ZdZeeeedd�dd��ZdS )�
RenewDeployera� Interface for update types run when a lineage is renewed
This class allows plugins to perform types of updates that need to run at
lineage renewal that Certbot hasn't defined (yet).
To make use of this interface, the installer should implement the interface
methods, and interfaces.RenewDeployer.register(InstallerClass) should
be called from the installer code.
N)r\ r] r^ r c O s dS )a Perform updates defined by installer when a certificate has been renewed
If an installer is a subclass of the class containing this method, this
function will always be called when a certificate has been renewed by
running "certbot renew". For example if a plugin needs to copy a
certificate over, or change configuration based on the new certificate.
This method is called once for each lineage renewed
:param lineage: Certificate lineage object
:type lineage: RenewableCert
Nr )r r\ r] r^ r r r � renew_deploy� s zRenewDeployer.renew_deploy)r r! r" r# r rW r ra r r r r r` � s r` c @ sd e Zd ZdZedd�dd�Zedd�dd�Zeedd �d
d �Z edd�d d
�Z
e e d�dd�Z dS )� _ZopeInterfacesDeprecationModulez�
Internal class delegating to a module, and displaying warnings when
attributes related to Zope interfaces are accessed.
N)�moduler c C s || j d< d S )N�_module)�__dict__)r rc r r r r- s z)_ZopeInterfacesDeprecationModule.__init__)�attrr c C s* |d kr t jdj|�td d
� t| j|�S ) Nr& r( r' r8 r? rU rV zR{0} attribute in certbot.interfaces module is deprecated and will be removed soon.� )�
stacklevel)r& r( r' r8 r? rU rV )�warnings�warn�format�DeprecationWarning�getattrrd )r rf r r r � __getattr__ s
z,_ZopeInterfacesDeprecationModule.__getattr__)rf �valuer c C s t | j||� d S )N)�setattrrd )r rf ro r r r � __setattr__ s z,_ZopeInterfacesDeprecationModule.__setattr__c C s t | j|� d S )N)�delattrrd )r rf r r r � __delattr__ s z,_ZopeInterfacesDeprecationModule.__delattr__)r c C s dgt | j� S )Nrd )�dirrd )r r r r �__dir__ s z(_ZopeInterfacesDeprecationModule.__dir__)
r r! r" r# r r- r$ rn r rq rs r ru r r r r rb � s rb )3r# �abcr r �argparser �sys�typesr Ztypingr r r r r
r r r
ri Zzope.interface�zopeZacme.challengesr r Z acme.clientr Zcertbotr Zcertbot.achallengesr Zcertbot._internal.accountr r Z interfaceZ Interfacer& r' r( r) r8 r9 r? r@ rU rV rW r[ r` rb �modulesr r r r r �<module> sL $^;G