Refactor internal data representation

Unify internal request and response data.
Deprecate internal_data module; use satosa.internal.
Deprecate InternalRequest class; use satosa.internal.InternalData.
Deprecate InternalResponse class; use satosa.internal.InternalData.
Deprecate SAMLInternalResponse class; use satosa.internal.InternalData.

Changes in internal data fields:
- Deprecate user_id; use subject_id.
- Deprecate user_id_hash_type; use subject_type.
- Deprecate name_id; use subject_id.
- Deprecate approved_attributes; use attributes.

All arguments for InternalData are now optional and named.

Signed-off-by: Ivan Kanakarakis <[email protected]>

Author: c00kiemon5ter

src/satosa/backends/base.py

@@ -13,7 +13,7 @@ class BackendModule(object):
     def __init__(self, auth_callback_func, internal_attributes, base_url, name):
         """
         :type auth_callback_func:
-        (satosa.context.Context, satosa.internal_data.InternalResponse) -> satosa.response.Response
+        (satosa.context.Context, satosa.internal.InternalData) -> satosa.response.Response
         :type internal_attributes: dict[string, dict[str, str | list[str]]]
         :type base_url: str
         :type name: str
@@ -37,7 +37,7 @@ def start_auth(self, context, internal_request):
         This is the start up function of the backend authorization.
 
         :type context: satosa.context.Context
-        :type internal_request: satosa.internal_data.InternalRequest
+        :type internal_request: satosa.internal.InternalData
         :rtype satosa.response.Response
 
         :param context: the request context

src/satosa/backends/github.py

@@ -10,10 +10,10 @@
 from oic.oauth2.message import AuthorizationResponse
 
 from satosa.backends.oauth import _OAuthBackend
-from ..internal_data import InternalResponse
-from ..internal_data import AuthenticationInformation
-from ..response import Redirect
-from ..util import rndstr
+from satosa.internal import AuthenticationInformation
+from satosa.internal import InternalData
+from satosa.response import Redirect
+from satosa.util import rndstr
 
 logger = logging.getLogger(__name__)
 
@@ -32,7 +32,7 @@ def __init__(self, outgoing, internal_attributes, config, base_url, name):
         :param base_url: base url of the service
         :param name: name of the plugin
         :type outgoing:
-            (satosa.context.Context, satosa.internal_data.InternalResponse) ->
+            (satosa.context.Context, satosa.internal.InternalData) ->
             satosa.response.Response
         :type internal_attributes: dict[string, dict[str, str | list[str]]]
         :type config: dict[str, dict[str, str] | list[str] | str]
@@ -51,7 +51,7 @@ def start_auth(self, context, internal_request, get_state=stateID):
 
         :type get_state: Callable[[str, bytes], str]
         :type context: satosa.context.Context
-        :type internal_request: satosa.internal_data.InternalRequest
+        :type internal_request: satosa.internal.InternalData
         :rtype satosa.response.Redirect
         """
         oauth_state = get_state(self.config["base_url"], rndstr().encode())
@@ -95,10 +95,10 @@ def _authn_response(self, context):
 
         user_info = self.user_information(response["access_token"])
         auth_info = self.auth_info(context.request)
-        internal_response = InternalResponse(auth_info=auth_info)
+        internal_response = InternalData(auth_info=auth_info)
         internal_response.attributes = self.converter.to_internal(
             self.external_type, user_info)
-        internal_response.user_id = str(user_info[self.user_id_attr])
+        internal_response.subject_id = str(user_info[self.user_id_attr])
         del context.state[self.name]
         return self.auth_callback_func(context, internal_response)
 

src/satosa/backends/linkedin.py

@@ -10,10 +10,10 @@
 from oic.oauth2.message import AuthorizationResponse
 
 from satosa.backends.oauth import _OAuthBackend
-from ..internal_data import InternalResponse
-from ..internal_data import AuthenticationInformation
-from ..response import Redirect
-from ..util import rndstr
+from satosa.internal import AuthenticationInformation
+from satosa.internal import InternalData
+from satosa.response import Redirect
+from satosa.util import rndstr
 
 
 logger = logging.getLogger(__name__)
@@ -33,7 +33,7 @@ def __init__(self, outgoing, internal_attributes, config, base_url, name):
         :param base_url: base url of the service
         :param name: name of the plugin
         :type outgoing:
