Skip to content

[Fix] Fixed HMAC validation failure for query params with non url-safe characters #413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
brutal-factories wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[Fix] Fixed HMAC validation failure for query params with non url-safe characters #413

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Utils.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ public static function validateHmac(array $params, string $secret): bool

return hash_equals(
$params['hmac'],
hash_hmac('sha256', self::buildQueryString($params), $secret)
hash_hmac('sha256', urldecode(self::buildQueryString($params)), $secret)
);
}

Expand Down
29 changes: 27 additions & 2 deletions tests/UtilsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ public function testValidHmac()
$url = 'https://123456.ngrok.io/auth/shopify/callback?code=0907a61c0c8d55e99db179b68161bc00&&shop=some-shop.myshopify.com&state=0.6784241404160823&timestamp=1337178173';
$params = Utils::getQueryParams($url);
$secret = 'test-secret';
$params['hmac'] = hash_hmac('sha256', http_build_query($params), $secret);
$params['hmac'] = hash_hmac('sha256', urldecode(http_build_query($params)), $secret);

$this->assertEquals(true, Utils::validateHmac(
$params,
Expand All @@ -161,7 +161,7 @@ public function testInvalidHmac()
$url = 'https://123456.ngrok.io/auth/shopify/callback?code=0907a61c0c8d55e99db179b68161bc00&&shop=some-shop.myshopify.com&state=0.6784241404160823&timestamp=1337178173';
$params = Utils::getQueryParams($url);
$secret = 'test-secret';
$params['hmac'] = hash_hmac('sha256', http_build_query($params), $secret);
$params['hmac'] = hash_hmac('sha256', urldecode(http_build_query($params)), $secret);

// Check with a wrong secret
$this->assertEquals(false, Utils::validateHmac(
Expand All @@ -177,6 +177,31 @@ public function testInvalidHmac()
));
}

public function testHmacOfEncodedUriComponents()
{
$state = base64_encode(json_encode(['id' => '0123456789', 'for' => 'some-shop']));
// phpcs:ignore
$url = 'https://123456.ngrok.io/auth/shopify/callback?code=0907a61c0c8d55e99db179b68161bc00&state=' . $state . '&shop=some-shop.myshopify.com&timestamp=1337178173';
$params = Utils::getQueryParams($url);
$secret = 'test-secret';

$paramsWrong = $params + ['hmac' => hash_hmac('sha256', http_build_query($params), $secret)];
$paramsRight = $params + ['hmac' => hash_hmac('sha256', urldecode(http_build_query($params)), $secret)];

// Check with the encoded version of the URI (wrong)
$this->assertEquals(false, Utils::validateHmac(
$paramsWrong,
$secret
));


// Check with the decoded version of the URI
$this->assertEquals(true, Utils::validateHmac(
$paramsRight,
$secret
));
}

public function testGetValidQueryParams()
{
$params = [
Expand Down
Loading