2 * Copyright [2005] [University Corporation for Advanced Internet Development, Inc.]
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 package edu.internet2.middleware.shibboleth.common;
19 import java.net.MalformedURLException;
21 import java.net.URISyntaxException;
23 import java.util.ArrayList;
24 import java.util.HashMap;
25 import java.util.List;
28 import org.apache.log4j.Logger;
29 import org.w3c.dom.Element;
30 import org.w3c.dom.NodeList;
32 import edu.internet2.middleware.shibboleth.idp.IdPConfig;
33 import edu.internet2.middleware.shibboleth.metadata.EntitiesDescriptor;
34 import edu.internet2.middleware.shibboleth.metadata.EntityDescriptor;
35 import edu.internet2.middleware.shibboleth.metadata.Metadata;
38 * Class for determining the effective relying party from the unique id of the service provider. Checks first for an
39 * exact match on the service provider, then for membership in a group of providers (perhaps a federation). Uses the
40 * default relying party if neither is found.
42 * @author Walter Hoehn
44 public class ServiceProviderMapper {
46 private static Logger log = Logger.getLogger(ServiceProviderMapper.class.getName());
47 protected Map relyingParties = new HashMap();
48 private Metadata metaData;
49 private IdPConfig configuration;
50 private Credentials credentials;
51 private NameMapper nameMapper;
53 public ServiceProviderMapper(Element rawConfig, IdPConfig configuration, Credentials credentials,
54 NameMapper nameMapper) throws ServiceProviderMapperException {
56 this.configuration = configuration;
57 this.credentials = credentials;
58 this.nameMapper = nameMapper;
60 NodeList itemElements = rawConfig.getElementsByTagNameNS(IdPConfig.configNameSpace, "RelyingParty");
62 for (int i = 0; i < itemElements.getLength(); i++) {
63 addRelyingParty((Element) itemElements.item(i));
66 verifyDefaultParty(configuration);
70 public void setMetadata(Metadata metadata) {
72 this.metaData = metadata;
75 private IdPConfig getIdPConfig() {
80 protected void verifyDefaultParty(IdPConfig configuration) throws ServiceProviderMapperException {
82 // Verify we have a proper default party
83 String defaultParty = configuration.getDefaultRelyingPartyName();
84 if (defaultParty == null || defaultParty.equals("")) {
85 if (relyingParties.size() != 1) {
87 .error("Default Relying Party not specified. Add a (defaultRelyingParty) attribute to <IdPConfig>.");
88 throw new ServiceProviderMapperException("Required configuration not specified.");
90 log.debug("Only one Relying Party loaded. Using this as the default.");
93 log.debug("Default Relying Party set to: (" + defaultParty + ").");
94 if (!relyingParties.containsKey(defaultParty)) {
95 log.error("Default Relying Party refers to a Relying Party that has not been loaded.");
96 throw new ServiceProviderMapperException("Invalid configuration (Default Relying Party).");
100 protected RelyingParty getRelyingPartyImpl(String providerIdFromSP) {
102 // Null request, send the default
103 if (providerIdFromSP == null) {
104 RelyingParty relyingParty = getDefaultRelyingParty();
105 log.info("Using default Relying Party: (" + relyingParty.getName() + ").");
106 return new UnknownProviderWrapper(relyingParty, providerIdFromSP);
109 // Look for a configuration for the specific relying party
110 if (relyingParties.containsKey(providerIdFromSP)) {
111 log.info("Found Relying Party for (" + providerIdFromSP + ").");
112 return (RelyingParty) relyingParties.get(providerIdFromSP);
115 // Next, check to see if the relying party is in any groups
116 RelyingParty groupParty = findRelyingPartyByGroup(providerIdFromSP);
117 if (groupParty != null) {
118 log.info("Provider is a member of Relying Party (" + groupParty.getName() + ").");
119 return new RelyingPartyGroupWrapper(groupParty, providerIdFromSP);
122 // OK, we can't find it... just send the default
123 RelyingParty relyingParty = getDefaultRelyingParty();
124 log.info("Could not locate Relying Party configuration for (" + providerIdFromSP
125 + "). Using default Relying Party: (" + relyingParty.getName() + ").");
126 return new UnknownProviderWrapper(relyingParty, providerIdFromSP);
129 private RelyingParty findRelyingPartyByGroup(String providerIdFromSP) {
131 if (metaData == null) { return null; }
133 EntityDescriptor provider = metaData.lookup(providerIdFromSP);
134 if (provider != null) {
135 EntitiesDescriptor parent = provider.getEntitiesDescriptor();
136 while (parent != null) {
137 if (parent.getName() != null) {
138 if (relyingParties.containsKey(parent.getName())) {
139 log.info("Found matching Relying Party for group (" + parent.getName() + ").");
140 return (RelyingParty) relyingParties.get(parent.getName());
143 log.debug("Provider is a member of group (" + parent.getName()
144 + "), but no matching Relying Party was found.");
147 parent = parent.getEntitiesDescriptor();
153 public RelyingParty getDefaultRelyingParty() {
155 // If there is no explicit default, pick the single configured Relying
157 String defaultParty = getIdPConfig().getDefaultRelyingPartyName();
158 if (defaultParty == null || defaultParty.equals("")) { return (RelyingParty) relyingParties.values().iterator()
161 // If we do have a default specified, use it...
162 return (RelyingParty) relyingParties.get(defaultParty);
166 * Returns the relying party for a legacy provider(the default)
168 public RelyingParty getLegacyRelyingParty() {
170 RelyingParty relyingParty = getDefaultRelyingParty();
171 log.info("Request is from legacy shib SP. Selecting default Relying Party: (" + relyingParty.getName() + ").");
172 return new LegacyWrapper((RelyingParty) relyingParty);
177 * Returns the appropriate relying party for the supplied service provider id.
179 public RelyingParty getRelyingParty(String providerIdFromSP) {
181 if (providerIdFromSP == null || providerIdFromSP.equals("")) {
182 RelyingParty relyingParty = getDefaultRelyingParty();
183 log.info("Selecting default Relying Party: (" + relyingParty.getName() + ").");
184 return new NoMetadataWrapper((RelyingParty) relyingParty);
187 return (RelyingParty) getRelyingPartyImpl(providerIdFromSP);
190 private void addRelyingParty(Element e) throws ServiceProviderMapperException {
192 log.debug("Found a Relying Party.");
194 if (e.getLocalName().equals("RelyingParty")) {
195 RelyingParty party = new RelyingPartyImpl(e, configuration, credentials, nameMapper);
196 log.debug("Relying Party (" + party.getName() + ") loaded.");
197 relyingParties.put(party.getName(), party);
199 } catch (ServiceProviderMapperException exc) {
200 log.error("Encountered an error while attempting to load Relying Party configuration. Skipping...");
206 * Base relying party implementation.
208 * @author Walter Hoehn
210 protected class RelyingPartyImpl implements RelyingParty {
212 private RelyingPartyIdentityProvider identityProvider;
214 private String overridenIdPProviderId;
215 private URL overridenAAUrl;
216 private URI overridenDefaultAuthMethod;
217 private List mappingIds = new ArrayList();
218 private IdPConfig configuration;
219 private boolean overridenPassThruErrors = false;
220 private boolean passThruIsOverriden = false;
221 private boolean forceAttributePush = false;
222 private boolean forceAttributeNoPush = false;
223 private boolean defaultToPOST = true;
224 private boolean wantsAssertionsSigned = false;
225 private int preferredArtifactType = 1;
226 private String defaultTarget;
227 private boolean wantsSchemaHack = false;
229 public RelyingPartyImpl(Element partyConfig, IdPConfig globalConfig, Credentials credentials,
230 NameMapper nameMapper) throws ServiceProviderMapperException {
232 configuration = globalConfig;
235 name = ((Element) partyConfig).getAttribute("name");
236 if (name == null || name.equals("")) {
237 log.error("Relying Party name not set. Add a (name) attribute to <RelyingParty>.");
238 throw new ServiceProviderMapperException("Required configuration not specified.");
240 log.debug("Loading Relying Party: (" + name + ").");
242 // Process overrides for global configuration data
243 String attribute = ((Element) partyConfig).getAttribute("providerId");
244 if (attribute != null && !attribute.equals("")) {
245 log.debug("Overriding providerId for Relying Pary (" + name + ") with (" + attribute + ").");
246 overridenIdPProviderId = attribute;
249 attribute = ((Element) partyConfig).getAttribute("AAUrl");
250 if (attribute != null && !attribute.equals("")) {
251 log.debug("Overriding AAUrl for Relying Pary (" + name + ") with (" + attribute + ").");
253 overridenAAUrl = new URL(attribute);
254 } catch (MalformedURLException e) {
255 log.error("(AAUrl) attribute to is not a valid URL.");
256 throw new ServiceProviderMapperException("Configuration is invalid.");
260 attribute = ((Element) partyConfig).getAttribute("defaultAuthMethod");
261 if (attribute != null && !attribute.equals("")) {
262 log.debug("Overriding defaultAuthMethod for Relying Pary (" + name + ") with (" + attribute + ").");
264 overridenDefaultAuthMethod = new URI(attribute);
265 } catch (URISyntaxException e1) {
266 log.error("(defaultAuthMethod) attribute to is not a valid URI.");
267 throw new ServiceProviderMapperException("Configuration is invalid.");
271 attribute = ((Element) partyConfig).getAttribute("passThruErrors");
272 if (attribute != null && !attribute.equals("")) {
273 log.debug("Overriding passThruErrors for Relying Pary (" + name + ") with (" + attribute + ").");
274 overridenPassThruErrors = Boolean.valueOf(attribute).booleanValue();
275 passThruIsOverriden = true;
278 // SSO profile defaulting
279 attribute = ((Element) partyConfig).getAttribute("defaultToPOSTProfile");
280 if (attribute != null && !attribute.equals("")) {
281 defaultToPOST = Boolean.valueOf(attribute).booleanValue();
284 log.debug("Relying party defaults to POST profile.");
286 log.debug("Relying party defaults to Artifact profile.");
289 // Relying Party wants assertions signed?
290 attribute = ((Element) partyConfig).getAttribute("signAssertions");
291 if (attribute != null && !attribute.equals("")) {
292 wantsAssertionsSigned = Boolean.valueOf(attribute).booleanValue();
294 if (wantsAssertionsSigned) {
295 log.debug("Relying party wants SAML Assertions to be signed.");
297 log.debug("Relying party does not want SAML Assertions to be signed.");
300 // Decide whether or not to use the schema hack for old xerces
301 attribute = ((Element) partyConfig).getAttribute("schemaHack");
302 if (attribute != null && !attribute.equals("")) {
303 wantsSchemaHack = Boolean.valueOf(attribute).booleanValue();
305 if (wantsSchemaHack) {
306 log.debug("XML schema hack enabled for this relying party.");
309 // Set a default target for use in artifact redirects
310 defaultTarget = ((Element) partyConfig).getAttribute("defaultTarget");
312 // Determine whether or not we are forcing attribute push on or off
313 String forcePush = ((Element) partyConfig).getAttribute("forceAttributePush");
314 String forceNoPush = ((Element) partyConfig).getAttribute("forceAttributeNoPush");
316 if (forcePush != null && Boolean.valueOf(forcePush).booleanValue() && forceNoPush != null
317 && Boolean.valueOf(forceNoPush).booleanValue()) {
318 log.error("Invalid configuration: Attribute push is forced to ON and OFF for this relying "
319 + "party. Turning off forcing in favor of profile defaults.");
321 forceAttributePush = Boolean.valueOf(forcePush).booleanValue();
322 forceAttributeNoPush = Boolean.valueOf(forceNoPush).booleanValue();
323 log.debug("Attribute push forcing is set to (" + forceAttributePush + ").");
324 log.debug("No attribute push forcing is set to (" + forceAttributeNoPush + ").");
327 attribute = ((Element) partyConfig).getAttribute("preferredArtifactType");
328 if (attribute != null && !attribute.equals("")) {
329 log.debug("Overriding AAUrl for Relying Pary (" + name + ") with (" + attribute + ").");
331 preferredArtifactType = Integer.parseInt(attribute);
332 } catch (NumberFormatException e) {
333 log.error("(preferredArtifactType) attribute to is not a valid integer.");
334 throw new ServiceProviderMapperException("Configuration is invalid.");
336 log.debug("Preferred artifact type: (" + preferredArtifactType + ").");
339 // Load and verify the name mappings that should be used in
340 // assertions for this RelyingParty
342 NodeList nameIDs = ((Element) partyConfig).getElementsByTagNameNS(IdPConfig.configNameSpace, "NameID");
343 // If no specification. Make sure we have a default mapping
344 if (nameIDs.getLength() < 1) {
345 if (nameMapper.getNameIdentifierMappingById(null) == null) {
346 log.error("Relying Party NameId configuration not set. Add a <NameID> element to <RelyingParty>.");
347 throw new ServiceProviderMapperException("Required configuration not specified.");
352 // We do have a specification, so make sure it points to a
353 // valid Name Mapping
355 for (int i = 0; i < nameIDs.getLength(); i++) {
357 String mappingId = ((Element) nameIDs.item(i)).getAttribute("nameMapping");
358 if (mappingId == null || mappingId.equals("")) {
359 log.error("Name mapping not set. Add a (nameMapping) attribute to <NameID>.");
360 throw new ServiceProviderMapperException("Required configuration not specified.");
363 if (nameMapper.getNameIdentifierMappingById(mappingId) == null) {
364 log.error("Relying Party NameID refers to a name mapping that is not loaded.");
365 throw new ServiceProviderMapperException("Required configuration not specified.");
368 mappingIds.add(mappingId);
372 // Load the credential for signing
373 String credentialName = ((Element) partyConfig).getAttribute("signingCredential");
374 Credential signingCredential = credentials.getCredential(credentialName);
375 if (signingCredential == null) {
376 if (credentialName == null || credentialName.equals("")) {
377 log.error("Relying Party credential not set. Add a (signingCredential) "
378 + "attribute to <RelyingParty>.");
379 throw new ServiceProviderMapperException("Required configuration not specified.");
381 log.error("Relying Party credential invalid. Fix the (signingCredential) attribute "
382 + "on <RelyingParty>.");
383 throw new ServiceProviderMapperException("Required configuration is invalid.");
388 // Initialize and Identity Provider object for this use by this relying party
389 identityProvider = new RelyingPartyIdentityProvider(overridenIdPProviderId != null
390 ? overridenIdPProviderId
391 : configuration.getProviderId(), signingCredential);
395 public String getProviderId() {
400 public String getName() {
405 public IdentityProvider getIdentityProvider() {
407 return identityProvider;
410 public boolean isLegacyProvider() {
415 public String[] getNameMapperIds() {
417 return (String[]) mappingIds.toArray(new String[0]);
420 public URI getDefaultAuthMethod() {
422 if (overridenDefaultAuthMethod != null) {
423 return overridenDefaultAuthMethod;
425 return configuration.getDefaultAuthMethod();
429 public URL getAAUrl() {
431 if (overridenAAUrl != null) {
432 return overridenAAUrl;
434 return configuration.getAAUrl();
438 public boolean passThruErrors() {
440 if (passThruIsOverriden) {
441 return overridenPassThruErrors;
443 return configuration.passThruErrors();
447 public boolean forceAttributePush() {
449 return forceAttributePush;
452 public boolean forceAttributeNoPush() {
454 return forceAttributeNoPush;
457 public boolean defaultToPOSTProfile() {
459 return defaultToPOST;
462 public boolean wantsAssertionsSigned() {
464 return wantsAssertionsSigned;
467 public int getPreferredArtifactType() {
469 return preferredArtifactType;
472 public String getDefaultTarget() {
474 return defaultTarget;
477 public boolean wantsSchemaHack() {
479 return wantsSchemaHack;
483 * Default identity provider implementation.
485 * @author Walter Hoehn
487 protected class RelyingPartyIdentityProvider implements IdentityProvider {
489 private String providerId;
490 private Credential credential;
492 public RelyingPartyIdentityProvider(String providerId, Credential credential) {
494 this.providerId = providerId;
495 this.credential = credential;
499 * @see edu.internet2.middleware.shibboleth.common.IdentityProvider#getProviderId()
501 public String getProviderId() {
507 * @see edu.internet2.middleware.shibboleth.common.IdentityProvider#getSigningCredential()
509 public Credential getSigningCredential() {
518 * Relying party implementation wrapper for relying parties that are groups.
520 * @author Walter Hoehn
522 class RelyingPartyGroupWrapper implements RelyingParty {
524 private RelyingParty wrapped;
525 private String providerId;
527 RelyingPartyGroupWrapper(RelyingParty wrapped, String providerId) {
529 this.wrapped = wrapped;
530 this.providerId = providerId;
533 public String getName() {
535 return wrapped.getName();
538 public boolean isLegacyProvider() {
543 public IdentityProvider getIdentityProvider() {
545 return wrapped.getIdentityProvider();
548 public String getProviderId() {
553 public String[] getNameMapperIds() {
555 return wrapped.getNameMapperIds();
558 public URL getAAUrl() {
560 return wrapped.getAAUrl();
563 public URI getDefaultAuthMethod() {
565 return wrapped.getDefaultAuthMethod();
568 public boolean passThruErrors() {
570 return wrapped.passThruErrors();
573 public boolean forceAttributePush() {
575 return wrapped.forceAttributePush();
578 public boolean forceAttributeNoPush() {
580 return wrapped.forceAttributeNoPush();
583 public boolean defaultToPOSTProfile() {
585 return wrapped.defaultToPOSTProfile();
588 public boolean wantsAssertionsSigned() {
590 return wrapped.wantsAssertionsSigned();
593 public int getPreferredArtifactType() {
595 return wrapped.getPreferredArtifactType();
598 public String getDefaultTarget() {
600 return wrapped.getDefaultTarget();
603 public boolean wantsSchemaHack() {
605 return wrapped.wantsSchemaHack();
610 * Relying party implementation wrapper for anonymous service providers.
612 * @author Walter Hoehn
614 protected class UnknownProviderWrapper implements RelyingParty {
616 protected RelyingParty wrapped;
617 protected String providerId;
619 protected UnknownProviderWrapper(RelyingParty wrapped, String providerId) {
621 this.wrapped = wrapped;
622 this.providerId = providerId;
625 public String getName() {
627 return wrapped.getName();
630 public IdentityProvider getIdentityProvider() {
632 return wrapped.getIdentityProvider();
635 public String getProviderId() {
640 public String[] getNameMapperIds() {
642 return wrapped.getNameMapperIds();
645 public boolean isLegacyProvider() {
647 return wrapped.isLegacyProvider();
650 public URL getAAUrl() {
652 return wrapped.getAAUrl();
655 public URI getDefaultAuthMethod() {
657 return wrapped.getDefaultAuthMethod();
660 public boolean passThruErrors() {
662 return wrapped.passThruErrors();
665 public boolean forceAttributePush() {
670 public boolean forceAttributeNoPush() {
675 public boolean defaultToPOSTProfile() {
680 public boolean wantsAssertionsSigned() {
682 return wrapped.wantsAssertionsSigned();
685 public int getPreferredArtifactType() {
687 return wrapped.getPreferredArtifactType();
690 public String getDefaultTarget() {
692 return wrapped.getDefaultTarget();
695 public boolean wantsSchemaHack() {
697 return wrapped.wantsSchemaHack();
702 * Relying party wrapper for Shibboleth <=1.1 service providers.
704 * @author Walter Hoehn
706 class LegacyWrapper extends UnknownProviderWrapper implements RelyingParty {
708 LegacyWrapper(RelyingParty wrapped) {
710 super(wrapped, null);
713 public boolean isLegacyProvider() {
718 public String[] getNameMapperIds() {
720 return ((RelyingParty) wrapped).getNameMapperIds();
723 public URL getAAUrl() {
725 return ((RelyingParty) wrapped).getAAUrl();
728 public URI getDefaultAuthMethod() {
730 return ((RelyingParty) wrapped).getDefaultAuthMethod();
735 * Relying party wrapper for providers for which we have no metadata
737 * @author Walter Hoehn
739 class NoMetadataWrapper extends UnknownProviderWrapper implements RelyingParty {
741 NoMetadataWrapper(RelyingParty wrapped) {
743 super(wrapped, null);
746 public String[] getNameMapperIds() {
748 return ((RelyingParty) wrapped).getNameMapperIds();
751 public URL getAAUrl() {
753 return ((RelyingParty) wrapped).getAAUrl();
756 public URI getDefaultAuthMethod() {
758 return ((RelyingParty) wrapped).getDefaultAuthMethod();