src/edu/internet2/middleware/shibboleth/idp/profile/saml2/SSOProfileHandler.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.saml2;
  18
  19 import java.io.IOException;
  20 import java.util.ArrayList;
  21 import java.util.List;
  22
  23 import javax.servlet.RequestDispatcher;
  24 import javax.servlet.ServletException;
  25 import javax.servlet.ServletRequest;
  26 import javax.servlet.ServletResponse;
  27 import javax.servlet.http.HttpServletRequest;
  28 import javax.servlet.http.HttpSession;
  29
  30 import org.apache.log4j.Logger;
  31 import org.opensaml.common.SAMLObjectBuilder;
  32 import org.opensaml.common.binding.BindingException;
  33 import org.opensaml.common.binding.decoding.MessageDecoder;
  34 import org.opensaml.common.binding.encoding.MessageEncoder;
  35 import org.opensaml.common.binding.security.SAMLSecurityPolicy;
  36 import org.opensaml.common.xml.SAMLConstants;
  37 import org.opensaml.saml2.core.SubjectLocality;
  38 import org.opensaml.saml2.binding.AuthnResponseEndpointSelector;
  39 import org.opensaml.saml2.core.AuthnContext;
  40 import org.opensaml.saml2.core.AuthnContextClassRef;
  41 import org.opensaml.saml2.core.AuthnContextDeclRef;
  42 import org.opensaml.saml2.core.AuthnRequest;
  43 import org.opensaml.saml2.core.AuthnStatement;
  44 import org.opensaml.saml2.core.RequestedAuthnContext;
  45 import org.opensaml.saml2.core.Response;
  46 import org.opensaml.saml2.core.Statement;
  47 import org.opensaml.saml2.core.StatusCode;
  48 import org.opensaml.saml2.core.Subject;
  49 import org.opensaml.saml2.metadata.AssertionConsumerService;
  50 import org.opensaml.saml2.metadata.Endpoint;
  51 import org.opensaml.saml2.metadata.provider.MetadataProviderException;
  52 import org.opensaml.ws.security.SecurityPolicyException;
  53 import org.opensaml.xml.io.MarshallingException;
  54 import org.opensaml.xml.io.UnmarshallingException;
  55
  56 import edu.internet2.middleware.shibboleth.common.profile.ProfileException;
  57 import edu.internet2.middleware.shibboleth.common.profile.ProfileRequest;
  58 import edu.internet2.middleware.shibboleth.common.profile.ProfileResponse;
  59 import edu.internet2.middleware.shibboleth.common.relyingparty.RelyingPartyConfiguration;
  60 import edu.internet2.middleware.shibboleth.common.relyingparty.provider.saml2.SSOConfiguration;
  61 import edu.internet2.middleware.shibboleth.common.util.HttpHelper;
  62 import edu.internet2.middleware.shibboleth.idp.authn.LoginContext;
  63 import edu.internet2.middleware.shibboleth.idp.authn.Saml2LoginContext;
  64
  65 /** SAML 2.0 SSO request profile handler. */
  66 public class SSOProfileHandler extends AbstractSAML2ProfileHandler {
  67
  68     /** Class logger. */
  69     private final Logger log = Logger.getLogger(SSOProfileHandler.class);
  70
  71     /** Builder of AuthnStatement objects. */
  72     private SAMLObjectBuilder<AuthnStatement> authnStatementBuilder;
  73
  74     /** Builder of AuthnContext objects. */
  75     private SAMLObjectBuilder<AuthnContext> authnContextBuilder;
  76
  77     /** Builder of AuthnContextClassRef objects. */
  78     private SAMLObjectBuilder<AuthnContextClassRef> authnContextClassRefBuilder;
  79
  80     /** Builder of AuthnContextDeclRef objects. */
  81     private SAMLObjectBuilder<AuthnContextDeclRef> authnContextDeclRefBuilder;
  82
  83     /** Builder of SubjectLocality objects. */
  84     private SAMLObjectBuilder<SubjectLocality> subjectLocalityBuilder;
  85
  86     /** URL of the authentication manager servlet. */
  87     private String authenticationManagerPath;
  88
  89     /** URI of SAML 2 bindings supported for outgoing messaged encoding. */
  90     private ArrayList<String> supportedOutgoingBindings;
  91
  92     /** URI of request decoder. */
  93     private String decodingBinding;
  94
  95     /**
  96      * Constructor.
  97      *
  98      * @param authnManagerPath path to the authentication manager servlet
  99      * @param outgoingBindings URIs of SAML 2 bindings supported for outgoing message encoding
 100      * @param decoder URI of the request decoder to use
 101      */
 102     @SuppressWarnings("unchecked")
 103     public SSOProfileHandler(String authnManagerPath, List<String> outgoingBindings, String decoder) {
 104         super();
 105
 106         if (authnManagerPath == null || decoder == null) {
 107             throw new IllegalArgumentException("AuthN manager path or decoding bindings URI may not be null");
 108         }
 109         authenticationManagerPath = authnManagerPath;
 110
 111         if(outgoingBindings == null || outgoingBindings.isEmpty()){
 112             throw new IllegalArgumentException("List of supported outgoing bindings may not be empty");
 113         }
 114         supportedOutgoingBindings = new ArrayList<String>(outgoingBindings);
 115
 116         decodingBinding = decoder;
 117
 118         authnStatementBuilder = (SAMLObjectBuilder<AuthnStatement>) getBuilderFactory().getBuilder(
 119                 AuthnStatement.DEFAULT_ELEMENT_NAME);
 120         authnContextBuilder = (SAMLObjectBuilder<AuthnContext>) getBuilderFactory().getBuilder(
 121                 AuthnContext.DEFAULT_ELEMENT_NAME);
 122         authnContextClassRefBuilder = (SAMLObjectBuilder<AuthnContextClassRef>) getBuilderFactory().getBuilder(
 123                 AuthnContextClassRef.DEFAULT_ELEMENT_NAME);
 124         authnContextDeclRefBuilder = (SAMLObjectBuilder<AuthnContextDeclRef>) getBuilderFactory().getBuilder(
 125                 AuthnContextDeclRef.DEFAULT_ELEMENT_NAME);
 126         subjectLocalityBuilder = (SAMLObjectBuilder<SubjectLocality>) getBuilderFactory().getBuilder(
 127                 SubjectLocality.DEFAULT_ELEMENT_NAME);
 128     }
 129
 130     /** {@inheritDoc} */
 131     public String getProfileId() {
 132         return "urn:mace:shibboleth:2.0:idp:profiles:saml2:request:sso";
 133     }
 134
 135     /** {@inheritDoc} */
 136     public void processRequest(ProfileRequest<ServletRequest> request, ProfileResponse<ServletResponse> response)
 137             throws ProfileException {
 138
 139         HttpSession httpSession = ((HttpServletRequest) request.getRawRequest()).getSession(true);
 140         if (httpSession.getAttribute(LoginContext.LOGIN_CONTEXT_KEY) == null) {
 141             performAuthentication(request, response);
 142         } else {
 143             completeAuthenticationRequest(request, response);
 144         }
 145     }
 146
 147     /**
 148      * Creates a {@link Saml2LoginContext} an sends the request off to the AuthenticationManager to begin the process of
 149      * authenticating the user.
 150      *
 151      * @param request current request
 152      * @param response current response
 153      *
 154      * @throws ProfileException thrown if there is a problem creating the login context and transferring control to the
 155      *             authentication manager
 156      */
 157     protected void performAuthentication(ProfileRequest<ServletRequest> request,
 158             ProfileResponse<ServletResponse> response) throws ProfileException {
 159         HttpServletRequest httpRequest = (HttpServletRequest) request.getRawRequest();
 160
 161         AuthnRequest authnRequest = null;
 162         try {
 163             MessageDecoder<ServletRequest> decoder = decodeRequest(request);
 164             SAMLSecurityPolicy securityPolicy = decoder.getSecurityPolicy();
 165
 166             String relyingParty = securityPolicy.getIssuer();
 167             RelyingPartyConfiguration rpConfig = getRelyingPartyConfiguration(relyingParty);
 168             if (rpConfig == null) {
 169                 log.error("No relying party configuration for " + relyingParty);
 170                 throw new ProfileException("No relying party configuration for " + relyingParty);
 171             }
 172
 173             authnRequest = (AuthnRequest) decoder.getSAMLMessage();
 174
 175             Saml2LoginContext loginContext = new Saml2LoginContext(relyingParty, authnRequest);
 176             loginContext.setAuthenticationEngineURL(authenticationManagerPath);
 177             loginContext.setProfileHandlerURL(HttpHelper.getRequestUriWithoutContext(httpRequest));
 178             if (loginContext.getRequestedAuthenticationMethods().size() == 0) {
 179                 loginContext.getRequestedAuthenticationMethods().add(rpConfig.getDefaultAuthenticationMethod());
 180             }
 181
 182             HttpSession httpSession = httpRequest.getSession();
 183             httpSession.setAttribute(Saml2LoginContext.LOGIN_CONTEXT_KEY, loginContext);
 184             RequestDispatcher dispatcher = httpRequest.getRequestDispatcher(authenticationManagerPath);
 185             dispatcher.forward(httpRequest, response.getRawResponse());
 186         } catch (MarshallingException e) {
 187             log.error("Unable to marshall authentication request context");
 188             throw new ProfileException("Unable to marshall authentication request context", e);
 189         } catch (IOException ex) {
 190             log.error("Error forwarding SAML 2 AuthnRequest " + authnRequest.getID() + " to AuthenticationManager", ex);
 191             throw new ProfileException("Error forwarding SAML 2 AuthnRequest " + authnRequest.getID()
 192                     + " to AuthenticationManager", ex);
 193         } catch (ServletException ex) {
 194             log.error("Error forwarding SAML 2 AuthnRequest " + authnRequest.getID() + " to AuthenticationManager", ex);
 195             throw new ProfileException("Error forwarding SAML 2 AuthnRequest " + authnRequest.getID()
 196                     + " to AuthenticationManager", ex);
 197         }
 198     }
 199
 200     /**
 201      * Creates a response to the {@link AuthnRequest} and sends the user, with response in tow, back to the relying
 202      * party after they've been authenticated.
 203      *
 204      * @param request current request
 205      * @param response current response
 206      *
 207      * @throws ProfileException thrown if the response can not be created and sent back to the relying party
 208      */
 209     protected void completeAuthenticationRequest(ProfileRequest<ServletRequest> request,
 210             ProfileResponse<ServletResponse> response) throws ProfileException {
 211
 212         HttpSession httpSession = ((HttpServletRequest) request.getRawRequest()).getSession(true);
 213
 214         Saml2LoginContext loginContext = (Saml2LoginContext) httpSession.getAttribute(LoginContext.LOGIN_CONTEXT_KEY);
 215         httpSession.removeAttribute(LoginContext.LOGIN_CONTEXT_KEY);
 216
 217         SSORequestContext requestContext = buildRequestContext(loginContext, request, response);
 218
 219         checkSamlVersion(requestContext);
 220
 221         Response samlResponse;
 222         try {
 223             if (!loginContext.isPrincipalAuthenticated()) {
 224                 requestContext
 225                         .setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, StatusCode.AUTHN_FAILED_URI, null));
 226                 throw new ProfileException("User failed authentication");
 227             }
 228
 229             ArrayList<Statement> statements = new ArrayList<Statement>();
 230             statements.add(buildAuthnStatement(requestContext));
 231             if (requestContext.getProfileConfiguration().includeAttributeStatement()) {
 232                 statements.add(buildAttributeStatement(requestContext));
 233             }
 234
 235             Subject assertionSubject = buildSubject(requestContext, "urn:oasis:names:tc:SAML:2.0:cm:bearer");
 236
 237             samlResponse = buildResponse(requestContext, assertionSubject, statements);
 238         } catch (ProfileException e) {
 239             samlResponse = buildErrorResponse(requestContext);
 240         }
 241
 242         requestContext.setSamlResponse(samlResponse);
 243         encodeResponse(requestContext);
 244         writeAuditLogEntry(requestContext);
 245     }
 246
 247     /**
 248      * Creates an appropriate message decoder, populates it, and decodes the incoming request.
 249      *
 250      * @param request current request
 251      *
 252      * @return message decoder containing the decoded message and other stateful information
 253      *
 254      * @throws ProfileException thrown if the incomming message failed decoding
 255      */
 256     protected MessageDecoder<ServletRequest> decodeRequest(ProfileRequest<ServletRequest> request)
 257             throws ProfileException {
 258         MessageDecoder<ServletRequest> decoder = getMessageDecoderFactory().getMessageDecoder(decodingBinding);
 259         if (decoder == null) {
 260             log.error("No request decoder was registered for binding type: " + decodingBinding);
 261             throw new ProfileException("No request decoder was registered for binding type: " + decodingBinding);
 262         }
 263
 264         populateMessageDecoder(decoder);
 265         decoder.setRequest(request.getRawRequest());
 266         try {
 267             decoder.decode();
 268             return decoder;
 269         } catch (BindingException e) {
 270             log.error("Error decoding authentication request message", e);
 271             throw new ProfileException("Error decoding authentication request message", e);
 272         } catch (SecurityPolicyException e) {
 273             log.error("Message did not meet security policy requirements", e);
 274             throw new ProfileException("Message did not meet security policy requirements", e);
 275         }
 276     }
 277
 278     /**
 279      * Creates an authentication request context from the current environmental information.
 280      *
 281      * @param loginContext current login context
 282      * @param request current request
 283      * @param response current response
 284      *
 285      * @return created authentication request context
 286      *
 287      * @throws ProfileException thrown if there is a problem creating the context
 288      */
 289     protected SSORequestContext buildRequestContext(Saml2LoginContext loginContext,
 290             ProfileRequest<ServletRequest> request, ProfileResponse<ServletResponse> response) throws ProfileException {
 291         SSORequestContext requestContext = new SSORequestContext(request, response);
 292
 293         try {
 294             requestContext.setMessageDecoder(getMessageDecoderFactory().getMessageDecoder(decodingBinding));
 295
 296             requestContext.setLoginContext(loginContext);
 297
 298             String relyingPartyId = loginContext.getRelyingPartyId();
 299             AuthnRequest authnRequest = loginContext.getAuthenticationRequest();
 300
 301             requestContext.setRelyingPartyId(relyingPartyId);
 302
 303             requestContext.setRelyingPartyMetadata(getMetadataProvider().getEntityDescriptor(relyingPartyId));
 304
 305             requestContext.setRelyingPartyRoleMetadata(requestContext.getRelyingPartyMetadata().getSPSSODescriptor(
 306                     SAMLConstants.SAML20P_NS));
 307
 308             RelyingPartyConfiguration rpConfig = getRelyingPartyConfiguration(relyingPartyId);
 309             requestContext.setRelyingPartyConfiguration(rpConfig);
 310
 311             requestContext.setAssertingPartyId(requestContext.getRelyingPartyConfiguration().getProviderId());
 312
 313             requestContext.setAssertingPartyMetadata(getMetadataProvider().getEntityDescriptor(
 314                     requestContext.getAssertingPartyId()));
 315
 316             requestContext.setAssertingPartyRoleMetadata(requestContext.getRelyingPartyMetadata().getIDPSSODescriptor(
 317                     SAMLConstants.SAML20P_NS));
 318
 319             requestContext.setPrincipalName(loginContext.getPrincipalName());
 320
 321             requestContext.setProfileConfiguration((SSOConfiguration) rpConfig
 322                     .getProfileConfiguration(SSOConfiguration.PROFILE_ID));
 323
 324             requestContext.setSamlRequest(authnRequest);
 325
 326             return requestContext;
 327         } catch (UnmarshallingException e) {
 328             log.error("Unable to unmarshall authentication request context");
 329             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null,
 330                     "Error recovering request state"));
 331             throw new ProfileException("Error recovering request state", e);
 332         } catch (MetadataProviderException e) {
 333             log.error("Unable to locate metadata for asserting or relying party");
 334             requestContext
 335                     .setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Error locating party metadata"));
 336             throw new ProfileException("Error locating party metadata");
 337         }
 338     }
 339
 340     /**
 341      * Creates an authentication statement for the current request.
 342      *
 343      * @param requestContext current request context
 344      *
 345      * @return constructed authentication statement
 346      */
 347     protected AuthnStatement buildAuthnStatement(SSORequestContext requestContext) {
 348         Saml2LoginContext loginContext = requestContext.getLoginContext();
 349
 350         AuthnContext authnContext = buildAuthnContext(requestContext);
 351
 352         AuthnStatement statement = authnStatementBuilder.buildObject();
 353         statement.setAuthnContext(authnContext);
 354         statement.setAuthnInstant(loginContext.getAuthenticationInstant());
 355
 356         // TODO
 357         statement.setSessionIndex(null);
 358
 359         if (loginContext.getAuthenticationDuration() > 0) {
 360             statement.setSessionNotOnOrAfter(loginContext.getAuthenticationInstant().plus(
 361                     loginContext.getAuthenticationDuration()));
 362         }
 363
 364         statement.setSubjectLocality(buildSubjectLocality(requestContext));
 365
 366         return statement;
 367     }
 368
 369     /**
 370      * Creates an {@link AuthnContext} for a succesful authentication request.
 371      *
 372      * @param requestContext current request
 373      *
 374      * @return the built authn context
 375      */
 376     protected AuthnContext buildAuthnContext(SSORequestContext requestContext) {
 377         AuthnContext authnContext = authnContextBuilder.buildObject();
 378
 379         Saml2LoginContext loginContext = requestContext.getLoginContext();
 380         AuthnRequest authnRequest = requestContext.getSamlRequest();
 381         RequestedAuthnContext requestedAuthnContext = authnRequest.getRequestedAuthnContext();
 382         if (requestedAuthnContext != null) {
 383             if (requestedAuthnContext.getAuthnContextClassRefs() != null) {
 384                 for (AuthnContextClassRef classRef : requestedAuthnContext.getAuthnContextClassRefs()) {
 385                     if (classRef.getAuthnContextClassRef().equals(loginContext.getAuthenticationMethod())) {
 386                         AuthnContextClassRef ref = authnContextClassRefBuilder.buildObject();
 387                         ref.setAuthnContextClassRef(loginContext.getAuthenticationMethod());
 388                         authnContext.setAuthnContextClassRef(ref);
 389                     }
 390                 }
 391             } else if (requestedAuthnContext.getAuthnContextDeclRefs() != null) {
 392                 for (AuthnContextDeclRef declRef : requestedAuthnContext.getAuthnContextDeclRefs()) {
 393                     if (declRef.getAuthnContextDeclRef().equals(loginContext.getAuthenticationMethod())) {
 394                         AuthnContextDeclRef ref = authnContextDeclRefBuilder.buildObject();
 395                         ref.setAuthnContextDeclRef(loginContext.getAuthenticationMethod());
 396                         authnContext.setAuthnContextDeclRef(ref);
 397                     }
 398                 }
 399             }
 400         } else {
 401             AuthnContextDeclRef ref = authnContextDeclRefBuilder.buildObject();
 402             ref.setAuthnContextDeclRef(loginContext.getAuthenticationMethod());
 403             authnContext.setAuthnContextDeclRef(ref);
 404         }
 405
 406         return authnContext;
 407     }
 408
 409     /**
 410      * Constructs the subject locality for the authentication statement.
 411      *
 412      * @param requestContext curent request context
 413      *
 414      * @return subject locality for the authentication statement
 415      */
 416     protected SubjectLocality buildSubjectLocality(SSORequestContext requestContext) {
 417         SubjectLocality subjectLocality = subjectLocalityBuilder.buildObject();
 418
 419         HttpServletRequest httpRequest = (HttpServletRequest) requestContext.getProfileRequest().getRawRequest();
 420         subjectLocality.setAddress(httpRequest.getRemoteAddr());
 421         subjectLocality.setDNSName(httpRequest.getRemoteHost());
 422
 423         return subjectLocality;
 424     }
 425
 426     /**
 427      * Encodes the request's SAML response and writes it to the servlet response.
 428      *
 429      * @param requestContext current request context
 430      *
 431      * @throws ProfileException thrown if no message encoder is registered for this profiles binding
 432      */
 433     protected void encodeResponse(SSORequestContext requestContext) throws ProfileException {
 434         if (log.isDebugEnabled()) {
 435             log.debug("Encoding response to SAML request " + requestContext.getSamlRequest().getID()
 436                     + " from relying party " + requestContext.getRelyingPartyId());
 437         }
 438         AuthnResponseEndpointSelector endpointSelector = new AuthnResponseEndpointSelector();
 439         endpointSelector.setEndpointType(AssertionConsumerService.DEFAULT_ELEMENT_NAME);
 440         endpointSelector.setMetadataProvider(getMetadataProvider());
 441         endpointSelector.setRelyingParty(requestContext.getRelyingPartyMetadata());
 442         endpointSelector.setRelyingPartyRole(requestContext.getRelyingPartyRoleMetadata());
 443         endpointSelector.setSamlRequest(requestContext.getSamlRequest());
 444         endpointSelector.getSupportedIssuerBindings().addAll(supportedOutgoingBindings);
 445         Endpoint relyingPartyEndpoint = endpointSelector.selectEndpoint();
 446
 447         MessageEncoder<ServletResponse> encoder = getMessageEncoderFactory().getMessageEncoder(
 448                 relyingPartyEndpoint.getBinding());
 449         if (encoder == null) {
 450             log.error("No response encoder was registered for binding type: " + relyingPartyEndpoint.getBinding());
 451             throw new ProfileException("No response encoder was registered for binding type: "
 452                     + relyingPartyEndpoint.getBinding());
 453         }
 454
 455         super.populateMessageEncoder(encoder);
 456         encoder.setIssuer(requestContext.getAssertingPartyId());
 457         encoder.setRelyingParty(requestContext.getRelyingPartyMetadata());
 458         encoder.setRelyingPartyEndpoint(relyingPartyEndpoint);
 459         encoder.setRelyingPartyRole(requestContext.getRelyingPartyRoleMetadata());
 460         ProfileResponse<ServletResponse> profileResponse = requestContext.getProfileResponse();
 461         encoder.setResponse(profileResponse.getRawResponse());
 462         encoder.setSamlMessage(requestContext.getSamlResponse());
 463         requestContext.setMessageEncoder(encoder);
 464
 465         try {
 466             encoder.encode();
 467         } catch (BindingException e) {
 468             throw new ProfileException("Unable to encode response to relying party: "
 469                     + requestContext.getRelyingPartyId(), e);
 470         }
 471     }
 472
 473     /** Represents the internal state of a SAML 2.0 SSO Request while it's being processed by the IdP. */
 474     protected class SSORequestContext extends SAML2ProfileRequestContext<AuthnRequest, Response, SSOConfiguration> {
 475
 476         /** Current login context. */
 477         private Saml2LoginContext loginContext;
 478
 479         /**
 480          * Constructor.
 481          *
 482          * @param request current profile request
 483          * @param response current profile response
 484          */
 485         public SSORequestContext(ProfileRequest<ServletRequest> request, ProfileResponse<ServletResponse> response) {
 486             super(request, response);
 487         }
 488
 489         /**
 490          * Gets the current login context.
 491          *
 492          * @return current login context
 493          */
 494         public Saml2LoginContext getLoginContext() {
 495             return loginContext;
 496         }
 497
 498         /**
 499          * Sets the current login context.
 500          *
 501          * @param context current login context
 502          */
 503         public void setLoginContext(Saml2LoginContext context) {
 504             loginContext = context;
 505         }
 506     }
 507 }