Yiisoft\Yii\AuthClient\Signature\Signature

Complexity

Total Complexity

3

Size/Duplication

Total Lines	37
Duplicated Lines	0 %

Test Coverage

Coverage

80%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	verify()	0	8	3

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\AuthClient\Signature;

/**
 * BaseMethod is a base class for the OAuth signature methods.
 */
abstract class Signature
{
    /**
     * Return the canonical name of the Signature Method.
     *
     * @return string method name.
     */
    abstract public function getName(): string;

    /**
     * Verifies given OAuth request.
     *
     * @param string $signature signature to be verified.
     * @param string $baseString signature base string.
     * @param string $key signature key.
     *
     * @return bool success.
     */
    public function verify(string $signature, string $baseString, string $key): bool
    {
        $expectedSignature = $this->generateSignature($baseString, $key);
        if (empty($signature) || empty($expectedSignature)) {
            return false;
        }

        return strcmp($expectedSignature, $signature) === 0;
    }

    /**
     * Generates OAuth request signature.
     *
     * @param string $baseString signature base string.
     * @param string $key signature key.
     *
     * @return string signature string.
     */
    abstract public function generateSignature(string $baseString, string $key): string;
}