zope.interface

docs/api/client/configurator.rst

@@ -1,5 +0,0 @@
-:mod:`letsencrypt.client.configurator`
---------------------------------------
-
-.. automodule:: letsencrypt.client.configurator
-   :members:

docs/api/client/interfaces.rst

@@ -0,0 +1,5 @@
+:mod:`letsencrypt.client.interfaces`
+------------------------------------
+
+.. automodule:: letsencrypt.client.interfaces
+   :members:

docs/api/client/validator.rst

@@ -1,5 +0,0 @@
-:mod:`letsencrypt.client.validator`
------------------------------------
-
-.. automodule:: letsencrypt.client.validator
-   :members:

letsencrypt/client/augeas_configurator.py

@@ -6,13 +6,14 @@ import shutil
 import time
 
 import augeas
+import zope.interface
 
 from letsencrypt.client import CONFIG
-from letsencrypt.client import configurator
+from letsencrypt.client import interfaces
 from letsencrypt.client import le_util
 
 
-class AugeasConfigurator(configurator.Configurator):
+class AugeasConfigurator(object):
     """Base Augeas Configurator class.
 
     .. todo:: Fix generic exception handling.
@@ -24,6 +25,7 @@ class AugeasConfigurator(configurator.Configurator):
     :ivar dict direc: dictionary containing save directory paths
 
     """
+    zope.interface.implements(interfaces.IConfigurator)
 
     def __init__(self, direc=None):
         """Initialize Augeas Configurator.

letsencrypt/client/challenge.py

@@ -5,29 +5,6 @@ import sys
 from letsencrypt.client import CONFIG
 
 
-class Challenge(object):
-    """Let's Encrypt challenge."""
-
-    def __init__(self, configurator):
-        self.config = configurator
-
-    def perform(self, quiet=True):
-        """Perform the challange.
-
-        :param bool quiet: TODO
-
-        """
-        raise NotImplementedError()
-
-    def generate_response(self):
-        """Generate response."""
-        raise NotImplementedError()
-
-    def cleanup(self):
-        """Cleanup."""
-        raise NotImplementedError()
-
-
 def gen_challenge_path(challenges, combos=None):
     """Generate a plan to get authority over the identity.
 
@@ -101,13 +78,13 @@ def _find_smart_path(challenges, combos):
 
 
 def _find_dumb_path(challenges):
-    """Find challange path without server hints.
+    """Find challenge path without server hints.
 
     Should be called if the combinations hint is not included by the
     server. This function returns the best path that does not contain
     multiple mutually exclusive challenges.
 
-    :param list challanges: A list of challenges from ACME "challenge"
+    :param list challenges: A list of challenges from ACME "challenge"
         server message to be fulfilled by the client in order to prove
         possession of the identifier.
 

letsencrypt/client/interactive_challenge.py

@@ -1,12 +1,13 @@
 import textwrap
 
 import dialog
+import zope.interface
 
-from letsencrypt.client import challenge
+from letsencrypt.client import interfaces
 
 
-class InteractiveChallenge(challenge.Challenge):
-    """Interactive challange.
+class InteractiveChallenge(object):
+    """Interactive challenge.
 
     Interactive challenge displays the string sent by the CA formatted
     to fit on the screen of the client. The Challenge also adds proper
@@ -14,9 +15,12 @@ class InteractiveChallenge(challenge.Challenge):
     process.
 
     """
+    zope.interface.implements(interfaces.IChallenge)
+
     BOX_SIZE = 70
 
     def __init__(self, string):
+        super(InteractiveChallenge, self).__init__()
         self.string = string
 
     def perform(self, quiet=True):

letsencrypt/client/interfaces.py

@@ -1,16 +1,36 @@
-"""Configurator."""
+"""Let's Encrypt client interfaces."""
+import zope.interface
+
+# pylint: disable=no-self-argument,no-method-argument
+
+class IChallenge(zope.interface.Interface):
+    """Let's Encrypt challenge."""
+
+    def perform(quiet=True):
+        """Perform the challenge.
+
+        :param bool quiet: TODO
+
+        """
+
+    def generate_response():
+        """Generate response."""
+
+    def cleanup():
+        """Cleanup."""
 
 
-class Configurator(object):
+class IConfigurator(zope.interface.Interface):
     """Generic Let's Encrypt configurator.
 
     Class represents all possible webservers and configuration editors
     This includes the generic webserver which wont have configuration
     files at all, but instead create a new process to handle the DVSNI
     and other challenges.
+
     """
 
-    def deploy_cert(self, vhost, cert, key, cert_chain=None):
+    def deploy_cert(vhost, cert, key, cert_chain=None):
         """Deploy certificate.
 
         :param vhost
@@ -18,42 +38,34 @@ class Configurator(object):
         :param str key: Private key
 
         """
-        raise NotImplementedError()
 
-    def choose_virtual_host(self, name):
+    def choose_virtual_host(name):
         """Chooses a virtual host based on a given domain name."""
-        raise NotImplementedError()
 
