AnthonySan95\UrlSigner\UrlSigner

Complexity

Total Complexity

7

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	sign()	0	19	2
A	temporarySign()	0	3	1
A	validate()	0	14	3
A	setKeyResolver()	0	5	1

<?php

namespace AnthonySan95\UrlSigner;

use AnthonySan95\UrlSigner\Contracts\UrlSigner as UrlSignerContract;
use AnthonySan95\UrlSigner\Url\Url;
use Illuminate\Support\Arr;
use Illuminate\Support\Carbon;
use Illuminate\Support\InteractsWithTime;


class UrlSigner implements UrlSignerContract {
    use InteractsWithTime;

    /**
     * The encryption key resolver callable.
     *
     * @var callable
     */
    protected $keyResolver;

    /**
     * Create a signed URL.
     *
     * @param  string $url
     * @param  array $parameters
     * @param  \DateTimeInterface|\DateInterval|int $expiration
     * @return string
     * @throws \Throwable
     */
    public function sign($url, $parameters = [], $expiration = null): string {
        $parameters = Arr::wrap($parameters);

        if ($expiration) {
            $parameters = $parameters + ['expires' => $this->availableAt($expiration)];

It seems like $expiration defined by parameter $expiration on line 31 can also be of type object<DateInterval> or object<DateTimeInterface>; however, Illuminate\Support\InteractsWithTime::availableAt() does only seem to accept integer, maybe add an additional type check?

        }

        ksort($parameters);

        $url = new Url($url, $parameters);

        $key = call_user_func($this->keyResolver);

        $url = new Url($url, $parameters + [
                'signature' => hash_hmac('sha256', $url, $key),
            ]);

        return $url;
    }

    /**
     * Create a temporary signed URL.
     *
     * @param  string $url
     * @param  \DateTimeInterface|\DateInterval|int $expiration
     * @param  array $parameters
     * @return string
     * @throws \Throwable
     */
    public function temporarySign($url, $expiration, $parameters = []): string {
        return $this->sign($url, $parameters, $expiration);
    }

    /**
     * Validate a signed url.
     *
     * @param string $url
     *
     * @return bool
     * @throws \Throwable
     */
    public function validate($url) {
        $url = new Url($url);

        $original = rtrim($url->getWithoutQuery() . '?' . Arr::query(
                Arr::except($url->query(), 'signature')

It seems like $url->query() targeting AnthonySan95\UrlSigner\Url\Url::query() can also be of type null or string; however, Illuminate\Support\Arr::except() does only seem to accept array, maybe add an additional type check?

            ), '?');

        $expires = $url->query('expires');

        $signature = hash_hmac('sha256', $original, call_user_func($this->keyResolver));

        return hash_equals($signature, $url->query('signature', '')) &&
            !($expires && Carbon::now()->getTimestamp() > $expires);
    }


    /**
     * Set the encryption key resolver.
     *
     * @param  callable $keyResolver
     * @return $this
     */
    public function setKeyResolver(callable $keyResolver) {
        $this->keyResolver = $keyResolver;

        return $this;
    }
}