Merge pull request #57 from Carobit/bugfix/consistent-urlencoding

Bugfix/consistent urlencoding

src/AbstractUrlSigner.php

@@ -36,9 +36,11 @@ public function sign(
 
         $expiration = $this->getExpirationTimestamp($expiration);
 
-        $signature = $this->createSignature($url, $expiration, $signatureKey);
+        $normalizedUrl = $this->getIntendedUrl($url);
 
-        return $this->signUrl($url, $expiration, $signature);
+        $signature = $this->createSignature($normalizedUrl, $expiration, $signatureKey);
+
+        return $this->signUrl($normalizedUrl, $expiration, $signature);
     }
 
     protected function signUrl(string $url, string $expiration, $signature): string

src/BaseUrlSigner.php

@@ -37,9 +37,11 @@ public function sign(
 
         $expiration = $this->getExpirationTimestamp($expiration);
 
-        $signature = $this->createSignature($url, $expiration, $signatureKey);
+        $normalizedUrl = $this->getIntendedUrl($url);
 
-        return $this->signUrl($url, $expiration, $signature);
+        $signature = $this->createSignature($normalizedUrl, $expiration, $signatureKey);
+
+        return $this->signUrl($normalizedUrl, $expiration, $signature);
     }
 
     protected function signUrl(string $url, string $expiration, $signature): string

tests/Md5UrlSignerTest.php

@@ -83,3 +83,27 @@
     expect($this->urlSigner->validate($signedUsingCustomKey, 'custom-key'))->toBeTrue();
     expect($this->urlSigner->validate($signedUsingCustomKey, 'wrong-custom-key'))->toBeFalse();
 });
+
+it('can sign url which has special characters in the query parameters', function ($url) {
+    $expiration = 100;
+
+    $signedUrl = $this->urlSigner->sign($url, $expiration);
+
+    expect($this->urlSigner->validate($signedUrl))->toBeTrue();
+})->with([
+    ['https://myapp.com/?foo=bar baz'],
+    ['https://myapp.com/?foo=bar%20baz'],
+    ['https://myapp.com/?foo=bar@baz.com'],
+]);
+
+it('can sign url which has reserved query parameters', function ($url) {
+    $expiration = 100;
+
+    $signedUrl = $this->urlSigner->sign($url, $expiration);
+
+    expect($this->urlSigner->validate($signedUrl))->toBeTrue();
+})->with([
+    ['https://myapp.com/?foo=bar&expires=100&signature=abc123'],
+    ['https://myapp.com/?foo=bar&expires=100'],
+    ['https://myapp.com/?foo=bar&signature=abc123'],
+]);

tests/Sha256UrlSignerTest.php

@@ -92,3 +92,27 @@
     expect($this->urlSigner->validate($signedUsingCustomKey, 'custom-key'))->toBeTrue();
     expect($this->urlSigner->validate($signedUsingCustomKey, 'wrong-custom-key'))->toBeFalse();
 });
+
+it('can sign url which has special characters in the query parameters', function ($url) {
+    $expiration = 100;
+
+    $signedUrl = $this->urlSigner->sign($url, $expiration);
+
+    expect($this->urlSigner->validate($signedUrl))->toBeTrue();
+})->with([
+    ['https://myapp.com/?foo=bar baz'],
+    ['https://myapp.com/?foo=bar%20baz'],
+    ['https://myapp.com/?foo=bar@baz.com'],
+]);
+
+it('can sign url which has reserved query parameters', function ($url) {
+    $expiration = 100;
+
+    $signedUrl = $this->urlSigner->sign($url, $expiration);
+
+    expect($this->urlSigner->validate($signedUrl))->toBeTrue();
+})->with([
+    ['https://myapp.com/?foo=bar&expires=100&signature=abc123'],
+    ['https://myapp.com/?foo=bar&expires=100'],
+    ['https://myapp.com/?foo=bar&signature=abc123'],
+]);