* * @author Arthur Schiwon * * @license GNU AGPL version 3 or any later version * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see . * */ namespace OC\Security\VerificationToken; use OCP\AppFramework\Utility\ITimeFactory; use OCP\BackgroundJob\IJobList; use OCP\IConfig; use OCP\IUser; use OCP\Security\ICrypto; use OCP\Security\ISecureRandom; use OCP\Security\VerificationToken\InvalidTokenException; use OCP\Security\VerificationToken\IVerificationToken; use function json_encode; class VerificationToken implements IVerificationToken { protected const TOKEN_LIFETIME = 60 * 60 * 24 * 7; /** @var IConfig */ private $config; /** @var ICrypto */ private $crypto; /** @var ITimeFactory */ private $timeFactory; /** @var ISecureRandom */ private $secureRandom; /** @var IJobList */ private $jobList; public function __construct( IConfig $config, ICrypto $crypto, ITimeFactory $timeFactory, ISecureRandom $secureRandom, IJobList $jobList ) { $this->config = $config; $this->crypto = $crypto; $this->timeFactory = $timeFactory; $this->secureRandom = $secureRandom; $this->jobList = $jobList; } /** * @throws InvalidTokenException */ protected function throwInvalidTokenException(int $code): void { throw new InvalidTokenException($code); } public function check(string $token, ?IUser $user, string $subject, string $passwordPrefix = '', bool $expiresWithLogin = false): void { if ($user === null || !$user->isEnabled()) { $this->throwInvalidTokenException(InvalidTokenException::USER_UNKNOWN); } $encryptedToken = $this->config->getUserValue($user->getUID(), 'core', $subject, null); if ($encryptedToken === null) { $this->throwInvalidTokenException(InvalidTokenException::TOKEN_NOT_FOUND); } try { $decryptedToken = $this->crypto->decrypt($encryptedToken, $passwordPrefix.$this->config->getSystemValueString('secret')); } catch (\Exception $e) { // Retry with empty secret as a fallback for instances where the secret might not have been set by accident try { $decryptedToken = $this->crypto->decrypt($encryptedToken, $passwordPrefix); } catch (\Exception $e2) { $this->throwInvalidTokenException(InvalidTokenException::TOKEN_DECRYPTION_ERROR); } } $splitToken = explode(':', $decryptedToken); if (count($splitToken) !== 2) { $this->throwInvalidTokenException(InvalidTokenException::TOKEN_INVALID_FORMAT); } if ($splitToken[0] < ($this->timeFactory->getTime() - self::TOKEN_LIFETIME) || ($expiresWithLogin && $user->getLastLogin() > $splitToken[0])) { $this->throwInvalidTokenException(InvalidTokenException::TOKEN_EXPIRED); } if (!hash_equals($splitToken[1], $token)) { $this->throwInvalidTokenException(InvalidTokenException::TOKEN_MISMATCH); } } public function create(IUser $user, string $subject, string $passwordPrefix = ''): string { $token = $this->secureRandom->generate( 21, ISecureRandom::CHAR_DIGITS. ISecureRandom::CHAR_LOWER. ISecureRandom::CHAR_UPPER ); $tokenValue = $this->timeFactory->getTime() .':'. $token; $encryptedValue = $this->crypto->encrypt($tokenValue, $passwordPrefix . $this->config->getSystemValueString('secret')); $this->config->setUserValue($user->getUID(), 'core', $subject, $encryptedValue); $jobArgs = json_encode([ 'userId' => $user->getUID(), 'subject' => $subject, 'pp' => $passwordPrefix, 'notBefore' => $this->timeFactory->getTime() + self::TOKEN_LIFETIME * 2, // multiply to provide a grace period ]); $this->jobList->add(CleanUpJob::class, $jobArgs); return $token; } public function delete(string $token, IUser $user, string $subject): void { $this->config->deleteUserValue($user->getUID(), 'core', $subject); } }