GUACAMOLE-1780: Unify session reactivation/invalidation behavior.

extensions/guacamole-auth-sso/modules/guacamole-auth-sso-saml/src/main/java/org/apache/guacamole/auth/saml/AuthenticationEventListener.java

@@ -1,70 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements.  See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership.  The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License.  You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-package org.apache.guacamole.auth.saml;
-
-import com.google.inject.Inject;
-import org.apache.guacamole.GuacamoleException;
-import org.apache.guacamole.auth.saml.acs.SAMLAuthenticationSessionManager;
-import org.apache.guacamole.net.event.AuthenticationFailureEvent;
-import org.apache.guacamole.net.event.AuthenticationSuccessEvent;
-import org.apache.guacamole.net.event.listener.Listener;
-
-/**
- * A Listener that will reactivate or invalidate SAML auth sessions depending on
- * overall auth success or failure.
- */
-public class AuthenticationEventListener implements Listener {
-
-    /**
-     * Manager of active SAML authentication attempts.
-     *
-     * Requires static injection due to the fact that the webapp just calls the
-     * constructor directly when creating new Listeners. The instances will not
-     * be constructed by guice.
-     */
-    @Inject
-    private static SAMLAuthenticationSessionManager sessionManager;
-
-    @Override
-    public void handleEvent(Object event) throws GuacamoleException {
-
-        if (event instanceof AuthenticationSuccessEvent)
-
-            // After an auth attempt has fully succeeded, invalidate the session
-            // associated with the successful login event so it can't be reused
-            sessionManager.invalidateSession(
-                AuthenticationProviderService.getSessionIdentifier(
-                    ((AuthenticationSuccessEvent) event).getCredentials()));
-
-        else if (event instanceof AuthenticationFailureEvent)
-
-            // If the SSL auth succeeded, but other auth providers failed to
-            // authenticate the user associated with the credentials in this
-            // failure event, they may wish to make another login attempt. To 
-            // avoid an infinite login attempt loop, re-enable the session
-            // associated with these credentials, allowing the auth attempt to be
-            // resumed without requiring another round trip to the SAML provider.
-            sessionManager.reactivateSession(
-                AuthenticationProviderService.getSessionIdentifier(
-                    ((AuthenticationFailureEvent) event).getCredentials()));
-        
-    }
-
-}

extensions/guacamole-auth-sso/modules/guacamole-auth-sso-saml/src/main/java/org/apache/guacamole/auth/saml/AuthenticationProviderService.java

@@ -74,11 +74,12 @@ public class AuthenticationProviderService implements SSOAuthenticationProviderS
      * credentials, or null if no session identifier is found in the
      * credentials.
      *
-     * @param credentials The credentials from which to extract the session
-     * identifier.
+     * @param credentials
+     *     The credentials from which to extract the session identifier.
      *
-     * @return The session identifier associated with the given credentials, or
-     * null if no identifier is found.
+     * @return
+     *     The session identifier associated with the given credentials, or
+     *     null if no identifier is found.
      */
     public static String getSessionIdentifier(Credentials credentials) {
 

extensions/guacamole-auth-sso/modules/guacamole-auth-sso-saml/src/main/java/org/apache/guacamole/auth/saml/SAMLAuthenticationEventListener.java

@@ -0,0 +1,66 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.auth.saml;
+
+import org.apache.guacamole.auth.saml.acs.SAMLAuthenticationSessionManager;
+import org.apache.guacamole.auth.sso.SSOAuthenticationEventListener;
+import org.apache.guacamole.net.auth.Credentials;
+
+import com.google.inject.Inject;
+
+/**
+ * A Listener that will reactivate or invalidate SAML auth sessions depending on
+ * overall auth success or failure.
+ */
+public class SAMLAuthenticationEventListener extends SSOAuthenticationEventListener {
+
+    /**
+     * Session manager for generating and maintaining unique tokens to
+     * represent the authentication flow of a user who has only partially
+     * authenticated.
+     *
+     * Requires static injection due to the fact that the webapp just calls the
+     * constructor directly when creating new Listeners. The instances will not
+     * be constructed by guice.
+     *
+     * Note that is possible to instead inject an AuthenticationSessionManager
+     * instance directly into the base class, but this results in different
+     * instances of the session manager injected here and in the rest of the
+     * extension, regardless of singleton configuration for the service.
+     */
+    @Inject
+    protected static SAMLAuthenticationSessionManager sessionManager;
+
+    @Override
+    protected String getSessionIdentifier(Credentials credentials) {
+        return AuthenticationProviderService.getSessionIdentifier(credentials);
+    }
+
+    @Override
+    protected void reactivateSession(String sessionIdentifier) {
+        sessionManager.reactivateSession(sessionIdentifier);
+    }
+
+    @Override
+    protected void invalidateSession(String sessionIdentifier) {
+        sessionManager.invalidateSession(sessionIdentifier);
+    }
+
+}

extensions/guacamole-auth-sso/modules/guacamole-auth-sso-saml/src/main/java/org/apache/guacamole/auth/saml/SAMLAuthenticationProviderModule.java

@@ -37,7 +37,7 @@ public class SAMLAuthenticationProviderModule extends AbstractModule {
         bind(SAMLAuthenticationSessionManager.class);
         bind(SAMLService.class);
         
-        requestStaticInjection(AuthenticationEventListener.class);
+        requestStaticInjection(SAMLAuthenticationEventListener.class);
     }
 
 }

extensions/guacamole-auth-sso/modules/guacamole-auth-sso-saml/src/main/resources/guac-manifest.json

@@ -10,7 +10,7 @@
     ],
 
     "listeners" : [
-        "org.apache.guacamole.auth.saml.AuthenticationEventListener"
+        "org.apache.guacamole.auth.saml.SAMLAuthenticationEventListener"
     ],
 
     "css" : [