Added mechanism for extension developers to access relying party-specific configurati...

git-svn-id: https://subversion.switch.ch/svn/shibboleth/java-idp/trunk@2048 ab3bd59b-922f-494d-bb5f-6f0a3c29deca

diff --git a/data/relyingPartyMapper3.xml b/data/relyingPartyMapper3.xml
new file mode 100644 (file)
index 0000000..baef921
--- /dev/null
+++ b/data/relyingPartyMapper3.xml
@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<IdPConfig 
+       xmlns="urn:mace:shibboleth:idp:config:1.0" 
+       xmlns:cred="urn:mace:shibboleth:credentials:1.0" 
+       xmlns:name="urn:mace:shibboleth:namemapper:1.0" 
+       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+       xsi:schemaLocation="urn:mace:shibboleth:idp:config:1.0 ../schemas/shibboleth-idpconfig-1.0.xsd">
+               
+       <RelyingParty 
+               name="urn-x:test:1" 
+               providerId="urn-x:test:id1"
+               signingCredential="test"
+               passThruErrors="true" 
+               defaultNameID="foo" 
+               extension1="foo" 
+               extension2="bar"/>
+       
+<!-- Add back later <AttributeResolver config="$IDP_HOME$/etc/resolver.xml"/>-->
+       
+       <ReleasePolicyEngine>
+               <ArpRepository implementation="edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository">
+                       <Path>$IDP_HOME$/etc/arps/</Path>
+               </ArpRepository>
+       </ReleasePolicyEngine>
+
+       <Logging>
+               <ErrorLog level="WARN" location="$IDP_HOME$/logs/shib-error.log" />
+               <TransactionLog level="INFO" location="$IDP_HOME$/logs/shib-access.log" />
+       </Logging>
+
+       <Credentials xmlns="urn:mace:shibboleth:credentials:1.0">
+               <KeyStoreResolver Id="test" storeType="JKS">
+                       <Path>/conf/keystore.jks</Path>
+                       <KeyAlias>shibhs</KeyAlias>
+                       <CertAlias>shibhs</CertAlias>
+                       <StorePassword>shibhs</StorePassword>
+                       <KeyPassword>shibhs</KeyPassword>
+               </KeyStoreResolver>
+       </Credentials>
+
+       <ProtocolHandler type="ShibbolethV1SSOHandler">
+               <Location>https?://[^:/]+(:(443|80))?/$IDP_WEBAPP_NAME$/SSO</Location> 
+       </ProtocolHandler>
+
+       <MetadataProvider type="edu.internet2.middleware.shibboleth.metadata.FilesystemMetadataProvider"
+                path="$IDP_HOME$/etc/example-metadata.xml"/>
+
+</IdPConfig>
\ No newline at end of file

diff --git a/src/edu/internet2/middleware/shibboleth/common/RelyingParty.java b/src/edu/internet2/middleware/shibboleth/common/RelyingParty.java
index f219908..cdfebfb 100644 (file)
--- a/src/edu/internet2/middleware/shibboleth/common/RelyingParty.java
+++ b/src/edu/internet2/middleware/shibboleth/common/RelyingParty.java
@@ -24,8 +24,6 @@ package edu.internet2.middleware.shibboleth.common;
  */
 public interface RelyingParty {
 
-       // TODO add support for extension attributes via getAttribute(foo)
-
        /**
         * Returns the appropriate identity provider to create assertions for this relying party.
         * 
@@ -78,4 +76,9 @@ public interface RelyingParty {
         */
        public String getDefaultTarget();
 
+       /**
+        * Provides a mechanism for extension developers to pass relying party specific data into their extensions.
+        */
+       public String getCustomAttribute(String name);
+
 }

diff --git a/src/edu/internet2/middleware/shibboleth/common/RelyingPartyMapper.java b/src/edu/internet2/middleware/shibboleth/common/RelyingPartyMapper.java
index c5283e7..cca975a 100644 (file)
--- a/src/edu/internet2/middleware/shibboleth/common/RelyingPartyMapper.java
+++ b/src/edu/internet2/middleware/shibboleth/common/RelyingPartyMapper.java
@@ -16,6 +16,8 @@
 
 package edu.internet2.middleware.shibboleth.common;
 
+import java.util.Arrays;
+import java.util.Collection;
 import java.util.HashMap;
 import java.util.Map;
 
@@ -25,7 +27,9 @@ import org.opensaml.saml2.metadata.EntityDescriptor;
 import org.opensaml.saml2.metadata.provider.MetadataProvider;
 import org.opensaml.saml2.metadata.provider.MetadataProviderException;
 import org.opensaml.xml.XMLObject;
+import org.w3c.dom.Attr;
 import org.w3c.dom.Element;
+import org.w3c.dom.NamedNodeMap;
 import org.w3c.dom.NodeList;
 
 import edu.internet2.middleware.shibboleth.idp.IdPConfig;
