Added more needed methods.

Bumped version

Author: rohe

src/oidcservice/__init__.py

@@ -9,7 +9,7 @@
 
 
 __author__ = 'Roland Hedberg'
-__version__ = '0.6.0'
+__version__ = '0.6.1'
 
 
 OIDCONF_PATTERN = "{}/.well-known/openid-configuration"

src/oidcservice/oidc/end_session.py

@@ -17,8 +17,9 @@ class EndSession(Service):
     response_cls = Message
     error_msg = ResponseMessage
     endpoint_name = 'end_session_endpoint'
-    synchronous = False
+    synchronous = True
     service_name = 'end_session'
+    response_body_type = 'html'
 
     def __init__(self, service_context, state_db, client_authn_factory=None,
                  conf=None):
@@ -56,7 +57,8 @@ def add_post_logout_redirect_uri(self, request_args=None, **kwargs):
             try:
                 request_args[
                     'post_logout_redirect_uri'
-                ] = self.service_context.post_logout_redirect_uris[0]
+                ] = self.service_context.register_args[
+                    'post_logout_redirect_uris'][0]
             except KeyError:
                 pass
 

src/oidcservice/oidc/registration.py

@@ -43,7 +43,7 @@ def add_request_uri(request_args=None, service=None, **kwargs):
     if _context.requests_dir:
         try:
             if _context.provider_info[
-                'require_request_uri_registration'] is True:
+                    'require_request_uri_registration'] is True:
                 request_args['request_uris'] = _context.generate_request_uris(
                     _context.requests_dir)
         except KeyError:
@@ -64,8 +64,9 @@ def add_post_logout_redirect_uris(request_args=None, service=None, **kwargs):
 
     if "post_logout_redirect_uris" not in request_args:
         try:
-            _uris = service.service_context.post_logout_redirect_uris
-        except AttributeError:
+            _uris = service.service_context.register_args[
+                'post_logout_redirect_uris']
+        except KeyError:
             pass
         else:
             request_args["post_logout_redirect_uris"] = _uris

src/oidcservice/service.py

@@ -94,9 +94,12 @@ def gather_request_args(self, **kwargs):
                         ar_args[prop] = self.conf['request_args'][prop]
                     except KeyError:
                         try:
-                            ar_args[prop] = self.default_request_args[prop]
+                            ar_args[prop] = self.service_context.register_args[prop]
                         except KeyError:
-                            pass
+                            try:
+                                ar_args[prop] = self.default_request_args[prop]
+                            except KeyError:
+                                pass
 
         return ar_args
 
