Skip to content

Commit 2052924

Browse files
author
Kevin Turner
committed
[project @ Deprecate server.CheckIDRequest.namespace and stop using == OPENID1_NS anywhere in server]
1 parent d6acbfb commit 2052924

2 files changed

Lines changed: 43 additions & 20 deletions

File tree

‎openid/server/server.py‎

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,7 @@
127127
from openid.server.trustroot import TrustRoot, verifyReturnTo
128128
from openid.association import Association, default_negotiator, getSecretSize
129129
from openid.message import Message, InvalidOpenIDNamespace, \
130-
OPENID_NS, OPENID1_NS, \
131-
OPENID2_NS, IDENTIFIER_SELECT, OPENID1_URL_LIMIT
130+
OPENID_NS, OPENID2_NS, IDENTIFIER_SELECT, OPENID1_URL_LIMIT
132131

133132
HTTP_OK = 200
134133
HTTP_REDIRECT = 302
@@ -418,7 +417,7 @@ def fromMessage(klass, message, op_endpoint=UNUSED):
418417
@returntype: L{AssociateRequest}
419418
"""
420419
if message.isOpenID1():
421-
session_type = message.getArg(OPENID1_NS, 'session_type')
420+
session_type = message.getArg(OPENID_NS, 'session_type')
422421
if session_type == 'no-encryption':
423422
oidutil.log('Received OpenID 1 request with a no-encryption '
424423
'assocaition session type. Continuing anyway.')
@@ -474,7 +473,7 @@ def answer(self, assoc):
474473
self.session.answer(assoc.secret))
475474

476475
if not (self.session.session_type == 'no-encryption' and
477-
self.namespace == OPENID1_NS):
476+
self.message.isOpenID1()):
478477
# The session type "no-encryption" did not have a name
479478
# in OpenID v1, it was just omitted.
480479
response.fields.setArg(
@@ -547,7 +546,6 @@ def __init__(self, identity, return_to, trust_root=None, immediate=False,
547546
548547
@raises MalformedReturnURL: When the C{return_to} URL is not a URL.
549548
"""
550-
self.namespace = OPENID2_NS
551549
self.assoc_handle = assoc_handle
552550
self.identity = identity
553551
self.claimed_id = identity
@@ -567,8 +565,16 @@ def __init__(self, identity, return_to, trust_root=None, immediate=False,
567565
raise MalformedReturnURL(None, self.return_to)
568566
if not self.trustRootValid():
569567
raise UntrustedReturnURL(None, self.return_to, self.trust_root)
568+
self.message = None
570569

570+
def _getNamespace(self):
571+
warnings.warn('The "namespace" attribute of CheckIDRequest objects '
572+
'is deprecated. Use "message.getOpenIDNamespace()" '
573+
'instead', DeprecationWarning, stacklevel=2)
574+
return self.message.getOpenIDNamespace()
571575

576+
namespace = property(_getNamespace)
577+
572578
def fromMessage(klass, message, op_endpoint):
573579
"""Construct me from an OpenID message.
574580
@@ -591,7 +597,6 @@ def fromMessage(klass, message, op_endpoint):
591597
"""
592598
self = klass.__new__(klass)
593599
self.message = message
594-
self.namespace = message.getOpenIDNamespace()
595600
self.op_endpoint = op_endpoint
596601
mode = message.getArg(OPENID_NS, 'mode')
597602
if mode == "checkid_immediate":
@@ -769,7 +774,7 @@ def answer(self, allow, server_url=None, identity=None, claimed_id=None):
769774
raise NoReturnToError
770775

771776
if not server_url:
772-
if self.namespace != OPENID1_NS and not self.op_endpoint:
777+
if not self.message.isOpenID1() and not self.op_endpoint:
773778
# In other words, that warning I raised in Server.__init__?
774779
# You should pay attention to it now.
775780
raise RuntimeError("%s should be constructed with op_endpoint "
@@ -779,7 +784,7 @@ def answer(self, allow, server_url=None, identity=None, claimed_id=None):
779784

780785
if allow:
781786
mode = 'id_res'
782-
elif self.namespace == OPENID1_NS:
787+
elif self.message.isOpenID1():
783788
if self.immediate:
784789
mode = 'id_res'
785790
else:
@@ -792,9 +797,10 @@ def answer(self, allow, server_url=None, identity=None, claimed_id=None):
792797

793798
response = OpenIDResponse(self)
794799

795-
if claimed_id and self.namespace == OPENID1_NS:
800+
if claimed_id and self.message.isOpenID1():
801+
namespace = self.message.getOpenIDNamespace()
796802
raise VersionError("claimed_id is new in OpenID 2.0 and not "
797-
"available for %s" % (self.namespace,))
803+
"available for %s" % (namespace,))
798804

799805
if identity and not claimed_id:
800806
claimed_id = identity
@@ -823,7 +829,7 @@ def answer(self, allow, server_url=None, identity=None, claimed_id=None):
823829
"supplied %r" % (identity,))
824830
response_identity = None
825831

