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