2 * Copyright [2006] [University Corporation for Advanced Internet Development, Inc.]
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 package edu.internet2.middleware.shibboleth.idp.profile.saml1;
19 import java.util.ArrayList;
20 import java.util.Collection;
22 import org.apache.log4j.Logger;
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.SPSSODescriptor;
42 import org.opensaml.saml2.metadata.provider.MetadataProvider;
43 import org.opensaml.saml2.metadata.provider.MetadataProviderException;
44 import org.opensaml.ws.message.decoder.MessageDecodingException;
45 import org.opensaml.ws.security.SecurityPolicyException;
46 import org.opensaml.ws.transport.http.HTTPInTransport;
47 import org.opensaml.ws.transport.http.HTTPOutTransport;
49 import edu.internet2.middleware.shibboleth.common.profile.ProfileException;
50 import edu.internet2.middleware.shibboleth.common.relyingparty.RelyingPartyConfiguration;
51 import edu.internet2.middleware.shibboleth.common.relyingparty.provider.saml1.ArtifactResolutionConfiguration;
54 * SAML 2.0 Artifact resolution profile handler.
56 public class ArtifactResolution extends AbstractSAML1ProfileHandler {
59 private final Logger log = Logger.getLogger(ArtifactResolution.class);
61 /** Builder of Response objects. */
62 private SAMLObjectBuilder<Response> responseBuilder;
64 /** Map artifacts to SAML messages. */
65 private SAMLArtifactMap artifactMap;
68 public ArtifactResolution() {
70 responseBuilder = (SAMLObjectBuilder<Response>) getBuilderFactory().getBuilder(Response.DEFAULT_ELEMENT_NAME);
74 public String getProfileId() {
75 return "urn:mace:shibboleth:2.0:idp:profiles:saml1:request:artifact";
79 public void processRequest(HTTPInTransport inTransport, HTTPOutTransport outTransport) throws ProfileException {
80 Response samlResponse;
82 ArtifactResolutionRequestContext requestContext = decodeRequest(inTransport, outTransport);
85 if (requestContext.getRelyingPartyConfiguration() == null) {
86 log.error("SAML 1 Artifact resolution profile is not configured for relying party "
87 + requestContext.getPeerEntityId());
88 requestContext.setFailureStatus(buildStatus(StatusCode.SUCCESS, StatusCode.REQUEST_DENIED,
89 "SAML 1 Artifact resolution profile is not configured for relying party "
90 + requestContext.getPeerEntityId()));
91 throw new ProfileException("SAML 1 Artifact resolution profile is not configured for relying party "
92 + requestContext.getPeerEntityId());
95 checkSamlVersion(requestContext);
97 // create the SAML response
98 samlResponse = buildArtifactResponse(requestContext);
99 } catch (ProfileException e) {
100 samlResponse = buildErrorResponse(requestContext);
103 requestContext.setOutboundSAMLMessage(samlResponse);
104 requestContext.setOutboundSAMLMessageId(samlResponse.getID());
105 requestContext.setOutboundSAMLMessageIssueInstant(samlResponse.getIssueInstant());
107 encodeResponse(requestContext);
108 writeAuditLogEntry(requestContext);
112 * Decodes an incoming request and populates a created request context with the resultant information.
114 * @param inTransport inbound message transport
115 * @param outTransport outbound message transport
117 * @return the created request context
119 * @throws ProfileException throw if there is a problem decoding the request
121 protected ArtifactResolutionRequestContext decodeRequest(HTTPInTransport inTransport, HTTPOutTransport outTransport)
122 throws ProfileException {
123 if (log.isDebugEnabled()) {
124 log.debug("Decoding incomming request");
127 MetadataProvider metadataProvider = getMetadataProvider();
129 ArtifactResolutionRequestContext requestContext = new ArtifactResolutionRequestContext();
130 requestContext.setInboundMessageTransport(inTransport);
131 requestContext.setInboundSAMLProtocol(SAMLConstants.SAML20P_NS);
132 requestContext.setOutboundMessageTransport(outTransport);
133 requestContext.setOutboundSAMLProtocol(SAMLConstants.SAML20P_NS);
134 requestContext.setMetadataProvider(metadataProvider);
137 SAMLMessageDecoder decoder = getMessageDecoders().get(getInboundBinding());
138 requestContext.setMessageDecoder(decoder);
139 decoder.decode(requestContext);
140 if (log.isDebugEnabled()) {
141 log.debug("Decoded request");
143 return requestContext;
144 } catch (MessageDecodingException e) {
145 log.error("Error decoding artifact resolve message", e);
146 requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null, "Error decoding message"));
147 throw new ProfileException("Error decoding artifact resolve message");
148 } catch (SecurityPolicyException e) {
149 log.error("Message did not meet security policy requirements", e);
150 requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, StatusCode.REQUEST_DENIED,
151 "Message did not meet security policy requirements"));
152 throw new ProfileException("Message did not meet security policy requirements", e);
154 // Set as much information as can be retrieved from the decoded message
156 Request samlRequest = requestContext.getInboundSAMLMessage();
157 if (samlRequest.getAssertionArtifacts() != null) {
158 ArrayList<String> artifacts = new ArrayList<String>();
159 for (AssertionArtifact artifact : samlRequest.getAssertionArtifacts()) {
160 artifacts.add(artifact.getAssertionArtifact());
162 requestContext.setArtifacts(artifacts);
164 requestContext.setInboundSAMLMessageId(samlRequest.getID());
165 requestContext.setInboundSAMLMessageIssueInstant(samlRequest.getIssueInstant());
167 String relyingPartyId = requestContext.getPeerEntityId();
168 requestContext.setPeerEntityMetadata(metadataProvider.getEntityDescriptor(relyingPartyId));
169 requestContext.setPeerEntityRole(SPSSODescriptor.DEFAULT_ELEMENT_NAME);
170 requestContext.setPeerEntityRoleMetadata(requestContext.getPeerEntityMetadata().getSPSSODescriptor(
171 SAMLConstants.SAML11P_NS));
172 RelyingPartyConfiguration rpConfig = getRelyingPartyConfiguration(relyingPartyId);
173 requestContext.setRelyingPartyConfiguration(rpConfig);
175 String assertingPartyId = requestContext.getRelyingPartyConfiguration().getProviderId();
176 requestContext.setLocalEntityId(assertingPartyId);
177 requestContext.setLocalEntityMetadata(metadataProvider.getEntityDescriptor(assertingPartyId));
178 requestContext.setLocalEntityRole(AttributeAuthorityDescriptor.DEFAULT_ELEMENT_NAME);
179 requestContext.setLocalEntityRoleMetadata(requestContext.getLocalEntityMetadata()
180 .getAttributeAuthorityDescriptor(SAMLConstants.SAML11P_NS));
182 ArtifactResolutionConfiguration profileConfig = (ArtifactResolutionConfiguration) rpConfig
183 .getProfileConfiguration(ArtifactResolutionConfiguration.PROFILE_ID);
184 requestContext.setProfileConfiguration(profileConfig);
185 if (profileConfig.getSigningCredential() != null) {
186 requestContext.setOutboundSAMLMessageSigningCredential(profileConfig.getSigningCredential());
187 } else if (rpConfig.getDefaultSigningCredential() != null) {
188 requestContext.setOutboundSAMLMessageSigningCredential(rpConfig.getDefaultSigningCredential());
191 } catch (MetadataProviderException e) {
192 log.error("Unable to locate metadata for asserting or relying party");
194 .setFailureStatus(buildStatus(StatusCode.RESPONDER, null, "Error locating party metadata"));
195 throw new ProfileException("Error locating party metadata");
201 * Selects the appropriate endpoint for the relying party and stores it in the request context.
203 * @param requestContext current request context
205 * @return Endpoint selected from the information provided in the request context
207 protected Endpoint selectEndpoint(ArtifactResolutionRequestContext requestContext) {
208 BasicEndpointSelector endpointSelector = new BasicEndpointSelector();
209 endpointSelector.setEndpointType(AssertionConsumerService.DEFAULT_ELEMENT_NAME);
210 endpointSelector.setMetadataProvider(getMetadataProvider());
211 endpointSelector.setRelyingParty(requestContext.getPeerEntityMetadata());
212 endpointSelector.setRelyingPartyRole(requestContext.getPeerEntityRoleMetadata());
213 endpointSelector.setSamlRequest(requestContext.getInboundSAMLMessage());
214 endpointSelector.getSupportedIssuerBindings().addAll(getSupportedOutboundBindings());
215 return endpointSelector.selectEndpoint();
219 * Derferences the provided artifacts and stores them in the request context.
221 * @param requestContext current request context
223 protected void derferenceArtifacts(ArtifactResolutionRequestContext requestContext) {
224 Collection<String> artifacts = requestContext.getArtifacts();
225 if (artifacts != null) {
226 ArrayList<Assertion> assertions = new ArrayList<Assertion>();
227 SAMLArtifactMapEntry artifactEntry;
229 for (String artifact : artifacts) {
230 artifactEntry = artifactMap.peek(artifact.getBytes());
231 if (artifactEntry == null || artifactEntry.isExpired()) {
232 log.error("Unknown artifact.");
235 if (!artifactEntry.getIssuerId().equals(requestContext.getLocalEntityId())) {
236 log.error("Artifact issuer mismatch. Artifact issued by " + artifactEntry.getIssuerId()
237 + " but IdP has entity ID of " + requestContext.getLocalEntityId());
240 if (!artifactEntry.getRelyingPartyId().equals(requestContext.getPeerEntityId())) {
241 log.error("Artifact requester mismatch. Artifact was issued to "
242 + artifactEntry.getRelyingPartyId() + " but was resolve request came from "
243 + requestContext.getPeerEntityId());
245 artifactMap.get(artifact.getBytes());
246 assertions.add((Assertion) artifactEntry.getSamlMessage());
248 requestContext.setReferencedAssertions(assertions);
253 * Builds the response to the artifact request.
255 * @param requestContext current request context
257 * @return response to the artifact request
259 protected Response buildArtifactResponse(ArtifactResolutionRequestContext requestContext) {
260 DateTime issueInstant = new DateTime();
262 // create the SAML response and add the assertion
263 Response samlResponse = responseBuilder.buildObject();
264 samlResponse.setIssueInstant(issueInstant);
265 populateStatusResponse(requestContext, samlResponse);
267 if (requestContext.getReferencedAssertions() != null) {
268 samlResponse.getAssertions().addAll(requestContext.getReferencedAssertions());
271 Status status = buildStatus(StatusCode.SUCCESS, null, null);
272 samlResponse.setStatus(status);
277 /** Represents the internal state of a SAML 1 Artiface resolver request while it's being processed by the IdP. */
278 public class ArtifactResolutionRequestContext extends
279 BaseSAML1ProfileRequestContext<Request, Response, ArtifactResolutionConfiguration> implements
280 SAML1ArtifactMessageContext<Request, Response, NameIdentifier> {
282 /** Artifact to be resolved. */
283 private Collection<String> artifacts;
285 /** Message referenced by the SAML artifact. */
286 private Collection<Assertion> referencedAssertions;
289 * Gets the artifacts to be resolved.
291 * @return artifacts to be resolved
293 public Collection<String> getArtifacts() {
298 * Sets the artifacts to be resolved.
300 * @param artifacts artifacts to be resolved
302 public void setArtifacts(Collection<String> artifacts) {
303 this.artifacts = artifacts;
307 * Gets the SAML assertions referenced by the artifact(s).
309 * @return SAML assertions referenced by the artifact(s)
311 public Collection<Assertion> getReferencedAssertions() {
312 return referencedAssertions;
316 * Sets the SAML assertions referenced by the artifact(s).
318 * @param assertions SAML assertions referenced by the artifact(s)
320 public void setReferencedAssertions(Collection<Assertion> assertions) {
321 referencedAssertions = assertions;