826-
if self.namespace == OPENID1_NS and response_identity is None:
832+
if self.message.isOpenID1() and response_identity is None:
827833
raise ValueError(
828834
"Request was an OpenID 1 request, so response must "
829835
"include an identifier."
@@ -841,20 +847,24 @@ def answer(self, allow, server_url=None, identity=None, claimed_id=None):
841847
if response_identity is not None:
842848
response.fields.setArg(
843849
OPENID_NS, 'identity', response_identity)
844-
if self.namespace == OPENID2_NS:
850+
if self.message.isOpenID2():
845851
response.fields.setArg(
846852
OPENID_NS, 'claimed_id', response_claimed_id)
847853
else:
848854
response.fields.setArg(OPENID_NS, 'mode', mode)
849855
if self.immediate:
850-
if self.namespace == OPENID1_NS and not server_url:
856+
if self.message.isOpenID1() and not server_url:
851857
raise ValueError("setup_url is required for allow=False "
852858
"in OpenID 1.x immediate mode.")
853859
# Make a new request just like me, but with immediate=False.
854860
setup_request = self.__class__(
855861
self.identity, self.return_to, self.trust_root,
856862
immediate=False, assoc_handle=self.assoc_handle,
857863
op_endpoint=self.op_endpoint)
864+
865+
# XXX: This API is weird.
866+
setup_request.message = self.message
867+
858868
setup_url = setup_request.encodeToURL(server_url)
859869
response.fields.setArg(OPENID_NS, 'user_setup_url', setup_url)
860870

@@ -883,15 +893,15 @@ def encodeToURL(self, server_url):
883893
'claimed_id': self.claimed_id,
884894
'return_to': self.return_to}
885895
if self.trust_root:
886-
if self.namespace == OPENID1_NS:
896+
if self.message.isOpenID1():
887897
q['trust_root'] = self.trust_root
888898
else:
889899
q['realm'] = self.trust_root
890900
if self.assoc_handle:
891901
q['assoc_handle'] = self.assoc_handle
892902

893-
response = Message(self.namespace)
894-
response.updateArgs(self.namespace, q)
903+
response = Message(self.message.getOpenIDNamespace())
904+
response.updateArgs(OPENID_NS, q)
895905
return response.toURL(server_url)
896906

897907

@@ -916,7 +926,8 @@ def getCancelURL(self):
916926
if self.immediate:
917927
raise ValueError("Cancel is not an appropriate response to "
918928
"immediate mode requests.")
919-
response = Message(self.namespace)
929+
930+
response = Message(self.message.getOpenIDNamespace())
920931
response.setArg(OPENID_NS, 'mode', 'cancel')
921932
return response.toURL(self.return_to)
922933

