Support for conditional encryption and signing based on what the transport and bindin...
[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             artifactMap.remove(requestContext.getArtifact());
129             SAMLObject referencedMessage = artifactEntry.getSamlMessage();
130             requestContext.setReferencedMessage(referencedMessage);
131
132             // create the SAML response
133             samlResponse = buildArtifactResponse(requestContext);
134         } catch (ProfileException e) {
135             samlResponse = buildArtifactErrorResponse(requestContext);
136         }
137
138         requestContext.setOutboundSAMLMessage(samlResponse);
139         requestContext.setOutboundSAMLMessageId(samlResponse.getID());
140         requestContext.setOutboundSAMLMessageIssueInstant(samlResponse.getIssueInstant());
141
142         encodeResponse(requestContext);
143         writeAuditLogEntry(requestContext);
144     }
145
146     /**
147      * Decodes an incoming request and populates a created request context with the resultant information.
148      * 
149      * @param inTransport inbound message transport
150      * @param outTransport outbound message transport
151      * 
152      * @return the created request context
153      * 
154      * @throws ProfileException throw if there is a problem decoding the request
155      */
156     protected ArtifactResolutionRequestContext decodeRequest(HTTPInTransport inTransport, HTTPOutTransport outTransport)
157             throws ProfileException {
158         log.debug("Decoding message with decoder binding {}", getInboundBinding());
159
160         MetadataProvider metadataProvider = getMetadataProvider();
161
162         ArtifactResolutionRequestContext requestContext = new ArtifactResolutionRequestContext();
163         requestContext.setMetadataProvider(metadataProvider);
164         requestContext.setSecurityPolicyResolver(getSecurityPolicyResolver());
165
166         requestContext.setCommunicationProfileId(ArtifactResolutionConfiguration.PROFILE_ID);
167         requestContext.setInboundMessageTransport(inTransport);
168         requestContext.setInboundSAMLProtocol(SAMLConstants.SAML20P_NS);
169         requestContext.setPeerEntityRole(SPSSODescriptor.DEFAULT_ELEMENT_NAME);
170
171         requestContext.setOutboundMessageTransport(outTransport);
172         requestContext.setOutboundSAMLProtocol(SAMLConstants.SAML20P_NS);
173
174         try {
175             SAMLMessageDecoder decoder = getMessageDecoders().get(getInboundBinding());
176             requestContext.setMessageDecoder(decoder);
177             decoder.decode(requestContext);
178             log.debug("Decoded request");
179             return requestContext;
180         } catch (MessageDecodingException e) {
181             log.error("Error decoding artifact resolve message", e);
182             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Error decoding message"));
183             throw new ProfileException("Error decoding artifact resolve message");
184         } catch (SecurityException e) {
185             log.error("Message did not meet security requirements", e);
186             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, StatusCode.REQUEST_DENIED_URI,
187                     "Message did not meet security requirements"));
188             throw new ProfileException("Message did not meet security requirements", e);
189         } finally {
190             // Set as much information as can be retrieved from the decoded message
191             requestContext.setArtifact(requestContext.getInboundSAMLMessage().getArtifact().getArtifact());
192
193             String relyingPartyId = requestContext.getInboundMessageIssuer();
194             RelyingPartyConfiguration rpConfig = getRelyingPartyConfiguration(relyingPartyId);
195             if (rpConfig == null) {
196                 log.error("Unable to retrieve relying party configuration data for entity with ID {}", relyingPartyId);
197                 throw new ProfileException("Unable to retrieve relying party configuration data for entity with ID "
198                         + relyingPartyId);
199             }
200             requestContext.setRelyingPartyConfiguration(rpConfig);
201
202             ArtifactResolutionConfiguration profileConfig = (ArtifactResolutionConfiguration) rpConfig
203                     .getProfileConfiguration(ArtifactResolutionConfiguration.PROFILE_ID);
204             requestContext.setProfileConfiguration(profileConfig);
205             requestContext.setPeerEntityEndpoint(selectEndpoint(requestContext));
206
207             String assertingPartyId = requestContext.getRelyingPartyConfiguration().getProviderId();
208             requestContext.setLocalEntityId(assertingPartyId);
209             try {
210                 EntityDescriptor localEntityDescriptor = metadataProvider.getEntityDescriptor(assertingPartyId);
211                 if (localEntityDescriptor != null) {
212                     requestContext.setLocalEntityMetadata(localEntityDescriptor);
213                     requestContext.setLocalEntityRole(AttributeAuthorityDescriptor.DEFAULT_ELEMENT_NAME);
214                     requestContext.setLocalEntityRoleMetadata(localEntityDescriptor
215                             .getAttributeAuthorityDescriptor(SAMLConstants.SAML20P_NS));
216                 }
217             } catch (MetadataProviderException e) {
218                 log.error("Unable to locate metadata for asserting party");
219                 requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null,
220                         "Error locating asserting party metadata"));
221                 throw new ProfileException("Error locating asserting party metadata");
222             }
223         }
224     }
225
226     /**
227      * Selects the appropriate endpoint for the relying party and stores it in the request context.
228      * 
229      * @param requestContext current request context
230      * 
231      * @return Endpoint selected from the information provided in the request context
232      */
233     protected Endpoint selectEndpoint(ArtifactResolutionRequestContext requestContext) {
234         Endpoint endpoint;
235
236         if (getInboundBinding().equals(SAMLConstants.SAML2_SOAP11_BINDING_URI)) {
237             endpoint = acsEndpointBuilder.buildObject();
238             endpoint.setBinding(SAMLConstants.SAML2_SOAP11_BINDING_URI);
239         } else {
240             BasicEndpointSelector endpointSelector = new BasicEndpointSelector();
241             endpointSelector.setEndpointType(AssertionConsumerService.DEFAULT_ELEMENT_NAME);
242             endpointSelector.setMetadataProvider(getMetadataProvider());
243             endpointSelector.setEntityMetadata(requestContext.getPeerEntityMetadata());
244             endpointSelector.setEntityRoleMetadata(requestContext.getPeerEntityRoleMetadata());
245             endpointSelector.setSamlRequest(requestContext.getInboundSAMLMessage());
246             endpointSelector.getSupportedIssuerBindings().addAll(getSupportedOutboundBindings());
247             endpoint = endpointSelector.selectEndpoint();
248         }
249
250         return endpoint;
251     }
252
253     /**
254      * Constructs a artifact resolution response with the derferenced SAML message inside.
255      * 
256      * @param requestContext current request context
257      * 
258      * @return constructed response
259      */
260     protected ArtifactResponse buildArtifactResponse(ArtifactResolutionRequestContext requestContext) {
261         DateTime issueInstant = new DateTime();
262
263         // create the SAML response and add the assertion
264         ArtifactResponse samlResponse = responseBuilder.buildObject();
265         samlResponse.setIssueInstant(issueInstant);
266         populateStatusResponse(requestContext, samlResponse);
267
268         if (requestContext.getFailureStatus() == null) {
269             Status status = buildStatus(StatusCode.SUCCESS_URI, null, null);
270             samlResponse.setStatus(status);
271             samlResponse.setMessage(requestContext.getReferencedMessage());
272         } else {
273             samlResponse.setStatus(requestContext.getFailureStatus());
274         }
275
276         return samlResponse;
277     }
278
279     /**
280      * Constructs an artifact resolution response with an error status as content.
281      * 
282      * @param requestContext current request context
283      * 
284      * @return constructed response
285      */
286     protected ArtifactResponse buildArtifactErrorResponse(ArtifactResolutionRequestContext requestContext) {
287         ArtifactResponse samlResponse = responseBuilder.buildObject();
288         samlResponse.setIssueInstant(new DateTime());
289         populateStatusResponse(requestContext, samlResponse);
290
291         samlResponse.setStatus(requestContext.getFailureStatus());
292
293         return samlResponse;
294     }
295
296     /** Represents the internal state of a SAML 2.0 Artiface resolver request while it's being processed by the IdP. */
297     public class ArtifactResolutionRequestContext extends
298             BaseSAML2ProfileRequestContext<ArtifactResolve, ArtifactResponse, ArtifactResolutionConfiguration>
299             implements SAML2ArtifactMessageContext<ArtifactResolve, ArtifactResponse, NameID> {
300
301         /** Artifact to be resolved. */
302         private String artifact;
303
304         /** Message referenced by the SAML artifact. */
305         private SAMLObject referencedMessage;
306
307         /** {@inheritDoc} */
308         public String getArtifact() {
309             return artifact;
310         }
311
312         /** {@inheritDoc} */
313         public void setArtifact(String saml2Artifact) {
314             this.artifact = saml2Artifact;
315         }
316
317         /**
318          * Gets the SAML message referenced by the artifact.
319          * 
320          * @return SAML message referenced by the artifact
321          */
322         public SAMLObject getReferencedMessage() {
323             return referencedMessage;
324         }
325
326         /**
327          * Sets the SAML message referenced by the artifact.
328          * 
329          * @param message SAML message referenced by the artifact
330          */
331         public void setReferencedMessage(SAMLObject message) {
332             referencedMessage = message;
333         }
334     }
335 }