User Tokens

core/Api/UserAPI.class.php

@@ -42,11 +42,29 @@ namespace Api {
       return $this->success;
     }
 
-    protected function insertUser($username, $email, $password) {
+    protected function checkPasswordRequirements($password, $confirmPassword) {
+      if(strcmp($password, $confirmPassword) !== 0) {
+        return $this->createError("The given passwords do not match");
+      } else if(strlen($password) < 6) {
+        return $this->createError("The password should be at least 6 characters long");
+      }
+
+      return true;
+    }
+
+    protected function checkRequirements($username, $password, $confirmPassword) {
+      if(strlen($username) < 5 || strlen($username) > 32) {
+        return $this->createError("The username should be between 5 and 32 characters long");
+      }
+
+      return $this->checkPasswordRequirements($password, $confirmPassword);
+    }
+
+    protected function insertUser($username, $email, $password, $confirmed) {
       $sql = $this->user->getSQL();
       $hash = $this->hashPassword($password);
-      $res = $sql->insert("User", array("name", "password", "email"))
+      $res = $sql->insert("User", array("name", "password", "email", "confirmed"))
-        ->addRow($username, $hash, $email)
+        ->addRow($username, $hash, $email, $confirmed)
         ->returning("uid")
         ->execute();
 
@@ -64,25 +82,6 @@ namespace Api {
       return password_hash($password, PASSWORD_BCRYPT);
     }
 
-    protected function checkToken($token) {
-      $sql = $this->user->getSQL();
-      $res = $sql->select("UserToken.token_type", "User.name", "User.email")
-        ->from("UserToken")
-        ->innerJoin("User", "UserToken.user_id", "User.uid")
-        ->where(new Compare("UserToken.token", $token))
-        ->where(new Compare("UserToken.valid_until", $sql->now(), ">"))
-        ->where(new Compare("UserToken.used", 0))
-        ->execute();
-      $this->lastError = $sql->getLastError();
-      $this->success = ($res !== FALSE);
-
-      if ($this->success && !empty($res)) {
-        return $res[0];
-      }
-
-      return array();
-    }
-
     protected function getUser($id) {
       $sql = $this->user->getSQL();
       $res = $sql->select("User.uid as userId", "User.name", "User.email", "User.registered_at",
@@ -101,11 +100,17 @@ namespace Api {
 
     protected function getMessageTemplate($key) {
       $req = new \Api\Settings\Get($this->user);
-      $this->success = $req->execute(array("key" => $key));
+      $this->success = $req->execute(array("key" => "^($key|mail_enabled)$"));
       $this->lastError = $req->getLastError();
 
       if ($this->success) {
-        return $req->getResult()["settings"][$key] ?? "{{link}}";
+        $settings = $req->getResult()["settings"];
+        $isEnabled = ($settings["mail_enabled"] ?? "0") === "1";
+        if (!$isEnabled) {
+          return $this->createError("Mail is not enabled.");
+        }
+
+        return $settings[$key] ?? "{{link}}";
       }
 
       return $this->success;
@@ -122,6 +127,7 @@ namespace Api\User {
   use Api\VerifyCaptcha;
   use DateTime;
   use Driver\SQL\Condition\Compare;
+  use Driver\SQL\Condition\CondBool;
   use Driver\SQL\Condition\CondIn;
   use Objects\User;
 
@@ -148,12 +154,8 @@ namespace Api\User {
       $password = $this->getParam('password');
       $confirmPassword = $this->getParam('confirmPassword');
 
-      if(strlen($username) < 5 || strlen($username) > 32) {
+      if (!$this->checkRequirements($username, $password, $confirmPassword)) {
-        return $this->createError("The username should be between 5 and 32 characters long");
+        return false;
-      } else if(strcmp($password, $confirmPassword) !== 0) {
-        return $this->createError("The given passwords do not match");
-      } else if(strlen($password) < 6) {
-        return $this->createError("The password should be at least 6 characters long");
       }
 
       if (!$this->userExists($username, $email)) {
@@ -163,7 +165,7 @@ namespace Api\User {
       // prevent duplicate keys
       $email = (!is_null($email) && empty($email)) ? null : $email;
 
-      $id = $this->insertUser($username, $email, $password);
+      $id = $this->insertUser($username, $email, $password, true);
       if ($this->success) {
         $this->result["userId"] = $id;
       }
@@ -375,12 +377,23 @@ namespace Api\User {
         return false;
       }
 
-      //add to DB
+      $messageBody = $this->getMessageTemplate("message_accept_invite");
+      if ($messageBody === false) {
+        return false;
+      }
+
+      // Create user
+      $id = $this->insertUser($username, $email, "", false);
+      if (!$this->success) {
+        return false;
+      }
+
+      // Create Token
       $token = generateRandomString(36);
-      $valid_until = (new DateTime())->modify("+48 hour");
+      $valid_until = (new DateTime())->modify("+7 day");
       $sql = $this->user->getSQL();
-      $res = $sql->insert("UserInvitation", array("username", "email", "token", "valid_until"))
+      $res = $sql->insert("UserToken", array("user_id", "token", "token_type", "valid_until"))
-        ->addRow($username, $email, $token, $valid_until)
+        ->addRow($id, $token, "invite", $valid_until)
         ->execute();
       $this->success = ($res !== FALSE);
       $this->lastError = $sql->getLastError();
@@ -391,40 +404,159 @@ namespace Api\User {
         $settings = $this->user->getConfiguration()->getSettings();
         $baseUrl = htmlspecialchars($settings->getBaseUrl());
         $siteName = htmlspecialchars($settings->getSiteName());
-        $body = $this->getMessageTemplate("message_accept_invite");
 
-        if ($this->success) {
+        $replacements = array(
+          "link" => "$baseUrl/acceptInvite?token=$token",
+          "site_name" => $siteName,
+          "base_url" => $baseUrl,
+          "username" => htmlspecialchars($username)
+        );
 
-          $replacements = array(
+        foreach($replacements as $key => $value) {
-            "link" => "$baseUrl/acceptInvite?token=$token",
+          $messageBody = str_replace("{{{$key}}}", $value, $messageBody);
-            "site_name" => $siteName,
-            "base_url" => $baseUrl,
-            "username" => htmlspecialchars($username)
-          );
-
-          foreach($replacements as $key => $value) {
-            $body = str_replace("{{{$key}}}", $value, $body);
-          }
-
-          $request = new \Api\Mail\Send($this->user);
-          $this->success = $request->execute(array(
-            "to" => $email,
-            "subject" => "[$siteName] Account Invitation",
-            "body" => $body
-          ));
-
-          $this->lastError = $request->getLastError();
         }
 
+        $request = new \Api\Mail\Send($this->user);
+        $this->success = $request->execute(array(
+          "to" => $email,
+          "subject" => "[$siteName] Account Invitation",
+          "body" => $messageBody
+        ));
+
+        $this->lastError = $request->getLastError();
+
         if (!$this->success) {
           $this->lastError = "The invitation was created but the confirmation email could not be sent. " .
             "Please contact the server administration. Reason: " . $this->lastError;
         }
       }
+
       return $this->success;
     }
   }
 
+  class AcceptInvite extends UserAPI {
+    public function __construct($user, $externalCall = false) {
+      parent::__construct($user, $externalCall, array(
+        'token' => new StringType('token', 36),
+        'password' => new StringType('password'),
+        'confirmPassword' => new StringType('confirmPassword'),
+      ));
+    }
+
+    private function updateUser($uid, $password) {
+      $sql = $this->user->getSQL();
+      $res = $sql->update("User")
+        ->set("password", $this->hashPassword($password))
+        ->set("confirmed", true)
+        ->where(new Compare("uid", $uid))
+        ->execute();
+
+      $this->success = ($res !== FALSE);
+      $this->lastError = $sql->getLastError();
+      return $this->success;
+    }
+
+    public function execute($values = array()) {
+      if (!parent::execute($values)) {
+        return false;
+      }
+
+      if ($this->user->isLoggedIn()) {
+        return $this->createError("You are already logged in.");
+      }
+
+      $token = $this->getParam("token");
+      $password = $this->getParam("password");
+      $confirmPassword = $this->getParam("confirmPassword");
+
+      $req = new CheckToken($this->user);
+      $this->success = $req->execute(array("token" => $token));
+      $this->lastError = $req->getLastError();
+
+      if (!$this->success) {
+        return false;
+      }
+
+      $result = $req->getResult();
+      if (strcasecmp($result["token"]["type"], "invite") !== 0) {
+        return $this->createError("Invalid token type");
+      } else if($result["user"]["confirmed"]) {
+        return $this->createError("Your email address is already confirmed.");
+      } else if (!$this->checkPasswordRequirements($password, $confirmPassword)) {
+        return false;
+      } else if (!$this->updateUser($result["user"]["uid"], $password)) {
+        return false;
+      } else {
+
+        // Invalidate token
+        $this->user->getSQL()
+          ->update("UserToken")
+          ->set("used", true)
+          ->where(new Compare("token", $token))
+          ->execute();
+
+        return true;
+      }
+    }
+  }
+
+  class ConfirmEmail extends UserAPI {
+
+    public function __construct($user, $externalCall = false) {
+      parent::__construct($user, $externalCall, array(
+        'token' => new StringType('token', 36)
+      ));
+    }
+
+    private function updateUser($uid) {
+      $sql = $this->user->getSQL();
+      $res = $sql->update("User")
+        ->set("confirmed", true)
+        ->where(new Compare("uid", $uid))
+        ->execute();
+
+      $this->success = ($res !== FALSE);
+      $this->lastError = $sql->getLastError();
+      return $this->success;
+    }
+
+    public function execute($values = array()) {
+      if (!parent::execute($values)) {
+        return false;
+      }
+
+      if ($this->user->isLoggedIn()) {
+        return $this->createError("You are already logged in.");
+      }
+
+      $token = $this->getParam("token");
+
+      $req = new CheckToken($this->user);
+      $this->success = $req->execute(array("token" => $token));
+      $this->lastError = $req->getLastError();
+
+      $result = $req->getResult();
+      if (strcasecmp($result["token"]["type"], "invite") !== 0) {
+        return $this->createError("Invalid token type");
+      } else if($result["user"]["confirmed"]) {
+        return $this->createError("Your email address is already confirmed.");
+      } else if (!$this->updateUser($result["user"]["uid"])) {
+        return false;
+      } else {
+
+        // Invalidate token
+        $this->user->getSQL()
+          ->update("UserToken")
+          ->set("used", true)
+          ->where(new Compare("token", $token))
+          ->execute();
+
+        return true;
+      }
+    }
+  }
+
   class Login extends UserAPI {
 
     private int $startedAt;
@@ -463,7 +595,7 @@ namespace Api\User {
       $stayLoggedIn = $this->getParam('stayLoggedIn');
 
       $sql = $this->user->getSQL();
-      $res = $sql->select("User.uid", "User.password")
+      $res = $sql->select("User.uid", "User.password", "User.confirmed")
         ->from("User")
         ->where(new Compare("User.name", $username))
         ->execute();
@@ -477,8 +609,11 @@ namespace Api\User {
         } else {
           $row = $res[0];
           $uid = $row['uid'];
+          $confirmed = $sql->parseBool($row["confirmed"]);
           if (password_verify($password, $row['password'])) {
-            if (!($this->success = $this->user->createSession($uid, $stayLoggedIn))) {
+            if (!$confirmed) {
+              return $this->createError("Your email address has not been confirmed yet.");
+            } else if (!($this->success = $this->user->createSession($uid, $stayLoggedIn))) {
               return $this->createError("Error creating Session: " . $sql->getLastError());
             } else {
               $this->result["loggedIn"] = true;
@@ -573,17 +708,22 @@ namespace Api\User {
 
       $username = $this->getParam("username");
       $email = $this->getParam('email');
+      $password = $this->getParam("password");
+      $confirmPassword = $this->getParam("confirmPassword");
       if (!$this->userExists($username, $email)) {
         return false;
       }
 
-      $password = $this->getParam("password");
+      if(!$this->checkRequirements($username, $password, $confirmPassword)) {
-      $confirmPassword = $this->getParam("confirmPassword");
+        return false;
-      if (strcmp($password, $confirmPassword) !== 0) {
-        return $this->createError("The given passwords don't match");
       }
 
-      $id = $this->insertUser($username, $email, $password);
+      $messageBody = $this->getMessageTemplate("message_confirm_email");
+      if ($messageBody === false) {
+        return false;
+      }
+
+      $id = $this->insertUser($username, $email, $password, false);
       if ($id === FALSE) {
         return false;
       }
@@ -597,7 +737,6 @@ namespace Api\User {
       $settings = $this->user->getConfiguration()->getSettings();
       $baseUrl = htmlspecialchars($settings->getBaseUrl());
       $siteName = htmlspecialchars($settings->getSiteName());
-      $body = $this->getMessageTemplate("message_confirm_email");
 
       if ($this->success) {
 
@@ -609,14 +748,14 @@ namespace Api\User {
         );
 
         foreach($replacements as $key => $value) {
-          $body = str_replace("{{{$key}}}", $value, $body);
+          $messageBody = str_replace("{{{$key}}}", $value, $messageBody);
         }
 
         $request = new \Api\Mail\Send($this->user);
         $this->success = $request->execute(array(
             "to" => $email,
             "subject" => "[$siteName] E-Mail Confirmation",
-            "body" => $body
+            "body" => $messageBody
         ));
         $this->lastError = $request->getLastError();
       }
@@ -631,12 +770,32 @@ namespace Api\User {
   }
 
   class CheckToken extends UserAPI {
+
     public function __construct($user, $externalCall = false) {
       parent::__construct($user, $externalCall, array(
         'token' => new StringType('token', 36),
       ));
     }
 
+    private function checkToken($token) {
+      $sql = $this->user->getSQL();
+      $res = $sql->select("UserToken.token_type", "User.uid", "User.name", "User.email", "User.confirmed")
+        ->from("UserToken")
+        ->innerJoin("User", "UserToken.user_id", "User.uid")
+        ->where(new Compare("UserToken.token", $token))
+        ->where(new Compare("UserToken.valid_until", $sql->now(), ">"))
+        ->where(new Compare("UserToken.used", 0))
+        ->execute();
+      $this->lastError = $sql->getLastError();
+      $this->success = ($res !== FALSE);
+
+      if ($this->success && !empty($res)) {
+        return $res[0];
+      }
+
+      return array();
+    }
+
     public function execute($values = array()) {
       if (!parent::execute($values)) {
         return false;
@@ -647,8 +806,16 @@ namespace Api\User {
 
       if ($this->success) {
         if (!empty($tokenEntry)) {
-          $this->result["token"] = array("type" => $tokenEntry["token_type"]);
+          $this->result["token"] = array(
-          $this->result["user"] = array("name" => $tokenEntry["name"], "email" => $tokenEntry["email"]);
+            "type" => $tokenEntry["token_type"]
+          );
+
+          $this->result["user"] = array(
+            "name" => $tokenEntry["name"],
+            "email" => $tokenEntry["email"],
+            "confirmed" => $this->user->getSQL()->parseBool($tokenEntry["confirmed"]),
+            "uid" => $tokenEntry["uid"]
+          );
         } else {
           return $this->createError("This token does not exist or is no longer valid");
         }
@@ -785,4 +952,175 @@ namespace Api\User {
       return $this->success;
     }
   }
+
+  class RequestResetPassword extends UserAPI {
+    public function __construct(User $user, $externalCall = false) {
+      $parameters = array(
+        'email' => new Parameter('email', Parameter::TYPE_EMAIL),
+      );
+
+      $settings = $user->getConfiguration()->getSettings();
+      if ($settings->isRecaptchaEnabled()) {
+        $parameters["captcha"] = new StringType("captcha");
+      }
+
+      parent::__construct($user, $externalCall, $parameters);
+    }
+
+    public function execute($values = array()) {
+      if (!parent::execute($values)) {
+        return false;
+      }
+
+      if ($this->user->isLoggedIn()) {
+        return $this->createError("You already logged in.");
+      }
+
+      $settings = $this->user->getConfiguration()->getSettings();
+      if ($settings->isRecaptchaEnabled()) {
+        $captcha = $this->getParam("captcha");
+        $req = new VerifyCaptcha($this->user);
+        if (!$req->execute(array("captcha" => $captcha, "action" => "resetPassword"))) {
+          return $this->createError($req->getLastError());
+        }
+      }
+
+      $messageBody = $this->getMessageTemplate("message_reset_password");
+      if ($messageBody === false) {
+        return false;
+      }
+
+      $email = $this->getParam("email");
+      $user = $this->findUser($email);
+      if ($user === false) {
+        return false;
+      }
+
+      if ($user !== null) {
+        $token = generateRandomString(36);
+        if (!$this->insertToken($user["uid"], $token)) {
+          return false;
+        }
+
+        $baseUrl = htmlspecialchars($settings->getBaseUrl());
+        $siteName = htmlspecialchars($settings->getSiteName());
+
+        $replacements = array(
+          "link" => "$baseUrl/confirmEmail?token=$token",
+          "site_name" => $siteName,
+          "base_url" => $baseUrl,
+          "username" => htmlspecialchars($user["name"])
+        );
+
+        foreach($replacements as $key => $value) {
+          $messageBody = str_replace("{{{$key}}}", $value, $messageBody);
+        }
+
+        $request = new \Api\Mail\Send($this->user);
+        $this->success = $request->execute(array(
+          "to" => $email,
+          "subject" => "[$siteName] Password Reset",
+          "body" => $messageBody
+        ));
+        $this->lastError = $request->getLastError();
+      }
+
+      return $this->success;
+    }
+
+    private function findUser($email) {
+      $sql = $this->user->getSQL();
+      $res = $sql->select("User.uid", "User.name")
+        ->where(new Compare("User.email", $email))
+        ->where(new CondBool("User.confirmed"))
+        ->execute();
+
+      $this->success = ($res !== FALSE);
+      $this->lastError = $sql->getLastError();
+      if ($this->success) {
+        if (empty($res)) {
+          return null;
+        } else {
+          return $res[0];
+        }
+      }
+
+      return $this->success;
+    }
+
+    private function insertToken(int $id, string $token) {
+      $validUntil = (new DateTime())->modify("+1 hour");
+      $sql = $this->user->getSQL();
+      $res = $sql->insert("UserToken", array("user_id", "token", "token_type", "valid_until"))
+        ->addRow($id, $token, "password_reset", $validUntil)
+        ->execute();
+
+      $this->success = ($res !== FALSE);
+      $this->lastError = $sql->getLastError();
+      return $this->success;
+    }
+  }
+
+  class ResetPassword extends UserAPI {
+
+    public function __construct(User $user, $externalCall = false) {
+      parent::__construct($user, $externalCall, array(
+        'token' => new StringType('token', 36),
+        'password' => new StringType('password'),
+        'confirmPassword' => new StringType('confirmPassword'),
+      ));
+    }
+
+    private function updateUser($uid, $password) {
+      $sql = $this->user->getSQL();
+      $res = $sql->update("User")
+        ->set("password", $this->hashPassword($password))
+        ->where(new Compare("uid", $uid))
+        ->execute();
+
+      $this->success = ($res !== FALSE);
+      $this->lastError = $sql->getLastError();
+      return $this->success;
+    }
+
+    public function execute($values = array()) {
+      if (!parent::execute($values)) {
+        return false;
+      }
+
+      if ($this->user->isLoggedIn()) {
+        return $this->createError("You are already logged in.");
+      }
+
+      $token = $this->getParam("token");
+      $password = $this->getParam("password");
+      $confirmPassword = $this->getParam("confirmPassword");
+
+      $req = new CheckToken($this->user);
+      $this->success = $req->execute(array("token" => $token));
+      $this->lastError = $req->getLastError();
+      if (!$this->success) {
+        return false;
+      }
+
+      $result = $req->getResult();
+      if (strcasecmp($result["token"]["type"], "reset_password") !== 0) {
+        return $this->createError("Invalid token type");
+      } else if (!$this->checkPasswordRequirements($password, $confirmPassword)) {
+        return false;
+      } else if (!$this->updateUser($result["user"]["uid"], $password)) {
+        return false;
+      } else {
+
+        // Invalidate token
+        $this->user->getSQL()
+          ->update("UserToken")
+          ->set("used", true)
+          ->where(new Compare("token", $token))
+          ->execute();
+
+        return true;
+      }
+    }
+  }
 }

core/Configuration/CreateDatabase.class.php

@@ -32,6 +32,7 @@ class CreateDatabase {
       ->addString("email", 64, true)
       ->addString("name", 32)
       ->addString("password", 128)
+      ->addBool("confirmed", false)
       ->addInt("language_id", true, 1)
       ->addDateTime("registered_at", false, $sql->currentTimestamp())
       ->primaryKey("uid")
@@ -53,20 +54,13 @@ class CreateDatabase {
       ->primaryKey("uid", "user_id")
       ->foreignKey("user_id", "User", "uid", new CascadeStrategy());
 
-    $queries[] = $sql->createTable("UserInvitation")
-      ->addString("username",32)
-      ->addString("email",32)
-      ->addString("token",36)
-      ->addDateTime("valid_until");
-
     $queries[] = $sql->createTable("UserToken")
       ->addInt("user_id")
       ->addString("token", 36)
-      ->addEnum("token_type", array("password_reset", "email_confirm"))
+      ->addEnum("token_type", array("password_reset", "email_confirm", "invite"))
       ->addDateTime("valid_until")
       ->addBool("used", false)
       ->foreignKey("user_id", "User", "uid", new CascadeStrategy());
-
     $queries[] = $sql->createTable("Group")
       ->addSerial("uid")
       ->addString("name", 32)
@@ -216,7 +210,7 @@ class CreateDatabase {
     return "Hello {{username}},<br>" .
       "You were invited to create an account on {{site_name}}. Please click on the following link to " .
       "confirm your email address and complete your registration by choosing a new password. " .
-      "If you want to decline the invitation, you can simply ignore this email. The link is valid for the next 48 hours:<br><br>" .
+      "If you want to decline the invitation, you can simply ignore this email. The link is valid for the next 7 days:<br><br>" .
       "<a href=\"{{link}}\">{{link}}</a><br><br>" .
       "Best Regards<br>" .
       "{{site_name}} Administration";

core/Objects/User.class.php

@@ -219,7 +219,7 @@ class User extends ApiObject {
     if($this->loggedIn)
       return true;
 
-    $res = $this->sql->select("ApiKey.user_id as uid", "User.name", "User.email",
+    $res = $this->sql->select("ApiKey.user_id as uid", "User.name", "User.email", "User.confirmed",
       "Language.uid as langId", "Language.code as langCode", "Language.name as langName")
       ->from("ApiKey")
       ->innerJoin("User", "ApiKey.user_id", "User.uid")
@@ -235,6 +235,10 @@ class User extends ApiObject {
         $success = false;
       } else {
         $row = $res[0];
+        if (!$this->sql->parseBool($row["confirmed"])) {
+          return false;
+        }
+
         $this->uid = $row['uid'];
         $this->username = $row['name'];
         $this->email = $row['email'];