Changeset 6424

Timestamp:

Feb 25, 2014, 2:37:04 PM (9 years ago)

Author:

Nicklas Nordborg

Message:

References #1599: Convert authentication plug-in system to an extension point

Avoid calling deprecated methods.

Added OldAuthenticationWrapperFactory for backwards compatibility with old external authentication implementations.

Location:

trunk

Files:

• config/dist/base.config (modified) (1 diff)
• src/clients/jobagent/net/sf/basedb/clients/jobagent/Agent.java (modified) (2 diffs)
• src/clients/jobagent/net/sf/basedb/clients/jobagent/executors/ThreadJobExecutor.java (modified) (2 diffs)
• src/core/core-extensions.xml (modified) (1 diff)
• src/core/net/sf/basedb/core/Install.java (modified) (3 diffs)
• src/core/net/sf/basedb/core/PluginSessionControl.java (modified) (1 diff)
• src/core/net/sf/basedb/core/SessionControl.java (modified) (4 diffs)
• src/core/net/sf/basedb/core/Update.java (modified) (4 diffs)
• src/core/net/sf/basedb/core/authentication/AuthenticationInformation.java (modified) (2 diffs)
• src/core/net/sf/basedb/core/authentication/OldAuthenticationWrapperFactory.java (added)
• src/install/net/sf/basedb/install/Webclient.java (modified) (2 diffs)
• src/test/TestClient.java (modified) (2 diffs)
• src/test/TestUtil.java (modified) (2 diffs)
• src/test/net/sf/basedb/test/TestUtil.java (modified) (2 diffs)
• src/webservices/server/net/sf/basedb/ws/server/SessionService.java (modified) (2 diffs)
• www/login.jsp (modified) (3 diffs)

trunk/config/dist/base.config

@@ -62 +62 @@
 # ======================
 
-# ----------------
-# POP3 mail server
-# ----------------
-#auth.driver         = net.sf.basedb.core.authentication.POP3Authenticator
-#auth.jarpath        =
-#auth.init           = mail.example.com
+# If extra information such as address, email, phone, etc. should
+# be synchronized or not from external authentication managers 
 #auth.synchronize    = 0
+
+# If passwords should be cached locally or not to allow
+# fallback to internal authentication when external authentication
+# system is not responding
 #auth.cachepasswords = 0
+
+# Number of days to cache passwords locally
 #auth.daystocache    = 0
 

trunk/src/clients/jobagent/net/sf/basedb/clients/jobagent/Agent.java

@@ -52 +52 @@
 import net.sf.basedb.core.Project;
 import net.sf.basedb.core.SessionControl;
-
+import net.sf.basedb.core.authentication.LoginRequest;
 import net.sf.basedb.util.SocketUtil;
 import net.sf.basedb.util.Values;
@@ -892 +892 @@
     {
       log.info("Logging in as user: " + login);
-      sc.login(login, password, "Job agent running on host " + getServerName());
+      LoginRequest loginRequest = new LoginRequest(login, password);
+      loginRequest.setComment("Job agent running on host " + getServerName());
+      sc.login(loginRequest);
     }
     return sc;

trunk/src/clients/jobagent/net/sf/basedb/clients/jobagent/executors/ThreadJobExecutor.java

@@ -36 +36 @@
 import net.sf.basedb.core.Project;
 import net.sf.basedb.core.SessionControl;
+import net.sf.basedb.core.authentication.LoginRequest;
 import net.sf.basedb.core.plugin.Response;
 import net.sf.basedb.core.signal.SignalReceiver;
@@ -177 +178 @@
       sc = Application.newSessionControl("net.sf.basedb.clients.jobagent", 
         SocketUtil.getLocalHost().toString(), null);
-      sc.login(login, password, loginComment);
+      LoginRequest loginRequest = new LoginRequest(login, password);
+      loginRequest.setComment(loginComment);
+      sc.login(loginRequest);
       dc = sc.newDbControl();
       Job job = Job.getById(dc, jobId);

trunk/src/core/core-extensions.xml

@@ -247 +247 @@
     </action-factory>
   </extension>
+  
+  <extension 
+    id="net.sf.basedb.core.authentication.old-auth-manager"
+    extends="net.sf.basedb.core.authentication-manager"
+    >
+    <about>
+      <name>Old authentication manager</name>
+      <description>
+        Wrapper implementation for supporting the old external
+        authentication style. The implemention is only enabled if
+        the 'auth.driver' settings exists in 'base.config'.
+      </description>
+    </about>
+    <index>999</index>
+    <action-factory>
+      <factory-class>net.sf.basedb.core.authentication.OldAuthenticationWrapperFactory</factory-class>
+    </action-factory>
+  </extension>
 
   <!-- 

trunk/src/core/net/sf/basedb/core/Install.java

@@ -25 +25 @@
 package net.sf.basedb.core;
 
+import net.sf.basedb.core.authentication.LoginRequest;
 import net.sf.basedb.core.data.BioPlateEventTypeData;
 import net.sf.basedb.core.data.BioPlateTypeData;
