From 057d72c8165ea5bcf80c63db36d3ab52668c6681 Mon Sep 17 00:00:00 2001 From: "J. King" Date: Sun, 28 Oct 2018 13:50:57 -0400 Subject: [PATCH] Remove the distinction between internal and external user functionality --- lib/User.php | 164 ++++++++---------------- lib/User/Driver.php | 2 - lib/User/Internal/Driver.php | 48 ++++--- lib/User/Internal/InternalFunctions.php | 49 ------- 4 files changed, 80 insertions(+), 183 deletions(-) delete mode 100644 lib/User/Internal/InternalFunctions.php diff --git a/lib/User.php b/lib/User.php index 2e130345..ad645f88 100644 --- a/lib/User.php +++ b/lib/User.php @@ -6,6 +6,8 @@ declare(strict_types=1); namespace JKingWeb\Arsse; +use JKingWeb\Arsse\User\Internal\Driver as InternalDriver; + class User { public $id = null; @@ -44,30 +46,13 @@ class User { public function auth(string $user, string $password): bool { $prevUser = $this->id ?? null; $this->id = $user; - switch ($this->u->driverFunctions("auth")) { - case User\Driver::FUNC_EXTERNAL: - if (Arsse::$conf->userPreAuth) { - $out = true; - } else { - $out = $this->u->auth($user, $password); - } - if ($out && !Arsse::$db->userExists($user)) { - $this->autoProvision($user, $password); - } - break; - case User\Driver::FUNC_INTERNAL: - if (Arsse::$conf->userPreAuth) { - if (!Arsse::$db->userExists($user)) { - $this->autoProvision($user, $password); - } - $out = true; - } else { - $out = $this->u->auth($user, $password); - } - break; - case User\Driver::FUNCT_NOT_IMPLEMENTED: - $out = false; - break; + if (Arsse::$conf->userPreAuth) { + $out = true; + } else { + $out = $this->u->auth($user, $password); + } + if ($out && !Arsse::$db->userExists($user)) { + $this->autoProvision($user, $password); } if (!$out) { $this->id = $prevUser; @@ -75,118 +60,71 @@ class User { return $out; } - public function driverFunctions(string $function = null) { - return $this->u->driverFunctions($function); - } - public function list(): array { $func = "userList"; - switch ($this->u->driverFunctions($func)) { - case User\Driver::FUNC_EXTERNAL: - // we handle authorization checks for external drivers - if (!$this->authorize("", $func)) { - throw new User\ExceptionAuthz("notAuthorized", ["action" => $func, "user" => ""]); - } - // no break - case User\Driver::FUNC_INTERNAL: - // internal functions handle their own authorization - return $this->u->userList($domain); - case User\Driver::FUNCT_NOT_IMPLEMENTED: - throw new User\ExceptionNotImplemented("notImplemented", ["action" => $func, "user" => $domain]); + if (!$this->authorize("", $func)) { + throw new User\ExceptionAuthz("notAuthorized", ["action" => $func, "user" => ""]); } + return $this->u->userList($domain); } public function exists(string $user): bool { $func = "userExists"; - switch ($this->u->driverFunctions($func)) { - case User\Driver::FUNC_EXTERNAL: - // we handle authorization checks for external drivers - if (!$this->authorize($user, $func)) { - throw new User\ExceptionAuthz("notAuthorized", ["action" => $func, "user" => $user]); - } - $out = $this->u->userExists($user); - if ($out && !Arsse::$db->userExists($user)) { - $this->autoProvision($user, ""); - } - return $out; - case User\Driver::FUNC_INTERNAL: - // internal functions handle their own authorization - return $this->u->userExists($user); - case User\Driver::FUNCT_NOT_IMPLEMENTED: - // throwing an exception here would break all kinds of stuff; we just report that the user exists - return true; + if (!$this->authorize($user, $func)) { + throw new User\ExceptionAuthz("notAuthorized", ["action" => $func, "user" => $user]); } + $out = $this->u->userExists($user); + if (!$this->u instanceof InternalDriver) { + // if an alternative driver doesn't match the internal database, add or remove the user as appropriate + if (!$out && Arsse::$db->userExists($user)) { + Arsse::$db->userRemove($user); + } elseif ($out && !Arsse::$db->userExists($user)) { + $this->autoProvision($user, ""); + } + } + return $out; } public function add($user, $password = null): string { $func = "userAdd"; - switch ($this->u->driverFunctions($func)) { - case User\Driver::FUNC_EXTERNAL: - // we handle authorization checks for external drivers - if (!$this->authorize($user, $func)) { - throw new User\ExceptionAuthz("notAuthorized", ["action" => $func, "user" => $user]); - } - $newPassword = $this->u->userAdd($user, $password); - // if there was no exception and we don't have the user in the internal database, add it - if (!Arsse::$db->userExists($user)) { - $this->autoProvision($user, $newPassword); - } - return $newPassword; - case User\Driver::FUNC_INTERNAL: - // internal functions handle their own authorization - return $this->u->userAdd($user, $password); - case User\Driver::FUNCT_NOT_IMPLEMENTED: - throw new User\ExceptionNotImplemented("notImplemented", ["action" => $func, "user" => $user]); + if (!$this->authorize($user, $func)) { + throw new User\ExceptionAuthz("notAuthorized", ["action" => $func, "user" => $user]); } + $newPassword = $this->u->userAdd($user, $password); + // if there was no exception and we don't have the user in the internal database, add it + if (!$this->u instanceof InternalDriver && !Arsse::$db->userExists($user)) { + $this->autoProvision($user, $newPassword); + } + return $newPassword; } public function remove(string $user): bool { $func = "userRemove"; - switch ($this->u->driverFunctions($func)) { - case User\Driver::FUNC_EXTERNAL: - // we handle authorization checks for external drivers - if (!$this->authorize($user, $func)) { - throw new User\ExceptionAuthz("notAuthorized", ["action" => $func, "user" => $user]); - } - $out = $this->u->userRemove($user); - if ($out && Arsse::$db->userExists($user)) { - // if the user was removed and we have it in our data, remove it there - if (!Arsse::$db->userExists($user)) { - Arsse::$db->userRemove($user); - } - } - return $out; - case User\Driver::FUNC_INTERNAL: - // internal functions handle their own authorization - return $this->u->userRemove($user); - case User\Driver::FUNCT_NOT_IMPLEMENTED: - throw new User\ExceptionNotImplemented("notImplemented", ["action" => $func, "user" => $user]); + if (!$this->authorize($user, $func)) { + throw new User\ExceptionAuthz("notAuthorized", ["action" => $func, "user" => $user]); } + $out = $this->u->userRemove($user); + if ($out && !$this->u instanceof InternalDriver && Arsse::$db->userExists($user)) { + // if the user was removed and we have it in our data, remove it there + Arsse::$db->userRemove($user); + } + return $out; } public function passwordSet(string $user, string $newPassword = null, $oldPassword = null): string { $func = "userPasswordSet"; - switch ($this->u->driverFunctions($func)) { - case User\Driver::FUNC_EXTERNAL: - // we handle authorization checks for external drivers - if (!$this->authorize($user, $func)) { - throw new User\ExceptionAuthz("notAuthorized", ["action" => $func, "user" => $user]); - } - $out = $this->u->userPasswordSet($user, $newPassword, $oldPassword); - if (Arsse::$db->userExists($user)) { - // if the password change was successful and the user exists, set the internal password to the same value - Arsse::$db->userPasswordSet($user, $out); - } else { - // if the user does not exists in the internal database, create it - $this->autoProvision($user, $out); - } - return $out; - case User\Driver::FUNC_INTERNAL: - // internal functions handle their own authorization - return $this->u->userPasswordSet($user, $newPassword); - case User\Driver::FUNCT_NOT_IMPLEMENTED: - throw new User\ExceptionNotImplemented("notImplemented", ["action" => $func, "user" => $user]); + if (!$this->authorize($user, $func)) { + throw new User\ExceptionAuthz("notAuthorized", ["action" => $func, "user" => $user]); } + $out = $this->u->userPasswordSet($user, $newPassword, $oldPassword); + if (!$this->u instanceof InternalDriver && Arsse::$db->userExists($user)) { + // if the password change was successful and the user exists, set the internal password to the same value + Arsse::$db->userPasswordSet($user, $out); + } elseif (!$this->u instanceof InternalDriver){ + // if the user does not exists in the internal database, create it + $this->autoProvision($user, $out); + } + return $out; } protected function autoProvision(string $user, string $password = null): string { diff --git a/lib/User/Driver.php b/lib/User/Driver.php index 7b07dc4e..fa23ef9b 100644 --- a/lib/User/Driver.php +++ b/lib/User/Driver.php @@ -15,8 +15,6 @@ interface Driver { public function __construct(); // returns a human-friendly name for the driver (for display in installer, for example) public static function driverName(): string; - // returns an array (or single queried member of same) of methods defined by this interface and whether the class implements the internal function or a custom version - public function driverFunctions(string $function = null); // authenticates a user against their name and password public function auth(string $user, string $password): bool; // checks whether a user exists diff --git a/lib/User/Internal/Driver.php b/lib/User/Internal/Driver.php index ad3e50d9..25bcc74c 100644 --- a/lib/User/Internal/Driver.php +++ b/lib/User/Internal/Driver.php @@ -7,32 +7,42 @@ declare(strict_types=1); namespace JKingWeb\Arsse\User\Internal; final class Driver implements \JKingWeb\Arsse\User\Driver { - use InternalFunctions; - - protected $db; - protected $functions = [ - "auth" => self::FUNC_INTERNAL, - "userList" => self::FUNC_INTERNAL, - "userExists" => self::FUNC_INTERNAL, - "userAdd" => self::FUNC_INTERNAL, - "userRemove" => self::FUNC_INTERNAL, - "userPasswordSet" => self::FUNC_INTERNAL, - ]; + public function __construct() { + } public static function driverName(): string { return Arsse::$lang->msg("Driver.User.Internal.Name"); } - public function driverFunctions(string $function = null) { - if ($function===null) { - return $this->functions; + public function auth(string $user, string $password): bool { + try { + $hash = Arsse::$db->userPasswordGet($user); + } catch (Exception $e) { + return false; } - if (array_key_exists($function, $this->functions)) { - return $this->functions[$function]; - } else { - return self::FUNC_NOT_IMPLEMENTED; + if ($password==="" && $hash==="") { + return true; } + return password_verify($password, $hash); } - // see InternalFunctions.php for bulk of methods + public function userExists(string $user): bool { + return Arsse::$db->userExists($user); + } + + public function userAdd(string $user, string $password = null): string { + return Arsse::$db->userAdd($user, $password); + } + + public function userRemove(string $user): bool { + return Arsse::$db->userRemove($user); + } + + public function userList(): array { + return Arsse::$db->userList(); + } + + public function userPasswordSet(string $user, string $newPassword = null, string $oldPassword = null): string { + return Arsse::$db->userPasswordSet($user, $newPassword); + } } diff --git a/lib/User/Internal/InternalFunctions.php b/lib/User/Internal/InternalFunctions.php deleted file mode 100644 index e834b3d9..00000000 --- a/lib/User/Internal/InternalFunctions.php +++ /dev/null @@ -1,49 +0,0 @@ -userPasswordGet($user); - } catch (Exception $e) { - return false; - } - if ($password==="" && $hash==="") { - return true; - } - return password_verify($password, $hash); - } - - public function userExists(string $user): bool { - return Arsse::$db->userExists($user); - } - - public function userAdd(string $user, string $password = null): string { - return Arsse::$db->userAdd($user, $password); - } - - public function userRemove(string $user): bool { - return Arsse::$db->userRemove($user); - } - - public function userList(): array { - return Arsse::$db->userList(); - } - - public function userPasswordSet(string $user, string $newPassword = null, string $oldPassword = null): string { - return Arsse::$db->userPasswordSet($user, $newPassword); - } -}