-            (satosa.context.Context, satosa.internal_data.InternalResponse) ->
+            (satosa.context.Context, satosa.internal.InternalData) ->
             satosa.response.Response
         :type internal_attributes: dict[string, dict[str, str | list[str]]]
         :type config: dict[str, dict[str, str] | list[str] | str]
@@ -52,7 +52,7 @@ def start_auth(self, context, internal_request, get_state=stateID):
 
         :type get_state: Callable[[str, bytes], str]
         :type context: satosa.context.Context
-        :type internal_request: satosa.internal_data.InternalRequest
+        :type internal_request: satosa.internal.InternalData
         :rtype satosa.response.Redirect
         """
         oauth_state = get_state(self.config["base_url"], rndstr().encode())
@@ -96,10 +96,10 @@ def _authn_response(self, context):
 
         user_info = self.user_information(response["access_token"])
         auth_info = self.auth_info(context.request)
-        internal_response = InternalResponse(auth_info=auth_info)
+        internal_response = InternalData(auth_info=auth_info)
         internal_response.attributes = self.converter.to_internal(
             self.external_type, user_info)
-        internal_response.user_id = user_info[self.user_id_attr]
+        internal_response.subject_id = user_info[self.user_id_attr]
         del context.state[self.name]
         return self.auth_callback_func(context, internal_response)
 

src/satosa/backends/oauth.py

@@ -10,13 +10,17 @@
 from oic.oauth2.message import AuthorizationResponse
 from oic.utils.authn.authn_context import UNSPECIFIED
 
-from .base import BackendModule
-from ..exception import SATOSAAuthenticationError
-from ..internal_data import InternalResponse, AuthenticationInformation
-from ..logging_util import satosa_logging
-from ..metadata_creation.description import OrganizationDesc, UIInfoDesc, ContactPersonDesc, MetadataDescription
-from ..response import Redirect
-from ..util import rndstr
+from satosa.internal import AuthenticationInformation
+from satosa.internal import InternalData
+from satosa.exception import SATOSAAuthenticationError
+from satosa.logging_util import satosa_logging
+from satosa.response import Redirect
+from satosa.util import rndstr
+from satosa.metadata_creation.description import (
+    OrganizationDesc, UIInfoDesc, ContactPersonDesc, MetadataDescription
+)
+from satosa.backends.base import BackendModule
+
 
 logger = logging.getLogger(__name__)
 
@@ -40,7 +44,7 @@ def __init__(self, outgoing, internal_attributes, config, base_url, name, extern
         :param external_type: The name for this module in the internal attributes.
 
         :type outgoing:
-        (satosa.context.Context, satosa.internal_data.InternalResponse) -> satosa.response.Response
+        (satosa.context.Context, satosa.internal.InternalData) -> satosa.response.Response
         :type internal_attributes: dict[string, dict[str, str | list[str]]]
         :type config: dict[str, dict[str, str] | list[str]]
         :type base_url: str
@@ -67,7 +71,7 @@ def start_auth(self, context, internal_request, get_state=stateID):
 
         :type get_state: Callable[[str, bytes], str]
         :type context: satosa.context.Context
-        :type internal_request: satosa.internal_data.InternalRequest
+        :type internal_request: satosa.internal.InternalData
         :rtype satosa.response.Redirect
         """
         oauth_state = get_state(self.config["base_url"], rndstr().encode())
@@ -132,9 +136,9 @@ def _authn_response(self, context):
             self._verify_state(atresp, state_data, context.state)
 
         user_info = self.user_information(atresp["access_token"])
-        internal_response = InternalResponse(auth_info=self.auth_info(context.request))
+        internal_response = InternalData(auth_info=self.auth_info(context.request))
         internal_response.attributes = self.converter.to_internal(self.external_type, user_info)
-        internal_response.user_id = user_info[self.user_id_attr]
+        internal_response.subject_id = user_info[self.user_id_attr]
         del context.state[self.name]
         return self.auth_callback_func(context, internal_response)
 
@@ -187,7 +191,7 @@ def __init__(self, outgoing, internal_attributes, config, base_url, name):
         :param name: name of the plugin
 
         :type outgoing:
-        (satosa.context.Context, satosa.internal_data.InternalResponse) -> satosa.response.Response
+        (satosa.context.Context, satosa.internal.InternalData) -> satosa.response.Response
         :type internal_attributes: dict[string, dict[str, str | list[str]]]
         :type config: dict[str, dict[str, str] | list[str] | str]
         :type base_url: str

