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.binding.encoding.SAMLMessageEncoder;
+import org.opensaml.common.xml.SAMLConstants;
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.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.core.SubjectConfirmationData;
+import org.opensaml.saml2.encryption.Encrypter;
+import org.opensaml.saml2.encryption.Encrypter.KeyPlacement;
+import org.opensaml.saml2.metadata.AttributeAuthorityDescriptor;
+import org.opensaml.saml2.metadata.AuthnAuthorityDescriptor;
+import org.opensaml.saml2.metadata.Endpoint;
+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.security.MetadataCredentialResolver;
+import org.opensaml.security.MetadataCriteria;
+import org.opensaml.ws.message.encoder.MessageEncodingException;
+import org.opensaml.ws.transport.http.HTTPInTransport;
import org.opensaml.xml.XMLObjectBuilder;
-import org.opensaml.xml.XMLObjectBuilderFactory;
-
+import org.opensaml.xml.encryption.EncryptionException;
+import org.opensaml.xml.encryption.EncryptionParameters;
+import org.opensaml.xml.encryption.KeyEncryptionParameters;
+import org.opensaml.xml.io.Marshaller;
+import org.opensaml.xml.io.MarshallingException;
+import org.opensaml.xml.security.CriteriaSet;
+import org.opensaml.xml.security.SecurityConfiguration;
+import org.opensaml.xml.security.SecurityException;
+import org.opensaml.xml.security.SecurityHelper;
+import org.opensaml.xml.security.credential.Credential;
+import org.opensaml.xml.security.credential.UsageType;
+import org.opensaml.xml.security.criteria.EntityIDCriteria;
+import org.opensaml.xml.security.criteria.UsageCriteria;
+import org.opensaml.xml.signature.Signature;
+import org.opensaml.xml.signature.SignatureException;
+import org.opensaml.xml.signature.Signer;
+import org.opensaml.xml.util.DatatypeHelper;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+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.SAML2NameIDEncoder;
+import edu.internet2.middleware.shibboleth.common.attribute.provider.SAML2AttributeAuthority;
+import edu.internet2.middleware.shibboleth.common.profile.ProfileException;
+import edu.internet2.middleware.shibboleth.common.profile.provider.BaseSAMLProfileRequestContext;
+import edu.internet2.middleware.shibboleth.common.relyingparty.provider.CryptoOperationRequirementLevel;
+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.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 = LoggerFactory.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 building subject confirmation. */
+ private SAMLObjectBuilder<SubjectConfirmation> subjectConfirmationBuilder;
+
+ /** For building subject confirmation data. */
+ private SAMLObjectBuilder<SubjectConfirmationData> subjectConfirmationDataBuilder;
+
+ /** 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);
+ subjectConfirmationDataBuilder = (SAMLObjectBuilder<SubjectConfirmationData>) getBuilderFactory().getBuilder(
+ SubjectConfirmationData.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);
+ }
+
+ /** {@inheritDoc} */
+ protected void populateRequestContext(BaseSAMLProfileRequestContext requestContext) throws ProfileException {
+ BaseSAML2ProfileRequestContext saml2Request = (BaseSAML2ProfileRequestContext) requestContext;
+ try {
+ super.populateRequestContext(requestContext);
+ } catch (ProfileException e) {
+ if (saml2Request.getFailureStatus() == null) {
+ saml2Request.setFailureStatus(buildStatus(StatusCode.REQUESTER_URI, null, e.getMessage()));
+ }
+ throw e;
+ }
+ }
+
+ /**
+ * Populates the request context with the information about the user.
+ *
+ * This method requires the the following request context properties to be populated: inbound message transport,
+ * relying party ID
+ *
+ * This methods populates the following request context properties: user's session, user's principal name, and
+ * service authentication method
+ *
+ * @param requestContext current request context
+ */
+ protected void populateUserInformation(BaseSAMLProfileRequestContext requestContext) {
+ Session userSession = getUserSession(requestContext.getInboundMessageTransport());
+ if (userSession == null) {
+ NameID subject = (NameID) requestContext.getSubjectNameIdentifier();
+ if (subject != null && subject.getValue() != null) {
+ userSession = getUserSession(subject.getValue());
+ }
+ }
+
+ if (userSession != null) {
+ requestContext.setUserSession(userSession);
+ requestContext.setPrincipalName(userSession.getPrincipalName());
+ requestContext.setPrincipalAuthenticationMethod(userSession.getServicesInformation().get(
+ requestContext.getPeerEntityId()).getAuthenticationMethod().getAuthenticationMethod());
+ }
+ }
- /** 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(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext) throws ProfileException {
+ SAMLVersion version = requestContext.getInboundSAMLMessage().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 || version.getMinorVersion() > 0) {
+ 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 subjectConfirmationMethod confirmation method used for the subject
+ * @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(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext,
+ String subjectConfirmationMethod, List<Statement> statements) throws ProfileException {
+
+ DateTime issueInstant = new DateTime();
+
+ Subject subject = buildSubject(requestContext, subjectConfirmationMethod, issueInstant);
+
+ // create the assertion and add the attribute statement
+ Assertion assertion = buildAssertion(requestContext, issueInstant);
+ assertion.setSubject(subject);
+ if (statements != null && !statements.isEmpty()) {
+ assertion.getStatements().addAll(statements);
+ }
+
+ // create the SAML response and add the assertion
+ Response samlResponse = responseBuilder.buildObject();
+ samlResponse.setIssueInstant(issueInstant);
+ populateStatusResponse(requestContext, samlResponse);
+
+ // sign the assertion if it should be signed
+ signAssertion(requestContext, assertion);
+
+ SAMLMessageEncoder encoder = getMessageEncoders().get(requestContext.getPeerEntityEndpoint().getBinding());
+ try {
+ if (requestContext.getProfileConfiguration().getEncryptAssertion() == CryptoOperationRequirementLevel.always
+ || (requestContext.getProfileConfiguration().getEncryptAssertion() == CryptoOperationRequirementLevel.conditional && !encoder
+ .providesMessageConfidentiality(requestContext))) {
+ log.debug("Attempting to encrypt assertion to relying party {}", requestContext
+ .getInboundMessageIssuer());
+ try {
+ Encrypter encrypter = getEncrypter(requestContext.getInboundMessageIssuer());
+ samlResponse.getEncryptedAssertions().add(encrypter.encrypt(assertion));
+ } catch (SecurityException e) {
+ log.error("Unable to construct encrypter", e);
+ requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null,
+ "Unable to encrypt assertion"));
+ throw new ProfileException("Unable to construct encrypter", e);
+ } catch (EncryptionException e) {
+ log.error("Unable to encrypt assertion", e);
+ requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null,
+ "Unable to encrypt assertion"));
+ throw new ProfileException("Unable to encrypt assertion", e);
+ }
+ } else {
+ samlResponse.getAssertions().add(assertion);
+ }
+ } catch (MessageEncodingException e) {
+ log.error("Unable to determine if outbound encoding {} can provide confidentiality", encoder
+ .getBindingURI());
+ throw new ProfileException("Unable to determine if assertions should be encrypted");
+ }
- /** Builder for Response elements. */
- protected XMLObjectBuilder responseBuilder;
+ Status status = buildStatus(StatusCode.SUCCESS_URI, null, null);
+ samlResponse.setStatus(status);
- /** Builder for Status elements. */
- private XMLObjectBuilder statusBuilder;
+ return samlResponse;
+ }
- /** Builder for StatusCode elements. */
- private XMLObjectBuilder statusCodeBuilder;
+ /**
+ * 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
+ */
+ protected Assertion buildAssertion(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext, DateTime issueInstant) {
+ Assertion assertion = assertionBuilder.buildObject();
+ assertion.setID(getIdGenerator().generateIdentifier());
+ assertion.setIssueInstant(issueInstant);
+ assertion.setVersion(SAMLVersion.VERSION_20);
+ assertion.setIssuer(buildEntityIssuer(requestContext));
- /** Builder for StatusMessage elements. */
- private XMLObjectBuilder statusMessageBuilder;
+ Conditions conditions = buildConditions(requestContext, issueInstant);
+ assertion.setConditions(conditions);
- /** Builder for Issuer elements. */
- protected XMLObjectBuilder issuerBuilder;
+ return assertion;
+ }
/**
- * Default constructor.
+ * Creates an {@link Issuer} populated with information about the relying party.
+ *
+ * @param requestContext current request context
+ *
+ * @return the built issuer
*/
- public AbstractSAML2ProfileHandler() {
- builderFactory = Configuration.getBuilderFactory();
- idGenerator = new SecureRandomIdentifierGenerator();
+ protected Issuer buildEntityIssuer(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext) {
+ Issuer issuer = issuerBuilder.buildObject();
+ issuer.setFormat(Issuer.ENTITY);
+ issuer.setValue(requestContext.getLocalEntityId());
- 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 issuer;
}
/**
- * Returns the XML builder factory.
+ * 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 Returns the builderFactory.
+ * @return constructed conditions
*/
- public XMLObjectBuilderFactory getBuilderFactory() {
- return builderFactory;
+ protected Conditions buildConditions(BaseSAML2ProfileRequestContext<?, ?, ?> 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
+ AudienceRestriction audienceRestriction = audienceRestrictionBuilder.buildObject();
+ // TODO we should only do this for certain outgoing bindings, not globally
+ Audience audience = audienceBuilder.buildObject();
+ audience.setAudienceURI(requestContext.getInboundMessageIssuer());
+ audienceRestriction.getAudiences().add(audience);
+ audiences = profileConfig.getAssertionAudiences();
+ if (audiences != null && audiences.size() > 0) {
+ for (String audienceUri : audiences) {
+ 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();
+ 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(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext,
+ StatusResponseType response) {
+ response.setID(getIdGenerator().generateIdentifier());
+ if (requestContext.getInboundSAMLMessage() != null) {
+ response.setInResponseTo(requestContext.getInboundSAMLMessageId());
+ }
+ response.setVersion(SAMLVersion.VERSION_20);
+ response.setIssuer(buildEntityIssuer(requestContext));
}
/**
- * This decodes the attribute query message from the supplied request.
+ * Resolves the attributes for the principal.
*
- * @param decoder <code>MessageDecoder</code>
- * @param request <code>ServletRequest</code>
- * @return <code>SAMLObject</code>
- * @throws BindingException if the request cannot be decoded
+ * @param requestContext current request context
+ *
+ * @throws ProfileException thrown if there is a problem resolved attributes
*/
- public static SAMLObject decodeMessage(MessageDecoder<ServletRequest> decoder, ServletRequest request)
- throws BindingException {
+ protected void resolveAttributes(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext) throws ProfileException {
+ AbstractSAML2ProfileConfiguration profileConfiguration = requestContext.getProfileConfiguration();
+ SAML2AttributeAuthority attributeAuthority = profileConfiguration.getAttributeAuthority();
+
+ try {
+ log.debug("Resolving attributes for principal {} of SAML request from relying party {}", requestContext
+ .getPrincipalName(), requestContext.getInboundMessageIssuer());
+ Map<String, BaseAttribute> principalAttributes = attributeAuthority.getAttributes(requestContext);
+
+ requestContext.setAttributes(principalAttributes);
+ } catch (AttributeRequestException e) {
+ log.error("Error resolving attributes for SAML request " + requestContext.getInboundSAMLMessageId()
+ + " from relying party " + requestContext.getInboundMessageIssuer(), e);
+ requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Error resolving attributes"));
+ throw new ProfileException("Error resolving attributes for SAML request "
+ + requestContext.getInboundSAMLMessageId() + " from relying party "
+ + requestContext.getInboundMessageIssuer(), e);
+ }
+ }
- decoder.setRequest(request);
- decoder.decode();
- if (log.isDebugEnabled()) {
- log.debug("decoded servlet request");
+ /**
+ * 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(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext)
+ throws ProfileException {
+ log.debug("Creating attribute statement in response to SAML request {} from relying party {}", requestContext
+ .getInboundSAMLMessageId(), requestContext.getInboundMessageIssuer());
+
+ AbstractSAML2ProfileConfiguration profileConfiguration = requestContext.getProfileConfiguration();
+ SAML2AttributeAuthority attributeAuthority = profileConfiguration.getAttributeAuthority();
+ try {
+ if (requestContext.getInboundSAMLMessage() instanceof AttributeQuery) {
+ return attributeAuthority.buildAttributeStatement((AttributeQuery) requestContext
+ .getInboundSAMLMessage(), requestContext.getAttributes().values());
+ } else {
+ return attributeAuthority.buildAttributeStatement(null, requestContext.getAttributes().values());
+ }
+ } catch (AttributeRequestException e) {
+ log.error("Error encoding attributes for principal " + requestContext.getPrincipalName(), e);
+ requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Error resolving attributes"));
+ throw new ProfileException("Error encoding attributes for principal " + requestContext.getPrincipalName(),
+ e);
}
+ }
- return decoder.getSAMLMessage();
+ /**
+ * 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(BaseSAML2ProfileRequestContext<?, ?, ?> 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.getInboundMessageIssuer());
+ 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.getInboundMessageIssuer());
+ }
+ SAML2AttributeAuthority attributeAuthority = profileConfiguration.getAttributeAuthority();
+ log.debug("Resolving principal name for subject of SAML request {} from relying party {}", requestContext
+ .getInboundSAMLMessageId(), requestContext.getInboundMessageIssuer());
+
+ try {
+ String principal = attributeAuthority.getPrincipal(requestContext);
+ requestContext.setPrincipalName(principal);
+ } catch (AttributeRequestException e) {
+ log.error("Error resolving attributes for SAML request " + requestContext.getInboundSAMLMessageId()
+ + " from relying party " + requestContext.getInboundMessageIssuer(), e);
+ requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, StatusCode.UNKNOWN_PRINCIPAL_URI,
+ "Error resolving principal"));
+ throw new ProfileException("Error resolving attributes for SAML request "
+ + requestContext.getInboundSAMLMessageId() + " from relying party "
+ + requestContext.getInboundMessageIssuer(), e);
+ }
}
/**
- * This encodes the supplied response.
+ * 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
*
- * @param encoder <code>MessageEncoder</code>
- * @param response <code>SAMLObject</code>
- * @throws BindingException if the response cannot be encoded
+ * @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
*/
- public static void encodeResponse(MessageEncoder<ServletResponse> encoder, SAMLObject response)
- throws BindingException {
+ protected void signAssertion(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext, Assertion assertion)
+ throws ProfileException {
+ log.debug("Determining if SAML assertion to relying party {} should be signed", requestContext
+ .getInboundMessageIssuer());
+
+ boolean signAssertion = false;
+
+ SAMLMessageEncoder encoder = getMessageEncoders().get(requestContext.getPeerEntityEndpoint().getBinding());
+ AbstractSAML2ProfileConfiguration profileConfig = requestContext.getProfileConfiguration();
+ try {
+ if (profileConfig.getSignAssertions() == CryptoOperationRequirementLevel.always
+ || (profileConfig.getSignAssertions() == CryptoOperationRequirementLevel.conditional && !encoder
+ .providesMessageIntegrity(requestContext))) {
+ signAssertion = true;
+ log.debug("IdP relying party configuration {} indicates to sign assertions: {}", requestContext
+ .getRelyingPartyConfiguration().getRelyingPartyId(), signAssertion);
+ }
+ } catch (MessageEncodingException e) {
+ log.error("Unable to determine if outbound encoding {} can provide integrity protection", encoder
+ .getBindingURI());
+ throw new ProfileException("Unable to determine if outbound message should be signed");
+ }
- encoder.setSAMLMessage(response);
- encoder.encode();
+ if (!signAssertion && requestContext.getPeerEntityRoleMetadata() instanceof SPSSODescriptor) {
+ SPSSODescriptor ssoDescriptor = (SPSSODescriptor) requestContext.getPeerEntityRoleMetadata();
+ if (ssoDescriptor.getWantAssertionsSigned() != null) {
+ signAssertion = ssoDescriptor.getWantAssertionsSigned().booleanValue();
+ log.debug("Entity metadata for relying party {} indicates to sign assertions: {}", requestContext
+ .getInboundMessageIssuer(), signAssertion);
+ }
+ }
+
+ if (!signAssertion) {
+ return;
+ }
+
+ log.debug("Determining signing credntial for assertion to relying party {}", requestContext
+ .getInboundMessageIssuer());
+ 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");
+ }
+
+ log.debug("Signing assertion to relying party {}", requestContext.getInboundMessageIssuer());
+ Signature signature = signatureBuilder.buildObject(Signature.DEFAULT_ELEMENT_NAME);
+
+ signature.setSigningCredential(signatureCredential);
+ try {
+ // TODO pull SecurityConfiguration from SAMLMessageContext? needs to be added
+ // TODO how to pull what keyInfoGenName to use?
+ SecurityHelper.prepareSignatureParams(signature, signatureCredential, null, null);
+ } catch (SecurityException e) {
+ throw new ProfileException("Error preparing signature for signing", e);
+ }
+
+ assertion.setSignature(signature);
+
+ Marshaller assertionMarshaller = Configuration.getMarshallerFactory().getMarshaller(assertion);
+ try {
+ assertionMarshaller.marshall(assertion);
+ Signer.signObject(signature);
+ } catch (MarshallingException e) {
+ log.error("Unable to marshall assertion for signing", e);
+ throw new ProfileException("Unable to marshall assertion for signing", e);
+ } catch (SignatureException e) {
+ log.error("Unable to sign assertion", e);
+ throw new ProfileException("Unable to sign assertion", e);
+ }
}
/**
* @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 issueInstant instant the subject confirmation data should reflect for issuance
*
- * @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(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext, String confirmationMethod,
+ DateTime issueInstant) throws ProfileException {
+ NameID nameID = buildNameId(requestContext);
+ requestContext.setSubjectNameIdentifier(nameID);
+
+ SubjectConfirmationData confirmationData = subjectConfirmationDataBuilder.buildObject();
+ HTTPInTransport inTransport = (HTTPInTransport) requestContext.getInboundMessageTransport();
+ confirmationData.setAddress(inTransport.getPeerAddress());
+ confirmationData.setInResponseTo(requestContext.getInboundSAMLMessageId());
+ confirmationData.setNotOnOrAfter(issueInstant.plus(requestContext.getProfileConfiguration()
+ .getAssertionLifetime()));
+
+ Endpoint relyingPartyEndpoint = requestContext.getPeerEntityEndpoint();
+ if (relyingPartyEndpoint != null) {
+ if (relyingPartyEndpoint.getResponseLocation() != null) {
+ confirmationData.setRecipient(relyingPartyEndpoint.getResponseLocation());
+ } else {
+ confirmationData.setRecipient(relyingPartyEndpoint.getLocation());
+ }
+ }
- Response response = (Response) responseBuilder.buildObject(Response.DEFAULT_ELEMENT_NAME);
+ SubjectConfirmation subjectConfirmation = subjectConfirmationBuilder.buildObject();
+ subjectConfirmation.setMethod(confirmationMethod);
+ subjectConfirmation.setSubjectConfirmationData(confirmationData);
+
+ Subject subject = subjectBuilder.buildObject();
+ subject.getSubjectConfirmations().add(subjectConfirmation);
+ SAMLMessageEncoder encoder = getMessageEncoders().get(requestContext.getPeerEntityEndpoint().getBinding());
+ try {
+ if (requestContext.getProfileConfiguration().getEncryptNameID() == CryptoOperationRequirementLevel.always
+ || (requestContext.getProfileConfiguration().getEncryptNameID() == CryptoOperationRequirementLevel.conditional && !encoder
+ .providesMessageConfidentiality(requestContext))) {
+ log.debug("Attempting to encrypt NameID to relying party {}", requestContext.getInboundMessageIssuer());
+ try {
+ Encrypter encrypter = getEncrypter(requestContext.getInboundMessageIssuer());
+ subject.setEncryptedID(encrypter.encrypt(nameID));
+ } catch (SecurityException e) {
+ log.error("Unable to construct encrypter", e);
+ requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null,
+ "Unable to construct NameID"));
+ throw new ProfileException("Unable to construct encrypter", e);
+ } catch (EncryptionException e) {
+ log.error("Unable to encrypt NameID", e);
+ requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null,
+ "Unable to construct NameID"));
+ throw new ProfileException("Unable to encrypt NameID", e);
+ }
+ } else {
+ subject.setNameID(nameID);
+ }
+ } catch (MessageEncodingException e) {
+ log.error("Unable to determine if outbound encoding {} can provide confidentiality", encoder
+ .getBindingURI());
+ throw new ProfileException("Unable to determine if assertions should be encrypted");
+ }
- Issuer i = (Issuer) issuerBuilder.buildObject(Issuer.DEFAULT_ELEMENT_NAME);
- i.setValue(issuer);
+ return subject;
+ }
- response.setVersion(SAML_VERSION);
- response.setId(getIdGenerator().generateIdentifier());
- response.setInResponseto(inResponseTo);
- response.setIssueInstance(new DateTime());
- response.setIssuer(i);
- response.setStatus(status);
+ /**
+ * 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(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext) throws ProfileException {
+ log.debug("Building assertion NameID for principal/relying party:{}/{}", requestContext.getPrincipalName(),
+ requestContext.getInboundMessageIssuer());
+
+ Map<String, BaseAttribute> principalAttributes = requestContext.getAttributes();
+ if (principalAttributes == null || principalAttributes.isEmpty()) {
+ log.error("No attributes for principal {}, unable to construct of NameID", requestContext
+ .getPrincipalName());
+ requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, StatusCode.INVALID_NAMEID_POLICY_URI,
+ "Unable to construct NameID"));
+ throw new ProfileException("No principal attributes support NameID construction");
+ }
- return response;
- }
+ List<String> supportedNameFormats = getNameFormats(requestContext);
+ if (supportedNameFormats == null || supportedNameFormats.isEmpty()) {
+ log.error("No common NameID formats supported by SP {} and IdP", requestContext.getInboundMessageIssuer());
+ requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, StatusCode.INVALID_NAMEID_POLICY_URI,
+ "Unable to construct NameID"));
+ throw new ProfileException("No principal attributes support NameID construction");
+ }
- protected Assertion buildAssertion(final Subject subject, final Conditions conditions, String issuer,
- final String[] audiences) {
+ log.debug("Supported NameID formats: {}", supportedNameFormats);
+ try {
+ SAML2NameIDEncoder nameIdEncoder;
+ for (BaseAttribute<?> attribute : principalAttributes.values()) {
+ for (AttributeEncoder encoder : attribute.getEncoders()) {
+ if (encoder instanceof SAML2NameIDEncoder) {
+ nameIdEncoder = (SAML2NameIDEncoder) encoder;
+ if (supportedNameFormats.contains(nameIdEncoder.getNameFormat())) {
+ log.debug("Using attribute {} suppoting NameID format {} to create the NameID.", attribute
+ .getId(), nameIdEncoder.getNameFormat());
+ return nameIdEncoder.encode(attribute);
+ }
+ }
+ }
+ }
- 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);
+ log.error("No principal attribute supported encoding into a supported name ID format.");
+ requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Unable to construct NameID"));
+ throw new ProfileException("No principal attribute supported encoding into a supported name ID format.");
+ } catch (AttributeEncodingException e) {
+ log.error("Unable to encode NameID attribute", e);
+ requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Unable to construct NameID"));
+ throw new ProfileException("Unable to encode NameID attribute", e);
+ }
+ }
- Issuer i = (Issuer) issuerBuilder.buildObject(Issuer.DEFAULT_ELEMENT_NAME);
- i.setValue(issuer);
- assertion.setIssuer(i);
+ /**
+ * 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(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext)
+ throws ProfileException {
+ ArrayList<String> nameFormats = new ArrayList<String>();
+
+ // Determine name formats supported by both SP and IdP
+ RoleDescriptor relyingPartyRole = requestContext.getPeerEntityRoleMetadata();
+ if (relyingPartyRole != null) {
+ List<String> relyingPartySupportedFormats = getEntitySupportedFormats(relyingPartyRole);
+ if (relyingPartySupportedFormats != null && !relyingPartySupportedFormats.isEmpty()) {
+ nameFormats.addAll(relyingPartySupportedFormats);
+
+ RoleDescriptor assertingPartyRole = requestContext.getLocalEntityRoleMetadata();
+ if (assertingPartyRole != null) {
+ List<String> assertingPartySupportedFormats = getEntitySupportedFormats(assertingPartyRole);
+ if (assertingPartySupportedFormats != null && !assertingPartySupportedFormats.isEmpty()) {
+ nameFormats.retainAll(assertingPartySupportedFormats);
+ }
+ }
+ }
+ }
- // if audiences were specified, set an AudienceRestriction condition
- if (audiences != null && audiences.length > 0) {
+ if (nameFormats.isEmpty()) {
+ nameFormats.add("urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified");
+ }
- Conditions conditions = assertion.getConditions();
- List<AudienceRestriction> audienceRestrictionConditions = conditions.getAudienceRestrictions();
+ // If authn request and name ID policy format specified, make sure it's in the list of supported formats
+ String nameFormat = null;
+ if (requestContext.getInboundSAMLMessage() instanceof AuthnRequest) {
+ AuthnRequest authnRequest = (AuthnRequest) requestContext.getInboundSAMLMessage();
+ if (authnRequest.getNameIDPolicy() != null) {
+ nameFormat = DatatypeHelper.safeTrimOrNullString(authnRequest.getNameIDPolicy().getFormat());
+ if (nameFormat != null) {
+ if (nameFormats.contains(nameFormat)) {
+ nameFormats.clear();
+ 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");
+ }
+ }
- for (String audienceURI : audiences) {
+ }
+ }
- 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(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext) {
+ Response samlResponse = responseBuilder.buildObject();
+ samlResponse.setIssueInstant(new DateTime());
+ populateStatusResponse(requestContext, samlResponse);
+
+ samlResponse.setStatus(requestContext.getFailureStatus());
+
+ return samlResponse;
+ }
+
+ /**
+ * Gets an encrypter that may be used encrypt content to a given peer.
+ *
+ * @param peerEntityId entity ID of the peer
+ *
+ * @return encrypter that may be used encrypt content to a given peer
+ *
+ * @throws SecurityException thrown if there is a problem constructing the encrypter. This normally occurs if the
+ * key encryption credential for the peer can not be resolved or a required encryption algorithm is not
+ * supported by the VM's JCE.
+ */
+ protected Encrypter getEncrypter(String peerEntityId) throws SecurityException {
+ SecurityConfiguration securityConfiguration = Configuration.getGlobalSecurityConfiguration();
+
+ EncryptionParameters dataEncParams = SecurityHelper
+ .buildDataEncryptionParams(null, securityConfiguration, null);
+
+ Credential keyEncryptionCredentials = getKeyEncryptionCredential(peerEntityId);
+ String wrappedJCAKeyAlgorithm = SecurityHelper.getKeyAlgorithmFromURI(dataEncParams.getAlgorithm());
+ KeyEncryptionParameters keyEncParams = SecurityHelper.buildKeyEncryptionParams(keyEncryptionCredentials,
+ wrappedJCAKeyAlgorithm, securityConfiguration, null, null);
+
+ Encrypter encrypter = new Encrypter(dataEncParams, keyEncParams);
+ encrypter.setKeyPlacement(KeyPlacement.INLINE);
+ return encrypter;
+ }
+
+ /**
+ * Gets the credential that can be used to encrypt encryption keys for a peer.
+ *
+ * @param peerEntityId entity ID of the peer
+ *
+ * @return credential that can be used to encrypt encryption keys for a peer
+ *
+ * @throws SecurityException thrown if there is a problem resolving the credential from the peer's metadata
+ */
+ protected Credential getKeyEncryptionCredential(String peerEntityId) throws SecurityException {
+ MetadataCredentialResolver kekCredentialResolver = new MetadataCredentialResolver(getMetadataProvider());
+
+ CriteriaSet criteriaSet = new CriteriaSet();
+ criteriaSet.add(new EntityIDCriteria(peerEntityId));
+ criteriaSet.add(new MetadataCriteria(SPSSODescriptor.DEFAULT_ELEMENT_NAME, SAMLConstants.SAML20P_NS));
+ criteriaSet.add(new UsageCriteria(UsageType.ENCRYPTION));
+
+ return kekCredentialResolver.resolveSingle(criteriaSet);
}
-}
+}
\ No newline at end of file
projects / java-idp.git / blobdiff