1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
|
<?php
declare(strict_types=1);
namespace AsyncAws\Core\Tests\Unit\Signer;
use AsyncAws\Core\Credentials\Credentials;
use AsyncAws\Core\Request;
use AsyncAws\Core\RequestContext;
use AsyncAws\Core\Signer\SignerV4;
use AsyncAws\Core\Stream\StringStream;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
class SignerV4Test extends TestCase
{
public function testSign()
{
$signer = new SignerV4('sqs', 'eu-west-1');
$request = new Request('POST', '/foo', ['arg' => 'bar'], ['header' => 'baz'], StringStream::create('body'));
$request->setEndpoint('http://localhost:1234/foo?arg=bar');
$context = new RequestContext(['currentDate' => new \DateTimeImmutable('2020-01-01T00:00:00Z')]);
$credentials = new Credentials('key', 'secret', 'token');
$signer->sign($request, $credentials, $context);
$expectedHeaders = [
'header' => 'baz',
'host' => 'localhost:1234',
'x-amz-security-token' => 'token',
'x-amz-date' => '20200101T000000Z',
'authorization' => 'AWS4-HMAC-SHA256 Credential=key/20200101/eu-west-1/sqs/aws4_request, SignedHeaders=header;host;x-amz-date;x-amz-security-token, Signature=87e3d70ecfaf7655c24284198c90c61da166aea5bbe2eb3fe470634369acb108',
];
self::assertEqualsCanonicalizing($expectedHeaders, $request->getHeaders());
}
public function testPresign()
{
$signer = new SignerV4('sqs', 'eu-west-1');
$request = new Request('POST', '/foo', ['arg' => 'bar'], ['header' => 'baz'], StringStream::create('body'));
$request->setEndpoint('http://localhost:1234/foo?arg=bar');
$context = new RequestContext(['currentDate' => new \DateTimeImmutable('2020-01-01T00:00:00Z')]);
$credentials = new Credentials('key', 'secret', 'token');
$signer->presign($request, $credentials, $context);
$expectedQuery = [
'arg' => 'bar',
'X-Amz-Algorithm' => 'AWS4-HMAC-SHA256',
'X-Amz-Security-Token' => 'token',
'X-Amz-Date' => '20200101T000000Z',
'X-Amz-Expires' => '3600',
'X-Amz-Credential' => 'key/20200101/eu-west-1/sqs/aws4_request',
'X-Amz-SignedHeaders' => 'header;host',
'X-Amz-Signature' => '27d875a8ba472ef2c315e2120e7718c4187b4b07f6b787264858227586c0445a',
];
self::assertEqualsCanonicalizing($expectedQuery, $request->getQuery());
}
/**
* @dataProvider provideRequests
*/
#[DataProvider('provideRequests')]
public function testSignsRequests($rawRequest, $rawExpected)
{
$request = $this->parseRequest($rawRequest);
$signer = new SignerV4('host', 'us-east-1');
$context = new RequestContext(['currentDate' => new \DateTimeImmutable('20110909T233600Z')]);
$credentials = new Credentials('AKIDEXAMPLE', 'wJalrXUtnFEMI/K7MDENG+bPxRfiCYEXAMPLEKEY');
$signer->sign($request, $credentials, $context);
$expected = $this->parseRequest($rawExpected);
self::assertEquals($expected, $request);
}
public static function provideRequests()
{
return [
// POST headers should be signed.
[
"POST / HTTP/1.1\r\nHost: host.foo.com\r\nx-AMZ-date: 20110909T233600Z\r\nZOO:zoobar\r\n\r\n",
"POST / HTTP/1.1\r\nHost: host.foo.com\r\nZOO: zoobar\r\nX-Amz-Date: 20110909T233600Z\r\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=host;x-amz-date;zoo, Signature=b28a4d452e58edf8ff150a9518b6f4135c9960e4724dc3daab4d7ccc26e90b9b\r\n\r\n",
],
// Changing the method should change the signature.
[
"GET / HTTP/1.1\r\nHost: host.foo.com\r\nx-AMZ-date: 20110909T233600Z\r\nZOO:zoobar\r\n\r\n",
"GET / HTTP/1.1\r\nHost: host.foo.com\r\nZOO: zoobar\r\nX-Amz-Date: 20110909T233600Z\r\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=host;x-amz-date;zoo, Signature=287deb2c1249c9c415cb4b3ef74404629fcab56a8e9ec568bff88cf093196e8e\r\n\r\n",
],
// Request with space.
[
"GET /%20/foo HTTP/1.1\r\nHost: host.foo.com\r\n\r\n",
"GET /%20/foo HTTP/1.1\r\nHost: host.foo.com\r\nX-Amz-Date: 20110909T233600Z\r\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=host;x-amz-date, Signature=948b2292a8bcb4510013741d64c5667f75d46dd6c4896ead5d669eb8264ebe1f\r\n\r\n",
],
// Query order key
[
"GET /?a=foo&b=foo HTTP/1.1\r\nHost: host.foo.com\r\n\r\n",
"GET /?a=foo&b=foo HTTP/1.1\r\nHost: host.foo.com\r\nX-Amz-Date: 20110909T233600Z\r\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=host;x-amz-date, Signature=1cfa3132ddd1b16d824aacef668c131d9096fe52e6d5718e20e43a7e47f616c6\r\n\r\n",
],
// POST with body
[
"POST / HTTP/1.1\r\nHost: host.foo.com\r\nContent-Length: 4\r\n\r\nTest",
"POST / HTTP/1.1\r\nHost: host.foo.com\r\nContent-Length: 4\r\nX-Amz-Date: 20110909T233600Z\r\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=host;x-amz-date, Signature=277a7dcbb942ea6290173548feee1df1a7550354dc83e22daf5ffea86a44e0db\r\n\r\nTest",
],
// HTTPS POST headers should be signed.
[
"POST / HTTP/1.1\r\nHost: host.foo.com:443\r\nx-AMZ-date: 20110909T233600Z\r\nZOO:zoobar\r\n\r\n",
"POST / HTTP/1.1\r\nHost: host.foo.com:443\r\nZOO: zoobar\r\nX-Amz-Date: 20110909T233600Z\r\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=host;x-amz-date;zoo, Signature=d02686375a2514d5bcdc0c4609fdeb80a149f559f7bde45c790c23f3bed62c15\r\n\r\n",
],
// HTTPS Changing the method should change the signature.
[
"GET / HTTP/1.1\r\nHost: host.foo.com:443\r\nx-AMZ-date: 20110909T233600Z\r\nZOO:zoobar\r\n\r\n",
"GET / HTTP/1.1\r\nHost: host.foo.com:443\r\nZOO: zoobar\r\nX-Amz-Date: 20110909T233600Z\r\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=host;x-amz-date;zoo, Signature=69c57723eee136a804b6d4b1fd1b4d45ba059e1f758900a6b1301111e1e8c77e\r\n\r\n",
],
// HTTPS Request with space.
[
"GET /%20/foo HTTP/1.1\r\nHost: host.foo.com:443\r\n\r\n",
"GET /%20/foo HTTP/1.1\r\nHost: host.foo.com:443\r\nX-Amz-Date: 20110909T233600Z\r\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=host;x-amz-date, Signature=5a55c5e2f146b167c3026dd5586bb1d85d530b1dd4a9dfe7cf7966eee3e92d2c\r\n\r\n",
],
// HTTPS Query order key
[
"GET /?a=foo&b=foo HTTP/1.1\r\nHost: host.foo.com:443\r\n\r\n",
"GET /?a=foo&b=foo HTTP/1.1\r\nHost: host.foo.com:443\r\nX-Amz-Date: 20110909T233600Z\r\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=host;x-amz-date, Signature=1c3274381ae12d8817336268d7da17672bd57e7348e39b7b9c567280f73742af\r\n\r\n",
],
// HTTPS POST with body
[
"POST / HTTP/1.1\r\nHost: host.foo.com:443\r\nContent-Length: 4\r\n\r\nTest",
"POST / HTTP/1.1\r\nHost: host.foo.com:443\r\nContent-Length: 4\r\nX-Amz-Date: 20110909T233600Z\r\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=host;x-amz-date, Signature=e971be49c79358595ef6214f683ac9c0489d397a5d5d13b361291e751deeca03\r\n\r\nTest",
],
// DateHeader should be kept
[
"POST / HTTP/1.1\r\nHost: host.foo.com:443\r\nx-AMZ-date: 20110909T233600Z\r\nExpires: Thu, 21 May 20 20:54:15 +0200\r\n\r\n",
"POST / HTTP/1.1\r\nHost: host.foo.com:443\r\nexpires:Thu, 21 May 20 20:54:15 +0200\r\nX-Amz-Date: 20110909T233600Z\r\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=expires;host;x-amz-date, Signature=7090e12acc44281b2b46ba195ee1ae09f2e8c81653fcd592abbfbc30e1a5acc6\r\n\r\n",
],
];
}
/**
* @dataProvider provideRequestsWithQueryParams
*/
#[DataProvider('provideRequestsWithQueryParams')]
public function testSignsRequestsWithArrayInQueryParams($rawRequestWithoutQuery, $rawExpected, $queryParams)
{
$request = $this->parseRequest($rawRequestWithoutQuery, $queryParams);
$signer = new SignerV4('host', 'us-east-1');
$context = new RequestContext(['currentDate' => new \DateTimeImmutable('20110909T233600Z')]);
$credentials = new Credentials('AKIDEXAMPLE', 'wJalrXUtnFEMI/K7MDENG+bPxRfiCYEXAMPLEKEY');
$signer->sign($request, $credentials, $context);
$expected = $this->parseRequest($rawExpected, $queryParams);
self::assertEquals($expected, $request);
}
public static function provideRequestsWithQueryParams()
{
return [
// GET Case with array in query params
[
"GET / HTTP/1.1\r\nHost: host.foo.com:443\r\n\r\n",
"GET / HTTP/1.1\r\nHost: host.foo.com:443\r\nX-Amz-Date: 20110909T233600Z\r\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=host;x-amz-date, Signature=7bd9c6fed0473be1f7ea96ff34c7d79e71a92932054a24b4210b3a56e4ab46d3\r\n\r\n",
[
'foos[0]' => '834127',
'foos[1]' => '59',
'foos[2]' => '90123',
'foos[3]' => '4708',
'foos[4]' => '120001',
'foos[5]' => '333',
'foos[6]' => '78005',
'foos[7]' => '2',
'foos[8]' => 'string value',
'foos[9]' => '40617',
'foos[10]' => '715',
],
],
// GET Simple case with query params (copy of one of the cases above from testSignsRequests)
[
"GET / HTTP/1.1\r\nHost: host.foo.com:443\r\n\r\n",
"GET / HTTP/1.1\r\nHost: host.foo.com:443\r\nX-Amz-Date: 20110909T233600Z\r\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=host;x-amz-date, Signature=1c3274381ae12d8817336268d7da17672bd57e7348e39b7b9c567280f73742af\r\n\r\n",
[
'a' => 'foo',
'b' => 'foo',
],
],
];
}
private function parseRequest(string $req, array $queryParams = []): Request
{
$lines = explode("\r\n", $req);
[$method, $path] = explode(' ', array_shift($lines));
$headers = [];
while ('' !== $line = array_shift($lines)) {
[$name, $value] = explode(':', $line, 2);
if (isset($headers[$name])) {
$headers[$name] = $headers[$name] . ',' . $value;
} else {
$headers[$name] = trim($value);
}
}
$req = new Request($method, '/', [], $headers, StringStream::create(implode("\n", $lines)));
$req->setEndpoint('https://' . $headers['Host'] . $path);
// currently the library cannot properly parse query params if they contain arrays, so we need to set them manually
foreach ($queryParams as $k => $v) {
$req->setQueryAttribute($k, $v);
}
// Ensure that the memoized property is filled, so that comparison works consistently.
$req->getEndpoint();
return $req;
}
}
|