1
2
3
4
5
6
7
8
9
10
11
12
13
14
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
65 public class ShibbolethSSOProfileHandler extends AbstractSAML1ProfileHandler {
66
67
68 private final Logger log = LoggerFactory.getLogger(ShibbolethSSOProfileHandler.class);
69
70
71 private SAMLObjectBuilder<AuthenticationStatement> authnStatementBuilder;
72
73
74 private SAMLObjectBuilder<SubjectLocality> subjectLocalityBuilder;
75
76
77 private SAMLObjectBuilder<Endpoint> endpointBuilder;
78
79
80 private String authenticationManagerPath;
81
82
83
84
85
86
87
88
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
107 public String getProfileId() {
108 return ShibbolethSSOConfiguration.PROFILE_ID;
109 }
110
111
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
129
130
131
132
133
134
135
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
175
176
177
178
179
180
181
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
228
229
230
231
232
233
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 requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null, "User failed authentication"));
247 throw new ProfileException("Authentication failure", loginContext.getAuthenticationFailure());
248 }
249
250 resolveAttributes(requestContext);
251
252 ArrayList<Statement> statements = new ArrayList<Statement>();
253 statements.add(buildAuthenticationStatement(requestContext));
254 if (requestContext.getProfileConfiguration().includeAttributeStatement()) {
255 AttributeStatement attributeStatement = buildAttributeStatement(requestContext,
256 "urn:oasis:names:tc:SAML:1.0:cm:bearer");
257 if (attributeStatement != null) {
258 requestContext.setReleasedAttributes(requestContext.getAttributes().keySet());
259 statements.add(attributeStatement);
260 }
261 }
262
263 samlResponse = buildResponse(requestContext, statements);
264 } catch (ProfileException e) {
265 samlResponse = buildErrorResponse(requestContext);
266 }
267
268 requestContext.setOutboundSAMLMessage(samlResponse);
269 requestContext.setOutboundSAMLMessageId(samlResponse.getID());
270 requestContext.setOutboundSAMLMessageIssueInstant(samlResponse.getIssueInstant());
271 encodeResponse(requestContext);
272 writeAuditLogEntry(requestContext);
273 }
274
275
276
277
278
279
280
281
282
283
284
285
286 protected ShibbolethSSORequestContext buildRequestContext(ShibbolethSSOLoginContext loginContext,
287 HTTPInTransport in, HTTPOutTransport out) throws ProfileException {
288 ShibbolethSSORequestContext requestContext = new ShibbolethSSORequestContext();
289 requestContext.setCommunicationProfileId(getProfileId());
290
291 requestContext.setMessageDecoder(getMessageDecoders().get(getInboundBinding()));
292
293 requestContext.setLoginContext(loginContext);
294 requestContext.setRelayState(loginContext.getSpTarget());
295
296 requestContext.setInboundMessageTransport(in);
297 requestContext.setInboundSAMLProtocol(ShibbolethConstants.SHIB_SSO_PROFILE_URI);
298
299 requestContext.setOutboundMessageTransport(out);
300 requestContext.setOutboundSAMLProtocol(SAMLConstants.SAML20P_NS);
301
302 requestContext.setMetadataProvider(getMetadataProvider());
303
304 String relyingPartyId = loginContext.getRelyingPartyId();
305 requestContext.setPeerEntityId(relyingPartyId);
306 requestContext.setInboundMessageIssuer(relyingPartyId);
307
308 populateRequestContext(requestContext);
309
310 return requestContext;
311 }
312
313
314 protected void populateRelyingPartyInformation(BaseSAMLProfileRequestContext requestContext)
315 throws ProfileException {
316 super.populateRelyingPartyInformation(requestContext);
317
318 EntityDescriptor relyingPartyMetadata = requestContext.getPeerEntityMetadata();
319 if (relyingPartyMetadata != null) {
320 requestContext.setPeerEntityRole(SPSSODescriptor.DEFAULT_ELEMENT_NAME);
321 requestContext.setPeerEntityRoleMetadata(relyingPartyMetadata.getSPSSODescriptor(SAMLConstants.SAML11P_NS));
322 }
323 }
324
325
326 protected void populateAssertingPartyInformation(BaseSAMLProfileRequestContext requestContext)
327 throws ProfileException {
328 super.populateAssertingPartyInformation(requestContext);
329
330 EntityDescriptor localEntityDescriptor = requestContext.getLocalEntityMetadata();
331 if (localEntityDescriptor != null) {
332 requestContext.setLocalEntityRole(IDPSSODescriptor.DEFAULT_ELEMENT_NAME);
333 requestContext.setLocalEntityRoleMetadata(localEntityDescriptor
334 .getIDPSSODescriptor(SAMLConstants.SAML20P_NS));
335 }
336 }
337
338
339 protected void populateSAMLMessageInformation(BaseSAMLProfileRequestContext requestContext) throws ProfileException {
340
341 }
342
343
344
345
346
347
348
349
350 protected Endpoint selectEndpoint(BaseSAMLProfileRequestContext requestContext) {
351 ShibbolethSSOLoginContext loginContext = ((ShibbolethSSORequestContext) requestContext).getLoginContext();
352
353 Endpoint endpoint = null;
354 if (requestContext.getRelyingPartyConfiguration().getRelyingPartyId() == SAMLMDRelyingPartyConfigurationManager.ANONYMOUS_RP_NAME) {
355 if (loginContext.getSpAssertionConsumerService() != null) {
356 endpoint = endpointBuilder.buildObject();
357 endpoint.setLocation(loginContext.getSpAssertionConsumerService());
358 endpoint.setBinding(getSupportedOutboundBindings().get(0));
359 log.warn("Generating endpoint for anonymous relying party. ACS url {} and binding {}", new Object[] {
360 requestContext.getInboundMessageIssuer(), endpoint.getLocation(), endpoint.getBinding(), });
361 }else{
362 log.warn("Unable to generate endpoint for anonymous party. No ACS url provided.");
363 }
364 } else {
365 ShibbolethSSOEndpointSelector endpointSelector = new ShibbolethSSOEndpointSelector();
366 endpointSelector.setSpAssertionConsumerService(loginContext.getSpAssertionConsumerService());
367 endpointSelector.setEndpointType(AssertionConsumerService.DEFAULT_ELEMENT_NAME);
368 endpointSelector.setMetadataProvider(getMetadataProvider());
369 endpointSelector.setEntityMetadata(requestContext.getPeerEntityMetadata());
370 endpointSelector.setEntityRoleMetadata(requestContext.getPeerEntityRoleMetadata());
371 endpointSelector.setSamlRequest(requestContext.getInboundSAMLMessage());
372 endpointSelector.getSupportedIssuerBindings().addAll(getSupportedOutboundBindings());
373 endpoint = endpointSelector.selectEndpoint();
374 }
375
376 return endpoint;
377 }
378
379
380
381
382
383
384
385
386
387
388 protected AuthenticationStatement buildAuthenticationStatement(ShibbolethSSORequestContext requestContext)
389 throws ProfileException {
390 ShibbolethSSOLoginContext loginContext = requestContext.getLoginContext();
391
392 AuthenticationStatement statement = authnStatementBuilder.buildObject();
393 statement.setAuthenticationInstant(loginContext.getAuthenticationInstant());
394 statement.setAuthenticationMethod(loginContext.getAuthenticationMethod());
395
396 statement.setSubjectLocality(buildSubjectLocality(requestContext));
397
398 Subject statementSubject;
399 Endpoint endpoint = selectEndpoint(requestContext);
400 if(endpoint.getBinding().equals(SAMLConstants.SAML1_ARTIFACT_BINDING_URI)){
401 statementSubject = buildSubject(requestContext, "urn:oasis:names:tc:SAML:1.0:cm:artifact");
402 }else{
403 statementSubject = buildSubject(requestContext, "urn:oasis:names:tc:SAML:1.0:cm:bearer");
404 }
405 statement.setSubject(statementSubject);
406
407 return statement;
408 }
409
410
411
412
413
414
415
416
417 protected SubjectLocality buildSubjectLocality(ShibbolethSSORequestContext requestContext) {
418 SubjectLocality subjectLocality = subjectLocalityBuilder.buildObject();
419
420 HTTPInTransport inTransport = (HTTPInTransport) requestContext.getInboundMessageTransport();
421 subjectLocality.setIPAddress(inTransport.getPeerAddress());
422
423 return subjectLocality;
424 }
425
426
427 public class ShibbolethSSORequestContext extends
428 BaseSAML1ProfileRequestContext<Request, Response, ShibbolethSSOConfiguration> {
429
430
431 private String spAssertionConsumerService;
432
433
434 private ShibbolethSSOLoginContext loginContext;
435
436
437
438
439
440
441 public ShibbolethSSOLoginContext getLoginContext() {
442 return loginContext;
443 }
444
445
446
447
448
449
450 public void setLoginContext(ShibbolethSSOLoginContext context) {
451 loginContext = context;
452 }
453
454
455
456
457
458
459 public String getSpAssertionConsumerService() {
460 return spAssertionConsumerService;
461 }
462
463
464
465
466
467
468 public void setSpAssertionConsumerService(String acs) {
469 spAssertionConsumerService = acs;
470 }
471 }
472 }