starred/certbot-certbot-2
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-08-02 00:22:28 +02:00
Code Issues Packages Projects Releases Wiki Activity

clean up references to dv_challs and dv_auth

Browse Source
This commit is contained in:
Brad Warren
2016-03-01 15:13:58 -08:00
parent 32c4f80117
commit 8266dde2bb
2 changed files with 50 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files
letsencrypt/auth_handler.py
+32 -32
View File
@@ -20,9 +20,9 @@ logger = logging.getLogger(__name__)
class AuthHandler(object): class AuthHandler(object):
"""ACME Authorization Handler for a client. """ACME Authorization Handler for a client.
:ivar dv_auth: Authenticator capable of solving :ivar auth: Authenticator capable of solving
:class:`~acme.challenges.DVChallenge` types :class:`~acme.challenges.DVChallenge` types
:type dv_auth: :class:`letsencrypt.interfaces.IAuthenticator` :type auth: :class:`letsencrypt.interfaces.IAuthenticator`
:ivar acme.client.Client acme: ACME client API. :ivar acme.client.Client acme: ACME client API.
@@ -31,19 +31,19 @@ class AuthHandler(object):
:ivar dict authzr: ACME Authorization Resource dict where keys are domains :ivar dict authzr: ACME Authorization Resource dict where keys are domains
and values are :class:`acme.messages.AuthorizationResource` and values are :class:`acme.messages.AuthorizationResource`
:ivar list dv_c: DV challenges in the form of :ivar list achalls: DV challenges in the form of
:class:`letsencrypt.achallenges.AnnotatedChallenge` :class:`letsencrypt.achallenges.AnnotatedChallenge`
""" """
def __init__(self, dv_auth, acme, account): def __init__(self, auth, acme, account):
self.dv_auth = dv_auth self.auth = auth
self.acme = acme self.acme = acme
self.account = account self.account = account
self.authzr = dict() self.authzr = dict()
# List must be used to keep responses straight. # List must be used to keep responses straight.
self.dv_c = [] self.achalls = []
def get_authorizations(self, domains, best_effort=False): def get_authorizations(self, domains, best_effort=False):
"""Retrieve all authorizations for challenges. """Retrieve all authorizations for challenges.
@@ -67,12 +67,12 @@ class AuthHandler(object):
self._choose_challenges(domains) self._choose_challenges(domains)
# While there are still challenges remaining... # While there are still challenges remaining...
while self.dv_c: while self.achalls:
dv_resp = self._solve_challenges() resp = self._solve_challenges()
logger.info("Waiting for verification...") logger.info("Waiting for verification...")
# Send all Responses - this modifies dv_c # Send all Responses - this modifies achalls
self._respond(dv_resp, best_effort) self._respond(resp, best_effort)
# Just make sure all decisions are complete. # Just make sure all decisions are complete.
self.verify_authzr_complete() self.verify_authzr_complete()
@@ -89,27 +89,27 @@ class AuthHandler(object):
self._get_chall_pref(dom), self._get_chall_pref(dom),
self.authzr[dom].body.combinations) self.authzr[dom].body.combinations)
dom_dv_c = self._challenge_factory( dom_achalls = self._challenge_factory(
dom, path) dom, path)
self.dv_c.extend(dom_dv_c) self.achalls.extend(dom_achalls)
def _solve_challenges(self): def _solve_challenges(self):
"""Get Responses for challenges from authenticators.""" """Get Responses for challenges from authenticators."""
dv_resp = [] resp = []
with error_handler.ErrorHandler(self._cleanup_challenges): with error_handler.ErrorHandler(self._cleanup_challenges):
try: try:
if self.dv_c: if self.achalls:
dv_resp = self.dv_auth.perform(self.dv_c) resp = self.auth.perform(self.achalls)
except errors.AuthorizationError: except errors.AuthorizationError:
logger.critical("Failure in setting up challenges.") logger.critical("Failure in setting up challenges.")
logger.info("Attempting to clean up outstanding challenges...") logger.info("Attempting to clean up outstanding challenges...")
raise raise
assert len(dv_resp) == len(self.dv_c) assert len(resp) == len(self.achalls)
return dv_resp return resp
def _respond(self, dv_resp, best_effort): def _respond(self, resp, best_effort):
"""Send/Receive confirmation of all challenges. """Send/Receive confirmation of all challenges.
.. note:: This method also cleans up the auth_handler state. .. note:: This method also cleans up the auth_handler state.
@@ -119,13 +119,13 @@ class AuthHandler(object):
chall_update = dict() chall_update = dict()
active_achalls = [] active_achalls = []
active_achalls.extend( active_achalls.extend(
self._send_responses(self.dv_c, dv_resp, chall_update)) self._send_responses(self.achalls, resp, chall_update))
# Check for updated status... # Check for updated status...
try: try:
self._poll_challenges(chall_update, best_effort) self._poll_challenges(chall_update, best_effort)
finally: finally:
# This removes challenges from self.dv_c # This removes challenges from self.achalls
self._cleanup_challenges(active_achalls) self._cleanup_challenges(active_achalls)
def _send_responses(self, achalls, resps, chall_update): def _send_responses(self, achalls, resps, chall_update):
@@ -239,7 +239,7 @@ class AuthHandler(object):
""" """
# Make sure to make a copy... # Make sure to make a copy...
chall_prefs = [] chall_prefs = []
chall_prefs.extend(self.dv_auth.get_chall_pref(domain)) chall_prefs.extend(self.auth.get_chall_pref(domain))
return chall_prefs return chall_prefs
def _cleanup_challenges(self, achall_list=None): def _cleanup_challenges(self, achall_list=None):
@@ -251,15 +251,15 @@ class AuthHandler(object):
logger.info("Cleaning up challenges") logger.info("Cleaning up challenges")
if achall_list is None: if achall_list is None:
dv_c = self.dv_c achalls = self.achalls
else: else:
dv_c = [achall for achall in achall_list achalls = [achall for achall in achall_list
if isinstance(achall.chall, challenges.DVChallenge)] if isinstance(achall.chall, challenges.DVChallenge)]
if dv_c: if achalls:
self.dv_auth.cleanup(dv_c) self.auth.cleanup(achalls)
for achall in dv_c: for achall in achalls:
self.dv_c.remove(achall) self.achalls.remove(achall)
def verify_authzr_complete(self): def verify_authzr_complete(self):
"""Verifies that all authorizations have been decided. """Verifies that all authorizations have been decided.
@@ -280,14 +280,14 @@ class AuthHandler(object):
:param list path: List of indices from `challenges`. :param list path: List of indices from `challenges`.
:returns: dv_chall, list of DVChallenge type :returns: achalls, list of DVChallenge type
:class:`letsencrypt.achallenges.Indexed` :class:`letsencrypt.achallenges.Indexed`
:rtype: list :rtype: list
:raises .errors.Error: if challenge type is not recognized :raises .errors.Error: if challenge type is not recognized
""" """
dv_chall = [] achalls = []
for index in path: for index in path:
challb = self.authzr[domain].body.challenges[index] challb = self.authzr[domain].body.challenges[index]
@@ -296,9 +296,9 @@ class AuthHandler(object):
achall = challb_to_achall(challb, self.account.key, domain) achall = challb_to_achall(challb, self.account.key, domain)
if isinstance(chall, challenges.DVChallenge): if isinstance(chall, challenges.DVChallenge):
dv_chall.append(achall) achalls.append(achall)
return dv_chall return achalls
def challb_to_achall(challb, account_key, domain): def challb_to_achall(challb, account_key, domain):
letsencrypt/tests/auth_handler_test.py
+18 -17
View File
@@ -31,16 +31,17 @@ class ChallengeFactoryTest(unittest.TestCase):
[messages.STATUS_PENDING] * 6, False) [messages.STATUS_PENDING] * 6, False)
def test_all(self): def test_all(self):
dv_c = self.handler._challenge_factory( achalls = self.handler._challenge_factory(
self.dom, range(0, len(acme_util.CHALLENGES))) self.dom, range(0, len(acme_util.CHALLENGES)))
self.assertEqual( self.assertEqual(
[achall.chall for achall in dv_c], acme_util.DV_CHALLENGES) [achall.chall for achall in achalls], acme_util.DV_CHALLENGES)
def test_one_dv(self): def test_one_tls_sni(self):
dv_c = self.handler._challenge_factory(self.dom, [1, 3]) achalls = self.handler._challenge_factory(self.dom, [1, 3])
self.assertEqual([achall.chall for achall in dv_c], [acme_util.TLSSNI01]) self.assertEqual(
[achall.chall for achall in achalls], [acme_util.TLSSNI01])
def test_unrecognized(self): def test_unrecognized(self):
self.handler.authzr["failure.com"] = acme_util.gen_authzr( self.handler.authzr["failure.com"] = acme_util.gen_authzr(
@@ -62,17 +63,17 @@ class GetAuthorizationsTest(unittest.TestCase):
def setUp(self): def setUp(self):
from letsencrypt.auth_handler import AuthHandler from letsencrypt.auth_handler import AuthHandler
self.mock_dv_auth = mock.MagicMock(name="ApacheConfigurator") self.mock_auth = mock.MagicMock(name="ApacheConfigurator")
self.mock_dv_auth.get_chall_pref.return_value = [challenges.TLSSNI01] self.mock_auth.get_chall_pref.return_value = [challenges.TLSSNI01]
self.mock_dv_auth.perform.side_effect = gen_auth_resp self.mock_auth.perform.side_effect = gen_auth_resp
self.mock_account = mock.Mock(key=le_util.Key("file_path", "PEM")) self.mock_account = mock.Mock(key=le_util.Key("file_path", "PEM"))
self.mock_net = mock.MagicMock(spec=acme_client.Client) self.mock_net = mock.MagicMock(spec=acme_client.Client)
self.handler = AuthHandler( self.handler = AuthHandler(
self.mock_dv_auth, self.mock_net, self.mock_account) self.mock_auth, self.mock_net, self.mock_account)
logging.disable(logging.CRITICAL) logging.disable(logging.CRITICAL)
@@ -95,10 +96,10 @@ class GetAuthorizationsTest(unittest.TestCase):
self.assertEqual(chall_update.keys(), ["0"]) self.assertEqual(chall_update.keys(), ["0"])
self.assertEqual(len(chall_update.values()), 1) self.assertEqual(len(chall_update.values()), 1)
self.assertEqual(self.mock_dv_auth.cleanup.call_count, 1) self.assertEqual(self.mock_auth.cleanup.call_count, 1)
# Test if list first element is TLSSNI01, use typ because it is an achall # Test if list first element is TLSSNI01, use typ because it is an achall
self.assertEqual( self.assertEqual(
self.mock_dv_auth.cleanup.call_args[0][0][0].typ, "tls-sni-01") self.mock_auth.cleanup.call_args[0][0][0].typ, "tls-sni-01")
self.assertEqual(len(authzr), 1) self.assertEqual(len(authzr), 1)
@@ -108,8 +109,8 @@ class GetAuthorizationsTest(unittest.TestCase):
gen_dom_authzr, challs=acme_util.DV_CHALLENGES, combos=False) gen_dom_authzr, challs=acme_util.DV_CHALLENGES, combos=False)
mock_poll.side_effect = self._validate_all mock_poll.side_effect = self._validate_all
self.mock_dv_auth.get_chall_pref.return_value.append(challenges.HTTP01) self.mock_auth.get_chall_pref.return_value.append(challenges.HTTP01)
self.mock_dv_auth.get_chall_pref.return_value.append(challenges.DNS) self.mock_auth.get_chall_pref.return_value.append(challenges.DNS)
authzr = self.handler.get_authorizations(["0"]) authzr = self.handler.get_authorizations(["0"])
@@ -120,9 +121,9 @@ class GetAuthorizationsTest(unittest.TestCase):
self.assertEqual(chall_update.keys(), ["0"]) self.assertEqual(chall_update.keys(), ["0"])
self.assertEqual(len(chall_update.values()), 1) self.assertEqual(len(chall_update.values()), 1)
self.assertEqual(self.mock_dv_auth.cleanup.call_count, 1) self.assertEqual(self.mock_auth.cleanup.call_count, 1)
# Test if list first element is TLSSNI01, use typ because it is an achall # Test if list first element is TLSSNI01, use typ because it is an achall
for achall in self.mock_dv_auth.cleanup.call_args[0][0]: for achall in self.mock_auth.cleanup.call_args[0][0]:
self.assertTrue(achall.typ in ["tls-sni-01", "http-01", "dns"]) self.assertTrue(achall.typ in ["tls-sni-01", "http-01", "dns"])
self.assertEqual(len(authzr), 1) self.assertEqual(len(authzr), 1)
@@ -149,14 +150,14 @@ class GetAuthorizationsTest(unittest.TestCase):
self.assertTrue("2" in chall_update.keys()) self.assertTrue("2" in chall_update.keys())
self.assertEqual(len(chall_update["2"]), 1) self.assertEqual(len(chall_update["2"]), 1)
self.assertEqual(self.mock_dv_auth.cleanup.call_count, 1) self.assertEqual(self.mock_auth.cleanup.call_count, 1)
self.assertEqual(len(authzr), 3) self.assertEqual(len(authzr), 3)
def test_perform_failure(self): def test_perform_failure(self):
self.mock_net.request_domain_challenges.side_effect = functools.partial( self.mock_net.request_domain_challenges.side_effect = functools.partial(
gen_dom_authzr, challs=acme_util.DV_CHALLENGES) gen_dom_authzr, challs=acme_util.DV_CHALLENGES)
self.mock_dv_auth.perform.side_effect = errors.AuthorizationError self.mock_auth.perform.side_effect = errors.AuthorizationError
self.assertRaises( self.assertRaises(
errors.AuthorizationError, self.handler.get_authorizations, ["0"]) errors.AuthorizationError, self.handler.get_authorizations, ["0"])