-    def get_all_names(self):
+    def get_all_names():
         """Returns all names found in the configuration."""
-        raise NotImplementedError()
 
-    def enable_redirect(self, ssl_vhost):
+    def enable_redirect(ssl_vhost):
         """Redirect all traffic to the given ssl_vhost (port 80 => 443)."""
-        raise NotImplementedError()
 
-    def enable_hsts(self, ssl_vhost):
+    def enable_hsts(ssl_vhost):
         """Enable HSTS on the given ssl_vhost."""
-        raise NotImplementedError()
 
-    def enable_ocsp_stapling(self, ssl_vhost):
+    def enable_ocsp_stapling(ssl_vhost):
         """Enable OCSP stapling on given ssl_vhost."""
-        raise NotImplementedError()
 
-    def get_all_certs_keys(self):
+    def get_all_certs_keys():
         """Retrieve all certs and keys set in configuration.
 
         :returns: List of tuples with form [(cert, key, path)].
         :rtype: list
 
         """
-        raise NotImplementedError()
 
-    def enable_site(self, vhost):
+    def enable_site(vhost):
         """Enable the site at the given vhost."""
-        raise NotImplementedError()
 
-    def save(self, title=None, temporary=False):
+    def save(title=None, temporary=False):
         """Saves all changes to the configuration files.
 
         Both title and temporary are needed because a save may be
@@ -66,33 +78,42 @@ class Configurator(object):
 
         :param bool temporary: Indicates whether the changes made will
             be quickly reversed in the future (challenges)
+
         """
-        raise NotImplementedError()
 
-    def revert_challenge_config(self):
+    def revert_challenge_config():
         """Reload the users original configuration files."""
-        raise NotImplementedError()
 
-    def rollback_checkpoints(self, rollback=1):
+    def rollback_checkpoints(rollback=1):
         """Revert `rollback` number of configuration checkpoints."""
-        raise NotImplementedError()
 
-    def display_checkpoints(self):
+    def display_checkpoints():
         """Display the saved configuration checkpoints."""
-        raise NotImplementedError()
 
-    def config_test(self):
+    def config_test():
         """Make sure the configuration is valid."""
-        raise NotImplementedError()
 
-    def restart(self, quiet=False):
+    def restart(quiet=False):
         """Restart or refresh the server content."""
-        raise NotImplementedError()
 
-    def perform(self, chall_dict):
+    def perform(chall_dict):
         """Perform the given challenge"""
-        raise NotImplementedError()
 
-    def cleanup(self):
+    def cleanup():
         """Cleanup configuration changes from challenge."""
-        raise NotImplementedError()
+
+
+class IValidator(object):
+    """Configuration validator."""
+
+    def redirect(name):
+        pass
+
+    def ocsp_stapling(name):
+        pass
+
+    def https(names):
+        pass
+
+    def hsts(name):
+        pass

letsencrypt/client/recovery_contact_challenge.py

@@ -8,19 +8,22 @@ import time
 
 import dialog
 import requests
+import zope.interface
 
-from letsencrypt.client import challenge
+from letsencrypt.client import interfaces
 
 
-class RecoveryContact(challenge.Challenge):
-    """Recovery Contact Identitifier Validation Challange.
+class RecoveryContact(object):
+    """Recovery Contact Identitifier Validation Challenge.
 
     Based on draft-barnes-acme, section 6.3.
 
     """
+    zope.interface.implements(interfaces.IChallenge)
 
     def __init__(self, activation_url="", success_url="", contact="",
                  poll_delay=3):
+        super(RecoveryContact, self).__init__()
         self.token = ""
         self.activation_url = activation_url
         self.success_url = success_url

letsencrypt/client/recovery_token_challenge.py

@@ -3,20 +3,22 @@
 .. note:: This challenge has not been implemented into the project yet
 
 """
-import display
+import zope.interface
 
-from letsencrypt.client import challenge
+from letsencrypt.client import display
+from letsencrypt.client import interfaces
 
 
-class RecoveryToken(challenge.Challenge):
+class RecoveryToken(object):
     """Recovery Token Identifier Validation Challenge.
 
     Based on draft-barnes-acme, section 6.4.
 
     """
+    zope.interface.implements(interfaces.IChallenge)
 
-    def __init__(self, configurator):
-        super(RecoveryToken, self).__init__(configurator)
+    def __init__(self):
+        super(RecoveryToken, self).__init__()
         self.token = ""
 
     def perform(self, quiet=True):

letsencrypt/client/validator.py

@@ -1,14 +0,0 @@
-class Validator(object):
-    """Configuration validator."""
-
-    def redirect(self, name):
-        raise NotImplementedError()
-
-    def ocsp_stapling(self, name):
-        raise NotImplementedError()
-
-    def https(self, names):
-        raise NotImplementedError()
-
-    def hsts(self, name):
-        raise NotImplementedError()

setup.py

@@ -11,6 +11,7 @@ install_requires = [
     'python-augeas',
     'python2-pythondialog',
     'requests',
+    'zope.interface',
 ]
 
 docs_extras = [