Make sure groups have names.
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / common / ServiceProviderMapper.java
index 7d354c2..264f05b 100644 (file)
@@ -1,26 +1,17 @@
 /*
- * The Shibboleth License, Version 1. Copyright (c) 2002 University Corporation for Advanced Internet Development, Inc.
- * All rights reserved Redistribution and use in source and binary forms, with or without modification, are permitted
- * provided that the following conditions are met: Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above
- * copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials
- * provided with the distribution, if any, must include the following acknowledgment: "This product includes software
- * developed by the University Corporation for Advanced Internet Development <http://www.ucaid.edu> Internet2 Project.
- * Alternately, this acknowledegement may appear in the software itself, if and wherever such third-party
- * acknowledgments normally appear. Neither the name of Shibboleth nor the names of its contributors, nor Internet2, nor
- * the University Corporation for Advanced Internet Development, Inc., nor UCAID may be used to endorse or promote
- * products derived from this software without specific prior written permission. For written permission, please contact
- * shibboleth@shibboleth.org Products derived from this software may not be called Shibboleth, Internet2, UCAID, or the
- * University Corporation for Advanced Internet Development, nor may Shibboleth appear in their name, without prior
- * written permission of the University Corporation for Advanced Internet Development. THIS SOFTWARE IS PROVIDED BY THE
- * COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE
- * DISCLAIMED AND THE ENTIRE RISK OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE. IN NO
- * EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC.
- * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
- * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * Copyright [2005] [University Corporation for Advanced Internet Development, Inc.]
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
  */
 
 package edu.internet2.middleware.shibboleth.common;
@@ -29,7 +20,9 @@ import java.net.MalformedURLException;
 import java.net.URI;
 import java.net.URISyntaxException;
 import java.net.URL;
+import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 
 import org.apache.log4j.Logger;
@@ -37,13 +30,14 @@ import org.w3c.dom.Element;
 import org.w3c.dom.NodeList;
 
 import edu.internet2.middleware.shibboleth.idp.IdPConfig;
+import edu.internet2.middleware.shibboleth.metadata.EntitiesDescriptor;
+import edu.internet2.middleware.shibboleth.metadata.EntityDescriptor;
 import edu.internet2.middleware.shibboleth.metadata.Metadata;
-import edu.internet2.middleware.shibboleth.metadata.Provider;
 
 /**
  * Class for determining the effective relying party from the unique id of the service provider. Checks first for an
- * exact match on the service provider, then for membership in a federation. Uses the default relying party if neither
- * is found.
+ * exact match on the service provider, then for membership in a group of providers (perhaps a federation). Uses the
+ * default relying party if neither is found.
  * 
  * @author Walter Hoehn
  */
