More descriptive name.

Author: rohe

src/oidcop/session/claims.py

@@ -25,17 +25,17 @@ def available_claims(endpoint_context):
 
 class ClaimsInterface:
     init_args = {"add_claims_by_scope": False, "enable_claims_per_client": False}
-    claims_types = ["userinfo", "introspection", "id_token", "access_token"]
+    claims_release_points = ["userinfo", "introspection", "id_token", "access_token"]
 
     def __init__(self, server_get):
         self.server_get = server_get
 
     def authorization_request_claims(self,
                                      session_id: str,
-                                     claims_release_ref: Optional[str] = "") -> dict:
+                                     claims_release_point: Optional[str] = "") -> dict:
         _grant = self.server_get("endpoint_context").session_manager.get_grant(session_id)
         if _grant.authorization_request and "claims" in _grant.authorization_request:
-            return _grant.authorization_request["claims"].get(claims_release_ref, {})
+            return _grant.authorization_request["claims"].get(claims_release_point, {})
 
         return {}
 
@@ -65,19 +65,19 @@ def _get_module(self, usage, endpoint_context):
 
         return module
 
-    def get_claims(self, session_id: str, scopes: str, claims_release_ref: str) -> dict:
+    def get_claims(self, session_id: str, scopes: str, claims_release_point: str) -> dict:
         """
 
         :param session_id: Session identifier
         :param scopes: Scopes
-        :param claims_release_ref: Where to release the claims. One of
+        :param claims_release_point: Where to release the claims. One of
             "userinfo"/"id_token"/"introspection"/"access_token"
         :return: Claims specification as a dictionary.
         """
 
         _context = self.server_get("endpoint_context")
         # which endpoint module configuration to get the base claims from
-        module = self._get_module(claims_release_ref, _context)
+        module = self._get_module(claims_release_point, _context)
 
         if module:
             base_claims = module.kwargs.get("base_claims", {})
@@ -88,7 +88,7 @@ def get_claims(self, session_id: str, scopes: str, claims_release_ref: str) -> d
 
         # Can there be per client specification of which claims to use.
         if module.kwargs.get("enable_claims_per_client"):
-            claims = self._get_client_claims(client_id, claims_release_ref)
+            claims = self._get_client_claims(client_id, claims_release_point)
         else:
             claims = {}
 
@@ -105,7 +105,7 @@ def get_claims(self, session_id: str, scopes: str, claims_release_ref: str) -> d
         # Bring in claims specification from the authorization request
         # This only goes for ID Token and user info
         request_claims = self.authorization_request_claims(session_id=session_id,
-                                                           claims_release_ref=claims_release_ref)
+                                                           claims_release_point=claims_release_point)
 
         # This will add claims that has not be added before and
         # set filters on those claims that also appears in one of the sources above
@@ -116,7 +116,7 @@ def get_claims(self, session_id: str, scopes: str, claims_release_ref: str) -> d
 
     def get_claims_all_usage(self, session_id: str, scopes: str) -> dict:
         _claims = {}
-        for usage in self.claims_types:
+        for usage in self.claims_release_points:
             _claims[usage] = self.get_claims(session_id, scopes, usage)
         return _claims
 
@@ -192,7 +192,7 @@ def by_schema(cls, **kwa):
 
 
 class OAuth2ClaimsInterface(ClaimsInterface):
-    claims_types = ["introspection", "access_token"]
+    claims_release_points = ["introspection", "access_token"]
 
     def _get_module(self, usage, endpoint_context):
         module = None
@@ -208,6 +208,6 @@ def _get_module(self, usage, endpoint_context):
 
     def get_claims_all_usage(self, session_id: str, scopes: str) -> dict:
         _claims = {}
-        for usage in self.claims_types:
+        for usage in self.claims_release_points:
             _claims[usage] = self.get_claims(session_id, scopes, usage)
         return _claims

src/oidcop/session/grant.py

