Note release attributes when including the attribute statement within the IdP; SIDP-181
[java-idp.git] / src / main / java / edu / internet2 / middleware / shibboleth / idp / profile / saml1 / ShibbolethSSOProfileHandler.java
1 /*
2  * Copyright [2007] [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.io.IOException;
20 import java.util.ArrayList;
21
22 import javax.servlet.RequestDispatcher;
23 import javax.servlet.ServletException;
24 import javax.servlet.http.HttpServletRequest;
25 import javax.servlet.http.HttpServletResponse;
26
27 import org.opensaml.common.SAMLObjectBuilder;
28 import org.opensaml.common.binding.decoding.SAMLMessageDecoder;
29 import org.opensaml.common.xml.SAMLConstants;
30 import org.opensaml.saml1.core.AttributeStatement;
31 import org.opensaml.saml1.core.AuthenticationStatement;
32 import org.opensaml.saml1.core.Request;
33 import org.opensaml.saml1.core.Response;
34 import org.opensaml.saml1.core.Statement;
35 import org.opensaml.saml1.core.StatusCode;
36 import org.opensaml.saml1.core.Subject;
37 import org.opensaml.saml1.core.SubjectLocality;
38 import org.opensaml.saml2.metadata.AssertionConsumerService;
39 import org.opensaml.saml2.metadata.Endpoint;
40 import org.opensaml.saml2.metadata.EntityDescriptor;
41 import org.opensaml.saml2.metadata.IDPSSODescriptor;
42 import org.opensaml.saml2.metadata.SPSSODescriptor;
43 import org.opensaml.ws.message.decoder.MessageDecodingException;
44 import org.opensaml.ws.transport.http.HTTPInTransport;
45 import org.opensaml.ws.transport.http.HTTPOutTransport;
46 import org.opensaml.ws.transport.http.HttpServletRequestAdapter;
47 import org.opensaml.ws.transport.http.HttpServletResponseAdapter;
48 import org.opensaml.xml.security.SecurityException;
49 import org.opensaml.xml.util.DatatypeHelper;
50 import org.slf4j.Logger;
51 import org.slf4j.LoggerFactory;
52
53 import edu.internet2.middleware.shibboleth.common.ShibbolethConstants;
54 import edu.internet2.middleware.shibboleth.common.profile.ProfileException;
55 import edu.internet2.middleware.shibboleth.common.profile.provider.BaseSAMLProfileRequestContext;
56 import edu.internet2.middleware.shibboleth.common.relyingparty.ProfileConfiguration;
57 import edu.internet2.middleware.shibboleth.common.relyingparty.RelyingPartyConfiguration;
58 import edu.internet2.middleware.shibboleth.common.relyingparty.provider.SAMLMDRelyingPartyConfigurationManager;
59 import edu.internet2.middleware.shibboleth.common.relyingparty.provider.saml1.ShibbolethSSOConfiguration;
60 import edu.internet2.middleware.shibboleth.common.util.HttpHelper;
61 import edu.internet2.middleware.shibboleth.idp.authn.LoginContext;
62 import edu.internet2.middleware.shibboleth.idp.authn.ShibbolethSSOLoginContext;
63
64 /** Shibboleth SSO request profile handler. */
65 public class ShibbolethSSOProfileHandler extends AbstractSAML1ProfileHandler {
66
67     /** Class logger. */
68     private final Logger log = LoggerFactory.getLogger(ShibbolethSSOProfileHandler.class);
69
70     /** Builder of AuthenticationStatement objects. */
71     private SAMLObjectBuilder<AuthenticationStatement> authnStatementBuilder;
72
73     /** Builder of SubjectLocality objects. */
74     private SAMLObjectBuilder<SubjectLocality> subjectLocalityBuilder;
75
76     /** Builder of Endpoint objects. */
77     private SAMLObjectBuilder<Endpoint> endpointBuilder;
78
79     /** URL of the authentication manager servlet. */
80     private String authenticationManagerPath;
81
82     /**
83      * Constructor.
84      * 
85      * @param authnManagerPath path to the authentication manager servlet
86      * 
87      * @throws IllegalArgumentException thrown if either the authentication manager path or encoding binding URI are
88      *             null or empty
89      */
90     public ShibbolethSSOProfileHandler(String authnManagerPath) {
91         if (DatatypeHelper.isEmpty(authnManagerPath)) {
92             throw new IllegalArgumentException("Authentication manager path may not be null");
93         }
94         authenticationManagerPath = authnManagerPath;
95
96         authnStatementBuilder = (SAMLObjectBuilder<AuthenticationStatement>) getBuilderFactory().getBuilder(
97                 AuthenticationStatement.DEFAULT_ELEMENT_NAME);
98
99         subjectLocalityBuilder = (SAMLObjectBuilder<SubjectLocality>) getBuilderFactory().getBuilder(
100                 SubjectLocality.DEFAULT_ELEMENT_NAME);
101
102         endpointBuilder = (SAMLObjectBuilder<Endpoint>) getBuilderFactory().getBuilder(
103                 AssertionConsumerService.DEFAULT_ELEMENT_NAME);
104     }
105
106     /** {@inheritDoc} */
107     public String getProfileId() {
108         return ShibbolethSSOConfiguration.PROFILE_ID;
109     }
110
111     /** {@inheritDoc} */
112     public void processRequest(HTTPInTransport inTransport, HTTPOutTransport outTransport) throws ProfileException {
113         log.debug("Processing incoming request");
114
115         HttpServletRequest httpRequest = ((HttpServletRequestAdapter) inTransport).getWrappedRequest();
116         LoginContext loginContext = (LoginContext) httpRequest.getAttribute(LoginContext.LOGIN_CONTEXT_KEY);
117
118         if (loginContext == null) {
119             log.debug("Incoming request does not contain a login context, processing as first leg of request");
120             performAuthentication(inTransport, outTransport);
121         } else {
122             log.debug("Incoming request contains a login context, processing as second leg of request");
123             completeAuthenticationRequest(inTransport, outTransport);
124         }
125     }
126
127     /**
128      * Creates a {@link LoginContext} an sends the request off to the AuthenticationManager to begin the process of
129      * authenticating the user.
130      * 
131      * @param inTransport inbound message transport
132      * @param outTransport outbound message transport
133      * 
134      * @throws ProfileException thrown if there is a problem creating the login context and transferring control to the
135      *             authentication manager
136      */
137     protected void performAuthentication(HTTPInTransport inTransport, HTTPOutTransport outTransport)
138             throws ProfileException {
139
140         HttpServletRequest httpRequest = ((HttpServletRequestAdapter) inTransport).getWrappedRequest();
141         HttpServletResponse httpResponse = ((HttpServletResponseAdapter) outTransport).getWrappedResponse();
142
143         ShibbolethSSORequestContext requestContext = decodeRequest(inTransport, outTransport);
144         ShibbolethSSOLoginContext loginContext = requestContext.getLoginContext();
145
146         RelyingPartyConfiguration rpConfig = getRelyingPartyConfiguration(loginContext.getRelyingPartyId());
147         ProfileConfiguration ssoConfig = rpConfig.getProfileConfiguration(ShibbolethSSOConfiguration.PROFILE_ID);
148         if (ssoConfig == null) {
149             log.error("Shibboleth SSO profile is not configured for relying party " + loginContext.getRelyingPartyId());
150             throw new ProfileException("Shibboleth SSO profile is not configured for relying party "
151                     + loginContext.getRelyingPartyId());
152         }
153         if (loginContext.getRequestedAuthenticationMethods().size() == 0
154                 && rpConfig.getDefaultAuthenticationMethod() != null) {
155             loginContext.getRequestedAuthenticationMethods().add(rpConfig.getDefaultAuthenticationMethod());
156         }
157
158         httpRequest.setAttribute(LoginContext.LOGIN_CONTEXT_KEY, loginContext);
159
160         try {
161             RequestDispatcher dispatcher = httpRequest.getRequestDispatcher(authenticationManagerPath);
162             dispatcher.forward(httpRequest, httpResponse);
163             return;
164         } catch (IOException ex) {
165             log.error("Error forwarding Shibboleth SSO request to AuthenticationManager", ex);
166             throw new ProfileException("Error forwarding Shibboleth SSO request to AuthenticationManager", ex);
167         } catch (ServletException ex) {
168             log.error("Error forwarding Shibboleth SSO request to AuthenticationManager", ex);
169             throw new ProfileException("Error forwarding Shibboleth SSO request to AuthenticationManager", ex);
170         }
171     }
172
173     /**
174      * Decodes an incoming request and populates a created request context with the resultant information.
175      * 
176      * @param inTransport inbound message transport
177      * @param outTransport outbound message transport
178      * 
179      * @return the created request context
180      * 
181      * @throws ProfileException throw if there is a problem decoding the request
182      */
183     protected ShibbolethSSORequestContext decodeRequest(HTTPInTransport inTransport, HTTPOutTransport outTransport)
184             throws ProfileException {
185         log.debug("Decoding message with decoder binding {}", getInboundBinding());
186
187         HttpServletRequest httpRequest = ((HttpServletRequestAdapter) inTransport).getWrappedRequest();
188
189         ShibbolethSSORequestContext requestContext = new ShibbolethSSORequestContext();
190         requestContext.setCommunicationProfileId(getProfileId());
191
192         requestContext.setMetadataProvider(getMetadataProvider());
193         requestContext.setSecurityPolicyResolver(getSecurityPolicyResolver());
194
195         requestContext.setCommunicationProfileId(ShibbolethSSOConfiguration.PROFILE_ID);
196         requestContext.setInboundMessageTransport(inTransport);
197         requestContext.setInboundSAMLProtocol(ShibbolethConstants.SHIB_SSO_PROFILE_URI);
198         requestContext.setPeerEntityRole(SPSSODescriptor.DEFAULT_ELEMENT_NAME);
199
200         requestContext.setOutboundMessageTransport(outTransport);
201         requestContext.setOutboundSAMLProtocol(SAMLConstants.SAML11P_NS);
202
203         SAMLMessageDecoder decoder = getMessageDecoders().get(getInboundBinding());
204         requestContext.setMessageDecoder(decoder);
205         try {
206             decoder.decode(requestContext);
207         } catch (MessageDecodingException e) {
208             log.error("Error decoding Shibboleth SSO request", e);
209             throw new ProfileException("Error decoding Shibboleth SSO request", e);
210         } catch (SecurityException e) {
211             log.error("Shibboleth SSO request does not meet security requirements", e);
212             throw new ProfileException("Shibboleth SSO request does not meet security requirements", e);
213         }
214
215         ShibbolethSSOLoginContext loginContext = new ShibbolethSSOLoginContext();
216         loginContext.setRelyingParty(requestContext.getInboundMessageIssuer());
217         loginContext.setSpAssertionConsumerService(requestContext.getSpAssertionConsumerService());
218         loginContext.setSpTarget(requestContext.getRelayState());
219         loginContext.setAuthenticationEngineURL(authenticationManagerPath);
220         loginContext.setProfileHandlerURL(HttpHelper.getRequestUriWithoutContext(httpRequest));
221         requestContext.setLoginContext(loginContext);
222
223         return requestContext;
224     }
225
226     /**
227      * Creates a response to the Shibboleth SSO and sends the user, with response in tow, back to the relying party
228      * after they've been authenticated.
229      * 
230      * @param inTransport inbound message transport
231      * @param outTransport outbound message transport
232      * 
233      * @throws ProfileException thrown if the response can not be created and sent back to the relying party
234      */
235     protected void completeAuthenticationRequest(HTTPInTransport inTransport, HTTPOutTransport outTransport)
236             throws ProfileException {
237         HttpServletRequest httpRequest = ((HttpServletRequestAdapter) inTransport).getWrappedRequest();
238         ShibbolethSSOLoginContext loginContext = (ShibbolethSSOLoginContext) httpRequest
239                 .getAttribute(LoginContext.LOGIN_CONTEXT_KEY);
240
241         ShibbolethSSORequestContext requestContext = buildRequestContext(loginContext, inTransport, outTransport);
242
243         Response samlResponse;
244         try {
245             if (loginContext.getAuthenticationFailure() != null) {
246                 log.error("User authentication failed with the following error: {}", loginContext
247                         .getAuthenticationFailure().toString());
248                 requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null, "User failed authentication"));
249                 throw new ProfileException("Authentication failure", loginContext.getAuthenticationFailure());
250             }
251
252             resolveAttributes(requestContext);
253
254             ArrayList<Statement> statements = new ArrayList<Statement>();
255             statements.add(buildAuthenticationStatement(requestContext));
256             if (requestContext.getProfileConfiguration().includeAttributeStatement()) {
257                 AttributeStatement attributeStatement = buildAttributeStatement(requestContext,
258                         "urn:oasis:names:tc:SAML:1.0:cm:bearer");
259                 if (attributeStatement != null) {
260                     requestContext.setReleasedAttributes(requestContext.getAttributes().keySet());
261                     statements.add(attributeStatement);
262                 }
263             }
264
265             samlResponse = buildResponse(requestContext, statements);
266         } catch (ProfileException e) {
267             samlResponse = buildErrorResponse(requestContext);
268         }
269
270         requestContext.setOutboundSAMLMessage(samlResponse);
271         requestContext.setOutboundSAMLMessageId(samlResponse.getID());
272         requestContext.setOutboundSAMLMessageIssueInstant(samlResponse.getIssueInstant());
273         encodeResponse(requestContext);
274         writeAuditLogEntry(requestContext);
275     }
276
277     /**
278      * Creates an authentication request context from the current environmental information.
279      * 
280      * @param loginContext current login context
281      * @param in inbound transport
282      * @param out outbount transport
283      * 
284      * @return created authentication request context
285      * 
286      * @throws ProfileException thrown if there is a problem creating the context
287      */
288     protected ShibbolethSSORequestContext buildRequestContext(ShibbolethSSOLoginContext loginContext,
289             HTTPInTransport in, HTTPOutTransport out) throws ProfileException {
290         ShibbolethSSORequestContext requestContext = new ShibbolethSSORequestContext();
291         requestContext.setCommunicationProfileId(getProfileId());
292
293         requestContext.setMessageDecoder(getMessageDecoders().get(getInboundBinding()));
294
295         requestContext.setLoginContext(loginContext);
296         requestContext.setRelayState(loginContext.getSpTarget());
297
298         requestContext.setInboundMessageTransport(in);
299         requestContext.setInboundSAMLProtocol(ShibbolethConstants.SHIB_SSO_PROFILE_URI);
300
301         requestContext.setOutboundMessageTransport(out);
302         requestContext.setOutboundSAMLProtocol(SAMLConstants.SAML20P_NS);
303
304         requestContext.setMetadataProvider(getMetadataProvider());
305
306         String relyingPartyId = loginContext.getRelyingPartyId();
307         requestContext.setPeerEntityId(relyingPartyId);
308         requestContext.setInboundMessageIssuer(relyingPartyId);
309
310         populateRequestContext(requestContext);
311
312         return requestContext;
313     }
314
315     /** {@inheritDoc} */
316     protected void populateRelyingPartyInformation(BaseSAMLProfileRequestContext requestContext)
317             throws ProfileException {
318         super.populateRelyingPartyInformation(requestContext);
319
320         EntityDescriptor relyingPartyMetadata = requestContext.getPeerEntityMetadata();
321         if (relyingPartyMetadata != null) {
322             requestContext.setPeerEntityRole(SPSSODescriptor.DEFAULT_ELEMENT_NAME);
323             requestContext.setPeerEntityRoleMetadata(relyingPartyMetadata.getSPSSODescriptor(SAMLConstants.SAML11P_NS));
324         }
325     }
326
327     /** {@inheritDoc} */
328     protected void populateAssertingPartyInformation(BaseSAMLProfileRequestContext requestContext)
329             throws ProfileException {
330         super.populateAssertingPartyInformation(requestContext);
331
332         EntityDescriptor localEntityDescriptor = requestContext.getLocalEntityMetadata();
333         if (localEntityDescriptor != null) {
334             requestContext.setLocalEntityRole(IDPSSODescriptor.DEFAULT_ELEMENT_NAME);
335             requestContext.setLocalEntityRoleMetadata(localEntityDescriptor
336                     .getIDPSSODescriptor(SAMLConstants.SAML20P_NS));
337         }
338     }
339
340     /** {@inheritDoc} */
341     protected void populateSAMLMessageInformation(BaseSAMLProfileRequestContext requestContext) throws ProfileException {
342         // nothing to do here
343     }
344
345     /**
346      * Selects the appropriate endpoint for the relying party and stores it in the request context.
347      * 
348      * @param requestContext current request context
349      * 
350      * @return Endpoint selected from the information provided in the request context
351      */
352     protected Endpoint selectEndpoint(BaseSAMLProfileRequestContext requestContext) {
353         ShibbolethSSOLoginContext loginContext = ((ShibbolethSSORequestContext) requestContext).getLoginContext();
354
355         Endpoint endpoint = null;
356         if (requestContext.getRelyingPartyConfiguration().getRelyingPartyId() == SAMLMDRelyingPartyConfigurationManager.ANONYMOUS_RP_NAME) {
357             if (loginContext.getSpAssertionConsumerService() != null) {
358                 endpoint = endpointBuilder.buildObject();
359                 endpoint.setLocation(loginContext.getSpAssertionConsumerService());
360                 endpoint.setBinding(getSupportedOutboundBindings().get(0));
361                 log.warn("Generating endpoint for anonymous relying party. ACS url {} and binding {}", new Object[] {
362                         requestContext.getInboundMessageIssuer(), endpoint.getLocation(), endpoint.getBinding(), });
363             }else{
364                log.warn("Unable to generate endpoint for anonymous party.  No ACS url provided."); 
365             }
366         } else {
367             ShibbolethSSOEndpointSelector endpointSelector = new ShibbolethSSOEndpointSelector();
368             endpointSelector.setSpAssertionConsumerService(loginContext.getSpAssertionConsumerService());
369             endpointSelector.setEndpointType(AssertionConsumerService.DEFAULT_ELEMENT_NAME);
370             endpointSelector.setMetadataProvider(getMetadataProvider());
371             endpointSelector.setEntityMetadata(requestContext.getPeerEntityMetadata());
372             endpointSelector.setEntityRoleMetadata(requestContext.getPeerEntityRoleMetadata());
373             endpointSelector.setSamlRequest(requestContext.getInboundSAMLMessage());
374             endpointSelector.getSupportedIssuerBindings().addAll(getSupportedOutboundBindings());
375             endpoint = endpointSelector.selectEndpoint();
376         }
377
378         return endpoint;
379     }
380
381     /**
382      * Builds the authentication statement for the authenticated principal.
383      * 
384      * @param requestContext current request context
385      * 
386      * @return the created statement
387      * 
388      * @throws ProfileException thrown if the authentication statement can not be created
389      */
390     protected AuthenticationStatement buildAuthenticationStatement(ShibbolethSSORequestContext requestContext)
391             throws ProfileException {
392         ShibbolethSSOLoginContext loginContext = requestContext.getLoginContext();
393
394         AuthenticationStatement statement = authnStatementBuilder.buildObject();
395         statement.setAuthenticationInstant(loginContext.getAuthenticationInstant());
396         statement.setAuthenticationMethod(loginContext.getAuthenticationMethod());
397
398         statement.setSubjectLocality(buildSubjectLocality(requestContext));
399
400         Subject statementSubject = buildSubject(requestContext, "urn:oasis:names:tc:SAML:1.0:cm:bearer");
401         statement.setSubject(statementSubject);
402
403         return statement;
404     }
405
406     /**
407      * Constructs the subject locality for the authentication statement.
408      * 
409      * @param requestContext curent request context
410      * 
411      * @return subject locality for the authentication statement
412      */
413     protected SubjectLocality buildSubjectLocality(ShibbolethSSORequestContext requestContext) {
414         SubjectLocality subjectLocality = subjectLocalityBuilder.buildObject();
415
416         HTTPInTransport inTransport = (HTTPInTransport) requestContext.getInboundMessageTransport();
417         subjectLocality.setIPAddress(inTransport.getPeerAddress());
418
419         return subjectLocality;
420     }
421
422     /** Represents the internal state of a Shibboleth SSO Request while it's being processed by the IdP. */
423     public class ShibbolethSSORequestContext extends
424             BaseSAML1ProfileRequestContext<Request, Response, ShibbolethSSOConfiguration> {
425
426         /** SP-provide assertion consumer service URL. */
427         private String spAssertionConsumerService;
428
429         /** Current login context. */
430         private ShibbolethSSOLoginContext loginContext;
431
432         /**
433          * Gets the current login context.
434          * 
435          * @return current login context
436          */
437         public ShibbolethSSOLoginContext getLoginContext() {
438             return loginContext;
439         }
440
441         /**
442          * Sets the current login context.
443          * 
444          * @param context current login context
445          */
446         public void setLoginContext(ShibbolethSSOLoginContext context) {
447             loginContext = context;
448         }
449
450         /**
451          * Gets the SP-provided assertion consumer service URL.
452          * 
453          * @return SP-provided assertion consumer service URL
454          */
455         public String getSpAssertionConsumerService() {
456             return spAssertionConsumerService;
457         }
458
459         /**
460          * Sets the SP-provided assertion consumer service URL.
461          * 
462          * @param acs SP-provided assertion consumer service URL
463          */
464         public void setSpAssertionConsumerService(String acs) {
465             spAssertionConsumerService = acs;
466         }
467     }
468 }