src/edu/internet2/middleware/shibboleth/idp/profile/saml2/AbstractSAML2ProfileHandler.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.util.ArrayList;
  20 import java.util.Collection;
  21 import java.util.List;
  22 import java.util.Map;
  23
  24 import org.joda.time.DateTime;
  25 import org.opensaml.common.SAMLObjectBuilder;
  26 import org.opensaml.common.SAMLVersion;
  27 import org.opensaml.saml2.core.Assertion;
  28 import org.opensaml.saml2.core.AttributeQuery;
  29 import org.opensaml.saml2.core.AttributeStatement;
  30 import org.opensaml.saml2.core.Audience;
  31 import org.opensaml.saml2.core.AudienceRestriction;
  32 import org.opensaml.saml2.core.AuthnRequest;
  33 import org.opensaml.saml2.core.Conditions;
  34 import org.opensaml.saml2.core.Issuer;
  35 import org.opensaml.saml2.core.NameID;
  36 import org.opensaml.saml2.core.ProxyRestriction;
  37 import org.opensaml.saml2.core.Response;
  38 import org.opensaml.saml2.core.Statement;
  39 import org.opensaml.saml2.core.Status;
  40 import org.opensaml.saml2.core.StatusCode;
  41 import org.opensaml.saml2.core.StatusMessage;
  42 import org.opensaml.saml2.core.StatusResponseType;
  43 import org.opensaml.saml2.core.Subject;
  44 import org.opensaml.saml2.core.SubjectConfirmation;
  45 import org.opensaml.saml2.core.SubjectConfirmationData;
  46 import org.opensaml.saml2.metadata.AttributeAuthorityDescriptor;
  47 import org.opensaml.saml2.metadata.AuthnAuthorityDescriptor;
  48 import org.opensaml.saml2.metadata.Endpoint;
  49 import org.opensaml.saml2.metadata.NameIDFormat;
  50 import org.opensaml.saml2.metadata.PDPDescriptor;
  51 import org.opensaml.saml2.metadata.RoleDescriptor;
  52 import org.opensaml.saml2.metadata.SPSSODescriptor;
  53 import org.opensaml.saml2.metadata.SSODescriptor;
  54 import org.opensaml.ws.transport.http.HTTPInTransport;
  55 import org.opensaml.xml.XMLObjectBuilder;
  56 import org.opensaml.xml.security.SecurityException;
  57 import org.opensaml.xml.security.SecurityHelper;
  58 import org.opensaml.xml.security.credential.Credential;
  59 import org.opensaml.xml.signature.Signature;
  60 import org.opensaml.xml.signature.Signer;
  61 import org.opensaml.xml.util.DatatypeHelper;
  62 import org.slf4j.Logger;
  63 import org.slf4j.LoggerFactory;
  64
  65 import edu.internet2.middleware.shibboleth.common.attribute.AttributeRequestException;
  66 import edu.internet2.middleware.shibboleth.common.attribute.BaseAttribute;
  67 import edu.internet2.middleware.shibboleth.common.attribute.encoding.AttributeEncoder;
  68 import edu.internet2.middleware.shibboleth.common.attribute.encoding.AttributeEncodingException;
  69 import edu.internet2.middleware.shibboleth.common.attribute.encoding.SAML2NameIDAttributeEncoder;
  70 import edu.internet2.middleware.shibboleth.common.attribute.provider.SAML2AttributeAuthority;
  71 import edu.internet2.middleware.shibboleth.common.profile.ProfileException;
  72 import edu.internet2.middleware.shibboleth.common.relyingparty.provider.saml2.AbstractSAML2ProfileConfiguration;
  73 import edu.internet2.middleware.shibboleth.idp.profile.AbstractSAMLProfileHandler;
  74
  75 /** Common implementation details for profile handlers. */
  76 public abstract class AbstractSAML2ProfileHandler extends AbstractSAMLProfileHandler {
  77
  78     /** SAML Version for this profile handler. */
  79     public static final SAMLVersion SAML_VERSION = SAMLVersion.VERSION_20;
  80
  81     /** Class logger. */
  82     private Logger log = LoggerFactory.getLogger(AbstractSAML2ProfileHandler.class);
  83
  84     /** For building response. */
  85     private SAMLObjectBuilder<Response> responseBuilder;
  86
  87     /** For building status. */
  88     private SAMLObjectBuilder<Status> statusBuilder;
  89
  90     /** For building statuscode. */
  91     private SAMLObjectBuilder<StatusCode> statusCodeBuilder;
  92
  93     /** For building StatusMessages. */
  94     private SAMLObjectBuilder<StatusMessage> statusMessageBuilder;
  95
  96     /** For building assertion. */
  97     private SAMLObjectBuilder<Assertion> assertionBuilder;
  98
  99     /** For building issuer. */
 100     private SAMLObjectBuilder<Issuer> issuerBuilder;
 101
 102     /** For building subject. */
 103     private SAMLObjectBuilder<Subject> subjectBuilder;
 104
 105     /** For building subject confirmation. */
 106     private SAMLObjectBuilder<SubjectConfirmation> subjectConfirmationBuilder;
 107
 108     /** For building subject confirmation data. */
 109     private SAMLObjectBuilder<SubjectConfirmationData> subjectConfirmationDataBuilder;
 110
 111     /** For building conditions. */
 112     private SAMLObjectBuilder<Conditions> conditionsBuilder;
 113
 114     /** For building audience restriction. */
 115     private SAMLObjectBuilder<AudienceRestriction> audienceRestrictionBuilder;
 116
 117     /** For building proxy retrictions. */
 118     private SAMLObjectBuilder<ProxyRestriction> proxyRestrictionBuilder;
 119
 120     /** For building audience. */
 121     private SAMLObjectBuilder<Audience> audienceBuilder;
 122
 123     /** For building signature. */
 124     private XMLObjectBuilder<Signature> signatureBuilder;
 125
 126     /** Constructor. */
 127     @SuppressWarnings("unchecked")
 128     protected AbstractSAML2ProfileHandler() {
 129         super();
 130
 131         responseBuilder = (SAMLObjectBuilder<Response>) getBuilderFactory().getBuilder(Response.DEFAULT_ELEMENT_NAME);
 132         statusBuilder = (SAMLObjectBuilder<Status>) getBuilderFactory().getBuilder(Status.DEFAULT_ELEMENT_NAME);
 133         statusCodeBuilder = (SAMLObjectBuilder<StatusCode>) getBuilderFactory().getBuilder(
 134                 StatusCode.DEFAULT_ELEMENT_NAME);
 135         statusMessageBuilder = (SAMLObjectBuilder<StatusMessage>) getBuilderFactory().getBuilder(
 136                 StatusMessage.DEFAULT_ELEMENT_NAME);
 137         issuerBuilder = (SAMLObjectBuilder<Issuer>) getBuilderFactory().getBuilder(Issuer.DEFAULT_ELEMENT_NAME);
 138         assertionBuilder = (SAMLObjectBuilder<Assertion>) getBuilderFactory()
 139                 .getBuilder(Assertion.DEFAULT_ELEMENT_NAME);
 140         subjectBuilder = (SAMLObjectBuilder<Subject>) getBuilderFactory().getBuilder(Subject.DEFAULT_ELEMENT_NAME);
 141         subjectConfirmationBuilder = (SAMLObjectBuilder<SubjectConfirmation>) getBuilderFactory().getBuilder(
 142                 SubjectConfirmation.DEFAULT_ELEMENT_NAME);
 143         subjectConfirmationDataBuilder = (SAMLObjectBuilder<SubjectConfirmationData>) getBuilderFactory().getBuilder(
 144                 SubjectConfirmationData.DEFAULT_ELEMENT_NAME);
 145         conditionsBuilder = (SAMLObjectBuilder<Conditions>) getBuilderFactory().getBuilder(
 146                 Conditions.DEFAULT_ELEMENT_NAME);
 147         audienceRestrictionBuilder = (SAMLObjectBuilder<AudienceRestriction>) getBuilderFactory().getBuilder(
 148                 AudienceRestriction.DEFAULT_ELEMENT_NAME);
 149         proxyRestrictionBuilder = (SAMLObjectBuilder<ProxyRestriction>) getBuilderFactory().getBuilder(
 150                 ProxyRestriction.DEFAULT_ELEMENT_NAME);
 151         audienceBuilder = (SAMLObjectBuilder<Audience>) getBuilderFactory().getBuilder(Audience.DEFAULT_ELEMENT_NAME);
 152         signatureBuilder = (XMLObjectBuilder<Signature>) getBuilderFactory().getBuilder(Signature.DEFAULT_ELEMENT_NAME);
 153     }
 154
 155     /**
 156      * Checks that the SAML major version for a request is 2.
 157      *
 158      * @param requestContext current request context containing the SAML message
 159      *
 160      * @throws ProfileException thrown if the major version of the SAML request is not 2
 161      */
 162     protected void checkSamlVersion(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext) throws ProfileException {
 163         SAMLVersion version = requestContext.getInboundSAMLMessage().getVersion();
 164         if (version.getMajorVersion() < 2) {
 165             requestContext.setFailureStatus(buildStatus(StatusCode.VERSION_MISMATCH_URI,
 166                     StatusCode.REQUEST_VERSION_TOO_LOW_URI, null));
 167             throw new ProfileException("SAML request version too low");
 168         } else if (version.getMajorVersion() > 2) {
 169             requestContext.setFailureStatus(buildStatus(StatusCode.VERSION_MISMATCH_URI,
 170                     StatusCode.REQUEST_VERSION_TOO_HIGH_URI, null));
 171             throw new ProfileException("SAML request version too high");
 172         }
 173     }
 174
 175     /**
 176      * Builds a response to the attribute query within the request context.
 177      *
 178      * @param requestContext current request context
 179      * @param subjectConfirmationMethod confirmation method used for the subject
 180      * @param statements the statements to include in the response
 181      *
 182      * @return the built response
 183      *
 184      * @throws ProfileException thrown if there is a problem creating the SAML response
 185      */
 186     protected Response buildResponse(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext,
 187             String subjectConfirmationMethod, List<Statement> statements) throws ProfileException {
 188
 189         DateTime issueInstant = new DateTime();
 190
 191         Subject subject = buildSubject(requestContext, subjectConfirmationMethod, issueInstant);
 192
 193         // create the assertion and add the attribute statement
 194         Assertion assertion = buildAssertion(requestContext, issueInstant);
 195         assertion.setSubject(subject);
 196         if (statements != null) {
 197             assertion.getStatements().addAll(statements);
 198         }
 199
 200         // create the SAML response and add the assertion
 201         Response samlResponse = responseBuilder.buildObject();
 202         samlResponse.setIssueInstant(issueInstant);
 203         populateStatusResponse(requestContext, samlResponse);
 204
 205         samlResponse.getAssertions().add(assertion);
 206
 207         // sign the assertion if it should be signed
 208         signAssertion(requestContext, assertion);
 209
 210         Status status = buildStatus(StatusCode.SUCCESS_URI, null, null);
 211         samlResponse.setStatus(status);
 212
 213         return samlResponse;
 214     }
 215
 216     /**
 217      * Builds a basic assertion with its id, issue instant, SAML version, issuer, subject, and conditions populated.
 218      *
 219      * @param requestContext current request context
 220      * @param issueInstant time to use as assertion issue instant
 221      *
 222      * @return the built assertion
 223      */
 224     protected Assertion buildAssertion(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext, DateTime issueInstant) {
 225         Assertion assertion = assertionBuilder.buildObject();
 226         assertion.setID(getIdGenerator().generateIdentifier());
 227         assertion.setIssueInstant(issueInstant);
 228         assertion.setVersion(SAMLVersion.VERSION_20);
 229         assertion.setIssuer(buildEntityIssuer(requestContext));
 230
 231         Conditions conditions = buildConditions(requestContext, issueInstant);
 232         assertion.setConditions(conditions);
 233
 234         return assertion;
 235     }
 236
 237     /**
 238      * Creates an {@link Issuer} populated with information about the relying party.
 239      *
 240      * @param requestContext current request context
 241      *
 242      * @return the built issuer
 243      */
 244     protected Issuer buildEntityIssuer(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext) {
 245         Issuer issuer = issuerBuilder.buildObject();
 246         issuer.setFormat(Issuer.ENTITY);
 247         issuer.setValue(requestContext.getLocalEntityId());
 248
 249         return issuer;
 250     }
 251
 252     /**
 253      * Builds a SAML assertion condition set. The following fields are set; not before, not on or after, audience
 254      * restrictions, and proxy restrictions.
 255      *
 256      * @param requestContext current request context
 257      * @param issueInstant timestamp the assertion was created
 258      *
 259      * @return constructed conditions
 260      */
 261     protected Conditions buildConditions(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext, DateTime issueInstant) {
 262         AbstractSAML2ProfileConfiguration profileConfig = requestContext.getProfileConfiguration();
 263
 264         Conditions conditions = conditionsBuilder.buildObject();
 265         conditions.setNotBefore(issueInstant);
 266         conditions.setNotOnOrAfter(issueInstant.plus(profileConfig.getAssertionLifetime()));
 267
 268         Collection<String> audiences;
 269
 270         // add audience restrictions
 271         audiences = profileConfig.getAssertionAudiences();
 272         if (audiences != null && audiences.size() > 0) {
 273             AudienceRestriction audienceRestriction = audienceRestrictionBuilder.buildObject();
 274             for (String audienceUri : audiences) {
 275                 Audience audience = audienceBuilder.buildObject();
 276                 audience.setAudienceURI(audienceUri);
 277                 audienceRestriction.getAudiences().add(audience);
 278             }
 279             conditions.getAudienceRestrictions().add(audienceRestriction);
 280         }
 281
 282         // add proxy restrictions
 283         audiences = profileConfig.getProxyAudiences();
 284         if (audiences != null && audiences.size() > 0) {
 285             ProxyRestriction proxyRestriction = proxyRestrictionBuilder.buildObject();
 286             Audience audience;
 287             for (String audienceUri : audiences) {
 288                 audience = audienceBuilder.buildObject();
 289                 audience.setAudienceURI(audienceUri);
 290                 proxyRestriction.getAudiences().add(audience);
 291             }
 292
 293             proxyRestriction.setProxyCount(profileConfig.getProxyCount());
 294             conditions.getConditions().add(proxyRestriction);
 295         }
 296
 297         return conditions;
 298     }
 299
 300     /**
 301      * Populates the response's id, in response to, issue instant, version, and issuer properties.
 302      *
 303      * @param requestContext current request context
 304      * @param response the response to populate
 305      */
 306     protected void populateStatusResponse(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext,
 307             StatusResponseType response) {
 308         response.setID(getIdGenerator().generateIdentifier());
 309         if (requestContext.getInboundSAMLMessage() != null) {
 310             response.setInResponseTo(requestContext.getInboundSAMLMessageId());
 311         }
 312         response.setVersion(SAMLVersion.VERSION_20);
 313         response.setIssuer(buildEntityIssuer(requestContext));
 314     }
 315
 316     /**
 317      * Resolves the attributes for the principal.
 318      *
 319      * @param requestContext current request context
 320      *
 321      * @throws ProfileException thrown if there is a problem resolved attributes
 322      */
 323     protected void resolveAttributes(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext) throws ProfileException {
 324         AbstractSAML2ProfileConfiguration profileConfiguration = requestContext.getProfileConfiguration();
 325         SAML2AttributeAuthority attributeAuthority = profileConfiguration.getAttributeAuthority();
 326
 327         try {
 328             log.debug("Resolving attributes for principal {} of SAML request from relying party {}", requestContext
 329                     .getPrincipalName(), requestContext.getInboundMessageIssuer());
 330             Map<String, BaseAttribute> principalAttributes = attributeAuthority.getAttributes(requestContext);
 331
 332             requestContext.setAttributes(principalAttributes);
 333         } catch (AttributeRequestException e) {
 334             log.error("Error resolving attributes for SAML request " + requestContext.getInboundSAMLMessageId()
 335                     + " from relying party " + requestContext.getInboundMessageIssuer(), e);
 336             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Error resolving attributes"));
 337             throw new ProfileException("Error resolving attributes for SAML request "
 338                     + requestContext.getInboundSAMLMessageId() + " from relying party "
 339                     + requestContext.getInboundMessageIssuer(), e);
 340         }
 341     }
 342
 343     /**
 344      * Executes a query for attributes and builds a SAML attribute statement from the results.
 345      *
 346      * @param requestContext current request context
 347      *
 348      * @return attribute statement resulting from the query
 349      *
 350      * @throws ProfileException thrown if there is a problem making the query
 351      */
 352     protected AttributeStatement buildAttributeStatement(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext)
 353             throws ProfileException {
 354         log.debug("Creating attribute statement in response to SAML request {} from relying party {}", requestContext
 355                 .getInboundSAMLMessageId(), requestContext.getInboundMessageIssuer());
 356
 357         AbstractSAML2ProfileConfiguration profileConfiguration = requestContext.getProfileConfiguration();
 358         SAML2AttributeAuthority attributeAuthority = profileConfiguration.getAttributeAuthority();
 359         try {
 360             if (requestContext.getInboundSAMLMessage() instanceof AttributeQuery) {
 361                 return attributeAuthority.buildAttributeStatement((AttributeQuery) requestContext
 362                         .getInboundSAMLMessage(), requestContext.getPrincipalAttributes().values());
 363             } else {
 364                 return attributeAuthority.buildAttributeStatement(null, requestContext.getPrincipalAttributes()
 365                         .values());
 366             }
 367         } catch (AttributeRequestException e) {
 368             log.error("Error encoding attributes for principal " + requestContext.getPrincipalName(), e);
 369             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Error resolving attributes"));
 370             throw new ProfileException("Error encoding attributes for principal " + requestContext.getPrincipalName(),
 371                     e);
 372         }
 373     }
 374
 375     /**
 376      * Resolves the principal name of the subject of the request.
 377      *
 378      * @param requestContext current request context
 379      *
 380      * @throws ProfileException thrown if the principal name can not be resolved
 381      */
 382     protected void resolvePrincipal(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext) throws ProfileException {
 383         AbstractSAML2ProfileConfiguration profileConfiguration = requestContext.getProfileConfiguration();
 384         if (profileConfiguration == null) {
 385             log.error("Unable to resolve principal, no SAML 2 profile configuration for relying party "
 386                     + requestContext.getInboundMessageIssuer());
 387             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, StatusCode.REQUEST_DENIED_URI,
 388                     "Error resolving principal"));
 389             throw new ProfileException(
 390                     "Unable to resolve principal, no SAML 2 profile configuration for relying party "
 391                             + requestContext.getInboundMessageIssuer());
 392         }
 393         SAML2AttributeAuthority attributeAuthority = profileConfiguration.getAttributeAuthority();
 394         log.debug("Resolving principal name for subject of SAML request {} from relying party {}", requestContext
 395                 .getInboundSAMLMessageId(), requestContext.getInboundMessageIssuer());
 396
 397         try {
 398             String principal = attributeAuthority.getPrincipal(requestContext);
 399             requestContext.setPrincipalName(principal);
 400         } catch (AttributeRequestException e) {
 401             log.error("Error resolving attributes for SAML request " + requestContext.getInboundSAMLMessageId()
 402                     + " from relying party " + requestContext.getInboundMessageIssuer(), e);
 403             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, StatusCode.UNKNOWN_PRINCIPAL_URI,
 404                     "Error resolving principal"));
 405             throw new ProfileException("Error resolving attributes for SAML request "
 406                     + requestContext.getInboundSAMLMessageId() + " from relying party "
 407                     + requestContext.getInboundMessageIssuer(), e);
 408         }
 409     }
 410
 411     /**
 412      * Signs the given assertion if either the current profile configuration or the relying party configuration contains
 413      * signing credentials.
 414      *
 415      * @param requestContext current request context
 416      * @param assertion assertion to sign
 417      *
 418      * @throws ProfileException thrown if the metadata can not be located for the relying party or, if signing is
 419      *             required, if a signing credential is not configured
 420      */
 421     protected void signAssertion(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext, Assertion assertion)
 422             throws ProfileException {
 423         log.debug("Determining if SAML assertion to relying party {} should be signed", requestContext
 424                 .getInboundMessageIssuer());
 425
 426         boolean signAssertion = false;
 427
 428         AbstractSAML2ProfileConfiguration profileConfig = requestContext.getProfileConfiguration();
 429
 430         if (requestContext.getPeerEntityRoleMetadata() instanceof SPSSODescriptor) {
 431             SPSSODescriptor ssoDescriptor = (SPSSODescriptor) requestContext.getPeerEntityRoleMetadata();
 432             if (ssoDescriptor.getWantAssertionsSigned() != null) {
 433                 signAssertion = ssoDescriptor.getWantAssertionsSigned().booleanValue();
 434                 log.debug("Entity metadata for relying party {} indicates to sign assertions: {}", requestContext
 435                         .getInboundMessageIssuer(), signAssertion);
 436             }
 437         } else if (profileConfig.getSignAssertions()) {
 438             signAssertion = true;
 439             log.debug("IdP relying party configuration {} indicates to sign assertions: {}", requestContext
 440                     .getRelyingPartyConfiguration().getRelyingPartyId(), signAssertion);
 441         }
 442
 443         if (!signAssertion) {
 444             return;
 445         }
 446
 447         log.debug("Determining signing credntial for assertion to relying party {}", requestContext
 448                 .getInboundMessageIssuer());
 449         Credential signatureCredential = profileConfig.getSigningCredential();
 450         if (signatureCredential == null) {
 451             signatureCredential = requestContext.getRelyingPartyConfiguration().getDefaultSigningCredential();
 452         }
 453
 454         if (signatureCredential == null) {
 455             throw new ProfileException("No signing credential is specified for relying party configuration "
 456                     + requestContext.getRelyingPartyConfiguration().getProviderId()
 457                     + " or it's SAML2 attribute query profile configuration");
 458         }
 459
 460         log.debug("Signing assertion to relying party {}", requestContext.getInboundMessageIssuer());
 461         Signature signature = signatureBuilder.buildObject(Signature.DEFAULT_ELEMENT_NAME);
 462
 463         signature.setSigningCredential(signatureCredential);
 464         try {
 465             // TODO pull SecurityConfiguration from SAMLMessageContext? needs to be added
 466             // TODO how to pull what keyInfoGenName to use?
 467             SecurityHelper.prepareSignatureParams(signature, signatureCredential, null, null);
 468         } catch (SecurityException e) {
 469             throw new ProfileException("Error preparing signature for signing", e);
 470         }
 471
 472         assertion.setSignature(signature);
 473
 474         Signer.signObject(signature);
 475     }
 476
 477     /**
 478      * Build a status message, with an optional second-level failure message.
 479      *
 480      * @param topLevelCode The top-level status code. Should be from saml-core-2.0-os, sec. 3.2.2.2
 481      * @param secondLevelCode An optional second-level failure code. Should be from saml-core-2.0-is, sec 3.2.2.2. If
 482      *            null, no second-level Status element will be set.
 483      * @param failureMessage An optional second-level failure message
 484      *
 485      * @return a Status object.
 486      */
 487     protected Status buildStatus(String topLevelCode, String secondLevelCode, String failureMessage) {
 488         Status status = statusBuilder.buildObject();
 489
 490         StatusCode statusCode = statusCodeBuilder.buildObject();
 491         statusCode.setValue(DatatypeHelper.safeTrimOrNullString(topLevelCode));
 492         status.setStatusCode(statusCode);
 493
 494         if (secondLevelCode != null) {
 495             StatusCode secondLevelStatusCode = statusCodeBuilder.buildObject();
 496             secondLevelStatusCode.setValue(DatatypeHelper.safeTrimOrNullString(secondLevelCode));
 497             statusCode.setStatusCode(secondLevelStatusCode);
 498         }
 499
 500         if (failureMessage != null) {
 501             StatusMessage msg = statusMessageBuilder.buildObject();
 502             msg.setMessage(failureMessage);
 503             status.setStatusMessage(msg);
 504         }
 505
 506         return status;
 507     }
 508
 509     /**
 510      * Builds the SAML subject for the user for the service provider.
 511      *
 512      * @param requestContext current request context
 513      * @param confirmationMethod subject confirmation method used for the subject
 514      * @param issueInstant instant the subject confirmation data should reflect for issuance
 515      *
 516      * @return SAML subject for the user for the service provider
 517      *
 518      * @throws ProfileException thrown if a NameID can not be created either because there was a problem encoding the
 519      *             name ID attribute or because there are no supported name formats
 520      */
 521     protected Subject buildSubject(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext, String confirmationMethod,
 522             DateTime issueInstant) throws ProfileException {
 523         NameID nameID = buildNameId(requestContext);
 524         requestContext.setSubjectNameIdentifier(nameID);
 525         // TODO handle encryption
 526
 527         SubjectConfirmationData confirmationData = subjectConfirmationDataBuilder.buildObject();
 528         HTTPInTransport inTransport = (HTTPInTransport) requestContext.getInboundMessageTransport();
 529         confirmationData.setAddress(inTransport.getPeerAddress());
 530         confirmationData.setInResponseTo(requestContext.getInboundSAMLMessageId());
 531         confirmationData.setNotOnOrAfter(issueInstant.plus(requestContext.getProfileConfiguration()
 532                 .getAssertionLifetime()));
 533
 534         Endpoint relyingPartyEndpoint = requestContext.getPeerEntityEndpoint();
 535         if (relyingPartyEndpoint != null) {
 536             if (relyingPartyEndpoint.getResponseLocation() != null) {
 537                 confirmationData.setRecipient(relyingPartyEndpoint.getResponseLocation());
 538             } else {
 539                 confirmationData.setRecipient(relyingPartyEndpoint.getLocation());
 540             }
 541         }
 542
 543         SubjectConfirmation subjectConfirmation = subjectConfirmationBuilder.buildObject();
 544         subjectConfirmation.setMethod(confirmationMethod);
 545         subjectConfirmation.setSubjectConfirmationData(confirmationData);
 546
 547         Subject subject = subjectBuilder.buildObject();
 548         subject.setNameID(nameID);
 549         subject.getSubjectConfirmations().add(subjectConfirmation);
 550
 551         return subject;
 552     }
 553
 554     /**
 555      * Builds a NameID appropriate for this request. NameIDs are built by inspecting the SAML request and metadata,
 556      * picking a name format that was requested by the relying party or is mutually supported by both the relying party
 557      * and asserting party as described in their metadata entries. Once a set of supported name formats is determined
 558      * the principals attributes are inspected for an attribute supported an attribute encoder whose category is one of
 559      * the supported name formats.
 560      *
 561      * @param requestContext current request context
 562      *
 563      * @return the NameID appropriate for this request
 564      *
 565      * @throws ProfileException thrown if a NameID can not be created either because there was a problem encoding the
 566      *             name ID attribute or because there are no supported name formats
 567      */
 568     protected NameID buildNameId(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext) throws ProfileException {
 569         log.debug("Building assertion NameID for principal/relying party:{}/{}", requestContext.getPrincipalName(),
 570                 requestContext.getInboundMessageIssuer());
 571         Map<String, BaseAttribute> principalAttributes = requestContext.getPrincipalAttributes();
 572         List<String> supportedNameFormats = getNameFormats(requestContext);
 573
 574         log.debug("Supported NameID formats: {}", supportedNameFormats);
 575
 576         if (principalAttributes == null || supportedNameFormats == null) {
 577             log.error("No attributes for principal " + requestContext.getPrincipalName()
 578                     + " support constructions of NameID");
 579             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, StatusCode.INVALID_NAMEID_POLICY_URI,
 580                     "Unable to construct NameID"));
 581             throw new ProfileException("No principal attributes support NameID construction");
 582         }
 583
 584         try {
 585             SAML2NameIDAttributeEncoder nameIdEncoder;
 586             for (BaseAttribute<?> attribute : principalAttributes.values()) {
 587                 for (AttributeEncoder encoder : attribute.getEncoders()) {
 588                     if (encoder instanceof SAML2NameIDAttributeEncoder) {
 589                         nameIdEncoder = (SAML2NameIDAttributeEncoder) encoder;
 590                         if (supportedNameFormats.contains(nameIdEncoder.getNameFormat())) {
 591                             log.debug("Using attribute {} suppoting NameID format {} to create the NameID for principal.{}",
 592                                             attribute.getId(), nameIdEncoder.getNameFormat());
 593                             return nameIdEncoder.encode(attribute);
 594                         }
 595                     }
 596                 }
 597             }
 598             log.error("No principal attribute supported encoding into a supported name ID format.");
 599             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Unable to construct NameID"));
 600             throw new ProfileException("No principal attribute supported encoding into a supported name ID format.");
 601         } catch (AttributeEncodingException e) {
 602             log.error("Unable to encode NameID attribute", e);
 603             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Unable to construct NameID"));
 604             throw new ProfileException("Unable to encode NameID attribute", e);
 605         }
 606     }
 607
 608     /**
 609      * Gets the NameID format to use when creating NameIDs for the relying party.
 610      *
 611      * @param requestContext current request context
 612      *
 613      * @return list of nameID formats that may be used with the relying party
 614      *
 615      * @throws ProfileException thrown if there is a problem determing the NameID format to use
 616      */
 617     protected List<String> getNameFormats(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext)
 618             throws ProfileException {
 619         ArrayList<String> nameFormats = new ArrayList<String>();
 620
 621         // Determine name formats supported by both SP and IdP
 622         RoleDescriptor relyingPartyRole = requestContext.getPeerEntityRoleMetadata();
 623         if(relyingPartyRole != null){
 624             List<String> relyingPartySupportedFormats = getEntitySupportedFormats(relyingPartyRole);
 625             if(relyingPartySupportedFormats != null && !relyingPartySupportedFormats.isEmpty()){
 626                 nameFormats.addAll(relyingPartySupportedFormats);
 627
 628                 RoleDescriptor assertingPartyRole = requestContext.getLocalEntityRoleMetadata();
 629                 if(assertingPartyRole != null){
 630                     List<String> assertingPartySupportedFormats = getEntitySupportedFormats(assertingPartyRole);
 631                     if(assertingPartySupportedFormats != null && !assertingPartySupportedFormats.isEmpty()){
 632                         nameFormats.retainAll(assertingPartySupportedFormats);
 633                     }
 634                 }
 635             }
 636         }
 637
 638         if (nameFormats.isEmpty()) {
 639             nameFormats.add("urn:oasis:names:tc:SAML:2.0:nameid-format:unspecified");
 640         }
 641
 642         // If authn request and name ID policy format specified, make sure it's in the list of supported formats
 643         String nameFormat = null;
 644         if (requestContext.getInboundSAMLMessage() instanceof AuthnRequest) {
 645             AuthnRequest authnRequest = (AuthnRequest) requestContext.getInboundSAMLMessage();
 646             if (authnRequest.getNameIDPolicy() != null) {
 647                 nameFormat = DatatypeHelper.safeTrimOrNullString(authnRequest.getNameIDPolicy().getFormat());
 648                 if(nameFormat != null && nameFormats.contains(nameFormat)){
 649                     nameFormats.clear();
 650                     nameFormats.add(nameFormat);
 651                 } else {
 652                     requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI,
 653                             StatusCode.INVALID_NAMEID_POLICY_URI, "Format not supported: " + nameFormat));
 654                     throw new ProfileException("NameID format required by relying party is not supported");
 655                 }
 656             }
 657         }
 658
 659         return nameFormats;
 660     }
 661
 662     /**
 663      * Gets the list of NameID formats supported for a given role.
 664      *
 665      * @param role the role to get the list of supported NameID formats
 666      *
 667      * @return list of supported NameID formats
 668      */
 669     protected List<String> getEntitySupportedFormats(RoleDescriptor role) {
 670         List<NameIDFormat> nameIDFormats = null;
 671
 672         if (role instanceof SSODescriptor) {
 673             nameIDFormats = ((SSODescriptor) role).getNameIDFormats();
 674         } else if (role instanceof AuthnAuthorityDescriptor) {
 675             nameIDFormats = ((AuthnAuthorityDescriptor) role).getNameIDFormats();
 676         } else if (role instanceof PDPDescriptor) {
 677             nameIDFormats = ((PDPDescriptor) role).getNameIDFormats();
 678         } else if (role instanceof AttributeAuthorityDescriptor) {
 679             nameIDFormats = ((AttributeAuthorityDescriptor) role).getNameIDFormats();
 680         }
 681
 682         ArrayList<String> supportedFormats = new ArrayList<String>();
 683         if (nameIDFormats != null) {
 684             for (NameIDFormat format : nameIDFormats) {
 685                 supportedFormats.add(format.getFormat());
 686             }
 687         }
 688
 689         return supportedFormats;
 690     }
 691
 692     /**
 693      * Constructs an SAML response message carrying a request error.
 694      *
 695      * @param requestContext current request context
 696      *
 697      * @return the constructed error response
 698      */
 699     protected Response buildErrorResponse(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext) {
 700         Response samlResponse = responseBuilder.buildObject();
 701         samlResponse.setIssueInstant(new DateTime());
 702         populateStatusResponse(requestContext, samlResponse);
 703
 704         samlResponse.setStatus(requestContext.getFailureStatus());
 705
 706         return samlResponse;
 707     }
 708 }