Lots of code cleanup
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / idp / profile / AbstractSAMLProfileHandler.java
index ed66097..c795d80 100644 (file)
@@ -21,22 +21,30 @@ import java.util.Map;
 
 import javax.servlet.http.HttpServletRequest;
 
-import org.apache.log4j.Logger;
 import org.opensaml.common.IdentifierGenerator;
 import org.opensaml.common.binding.decoding.SAMLMessageDecoder;
 import org.opensaml.common.binding.encoding.SAMLMessageEncoder;
-import org.opensaml.log.Level;
+import org.opensaml.saml2.metadata.Endpoint;
+import org.opensaml.saml2.metadata.EntityDescriptor;
 import org.opensaml.saml2.metadata.provider.MetadataProvider;
+import org.opensaml.saml2.metadata.provider.MetadataProviderException;
 import org.opensaml.ws.message.encoder.MessageEncodingException;
+import org.opensaml.ws.security.SecurityPolicyResolver;
 import org.opensaml.ws.transport.InTransport;
 import org.opensaml.ws.transport.http.HttpServletRequestAdapter;
+import org.opensaml.xml.security.credential.Credential;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import edu.internet2.middleware.shibboleth.common.log.AuditLogEntry;
 import edu.internet2.middleware.shibboleth.common.profile.ProfileException;
 import edu.internet2.middleware.shibboleth.common.profile.provider.AbstractShibbolethProfileHandler;
 import edu.internet2.middleware.shibboleth.common.profile.provider.BaseSAMLProfileRequestContext;
+import edu.internet2.middleware.shibboleth.common.relyingparty.RelyingPartyConfiguration;
+import edu.internet2.middleware.shibboleth.common.relyingparty.RelyingPartySecurityPolicyResolver;
+import edu.internet2.middleware.shibboleth.common.relyingparty.provider.AbstractSAMLProfileConfiguration;
+import edu.internet2.middleware.shibboleth.common.relyingparty.provider.CryptoOperationRequirementLevel;
 import edu.internet2.middleware.shibboleth.common.relyingparty.provider.SAMLMDRelyingPartyConfigurationManager;
-import edu.internet2.middleware.shibboleth.idp.profile.saml2.BaseSAML2ProfileRequestContext;
 import edu.internet2.middleware.shibboleth.idp.session.Session;
 
 /**
@@ -46,10 +54,10 @@ public abstract class AbstractSAMLProfileHandler extends
         AbstractShibbolethProfileHandler<SAMLMDRelyingPartyConfigurationManager, Session> {
 
     /** SAML message audit log. */
-    private final Logger auditLog = Logger.getLogger(AuditLogEntry.AUDIT_LOGGER_NAME);
+    private final Logger auditLog = LoggerFactory.getLogger(AuditLogEntry.AUDIT_LOGGER_NAME);
 
     /** Class logger. */
-    private final Logger log = Logger.getLogger(AbstractSAMLProfileHandler.class);
+    private final Logger log = LoggerFactory.getLogger(AbstractSAMLProfileHandler.class);
 
     /** Generator of IDs which may be used for SAML assertions, requests, etc. */
     private IdentifierGenerator idGenerator;
@@ -66,12 +74,37 @@ public abstract class AbstractSAMLProfileHandler extends
     /** SAML message bindings that may be used by outbound messages. */
     private List<String> supportedOutboundBindings;
 
+    /** Resolver used to determine active security policy for an incoming request. */
+    private SecurityPolicyResolver securityPolicyResolver;
+
     /** Constructor. */
     protected AbstractSAMLProfileHandler() {
         super();
     }
 
     /**
+     * Gets the resolver used to determine active security policy for an incoming request.
+     * 
+     * @return resolver used to determine active security policy for an incoming request
+     */
+    public SecurityPolicyResolver getSecurityPolicyResolver() {
+        if (securityPolicyResolver == null) {
+            setSecurityPolicyResolver(new RelyingPartySecurityPolicyResolver(getRelyingPartyConfigurationManager()));
+        }
+
+        return securityPolicyResolver;
+    }
+
+    /**
+     * Sets the resolver used to determine active security policy for an incoming request.
+     * 
+     * @param resolver resolver used to determine active security policy for an incoming request
+     */
+    public void setSecurityPolicyResolver(SecurityPolicyResolver resolver) {
+        securityPolicyResolver = resolver;
+    }
+
+    /**
      * Gets the audit log for this handler.
      * 
      * @return audit log for this handler
@@ -147,25 +180,19 @@ public abstract class AbstractSAMLProfileHandler extends
      * @return user's session
      */
     protected Session getUserSession(InTransport inTransport) {
-        String sessionId = getUserSessionId(inTransport);
-        return getSessionManager().getSession(sessionId);
+        HttpServletRequest rawRequest = ((HttpServletRequestAdapter) inTransport).getWrappedRequest();
+        return (Session) rawRequest.getAttribute(Session.HTTP_SESSION_BINDING_ATTRIBUTE);
     }
 
     /**
-     * Gets the user's session ID from the current request.
+     * Gets the user's session based on their principal name.
      * 
-     * @param inTransport current inbound transport
+     * @param principalName user's principal name
      * 
-     * @return user's session ID
+     * @return the user's session
      */
