Merge pull request #46123 from nextcloud/feat/user-password-hash

feat: Allow getting/setting the password hash of a user

2 files changed, 47 insertions, 0 deletions

diff --git a/lib/public/IUser.php b/lib/public/IUser.php
index 2ed2d0d87b2..4ba9a89f064 100644
--- a/lib/public/IUser.php
+++ b/lib/public/IUser.php
@@ -77,6 +77,23 @@ interface IUser {
 	public function setPassword($password, $recoveryPassword = null);
 
 	/**
+	 * Get the password hash of the user
+	 *
+	 * @return ?string the password hash hashed by `\OCP\Security\IHasher::hash()`
+	 * @since 30.0.0
+	 */
+	public function getPasswordHash(): ?string;
+
+	/**
+	 * Set the password hash of the user
+	 *
+	 * @param string $passwordHash the password hash hashed by `\OCP\Security\IHasher::hash()`
+	 * @throws InvalidArgumentException when `$passwordHash` is not a valid hash
+	 * @since 30.0.0
+	 */
+	public function setPasswordHash(string $passwordHash): bool;
+
+	/**
 	 * get the users home folder to mount
 	 *
 	 * @return string
diff --git a/lib/public/User/Backend/IPasswordHashBackend.php b/lib/public/User/Backend/IPasswordHashBackend.php
new file mode 100644
index 00000000000..2525b4e45ea
--- /dev/null
+++ b/lib/public/User/Backend/IPasswordHashBackend.php
@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCP\User\Backend;
+
+use InvalidArgumentException;
+
+/**
+ * @since 30.0.0
+ */
+interface IPasswordHashBackend {
+	/**
+	 * @return ?string the password hash hashed by `\OCP\Security\IHasher::hash()`
+	 * @since 30.0.0
+	 */
+	public function getPasswordHash(string $userId): ?string;
+
+	/**
+	 * @param string $passwordHash the password hash hashed by `\OCP\Security\IHasher::hash()`
+	 * @throws InvalidArgumentException when `$passwordHash` is not a valid hash
+	 * @since 30.0.0
+	 */
+	public function setPasswordHash(string $userId, string $passwordHash): bool;
+}