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