View Javadoc

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