@@ -286,7 +289,7 @@ def get_request_parameters(self, request_body_type="", method="",
         """
         Builds the request message and constructs the HTTP headers.
 
-        This is the starting pont for a pipeline that will:
+        This is the starting point for a pipeline that will:
 
         - construct the request message
         - add/remove information to/from the request message in the way a

src/oidcservice/service_context.py

@@ -10,6 +10,7 @@
 
 # This represents a map between the local storage of algorithm choices
 # and how they are represented in a provider info response.
+from oidcmsg.oidc import RegistrationRequest
 
 CLI_REG_MAP = {
     "userinfo": {
@@ -72,6 +73,7 @@ def __init__(self, keyjar=None, config=None, **kwargs):
         # Below so my IDE won't complain
         self.base_url = ''
         self.requests_dir = ''
+        self.register_args = {}
         self.allow = {}
         self.behaviour = {}
         self.client_preferences = {}
@@ -87,13 +89,18 @@ def __init__(self, keyjar=None, config=None, **kwargs):
         for key, val in kwargs.items():
             setattr(self, key, val)
 
-        for attr in ['client_id', 'issuer', 'base_url', 'requests_dir',
-                     'post_logout_redirect_uris']:
+        for attr in ['client_id', 'issuer', 'base_url', 'requests_dir']:
             try:
                 setattr(self, attr, config[attr])
             except:
                 setattr(self, attr, '')
 
+        for attr in RegistrationRequest.c_param.keys():
+            try:
+                self.register_args[attr] = config[attr]
+            except KeyError:
+                pass
+
         for attr in ['allow', 'client_preferences', 'behaviour',
                      'provider_info']:
             try:

src/oidcservice/state_interface.py

@@ -1,3 +1,5 @@
+import json
+
 from oidcmsg.message import Message
 from oidcmsg.message import SINGLE_OPTIONAL_JSON
 from oidcmsg.message import SINGLE_REQUIRED_STRING
@@ -20,7 +22,9 @@ class State(Message):
 
 KEY_PATTERN = {
     'nonce': '__{}__',
-    'logout state': '::{}::'
+    'logout state': '::{}::',
+    'session id': '..{}..',
+    'subject id': '=={}=='
 }
 
 
@@ -197,30 +201,38 @@ def multiple_extend_request_args(self, args, key, parameters, item_types,
 
         return args
 
-    def store_X2state(self, nonce, state, xtyp):
+    def store_X2state(self, x, state, xtyp):
         """
-        Store the connection between a nonce value and a state value.
+        Store the connection between some value and a state value.
         This allows us later in the game to find the state if we have the nonce.
 
-        :param nonce: The nonce value
+        :param x: The value of x
         :param state: The state value
+        :param xtyp: The type of value x is (e.g. nonce, ...)
         """
-        self.state_db.set(KEY_PATTERN[xtyp].format(nonce), state)
+        self.state_db.set(KEY_PATTERN[xtyp].format(x), state)
+        _val = self.state_db.get("ref{}ref".format(state))
+        if _val is None:
+            refs = {xtyp:x}
+        else:
+            refs = json.loads(_val)
+            refs[xtyp] = x
+        self.state_db.set("ref{}ref".format(state), json.dumps(refs))
 
-    def get_state_by_X(self, nonce, xtyp):
+    def get_state_by_X(self, x, xtyp):
         """
-        Find the state value by providing the nonce value.
-        Will raise an exception if the nonce value is absent from the state
+        Find the state value by providing the x value.
+        Will raise an exception if the x value is absent from the state
         data base.
 
-        :param nonce: The nonce value
+        :param x: The x value
         :return: The state value
         """
-        _state = self.state_db.get(KEY_PATTERN[xtyp].format(nonce))
+        _state = self.state_db.get(KEY_PATTERN[xtyp].format(x))
         if _state:
             return _state
         else:
-            raise KeyError('Unknown {}: "{}"'.format(xtyp, nonce))
+            raise KeyError('Unknown {}: "{}"'.format(xtyp, x))
 
     def store_nonce2state(self, nonce, state):
         """
@@ -245,8 +257,9 @@ def get_state_by_nonce(self, nonce):
 
     def store_logout_state2state(self, logout_state, state):
         """
-        Store the connection between a nonce value and a state value.
-        This allows us later in the game to find the state if we have the nonce.
+        Store the connection between a logout state value and a state value.
+        This allows us later in the game to find the state if we have the
+        logout state value.
 
         :param logout_state: The logout state value
         :param state: The state value
@@ -255,15 +268,59 @@ def store_logout_state2state(self, logout_state, state):
 
     def get_state_by_logout_state(self, logout_state):
         """
-        Find the state value by providing the nonce value.
-        Will raise an exception if the nonce value is absent from the state
-        data base.
+        Find the state value by providing the logout state value.
+        Will raise an exception if the logout state value is absent from the
+        state data base.
 
-        :param nonce: The nonce value
+        :param logout_state: The logout state value
         :return: The state value
         """
         return self.get_state_by_X(logout_state, 'logout state')
 
+    def store_sid2state(self, sid, state):
+        """
+        Store the connection between a session id (sid) value and a state value.
+        This allows us later in the game to find the state if we have the
+        sid value.
+
+        :param sid: The session ID value
+        :param state: The state value
+        """
+        self.store_X2state(sid, state, 'session id')
+
+    def get_state_by_sid(self, sid):
+        """
+        Find the state value by providing the logout state value.
+        Will raise an exception if the logout state value is absent from the
+        state data base.
+
+        :param sid: The session ID value
+        :return: The state value
+        """
+        return self.get_state_by_X(sid, 'session id')
+
+    def store_sub2state(self, sub, state):
+        """
+        Store the connection between a subject id (sub) value and a state value.
+        This allows us later in the game to find the state if we have the
+        sub value.
+
+        :param sub: The Subject ID value
+        :param state: The state value
+        """
+        self.store_X2state(sub, state, 'subject id')
+
+    def get_state_by_sub(self, sub):
+        """
+        Find the state value by providing the subject id value.
+        Will raise an exception if the subject id value is absent from the
+        state data base.
+
+        :param sub: The Subject ID value
+        :return: The state value
+        """
+        return self.get_state_by_X(sub, 'subject id')
+
     def create_state(self, iss, key=''):
         if not key:
             key = rndstr(32)
@@ -277,4 +334,8 @@ def create_state(self, iss, key=''):
         return key
 
     def remove_state(self, state):
-        self.state_db.delete(state)
+        self.state_db.delete(state)
+        refs = json.loads(self.state_db.get("ref{}ref".format(state)))
+        if refs:
+            for xtyp, x in refs.items():
+                self.state_db.delete(KEY_PATTERN[xtyp].format(x))

tests/test_13_oic_service.py

@@ -583,8 +583,8 @@ def test_construct(self):
         assert len(_req) == 4
 
     def test_config_with_post_logout(self):
-        self.service.service_context.post_logout_redirect_uris = [
-            'https://example.com/post_logout']
+        self.service.service_context.register_args[
+            'post_logout_redirect_uris'] = ['https://example.com/post_logout']
         _req = self.service.construct()
         assert isinstance(_req, RegistrationRequest)
         assert len(_req) == 5