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