Skip to content

Commit 7210806

Browse files
author
http://j3h.us/
committed
[project @ Fix openid#60 (passing return_to to consumer.complete() causes spurious failure when mode is not id_res)]
1 parent 62e647f commit 7210806

2 files changed

Lines changed: 47 additions & 48 deletions

File tree

‎openid/consumer/consumer.py‎

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -613,45 +613,40 @@ def complete(self, message, endpoint, return_to=None):
613613
"""
614614
mode = message.getArg(OPENID_NS, 'mode', '<No mode set>')
615615

616-
if return_to is not None:
617-
if not self._checkReturnTo(message, return_to):
618-
return FailureResponse(endpoint,
619-
"openid.return_to does not match return URL")
620-
621616
modeMethod = getattr(self, '_complete_' + mode,
622617
self._completeInvalid)
623618

624-
return modeMethod(message, endpoint)
619+
return modeMethod(message, endpoint, return_to)
625620

626-
def _complete_cancel(self, message, endpoint):
621+
def _complete_cancel(self, message, endpoint, _):
627622
return CancelResponse(endpoint)
628623

629-
def _complete_error(self, message, endpoint):
624+
def _complete_error(self, message, endpoint, _):
630625
error = message.getArg(OPENID_NS, 'error')
631626
contact = message.getArg(OPENID_NS, 'contact')
632627
reference = message.getArg(OPENID_NS, 'reference')
633628

634629
return FailureResponse(endpoint, error, contact=contact,
635630
reference=reference)
636631

637-
def _complete_setup_needed(self, message, endpoint):
632+
def _complete_setup_needed(self, message, endpoint, _):
638633
if not message.isOpenID2():
639-
return self._completeInvalid(message, endpoint)
634+
return self._completeInvalid(message, endpoint, _)
640635

641636
return SetupNeededResponse(endpoint)
642637

643-
def _complete_id_res(self, message, endpoint):
638+
def _complete_id_res(self, message, endpoint, return_to):
644639
try:
645640
self._checkSetupNeeded(message)
646641
except SetupNeededError, why:
647642
return SetupNeededResponse(endpoint, why.user_setup_url)
648643
else:
649644
try:
650-
return self._doIdRes(message, endpoint)
645+
return self._doIdRes(message, endpoint, return_to)
651646
except (ProtocolError, DiscoveryFailure), why:
652647
return FailureResponse(endpoint, why[0])
653648

654-
def _completeInvalid(self, message, endpoint):
649+
def _completeInvalid(self, message, endpoint, _):
655650
mode = message.getArg(OPENID_NS, 'mode', '<No mode set>')
656651
return FailureResponse(endpoint,
657652
'Invalid openid.mode: %r' % (mode,))
@@ -701,7 +696,7 @@ def _checkSetupNeeded(self, message):
701696
if user_setup_url is not None:
702697
raise SetupNeededError(user_setup_url)
703698

704-
def _doIdRes(self, message, endpoint):
699+
def _doIdRes(self, message, endpoint, return_to):
705700
"""Handle id_res responses that are not cancellations of
706701
immediate mode requests.
707702
@@ -720,15 +715,16 @@ def _doIdRes(self, message, endpoint):
720715
721716
@returntype: L{Response}
722717
"""
723-
signed_list_str = message.getArg(OPENID_NS, 'signed')
724-
if signed_list_str is None:
725-
raise ProtocolError("Response missing signed list")
726-
727-
signed_list = signed_list_str.split(',')
728-
729718
# Checks for presence of appropriate fields (and checks
730719
# signed list fields)
731-
self._idResCheckForFields(message, signed_list)
720+
self._idResCheckForFields(message)
721+
722+
if (return_to is not None and
723+
not self._checkReturnTo(message, return_to)):
724+
raise ProtocolError(
725+
"return_to does not match return URL. Expected %r, got %r"
726+
% (return_to, message.getArg(OPENID_NS, 'return_to')))
727+
732728

733729
# Verify discovery information:
734730
endpoint = self._verifyDiscoveryResults(message, endpoint)
@@ -740,6 +736,8 @@ def _doIdRes(self, message, endpoint):
740736
# Will raise a ProtocolError if the nonce is bad
741737
self._idResCheckNonce(message, endpoint)
742738

739+
signed_list_str = message.getArg(OPENID_NS, 'signed', no_default)
740+
signed_list = signed_list_str.split(',')
743741
signed_fields = ["openid." + s for s in signed_list]
744742
return SuccessResponse(endpoint, message, signed_fields)
745743

@@ -804,14 +802,14 @@ def _idResCheckSignature(self, message, server_url):
804802
if not self._checkAuth(message, server_url):
805803
raise ProtocolError('Server denied check_authentication')
806804

807-
def _idResCheckForFields(self, message, signed_list):
805+
def _idResCheckForFields(self, message):
808806
# XXX: this should be handled by the code that processes the
809807
# response (that is, if a field is missing, we should not have
810808
# to explicitly check that it's present, just make sure that
811809
# the fields are actually being used by the rest of the code
812810
# in tests). Although, which fields are signed does need to be
813811
# checked somewhere.
814-
basic_fields = ['return_to', 'assoc_handle', 'sig']
812+
basic_fields = ['return_to', 'assoc_handle', 'sig', 'signed']
815813
basic_sig_fields = ['return_to', 'identity']
816814

817815
require_fields = {
@@ -830,6 +828,9 @@ def _idResCheckForFields(self, message, signed_list):
830828
if not message.hasKey(OPENID_NS, field):
831829
raise ProtocolError('Missing required field %r' % (field,))
832830

831+
signed_list_str = message.getArg(OPENID_NS, 'signed', no_default)
832+
signed_list = signed_list_str.split(',')
833+
833834
for field in require_sigs[message.getOpenIDNamespace()]:
834835
# Field is present and not in signed list
835836
if message.hasKey(OPENID_NS, field) and field not in signed_list:

‎openid/test/test_consumer.py‎

Lines changed: 23 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -390,6 +390,12 @@ def test_cancel(self):
390390
self.failUnlessEqual(r.status, CANCEL)
391391
self.failUnless(r.identity_url == self.endpoint.claimed_id)
392392

393+
def test_cancel_with_return_to(self):
394+
message = Message.fromPostArgs({'openid.mode': 'cancel'})
395+
r = self.consumer.complete(message, self.endpoint, self.return_to)
396+
self.failUnlessEqual(r.status, CANCEL)
397+
self.failUnless(r.identity_url == self.endpoint.claimed_id)
398+
393399
def test_error(self):
394400
msg = 'an error message'
395401
message = Message.fromPostArgs({'openid.mode': 'error',
@@ -441,7 +447,7 @@ def test_idResMissingField(self):
441447
# *check_auth* failed, not because it's missing an arg, exactly.
442448
message = Message.fromPostArgs({'openid.mode': 'id_res'})
443449
self.failUnlessRaises(ProtocolError, self.consumer._doIdRes,
444-
message, self.endpoint)
450+
message, self.endpoint, None)
445451

446452
def test_idResURLMismatch(self):
447453
class VerifiedError(Exception): pass
@@ -725,7 +731,8 @@ def setUp(self):
725731
def mkSuccessTest(openid_args, signed_list):
726732
def test(self):
727733
message = Message.fromOpenIDArgs(openid_args)
728-
self.consumer._idResCheckForFields(message, signed_list)
734+
message.setArg(OPENID_NS, 'signed', ','.join(signed_list))
735+
self.consumer._idResCheckForFields(message)
729736
return test
730737

731738
test_openid1Success = mkSuccessTest(
@@ -759,16 +766,13 @@ def test(self):
759766
['return_to', 'response_nonce', 'identity',
760767
'claimed_id', 'assoc_handle'])
761768

762-
def mkFailureTest(openid_args, signed_list, sig_fail=False):
769+
def mkFailureTest(openid_args, signed_list):
763770
def test(self):
764771
message = Message.fromOpenIDArgs(openid_args)
765772
try:
766-
self.consumer._idResCheckForFields(message, signed_list)
773+
self.consumer._idResCheckForFields(message)
767774
except ProtocolError, why:
768-
if sig_fail:
769-
self.failUnless(why[0].endswith('not signed'))
770-
else:
771-
self.failUnless(why[0].startswith('Missing required'))
775+
self.failUnless(why[0].startswith('Missing required'))
772776
else:
773777
self.fail('Expected an error, but none occurred')
774778
return test
@@ -779,17 +783,15 @@ def test(self):
779783
'sig':'a signature',
780784
'identity':'someone',
781785
},
782-
['identity'],
783-
sig_fail=True)
786+
['identity'])
784787

785788
test_openid1Missing_identitySig = mkFailureTest(
786789
{'return_to':'return',
787790
'assoc_handle':'assoc handle',
788791
'sig':'a signature',
789792
'identity':'someone',
790793
},
791-
['return_to'],
792-
sig_fail=True)
794+
['return_to'])
793795

794796
test_openid1MissingReturnTo = mkFailureTest(
795797
{'assoc_handle':'assoc handle',
@@ -932,7 +934,7 @@ def test_checkAuthTriggered(self):
932934
'openid.signed': 'identity,return_to',
933935
})
934936
try:
935-
result = self.consumer._doIdRes(message, self.endpoint)
937+
result = self.consumer._doIdRes(message, self.endpoint, None)
936938
except CheckAuthHappened:
937939
pass
938940
else:
@@ -956,7 +958,7 @@ def test_checkAuthTriggeredWithAssoc(self):
956958
'openid.signed': 'identity,return_to',
957959
})
958960
try:
959-
result = self.consumer._doIdRes(message, self.endpoint)
961+
result = self.consumer._doIdRes(message, self.endpoint, None)
960962
except CheckAuthHappened:
961963
pass
962964
else:
@@ -981,7 +983,7 @@ def test_expiredAssoc(self):
981983
'openid.signed': 'identity,return_to',
982984
})
983985
self.failUnlessRaises(ProtocolError, self.consumer._doIdRes,
984-
message, self.endpoint)
986+
message, self.endpoint, None)
985987

986988
def test_newerAssoc(self):
987989
lifetime = 1000
@@ -1006,7 +1008,7 @@ def test_newerAssoc(self):
10061008

10071009
message = Message.fromOpenIDArgs(query)
10081010
message = good_assoc.signMessage(message)
1009-
info = self.consumer._doIdRes(message, self.endpoint)
1011+
info = self.consumer._doIdRes(message, self.endpoint, None)
10101012
self.failUnlessEqual(info.status, SUCCESS, info.message)
10111013
self.failUnlessEqual(self.consumer_id, info.identity_url)
10121014

@@ -1101,11 +1103,7 @@ def test_completeBadReturnTo(self):
11011103

11021104
for bad in bad_return_tos:
11031105
m.setArg(OPENID_NS, 'return_to', bad)
1104-
result = self.consumer.complete(m, endpoint, return_to)
1105-
self.failUnless(isinstance(result, FailureResponse), \
1106-
"Expected FailureResponse, got %r for %s" % (result, bad))
1107-
self.failUnless(result.message == \
1108-
"openid.return_to does not match return URL")
1106+
self.failIf(self.consumer._checkReturnTo(m, return_to))
11091107

11101108
def test_completeGoodReturnTo(self):
11111109
"""Test GenericConsumer.complete()'s handling of good
@@ -1376,8 +1374,8 @@ def test_setAssociationPreference(self):
13761374
association.SessionNegotiator))
13771375
self.failUnlessEqual([],
13781376
self.consumer.consumer.negotiator.allowed_types)
1379-
self.consumer.setAssociationPreference([('FOO', 'BAR')])
1380-
self.failUnlessEqual([('FOO', 'BAR')],
1377+
self.consumer.setAssociationPreference([('HMAC-SHA1', 'DH-SHA1')])
1378+
self.failUnlessEqual([('HMAC-SHA1', 'DH-SHA1')],
13811379
self.consumer.consumer.negotiator.allowed_types)
13821380

13831381
def withDummyDiscovery(self, callable, dummy_getNextService):
@@ -1607,7 +1605,7 @@ def verifyDiscoveryResults(identifier, endpoint):
16071605
return discovered_endpoint
16081606
self.consumer._verifyDiscoveryResults = verifyDiscoveryResults
16091607
self.consumer._idResCheckNonce = lambda *args: True
1610-
response = self.consumer._doIdRes(message, self.endpoint)
1608+
response = self.consumer._doIdRes(message, self.endpoint, None)
16111609

16121610
self.failUnlessSuccess(response)
16131611
self.failUnlessEqual(response.identity_url, "=directed_identifier")
@@ -1629,7 +1627,7 @@ def verifyDiscoveryResults(identifier, endpoint):
16291627
raise DiscoveryFailure("PHREAK!", None)
16301628
self.consumer._verifyDiscoveryResults = verifyDiscoveryResults
16311629
self.failUnlessRaises(DiscoveryFailure, self.consumer._doIdRes,
1632-
message, self.endpoint)
1630+
message, self.endpoint, None)
16331631

16341632

16351633
def failUnlessSuccess(self, response):

0 commit comments

Comments
 (0)