HashService.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Extbase\Security\Cryptography;
 
use ‪TYPO3\CMS\Core\Crypto\HashService as CoreHashService;
use ‪TYPO3\CMS\Extbase\Security\Exception\InvalidArgumentForHashGenerationException;
use ‪TYPO3\CMS\Extbase\Security\Exception\InvalidHashException;
 
class ‪HashService
{
    public function ‪__construct(protected readonly CoreHashService $hashService) {}
 
    public function ‪generateHmac(string $string): string
    {
        trigger_error(
            __CLASS__ . ' has been marked as deprecated in TYPO3 v13. Use \TYPO3\CMS\Core\Crypto\HashService instead.',
            E_USER_DEPRECATED,
        );
        return $this->hashService->hmac($string, self::class);
    }
 
    public function ‪appendHmac(string $string): string
    {
        trigger_error(
            __CLASS__ . ' has been marked as deprecated in TYPO3 v13. Use \TYPO3\CMS\Core\Crypto\HashService instead.',
            E_USER_DEPRECATED,
        );
        return $this->hashService->appendHmac($string, self::class);
    }
 
    public function ‪validateHmac(string $string, string $hmac): bool
    {
        trigger_error(
            __CLASS__ . ' has been marked as deprecated in TYPO3 v13. Use \TYPO3\CMS\Core\Crypto\HashService instead.',
            E_USER_DEPRECATED,
        );
        return $this->hashService->validateHmac($string, self::class, $hmac);
    }
 
    public function ‪validateAndStripHmac(string $string): string
    {
        trigger_error(
            __CLASS__ . ' has been marked as deprecated in TYPO3 v13. Use \TYPO3\CMS\Core\Crypto\HashService instead.',
            E_USER_DEPRECATED,
        );
 
        if (strlen($string) < 40) {
            throw new ‪InvalidArgumentForHashGenerationException('A hashed string must contain at least 40 characters, the given string was only ' . strlen($string) . ' characters long.', 1320830276);
        }
        $stringWithoutHmac = substr($string, 0, -40);
        if ($this->‪validateHmac($stringWithoutHmac, substr($string, -40)) !== true) {
            throw new ‪InvalidHashException('The given string was not appended with a valid HMAC.', 1320830018);
        }
        return $stringWithoutHmac;
    }
}