logger = $logger ?? new NullLogger(); if (!is_string($secret) || strlen($secret) < 64) { throw new Exception("\$secret must be a string with a minimum length of 64 characters. Make one with Taproot\IndieAuth\generateRandomString(64)"); } $this->secret = $secret; $this->path = rtrim($path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR; $this->authCodeTtl = $authCodeTtl ?? self::DEFAULT_AUTH_CODE_TTL; $this->accessTokenTtl = $accessTokenTtl ?? self::DEFAULT_ACCESS_TOKEN_TTL; @mkdir($this->path, 0777, true); if ($cleanUpNow) { $this->deleteExpiredTokens(); } } // LoggerAwareInterface method. public function setLogger(LoggerInterface $logger) { $this->logger = $logger; } // TokenStorageInterface Methods. public function createAuthCode(array $data): ?Token { $authCode = generateRandomString(self::TOKEN_LENGTH); $accessToken = $this->hash($authCode); if (!array_key_exists('valid_until', $data)) { $data['valid_until'] = time() + $this->authCodeTtl; } if (!$this->put($accessToken, $data)) { return null; } return new Token($authCode, $data); } public function exchangeAuthCodeForAccessToken(string $code): ?Token { // Hash the auth code to get the theoretical matching access token filename. $accessToken = $this->hash($code); // Prevent the token file from being read, modified or deleted while we’re working with it. // r+ to allow reading and writing, but to make sure we don’t create the file if it doesn’t // already exist. return $this->withLock($this->getPath($accessToken), 'r+', function ($fp) use ($accessToken) { // Read the file contents. $fileContents = ''; while ($d = fread($fp, 1024)) { $fileContents .= $d; } $data = json_decode($fileContents, true); if (!is_array($data)) { return null; } // Make sure the auth code hasn’t already been redeemed. if ($data['exchanged_at'] ?? false) { return null; } // Make sure the auth code isn’t expired. if (($data['valid_until'] ?? 0) < time()) { return null; } // If the access token is valid, mark it as redeemed and set a new expiry time. $data['exchanged_at'] = time(); if (is_int($data['_access_token_ttl'] ?? null)) { // This access token has a custom TTL, use that. $data['valid_until'] = time() + $data['_access_code_ttl']; } elseif ($this->accessTokenTtl == 0) { // The token should be valid until explicitly revoked. $data['valid_until'] = null; } else { // Use the default TTL. $data['valid_until'] = time() + $this->accessTokenTtl; } // Write the new file contents, truncating afterwards in case the new data is shorter than the old data. $jsonData = json_encode($data); if (rewind($fp) === false) { return null; } if (fwrite($fp, $jsonData) === false) { return null; } if (ftruncate($fp, strlen($jsonData)) === false) { return null; } return new Token($accessToken, $data); }); } public function getAccessToken(string $token): ?Token { $data = $this->get($token); if (!is_array($data)) { return null; } // Check that this is a redeemed access token. if ($data['_redeemed'] ?? false === false) { return null; } // Check that the access token is still valid. valid_until=null means it should live until // explicitly revoked. if (is_int($data['valid_until']) && $data['valid_until'] < time()) { return null; } // The token is valid! return new Token($token, $data); } public function revokeAccessToken(string $token): bool { return $this->delete($token); } // Implementation-Specifc Methods. public function deleteExpiredTokens(): int { $deleted = 0; foreach (new DirectoryIterator($this->path) as $fileInfo) { if ($fileInfo->isFile() && $fileInfo->getExtension() == 'json') { // Only delete files which we can lock. $successfullyDeleted = $this->withLock($fileInfo->getPathname(), 'r', function ($fp) use ($fileInfo) { // Read the file, check expiry date! Only unlink if file is expired. $fileContents = ''; while ($d = fread($fp, 1024)) { $fileContents .= $d; } $data = json_decode($fileContents, true); if (!is_array($data)) { return; } // If valid_until is a valid time, and is in the past, delete the token. if (is_int($data['valid_until'] ?? null) && $data['valid_until'] < time()) { return unlink($fileInfo->getPathname()); } }); if ($successfullyDeleted) { $deleted++; } } } return $deleted; } public function get(string $key): ?array { $path = $this->getPath($key); if (!file_exists($path)) { return null; } return $this->withLock($path, 'r', function ($fp) { $fileContents = ''; while ($data = fread($fp, 1024)) { $fileContents .= $data; } $result = json_decode($fileContents, true); if (is_array($result)) { return $result; } return null; }); } public function put(string $key, array $data): bool { // Ensure that the containing folder exists. @mkdir($this->path, 0777, true); return $this->withLock($this->getPath($key), 'w', function ($fp) use ($data) { return fwrite($fp, json_encode($data)) !== false; }); } public function delete(string $key): bool { $path = $this->getPath($key); if (file_exists($path)) { return $this->withLock($path, 'r', function ($fp) use ($path) { return unlink($path); }); } return false; } public function getPath(string $key): string { // TODO: ensure that the calculated path is a child of $this->path. return $this->path . "$key.json"; } protected function withLock(string $path, string $mode, callable $callback) { $fp = fopen($path, $mode); if ($fp === false) { return false; } // Wait for a lock. if (flock($fp, LOCK_EX)) { $return = null; try { // Perform whatever action on the file pointer. $return = $callback($fp); } finally { // Regardless of what happens, release the lock. flock($fp, LOCK_UN); fclose($fp); } return $return; } // It wasn’t possible to get a lock. return null; } protected function hash(string $token): string { return hash_hmac('sha256', $token, $this->secret); } }