* * @author Christoph Wurst * @author J0WI * @author Morris Jobke * @author Roeland Jago Douma * * @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 OCA\TwoFactorBackupCodes\Service; use OCA\TwoFactorBackupCodes\Db\BackupCode; use OCA\TwoFactorBackupCodes\Db\BackupCodeMapper; use OCA\TwoFactorBackupCodes\Event\CodesGenerated; use OCP\EventDispatcher\IEventDispatcher; use OCP\IUser; use OCP\Security\IHasher; use OCP\Security\ISecureRandom; class BackupCodeStorage { private static $CODE_LENGTH = 16; /** @var BackupCodeMapper */ private $mapper; /** @var IHasher */ private $hasher; /** @var ISecureRandom */ private $random; /** @var IEventDispatcher */ private $eventDispatcher; public function __construct(BackupCodeMapper $mapper, ISecureRandom $random, IHasher $hasher, IEventDispatcher $eventDispatcher) { $this->mapper = $mapper; $this->hasher = $hasher; $this->random = $random; $this->eventDispatcher = $eventDispatcher; } /** * @param IUser $user * @param int $number * @return string[] */ public function createCodes(IUser $user, int $number = 10): array { $result = []; // Delete existing ones $this->mapper->deleteCodes($user); $uid = $user->getUID(); foreach (range(1, min([$number, 20])) as $i) { $code = $this->random->generate(self::$CODE_LENGTH, ISecureRandom::CHAR_HUMAN_READABLE); $dbCode = new BackupCode(); $dbCode->setUserId($uid); $dbCode->setCode($this->hasher->hash($code)); $dbCode->setUsed(0); $this->mapper->insert($dbCode); $result[] = $code; } $this->eventDispatcher->dispatchTyped(new CodesGenerated($user)); return $result; } /** * @param IUser $user * @return bool */ public function hasBackupCodes(IUser $user): bool { $codes = $this->mapper->getBackupCodes($user); return count($codes) > 0; } /** * @param IUser $user * @return array */ public function getBackupCodesState(IUser $user): array { $codes = $this->mapper->getBackupCodes($user); $total = count($codes); $used = 0; array_walk($codes, function (BackupCode $code) use (&$used) { if ((int)$code->getUsed() === 1) { $used++; } }); return [ 'enabled' => $total > 0, 'total' => $total, 'used' => $used, ]; } /** * @param IUser $user * @param string $code * @return bool */ public function validateCode(IUser $user, string $code): bool { $dbCodes = $this->mapper->getBackupCodes($user); foreach ($dbCodes as $dbCode) { if ((int)$dbCode->getUsed() === 0 && $this->hasher->verify($code, $dbCode->getCode())) { $dbCode->setUsed(1); $this->mapper->update($dbCode); return true; } } return false; } public function deleteCodes(IUser $user): void { $this->mapper->deleteCodes($user); } }