@@ -171,15 +171,15 @@ def payload_arguments(
             self,
             session_id: str,
             endpoint_context,
-            claims_release_ref: str,
+            claims_release_point: str,
             scope: Optional[dict] = None,
             extra_payload: Optional[dict] = None,
     ) -> dict:
         """
 
         :param session_id:
         :param endpoint_context:
-        :param claims_release_ref: One of "userinfo", "introspection", "id_token", "access_token"
+        :param claims_release_point: One of "userinfo", "introspection", "id_token", "access_token"
         :param scope:
         :param extra_payload:
         :return: dictionary containing information to place in a token value
@@ -202,7 +202,7 @@ def payload_arguments(
                 payload.update({"client_id": client_id, "sub": client_id})
 
         _claims_restriction = endpoint_context.claims_interface.get_claims(
-            session_id, scopes=scope, claims_release_ref=claims_release_ref
+            session_id, scopes=scope, claims_release_point=claims_release_point
         )
         user_id, _, _ = endpoint_context.session_manager.decrypt_session_id(session_id)
         user_info = endpoint_context.claims_interface.get_user_claims(user_id, _claims_restriction)
@@ -269,14 +269,14 @@ def mint_token(
 
             # Only access_token and id_token can give rise to claims release
             if token_class in ["access_token", "id_token"]:
-                claims_release_ref = token_class
+                claims_release_point = token_class
             else:
-                claims_release_ref = ""
+                claims_release_point = ""
 
             token_payload = self.payload_arguments(
                 session_id,
                 endpoint_context,
-                claims_release_ref=claims_release_ref,
+                claims_release_point=claims_release_point,
                 scope=scope,
                 extra_payload=handler_args,
             )

tests/test_05_id_token.py

@@ -419,7 +419,7 @@ def test_client_claims(self):
         self.endpoint_context.cdb["client_1"]["id_token_claims"] = {"address": None}
 
         _claims = self.endpoint_context.claims_interface.get_claims(
-            session_id=session_id, scopes=AREQ["scope"], claims_release_ref="id_token"
+            session_id=session_id, scopes=AREQ["scope"], claims_release_point="id_token"
         )
         grant.claims = {"id_token": _claims}
 
@@ -438,7 +438,7 @@ def test_client_claims_with_default(self):
         grant = self.session_manager[session_id]
 
         _claims = self.endpoint_context.claims_interface.get_claims(
-            session_id=session_id, scopes=AREQ["scope"], claims_release_ref="id_token"
+            session_id=session_id, scopes=AREQ["scope"], claims_release_point="id_token"
         )
         grant.claims = {"id_token": _claims}
 
@@ -461,7 +461,7 @@ def test_client_claims_scopes(self):
         self.session_manager.token_handler["id_token"].kwargs["add_claims_by_scope"] = True
 
         _claims = self.endpoint_context.claims_interface.get_claims(
-            session_id=session_id, scopes=AREQS["scope"], claims_release_ref="id_token"
+            session_id=session_id, scopes=AREQS["scope"], claims_release_point="id_token"
         )
         grant.claims = {"id_token": _claims}
 
@@ -483,7 +483,7 @@ def test_client_claims_scopes_and_request_claims_no_match(self):
         self.session_manager.token_handler["id_token"].kwargs["add_claims_by_scope"] = True
 
         _claims = self.endpoint_context.claims_interface.get_claims(
-            session_id=session_id, scopes=AREQRC["scope"], claims_release_ref="id_token"
+            session_id=session_id, scopes=AREQRC["scope"], claims_release_point="id_token"
         )
         grant.claims = {"id_token": _claims}
 
@@ -510,7 +510,7 @@ def test_client_claims_scopes_and_request_claims_one_match(self):
         self.session_manager.token_handler["id_token"].kwargs["add_claims_by_scope"] = True
 
         _claims = self.endpoint_context.claims_interface.get_claims(
-            session_id=session_id, scopes=_req["scope"], claims_release_ref="id_token"
+            session_id=session_id, scopes=_req["scope"], claims_release_point="id_token"
         )
         grant.claims = {"id_token": _claims}
 

tests/test_07_userinfo.py

@@ -280,7 +280,7 @@ def test_collect_user_info(self):
         session_id = self._create_session(_req)
 
         _userinfo_restriction = self.claims_interface.get_claims(
-            session_id=session_id, scopes=OIDR["scope"], claims_release_ref="userinfo"
+            session_id=session_id, scopes=OIDR["scope"], claims_release_point="userinfo"
         )
 
         res = self.claims_interface.get_user_claims("diana", _userinfo_restriction)
@@ -293,7 +293,7 @@ def test_collect_user_info(self):
         }
 
         _id_token_restriction = self.claims_interface.get_claims(
-            session_id=session_id, scopes=OIDR["scope"], claims_release_ref="id_token"
+            session_id=session_id, scopes=OIDR["scope"], claims_release_point="id_token"
         )
 
         res = self.claims_interface.get_user_claims("diana", _id_token_restriction)
@@ -304,7 +304,7 @@ def test_collect_user_info(self):
         }
 
         _restriction = self.claims_interface.get_claims(
-            session_id=session_id, scopes=OIDR["scope"], claims_release_ref="introspection"
+            session_id=session_id, scopes=OIDR["scope"], claims_release_point="introspection"
         )
 
         res = self.claims_interface.get_user_claims("diana", _restriction)
@@ -320,7 +320,7 @@ def test_collect_user_info_2(self):
         _uid, _cid, _gid = self.session_manager.decrypt_session_id(session_id)
 
         _userinfo_restriction = self.claims_interface.get_claims(
-            session_id=session_id, scopes=_req["scope"], claims_release_ref="userinfo"
+            session_id=session_id, scopes=_req["scope"], claims_release_point="userinfo"
         )
 
         res = self.claims_interface.get_user_claims("diana", _userinfo_restriction)
@@ -351,7 +351,7 @@ def test_collect_user_info_scope_not_supported_no_base_claims(self):
         del _userinfo_endpoint.kwargs["base_claims"]
 
         _userinfo_restriction = self.claims_interface.get_claims(
-            session_id=session_id, scopes=_req["scope"], claims_release_ref="userinfo"
+            session_id=session_id, scopes=_req["scope"], claims_release_point="userinfo"
         )
 
         res = self.claims_interface.get_user_claims("diana", _userinfo_restriction)
@@ -374,7 +374,7 @@ def test_collect_user_info_enable_claims_per_client(self):
         self.endpoint_context.cdb[_req["client_id"]]["userinfo_claims"] = {"phone_number": None}
 
         _userinfo_restriction = self.claims_interface.get_claims(
-            session_id=session_id, scopes=_req["scope"], claims_release_ref="userinfo"
+            session_id=session_id, scopes=_req["scope"], claims_release_point="userinfo"
         )
 
         res = self.claims_interface.get_user_claims("diana", _userinfo_restriction)
@@ -495,7 +495,7 @@ def test_collect_user_info_custom_scope(self):
         session_id = self._create_session(_req)
 
         _restriction = self.claims_interface.get_claims(
-            session_id=session_id, scopes=_req["scope"], claims_release_ref="userinfo"
+            session_id=session_id, scopes=_req["scope"], claims_release_point="userinfo"
         )
 
         res = self.claims_interface.get_user_claims("diana", _restriction)

tests/test_26_oidc_userinfo_endpoint.py

@@ -324,7 +324,7 @@ def test_custom_scope(self):
         self.endpoint.server_get("endpoint_context").claims_interface.add_claims_by_scope = True
         grant.claims = {
             "userinfo": self.endpoint.server_get("endpoint_context").claims_interface.get_claims(
-                session_id=session_id, scopes=_auth_req["scope"], claims_release_ref="userinfo"
+                session_id=session_id, scopes=_auth_req["scope"], claims_release_point="userinfo"
             )
         }
 

tests/test_31_oauth2_introspection.py

@@ -389,7 +389,7 @@ def test_introspection_claims(self):
         _c_interface = self.introspection_endpoint.server_get("endpoint_context").claims_interface
         grant.claims = {
             "introspection": _c_interface.get_claims(
-                session_id, scopes=AUTH_REQ["scope"], claims_release_ref="introspection"
+                session_id, scopes=AUTH_REQ["scope"], claims_release_point="introspection"
             )
         }
 

tests/test_50_persistence.py

@@ -410,7 +410,7 @@ def test_custom_scope(self):
             "userinfo": self.endpoint[1]
             .server_get("endpoint_context")
             .claims_interface.get_claims(session_id, scopes=_auth_req["scope"],
-                                         claims_release_ref="userinfo")
+                                         claims_release_point="userinfo")
         }
 
         self._dump_restore(1, 2)