Add KEY_METADATA_STORE to store the saml2 metadata store

KEY_METADATA_STORE will hold the metadata store for saml2 backends and
frontends. Accessing it that through the Context object will allow one
to peek into the metadata of the corresponding backend or frontend.

Previously, KEY_BACKEND_METADATA_STORE was used for this reason, but was
available only on the backend. It is now a deprecated alias.

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

Author: c00kiemon5ter

src/satosa/backends/saml2.py

@@ -343,7 +343,7 @@ def authn_response(self, context, binding):
             logger.debug(logline)
             raise SATOSAAuthenticationError(context.state, "State did not match relay state")
 
-        context.decorate(Context.KEY_BACKEND_METADATA_STORE, self.sp.metadata)
+        context.decorate(Context.KEY_METADATA_STORE, self.sp.metadata)
         if self.config.get(SAMLBackend.KEY_MEMORIZE_IDP):
             issuer = authn_response.response.issuer.text.strip()
             context.state[Context.KEY_MEMORIZED_IDP] = issuer

src/satosa/context.py

@@ -1,3 +1,5 @@
+from warnings import warn as _warn
+
 from satosa.exception import SATOSAError
 
 
@@ -12,7 +14,7 @@ class Context(object):
     """
     Holds methods for sharing proxy data through the current request
     """
-    KEY_BACKEND_METADATA_STORE = 'metadata_store'
+    KEY_METADATA_STORE = 'metadata_store'
     KEY_TARGET_ENTITYID = 'target_entity_id'
     KEY_FORCE_AUTHN = 'force_authn'
     KEY_MEMORIZED_IDP = 'memorized_idp'
@@ -28,9 +30,13 @@ def __init__(self):
         self.cookie = None
         self.state = None
 
-    def __repr__(self):
-        from pprint import pformat
-        return pformat(vars(self))
+    @property
+    def KEY_BACKEND_METADATA_STORE(self):
+        msg = "'{old_key}' is deprecated; use '{new_key}' instead.".format(
+            old_key="KEY_BACKEND_METADATA_STORE", new_key="KEY_METADATA_STORE"
+        )
+        _warn(msg, DeprecationWarning)
+        return Context.KEY_METADATA_STORE
 
     @property
     def path(self):

src/satosa/frontends/saml2.py

@@ -247,6 +247,7 @@ def _handle_authn_request(self, context, binding_in, idp):
                 idp, idp_policy, requester, context.state
             )
 
+        context.decorate(Context.KEY_METADATA_STORE, self.idp.metadata)
         return self.auth_req_callback_func(context, internal_req)
 
     def _get_approved_attributes(self, idp, idp_policy, sp_entity_id, state):