@@ -236,6 +240,10 @@ public class RelyingPartyMapper {
                private boolean wantsAssertionsSigned = false;
                private int preferredArtifactType = 1;
                private String defaultTarget;
+               private Map<String, String> extensionAttributes = new HashMap<String, String>();
+               private Collection<String> knownAttributes = Arrays.asList(new String[]{"providerId", "passThruErrors",
+                               "defaultToPOSTProfile", "singleAssertion", "signAssertions", "defaultTarget", "forceAttributePush",
+                               "preferredArtifactType", "signingCredential"});
 
                public RelyingPartyImpl(Element partyConfig, Credentials credentials) throws RelyingPartyMapperException {
 
@@ -335,6 +343,14 @@ public class RelyingPartyMapper {
                        // Initialize and Identity Provider object for this use by this relying party
                        identityProvider = new RelyingPartyIdentityProvider(providerId, signingCredential);
 
+                       // Track extension attributes
+                       NamedNodeMap nodeMap = ((Element) partyConfig).getAttributes();
+                       for (int i = 0; i < nodeMap.getLength(); i++) {
+                               Attr attr = (Attr) nodeMap.item(i);
+                               if (!knownAttributes.contains(attr.getName())) {
+                                       extensionAttributes.put(attr.getName(), attr.getValue());
+                               }
+                       }
                }
 
                public IdentityProvider getIdentityProvider() {
@@ -382,6 +398,11 @@ public class RelyingPartyMapper {
                        return defaultTarget;
                }
 
+               public String getCustomAttribute(String name) {
+
+                       return extensionAttributes.get(name);
+               }
+
                /**
                 * Default identity provider implementation.
                 * 
@@ -414,6 +435,7 @@ public class RelyingPartyMapper {
                                return credential;
                        }
                }
+
        }
 
        class NamedRelyingParty extends RelyingPartyImpl {

diff --git a/tests/edu/internet2/middleware/shibboleth/common/RelyingPartyMapperTests.java b/tests/edu/internet2/middleware/shibboleth/common/RelyingPartyMapperTests.java
index ad679d8..ae0f6b7 100644 (file)
--- a/tests/edu/internet2/middleware/shibboleth/common/RelyingPartyMapperTests.java
+++ b/tests/edu/internet2/middleware/shibboleth/common/RelyingPartyMapperTests.java
@@ -223,4 +223,46 @@ public class RelyingPartyMapperTests extends TestCase {
                        fail("Unable to load XML parser: " + e.getMessage());
                }
        }
+
+       public void testCustomAttributes() {
+
+               try {
+                       // Parse IdP config file
+                       String fileLocation = "data/relyingPartyMapper3.xml";
+                       DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
+                       factory.setValidating(false);
+                       factory.setNamespaceAware(true);
+
+                       // We have to get a credentials set in order to init the mapper
+                       NodeList credentialNodes = factory.newDocumentBuilder().parse(
+                                       new InputSource(new FileInputStream(fileLocation))).getDocumentElement().getElementsByTagNameNS(
+                                       Credentials.credentialsNamespace, "Credentials");
+                       Credentials credentials = new Credentials((Element) credentialNodes.item(0));
+
+                       RelyingPartyMapper mapper = new RelyingPartyMapper(factory.newDocumentBuilder().parse(
+                                       new InputSource(new FileInputStream(fileLocation))).getDocumentElement(), credentials);
+
+                       // Make sure we can lookup by providerId
+                       assertNotNull("Expected relying party lookup to succeed.", mapper.getRelyingParty("urn-x:test:1"));
+
+                       // Check the extended config data for the relying party
+                       assertEquals("Incorrect extenstion attribute for relying party.", "foo", mapper.getRelyingParty(
+                                       "urn-x:test:1").getCustomAttribute("extension1"));
+                       assertEquals("Incorrect extension attribute for relying party.", "bar", mapper.getRelyingParty(
+                                       "urn-x:test:1").getCustomAttribute("extension2"));
+                       assertNull("Incorrect extension attribute for relying party.", mapper.getRelyingParty("urn-x:test:1")
+                                       .getCustomAttribute("extension3"));
+                       assertNull("Incorrect extension attribute for relying party.", mapper.getRelyingParty("urn-x:test:1")
+                                       .getCustomAttribute("providerId"));
+
+               } catch (SAXException e) {
+                       fail("Error in test specification: " + e.getMessage());
+               } catch (IOException e) {
+                       fail("Error in test specification: " + e.getMessage());
+               } catch (RelyingPartyMapperException e) {
+                       fail("Unable to load relying party mapper: " + e.getMessage());
+               } catch (ParserConfigurationException e) {
+                       fail("Unable to load XML parser: " + e.getMessage());
+               }
+       }
 }
\ No newline at end of file