src/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.io.UnsupportedEncodingException;
  21 import java.net.URLDecoder;
  22 import java.util.ArrayList;
  23 import java.util.List;
  24
  25 import javax.servlet.RequestDispatcher;
  26 import javax.servlet.ServletException;
  27 import javax.servlet.ServletRequest;
  28 import javax.servlet.ServletResponse;
  29 import javax.servlet.http.HttpServletRequest;
  30 import javax.servlet.http.HttpServletResponse;
  31 import javax.servlet.http.HttpSession;
  32
  33 import org.apache.log4j.Logger;
  34 import org.opensaml.common.SAMLObjectBuilder;
  35 import org.opensaml.common.binding.BasicEndpointSelector;
  36 import org.opensaml.common.binding.BindingException;
  37 import org.opensaml.common.binding.encoding.MessageEncoder;
  38 import org.opensaml.saml1.core.AuthenticationStatement;
  39 import org.opensaml.saml1.core.Request;
  40 import org.opensaml.saml1.core.Response;
  41 import org.opensaml.saml1.core.Statement;
  42 import org.opensaml.saml1.core.StatusCode;
  43 import org.opensaml.saml1.core.Subject;
  44 import org.opensaml.saml1.core.SubjectLocality;
  45 import org.opensaml.saml2.metadata.AssertionConsumerService;
  46 import org.opensaml.saml2.metadata.Endpoint;
  47 import org.opensaml.saml2.metadata.RoleDescriptor;
  48 import org.opensaml.saml2.metadata.provider.MetadataProviderException;
  49 import org.opensaml.xml.util.DatatypeHelper;
  50
  51 import edu.internet2.middleware.shibboleth.common.ShibbolethConstants;
  52 import edu.internet2.middleware.shibboleth.common.profile.ProfileException;
  53 import edu.internet2.middleware.shibboleth.common.profile.ProfileRequest;
  54 import edu.internet2.middleware.shibboleth.common.profile.ProfileResponse;
  55 import edu.internet2.middleware.shibboleth.common.relyingparty.RelyingPartyConfiguration;
  56 import edu.internet2.middleware.shibboleth.common.relyingparty.provider.saml1.ShibbolethSSOConfiguration;
  57 import edu.internet2.middleware.shibboleth.common.util.HttpHelper;
  58 import edu.internet2.middleware.shibboleth.idp.authn.LoginContext;
  59 import edu.internet2.middleware.shibboleth.idp.authn.ShibbolethSSOLoginContext;
  60
  61 /** Shibboleth SSO request profile handler. */
  62 public class ShibbolethSSOProfileHandler extends AbstractSAML1ProfileHandler {
  63
  64     /** Class logger. */
  65     private final Logger log = Logger.getLogger(ShibbolethSSOProfileHandler.class);
  66
  67     /** Builder of AuthenticationStatement objects. */
  68     private SAMLObjectBuilder<AuthenticationStatement> authnStatementBuilder;
  69
  70     /** Builder of SubjectLocality objects. */
  71     private SAMLObjectBuilder<SubjectLocality> subjectLocalityBuilder;
  72
  73     /** URL of the authentication manager servlet. */
  74     private String authenticationManagerPath;
  75
  76     /** URI of SAML 1 bindings supported for outgoing message encoding. */
  77     private ArrayList<String> supportedOutgoingBindings;
  78
  79     /**
  80      * Constructor.
  81      *
  82      * @param authnManagerPath path to the authentication manager servlet
  83      * @param outgoingBindings URIs of SAML 1 bindings supported for outgoing message encoding
  84      *
  85      * @throws IllegalArgumentException thrown if either the authentication manager path or encoding binding URI are
  86      *             null or empty
  87      */
  88     public ShibbolethSSOProfileHandler(String authnManagerPath, List<String> outgoingBindings) {
  89         if (DatatypeHelper.isEmpty(authnManagerPath)) {
  90             throw new IllegalArgumentException("Authentication manager path may not be null");
  91         }
  92         authenticationManagerPath = authnManagerPath;
  93
  94         if(outgoingBindings == null || outgoingBindings.isEmpty()){
  95             throw new IllegalArgumentException("List of supported outgoing bindings may not be empty");
  96         }
  97         supportedOutgoingBindings = new ArrayList<String>(outgoingBindings);
  98
  99         authnStatementBuilder = (SAMLObjectBuilder<AuthenticationStatement>) getBuilderFactory().getBuilder(
 100                 AuthenticationStatement.DEFAULT_ELEMENT_NAME);
 101
 102         subjectLocalityBuilder = (SAMLObjectBuilder<SubjectLocality>) getBuilderFactory().getBuilder(
 103                 SubjectLocality.DEFAULT_ELEMENT_NAME);
 104     }
 105
 106     /** {@inheritDoc} */
 107     public String getProfileId() {
 108         return "urn:mace:shibboleth:2.0:idp:profiles:shibboleth:request:sso";
 109     }
 110
 111     /** {@inheritDoc} */
 112     public void processRequest(ProfileRequest<ServletRequest> request, ProfileResponse<ServletResponse> response)
 113             throws ProfileException {
 114
 115         if (response.getRawResponse().isCommitted()) {
 116             log.error("HTTP Response already committed");
 117         }
 118
 119         if (log.isDebugEnabled()) {
 120             log.debug("Processing incomming request");
 121         }
 122         HttpSession httpSession = ((HttpServletRequest) request.getRawRequest()).getSession(true);
 123         if (httpSession.getAttribute(LoginContext.LOGIN_CONTEXT_KEY) == null) {
 124             if (log.isDebugEnabled()) {
 125                 log.debug("User session does not contain a login context, processing as first leg of request");
 126             }
 127             performAuthentication(request, response);
 128         } else {
 129             if (log.isDebugEnabled()) {
 130                 log.debug("User session contains a login context, processing as second leg of request");
 131             }
 132             completeAuthenticationRequest(request, response);
 133         }
 134     }
 135
 136     /**
 137      * Creates a {@link LoginContext} an sends the request off to the AuthenticationManager to begin the process of
 138      * authenticating the user.
 139      *
 140      * @param request current request
 141      * @param response current response
 142      *
 143      * @throws ProfileException thrown if there is a problem creating the login context and transferring control to the
 144      *             authentication manager
 145      */
 146     protected void performAuthentication(ProfileRequest<ServletRequest> request,
 147             ProfileResponse<ServletResponse> response) throws ProfileException {
 148
 149         HttpServletRequest httpRequest = (HttpServletRequest) request.getRawRequest();
 150         HttpServletResponse httpResponse = (HttpServletResponse) response.getRawResponse();
 151         HttpSession httpSession = httpRequest.getSession(true);
 152
 153         LoginContext loginContext = buildLoginContext(httpRequest);
 154         if (getRelyingPartyConfiguration(loginContext.getRelyingPartyId()) == null) {
 155             log.error("Shibboleth SSO profile is not configured for relying party " + loginContext.getRelyingPartyId());
 156             throw new ProfileException("Shibboleth SSO profile is not configured for relying party "
 157                     + loginContext.getRelyingPartyId());
 158         }
 159
 160         httpSession.setAttribute(LoginContext.LOGIN_CONTEXT_KEY, loginContext);
 161
 162         try {
 163             RequestDispatcher dispatcher = httpRequest.getRequestDispatcher(authenticationManagerPath);
 164             dispatcher.forward(httpRequest, httpResponse);
 165             return;
 166         } catch (IOException ex) {
 167             log.error("Error forwarding Shibboleth SSO request to AuthenticationManager", ex);
 168             throw new ProfileException("Error forwarding Shibboleth SSO request to AuthenticationManager", ex);
 169         } catch (ServletException ex) {
 170             log.error("Error forwarding Shibboleth SSO request to AuthenticationManager", ex);
 171             throw new ProfileException("Error forwarding Shibboleth SSO request to AuthenticationManager", ex);
 172         }
 173     }
 174
 175     /**
 176      * Creates a response to the Shibboleth SSO and sends the user, with response in tow, back to the relying party
 177      * after they've been authenticated.
 178      *
 179      * @param request current request
 180      * @param response current response
 181      *
 182      * @throws ProfileException thrown if the response can not be created and sent back to the relying party
 183      */
 184     protected void completeAuthenticationRequest(ProfileRequest<ServletRequest> request,
 185             ProfileResponse<ServletResponse> response) throws ProfileException {
 186         HttpSession httpSession = ((HttpServletRequest) request.getRawRequest()).getSession(true);
 187
 188         ShibbolethSSOLoginContext loginContext = (ShibbolethSSOLoginContext) httpSession
 189                 .getAttribute(LoginContext.LOGIN_CONTEXT_KEY);
 190         httpSession.removeAttribute(LoginContext.LOGIN_CONTEXT_KEY);
 191
 192         ShibbolethSSORequestContext requestContext = buildRequestContext(loginContext, request, response);
 193
 194         Response samlResponse;
 195         try {
 196             if (loginContext.getPrincipalName() == null) {
 197                 requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null, "User failed authentication"));
 198                 throw new ProfileException("User failed authentication");
 199             }
 200
 201             resolveAttributes(requestContext);
 202
 203             ArrayList<Statement> statements = new ArrayList<Statement>();
 204             statements.add(buildAuthenticationStatement(requestContext));
 205             if (requestContext.getProfileConfiguration().includeAttributeStatement()) {
 206                 statements.add(buildAttributeStatement(requestContext, "urn:oasis:names:tc:SAML:1.0:cm:bearer"));
 207             }
 208
 209             samlResponse = buildResponse(requestContext, statements);
 210         } catch (ProfileException e) {
 211             samlResponse = buildErrorResponse(requestContext);
 212         }
 213
 214         requestContext.setSamlResponse(samlResponse);
 215         encodeResponse(requestContext);
 216         writeAuditLogEntry(requestContext);
 217     }
 218
 219     /**
 220      * Creates a login context from the incoming HTTP request.
 221      *
 222      * @param request current HTTP request
 223      *
 224      * @return the constructed login context
 225      *
 226      * @throws ProfileException thrown if the incomming request did not contain a providerId, shire, and target
 227      *             parameter
 228      */
 229     protected ShibbolethSSOLoginContext buildLoginContext(HttpServletRequest request) throws ProfileException {
 230         ShibbolethSSOLoginContext loginContext = new ShibbolethSSOLoginContext();
 231
 232         try {
 233             String providerId = DatatypeHelper.safeTrimOrNullString(request.getParameter("providerId"));
 234             if (providerId == null) {
 235                 log.error("No providerId parameter in Shibboleth SSO request");
 236                 throw new ProfileException("No providerId parameter in Shibboleth SSO request");
 237             }
 238             loginContext.setRelyingParty(URLDecoder.decode(providerId, "UTF-8"));
 239
 240             RelyingPartyConfiguration rpConfig = getRelyingPartyConfiguration(providerId);
 241             if (rpConfig == null) {
 242                 log.error("No relying party configuration available for " + providerId);
 243                 throw new ProfileException("No relying party configuration available for " + providerId);
 244             }
 245             loginContext.getRequestedAuthenticationMethods().add(rpConfig.getDefaultAuthenticationMethod());
 246
 247             String acs = DatatypeHelper.safeTrimOrNullString(request.getParameter("shire"));
 248             if (acs == null) {
 249                 log.error("No shire parameter in Shibboleth SSO request");
 250                 throw new ProfileException("No shire parameter in Shibboleth SSO request");
 251             }
 252             loginContext.setSpAssertionConsumerService(URLDecoder.decode(acs, "UTF-8"));
 253
 254             String target = DatatypeHelper.safeTrimOrNullString(request.getParameter("target"));
 255             if (target == null) {
 256                 log.error("No target parameter in Shibboleth SSO request");
 257                 throw new ProfileException("No target parameter in Shibboleth SSO request");
 258             }
 259             loginContext.setSpTarget(URLDecoder.decode(target, "UTF-8"));
 260         } catch (UnsupportedEncodingException e) {
 261             // UTF-8 encoding required to be supported by all JVMs.
 262         }
 263
 264         loginContext.setAuthenticationEngineURL(authenticationManagerPath);
 265         loginContext.setProfileHandlerURL(HttpHelper.getRequestUriWithoutContext(request));
 266         return loginContext;
 267     }
 268
 269     /**
 270      * Creates an authentication request context from the current environmental information.
 271      *
 272      * @param loginContext current login context
 273      * @param request current request
 274      * @param response current response
 275      *
 276      * @return created authentication request context
 277      *
 278      * @throws ProfileException thrown if asserting and relying party metadata can not be located
 279      */
 280     protected ShibbolethSSORequestContext buildRequestContext(ShibbolethSSOLoginContext loginContext,
 281             ProfileRequest<ServletRequest> request, ProfileResponse<ServletResponse> response) throws ProfileException {
 282         ShibbolethSSORequestContext requestContext = new ShibbolethSSORequestContext(request, response);
 283
 284         requestContext.setRelayState(loginContext.getSpTarget());
 285
 286         requestContext.setLoginContext(loginContext);
 287
 288         requestContext.setPrincipalName(loginContext.getPrincipalName());
 289
 290         requestContext.setPrincipalAuthenticationMethod(loginContext.getAuthenticationMethod());
 291
 292         String relyingPartyId = loginContext.getRelyingPartyId();
 293
 294         requestContext.setRelyingPartyId(relyingPartyId);
 295
 296         populateRelyingPartyData(requestContext);
 297
 298         populateAssertingPartyData(requestContext);
 299
 300         return requestContext;
 301     }
 302
 303     /**
 304      * Populates the relying party entity and role metadata and relying party configuration data.
 305      *
 306      * @param requestContext current request context with relying party ID populated
 307      *
 308      * @throws ProfileException thrown if metadata can not be located for the relying party
 309      */
 310     protected void populateRelyingPartyData(ShibbolethSSORequestContext requestContext) throws ProfileException {
 311         try {
 312             requestContext.setRelyingPartyMetadata(getMetadataProvider().getEntityDescriptor(
 313                     requestContext.getRelyingPartyId()));
 314
 315             RoleDescriptor relyingPartyRole = requestContext.getRelyingPartyMetadata().getSPSSODescriptor(
 316                     ShibbolethConstants.SAML11P_NS);
 317
 318             if (relyingPartyRole == null) {
 319                 relyingPartyRole = requestContext.getRelyingPartyMetadata().getSPSSODescriptor(
 320                         ShibbolethConstants.SAML10P_NS);
 321                 if (relyingPartyRole == null) {
 322                     throw new MetadataProviderException("Unable to locate SPSSO role descriptor for entity "
 323                             + requestContext.getRelyingPartyId());
 324                 }
 325             }
 326             requestContext.setRelyingPartyRoleMetadata(relyingPartyRole);
 327
 328             RelyingPartyConfiguration rpConfig = getRelyingPartyConfiguration(requestContext.getRelyingPartyId());
 329             requestContext.setRelyingPartyConfiguration(rpConfig);
 330
 331             requestContext.setProfileConfiguration((ShibbolethSSOConfiguration) rpConfig
 332                     .getProfileConfiguration(ShibbolethSSOConfiguration.PROFILE_ID));
 333
 334         } catch (MetadataProviderException e) {
 335             log.error("Unable to locate metadata for relying party " + requestContext.getRelyingPartyId());
 336             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null,
 337                     "Unable to locate metadata for relying party " + requestContext.getRelyingPartyId()));
 338             throw new ProfileException("Unable to locate metadata for relying party "
 339                     + requestContext.getRelyingPartyId());
 340         }
 341     }
 342
 343     /**
 344      * Populates the asserting party entity and role metadata.
 345      *
 346      * @param requestContext current request context with relying party configuration populated
 347      *
 348      * @throws ProfileException thrown if metadata can not be located for the asserting party
 349      */
 350     protected void populateAssertingPartyData(ShibbolethSSORequestContext requestContext) throws ProfileException {
 351         String assertingPartyId = requestContext.getRelyingPartyConfiguration().getProviderId();
 352
 353         try {
 354             requestContext.setAssertingPartyId(assertingPartyId);
 355
 356             requestContext.setAssertingPartyMetadata(getMetadataProvider().getEntityDescriptor(assertingPartyId));
 357
 358             RoleDescriptor assertingPartyRole = requestContext.getAssertingPartyMetadata().getIDPSSODescriptor(
 359                     ShibbolethConstants.SHIB_SSO_PROFILE_URI);
 360             if (assertingPartyRole == null) {
 361                 throw new MetadataProviderException("Unable to locate IDPSSO role descriptor for entity "
 362                         + assertingPartyId);
 363             }
 364             requestContext.setAssertingPartyRoleMetadata(assertingPartyRole);
 365         } catch (MetadataProviderException e) {
 366             log.error("Unable to locate metadata for asserting party " + assertingPartyId);
 367             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null,
 368                     "Unable to locate metadata for relying party " + assertingPartyId));
 369             throw new ProfileException("Unable to locate metadata for relying party " + assertingPartyId);
 370         }
 371     }
 372
 373     /**
 374      * Builds the authentication statement for the authenticated principal.
 375      *
 376      * @param requestContext current request context
 377      *
 378      * @return the created statement
 379      *
 380      * @throws ProfileException thrown if the authentication statement can not be created
 381      */
 382     protected AuthenticationStatement buildAuthenticationStatement(ShibbolethSSORequestContext requestContext)
 383             throws ProfileException {
 384         ShibbolethSSOLoginContext loginContext = requestContext.getLoginContext();
 385
 386         AuthenticationStatement statement = authnStatementBuilder.buildObject();
 387         statement.setAuthenticationInstant(loginContext.getAuthenticationInstant());
 388         statement.setAuthenticationMethod(loginContext.getAuthenticationMethod());
 389
 390         statement.setSubjectLocality(buildSubjectLocality(requestContext));
 391
 392         Subject statementSubject = buildSubject(requestContext, "urn:oasis:names:tc:SAML:1.0:cm:bearer");
 393         statement.setSubject(statementSubject);
 394
 395         return statement;
 396     }
 397
 398     /**
 399      * Constructs the subject locality for the authentication statement.
 400      *
 401      * @param requestContext curent request context
 402      *
 403      * @return subject locality for the authentication statement
 404      */
 405     protected SubjectLocality buildSubjectLocality(ShibbolethSSORequestContext requestContext) {
 406         SubjectLocality subjectLocality = subjectLocalityBuilder.buildObject();
 407
 408         HttpServletRequest httpRequest = (HttpServletRequest) requestContext.getProfileRequest().getRawRequest();
 409         subjectLocality.setIPAddress(httpRequest.getRemoteAddr());
 410         subjectLocality.setDNSAddress(httpRequest.getRemoteHost());
 411
 412         return subjectLocality;
 413     }
 414
 415     /**
 416      * Encodes the request's SAML response and writes it to the servlet response.
 417      *
 418      * @param requestContext current request context
 419      *
 420      * @throws ProfileException thrown if no message encoder is registered for this profiles binding
 421      */
 422     protected void encodeResponse(ShibbolethSSORequestContext requestContext) throws ProfileException {
 423         if (log.isDebugEnabled()) {
 424             log.debug("Encoding response to SAML request from relying party " + requestContext.getRelyingPartyId());
 425         }
 426
 427         Endpoint relyingPartyEndpoint;
 428
 429         BasicEndpointSelector endpointSelector = new BasicEndpointSelector();
 430         endpointSelector.setEndpointType(AssertionConsumerService.DEFAULT_ELEMENT_NAME);
 431         endpointSelector.setMetadataProvider(getMetadataProvider());
 432         endpointSelector.setRelyingParty(requestContext.getRelyingPartyMetadata());
 433         endpointSelector.setRelyingPartyRole(requestContext.getRelyingPartyRoleMetadata());
 434         endpointSelector.setSamlRequest(requestContext.getSamlRequest());
 435         endpointSelector.getSupportedIssuerBindings().addAll(supportedOutgoingBindings);
 436         relyingPartyEndpoint = endpointSelector.selectEndpoint();
 437
 438         if (relyingPartyEndpoint == null) {
 439             log.error("Unable to determine endpoint, from metadata, for relying party "
 440                     + requestContext.getRelyingPartyId() + " acting in SPSSO role");
 441             throw new ProfileException("Unable to determine endpoint, from metadata, for relying party "
 442                     + requestContext.getRelyingPartyId() + " acting in SPSSO role");
 443         }
 444
 445         MessageEncoder<ServletResponse> encoder = getMessageEncoderFactory().getMessageEncoder(
 446                 relyingPartyEndpoint.getBinding());
 447         encoder.setRelyingPartyEndpoint(relyingPartyEndpoint);
 448         super.populateMessageEncoder(encoder);
 449         encoder.setRelayState(requestContext.getRelayState());
 450         ProfileResponse<ServletResponse> profileResponse = requestContext.getProfileResponse();
 451         encoder.setResponse(profileResponse.getRawResponse());
 452         encoder.setSamlMessage(requestContext.getSamlResponse());
 453         requestContext.setMessageEncoder(encoder.getBindingURI());
 454
 455         try {
 456             encoder.encode();
 457         } catch (BindingException e) {
 458             throw new ProfileException("Unable to encode response to relying party: "
 459                     + requestContext.getRelyingPartyId(), e);
 460         }
 461     }
 462
 463     /** Represents the internal state of a Shibboleth SSO Request while it's being processed by the IdP. */
 464     protected class ShibbolethSSORequestContext extends
 465             SAML1ProfileRequestContext<Request, Response, ShibbolethSSOConfiguration> {
 466
 467         /** Current login context. */
 468         private ShibbolethSSOLoginContext loginContext;
 469
 470         /**
 471          * Constructor.
 472          *
 473          * @param request current profile request
 474          * @param response current profile response
 475          */
 476         public ShibbolethSSORequestContext(ProfileRequest<ServletRequest> request,
 477                 ProfileResponse<ServletResponse> response) {
 478             super(request, response);
 479         }
 480
 481         /**
 482          * Gets the current login context.
 483          *
 484          * @return current login context
 485          */
 486         public ShibbolethSSOLoginContext getLoginContext() {
 487             return loginContext;
 488         }
 489
 490         /**
 491          * Sets the current login context.
 492          *
 493          * @param context current login context
 494          */
 495         public void setLoginContext(ShibbolethSSOLoginContext context) {
 496             loginContext = context;
 497         }
 498     }
 499 }