ba5de11e2ce68835fafdceb4a9777380ea2794ba
[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             try {
190                 EntityDescriptor localEntityDescriptor = metadataProvider.getEntityDescriptor(assertingPartyId);
191                 if (localEntityDescriptor != null) {
192                     requestContext.setLocalEntityMetadata(localEntityDescriptor);
193                     requestContext.setLocalEntityRole(AttributeAuthorityDescriptor.DEFAULT_ELEMENT_NAME);
194                     requestContext.setLocalEntityRoleMetadata(localEntityDescriptor
195                             .getAttributeAuthorityDescriptor(SAMLConstants.SAML11P_NS));
196                 }
197             } catch (MetadataProviderException e) {
198                 log.error("Unable to locate metadata for asserting party");
199                 requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null,
200                         "Error locating asserting party metadata"));
201                 throw new ProfileException("Error locating asserting 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 }