src/edu/internet2/middleware/shibboleth/idp/profile/saml1/ArtifactResolution.java

   1 /*
   2  * Copyright [2006] [University Corporation for Advanced Internet Development, Inc.]
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 package edu.internet2.middleware.shibboleth.idp.profile.saml1;
  18
  19 import java.util.ArrayList;
  20 import java.util.Collection;
  21 import java.util.List;
  22
  23 import org.joda.time.DateTime;
  24 import org.opensaml.common.SAMLObjectBuilder;
  25 import org.opensaml.common.binding.BasicEndpointSelector;
  26 import org.opensaml.common.binding.artifact.SAMLArtifactMap;
  27 import org.opensaml.common.binding.artifact.SAMLArtifactMap.SAMLArtifactMapEntry;
  28 import org.opensaml.common.binding.decoding.SAMLMessageDecoder;
  29 import org.opensaml.common.xml.SAMLConstants;
  30 import org.opensaml.saml1.binding.SAML1ArtifactMessageContext;
  31 import org.opensaml.saml1.core.Assertion;
  32 import org.opensaml.saml1.core.AssertionArtifact;
  33 import org.opensaml.saml1.core.NameIdentifier;
  34 import org.opensaml.saml1.core.Request;
  35 import org.opensaml.saml1.core.Response;
  36 import org.opensaml.saml1.core.Status;
  37 import org.opensaml.saml1.core.StatusCode;
  38 import org.opensaml.saml2.metadata.AssertionConsumerService;
  39 import org.opensaml.saml2.metadata.AttributeAuthorityDescriptor;
  40 import org.opensaml.saml2.metadata.Endpoint;
  41 import org.opensaml.saml2.metadata.SPSSODescriptor;
  42 import org.opensaml.saml2.metadata.provider.MetadataProvider;
  43 import org.opensaml.saml2.metadata.provider.MetadataProviderException;
  44 import org.opensaml.ws.message.decoder.MessageDecodingException;
  45 import org.opensaml.ws.transport.http.HTTPInTransport;
  46 import org.opensaml.ws.transport.http.HTTPOutTransport;
  47 import org.opensaml.xml.security.SecurityException;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50
  51 import edu.internet2.middleware.shibboleth.common.profile.ProfileException;
  52 import edu.internet2.middleware.shibboleth.common.relyingparty.RelyingPartyConfiguration;
  53 import edu.internet2.middleware.shibboleth.common.relyingparty.provider.saml1.ArtifactResolutionConfiguration;
  54
  55 /**
  56  * SAML 1 Artifact resolution profile handler.
  57  */
  58 public class ArtifactResolution extends AbstractSAML1ProfileHandler {
  59
  60     /** Class logger. */
  61     private final Logger log = LoggerFactory.getLogger(ArtifactResolution.class);
  62
  63     /** Builder of Response objects. */
  64     private SAMLObjectBuilder<Response> responseBuilder;
  65
  66     /** Builder of assertion consumer service endpoints. */
  67     private SAMLObjectBuilder<AssertionConsumerService> acsEndpointBuilder;
  68
  69     /** Map artifacts to SAML messages. */
  70     private SAMLArtifactMap artifactMap;
  71
  72     /**
  73      * Constructor.
  74      *
  75      * @param map ArtifactMap used to lookup artifacts to be resolved.
  76      */
  77     public ArtifactResolution(SAMLArtifactMap map) {
  78         super();
  79
  80         artifactMap = map;
  81
  82         responseBuilder = (SAMLObjectBuilder<Response>) getBuilderFactory().getBuilder(Response.DEFAULT_ELEMENT_NAME);
  83         acsEndpointBuilder = (SAMLObjectBuilder<AssertionConsumerService>) getBuilderFactory().getBuilder(
  84                 AssertionConsumerService.DEFAULT_ELEMENT_NAME);
  85     }
  86
  87     /** {@inheritDoc} */
  88     public String getProfileId() {
  89         return "urn:mace:shibboleth:2.0:idp:profiles:saml1:request:artifact";
  90     }
  91
  92     /** {@inheritDoc} */
  93     public void processRequest(HTTPInTransport inTransport, HTTPOutTransport outTransport) throws ProfileException {
  94         Response samlResponse;
  95
  96         ArtifactResolutionRequestContext requestContext = decodeRequest(inTransport, outTransport);
  97
  98         try {
  99             if (requestContext.getProfileConfiguration() == null) {
 100                 log.error("SAML 1 Artifact resolution profile is not configured for relying party "
 101                         + requestContext.getInboundMessageIssuer());
 102                 requestContext.setFailureStatus(buildStatus(StatusCode.SUCCESS, StatusCode.REQUEST_DENIED,
 103                         "SAML 1 Artifact resolution profile is not configured for relying party "
 104                                 + requestContext.getInboundMessageIssuer()));
 105                 throw new ProfileException("SAML 1 Artifact resolution profile is not configured for relying party "
 106                         + requestContext.getInboundMessageIssuer());
 107             }
 108
 109             checkSamlVersion(requestContext);
 110
 111             derferenceArtifacts(requestContext);
 112
 113             // create the SAML response
 114             samlResponse = buildArtifactResponse(requestContext);
 115         } catch (ProfileException e) {
 116             samlResponse = buildErrorResponse(requestContext);
 117         }
 118
 119         requestContext.setOutboundSAMLMessage(samlResponse);
 120         requestContext.setOutboundSAMLMessageId(samlResponse.getID());
 121         requestContext.setOutboundSAMLMessageIssueInstant(samlResponse.getIssueInstant());
 122
 123         encodeResponse(requestContext);
 124         writeAuditLogEntry(requestContext);
 125     }
 126
 127     /**
 128      * Decodes an incoming request and populates a created request context with the resultant information.
 129      *
 130      * @param inTransport inbound message transport
 131      * @param outTransport outbound message transport
 132      *
 133      * @return the created request context
 134      *
 135      * @throws ProfileException throw if there is a problem decoding the request
 136      */
 137     protected ArtifactResolutionRequestContext decodeRequest(HTTPInTransport inTransport, HTTPOutTransport outTransport)
 138             throws ProfileException {
 139         log.debug("Decoding incomming request");
 140
 141         MetadataProvider metadataProvider = getMetadataProvider();
 142
 143         ArtifactResolutionRequestContext requestContext = new ArtifactResolutionRequestContext();
 144         requestContext.setMetadataProvider(metadataProvider);
 145         requestContext.setSecurityPolicyResolver(getSecurityPolicyResolver());
 146
 147         requestContext.setCommunicationProfileId(ArtifactResolutionConfiguration.PROFILE_ID);
 148         requestContext.setInboundMessageTransport(inTransport);
 149         requestContext.setInboundSAMLProtocol(SAMLConstants.SAML11P_NS);
 150         requestContext.setPeerEntityRole(SPSSODescriptor.DEFAULT_ELEMENT_NAME);
 151
 152         requestContext.setOutboundMessageTransport(outTransport);
 153         requestContext.setOutboundSAMLProtocol(SAMLConstants.SAML11P_NS);
 154
 155         try {
 156             SAMLMessageDecoder decoder = getMessageDecoders().get(getInboundBinding());
 157             requestContext.setMessageDecoder(decoder);
 158             decoder.decode(requestContext);
 159             log.debug("Decoded request");
 160             return requestContext;
 161         } catch (MessageDecodingException e) {
 162             log.error("Error decoding artifact resolve message", e);
 163             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null, "Error decoding message"));
 164             throw new ProfileException("Error decoding artifact resolve message");
 165         } catch (SecurityException e) {
 166             log.error("Message did not meet security requirements", e);
 167             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, StatusCode.REQUEST_DENIED,
 168                     "Message did not meet security requirements"));
 169             throw new ProfileException("Message did not meet security requirements", e);
 170         } finally {
 171             // Set as much information as can be retrieved from the decoded message
 172             try {
 173                 String relyingPartyId = requestContext.getInboundMessageIssuer();
 174                 RelyingPartyConfiguration rpConfig = getRelyingPartyConfiguration(relyingPartyId);
 175                 requestContext.setRelyingPartyConfiguration(rpConfig);
 176                 requestContext.setPeerEntityEndpoint(selectEndpoint(requestContext));
 177
 178                 String assertingPartyId = requestContext.getRelyingPartyConfiguration().getProviderId();
 179                 requestContext.setLocalEntityId(assertingPartyId);
 180                 requestContext.setLocalEntityMetadata(metadataProvider.getEntityDescriptor(assertingPartyId));
 181                 requestContext.setLocalEntityRole(AttributeAuthorityDescriptor.DEFAULT_ELEMENT_NAME);
 182                 requestContext.setLocalEntityRoleMetadata(requestContext.getLocalEntityMetadata()
 183                         .getAttributeAuthorityDescriptor(SAMLConstants.SAML11P_NS));
 184
 185                 ArtifactResolutionConfiguration profileConfig = (ArtifactResolutionConfiguration) rpConfig
 186                         .getProfileConfiguration(ArtifactResolutionConfiguration.PROFILE_ID);
 187                 if(profileConfig != null){
 188                     requestContext.setProfileConfiguration(profileConfig);
 189                     if (profileConfig.getSigningCredential() != null) {
 190                         requestContext.setOutboundSAMLMessageSigningCredential(profileConfig.getSigningCredential());
 191                     } else if (rpConfig.getDefaultSigningCredential() != null) {
 192                         requestContext.setOutboundSAMLMessageSigningCredential(rpConfig.getDefaultSigningCredential());
 193                     }
 194                 }
 195
 196             } catch (MetadataProviderException e) {
 197                 log.error("Unable to locate metadata for asserting or relying party");
 198                 requestContext
 199                         .setFailureStatus(buildStatus(StatusCode.RESPONDER, null, "Error locating party metadata"));
 200                 throw new ProfileException("Error locating party metadata");
 201             }
 202         }
 203     }
 204
 205     /**
 206      * Selects the appropriate endpoint for the relying party and stores it in the request context.
 207      *
 208      * @param requestContext current request context
 209      *
 210      * @return Endpoint selected from the information provided in the request context
 211      */
 212     protected Endpoint selectEndpoint(ArtifactResolutionRequestContext requestContext) {
 213         Endpoint endpoint;
 214
 215         if (getInboundBinding().equals(SAMLConstants.SAML1_SOAP11_BINDING_URI)) {
 216             endpoint = acsEndpointBuilder.buildObject();
 217             endpoint.setBinding(SAMLConstants.SAML1_SOAP11_BINDING_URI);
 218         } else {
 219             BasicEndpointSelector endpointSelector = new BasicEndpointSelector();
 220             endpointSelector.setEndpointType(AssertionConsumerService.DEFAULT_ELEMENT_NAME);
 221             endpointSelector.setMetadataProvider(getMetadataProvider());
 222             endpointSelector.setEntityMetadata(requestContext.getPeerEntityMetadata());
 223             endpointSelector.setEntityRoleMetadata(requestContext.getPeerEntityRoleMetadata());
 224             endpointSelector.setSamlRequest(requestContext.getInboundSAMLMessage());
 225             endpointSelector.getSupportedIssuerBindings().addAll(getSupportedOutboundBindings());
 226             endpoint = endpointSelector.selectEndpoint();
 227         }
 228
 229         return endpoint;
 230     }
 231
 232     /**
 233      * Derferences the artifacts within the incomming request and stores them in the request context.
 234      *
 235      * @param requestContext current request context
 236      *
 237      * @throws ProfileException thrown if the incomming request does not contain any {@link AssertionArtifact}s.
 238      */
 239     protected void derferenceArtifacts(ArtifactResolutionRequestContext requestContext) throws ProfileException {
 240         Request request = requestContext.getInboundSAMLMessage();
 241         List<AssertionArtifact> assertionArtifacts = request.getAssertionArtifacts();
 242
 243         if (assertionArtifacts == null || assertionArtifacts.size() == 0) {
 244             log.error("No AssertionArtifacts available in request");
 245             throw new ProfileException("No AssertionArtifacts available in request");
 246         }
 247
 248         ArrayList<Assertion> assertions = new ArrayList<Assertion>();
 249         SAMLArtifactMapEntry artifactEntry;
 250         for (AssertionArtifact assertionArtifact : assertionArtifacts) {
 251             artifactEntry = artifactMap.get(assertionArtifact.getAssertionArtifact());
 252             if (artifactEntry == null || artifactEntry.isExpired()) {
 253                 log.error("Unknown artifact.");
 254             }
 255
 256             if (!artifactEntry.getIssuerId().equals(requestContext.getLocalEntityId())) {
 257                 log.error("Artifact issuer mismatch.  Artifact issued by " + artifactEntry.getIssuerId()
 258                         + " but IdP has entity ID of " + requestContext.getLocalEntityId());
 259             }
 260
 261             artifactMap.remove(assertionArtifact.getAssertionArtifact());
 262             assertions.add((Assertion) artifactEntry.getSamlMessage());
 263         }
 264
 265         requestContext.setReferencedAssertions(assertions);
 266     }
 267
 268     /**
 269      * Builds the response to the artifact request.
 270      *
 271      * @param requestContext current request context
 272      *
 273      * @return response to the artifact request
 274      */
 275     protected Response buildArtifactResponse(ArtifactResolutionRequestContext requestContext) {
 276         DateTime issueInstant = new DateTime();
 277
 278         // create the SAML response and add the assertion
 279         Response samlResponse = responseBuilder.buildObject();
 280         samlResponse.setIssueInstant(issueInstant);
 281         populateStatusResponse(requestContext, samlResponse);
 282
 283         if (requestContext.getReferencedAssertions() != null) {
 284             samlResponse.getAssertions().addAll(requestContext.getReferencedAssertions());
 285         }
 286
 287         Status status = buildStatus(StatusCode.SUCCESS, null, null);
 288         samlResponse.setStatus(status);
 289
 290         return samlResponse;
 291     }
 292
 293     /** Represents the internal state of a SAML 1 Artiface resolver request while it's being processed by the IdP. */
 294     public class ArtifactResolutionRequestContext extends
 295             BaseSAML1ProfileRequestContext<Request, Response, ArtifactResolutionConfiguration> implements
 296             SAML1ArtifactMessageContext<Request, Response, NameIdentifier> {
 297
 298         /** Artifact to be resolved. */
 299         private Collection<String> artifacts;
 300
 301         /** Message referenced by the SAML artifact. */
 302         private Collection<Assertion> referencedAssertions;
 303
 304         /** {@inheritDoc} */
 305         public Collection<String> getArtifacts() {
 306             return artifacts;
 307         }
 308
 309         /** {@inheritDoc} */
 310         public void setArtifacts(Collection<String> encodedArtifacts) {
 311             this.artifacts = encodedArtifacts;
 312         }
 313
 314         /**
 315          * Gets the SAML assertions referenced by the artifact(s).
 316          *
 317          * @return SAML assertions referenced by the artifact(s)
 318          */
 319         public Collection<Assertion> getReferencedAssertions() {
 320             return referencedAssertions;
 321         }
 322
 323         /**
 324          * Sets the SAML assertions referenced by the artifact(s).
 325          *
 326          * @param assertions SAML assertions referenced by the artifact(s)
 327          */
 328         public void setReferencedAssertions(Collection<Assertion> assertions) {
 329             referencedAssertions = assertions;
 330         }
 331     }
 332 }