mirror of
https://github.com/certbot/certbot.git
synced 2026-01-27 19:42:53 +03:00
4a8e35289c
The base class for Installer plugins `certbot.plugins.common.Installer` now provides functionality of `PluginStorage` to all installer plugins. This allows a plugin to save and retrieve variables in between of invocations.
The on disk storage is basically a JSON file at `config_dir`/`.pluginstorage.json`, usually `/etc/letsencrypt/.pluginstorage.json`. The JSON structure is automatically namespaced using the internal plugin name as a namespace key. Because the actual storage is JSON, the supported data types are: dict, list, tuple, str, unicode, int, long, float, boolean and nonetype.
To add a variable from inside the plugin class:
`self.storage.put("my_variable_name", my_var)`
To fetch a variable from inside the plugin class:
`my_var = self.storage.fetch("my_variable_key")`
The storage state isn't written on disk automatically, but needs to be called:
`self.storage.save()`
* Plugin storage implementation
* Added config_dir to existing test mocks
* PluginStorage test cases
* Saner handling of bad config_dir paths
* Storage moved to Installer and not initialized on plugin __init__
* Finetuning and renaming
111 lines
2.6 KiB
Python
111 lines
2.6 KiB
Python
"""Certbot client errors."""
|
|
|
|
|
|
class Error(Exception):
|
|
"""Generic Certbot client error."""
|
|
|
|
|
|
class AccountStorageError(Error):
|
|
"""Generic `.AccountStorage` error."""
|
|
|
|
|
|
class AccountNotFound(AccountStorageError):
|
|
"""Account not found error."""
|
|
|
|
|
|
class ReverterError(Error):
|
|
"""Certbot Reverter error."""
|
|
|
|
|
|
class SubprocessError(Error):
|
|
"""Subprocess handling error."""
|
|
|
|
|
|
class CertStorageError(Error):
|
|
"""Generic `.CertStorage` error."""
|
|
|
|
|
|
class HookCommandNotFound(Error):
|
|
"""Failed to find a hook command in the PATH."""
|
|
|
|
|
|
class SignalExit(Error):
|
|
"""A Unix signal was received while in the ErrorHandler context manager."""
|
|
|
|
class OverlappingMatchFound(Error):
|
|
"""Multiple lineages matched what should have been a unique result."""
|
|
|
|
class LockError(Error):
|
|
"""File locking error."""
|
|
|
|
|
|
# Auth Handler Errors
|
|
class AuthorizationError(Error):
|
|
"""Authorization error."""
|
|
|
|
|
|
class FailedChallenges(AuthorizationError):
|
|
"""Failed challenges error.
|
|
|
|
:ivar set failed_achalls: Failed `.AnnotatedChallenge` instances.
|
|
|
|
"""
|
|
def __init__(self, failed_achalls):
|
|
assert failed_achalls
|
|
self.failed_achalls = failed_achalls
|
|
super(FailedChallenges, self).__init__()
|
|
|
|
def __str__(self):
|
|
return "Failed authorization procedure. {0}".format(
|
|
", ".join(
|
|
"{0} ({1}): {2}".format(achall.domain, achall.typ, achall.error)
|
|
for achall in self.failed_achalls if achall.error is not None))
|
|
|
|
|
|
# Plugin Errors
|
|
class PluginError(Error):
|
|
"""Certbot Plugin error."""
|
|
|
|
|
|
class PluginEnhancementAlreadyPresent(Error):
|
|
""" Enhancement was already set """
|
|
|
|
|
|
class PluginSelectionError(Error):
|
|
"""A problem with plugin/configurator selection or setup"""
|
|
|
|
|
|
class NoInstallationError(PluginError):
|
|
"""Certbot No Installation error."""
|
|
|
|
|
|
class MisconfigurationError(PluginError):
|
|
"""Certbot Misconfiguration error."""
|
|
|
|
|
|
class NotSupportedError(PluginError):
|
|
"""Certbot Plugin function not supported error."""
|
|
|
|
|
|
class PluginStorageError(PluginError):
|
|
"""Certbot Plugin Storage error."""
|
|
|
|
|
|
class StandaloneBindError(Error):
|
|
"""Standalone plugin bind error."""
|
|
|
|
def __init__(self, socket_error, port):
|
|
super(StandaloneBindError, self).__init__(
|
|
"Problem binding to port {0}: {1}".format(port, socket_error))
|
|
self.socket_error = socket_error
|
|
self.port = port
|
|
|
|
|
|
class ConfigurationError(Error):
|
|
"""Configuration sanity error."""
|
|
|
|
# NoninteractiveDisplay iDisplay plugin error:
|
|
|
|
class MissingCommandlineFlag(Error):
|
|
"""A command line argument was missing in noninteractive usage"""
|