Merge pull request #1568 from erikrose/kill-dvsni

Remove remaining "DVSNI" wording, changing it to reference TLS-SNI-01, which it changed into.

letsencrypt-nginx/letsencrypt_nginx/configurator.py

@@ -24,7 +24,7 @@ from letsencrypt import reverter
 from letsencrypt.plugins import common
 
 from letsencrypt_nginx import constants
-from letsencrypt_nginx import dvsni
+from letsencrypt_nginx import tls_sni_01
 from letsencrypt_nginx import obj
 from letsencrypt_nginx import parser
 
@@ -379,11 +379,12 @@ class NginxConfigurator(common.Plugin):
         :param unused_options: Not currently used
         :type unused_options: Not Available
         """
-        redirect_block = [[['if', '($scheme != "https")'],
+        redirect_block = [[
+            ['if', '($scheme != "https")'],
             [['return', '301 https://$host$request_uri']]
         ]]
-        self.parser.add_server_directives(vhost.filep, vhost.names,
-            redirect_block)
+        self.parser.add_server_directives(
+            vhost.filep, vhost.names, redirect_block)
         logger.info("Redirecting all traffic to ssl in %s", vhost.filep)
 
     ######################################
@@ -573,15 +574,15 @@ class NginxConfigurator(common.Plugin):
         """
         self._chall_out += len(achalls)
         responses = [None] * len(achalls)
-        nginx_dvsni = dvsni.NginxDvsni(self)
+        chall_doer = tls_sni_01.NginxTlsSni01(self)
 
         for i, achall in enumerate(achalls):
-            # Currently also have dvsni hold associated index
-            # of the challenge. This helps to put all of the responses back
-            # together when they are all complete.
-            nginx_dvsni.add_chall(achall, i)
+            # Currently also have chall_doer hold associated index of the
+            # challenge. This helps to put all of the responses back together
+            # when they are all complete.
+            chall_doer.add_chall(achall, i)
 
-        sni_response = nginx_dvsni.perform()
+        sni_response = chall_doer.perform()
         # Must restart in order to activate the challenges.
         # Handled here because we may be able to load up other challenge types
         self.restart()
@@ -590,7 +591,7 @@ class NginxConfigurator(common.Plugin):
         # in the responses return value. All responses must be in the same order
         # as the original challenges.
         for i, resp in enumerate(sni_response):
-            responses[nginx_dvsni.indices[i]] = resp
+            responses[chall_doer.indices[i]] = resp
 
         return responses
 

letsencrypt-nginx/letsencrypt_nginx/parser.py

@@ -413,7 +413,7 @@ def _regex_match(target_name, name):
             return True
         else:
             return False
-    except re.error: # pragma: no cover
+    except re.error:  # pragma: no cover
         # perl-compatible regexes are sometimes not recognized by python
         return False
 

letsencrypt-nginx/letsencrypt_nginx/tests/configurator_test.py

@@ -212,9 +212,9 @@ class NginxConfiguratorTest(util.NginxTest):
             ('/etc/nginx/fullchain.pem', '/etc/nginx/key.pem', nginx_conf),
         ]), self.config.get_all_certs_keys())
 
-    @mock.patch("letsencrypt_nginx.configurator.dvsni.NginxDvsni.perform")
+    @mock.patch("letsencrypt_nginx.configurator.tls_sni_01.NginxTlsSni01.perform")
     @mock.patch("letsencrypt_nginx.configurator.NginxConfigurator.restart")
-    def test_perform(self, mock_restart, mock_dvsni_perform):
+    def test_perform(self, mock_restart, mock_perform):
         # Only tests functionality specific to configurator.perform
         # Note: As more challenges are offered this will have to be expanded
         achall1 = achallenges.KeyAuthorizationAnnotatedChallenge(
@@ -230,16 +230,16 @@ class NginxConfiguratorTest(util.NginxTest):
                 status=messages.Status("pending"),
             ), domain="example.com", account_key=self.rsa512jwk)
 
