GUACAMOLE-1364: Extract common base SSO classes.

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

@@ -30,14 +30,14 @@ import org.apache.guacamole.net.auth.credentials.GuacamoleInvalidCredentialsExce
 import org.apache.guacamole.auth.cas.conf.ConfigurationService;
 import org.apache.guacamole.auth.cas.form.CASTicketField;
 import org.apache.guacamole.auth.cas.ticket.TicketValidationService;
-import org.apache.guacamole.auth.cas.user.CASAuthenticatedUser;
+import org.apache.guacamole.auth.sso.SSOAuthenticationProviderService;
+import org.apache.guacamole.auth.sso.user.SSOAuthenticatedUser;
 import org.apache.guacamole.language.TranslatableMessage;
 
 /**
- * Service providing convenience functions for the CAS AuthenticationProvider
- * implementation.
+ * Service that authenticates Guacamole users by processing CAS tickets.
  */
-public class AuthenticationProviderService {
+public class AuthenticationProviderService implements SSOAuthenticationProviderService {
 
     /**
      * Service for retrieving CAS configuration information.
@@ -51,22 +51,8 @@ public class AuthenticationProviderService {
     @Inject
     private TicketValidationService ticketService;
 
-    /**
-     * Returns an AuthenticatedUser representing the user authenticated by the
-     * given credentials.
-     *
-     * @param credentials
-     *     The credentials to use for authentication.
-     *
-     * @return
-     *     A CASAuthenticatedUser representing the user authenticated by the
-     *     given credentials.
-     *
-     * @throws GuacamoleException
-     *     If an error occurs while authenticating the user, or if access is
-     *     denied.
-     */
-    public CASAuthenticatedUser authenticateUser(Credentials credentials)
+    @Override
+    public SSOAuthenticatedUser authenticateUser(Credentials credentials)
             throws GuacamoleException {
 
         // Pull CAS ticket from request if present
@@ -95,4 +81,9 @@ public class AuthenticationProviderService {
 
     }
 
+    @Override
+    public void shutdown() {
+        // Nothing to clean up
+    }
+    
 }

extensions/guacamole-auth-sso/modules/guacamole-auth-sso-cas/src/main/java/org/apache/guacamole/auth/cas/CASAuthenticationProvider.java

@@ -19,15 +19,7 @@
 
 package org.apache.guacamole.auth.cas;
 
-import com.google.inject.Guice;
-import com.google.inject.Injector;
-import org.apache.guacamole.GuacamoleException;
-import org.apache.guacamole.auth.cas.user.CASAuthenticatedUser;
-import org.apache.guacamole.net.auth.AbstractAuthenticationProvider;
-import org.apache.guacamole.net.auth.AuthenticatedUser;
-import org.apache.guacamole.net.auth.Credentials;
-import org.apache.guacamole.net.auth.TokenInjectingUserContext;
-import org.apache.guacamole.net.auth.UserContext;
+import org.apache.guacamole.auth.sso.SSOAuthenticationProvider;
 
 /**
  * Guacamole authentication backend which authenticates users using an
@@ -35,56 +27,19 @@ import org.apache.guacamole.net.auth.UserContext;
  * provided - only authentication. Storage must be provided by some other
  * extension.
  */
-public class CASAuthenticationProvider extends AbstractAuthenticationProvider {
-
-    /**
-     * Injector which will manage the object graph of this authentication
-     * provider.
-     */
-    private final Injector injector;
-
+public class CASAuthenticationProvider extends SSOAuthenticationProvider {
+    
     /**
      * Creates a new CASAuthenticationProvider that authenticates users
      * against an CAS service
-     *
-     * @throws GuacamoleException
-     *     If a required property is missing, or an error occurs while parsing
-     *     a property.
      */
-    public CASAuthenticationProvider() throws GuacamoleException {
-
-        // Set up Guice injector.
-        injector = Guice.createInjector(
-            new CASAuthenticationProviderModule(this)
-        );
-
+    public CASAuthenticationProvider() {
+        super(AuthenticationProviderService.class, new CASAuthenticationProviderModule());
     }
-
+    
     @Override
     public String getIdentifier() {
         return "cas";
     }
 
-    @Override
-    public AuthenticatedUser authenticateUser(Credentials credentials)
-            throws GuacamoleException {
-
-        // Attempt to authenticate user with given credentials
-        AuthenticationProviderService authProviderService = injector.getInstance(AuthenticationProviderService.class);
-        return authProviderService.authenticateUser(credentials);
-
-    }
-    
-    @Override
-    public UserContext decorate(UserContext context,
-            AuthenticatedUser authenticatedUser, Credentials credentials)
-            throws GuacamoleException {
-        
-        if (!(authenticatedUser instanceof CASAuthenticatedUser))
-            return context;
-        
-        return new TokenInjectingUserContext(context,
-                ((CASAuthenticatedUser) authenticatedUser).getTokens());
-    }
-
 }

extensions/guacamole-auth-sso/modules/guacamole-auth-sso-cas/src/main/java/org/apache/guacamole/auth/cas/CASAuthenticationProviderModule.java

@@ -19,12 +19,8 @@
 
 package org.apache.guacamole.auth.cas;
 
-import org.apache.guacamole.auth.cas.conf.ConfigurationService;
 import com.google.inject.AbstractModule;
-import org.apache.guacamole.GuacamoleException;
-import org.apache.guacamole.environment.Environment;
-import org.apache.guacamole.environment.LocalEnvironment;
-import org.apache.guacamole.net.auth.AuthenticationProvider;
+import org.apache.guacamole.auth.cas.conf.ConfigurationService;
 import org.apache.guacamole.auth.cas.ticket.TicketValidationService;
 
 /**
@@ -32,50 +28,10 @@ import org.apache.guacamole.auth.cas.ticket.TicketValidationService;
  */
 public class CASAuthenticationProviderModule extends AbstractModule {
 
-    /**
-     * Guacamole server environment.
-     */
-    private final Environment environment;
-
-    /**
-     * A reference to the CASAuthenticationProvider on behalf of which this
-     * module has configured injection.
-     */
-    private final AuthenticationProvider authProvider;
-
-    /**
-     * Creates a new CAS authentication provider module which configures
-     * injection for the CASAuthenticationProvider.
-     *
-     * @param authProvider
-     *     The AuthenticationProvider for which injection is being configured.
-     *
-     * @throws GuacamoleException
-     *     If an error occurs while retrieving the Guacamole server
-     *     environment.
-     */
-    public CASAuthenticationProviderModule(AuthenticationProvider authProvider)
-            throws GuacamoleException {
-
-        // Get local environment
-        this.environment = LocalEnvironment.getInstance();
-
-        // Store associated auth provider
-        this.authProvider = authProvider;
-
-    }
-
     @Override
     protected void configure() {
-
-        // Bind core implementations of guacamole-ext classes
-        bind(AuthenticationProvider.class).toInstance(authProvider);
-        bind(Environment.class).toInstance(environment);
-
-        // Bind CAS-specific services
         bind(ConfigurationService.class);
         bind(TicketValidationService.class);
-
     }
 
 }

extensions/guacamole-auth-sso/modules/guacamole-auth-sso-cas/src/main/java/org/apache/guacamole/auth/cas/ticket/TicketValidationService.java

@@ -41,7 +41,7 @@ import org.apache.guacamole.GuacamoleException;
 import org.apache.guacamole.GuacamoleSecurityException;
 import org.apache.guacamole.GuacamoleServerException;
 import org.apache.guacamole.auth.cas.conf.ConfigurationService;
-import org.apache.guacamole.auth.cas.user.CASAuthenticatedUser;
+import org.apache.guacamole.auth.sso.user.SSOAuthenticatedUser;
 import org.apache.guacamole.net.auth.Credentials;
 import org.apache.guacamole.token.TokenName;
 import org.jasig.cas.client.authentication.AttributePrincipal;
@@ -77,7 +77,7 @@ public class TicketValidationService {
      * Provider for AuthenticatedUser objects.
      */
     @Inject
-    private Provider<CASAuthenticatedUser> authenticatedUserProvider;
+    private Provider<SSOAuthenticatedUser> authenticatedUserProvider;
 
     /**
      * Converts the given CAS attribute value object (whose type is variable)
@@ -132,7 +132,7 @@ public class TicketValidationService {
      *     If the ID ticket is not valid or guacamole.properties could
      *     not be parsed.
      */
-    public CASAuthenticatedUser validateTicket(String ticket,
+    public SSOAuthenticatedUser validateTicket(String ticket,
             Credentials credentials) throws GuacamoleException {
 
         // Create a ticket validator that uses the configured CAS URL
@@ -160,6 +160,9 @@ public class TicketValidationService {
         if (username == null)
             throw new GuacamoleSecurityException("No username provided by CAS.");
 
+        // Canonicalize username as lowercase
+        username = username.toLowerCase();
+
         // Update credentials with username provided by CAS for sake of
         // ${GUAC_USERNAME} token
         credentials.setUsername(username);
@@ -196,8 +199,8 @@ public class TicketValidationService {
             }
         });
 
-        CASAuthenticatedUser authenticatedUser = authenticatedUserProvider.get();
-        authenticatedUser.init(username, credentials, tokens, effectiveGroups);
+        SSOAuthenticatedUser authenticatedUser = authenticatedUserProvider.get();
+        authenticatedUser.init(username, credentials, effectiveGroups, tokens);
         return authenticatedUser;
 
     }

extensions/guacamole-auth-sso/modules/guacamole-auth-sso-cas/src/main/java/org/apache/guacamole/auth/cas/user/CASAuthenticatedUser.java

@@ -1,122 +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.cas.user;
-
-import com.google.inject.Inject;
-import java.util.Collections;
-import java.util.Map;
-import java.util.Set;
-import org.apache.guacamole.net.auth.AbstractAuthenticatedUser;
-import org.apache.guacamole.net.auth.AuthenticationProvider;
-import org.apache.guacamole.net.auth.Credentials;
-
-/**
- * An CAS-specific implementation of AuthenticatedUser, associating a
- * username and particular set of credentials with the CAS authentication
- * provider.
- */
-public class CASAuthenticatedUser extends AbstractAuthenticatedUser {
-
-    /**
-     * Reference to the authentication provider associated with this
-     * authenticated user.
-     */
-    @Inject
-    private AuthenticationProvider authProvider;
-
-    /**
-     * The credentials provided when this user was authenticated.
-     */
-    private Credentials credentials;
-    
-    /**
-     * Tokens associated with this authenticated user.
-     */
-    private Map<String, String> tokens;
-
-    /**
-     * The unique identifiers of all user groups which this user is a member of.
-     */
-    private Set<String> effectiveGroups;
-
-    /**
-     * Initializes this AuthenticatedUser using the given username and
-     * credentials, and an empty map of parameter tokens.
-     *
-     * @param username
-     *     The username of the user that was authenticated.
-     *
-     * @param credentials
-     *     The credentials provided when this user was authenticated.
-     */
-    public void init(String username, Credentials credentials) {
-        this.init(username, credentials, Collections.emptyMap(), Collections.emptySet());
-    }
-    
-    /**
-     * Initializes this AuthenticatedUser using the given username,
-     * credentials, and parameter tokens.
-     *
-     * @param username
-     *     The username of the user that was authenticated.
-     *
-     * @param credentials
-     *     The credentials provided when this user was authenticated.
-     * 
-     * @param tokens
-     *     A map of all the name/value pairs that should be available
-     *     as tokens when connections are established with this user.
-     */
-    public void init(String username, Credentials credentials,
-            Map<String, String> tokens, Set<String> effectiveGroups) {
-        this.credentials = credentials;
-        this.tokens = Collections.unmodifiableMap(tokens);
-        this.effectiveGroups = effectiveGroups;
-        setIdentifier(username.toLowerCase());
-    }
-
-    /**
-     * Returns a Map containing the name/value pairs that can be applied
-     * as parameter tokens when connections are established by the user.
-     * 
-     * @return
-     *     A Map containing all of the name/value pairs that can be
-     *     used as parameter tokens by this user.
-     */
-    public Map<String, String> getTokens() {
-        return tokens;
-    }
-
-    @Override
-    public AuthenticationProvider getAuthenticationProvider() {
-        return authProvider;
-    }
-
-    @Override
-    public Credentials getCredentials() {
-        return credentials;
-    }
-
-    @Override
-    public Set<String> getEffectiveUserGroups() {
-        return effectiveGroups;
-    }
-
-}