U ]V@sdZddlZddlZddlZeejGdddeZGdddej j Z Gdddej j Z Gd d d e Z Gd d d ej j ZGd dde ZGdddej j ZGdddej j ZeejGdddeZeejGdddeZdS)zCertbot client interfaces.Nc@s:eZdZdZejddZejddZejddZdS) AccountStoragezAccounts storage interface.cCs tdS)zXFind all accounts. :returns: All found accounts. :rtype: list NNotImplementedErrorselfr4/usr/lib/python3/dist-packages/certbot/interfaces.pyfind_allszAccountStorage.find_allcCs tdS)zLoad an account by its id. :raises .AccountNotFound: if account could not be found :raises .AccountStorageError: if account could not be loaded Nr)rZ account_idrrrloadszAccountStorage.loadcCs tdS)z\Save account. :raises .AccountStorageError: if account could not be saved Nr)rZaccountZclientrrrsave"szAccountStorage.saveN) __name__ __module__ __qualname____doc__abcabstractmethodr r r rrrrr s  rc@s,eZdZdZejdZddZddZ dS)IPluginFactorya.IPlugin factory. 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__`). zShort plugin descriptioncCsdS)z{Create new `IPlugin`. :param IConfig config: Configuration. :param str name: Unique plugin name. Nr)Zconfignamerrr__call__LszIPluginFactory.__call__cCsdS)aInject 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)parserrrrrinject_parser_optionsTsz$IPluginFactory.inject_parser_optionsN) r r rrzope interface AttributeZ descriptionrrrrrrr,s rc@s eZdZdZddZddZdS)IPluginzCertbot plugin.cCsdS)aPrepare 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. NrrrrrpreparefszIPlugin.preparecCsdS)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: Nrrrrr more_infoyszIPlugin.more_infoN)r r rrrrrrrrrcsrc@s(eZdZdZddZddZddZdS) IAuthenticatorzGeneric Certbot Authenticator. Class represents all possible tools processes that have the ability to perform challenges and attain a certificate. cCsdS)aReturn `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)domainrrrget_chall_prefszIAuthenticator.get_chall_prefcCsdS)aPerform 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: `collections.Iterable` of ACME :class:`~acme.challenges.ChallengeResponse` instances corresponding to each provided :class:`~acme.challenges.Challenge`. :rtype: :class:`collections.Iterable` 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 NrZachallsrrrperformszIAuthenticator.performcCsdS)aRevert 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 Nrr rrrcleanupszIAuthenticator.cleanupN)r r rrrr!r"rrrrrs rc@seZdZdZejdZejdZejdZ ejdZ ejdZ ejdZ ejdZ ejd Zejd Zejd Zejd Zejd ZejdZejdZejdZejdZejdZejdZejdZejdZdS)IConfigzCertbot user-supplied configuration. .. warning:: The values stored in the configuration have not been filtered, stripped or sanitized. zACME Directory Resource URI.zEmail used for registration and recovery contact. Use comma to register multiple emails, ex: u1@example.com,u2@example.com. (default: Ask).zSize of the RSA key.zAdds the OCSP Must Staple extension to the certificate. Autoconfigures OCSP Stapling for supported setups (Apache version >= 2.3.3 ).zConfiguration directory.zWorking directory.z2Directory where all account information is stored.z Configuration backups directory.zNDirectory where newly generated Certificate Signing Requests (CSRs) are saved.z:Directory used before a permanent checkpoint is finalized.z Keys storage.zTemporary checkpoint directory.z6Disable verification of the ACME server's certificate.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.z;The address the server listens to during http-01 challenge.zkPort used to serve HTTPS. This affects which port Nginx will listen on after a LE certificate is installed.zeSorted user specified preferred challengestype strings with the most preferred challenge listed firsta#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. This is a booleanzRequire that all configuration files are owned by the current user; only needed if your config is somewhere unsafe like /tmp/.This is a booleanzmIf updates provided by installer enhancements when Certbot is being run with "renew" verb should be disabled.N)r r rrrrrZserverZemailZ rsa_key_sizeZ must_stapleZ config_dirZwork_dirZ accounts_dirZ backup_dirZcsr_dirZin_progress_dirZkey_dirZtemp_checkpoint_dirZ no_verify_sslZ http01_portZhttp01_addressZ https_portZ pref_challsZallow_subset_of_namesZstrict_permissionsZdisable_renew_updatesrrrrr#sb      r#c@s^eZdZdZddZddZdddZd d Zdd d ZdddZ ddZ ddZ ddZ dS) IInstalleraGeneric 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. cCsdS)zgReturns all names that may be authenticated. :rtype: `collections.Iterable` of `str` Nrrrrr get_all_namesszIInstaller.get_all_namescCsdS)aDeploy 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)rZ cert_pathZkey_pathZ chain_pathZfullchain_pathrrr deploy_certszIInstaller.deploy_certNcCsdS)a1Perform a configuration enhancement. :param str domain: domain for which to provide enhancement :param str enhancement: An enhancement as defined in :const:`~certbot.constants.ENHANCEMENTS` :param options: Flexible options parameter for enhancement. Check documentation of :const:`~certbot.constants.ENHANCEMENTS` for expected options for each enhancement. :raises .PluginError: If Enhancement is not supported, or if an error occurs during the enhancement. Nr)rZ enhancementZoptionsrrrenhance%szIInstaller.enhancecCsdS)zReturns a `collections.Iterable` of supported enhancements. :returns: supported enhancements which should be a subset of :const:`~certbot.constants.ENHANCEMENTS` :rtype: :class:`collections.Iterable` of :class:`str` Nrrrrrsupported_enhancements5sz!IInstaller.supported_enhancementsFcCsdS)a1Saves 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)titleZ temporaryrrrr >szIInstaller.savecCsdS)zRevert `rollback` number of configuration checkpoints. :raises .PluginError: when configuration cannot be fully reverted Nr)Zrollbackrrrrollback_checkpointsTszIInstaller.rollback_checkpointscCsdS)aARevert 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 Nrrrrrrecovery_routine[szIInstaller.recovery_routinecCsdS)zMake sure the configuration is valid. :raises .MisconfigurationError: when the config is not in a usable state Nrrrrr config_testfszIInstaller.config_testcCsdS)zoRestart or refresh the server content. :raises .PluginError: when server cannot be restarted NrrrrrrestartmszIInstaller.restart)N)NF)r*) r r rrr%r&r'r(r r+r,r-r.rrrrr$s    r$c@sLeZdZdZdddZdddZdd d Zdd dZdddZdddZ dS)IDisplayzGeneric display.TFcCsdS)aDisplays a string message :param str message: Message to display :param bool pause: Whether or not the application should pause for confirmation (if available) :param bool wrap: Whether or not the application should wrap text :param bool force_interactive: True if it's safe to prompt the user because it won't cause any workflow regressions Nr)messagepauseZwrapforce_interactiverrr notificationzszIDisplay.notificationNcCsdS)aDisplays a generic menu. When not setting force_interactive=True, you must provide a default value. :param str message: message to display :param choices: choices :type choices: :class:`list` of :func:`tuple` or :class:`str` :param str ok_label: label for OK button (UNUSED) :param str cancel_label: label for Cancel button (UNUSED) :param str help_label: label for Help button (UNUSED) :param int default: default (non-interactive) choice from the menu :param str cli_flag: to automate choice from the menu, eg "--keep" :param bool force_interactive: True if it's safe to prompt the user because it won't cause any workflow regressions :returns: tuple of (`code`, `index`) where `code` - str display exit code `index` - int index of the user's selection :raises errors.MissingCommandlineFlag: if called in non-interactive mode without a default set Nr)r0choicesZok_labelZ cancel_labelZ help_labeldefaultcli_flagr2rrrmenusz IDisplay.menucCsdS)aAccept input from the user. When not setting force_interactive=True, you must provide a default value. :param str message: message to display to the user :param str default: default (non-interactive) response to prompt :param bool force_interactive: True if it's safe to prompt the user because it won't cause any workflow regressions :returns: tuple of (`code`, `input`) where `code` - str display exit code `input` - str of the user's input :rtype: tuple :raises errors.MissingCommandlineFlag: if called in non-interactive mode without a default set Nr)r0r5cli_argsr2rrrinputszIDisplay.inputYesNocCsdS)aQuery the user with a yes/no question. Yes and No label must begin with different letters. When not setting force_interactive=True, you must provide a default value. :param str message: question for the user :param str default: default (non-interactive) choice from the menu :param str cli_flag: to automate choice from the menu, eg "--redirect / --no-redirect" :param bool force_interactive: True if it's safe to prompt the user because it won't cause any workflow regressions :returns: True for "Yes", False for "No" :rtype: bool :raises errors.MissingCommandlineFlag: if called in non-interactive mode without a default set Nr)r0Z yes_labelZno_labelr5r8r2rrryesnoszIDisplay.yesnocCsdS)alAllow for multiple selections from a menu. When not setting force_interactive=True, you must provide a default value. :param str message: message to display to the user :param list tags: where each is of type :class:`str` len(tags) > 0 :param str default: default (non-interactive) state of the checklist :param str cli_flag: to automate choice from the menu, eg "--domains" :param bool force_interactive: True if it's safe to prompt the user because it won't cause any workflow regressions :returns: tuple of the form (code, list_tags) where `code` - int display exit code `list_tags` - list of str tags selected by the user :rtype: tuple :raises errors.MissingCommandlineFlag: if called in non-interactive mode without a default set Nr)r0Ztagsr5r8r2rrr checklistszIDisplay.checklistcCsdS)aDisplay a directory selection screen. When not setting force_interactive=True, you must provide a default value. :param str message: prompt to give the user :param default: the default value to return, if one exists, when using the NoninteractiveDisplay :param str cli_flag: option used to set this value with the CLI, if one exists, to be included in error messages given by NoninteractiveDisplay :param bool force_interactive: True if it's safe to prompt the user because it won't cause any workflow regressions :returns: tuple of the form (`code`, `string`) where `code` - int display exit code `string` - input entered by the user Nr)rr0r5r6r2rrrdirectory_selectszIDisplay.directory_select)TF)NNNNNF)NNF)r:r;NNF)NNF)NNF) r r rrr3r7r9r<r=r>rrrrr/us&     r/c@sFeZdZdZejdZejdZejdZ d ddZ dd Z d S) IReporterz9Interface to collect and display information to the user.z%Used to denote high priority messagesz'Used to denote medium priority messagesz$Used to denote low priority messagesTcCsdS)aRAdds msg to the list of messages to be printed. :param str msg: Message to be displayed to the user. :param int priority: One of HIGH_PRIORITY, MEDIUM_PRIORITY, or LOW_PRIORITY. :param bool on_crash: Whether or not the message should be printed if the program exits abnormally. Nr)rmsgZpriorityZon_crashrrr add_messageszIReporter.add_messagecCsdS)z9Prints messages to the user and clears the message queue.Nrrrrrprint_messagesszIReporter.print_messagesN)T) r r rrrrrZ HIGH_PRIORITYZMEDIUM_PRIORITYZ LOW_PRIORITYrArBrrrrr?s r?c@seZdZdZejddZdS)GenericUpdateraJInterface 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.IInstaller` such as prepare() and restart() cOsdS)aPerform 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: storage.RenewableCert NrrZlineageargskwargsrrrgeneric_updates3szGenericUpdater.generic_updatesN)r r rrrrrGrrrrrC#srCc@seZdZdZejddZdS) RenewDeployeraInterface 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. cOsdS)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 certficate 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: storage.RenewableCert NrrDrrr renew_deployPszRenewDeployer.renew_deployN)r r rrrrrIrrrrrHDs rH)rrZsixZzope.interfacerZ add_metaclassABCMetaobjectrrZ Interfacerrrr#r$r/r?rCrHrrrrs" !7!8Et %