* @author Lukas Reschke * @author Roeland Jago Douma * * @license AGPL-3.0 * * This code is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License, version 3, * as published by the Free Software Foundation. * * 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, version 3, * along with this program. If not, see * */ namespace OC\Security\CSRF; use OC\Security\CSRF\TokenStorage\SessionStorage; /** * Class CsrfTokenManager is the manager for all CSRF token related activities. * * @package OC\Security\CSRF */ class CsrfTokenManager { private SessionStorage $sessionStorage; private ?CsrfToken $csrfToken = null; public function __construct( private CsrfTokenGenerator $tokenGenerator, SessionStorage $storageInterface, ) { $this->sessionStorage = $storageInterface; } /** * Returns the current CSRF token, if none set it will create a new one. */ public function getToken(): CsrfToken { if (!\is_null($this->csrfToken)) { return $this->csrfToken; } if ($this->sessionStorage->hasToken()) { $value = $this->sessionStorage->getToken(); } else { $value = $this->tokenGenerator->generateToken(); $this->sessionStorage->setToken($value); } $this->csrfToken = new CsrfToken($value); return $this->csrfToken; } /** * Invalidates any current token and sets a new one. */ public function refreshToken(): CsrfToken { $value = $this->tokenGenerator->generateToken(); $this->sessionStorage->setToken($value); $this->csrfToken = new CsrfToken($value); return $this->csrfToken; } /** * Remove the current token from the storage. */ public function removeToken(): void { $this->csrfToken = null; $this->sessionStorage->removeToken(); } /** * Verifies whether the provided token is valid. */ public function isTokenValid(CsrfToken $token): bool { if (!$this->sessionStorage->hasToken()) { return false; } return hash_equals( $this->sessionStorage->getToken(), $token->getDecryptedValue() ); } }