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