Yiisoft\Yii\AuthClient\Signature\HmacSha

Complexity

Total Complexity

4

Size/Duplication

Total Lines	26
Duplicated Lines	0 %

Test Coverage

Coverage

87.5%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	2
A	generateSignature()	0	3	1
A	getName()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\AuthClient\Signature;

use Yiisoft\Yii\AuthClient\Exception\NotSupportedException;

use function function_exists;

/**
 * HmacSha represents 'HMAC SHA' signature method.
 *
 * > **Note:** This class requires PHP "Hash" extension(<https://php.net/manual/en/book.hash.php>).
 */
final class HmacSha extends Signature
{
    /**
     * @var string hash algorithm, e.g. `sha1`, `sha256` and so on.
     *
     * @link https://php.net/manual/ru/function.hash-algos.php
     */
    private string $algorithm;

    public function __construct(string $algorithm)
    {
        if (!function_exists('hash_hmac')) {
            throw new NotSupportedException('PHP "Hash" extension is required.');
        }

        $this->algorithm = $algorithm;
    }

    public function getName(): string
    {
        return 'HMAC-' . strtoupper($this->algorithm);
    }

    public function generateSignature(string $baseString, string $key): string
    {
        return base64_encode(hash_hmac($this->algorithm, $baseString, $key, true));
    }
}