src/satosa/backends/openid_connect.py

@@ -12,10 +12,11 @@
 from oic.utils.authn.authn_context import UNSPECIFIED
 from oic.utils.authn.client import CLIENT_AUTHN_METHOD
 
+from satosa.internal import AuthenticationInformation
+from satosa.internal import InternalData
 from .base import BackendModule
 from .oauth import get_metadata_desc_for_oauth_backend
 from ..exception import SATOSAAuthenticationError, SATOSAError
-from ..internal_data import InternalResponse, AuthenticationInformation
 from ..logging_util import satosa_logging
 from ..response import Redirect
 
@@ -43,7 +44,7 @@ def __init__(self, auth_callback_func, internal_attributes, config, base_url, na
         :param name: name of the plugin
 
         :type auth_callback_func:
-        (satosa.context.Context, satosa.internal_data.InternalResponse) -> satosa.response.Response
+        (satosa.context.Context, satosa.internal.InternalData) -> satosa.response.Response
         :type internal_attributes: dict[string, dict[str, str | list[str]]]
         :type config: dict[str, dict[str, str] | list[str]]
         :type base_url: str
@@ -62,7 +63,7 @@ def start_auth(self, context, request_info):
         """
         See super class method satosa.backends.base#start_auth
         :type context: satosa.context.Context
-        :type request_info: satosa.internal_data.InternalRequest
+        :type request_info: satosa.internal.InternalData
         """
         oidc_nonce = rndstr()
         oidc_state = rndstr()
@@ -209,17 +210,17 @@ def _translate_response(self, response, issuer):
         :type response: dict[str, str]
         :type issuer: str
         :type subject_type: str
-        :rtype: InternalResponse
+        :rtype: InternalData
 
         :param response: Dictioary with attribute name as key.
         :param issuer: The oidc op that gave the repsonse.
         :param subject_type: public or pairwise according to oidc standard.
         :return: A SATOSA internal response.
         """
         auth_info = AuthenticationInformation(UNSPECIFIED, str(datetime.now()), issuer)
-        internal_resp = InternalResponse(auth_info=auth_info)
+        internal_resp = InternalData(auth_info=auth_info)
         internal_resp.attributes = self.converter.to_internal("openid", response)
-        internal_resp.user_id = response["sub"]
+        internal_resp.subject_id = response["sub"]
         return internal_resp
 
     def get_metadata_desc(self):

src/satosa/backends/orcid.py

@@ -11,9 +11,9 @@
 from oic.oauth2.message import AuthorizationResponse
 
 from satosa.backends.oauth import _OAuthBackend
-from ..internal_data import InternalResponse
-from ..internal_data import AuthenticationInformation
-from ..response import Redirect
+from satosa.internal import InternalData
+from satosa.internal import AuthenticationInformation
+from satosa.response import Redirect
 
 logger = logging.getLogger(__name__)
 
@@ -32,7 +32,7 @@ def __init__(self, outgoing, internal_attributes, config, base_url, name):
         :param base_url: base url of the service
         :param name: name of the plugin
         :type outgoing:
-            (satosa.context.Context, satosa.internal_data.InternalResponse) ->
+            (satosa.context.Context, satosa.internal.InternalData) ->
             satosa.response.Response
         :type internal_attributes: dict[string, dict[str, str | list[str]]]
         :type config: dict[str, dict[str, str] | list[str] | str]
@@ -51,7 +51,7 @@ def start_auth(self, context, internal_request, get_state=stateID):
 
         :type get_state: Callable[[str, bytes], str]
         :type context: satosa.context.Context
-        :type internal_request: satosa.internal_data.InternalRequest
+        :type internal_request: satosa.internal.InternalData
         :rtype satosa.response.Redirect
         """
         request_args = dict(
@@ -85,10 +85,10 @@ def _authn_response(self, context):
         orcid, name = response['orcid'], response['name']
         user_info = self.user_information(token, orcid, name)
         auth_info = self.auth_info(context.request)
-        internal_response = InternalResponse(auth_info=auth_info)
+        internal_response = InternalData(auth_info=auth_info)
         internal_response.attributes = self.converter.to_internal(
             self.external_type, user_info)
-        internal_response.user_id = orcid
+        internal_response.subject_id = orcid
         return self.auth_callback_func(context, internal_response)
 
     def user_information(self, access_token, orcid, name):