Merge pull request #41017 from nextcloud/fix/move-token-iprovider-to-ocp

Move IToken and IProvider::getToken to OCP

5 files changed, 37 insertions, 135 deletions

diff --git a/lib/private/Authentication/Exceptions/ExpiredTokenException.php b/lib/private/Authentication/Exceptions/ExpiredTokenException.php
index 0dc92b45920..15069313712 100644
--- a/lib/private/Authentication/Exceptions/ExpiredTokenException.php
+++ b/lib/private/Authentication/Exceptions/ExpiredTokenException.php
@@ -27,17 +27,19 @@ namespace OC\Authentication\Exceptions;
 
 use OC\Authentication\Token\IToken;
 
-class ExpiredTokenException extends InvalidTokenException {
-	/** @var IToken */
-	private $token;
-
-	public function __construct(IToken $token) {
-		parent::__construct();
-
-		$this->token = $token;
+/**
+ * @deprecated 28.0.0 use {@see \OCP\Authentication\Exceptions\ExpiredTokenException} instead
+ */
+class ExpiredTokenException extends \OCP\Authentication\Exceptions\ExpiredTokenException {
+	public function __construct(
+		IToken $token,
+	) {
+		parent::__construct($token);
 	}
 
 	public function getToken(): IToken {
-		return $this->token;
+		$token = parent::getToken();
+		/** @var IToken $token We know that we passed OC interface from constructor */
+		return $token;
 	}
 }
diff --git a/lib/private/Authentication/Exceptions/InvalidTokenException.php b/lib/private/Authentication/Exceptions/InvalidTokenException.php
index acaabff6b88..7de6e1522fa 100644
--- a/lib/private/Authentication/Exceptions/InvalidTokenException.php
+++ b/lib/private/Authentication/Exceptions/InvalidTokenException.php
@@ -24,7 +24,8 @@ declare(strict_types=1);
  */
 namespace OC\Authentication\Exceptions;
 
-use Exception;
-
-class InvalidTokenException extends Exception {
+/**
+ * @deprecated 28.0.0 use OCP version instead
+ */
+class InvalidTokenException extends \OCP\Authentication\Exceptions\InvalidTokenException {
 }
diff --git a/lib/private/Authentication/Exceptions/WipeTokenException.php b/lib/private/Authentication/Exceptions/WipeTokenException.php
index 1c60ab9da78..25b7cb74359 100644
--- a/lib/private/Authentication/Exceptions/WipeTokenException.php
+++ b/lib/private/Authentication/Exceptions/WipeTokenException.php
@@ -27,17 +27,19 @@ namespace OC\Authentication\Exceptions;
 
 use OC\Authentication\Token\IToken;
 
-class WipeTokenException extends InvalidTokenException {
-	/** @var IToken */
-	private $token;
-
-	public function __construct(IToken $token) {
-		parent::__construct();
-
-		$this->token = $token;
+/**
+ * @deprecated 28.0.0 use {@see \OCP\Authentication\Exceptions\WipeTokenException} instead
+ */
+class WipeTokenException extends \OCP\Authentication\Exceptions\WipeTokenException {
+	public function __construct(
+		IToken $token,
+	) {
+		parent::__construct($token);
 	}
 
 	public function getToken(): IToken {
-		return $this->token;
+		$token = parent::getToken();
+		/** @var IToken $token We know that we passed OC interface from constructor */
+		return $token;
 	}
 }
diff --git a/lib/private/Authentication/Token/IToken.php b/lib/private/Authentication/Token/IToken.php
index 5ca4eaea843..eb172f33396 100644
--- a/lib/private/Authentication/Token/IToken.php
+++ b/lib/private/Authentication/Token/IToken.php
@@ -26,109 +26,10 @@ declare(strict_types=1);
  */
 namespace OC\Authentication\Token;
 
-use JsonSerializable;
+use OCP\Authentication\Token\IToken as OCPIToken;
 
-interface IToken extends JsonSerializable {
-	public const TEMPORARY_TOKEN = 0;
-	public const PERMANENT_TOKEN = 1;
-	public const WIPE_TOKEN = 2;
-	public const DO_NOT_REMEMBER = 0;
-	public const REMEMBER = 1;
-
-	/**
-	 * Get the token ID
-	 *
-	 * @return int
-	 */
-	public function getId(): int;
-
-	/**
-	 * Get the user UID
-	 *
-	 * @return string
-	 */
-	public function getUID(): string;
-
-	/**
-	 * Get the login name used when generating the token
-	 *
-	 * @return string
-	 */
-	public function getLoginName(): string;
-
-	/**
-	 * Get the (encrypted) login password
-	 *
-	 * @return string|null
-	 */
-	public function getPassword();
-
-	/**
-	 * Get the timestamp of the last password check
-	 *
-	 * @return int
-	 */
-	public function getLastCheck(): int;
-
-	/**
-	 * Set the timestamp of the last password check
-	 *
-	 * @param int $time
-	 */
-	public function setLastCheck(int $time);
-
-	/**
-	 * Get the authentication scope for this token
-	 *
-	 * @return string
-	 */
-	public function getScope(): string;
-
-	/**
-	 * Get the authentication scope for this token
-	 *
-	 * @return array
-	 */
-	public function getScopeAsArray(): array;
-
-	/**
-	 * Set the authentication scope for this token
-	 *
-	 * @param array $scope
-	 */
-	public function setScope($scope);
-
-	/**
-	 * Get the name of the token
-	 * @return string
-	 */
-	public function getName(): string;
-
-	/**
-	 * Get the remember state of the token
-	 *
-	 * @return int
-	 */
-	public function getRemember(): int;
-
-	/**
-	 * Set the token
-	 *
-	 * @param string $token
-	 */
-	public function setToken(string $token);
-
-	/**
-	 * Set the password
-	 *
-	 * @param string $password
-	 */
-	public function setPassword(string $password);
-
-	/**
-	 * Set the expiration time of the token
-	 *
-	 * @param int|null $expires
-	 */
-	public function setExpires($expires);
+/**
+ * @deprecated 28.0.0 use {@see \OCP\Authentication\Token\IToken} instead
+ */
+interface IToken extends OCPIToken {
 }
diff --git a/lib/private/Authentication/Token/PublicKeyToken.php b/lib/private/Authentication/Token/PublicKeyToken.php
index 45335e17c31..b77a856589d 100644
--- a/lib/private/Authentication/Token/PublicKeyToken.php
+++ b/lib/private/Authentication/Token/PublicKeyToken.php
@@ -137,10 +137,8 @@ class PublicKeyToken extends Entity implements INamedToken, IWipeableToken {
 
 	/**
 	 * Get the (encrypted) login password
-	 *
-	 * @return string|null
 	 */
-	public function getPassword() {
+	public function getPassword(): ?string {
 		return parent::getPassword();
 	}
 
@@ -165,10 +163,8 @@ class PublicKeyToken extends Entity implements INamedToken, IWipeableToken {
 
 	/**
 	 * Get the timestamp of the last password check
-	 *
-	 * @param int $time
 	 */
-	public function setLastCheck(int $time) {
+	public function setLastCheck(int $time): void {
 		parent::setLastCheck($time);
 	}
 
@@ -191,7 +187,7 @@ class PublicKeyToken extends Entity implements INamedToken, IWipeableToken {
 		return $scope;
 	}
 
-	public function setScope($scope) {
+	public function setScope(array|string|null $scope): void {
 		if (is_array($scope)) {
 			parent::setScope(json_encode($scope));
 		} else {
@@ -211,15 +207,15 @@ class PublicKeyToken extends Entity implements INamedToken, IWipeableToken {
 		return parent::getRemember();
 	}
 
-	public function setToken(string $token) {
+	public function setToken(string $token): void {
 		parent::setToken($token);
 	}
 
-	public function setPassword(string $password = null) {
+	public function setPassword(string $password = null): void {
 		parent::setPassword($password);
 	}
 
-	public function setExpires($expires) {
+	public function setExpires($expires): void {
 		parent::setExpires($expires);
 	}