-    protected String getUserSessionId(InTransport inTransport) {
-        HttpServletRequest rawRequest = ((HttpServletRequestAdapter) inTransport).getWrappedRequest();
-
-        if (rawRequest != null) {
-            return (String) rawRequest.getSession().getAttribute(Session.HTTP_SESSION_BINDING_ATTRIBUTE);
-        }
-
-        return null;
+    protected Session getUserSession(String principalName) {
+        return getSessionManager().getSession(principalName);
     }
 
     /**
@@ -214,6 +241,170 @@ public abstract class AbstractSAMLProfileHandler extends
     }
 
     /**
+     * Populates the request context with information.
+     * 
+     * This method requires the the following request context properties to be populated: inbound message transport,
+     * peer entity ID, metadata provider
+     * 
+     * This methods populates the following request context properties: user's session, user's principal name, service
+     * authentication method, peer entity metadata, relying party configuration, local entity ID, outbound message
+     * issuer, local entity metadata
+     * 
+     * @param requestContext current request context
+     * @throws ProfileException thrown if there is a problem looking up the relying party's metadata
+     */
+    protected void populateRequestContext(BaseSAMLProfileRequestContext requestContext) throws ProfileException {
+        populateRelyingPartyInformation(requestContext);
+        populateAssertingPartyInformation(requestContext);
+        populateProfileInformation(requestContext);
+        populateSAMLMessageInformation(requestContext);
+        populateUserInformation(requestContext);
+    }
+
+    /**
+     * Populates the request context with information about the relying party.
+     * 
+     * This method requires the the following request context properties to be populated: peer entity ID
+     * 
+     * This methods populates the following request context properties: peer entity metadata, relying party
+     * configuration
+     * 
+     * @param requestContext current request context
+     * @throws ProfileException thrown if there is a problem looking up the relying party's metadata
+     */
+    protected void populateRelyingPartyInformation(BaseSAMLProfileRequestContext requestContext)
+            throws ProfileException {
+        MetadataProvider metadataProvider = requestContext.getMetadataProvider();
+        String relyingPartyId = requestContext.getPeerEntityId();
+
+        EntityDescriptor relyingPartyMetadata;
+        try {
+            relyingPartyMetadata = metadataProvider.getEntityDescriptor(relyingPartyId);
+        } catch (MetadataProviderException e) {
+            log.error("Error looking up metadata for relying party " + relyingPartyId, e);
+            throw new ProfileException("Error looking up metadata for relying party " + relyingPartyId);
+        }
+        
+        RelyingPartyConfiguration rpConfig = null;
+        if (relyingPartyMetadata != null) {
+            requestContext.setPeerEntityMetadata(relyingPartyMetadata);
+            rpConfig = getRelyingPartyConfiguration(relyingPartyId);
+        } else {
+            log.warn("No metadata for relying party {}, treating party as anonymous", relyingPartyId);
+            rpConfig = getRelyingPartyConfigurationManager().getAnonymousRelyingConfiguration();
+        }
+
+        if (rpConfig == null) {
+            log.error("Unable to retrieve relying party configuration data for entity with ID {}", relyingPartyId);
+            throw new ProfileException("Unable to retrieve relying party configuration data for entity with ID "
+                    + relyingPartyId);
+        }
+        requestContext.setRelyingPartyConfiguration(rpConfig);
+    }
+
+    /**
+     * Populates the request context with information about the asserting party. Unless overridden,
+     * {@link #populateRequestContext(BaseSAMLProfileRequestContext)} has already invoked
+     * {@link #populateRelyingPartyInformation(BaseSAMLProfileRequestContext)} has already been invoked and the
+     * properties it provides are available in the request context.
+     * 
+     * This method requires the the following request context properties to be populated: metadata provider, relying
+     * party configuration
+     * 
+     * This methods populates the following request context properties: local entity ID, outbound message issuer, local
+     * entity metadata
+     * 
+     * @param requestContext current request context
+     * @throws ProfileException thrown if there is a problem looking up the asserting party's metadata
+     */
+    protected void populateAssertingPartyInformation(BaseSAMLProfileRequestContext requestContext)
+            throws ProfileException {
+        String assertingPartyId = requestContext.getRelyingPartyConfiguration().getProviderId();
+        requestContext.setLocalEntityId(assertingPartyId);
+        requestContext.setOutboundMessageIssuer(assertingPartyId);
+
+        try {
+            EntityDescriptor localEntityDescriptor = requestContext.getMetadataProvider().getEntityDescriptor(
+                    assertingPartyId);
+            if (localEntityDescriptor != null) {
+                requestContext.setLocalEntityMetadata(localEntityDescriptor);
+            }
+        } catch (MetadataProviderException e) {
+            log.error("Error looking up metadata for asserting party " + assertingPartyId, e);
+            throw new ProfileException("Error looking up metadata for asserting party " + assertingPartyId);
+        }
+    }
+
+    /**
+     * Populates the request context with the information about the profile. Unless overridden,
+     * {@link #populateRequestContext(BaseSAMLProfileRequestContext)} has already invoked
+     * {@link #populateRelyingPartyInformation(BaseSAMLProfileRequestContext)},and
+     * {@link #populateAssertingPartyInformation(BaseSAMLProfileRequestContext)} have already been invoked and the
+     * properties they provide are available in the request context.
+     * 
+     * This method requires the the following request context properties to be populated: relying party configuration
+     * 
+     * This methods populates the following request context properties: communication profile ID, profile configuration,
+     * outbound message artifact type, peer entity endpoint
+     * 
+     * @param requestContext current request context
+     * 
+     * @throws ProfileException thrown if there is a problem populating the profile information
+     */
+    protected void populateProfileInformation(BaseSAMLProfileRequestContext requestContext) throws ProfileException {
+        requestContext.setCommunicationProfileId(getProfileId());
+        AbstractSAMLProfileConfiguration profileConfig = (AbstractSAMLProfileConfiguration) requestContext
+                .getRelyingPartyConfiguration().getProfileConfiguration(getProfileId());
+        requestContext.setProfileConfiguration(profileConfig);
+        requestContext.setOutboundMessageArtifactType(profileConfig.getOutboundArtifactType());
+        requestContext.setPeerEntityEndpoint(selectEndpoint(requestContext));
+    }
+
+    /**
+     * Populates the request context with information from the inbound SAML message. Unless overridden,
+     * {@link #populateRequestContext(BaseSAMLProfileRequestContext)} has already invoked
+     * {@link #populateRelyingPartyInformation(BaseSAMLProfileRequestContext)},
+     * {@link #populateAssertingPartyInformation(BaseSAMLProfileRequestContext)}, and
+     * {@link #populateProfileInformation(BaseSAMLProfileRequestContext)} have already been invoked and the properties
+     * they provide are available in the request context.
+     * 
+     * @param requestContext current request context
+     * 
+     * @throws ProfileException thrown if there is a problem populating the request context with information
+     */
+    protected abstract void populateSAMLMessageInformation(BaseSAMLProfileRequestContext requestContext)
+            throws ProfileException;
+
+    /**
+     * Populates the request context with the information about the user if they have an existing session. Unless
+     * overridden, {@link #populateRequestContext(BaseSAMLProfileRequestContext)} has already invoked
+     * {@link #populateRelyingPartyInformation(BaseSAMLProfileRequestContext)},
+     * {@link #populateAssertingPartyInformation(BaseSAMLProfileRequestContext)},
+     * {@link #populateProfileInformation(BaseSAMLProfileRequestContext)}, and
+     * {@link #populateSAMLMessageInformation(BaseSAMLProfileRequestContext)} have already been invoked and the
+     * properties they provide are available in the request context.
+     * 
+     * This method should populate: user's session, user's principal name, and service authentication method
+     * 
+     * @param requestContext current request context
+     * 
+     * @throws ProfileException thrown if there is a problem populating the user's information
+     */
+    protected abstract void populateUserInformation(BaseSAMLProfileRequestContext requestContext)
+            throws ProfileException;
+
+    /**
+     * Selects the appropriate endpoint for the relying party and stores it in the request context.
+     * 
+     * @param requestContext current request context
+     * 
+     * @return Endpoint selected from the information provided in the request context
+     * 
+     * @throws ProfileException thrown if there is a problem selecting a response endpoint
+     */
+    protected abstract Endpoint selectEndpoint(BaseSAMLProfileRequestContext requestContext) throws ProfileException;
+
+    /**
      * Encodes the request's SAML response and writes it to the servlet response.
      * 
      * @param requestContext current request context
@@ -221,25 +412,55 @@ public abstract class AbstractSAMLProfileHandler extends
      * @throws ProfileException thrown if no message encoder is registered for this profiles binding
      */
     protected void encodeResponse(BaseSAMLProfileRequestContext requestContext) throws ProfileException {
-        if (log.isDebugEnabled()) {
-            log.debug("Encoding response to SAML request " + requestContext.getInboundSAMLMessageId()
-                    + " from relying party " + requestContext.getPeerEntityId());
-        }
-
         try {
+
+            Endpoint peerEndpoint = requestContext.getPeerEntityEndpoint();
+            if (peerEndpoint == null) {
+                log
+                        .error("No return endpoint available for relying party {}", requestContext
+                                .getInboundMessageIssuer());
+                throw new ProfileException("No peer endpoint available to which to send SAML response");
+            }
+
             SAMLMessageEncoder encoder = getMessageEncoders().get(requestContext.getPeerEntityEndpoint().getBinding());
             if (encoder == null) {
+                log.error("No outbound message encoder configured for binding {}", requestContext
+                        .getPeerEntityEndpoint().getBinding());
                 throw new ProfileException("No outbound message encoder configured for binding "
                         + requestContext.getPeerEntityEndpoint().getBinding());
             }
+
+            AbstractSAMLProfileConfiguration profileConfig = (AbstractSAMLProfileConfiguration) requestContext
+                    .getProfileConfiguration();
+            if (profileConfig.getSignResponses() == CryptoOperationRequirementLevel.always
+                    || (profileConfig.getSignResponses() == CryptoOperationRequirementLevel.conditional && !encoder
+                            .providesMessageIntegrity(requestContext))) {
+                Credential signingCredential = null;
+                if (profileConfig.getSigningCredential() != null) {
+                    signingCredential = profileConfig.getSigningCredential();
+                } else if (requestContext.getRelyingPartyConfiguration().getDefaultSigningCredential() != null) {
+                    signingCredential = requestContext.getRelyingPartyConfiguration().getDefaultSigningCredential();
+                }
+
+                if (signingCredential == null) {
+                    throw new ProfileException(
+                            "Signing of responses is required but no signing credential is available");
+                }
+
+                requestContext.setOutboundSAMLMessageSigningCredential(signingCredential);
+            }
+
+            log.debug("Encoding response to SAML request {} from relying party {}", requestContext
+                    .getInboundSAMLMessageId(), requestContext.getInboundMessageIssuer());
+
             requestContext.setMessageEncoder(encoder);
             encoder.encode(requestContext);
         } catch (MessageEncodingException e) {
             throw new ProfileException("Unable to encode response to relying party: "
-                    + requestContext.getPeerEntityId(), e);
+                    + requestContext.getInboundMessageIssuer(), e);
         }
     }