@@ -64 +65 @@
 import net.sf.basedb.core.data.PluginTypeData;
 import net.sf.basedb.core.hibernate.SchemaGenerator;
-
 import net.sf.basedb.core.SessionControl;
 import net.sf.basedb.core.DbControl;
-
 import net.sf.basedb.util.FileUtil;
 import net.sf.basedb.util.Values;
@@ -227 +226 @@
       // Now that we have a root user let's create a session 
       sessionControl = Application.newSessionControl( null, null, null );
-      sessionControl.login(rootLogin, rootPassword, "InitDBSessionId");
+      LoginRequest loginRequest = new LoginRequest(rootLogin, rootPassword);
+      loginRequest.setComment("InitDBSessionId");
+      sessionControl.login(loginRequest);
   
       progressStep++;

trunk/src/core/net/sf/basedb/core/PluginSessionControl.java

@@ -64 +64 @@
   */
   @Override
+  @Deprecated
   public synchronized void login(String login, String password, String comment) 
     throws ItemNotFoundException, PermissionDeniedException, InvalidPasswordException, BaseException

trunk/src/core/net/sf/basedb/core/SessionControl.java

@@ -430 +430 @@
     if (userData == null)
     {
-      throw new ItemNotFoundException("User[login="+login+"]");
+      throw new ItemNotFoundException("The user with login '" + login + "' is not known to BASE.");
     }
     if (userData.isRemoved())
     {
-      throw new PermissionDeniedException("The account has been flagged for deletion: User[login="+login+"]");  
+      throw new PermissionDeniedException("The user with login '" + login + "' is flagged for deletion.");  
     }
     if (userData.isDisabled())
     {
-      throw new PermissionDeniedException("The account has been disabled: User[login="+login+"]");  
+      throw new PermissionDeniedException("The user with login '" + login + "' is disabled.");  
     }
     Date expirationDate = userData.getExpirationDate();
@@ -450 +450 @@
     if (cryptedPassword == null || !User.checkPassword(password, cryptedPassword))
     {
-      throw new InvalidPasswordException("User[login="+login+"]");
+      throw new InvalidPasswordException("The password for login '" + login + "' is not correct.");
     }
     
@@ -491 +491 @@
     catch (net.sf.basedb.core.authentication.UnknownLoginException ex)
     {
-      throw new ItemNotFoundException("User[login="+loginRequest.getLogin()+"]", ex);
+      throw new ItemNotFoundException("The user with login '" + loginRequest.getLogin() + "' is not known to BASE.", ex);
     }
     catch (net.sf.basedb.core.authentication.InvalidPasswordException ex)
     {
-      throw new InvalidPasswordException("User[login="+loginRequest.getLogin()+"]", ex);
+      throw new InvalidPasswordException("The password for login '" + loginRequest.getLogin() + "' is not correct.", ex);
     }
     catch (net.sf.basedb.core.authentication.AuthenticationException ex)
@@ -508 +508 @@
     if (info == null) return null;
 
+    // Load user information, first try 'id' and then 'login'
     UserData userData = context.getUserByExternalId(info.id);
