Skip to content

Fix registry auth to send base64url-encoded X-Registry-Auth header #105

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

Merged
clue merged 1 commit into from
Oct 18, 2026
Merged

Fix registry auth to send base64url-encoded X-Registry-Auth header #105

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
4 changes: 2 additions & 2 deletions src/Client.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1614,7 +1614,7 @@ private function json($data)
*
* Description from Docker's docs (see links):
*
* AuthConfig, set as the X-Registry-Auth header, is currently a Base64
* AuthConfig, set as the X-Registry-Auth header, is currently a base64url
* encoded (JSON) string with the following structure:
* ```
* {"username": "string", "password": "string", "email": "string", "serveraddress" : "string", "auth": ""}
Expand All @@ -1632,7 +1632,7 @@ private function authHeaders($registryAuth)
{
$headers = array();
if ($registryAuth !== null) {
$headers['X-Registry-Auth'] = base64_encode($this->json($registryAuth));
$headers['X-Registry-Auth'] = strtr(base64_encode($this->json($registryAuth)), '+/', '-_');
}

return $headers;
Expand Down
14 changes: 13 additions & 1 deletion tests/ClientTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -573,7 +573,6 @@ public function testImagePushStream()

public function testImagePushCustomRegistry()
{
// TODO: verify headers
$auth = array();
$json = array();
$stream = $this->getMockBuilder('React\Stream\ReadableStreamInterface')->getMock();
Expand All @@ -585,6 +584,19 @@ public function testImagePushCustomRegistry()
$this->expectPromiseResolveWith($json, $this->client->imagePush('123', 'test', 'demo.acme.com:5000', $auth));
}

public function testImagePushWithRegistryAuth()
{
$auth = array('username' => 'user', 'password' => 'p>ss?word!');
$json = array();
$stream = $this->getMockBuilder('React\Stream\ReadableStreamInterface')->getMock();

$this->browser->expects($this->once())->method('requestStreaming')->with('POST', 'images/123/push', array('X-Registry-Auth' => 'eyJ1c2VybmFtZSI6InVzZXIiLCJwYXNzd29yZCI6InA-c3M_d29yZCEifQ=='))->willReturn(\React\Promise\resolve($this->createResponseJsonStream($json)));
$this->streamingParser->expects($this->once())->method('parseJsonStream')->willReturn($stream);
$this->streamingParser->expects($this->once())->method('deferredStream')->with($stream)->willReturn(\React\Promise\resolve($json));

$this->expectPromiseResolveWith($json, $this->client->imagePush('123', null, null, $auth));
}

public function testImageTag()
{
$this->expectRequestFlow('post', 'images/123/tag?repo=test', $this->createResponse(), 'expectEmpty');
Expand Down