From: Rich Lott / Artful Robot <code.commits@artfulrobot.uk>
Date: Fri, 29 Sep 2023 13:49:55 +0000 (+0100)
Subject: standalone: forgotten password beginnings
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=d58f1c4cd9352b135a4b71ab8bde6695f0746d95;p=civicrm-core.git

standalone: forgotten password beginnings
---

diff --git a/ext/standaloneusers/Civi/Api4/Action/User/SendPasswordReset.php b/ext/standaloneusers/Civi/Api4/Action/User/SendPasswordReset.php
new file mode 100644
index 0000000000..bb0677b362
--- /dev/null
+++ b/ext/standaloneusers/Civi/Api4/Action/User/SendPasswordReset.php
@@ -0,0 +1,121 @@
+<?php
+namespace Civi\Api4\Action\User;
+
+use Civi;
+use Civi\Api4\Generic\Result;
+use API_Exception;
+use Civi\Api4\User;
+use Civi\Api4\MessageTemplate;
+use Civi\Api4\Generic\AbstractAction;
+
+/**
+ * This is designed to be a public API
+ */
+class SendPasswordReset extends AbstractAction {
+
+  /**
+   * Username or email of user to send email for.
+   *
+   * @param string $identifier
+   * @default ''
+   */
+  protected string $identifier;
+
+  public function _run(Result $result) {
+    $endNoSoonerThan = 0.25 + microtime(TRUE);
+
+    $identifier = trim($this->identifier);
+    if (!$identifier) {
+      throw new API_Exception("Missing identifier");
+    }
+
+    $user = User::get(FALSE)
+      ->addSelect('id', 'email', 'username')
+      ->addWhere('is_active', '=', TRUE)
+      ->setLimit(1)
+      ->addWhere(
+        filter_var($identifier, FILTER_VALIDATE_EMAIL) ? 'email' : 'username',
+        '=',
+        $identifier)
+      ->execute()
+      ->first();
+    $userID = $user['id'] ?? 0;
+
+    try {
+      // Allow flood control.
+      $ip = \CRM_Utils_System::ipAddress();
+      $event = \Civi\Core\Event\GenericHookEvent::create([
+        'identifiers' => ["ip:$ip", "user:$userID"],
+        'action'      => 'send_password_reset',
+      ]);
+      \Civi::dispatcher()->dispatch('civi.flood.drip', $event);
+    }
+    catch (\Exception $e) {
+      // If we caught an exception, disable sending.
+      $userID = 0;
+    }
+
+    if ($userID) {
+      $this->sendResetEmail($user);
+    }
+
+    // Ensure we took at least 0.25s. The assumption is that it takes
+    // less than 0.25s to generate and send an email, and so this will
+    // disguise whether an email has been sent or not. It's won't
+    // thwart concerted timing attacks, but in combination with flood
+    // control, it might help.
+    usleep(1000000 * max(0, $endNoSoonerThan - microtime(TRUE)));
+  }
+
+  protected function sendResetEmail(array $user) {
+    // Find the message template
+    $tplID = MessageTemplate::get(FALSE)
+      ->setSelect(['id'])
+      ->addWhere('workflow_name', '=', 'password_reset')
+      ->addWhere('is_default', '=', TRUE)
+      ->addWhere('is_active',  '=', TRUE)
+      ->execute()->first()['id'];
+    if (!$tplID) {
+      // Some sites may deliberately disable this, but it's unusual, so leave a notice in the log.
+      Civi::log()->notice("There is no active, default password_reset message template, which has prevented emailing a reset to {username}", ['username' => $user['username']]);
+      return;
+    }
+    if (!filter_var($user['email'] ?? '', FILTER_VALIDATE_EMAIL)) {
+      Civi::log()->warning("User $user[id] has an invalid email. Failed to send password reset.");
+      return;
+    }
+
+    // Generate a once-use token that expires in 1 hour.
+    // We'll store this on the User record, that way invalidating any previous token that may have been generated.
+    $expires = time() + 60*60;
+    $token = dechex($expires) . substr(preg_replace('@[/+=]+@', '', base64_encode(random_bytes(64))), 0, 32);
+
+    User::update(FALSE)
+      ->setValue('password_reset_token', $token)
+      ->addWhere('id', '=', $user['id'])
+      ->execute();
+
+    list($domainFromName, $domainFromEmail) = \CRM_Core_BAO_Domain::getNameAndEmail(TRUE);
+
+    $resetUrlPlaintext = \CRM_Utils_System::url('civicrm/password-reset', ['token' => $token], TRUE, NULL, FALSE, TRUE);
+    $resetUrlHtml = htmlspecialchars($resetUrlPlaintext);
+    // The template_params are used in the template like {$resetUrlHtml} and {$resetUrlHtml}
+    $params = [
+        'id' => $tplID,
+        'template_params' => compact('resetUrlPlaintext', 'resetUrlHtml'),
+        'from' => "\"$domainFromName\" <$domainFromEmail>",
+        'to_email' => $user['email'],
+        'disable_smarty' => 1,
+      ];
+
+    try {
+      civicrm_api3('MessageTemplate', 'send', $params);
+      Civi::log()->info("Sent password_reset_token MessageTemplate (ID {tplID}) to {to_email} for user {userID}",
+        $params + ['userID' => $user['id']]);
+    }
+    catch (\Exception $e) {
+      Civi::log()->error("Failed to send password_reset_token MessageTemplate (ID {tplID}) to {to_email} for user {userID}",
+        $params + ['userID' => $user['id'], 'exception' => $e]);
+    }
+  }
+}
diff --git a/ext/standaloneusers/Civi/Standalone/Security.php b/ext/standaloneusers/Civi/Standalone/Security.php
index d3b7b9ae92..fbba907fa6 100644
--- a/ext/standaloneusers/Civi/Standalone/Security.php
+++ b/ext/standaloneusers/Civi/Standalone/Security.php
@@ -375,8 +375,29 @@ class Security {
    * @return bool TRUE if it was valid.
    */
   public function checkPasswordResetToken(int $userID, string $token, bool $spend = TRUE): bool {
-    // Coming in next PR!
-    return FALSE;
+    if (!preg_match('/^([a-f0-9]{8})(.{32})$/', $token, $matches)) {
+      Civi::log()->warning("Rejected passwordResetToken with invalid syntax for user $userID.", compact('token'));
+      return FALSE;
+    }
+    $expiry = hexdec($matches[1]);
+    if (time() > $expiry) {
+      Civi::log()->info("Rejected expired passwordResetToken for user $userID");
+      return FALSE;
+    }
+    $matched = User::get(FALSE)
+      ->addWhere('id', '=', $userID)
+      ->addWhere('password_reset_token', '=', $token)
+      ->selectRowCount()
+      ->execute()->countMatched() === 1;
+
+    if ($matched && $spend) {
+      $matched = User::update(FALSE)
+        ->addWhere('id', '=', $userID)
+        ->addValue('password_reset_token', NULL)
+        ->execute();
+    }
+    Civi::log()->info(($matched ? 'Accepted' : 'Rejected') . " passwordResetToken for user $userID");
+    return $matched;
   }
 
 }
diff --git a/ext/standaloneusers/xml/schema/CRM/Standaloneusers/User.xml b/ext/standaloneusers/xml/schema/CRM/Standaloneusers/User.xml
index ac143278b5..1684bced10 100644
--- a/ext/standaloneusers/xml/schema/CRM/Standaloneusers/User.xml
+++ b/ext/standaloneusers/xml/schema/CRM/Standaloneusers/User.xml
@@ -147,12 +147,4 @@
     <comment>The language for the user.</comment>
   </field>
 
-  <field>
-    <name>password_reset_token</name>
-    <type>varchar</type>
-    <required>false</required>
-    <length>40</length>
-    <comment>Holds a pending password reset token.</comment>
-  </field>
-
 </table>