+    if (userData == null)
+    {
+      userData = context.getUserByLogin(info.login);
+    }
     if (userData == null) 
     {

trunk/src/core/net/sf/basedb/core/Update.java

@@ -45 +45 @@
 
 
+
+import net.sf.basedb.core.authentication.LoginRequest;
 import net.sf.basedb.core.data.AnnotatableData;
 import net.sf.basedb.core.data.AnnotationSetData;
@@ -241 +243 @@
       // Test root user account
       SessionControl sc = Application.newSessionControl(null, null, null);
-      sc.login(rootLogin, rootPassword, null);
+      LoginRequest loginRequest = new LoginRequest(rootLogin, rootPassword);
+      sc.login(loginRequest);
       if (sc.getLoggedInUserId() != SystemItems.getId(User.ROOT))
       {
@@ -522 +525 @@
       // Test root user account
       SessionControl sc = Application.newSessionControl(null, null, null);
-      sc.login(rootLogin, rootPassword, null);
+      LoginRequest loginRequest = new LoginRequest(rootLogin, rootPassword);
+      sc.login(loginRequest);
       if (sc.getLoggedInUserId() != SystemItems.getId(User.ROOT))
       {
@@ -1059 +1063 @@
       // Test root user account
       SessionControl sc = Application.newSessionControl(null, null, null);
-      sc.login(rootLogin, rootPassword, "Upgrading to BASE 3");
+      LoginRequest loginRequest = new LoginRequest(rootLogin, rootPassword);
+      loginRequest.setComment("Upgrading to BASE 3");
+      sc.login(loginRequest);
       if (sc.getLoggedInUserId() != SystemItems.getId(User.ROOT))
       {

trunk/src/core/net/sf/basedb/core/authentication/AuthenticationInformation.java

@@ -25 +25 @@
 /**
   Objects of this class are returned by the 
-  {@link Authenticator#authenticate(String,String)}
+  {@link AuthenticationManager#authenticate()}
   method and contains information about the authenticated
   user. The only required fields are {@link #id} and {@link #login}.
@@ -32 +32 @@
   <p>
   If the implementation supports extra information, ie. the call to
-  {@link Authenticator#supportsExtraInformation()}
+  {@link AuthenticationManager#supportsExtraInformation()}
   returns TRUE, the other fields may also contain information.
   

trunk/src/install/net/sf/basedb/install/Webclient.java

@@ -35 +35 @@
 import net.sf.basedb.core.BaseException;
 import net.sf.basedb.core.ItemNotFoundException;
+import net.sf.basedb.core.authentication.LoginRequest;
 import net.sf.basedb.plugins.HelpImporter;
 import net.sf.basedb.util.extensions.xml.PluginInfo;
@@ -93 +94 @@
     Application.start(false);
     SessionControl sc = Application.newSessionControl(null, null, null);
-    sc.login(login, password, "Installing web client");
+    LoginRequest loginRequest = new LoginRequest(login, password);
+    loginRequest.setComment("Installing web client");
+    sc.login(loginRequest);
     
     DbControl dc = sc.newDbControl();

trunk/src/test/TestClient.java

@@ -22 +22 @@
 */
 import net.sf.basedb.core.*;
+import net.sf.basedb.core.authentication.LoginRequest;
 
 import java.util.Date;
@@ -204 +205 @@
       Client c = Client.getById(dc, id);
       SessionControl sc = Application.newSessionControl(c.getExternalId(), null, null);
-      sc.login(TestUtil.getLogin(), TestUtil.getPassword(), "Running test program");
+      LoginRequest loginRequest = new LoginRequest(TestUtil.getLogin(), TestUtil.getPassword());
+      loginRequest.setComment("Running test program");
+      sc.login(loginRequest);
       sc.logout();
       write("--Login/logout OK");

trunk/src/test/TestUtil.java

@@ -28 +28 @@
 import net.sf.basedb.core.Permission;
 import net.sf.basedb.core.Version;
+import net.sf.basedb.core.authentication.LoginRequest;
 
 import java.io.File;
@@ -188 +189 @@
     throws BaseException
   {
-    sc.login(login, password, "Running test program");
+    LoginRequest loginRequest = new LoginRequest(login, password);
+    loginRequest.setComment("Running test program");
+    sc.login(loginRequest);
   }
 

trunk/src/test/net/sf/basedb/test/TestUtil.java

@@ -37 +37 @@
 import net.sf.basedb.core.DbControl;
 import net.sf.basedb.core.SessionControl;
+import net.sf.basedb.core.authentication.LoginRequest;
 
 /**
@@ -165 +166 @@
   {
     write("--Logging in as: " + login + "\n");
-    getSessionControl().login(login, password, "Running test program");
+    LoginRequest loginRequest = new LoginRequest(login, password);
+    loginRequest.setComment("Running test program");
+    getSessionControl().login(loginRequest);
   }
 

trunk/src/webservices/server/net/sf/basedb/ws/server/SessionService.java

@@ -24 +24 @@
 import net.sf.basedb.core.Application;
 import net.sf.basedb.core.SessionControl;
+import net.sf.basedb.core.authentication.LoginRequest;
 import net.sf.basedb.info.VersionInfo;
 
@@ -65 +66 @@
   {
     SessionControl sc = getSessionControl(ID);
-    sc.login(login, password, comment);
+    LoginRequest loginRequest = new LoginRequest(login, password);
+    loginRequest.setComment(comment);
+    sc.login(loginRequest);
     return ID;
   }

trunk/www/login.jsp

@@ -36 +36 @@
 <%@ page pageEncoding="UTF-8" session="false"
   import="net.sf.basedb.core.*"
+  import="net.sf.basedb.core.authentication.LoginRequest"
   import="net.sf.basedb.clients.web.Base"
   import="net.sf.basedb.clients.web.WebException"
@@ -59 +60 @@
     {
       if (sc.isLoggedIn()) sc.logout();
-      sc.login(login, password, null);
+      LoginRequest loginRequest = new LoginRequest(login, password);
+      sc.login(loginRequest);
     }
     catch (LoginException ex)
@@ -69 +71 @@
     {
       errorTitle = "Login not found";
-      errorMessage = Values.formatMessage(
-        "The user with login {1} is not a registered user for BASE.",
-        HTML.encodeTags(login)
-      );
+      errorMessage = ex.getMessage();
     }
     catch (InvalidPasswordException ex)
     {
       errorTitle = "Invalid password";
-      errorMessage = Values.formatMessage(
-        "The password for login {1} is not correct.",
-        HTML.encodeTags(login)
-      );
+      errorMessage = ex.getMessage();
     }
     catch (PermissionDeniedException ex)
     {
       errorTitle = "Permission denied";
-      errorMessage = Values.formatMessage(
-        "You do not have permission to log in to BASE.<br>"+ex.getMessage(),
-        HTML.encodeTags(login)
-      );
+      errorMessage = ex.getMessage();
     }