@@ -57,14 +51,13 @@ public class ServiceProviderMapper {
        private NameMapper nameMapper;
 
        public ServiceProviderMapper(Element rawConfig, IdPConfig configuration, Credentials credentials,
-                       NameMapper nameMapper, Metadata metaData) throws ServiceProviderMapperException {
+                       NameMapper nameMapper) throws ServiceProviderMapperException {
 
-               this.metaData = metaData;
                this.configuration = configuration;
                this.credentials = credentials;
                this.nameMapper = nameMapper;
 
-               NodeList itemElements = rawConfig.getElementsByTagNameNS(IdPConfig.originConfigNamespace, "RelyingParty");
+               NodeList itemElements = rawConfig.getElementsByTagNameNS(IdPConfig.configNameSpace, "RelyingParty");
 
                for (int i = 0; i < itemElements.getLength(); i++) {
                        addRelyingParty((Element) itemElements.item(i));
@@ -74,7 +67,12 @@ public class ServiceProviderMapper {
 
        }
 
-       private IdPConfig getOriginConfig() {
+       public void setMetadata(Metadata metadata) {
+
+               this.metaData = metadata;
+       }
+
+       private IdPConfig getIdPConfig() {
 
                return configuration;
        }
@@ -99,51 +97,54 @@ public class ServiceProviderMapper {
                }
        }
 
-       protected RelyingParty getRelyingPartyImpl(String providerIdFromTarget) {
+       protected RelyingParty getRelyingPartyImpl(String providerIdFromSP) {
 
                // Null request, send the default
-               if (providerIdFromTarget == null) {
+               if (providerIdFromSP == null) {
                        RelyingParty relyingParty = getDefaultRelyingParty();
                        log.info("Using default Relying Party: (" + relyingParty.getName() + ").");
-                       return new UnknownProviderWrapper(relyingParty, providerIdFromTarget);
+                       return new UnknownProviderWrapper(relyingParty, providerIdFromSP);
                }
 
                // Look for a configuration for the specific relying party
-               if (relyingParties.containsKey(providerIdFromTarget)) {
-                       log.info("Found Relying Party for (" + providerIdFromTarget + ").");
-                       return (RelyingParty) relyingParties.get(providerIdFromTarget);
+               if (relyingParties.containsKey(providerIdFromSP)) {
+                       log.info("Found Relying Party for (" + providerIdFromSP + ").");
+                       return (RelyingParty) relyingParties.get(providerIdFromSP);
                }
 
                // Next, check to see if the relying party is in any groups
-               RelyingParty groupParty = findRelyingPartyByGroup(providerIdFromTarget);
+               RelyingParty groupParty = findRelyingPartyByGroup(providerIdFromSP);
                if (groupParty != null) {
                        log.info("Provider is a member of Relying Party (" + groupParty.getName() + ").");
-                       return new RelyingPartyGroupWrapper(groupParty, providerIdFromTarget);
+                       return new RelyingPartyGroupWrapper(groupParty, providerIdFromSP);
                }
 
                // OK, we can't find it... just send the default
                RelyingParty relyingParty = getDefaultRelyingParty();
-               log.info("Could not locate Relying Party configuration for (" + providerIdFromTarget
+               log.info("Could not locate Relying Party configuration for (" + providerIdFromSP
                                + ").  Using default Relying Party: (" + relyingParty.getName() + ").");
-               return new UnknownProviderWrapper(relyingParty, providerIdFromTarget);
+               return new UnknownProviderWrapper(relyingParty, providerIdFromSP);
        }
 
-       private RelyingParty findRelyingPartyByGroup(String providerIdFromTarget) {
+       private RelyingParty findRelyingPartyByGroup(String providerIdFromSP) {
+
+               if (metaData == null) { return null; }
 
-               Provider provider = metaData.lookup(providerIdFromTarget);
+               EntityDescriptor provider = metaData.lookup(providerIdFromSP);
                if (provider != null) {
-                       String[] groups = provider.getGroups();
-                       for (int i = 0; groups.length > i; i++) {
-                               // We need to iterate backward because the groups go from least to most specific
-                               String group = groups[groups.length - 1 - i];
-                               if (relyingParties.containsKey(group)) {
-                                       log.info("Found matching Relying Party for group (" + group + ").");
-                                       return (RelyingParty) relyingParties.get(group);
-                               } else {
-                                       log
-                                                       .debug("Provider is a member of group (" + group
-                                                                       + "), but no matching Relying Party was found.");
+                       EntitiesDescriptor parent = provider.getEntitiesDescriptor();
+                       while (parent != null) {
+                               if (parent.getName() != null) {
+                                       if (relyingParties.containsKey(parent.getName())) {
+                                               log.info("Found matching Relying Party for group (" + parent.getName() + ").");
+                                               return (RelyingParty) relyingParties.get(parent.getName());
+                                       }
+                                       else {
+                                               log.debug("Provider is a member of group (" + parent.getName()
+                                                               + "), but no matching Relying Party was found.");
+                                       }
                                }
+                               parent = parent.getEntitiesDescriptor();
                        }
                }
                return null;
@@ -153,7 +154,7 @@ public class ServiceProviderMapper {
 
                // If there is no explicit default, pick the single configured Relying
                // Party
-               String defaultParty = getOriginConfig().getDefaultRelyingPartyName();
+               String defaultParty = getIdPConfig().getDefaultRelyingPartyName();
                if (defaultParty == null || defaultParty.equals("")) { return (RelyingParty) relyingParties.values().iterator()
                                .next(); }
 
@@ -167,8 +168,7 @@ public class ServiceProviderMapper {
        public RelyingParty getLegacyRelyingParty() {
 
                RelyingParty relyingParty = getDefaultRelyingParty();
-               log.info("Request is from legacy shib target.  Selecting default Relying Party: (" + relyingParty.getName()
-                               + ").");
+               log.info("Request is from legacy shib SP.  Selecting default Relying Party: (" + relyingParty.getName() + ").");
                return new LegacyWrapper((RelyingParty) relyingParty);
 
        }
@@ -176,15 +176,15 @@ public class ServiceProviderMapper {
        /**
         * Returns the appropriate relying party for the supplied service provider id.
         */
-       public RelyingParty getRelyingParty(String providerIdFromTarget) {
+       public RelyingParty getRelyingParty(String providerIdFromSP) {
 
-               if (providerIdFromTarget == null || providerIdFromTarget.equals("")) {
+               if (providerIdFromSP == null || providerIdFromSP.equals("")) {
                        RelyingParty relyingParty = getDefaultRelyingParty();
                        log.info("Selecting default Relying Party: (" + relyingParty.getName() + ").");
                        return new NoMetadataWrapper((RelyingParty) relyingParty);
                }
 
-               return (RelyingParty) getRelyingPartyImpl(providerIdFromTarget);
+               return (RelyingParty) getRelyingPartyImpl(providerIdFromSP);
        }
 
        private void addRelyingParty(Element e) throws ServiceProviderMapperException {
@@ -211,13 +211,20 @@ public class ServiceProviderMapper {
 
                private RelyingPartyIdentityProvider identityProvider;
                private String name;
-               private String overridenOriginProviderId;
+               private String overridenIdPProviderId;
                private URL overridenAAUrl;
                private URI overridenDefaultAuthMethod;
-               private String hsNameFormatId;
+               private List mappingIds = new ArrayList();
                private IdPConfig configuration;
                private boolean overridenPassThruErrors = false;
                private boolean passThruIsOverriden = false;
+               private boolean forceAttributePush = false;
+               private boolean forceAttributeNoPush = false;
+               private boolean defaultToPOST = true;
+               private boolean wantsAssertionsSigned = false;
+               private int preferredArtifactType = 1;
+               private String defaultTarget;
+               private boolean wantsSchemaHack = false;
 
                public RelyingPartyImpl(Element partyConfig, IdPConfig globalConfig, Credentials credentials,
                                NameMapper nameMapper) throws ServiceProviderMapperException {
@@ -236,7 +243,7 @@ public class ServiceProviderMapper {
                        String attribute = ((Element) partyConfig).getAttribute("providerId");
                        if (attribute != null && !attribute.equals("")) {
                                log.debug("Overriding providerId for Relying Pary (" + name + ") with (" + attribute + ").");
-                               overridenOriginProviderId = attribute;
+                               overridenIdPProviderId = attribute;
                        }
 
                        attribute = ((Element) partyConfig).getAttribute("AAUrl");
@@ -268,34 +275,97 @@ public class ServiceProviderMapper {
                                passThruIsOverriden = true;
                        }
 
-                       // Load and verify the name format that the HS should use in
+                       // SSO profile defaulting
+                       attribute = ((Element) partyConfig).getAttribute("defaultToPOSTProfile");
+                       if (attribute != null && !attribute.equals("")) {
+                               defaultToPOST = Boolean.valueOf(attribute).booleanValue();
+                       }
+                       if (defaultToPOST) {
+                               log.debug("Relying party defaults to POST profile.");
+                       } else {
+                               log.debug("Relying party defaults to Artifact profile.");
+                       }
+
+                       // Relying Party wants assertions signed?
+                       attribute = ((Element) partyConfig).getAttribute("signAssertions");
+                       if (attribute != null && !attribute.equals("")) {
+                               wantsAssertionsSigned = Boolean.valueOf(attribute).booleanValue();
+                       }
+                       if (wantsAssertionsSigned) {
+                               log.debug("Relying party wants SAML Assertions to be signed.");
+                       } else {
+                               log.debug("Relying party does not want SAML Assertions to be signed.");
+                       }
+
+                       // Decide whether or not to use the schema hack for old xerces
+                       attribute = ((Element) partyConfig).getAttribute("schemaHack");
+                       if (attribute != null && !attribute.equals("")) {
+                               wantsSchemaHack = Boolean.valueOf(attribute).booleanValue();
+                       }
+                       if (wantsSchemaHack) {
+                               log.debug("XML schema hack enabled for this relying party.");
+                       }
+
+                       // Set a default target for use in artifact redirects
+                       defaultTarget = ((Element) partyConfig).getAttribute("defaultTarget");
+
+                       // Determine whether or not we are forcing attribute push on or off
+                       String forcePush = ((Element) partyConfig).getAttribute("forceAttributePush");
+                       String forceNoPush = ((Element) partyConfig).getAttribute("forceAttributeNoPush");
+
+                       if (forcePush != null && Boolean.valueOf(forcePush).booleanValue() && forceNoPush != null
+                                       && Boolean.valueOf(forceNoPush).booleanValue()) {
+                               log.error("Invalid configuration:  Attribute push is forced to ON and OFF for this relying "
+                                               + "party.  Turning off forcing in favor of profile defaults.");
+                       } else {
+                               forceAttributePush = Boolean.valueOf(forcePush).booleanValue();
+                               forceAttributeNoPush = Boolean.valueOf(forceNoPush).booleanValue();
+                               log.debug("Attribute push forcing is set to (" + forceAttributePush + ").");
+                               log.debug("No attribute push forcing is set to (" + forceAttributeNoPush + ").");
+                       }
+
+                       attribute = ((Element) partyConfig).getAttribute("preferredArtifactType");
+                       if (attribute != null && !attribute.equals("")) {
+                               log.debug("Overriding AAUrl for Relying Pary (" + name + ") with (" + attribute + ").");
+                               try {
+                                       preferredArtifactType = Integer.parseInt(attribute);
+                               } catch (NumberFormatException e) {
+                                       log.error("(preferredArtifactType) attribute to is not a valid integer.");
+                                       throw new ServiceProviderMapperException("Configuration is invalid.");
+                               }
+                               log.debug("Preferred artifact type: (" + preferredArtifactType + ").");
+                       }
+
+                       // Load and verify the name mappings that should be used in
                        // assertions for this RelyingParty
-                       NodeList hsNameFormats = ((Element) partyConfig).getElementsByTagNameNS(IdPConfig.originConfigNamespace,
-                                       "HSNameFormat");
+
+                       NodeList nameIDs = ((Element) partyConfig).getElementsByTagNameNS(IdPConfig.configNameSpace, "NameID");
                        // If no specification. Make sure we have a default mapping
-                       if (hsNameFormats.getLength() < 1) {
+                       if (nameIDs.getLength() < 1) {
                                if (nameMapper.getNameIdentifierMappingById(null) == null) {
-                                       log.error("Relying Party HS Name Format not set.  Add a <HSNameFormat> element to <RelyingParty>.");
+                                       log.error("Relying Party NameId configuration not set.  Add a <NameID> element to <RelyingParty>.");
                                        throw new ServiceProviderMapperException("Required configuration not specified.");
                                }
 
                        } else {
+
                                // We do have a specification, so make sure it points to a
                                // valid Name Mapping
-                               if (hsNameFormats.getLength() > 1) {
-                                       log.warn("Found multiple HSNameFormat specifications for Relying Party (" + name
-                                                       + ").  Ignoring all but the first.");
-                               }
 
-                               hsNameFormatId = ((Element) hsNameFormats.item(0)).getAttribute("nameMapping");
-                               if (hsNameFormatId == null || hsNameFormatId.equals("")) {
-                                       log.error("HS Name Format mapping not set.  Add a (nameMapping) attribute to <HSNameFormat>.");
-                                       throw new ServiceProviderMapperException("Required configuration not specified.");
-                               }
+                               for (int i = 0; i < nameIDs.getLength(); i++) {
 
-                               if (nameMapper.getNameIdentifierMappingById(hsNameFormatId) == null) {
-                                       log.error("Relying Party HS Name Format refers to a name mapping that is not loaded.");
-                                       throw new ServiceProviderMapperException("Required configuration not specified.");
+                                       String mappingId = ((Element) nameIDs.item(i)).getAttribute("nameMapping");
+                                       if (mappingId == null || mappingId.equals("")) {
+                                               log.error("Name mapping not set.  Add a (nameMapping) attribute to <NameID>.");
+                                               throw new ServiceProviderMapperException("Required configuration not specified.");
+                                       }
+
+                                       if (nameMapper.getNameIdentifierMappingById(mappingId) == null) {
+                                               log.error("Relying Party NameID refers to a name mapping that is not loaded.");
+                                               throw new ServiceProviderMapperException("Required configuration not specified.");
+                                       }
+
+                                       mappingIds.add(mappingId);
                                }
                        }
 
@@ -316,8 +386,8 @@ public class ServiceProviderMapper {
                        }
 
                        // Initialize and Identity Provider object for this use by this relying party
-                       identityProvider = new RelyingPartyIdentityProvider(overridenOriginProviderId != null
-                                       ? overridenOriginProviderId
+                       identityProvider = new RelyingPartyIdentityProvider(overridenIdPProviderId != null
+                                       ? overridenIdPProviderId
                                        : configuration.getProviderId(), signingCredential);
 
                }
@@ -342,9 +412,9 @@ public class ServiceProviderMapper {
                        return false;
                }
 
-               public String getHSNameFormatId() {
+               public String[] getNameMapperIds() {
 
-                       return hsNameFormatId;
+                       return (String[]) mappingIds.toArray(new String[0]);
                }
 
                public URI getDefaultAuthMethod() {
@@ -374,6 +444,41 @@ public class ServiceProviderMapper {
                        }
                }
 
+               public boolean forceAttributePush() {
+
+                       return forceAttributePush;
+               }
+
+               public boolean forceAttributeNoPush() {
+
+                       return forceAttributeNoPush;
+               }
+
+               public boolean defaultToPOSTProfile() {
+
+                       return defaultToPOST;
+               }
+
+               public boolean wantsAssertionsSigned() {
+
+                       return wantsAssertionsSigned;
+               }
+
+               public int getPreferredArtifactType() {
+
+                       return preferredArtifactType;
+               }
+
+               public String getDefaultTarget() {
+
+                       return defaultTarget;
+               }
+
+               public boolean wantsSchemaHack() {
+
+                       return wantsSchemaHack;
+               }
+
                /**
                 * Default identity provider implementation.
                 * 
@@ -406,10 +511,11 @@ public class ServiceProviderMapper {
                                return credential;
                        }
                }
+
        }
 
        /**
-        * Relying party implementation wrapper for relying parties that are federations.
+        * Relying party implementation wrapper for relying parties that are groups.
         * 
         * @author Walter Hoehn
         */
@@ -444,9 +550,9 @@ public class ServiceProviderMapper {
                        return providerId;
                }
 
-               public String getHSNameFormatId() {
+               public String[] getNameMapperIds() {
 
-                       return wrapped.getHSNameFormatId();
+                       return wrapped.getNameMapperIds();
                }
 
                public URL getAAUrl() {
@@ -463,6 +569,41 @@ public class ServiceProviderMapper {
 
                        return wrapped.passThruErrors();
                }
+
+               public boolean forceAttributePush() {
+
+                       return wrapped.forceAttributePush();
+               }
+
+               public boolean forceAttributeNoPush() {
+
+                       return wrapped.forceAttributeNoPush();
+               }
+
+               public boolean defaultToPOSTProfile() {
+
+                       return wrapped.defaultToPOSTProfile();
+               }
+
+               public boolean wantsAssertionsSigned() {
+
+                       return wrapped.wantsAssertionsSigned();
+               }
+
+               public int getPreferredArtifactType() {
+
+                       return wrapped.getPreferredArtifactType();
+               }
+
+               public String getDefaultTarget() {
+
+                       return wrapped.getDefaultTarget();
+               }
+
+               public boolean wantsSchemaHack() {
+
+                       return wrapped.wantsSchemaHack();
+               }
        }
 
        /**
@@ -496,9 +637,9 @@ public class ServiceProviderMapper {
                        return providerId;
                }
 
-               public String getHSNameFormatId() {
+               public String[] getNameMapperIds() {
 
-                       return wrapped.getHSNameFormatId();
+                       return wrapped.getNameMapperIds();
                }
 
                public boolean isLegacyProvider() {
@@ -520,6 +661,41 @@ public class ServiceProviderMapper {
 
                        return wrapped.passThruErrors();
                }
+
+               public boolean forceAttributePush() {
+
+                       return false;
+               }
+
+               public boolean forceAttributeNoPush() {
+
+                       return false;
+               }
+
+               public boolean defaultToPOSTProfile() {
+
+                       return true;
+               }
+
+               public boolean wantsAssertionsSigned() {
+
+                       return wrapped.wantsAssertionsSigned();
+               }
+
+               public int getPreferredArtifactType() {
+
+                       return wrapped.getPreferredArtifactType();
+               }
+
+               public String getDefaultTarget() {
+
+                       return wrapped.getDefaultTarget();
+               }
+
+               public boolean wantsSchemaHack() {
+
+                       return wrapped.wantsSchemaHack();
+               }
        }
 
        /**
@@ -539,9 +715,9 @@ public class ServiceProviderMapper {
                        return true;
                }
 
-               public String getHSNameFormatId() {
+               public String[] getNameMapperIds() {
 
-                       return ((RelyingParty) wrapped).getHSNameFormatId();
+                       return ((RelyingParty) wrapped).getNameMapperIds();
                }
 
                public URL getAAUrl() {
@@ -567,9 +743,9 @@ public class ServiceProviderMapper {
                        super(wrapped, null);
                }
 
-               public String getHSNameFormatId() {
+               public String[] getNameMapperIds() {
 
-                       return ((RelyingParty) wrapped).getHSNameFormatId();
+                       return ((RelyingParty) wrapped).getNameMapperIds();
                }
 
                public URL getAAUrl() {