‎openid/test/test_server.py‎

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -542,6 +542,7 @@ def test_id_res_OpenID2_GET(self):
542542
immediate = False,
543543
op_endpoint = self.server.op_endpoint,
544544
)
545+
request.message = Message(OPENID2_NS)
545546
response = server.OpenIDResponse(request)
546547
response.fields = Message.fromOpenIDArgs({
547548
'ns': OPENID2_NS,
@@ -569,6 +570,7 @@ def test_id_res_OpenID2_POST(self):
569570
immediate = False,
570571
op_endpoint = self.server.op_endpoint,
571572
)
573+
request.message = Message(OPENID2_NS)
572574
response = server.OpenIDResponse(request)
573575
response.fields = Message.fromOpenIDArgs({
574576
'ns': OPENID2_NS,
@@ -592,6 +594,7 @@ def test_toFormMarkup(self):
592594
immediate = False,
593595
op_endpoint = self.server.op_endpoint,
594596
)
597+
request.message = Message(OPENID2_NS)
595598
response = server.OpenIDResponse(request)
596599
response.fields = Message.fromOpenIDArgs({
597600
'ns': OPENID2_NS,
@@ -612,6 +615,7 @@ def test_toHTML(self):
612615
immediate = False,
613616
op_endpoint = self.server.op_endpoint,
614617
)
618+
request.message = Message(OPENID2_NS)
615619
response = server.OpenIDResponse(request)
616620
response.fields = Message.fromOpenIDArgs({
617621
'ns': OPENID2_NS,
@@ -641,6 +645,7 @@ def test_id_res_OpenID1_exceeds_limit(self):
641645
immediate = False,
642646
op_endpoint = self.server.op_endpoint,
643647
)
648+
request.message = Message(OPENID2_NS)
644649
response = server.OpenIDResponse(request)
645650
response.fields = Message.fromOpenIDArgs({
646651
'mode': 'id_res',
@@ -662,6 +667,7 @@ def test_id_res(self):
662667
immediate = False,
663668
op_endpoint = self.server.op_endpoint,
664669
)
670+
request.message = Message(OPENID2_NS)
665671
response = server.OpenIDResponse(request)
666672
response.fields = Message.fromOpenIDArgs({
667673
'mode': 'id_res',
@@ -689,6 +695,7 @@ def test_cancel(self):
689695
immediate = False,
690696
op_endpoint = self.server.op_endpoint,
691697
)
698+
request.message = Message(OPENID2_NS)
692699
response = server.OpenIDResponse(request)
693700
response.fields = Message.fromOpenIDArgs({
694701
'mode': 'cancel',
@@ -705,6 +712,7 @@ def test_cancelToForm(self):
705712
immediate = False,
706713
op_endpoint = self.server.op_endpoint,
707714
)
715+
request.message = Message(OPENID2_NS)
708716
response = server.OpenIDResponse(request)
709717
response.fields = Message.fromOpenIDArgs({
710718
'mode': 'cancel',
@@ -776,6 +784,7 @@ def setUp(self):
776784
immediate = False,
777785
op_endpoint = self.server.op_endpoint,
778786
)
787+
self.request.message = Message(OPENID2_NS)
779788
self.response = server.OpenIDResponse(self.request)
780789
self.response.fields = Message.fromOpenIDArgs({
781790
'mode': 'id_res',
@@ -826,6 +835,7 @@ def test_cancel(self):
826835
immediate = False,
827836
op_endpoint = self.server.op_endpoint,
828837
)
838+
request.message = Message(OPENID2_NS)
829839
response = server.OpenIDResponse(request)
830840
response.fields.setArg(OPENID_NS, 'mode', 'cancel')
831841
webresponse = self.encode(response)
@@ -864,6 +874,7 @@ def setUp(self):
864874
immediate = False,
865875
op_endpoint = self.server.op_endpoint,
866876
)
877+
self.request.message = Message(OPENID2_NS)
867878

868879
def test_trustRootInvalid(self):
869880
self.request.trust_root = "http://foo.unittest/17"
@@ -1030,7 +1041,7 @@ def test_answerAllowWithDelegatedIdentityOpenID2(self):
10301041
def test_answerAllowWithDelegatedIdentityOpenID1(self):
10311042
"""claimed_id parameter doesn't exist in OpenID 1.
10321043
"""
1033-
self.request.namespace = OPENID1_NS
1044+
self.request.message = Message(OPENID1_NS)
10341045
# claimed_id delegates to selected_id here.
10351046
self.request.identity = IDENTIFIER_SELECT
10361047
selected_id = 'http://anon.unittest/9861'
@@ -1046,7 +1057,7 @@ def test_answerAllowWithAnotherIdentity(self):
10461057
identity="http://pebbles.unittest/")
10471058

10481059
def test_answerAllowNoIdentityOpenID1(self):
1049-
self.request.namespace = OPENID1_NS
1060+
self.request.message = Message(OPENID1_NS)
10501061
self.request.identity = None
10511062
self.failUnlessRaises(ValueError, self.request.answer, True,
10521063
identity=None)
@@ -1198,7 +1209,7 @@ def test_answerImmediateDenyOpenID2(self):
11981209
def test_answerImmediateDenyOpenID1(self):
11991210
"""Look for user_setup_url in checkid_immediate negative
12001211
response in OpenID 1 case."""
1201-
self.request.namespace = OPENID1_NS
1212+
self.request.message = Message(OPENID1_NS)
12021213
self.request.mode = 'checkid_immediate'
12031214
self.request.immediate = True
12041215
server_url = "http://setup-url.unittest/"
@@ -1260,6 +1271,7 @@ def setUp(self):
12601271
immediate = False,
12611272
op_endpoint = self.server.op_endpoint,
12621273
)
1274+
self.request.message = Message(OPENID2_NS)
12631275
self.response = server.OpenIDResponse(self.request)
12641276
self.response.fields.setArg(OPENID_NS, 'mode', 'id_res')
12651277
self.response.fields.setArg(OPENID_NS, 'blue', 'star')

0 commit comments

Comments
 (0)