-    
+
     /**
      * Writes an aduit log entry indicating the successful response to the attribute request.
      * 
@@ -251,7 +472,7 @@ public abstract class AbstractSAMLProfileHandler extends
         auditLogEntry.setPrincipalAuthenticationMethod(context.getPrincipalAuthenticationMethod());
         auditLogEntry.setPrincipalName(context.getPrincipalName());
         auditLogEntry.setAssertingPartyId(context.getLocalEntityId());
-        auditLogEntry.setRelyingPartyId(context.getPeerEntityId());
+        auditLogEntry.setRelyingPartyId(context.getInboundMessageIssuer());
         auditLogEntry.setRequestBinding(context.getMessageDecoder().getBindingURI());
         auditLogEntry.setRequestId(context.getInboundSAMLMessageId());
         auditLogEntry.setResponseBinding(context.getMessageEncoder().getBindingURI());
@@ -259,6 +480,7 @@ public abstract class AbstractSAMLProfileHandler extends
         if (context.getReleasedAttributes() != null) {
             auditLogEntry.getReleasedAttributes().addAll(context.getReleasedAttributes());
         }
-        getAduitLog().log(Level.CRITICAL, auditLogEntry);
+
+        getAduitLog().info(auditLogEntry.toString());
     }
 }
\ No newline at end of file