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