package edu.internet2.middleware.shibboleth.idp.profile.saml2;
+import java.util.ArrayList;
+import java.util.Collection;
import java.util.List;
+import java.util.Map;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import org.apache.log4j.Logger;
import org.joda.time.DateTime;
-import org.opensaml.Configuration;
-import org.opensaml.common.IdentifierGenerator;
-import org.opensaml.common.SAMLObject;
+import org.opensaml.common.SAMLObjectBuilder;
import org.opensaml.common.SAMLVersion;
-import org.opensaml.common.binding.BindingException;
-import org.opensaml.common.binding.MessageDecoder;
-import org.opensaml.common.binding.MessageEncoder;
-import org.opensaml.common.impl.SecureRandomIdentifierGenerator;
+import org.opensaml.common.impl.SAMLObjectContentReference;
+import org.opensaml.log.Level;
import org.opensaml.saml2.core.Assertion;
+import org.opensaml.saml2.core.AttributeQuery;
+import org.opensaml.saml2.core.AttributeStatement;
import org.opensaml.saml2.core.Audience;
import org.opensaml.saml2.core.AudienceRestriction;
+import org.opensaml.saml2.core.AuthnRequest;
import org.opensaml.saml2.core.Conditions;
import org.opensaml.saml2.core.Issuer;
+import org.opensaml.saml2.core.NameID;
+import org.opensaml.saml2.core.ProxyRestriction;
+import org.opensaml.saml2.core.RequestAbstractType;
import org.opensaml.saml2.core.Response;
+import org.opensaml.saml2.core.Statement;
import org.opensaml.saml2.core.Status;
import org.opensaml.saml2.core.StatusCode;
import org.opensaml.saml2.core.StatusMessage;
+import org.opensaml.saml2.core.StatusResponseType;
import org.opensaml.saml2.core.Subject;
+import org.opensaml.saml2.core.SubjectConfirmation;
+import org.opensaml.saml2.metadata.AttributeAuthorityDescriptor;
+import org.opensaml.saml2.metadata.AuthnAuthorityDescriptor;
+import org.opensaml.saml2.metadata.NameIDFormat;
+import org.opensaml.saml2.metadata.PDPDescriptor;
+import org.opensaml.saml2.metadata.RoleDescriptor;
+import org.opensaml.saml2.metadata.SPSSODescriptor;
+import org.opensaml.saml2.metadata.SSODescriptor;
import org.opensaml.xml.XMLObjectBuilder;
-import org.opensaml.xml.XMLObjectBuilderFactory;
-
+import org.opensaml.xml.security.credential.Credential;
+import org.opensaml.xml.signature.Signature;
+import org.opensaml.xml.signature.Signer;
+import org.opensaml.xml.util.DatatypeHelper;
+
+import edu.internet2.middleware.shibboleth.common.attribute.AttributeRequestException;
+import edu.internet2.middleware.shibboleth.common.attribute.BaseAttribute;
+import edu.internet2.middleware.shibboleth.common.attribute.encoding.AttributeEncoder;
+import edu.internet2.middleware.shibboleth.common.attribute.encoding.AttributeEncodingException;
+import edu.internet2.middleware.shibboleth.common.attribute.encoding.SAML2NameIDAttributeEncoder;
+import edu.internet2.middleware.shibboleth.common.attribute.provider.SAML2AttributeAuthority;
+import edu.internet2.middleware.shibboleth.common.attribute.provider.ShibbolethSAMLAttributeRequestContext;
+import edu.internet2.middleware.shibboleth.common.log.AuditLogEntry;
+import edu.internet2.middleware.shibboleth.common.profile.ProfileException;
+import edu.internet2.middleware.shibboleth.common.profile.ProfileRequest;
+import edu.internet2.middleware.shibboleth.common.profile.ProfileResponse;
+import edu.internet2.middleware.shibboleth.common.relyingparty.provider.saml2.AbstractSAML2ProfileConfiguration;
import edu.internet2.middleware.shibboleth.idp.profile.AbstractSAMLProfileHandler;
+import edu.internet2.middleware.shibboleth.idp.session.ServiceInformation;
+import edu.internet2.middleware.shibboleth.idp.session.Session;
-/**
- * Common implementation details for profile handlers.
- */
+/** Common implementation details for profile handlers. */
public abstract class AbstractSAML2ProfileHandler extends AbstractSAMLProfileHandler {
/** SAML Version for this profile handler. */
public static final SAMLVersion SAML_VERSION = SAMLVersion.VERSION_20;
/** Class logger. */
- private static Logger log = Logger.getLogger(AbstractSAML2ProfileHandler.class);
+ private Logger log = Logger.getLogger(AbstractSAML2ProfileHandler.class);
+
+ /** For building response. */
+ private SAMLObjectBuilder<Response> responseBuilder;
+
+ /** For building status. */
+ private SAMLObjectBuilder<Status> statusBuilder;
+
+ /** For building statuscode. */
+ private SAMLObjectBuilder<StatusCode> statusCodeBuilder;
+
+ /** For building StatusMessages. */
+ private SAMLObjectBuilder<StatusMessage> statusMessageBuilder;
+
+ /** For building assertion. */
+ private SAMLObjectBuilder<Assertion> assertionBuilder;
+
+ /** For building issuer. */
+ private SAMLObjectBuilder<Issuer> issuerBuilder;
+
+ /** For building subject. */
+ private SAMLObjectBuilder<Subject> subjectBuilder;
+
+ /** For builder subject confirmation. */
+ private SAMLObjectBuilder<SubjectConfirmation> subjectConfirmationBuilder;
+
+ /** For building conditions. */
+ private SAMLObjectBuilder<Conditions> conditionsBuilder;
+
+ /** For building audience restriction. */
+ private SAMLObjectBuilder<AudienceRestriction> audienceRestrictionBuilder;
+
+ /** For building proxy retrictions. */
+ private SAMLObjectBuilder<ProxyRestriction> proxyRestrictionBuilder;
+
+ /** For building audience. */
+ private SAMLObjectBuilder<Audience> audienceBuilder;
+
+ /** For building signature. */
+ private XMLObjectBuilder<Signature> signatureBuilder;
+
+ /** Constructor. */
+ @SuppressWarnings("unchecked")
+ protected AbstractSAML2ProfileHandler() {
+ super();
+
+ responseBuilder = (SAMLObjectBuilder<Response>) getBuilderFactory().getBuilder(Response.DEFAULT_ELEMENT_NAME);
+ statusBuilder = (SAMLObjectBuilder<Status>) getBuilderFactory().getBuilder(Status.DEFAULT_ELEMENT_NAME);
+ statusCodeBuilder = (SAMLObjectBuilder<StatusCode>) getBuilderFactory().getBuilder(
+ StatusCode.DEFAULT_ELEMENT_NAME);
+ statusMessageBuilder = (SAMLObjectBuilder<StatusMessage>) getBuilderFactory().getBuilder(
+ StatusMessage.DEFAULT_ELEMENT_NAME);
+ issuerBuilder = (SAMLObjectBuilder<Issuer>) getBuilderFactory().getBuilder(Issuer.DEFAULT_ELEMENT_NAME);
+ assertionBuilder = (SAMLObjectBuilder<Assertion>) getBuilderFactory()
+ .getBuilder(Assertion.DEFAULT_ELEMENT_NAME);
+ subjectBuilder = (SAMLObjectBuilder<Subject>) getBuilderFactory().getBuilder(Subject.DEFAULT_ELEMENT_NAME);
+ subjectConfirmationBuilder = (SAMLObjectBuilder<SubjectConfirmation>) getBuilderFactory().getBuilder(
+ SubjectConfirmation.DEFAULT_ELEMENT_NAME);
+ conditionsBuilder = (SAMLObjectBuilder<Conditions>) getBuilderFactory().getBuilder(
+ Conditions.DEFAULT_ELEMENT_NAME);
+ audienceRestrictionBuilder = (SAMLObjectBuilder<AudienceRestriction>) getBuilderFactory().getBuilder(
+ AudienceRestriction.DEFAULT_ELEMENT_NAME);
+ proxyRestrictionBuilder = (SAMLObjectBuilder<ProxyRestriction>) getBuilderFactory().getBuilder(
+ ProxyRestriction.DEFAULT_ELEMENT_NAME);
+ audienceBuilder = (SAMLObjectBuilder<Audience>) getBuilderFactory().getBuilder(Audience.DEFAULT_ELEMENT_NAME);
+ signatureBuilder = (XMLObjectBuilder<Signature>) getBuilderFactory().getBuilder(Signature.DEFAULT_ELEMENT_NAME);
+ }
- /** For building XML. */
- private XMLObjectBuilderFactory builderFactory;
+ /**
+ * Checks that the SAML major version for a request is 2.
+ *
+ * @param requestContext current request context containing the SAML message
+ *
+ * @throws ProfileException thrown if the major version of the SAML request is not 2
+ */
+ protected void checkSamlVersion(SAML2ProfileRequestContext requestContext) throws ProfileException {
+ SAMLVersion version = requestContext.getSamlRequest().getVersion();
+ if (version.getMajorVersion() < 2) {
+ requestContext.setFailureStatus(buildStatus(StatusCode.VERSION_MISMATCH_URI,
+ StatusCode.REQUEST_VERSION_TOO_LOW_URI, null));
+ throw new ProfileException("SAML request version too low");
+ } else if (version.getMajorVersion() > 2) {
+ requestContext.setFailureStatus(buildStatus(StatusCode.VERSION_MISMATCH_URI,
+ StatusCode.REQUEST_VERSION_TOO_HIGH_URI, null));
+ throw new ProfileException("SAML request version too high");
+ }
+ }
- /** For generating random ids. */
- private IdentifierGenerator idGenerator;
+ /**
+ * Builds a response to the attribute query within the request context.
+ *
+ * @param requestContext current request context
+ * @param assertionSubject subject of the assertion within the response
+ * @param statements the statements to include in the response
+ *
+ * @return the built response
+ *
+ * @throws ProfileException thrown if there is a problem creating the SAML response
+ */
+ protected Response buildResponse(SAML2ProfileRequestContext requestContext, Subject assertionSubject,
+ List<Statement> statements) throws ProfileException {
+
+ DateTime issueInstant = new DateTime();
- /** Builder for Response elements. */
- protected XMLObjectBuilder responseBuilder;
+ // create the assertion and add the attribute statement
+ Assertion assertion = buildAssertion(requestContext, issueInstant);
+ assertion.setSubject(assertionSubject);
+ if (statements != null) {
+ assertion.getStatements().addAll(statements);
+ }
+
+ // create the SAML response and add the assertion
+ Response samlResponse = responseBuilder.buildObject();
+ samlResponse.setIssueInstant(issueInstant);
+ populateStatusResponse(requestContext, samlResponse);
- /** Builder for Status elements. */
- private XMLObjectBuilder statusBuilder;
+ samlResponse.getAssertions().add(assertion);
- /** Builder for StatusCode elements. */
- private XMLObjectBuilder statusCodeBuilder;
+ // sign the assertion if it should be signed
+ signAssertion(requestContext, assertion);
- /** Builder for StatusMessage elements. */
- private XMLObjectBuilder statusMessageBuilder;
+ Status status = buildStatus(StatusCode.SUCCESS_URI, null, null);
+ samlResponse.setStatus(status);
- /** Builder for Issuer elements. */
- protected XMLObjectBuilder issuerBuilder;
+ return samlResponse;
+ }
/**
- * Default constructor.
+ * Builds a basic assertion with its id, issue instant, SAML version, issuer, subject, and conditions populated.
+ *
+ * @param requestContext current request context
+ * @param issueInstant time to use as assertion issue instant
+ *
+ * @return the built assertion
*/
- public AbstractSAML2ProfileHandler() {
- builderFactory = Configuration.getBuilderFactory();
- idGenerator = new SecureRandomIdentifierGenerator();
+ protected Assertion buildAssertion(SAML2ProfileRequestContext requestContext, DateTime issueInstant) {
+ Assertion assertion = assertionBuilder.buildObject();
+ assertion.setID(getIdGenerator().generateIdentifier());
+ assertion.setIssueInstant(issueInstant);
+ assertion.setVersion(SAMLVersion.VERSION_20);
+ assertion.setIssuer(buildEntityIssuer(requestContext));
+
+ Conditions conditions = buildConditions(requestContext, issueInstant);
+ assertion.setConditions(conditions);
- responseBuilder = builderFactory.getBuilder(Response.DEFAULT_ELEMENT_NAME);
- statusBuilder = builderFactory.getBuilder(Status.DEFAULT_ELEMENT_NAME);
- statusCodeBuilder = builderFactory.getBuilder(StatusCode.DEFAULT_ELEMENT_NAME);
- statusMessageBuilder = builderFactory.getBuilder(StatusMessage.DEFAULT_ELEMENT_NAME);
- issuerBuilder = builderFactory.getBuilder(Issuer.DEFAULT_ELEMENT_NAME);
+ return assertion;
}
/**
- * Returns the XML builder factory.
+ * Creates an {@link Issuer} populated with information about the relying party.
+ *
+ * @param requestContext current request context
*
- * @return Returns the builderFactory.
+ * @return the built issuer
*/
- public XMLObjectBuilderFactory getBuilderFactory() {
- return builderFactory;
+ protected Issuer buildEntityIssuer(SAML2ProfileRequestContext requestContext) {
+ Issuer issuer = issuerBuilder.buildObject();
+ issuer.setFormat(Issuer.ENTITY);
+ issuer.setValue(requestContext.getAssertingPartyId());
+
+ return issuer;
+ }
+
+ /**
+ * Builds a SAML assertion condition set. The following fields are set; not before, not on or after, audience
+ * restrictions, and proxy restrictions.
+ *
+ * @param requestContext current request context
+ * @param issueInstant timestamp the assertion was created
+ *
+ * @return constructed conditions
+ */
+ protected Conditions buildConditions(SAML2ProfileRequestContext requestContext, DateTime issueInstant) {
+ AbstractSAML2ProfileConfiguration profileConfig = requestContext.getProfileConfiguration();
+
+ Conditions conditions = conditionsBuilder.buildObject();
+ conditions.setNotBefore(issueInstant);
+ conditions.setNotOnOrAfter(issueInstant.plus(profileConfig.getAssertionLifetime()));
+
+ Collection<String> audiences;
+
+ // add audience restrictions
+ audiences = profileConfig.getAssertionAudiences();
+ if (audiences != null && audiences.size() > 0) {
+ AudienceRestriction audienceRestriction = audienceRestrictionBuilder.buildObject();
+ for (String audienceUri : audiences) {
+ Audience audience = audienceBuilder.buildObject();
+ audience.setAudienceURI(audienceUri);
+ audienceRestriction.getAudiences().add(audience);
+ }
+ conditions.getAudienceRestrictions().add(audienceRestriction);
+ }
+
+ // add proxy restrictions
+ audiences = profileConfig.getProxyAudiences();
+ if (audiences != null && audiences.size() > 0) {
+ ProxyRestriction proxyRestriction = proxyRestrictionBuilder.buildObject();
+ Audience audience;
+ for (String audienceUri : audiences) {
+ audience = audienceBuilder.buildObject();
+ audience.setAudienceURI(audienceUri);
+ proxyRestriction.getAudiences().add(audience);
+ }
+
+ proxyRestriction.setProxyCount(profileConfig.getProxyCount());
+ conditions.getConditions().add(proxyRestriction);
+ }
+
+ return conditions;
}
/**
- * Returns the id generator.
+ * Populates the response's id, in response to, issue instant, version, and issuer properties.
*
- * @return Returns the idGenerator.
+ * @param requestContext current request context
+ * @param response the response to populate
*/
- public IdentifierGenerator getIdGenerator() {
- return idGenerator;
+ protected void populateStatusResponse(SAML2ProfileRequestContext requestContext, StatusResponseType response) {
+ response.setID(getIdGenerator().generateIdentifier());
+ if (requestContext.getSamlRequest() != null) {
+ response.setInResponseTo(requestContext.getSamlRequest().getID());
+ }
+ response.setVersion(SAMLVersion.VERSION_20);
+ response.setIssuer(buildEntityIssuer(requestContext));
+ }
+
+ /**
+ * Executes a query for attributes and builds a SAML attribute statement from the results.
+ *
+ * @param requestContext current request context
+ *
+ * @return attribute statement resulting from the query
+ *
+ * @throws ProfileException thrown if there is a problem making the query
+ */
+ protected AttributeStatement buildAttributeStatement(SAML2ProfileRequestContext requestContext)
+ throws ProfileException {
+
+ if (log.isDebugEnabled()) {
+ log.debug("Creating attribute statement in response to SAML request "
+ + requestContext.getSamlRequest().getID() + " from relying party "
+ + requestContext.getRelyingPartyId());
+ }
+
+ AbstractSAML2ProfileConfiguration profileConfiguration = requestContext.getProfileConfiguration();
+ SAML2AttributeAuthority attributeAuthority = profileConfiguration.getAttributeAuthority();
+
+ try {
+ if (log.isDebugEnabled()) {
+ log.debug("Resolving attributes for principal " + requestContext.getPrincipalName()
+ + " of SAML request " + requestContext.getSamlRequest().getID() + " from relying party "
+ + requestContext.getRelyingPartyId());
+ }
+ Map<String, BaseAttribute> principalAttributes = attributeAuthority
+ .getAttributes(buildAttributeRequestContext(requestContext));
+
+ requestContext.setPrincipalAttributes(principalAttributes);
+
+ if (requestContext.getSamlRequest() instanceof AttributeQuery) {
+ return attributeAuthority.buildAttributeStatement((AttributeQuery) requestContext.getSamlRequest(),
+ principalAttributes.values());
+ } else {
+ return attributeAuthority.buildAttributeStatement(null, principalAttributes.values());
+ }
+ } catch (AttributeRequestException e) {
+ log.error("Error resolving attributes for SAML request " + requestContext.getSamlRequest().getID()
+ + " from relying party " + requestContext.getRelyingPartyId(), e);
+ requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Error resolving attributes"));
+ throw new ProfileException("Error resolving attributes for SAML request "
+ + requestContext.getSamlRequest().getID() + " from relying party "
+ + requestContext.getRelyingPartyId(), e);
+ }
+ }
+
+ /**
+ * Resolves the principal name of the subject of the request.
+ *
+ * @param requestContext current request context
+ *
+ * @throws ProfileException thrown if the principal name can not be resolved
+ */
+ protected void resolvePrincipal(SAML2ProfileRequestContext requestContext) throws ProfileException {
+ AbstractSAML2ProfileConfiguration profileConfiguration = requestContext.getProfileConfiguration();
+ if (profileConfiguration == null) {
+ log.error("Unable to resolve principal, no SAML 2 profile configuration for relying party "
+ + requestContext.getRelyingPartyId());
+ requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, StatusCode.REQUEST_DENIED_URI,
+ "Error resolving principal"));
+ throw new ProfileException(
+ "Unable to resolve principal, no SAML 2 profile configuration for relying party "
+ + requestContext.getRelyingPartyId());
+ }
+ SAML2AttributeAuthority attributeAuthority = profileConfiguration.getAttributeAuthority();
+
+ if (log.isDebugEnabled()) {
+ log.debug("Resolving principal name for subject of SAML request " + requestContext.getSamlRequest().getID()
+ + " from relying party " + requestContext.getRelyingPartyId());
+ }
+
+ try {
+ String principal = attributeAuthority.getPrincipal(buildAttributeRequestContext(requestContext));
+ requestContext.setPrincipalName(principal);
+ } catch (AttributeRequestException e) {
+ log.error("Error resolving attributes for SAML request " + requestContext.getSamlRequest().getID()
+ + " from relying party " + requestContext.getRelyingPartyId(), e);
+ requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, StatusCode.UNKNOWN_PRINCIPAL_URI,
+ "Error resolving principal"));
+ throw new ProfileException("Error resolving attributes for SAML request "
+ + requestContext.getSamlRequest().getID() + " from relying party "
+ + requestContext.getRelyingPartyId(), e);
+ }
+ }
+
+ /**
+ * Creates an attribute query context from the current profile request context.
+ *
+ * @param requestContext current profile request
+ *
+ * @return created query context
+ */
+ protected ShibbolethSAMLAttributeRequestContext<NameID, AttributeQuery> buildAttributeRequestContext(
+ SAML2ProfileRequestContext requestContext) {
+
+ ShibbolethSAMLAttributeRequestContext<NameID, AttributeQuery> queryContext;
+
+ if(requestContext.getSamlRequest() instanceof AttributeQuery){
+ queryContext = new ShibbolethSAMLAttributeRequestContext<NameID, AttributeQuery>(getMetadataProvider(),
+ requestContext.getRelyingPartyConfiguration(), (AttributeQuery) requestContext.getSamlRequest());
+ }else{
+ queryContext = new ShibbolethSAMLAttributeRequestContext<NameID, AttributeQuery>(getMetadataProvider(),
+ requestContext.getRelyingPartyConfiguration(), null);
+ }
+ queryContext.setAttributeRequester(requestContext.getAssertingPartyId());
+ queryContext.setPrincipalName(requestContext.getPrincipalName());
+ queryContext.setProfileConfiguration(requestContext.getProfileConfiguration());
+ queryContext.setRequest(requestContext.getProfileRequest());
+
+ Session userSession = getSessionManager().getSession(getUserSessionId(requestContext.getProfileRequest()));
+ if (userSession != null) {
+ queryContext.setUserSession(userSession);
+ ServiceInformation serviceInfo = userSession.getServicesInformation().get(
+ requestContext.getRelyingPartyId());
+ if (serviceInfo != null) {
+ String principalAuthenticationMethod = serviceInfo.getAuthenticationMethod().getAuthenticationMethod();
+
+ requestContext.setPrincipalAuthenticationMethod(principalAuthenticationMethod);
+ queryContext.setPrincipalAuthenticationMethod(principalAuthenticationMethod);
+ }
+ }
+
+ return queryContext;
+ }
+
+ /**
+ * Signs the given assertion if either the current profile configuration or the relying party configuration contains
+ * signing credentials.
+ *
+ * @param requestContext current request context
+ * @param assertion assertion to sign
+ *
+ * @throws ProfileException thrown if the metadata can not be located for the relying party or, if signing is
+ * required, if a signing credential is not configured
+ */
+ protected void signAssertion(SAML2ProfileRequestContext requestContext, Assertion assertion)
+ throws ProfileException {
+ if (log.isDebugEnabled()) {
+ log.debug("Determining if SAML assertion to relying party " + requestContext.getRelyingPartyId()
+ + " should be signed");
+ }
+
+ boolean signAssertion = false;
+
+ AbstractSAML2ProfileConfiguration profileConfig = requestContext.getProfileConfiguration();
+
+ if (requestContext.getRelyingPartyRoleMetadata() instanceof SPSSODescriptor) {
+ SPSSODescriptor ssoDescriptor = (SPSSODescriptor) requestContext.getRelyingPartyRoleMetadata();
+ if (ssoDescriptor.getWantAssertionsSigned() != null) {
+ signAssertion = ssoDescriptor.getWantAssertionsSigned().booleanValue();
+ if (log.isDebugEnabled()) {
+ log.debug("Entity metadata for relying party " + requestContext.getRelyingPartyId()
+ + " indicates to sign assertions: " + signAssertion);
+ }
+ }
+ } else if (profileConfig.getSignAssertions()) {
+ signAssertion = true;
+ log.debug("IdP relying party configuration "
+ + requestContext.getRelyingPartyConfiguration().getRelyingPartyId()
+ + " indicates to sign assertions: " + signAssertion);
+ }
+
+ if (!signAssertion) {
+ return;
+ }
+
+ if (log.isDebugEnabled()) {
+ log.debug("Determining signing credntial for assertion to relying party "
+ + requestContext.getRelyingPartyId());
+ }
+ Credential signatureCredential = profileConfig.getSigningCredential();
+ if (signatureCredential == null) {
+ signatureCredential = requestContext.getRelyingPartyConfiguration().getDefaultSigningCredential();
+ }
+
+ if (signatureCredential == null) {
+ throw new ProfileException("No signing credential is specified for relying party configuration "
+ + requestContext.getRelyingPartyConfiguration().getProviderId()
+ + " or it's SAML2 attribute query profile configuration");
+ }
+
+ if (log.isDebugEnabled()) {
+ log.debug("Signing assertion to relying party " + requestContext.getRelyingPartyId());
+ }
+ SAMLObjectContentReference contentRef = new SAMLObjectContentReference(assertion);
+ Signature signature = signatureBuilder.buildObject(Signature.DEFAULT_ELEMENT_NAME);
+ signature.getContentReferences().add(contentRef);
+ assertion.setSignature(signature);
+
+ Signer.signObject(signature);
}
/**
* @param topLevelCode The top-level status code. Should be from saml-core-2.0-os, sec. 3.2.2.2
* @param secondLevelCode An optional second-level failure code. Should be from saml-core-2.0-is, sec 3.2.2.2. If
* null, no second-level Status element will be set.
- * @param secondLevelFailureMessage An optional second-level failure message.
+ * @param failureMessage An optional second-level failure message
*
* @return a Status object.
*/
- protected Status buildStatus(String topLevelCode, String secondLevelCode, String secondLevelFailureMessage) {
+ protected Status buildStatus(String topLevelCode, String secondLevelCode, String failureMessage) {
+ Status status = statusBuilder.buildObject();
- Status status = (Status) statusBuilder.buildObject(Status.DEFAULT_ELEMENT_NAME);
- StatusCode statusCode = (StatusCode) statusCodeBuilder.buildObject(StatusCode.DEFAULT_ELEMENT_NAME);
+ StatusCode statusCode = statusCodeBuilder.buildObject();
+ statusCode.setValue(DatatypeHelper.safeTrimOrNullString(topLevelCode));
+ status.setStatusCode(statusCode);
- statusCode.setValue(topLevelCode);
if (secondLevelCode != null) {
- StatusCode secondLevelStatusCode = (StatusCode) statusCodeBuilder
- .buildObject(StatusCode.DEFAULT_ELEMENT_NAME);
- secondLevelStatusCode.setValue(secondLevelCode);
+ StatusCode secondLevelStatusCode = statusCodeBuilder.buildObject();
+ secondLevelStatusCode.setValue(DatatypeHelper.safeTrimOrNullString(secondLevelCode));
statusCode.setStatusCode(secondLevelStatusCode);
}
- if (secondLevelFailureMessage != null) {
- StatusMessage msg = (StatusMessage) statusMessageBuilder.buildObject(StatusMessage.DEFAULT_ELEMENT_NAME);
- msg.setMessage(secondLevelFailureMessage);
- status.setMessage(msg);
+ if (failureMessage != null) {
+ StatusMessage msg = statusMessageBuilder.buildObject();
+ msg.setMessage(failureMessage);
+ status.setStatusMessage(msg);
}
return status;
}
/**
- * Build a SAML 2 Response element with basic fields populated.
+ * Builds the SAML subject for the user for the service provider.
*
- * Failure handlers can send the returned response element to the RP. Success handlers should add the assertions
- * before sending it.
+ * @param requestContext current request context
+ * @param confirmationMethod subject confirmation method used for the subject
*
- * @param inResponseTo The ID of the request this is in response to.
- * @param issuer The URI of the RP issuing the response.
- * @param status The response's status code.
+ * @return SAML subject for the user for the service provider
*
- * @return The populated Response object.
+ * @throws ProfileException thrown if a NameID can not be created either because there was a problem encoding the
+ * name ID attribute or because there are no supported name formats
*/
- protected Response buildResponse(String inResponseTo, String issuer, final Status status) {
+ protected Subject buildSubject(SAML2ProfileRequestContext requestContext, String confirmationMethod)
+ throws ProfileException {
+ NameID nameID = buildNameId(requestContext);
+ requestContext.setSubjectNameID(nameID);
+ // TODO handle encryption
- Response response = (Response) responseBuilder.buildObject(Response.DEFAULT_ELEMENT_NAME);
+ SubjectConfirmation subjectConfirmation = subjectConfirmationBuilder.buildObject();
+ subjectConfirmation.setMethod(confirmationMethod);
- Issuer i = (Issuer) issuerBuilder.buildObject(Issuer.DEFAULT_ELEMENT_NAME);
- i.setValue(issuer);
+ Subject subject = subjectBuilder.buildObject();
+ subject.setNameID(nameID);
+ subject.getSubjectConfirmations().add(subjectConfirmation);
- response.setVersion(SAML_VERSION);
- response.setId(getIdGenerator().generateIdentifier());
- response.setInResponseto(inResponseTo);
- response.setIssueInstance(new DateTime());
- response.setIssuer(i);
- response.setStatus(status);
-
- return response;
+ return subject;
}
- protected Assertion buildAssertion(final Subject subject, final Conditions conditions, String issuer,
- final String[] audiences) {
+ /**
+ * Builds a NameID appropriate for this request. NameIDs are built by inspecting the SAML request and metadata,
+ * picking a name format that was requested by the relying party or is mutually supported by both the relying party
+ * and asserting party as described in their metadata entries. Once a set of supported name formats is determined
+ * the principals attributes are inspected for an attribute supported an attribute encoder whose category is one of
+ * the supported name formats.
+ *
+ * @param requestContext current request context
+ *
+ * @return the NameID appropriate for this request
+ *
+ * @throws ProfileException thrown if a NameID can not be created either because there was a problem encoding the
+ * name ID attribute or because there are no supported name formats
+ */
+ protected NameID buildNameId(SAML2ProfileRequestContext requestContext) throws ProfileException {
+ if (log.isDebugEnabled()) {
+ log.debug("Building assertion NameID for principal/relying party:" + requestContext.getPrincipalName()
+ + "/" + requestContext.getRelyingPartyId());
+ }
+ Map<String, BaseAttribute> principalAttributes = requestContext.getPrincipalAttributes();
+ List<String> supportedNameFormats = getNameFormats(requestContext);
- Assertion assertion = (Assertion) assertionBuilder.buildObject(Assertion.DEFAULT_ELEMENT_NAME);
- assertion.setID(getIdGenerator().generateIdentifier());
- assertion.setVersion(SAML_VERSION);
- assertion.setIssueInstant(new DateTime());
- assertion.setConditions(conditions);
- assertion.setSubject(subject);
+ if (log.isDebugEnabled()) {
+ log.debug("Supported NameID formats: " + supportedNameFormats);
+ }
- Issuer i = (Issuer) issuerBuilder.buildObject(Issuer.DEFAULT_ELEMENT_NAME);
- i.setValue(issuer);
- assertion.setIssuer(i);
+ if (principalAttributes == null || supportedNameFormats == null) {
+ log.error("No attributes for principal " + requestContext.getPrincipalName()
+ + " support constructions of NameID");
+ requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, StatusCode.INVALID_NAMEID_POLICY_URI,
+ "Unable to construct NameID"));
+ throw new ProfileException("No principal attributes support NameID construction");
+ }
- // if audiences were specified, set an AudienceRestriction condition
- if (audiences != null && audiences.length > 0) {
+ try {
+ SAML2NameIDAttributeEncoder nameIdEncoder;
+ for (BaseAttribute<?> attribute : principalAttributes.values()) {
+ for (AttributeEncoder encoder : attribute.getEncoders()) {
+ if (encoder instanceof SAML2NameIDAttributeEncoder) {
+ nameIdEncoder = (SAML2NameIDAttributeEncoder) encoder;
+ if (supportedNameFormats.contains(nameIdEncoder.getNameFormat())) {
+ if (log.isDebugEnabled()) {
+ log.debug("Using attribute " + attribute.getId() + " suppoting NameID format "
+ + nameIdEncoder.getNameFormat() + " to create the NameID for principal "
+ + requestContext.getPrincipalName());
+ }
+ return nameIdEncoder.encode(attribute);
+ }
+ }
+ }
+ }
+ requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Unable to construct NameID"));
+ throw new ProfileException("No principal attribute supported encoding into the a supported name ID format.");
+ } catch (AttributeEncodingException e) {
+ requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Unable to construct NameID"));
+ throw new ProfileException("Unable to encode NameID attribute", e);
+ }
+ }
+
+ /**
+ * Gets the NameID format to use when creating NameIDs for the relying party.
+ *
+ * @param requestContext current request context
+ *
+ * @return list of nameID formats that may be used with the relying party
+ *
+ * @throws ProfileException thrown if there is a problem determing the NameID format to use
+ */
+ protected List<String> getNameFormats(SAML2ProfileRequestContext requestContext) throws ProfileException {
+ ArrayList<String> nameFormats = new ArrayList<String>();
+
+ List<String> assertingPartySupportedFormats = getEntitySupportedFormats(requestContext
+ .getAssertingPartyRoleMetadata());
+
+ String nameFormat = null;
+ if (requestContext.getSamlRequest() instanceof AuthnRequest) {
+ AuthnRequest authnRequest = (AuthnRequest) requestContext.getSamlRequest();
+ if (authnRequest.getNameIDPolicy() != null && !DatatypeHelper.isEmpty(nameFormat)) {
+ nameFormat = authnRequest.getNameIDPolicy().getFormat();
+ if (assertingPartySupportedFormats.contains(nameFormat)) {
+ nameFormats.add(nameFormat);
+ } else {
+ requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI,
+ StatusCode.INVALID_NAMEID_POLICY_URI, "Format not supported: " + nameFormat));
+ throw new ProfileException("NameID format required by relying party is not supported");
+ }
+ }
+ }
- Conditions conditions = assertion.getConditions();
- List<AudienceRestriction> audienceRestrictionConditions = conditions.getAudienceRestrictions();
+ if (nameFormats.isEmpty()) {
+ List<String> relyingPartySupportedFormats = getEntitySupportedFormats(requestContext
+ .getRelyingPartyRoleMetadata());
- for (String audienceURI : audiences) {
+ assertingPartySupportedFormats.retainAll(relyingPartySupportedFormats);
+ nameFormats.addAll(assertingPartySupportedFormats);
+ }
+ if (nameFormats.isEmpty()) {
+ nameFormats.add("urn:oasis:names:tc:SAML:2.0:nameid-format:unspecified");
+ }
- Audience audience = (Audience) audienceBuilder.buildObject(Audience.DEFAULT_ELEMENT_NAME);
- audience.setAudienceURI(audienceURI);
+ return nameFormats;
+ }
- AudienceRestriction audienceRestriction = (AudienceRestriction) audienceRestrictionBuilder
- .buildObject(AudienceRestriction.DEFAULT_ELEMENT_NAME);
- List<Audience> audienceList = audienceRestriction.getAudiences();
- audienceList.add(audience);
+ /**
+ * Gets the list of NameID formats supported for a given role.
+ *
+ * @param role the role to get the list of supported NameID formats
+ *
+ * @return list of supported NameID formats
+ */
+ protected List<String> getEntitySupportedFormats(RoleDescriptor role) {
+ List<NameIDFormat> nameIDFormats = null;
+
+ if (role instanceof SSODescriptor) {
+ nameIDFormats = ((SSODescriptor) role).getNameIDFormats();
+ } else if (role instanceof AuthnAuthorityDescriptor) {
+ nameIDFormats = ((AuthnAuthorityDescriptor) role).getNameIDFormats();
+ } else if (role instanceof PDPDescriptor) {
+ nameIDFormats = ((PDPDescriptor) role).getNameIDFormats();
+ } else if (role instanceof AttributeAuthorityDescriptor) {
+ nameIDFormats = ((AttributeAuthorityDescriptor) role).getNameIDFormats();
+ }
- audienceRestrictionConditions.add(audienceRestriction);
+ ArrayList<String> supportedFormats = new ArrayList<String>();
+ if (nameIDFormats != null) {
+ for (NameIDFormat format : nameIDFormats) {
+ supportedFormats.add(format.getFormat());
}
}
- return assertion;
+ return supportedFormats;
+ }
+
+ /**
+ * Constructs an SAML response message carrying a request error.
+ *
+ * @param requestContext current request context
+ *
+ * @return the constructed error response
+ */
+ protected Response buildErrorResponse(SAML2ProfileRequestContext requestContext) {
+ Response samlResponse = responseBuilder.buildObject();
+ samlResponse.setIssueInstant(new DateTime());
+ populateStatusResponse(requestContext, samlResponse);
+
+ samlResponse.setStatus(requestContext.getFailureStatus());
+
+ return samlResponse;
+ }
+
+ /**
+ * Writes an aduit log entry indicating the successful response to the attribute request.
+ *
+ * @param context current request context
+ */
+ protected void writeAuditLogEntry(SAML2ProfileRequestContext context) {
+ AuditLogEntry auditLogEntry = new AuditLogEntry();
+ auditLogEntry.setMessageProfile(getProfileId());
+ auditLogEntry.setPrincipalAuthenticationMethod(context.getPrincipalAuthenticationMethod());
+ auditLogEntry.setPrincipalName(context.getPrincipalName());
+ auditLogEntry.setAssertingPartyId(context.getAssertingPartyId());
+ auditLogEntry.setRelyingPartyId(context.getRelyingPartyId());
+ auditLogEntry.setRequestBinding(context.getMessageDecoder().getBindingURI());
+ auditLogEntry.setRequestId(context.getSamlRequest().getID());
+ auditLogEntry.setResponseBinding(context.getMessageEncoder().getBindingURI());
+ auditLogEntry.setResponseId(context.getSamlResponse().getID());
+ if(context.getPrincipalAttributes() != null){
+ auditLogEntry.getReleasedAttributes().addAll(context.getPrincipalAttributes().keySet());
+ }
+ getAduitLog().log(Level.CRITICAL, auditLogEntry);
+ }
+
+ /**
+ * Contextual object used to accumlate information as profile requests are being processed.
+ *
+ * @param <RequestType> type of SAML 2 request
+ * @param <ResponseType> type of SAML 2 response
+ * @param <ProfileConfigurationType> configuration type for this profile
+ */
+ protected class SAML2ProfileRequestContext<RequestType extends RequestAbstractType, ResponseType extends StatusResponseType, ProfileConfigurationType extends AbstractSAML2ProfileConfiguration>
+ extends SAMLProfileRequestContext {
+
+ /** SAML request message. */
+ private RequestType samlRequest;
+
+ /** SAML response message. */
+ private ResponseType samlResponse;
+
+ /** Request profile configuration. */
+ private ProfileConfigurationType profileConfiguration;
+
+ /** The NameID of the subject of this request. */
+ private NameID subjectNameID;
+
+ /** The request failure status. */
+ private Status failureStatus;
+
+ /**
+ * Constructor.
+ *
+ * @param request current profile request
+ * @param response current profile response
+ */
+ public SAML2ProfileRequestContext(ProfileRequest<ServletRequest> request,
+ ProfileResponse<ServletResponse> response) {
+ super(request, response);
+ }
+
+ /**
+ * Gets the NameID of the subject of this request.
+ *
+ * @return NameID of the subject of this request
+ */
+ public NameID getSubjectNameID() {
+ return subjectNameID;
+ }
+
+ /**
+ * Sets the NameID of the subject of this request.
+ *
+ * @param nameID NameID of the subject of this request
+ */
+ public void setSubjectNameID(NameID nameID) {
+ subjectNameID = nameID;
+ }
+
+ /**
+ * Gets the profile configuration for this request.
+ *
+ * @return profile configuration for this request
+ */
+ public ProfileConfigurationType getProfileConfiguration() {
+ return profileConfiguration;
+ }
+
+ /**
+ * Sets the profile configuration for this request.
+ *
+ * @param configuration profile configuration for this request
+ */
+ public void setProfileConfiguration(ProfileConfigurationType configuration) {
+ profileConfiguration = configuration;
+ }
+
+ /**
+ * Gets the SAML request message.
+ *
+ * @return SAML request message
+ */
+ public RequestType getSamlRequest() {
+ return samlRequest;
+ }
+
+ /**
+ * Sets the SAML request message.
+ *
+ * @param request SAML request message
+ */
+ public void setSamlRequest(RequestType request) {
+ samlRequest = request;
+ }
+
+ /**
+ * Gets the SAML response message.
+ *
+ * @return SAML response message
+ */
+ public ResponseType getSamlResponse() {
+ return samlResponse;
+ }
+
+ /**
+ * Sets the SAML response message.
+ *
+ * @param response SAML response message
+ */
+ public void setSamlResponse(ResponseType response) {
+ samlResponse = response;
+ }
+
+ /**
+ * Gets the status reflecting a request failure.
+ *
+ * @return status reflecting a request failure
+ */
+ public Status getFailureStatus() {
+ return failureStatus;
+ }
+
+ /**
+ * Sets the status reflecting a request failure.
+ *
+ * @param status status reflecting a request failure
+ */
+ public void setFailureStatus(Status status) {
+ failureStatus = status;
+ }
}
-}
+}
\ No newline at end of file
projects / java-idp.git / blobdiff