-        dvsni_ret_val = [
+        expected = [
             achall1.response(self.rsa512jwk),
             achall2.response(self.rsa512jwk),
         ]
 
-        mock_dvsni_perform.return_value = dvsni_ret_val
+        mock_perform.return_value = expected
         responses = self.config.perform([achall1, achall2])
 
-        self.assertEqual(mock_dvsni_perform.call_count, 1)
-        self.assertEqual(responses, dvsni_ret_val)
+        self.assertEqual(mock_perform.call_count, 1)
+        self.assertEqual(responses, expected)
         self.assertEqual(mock_restart.call_count, 1)
 
     @mock.patch("letsencrypt_nginx.configurator.subprocess.Popen")

letsencrypt-nginx/letsencrypt_nginx/tests/tls_sni_01_test.py

@@ -1,4 +1,4 @@
-"""Test for letsencrypt_nginx.dvsni."""
+"""Tests for letsencrypt_nginx.tls_sni_01"""
 import unittest
 import shutil
 
@@ -16,8 +16,8 @@ from letsencrypt_nginx import obj
 from letsencrypt_nginx.tests import util
 
 
-class DvsniPerformTest(util.NginxTest):
-    """Test the NginxDVSNI challenge."""
+class TlsSniPerformTest(util.NginxTest):
+    """Test the NginxTlsSni01 challenge."""
 
     account_key = common_test.TLSSNI01Test.auth_key
     achalls = [
@@ -42,13 +42,13 @@ class DvsniPerformTest(util.NginxTest):
     ]
 
     def setUp(self):
-        super(DvsniPerformTest, self).setUp()
+        super(TlsSniPerformTest, self).setUp()
 
         config = util.get_nginx_configurator(
             self.config_path, self.config_dir, self.work_dir)
 
-        from letsencrypt_nginx import dvsni
-        self.sni = dvsni.NginxDvsni(config)
+        from letsencrypt_nginx import tls_sni_01
+        self.sni = tls_sni_01.NginxTlsSni01(config)
 
     def tearDown(self):
         shutil.rmtree(self.temp_dir)

letsencrypt-nginx/letsencrypt_nginx/tests/util.py

@@ -50,7 +50,7 @@ def get_nginx_configurator(
     backups = os.path.join(work_dir, "backups")
 
     with mock.patch("letsencrypt_nginx.configurator.le_util."
-            "exe_exists") as mock_exe_exists:
+                    "exe_exists") as mock_exe_exists:
         mock_exe_exists.return_value = True
 
         config = configurator.NginxConfigurator(

letsencrypt-nginx/letsencrypt_nginx/tls_sni_01.py

@@ -1,4 +1,5 @@
-"""NginxDVSNI"""
+"""A class that performs TLS-SNI-01 challenges for Nginx"""
+
 import itertools
 import logging
 import os
@@ -13,31 +14,32 @@ from letsencrypt_nginx import nginxparser
 logger = logging.getLogger(__name__)
 
 
-class NginxDvsni(common.TLSSNI01):
-    """Class performs DVSNI challenges within the Nginx configurator.
+class NginxTlsSni01(common.TLSSNI01):
+    """TLS-SNI-01 authenticator for Nginx
 
     :ivar configurator: NginxConfigurator object
     :type configurator: :class:`~nginx.configurator.NginxConfigurator`
 
-    :ivar list achalls: Annotated :class:`~letsencrypt.achallenges.DVSNI`
-        challenges.
+    :ivar list achalls: Annotated
+        class:`~letsencrypt.achallenges.KeyAuthorizationAnnotatedChallenge`
+        challenges
 
     :param list indices: Meant to hold indices of challenges in a
-        larger array. NginxDvsni is capable of solving many challenges
+        larger array. NginxTlsSni01 is capable of solving many challenges
         at once which causes an indexing issue within NginxConfigurator
         who must return all responses in order.  Imagine NginxConfigurator
         maintaining state about where all of the http-01 Challenges,
-        Dvsni Challenges belong in the response array.  This is an optional
-        utility.
+        TLS-SNI-01 Challenges belong in the response array.  This is an
+        optional utility.
 
     :param str challenge_conf: location of the challenge config file
 
     """
 
     def perform(self):
-        """Perform a DVSNI challenge on Nginx.
+        """Perform a challenge on Nginx.
 
-        :returns: list of :class:`letsencrypt.acme.challenges.DVSNIResponse`
+        :returns: list of :class:`letsencrypt.acme.challenges.TLSSNI01Response`
         :rtype: list
 
         """
@@ -84,7 +86,8 @@ class NginxDvsni(common.TLSSNI01):
             :class:`letsencrypt_nginx.obj.Addr` to apply
 
         :raises .MisconfigurationError:
-            Unable to find a suitable HTTP block to include DVSNI hosts.
+            Unable to find a suitable HTTP block in which to include
+            authenticator hosts.
 
         """
         # Add the 'include' statement for the challenges if it doesn't exist
@@ -110,8 +113,8 @@ class NginxDvsni(common.TLSSNI01):
                 break
         if not included:
             raise errors.MisconfigurationError(
-                'LetsEncrypt could not find an HTTP block to include DVSNI '
-                'challenges in %s.' % root)
+                'LetsEncrypt could not find an HTTP block to include '
+                'TLS-SNI-01 challenges in %s.' % root)
 
         config = [self._make_server_block(pair[0], pair[1])
                   for pair in itertools.izip(self.achalls, ll_addrs)]
@@ -123,10 +126,11 @@ class NginxDvsni(common.TLSSNI01):
             nginxparser.dump(config, new_conf)
 
     def _make_server_block(self, achall, addrs):
-        """Creates a server block for a DVSNI challenge.
+        """Creates a server block for a challenge.
 
-        :param achall: Annotated DVSNI challenge.
-        :type achall: :class:`letsencrypt.achallenges.DVSNI`
+        :param achall: Annotated TLS-SNI-01 challenge
+        :type achall:
+            :class:`letsencrypt.achallenges.KeyAuthorizationAnnotatedChallenge`
 
         :param list addrs: addresses of challenged domain
             :class:`list` of type :class:`~nginx.obj.Addr`
@@ -136,7 +140,7 @@ class NginxDvsni(common.TLSSNI01):
 
         """
         document_root = os.path.join(
-            self.configurator.config.work_dir, "dvsni_page")
+            self.configurator.config.work_dir, "tls_sni_01_page")
 
         block = [['listen', str(addr)] for addr in addrs]