571 lines
17 KiB
PHP
571 lines
17 KiB
PHP
<?php declare(strict_types=1);
|
|
|
|
/*
|
|
* This file is part of Composer.
|
|
*
|
|
* (c) Nils Adermann <naderman@naderman.de>
|
|
* Jordi Boggiano <j.boggiano@seld.be>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Composer\Test\Util;
|
|
|
|
use Composer\Downloader\TransportException;
|
|
use Composer\IO\IOInterface;
|
|
use Composer\Test\TestCase;
|
|
use Composer\Util\AuthHelper;
|
|
use Composer\Util\Bitbucket;
|
|
|
|
/**
|
|
* @author Michael Chekin <mchekin@gmail.com>
|
|
*/
|
|
class AuthHelperTest extends TestCase
|
|
{
|
|
/** @var \Composer\IO\IOInterface&\PHPUnit\Framework\MockObject\MockObject */
|
|
private $io;
|
|
|
|
/** @var \Composer\Config&\PHPUnit\Framework\MockObject\MockObject */
|
|
private $config;
|
|
|
|
/** @var AuthHelper */
|
|
private $authHelper;
|
|
|
|
protected function setUp(): void
|
|
{
|
|
$this->io = $this
|
|
->getMockBuilder('Composer\IO\IOInterface')
|
|
->disableOriginalConstructor()
|
|
->getMock();
|
|
|
|
$this->config = $this->getMockBuilder('Composer\Config')->getMock();
|
|
|
|
$this->authHelper = new AuthHelper($this->io, $this->config);
|
|
}
|
|
|
|
public function testAddAuthenticationHeaderWithoutAuthCredentials(): void
|
|
{
|
|
$headers = array(
|
|
'Accept-Encoding: gzip',
|
|
'Connection: close',
|
|
);
|
|
$origin = 'http://example.org';
|
|
$url = 'file://' . __FILE__;
|
|
|
|
$this->io->expects($this->once())
|
|
->method('hasAuthentication')
|
|
->with($origin)
|
|
->willReturn(false);
|
|
|
|
$this->assertSame(
|
|
$headers,
|
|
$this->authHelper->addAuthenticationHeader($headers, $origin, $url)
|
|
);
|
|
}
|
|
|
|
public function testAddAuthenticationHeaderWithBearerPassword(): void
|
|
{
|
|
$headers = array(
|
|
'Accept-Encoding: gzip',
|
|
'Connection: close',
|
|
);
|
|
$origin = 'http://example.org';
|
|
$url = 'file://' . __FILE__;
|
|
$auth = array(
|
|
'username' => 'my_username',
|
|
'password' => 'bearer',
|
|
);
|
|
|
|
$this->expectsAuthentication($origin, $auth);
|
|
|
|
$expectedHeaders = array_merge($headers, array('Authorization: Bearer ' . $auth['username']));
|
|
|
|
$this->assertSame(
|
|
$expectedHeaders,
|
|
$this->authHelper->addAuthenticationHeader($headers, $origin, $url)
|
|
);
|
|
}
|
|
|
|
public function testAddAuthenticationHeaderWithGithubToken(): void
|
|
{
|
|
$headers = array(
|
|
'Accept-Encoding: gzip',
|
|
'Connection: close',
|
|
);
|
|
$origin = 'github.com';
|
|
$url = 'https://api.github.com/';
|
|
$auth = array(
|
|
'username' => 'my_username',
|
|
'password' => 'x-oauth-basic',
|
|
);
|
|
|
|
$this->expectsAuthentication($origin, $auth);
|
|
|
|
$this->io->expects($this->once())
|
|
->method('writeError')
|
|
->with('Using GitHub token authentication', true, IOInterface::DEBUG);
|
|
|
|
$expectedHeaders = array_merge($headers, array('Authorization: token ' . $auth['username']));
|
|
|
|
$this->assertSame(
|
|
$expectedHeaders,
|
|
$this->authHelper->addAuthenticationHeader($headers, $origin, $url)
|
|
);
|
|
}
|
|
|
|
public function testAddAuthenticationHeaderWithGitlabOathToken(): void
|
|
{
|
|
$headers = array(
|
|
'Accept-Encoding: gzip',
|
|
'Connection: close',
|
|
);
|
|
$origin = 'gitlab.com';
|
|
$url = 'https://api.gitlab.com/';
|
|
$auth = array(
|
|
'username' => 'my_username',
|
|
'password' => 'oauth2',
|
|
);
|
|
|
|
$this->expectsAuthentication($origin, $auth);
|
|
|
|
$this->config->expects($this->once())
|
|
->method('get')
|
|
->with('gitlab-domains')
|
|
->willReturn(array($origin));
|
|
|
|
$this->io->expects($this->once())
|
|
->method('writeError')
|
|
->with('Using GitLab OAuth token authentication', true, IOInterface::DEBUG);
|
|
|
|
$expectedHeaders = array_merge($headers, array('Authorization: Bearer ' . $auth['username']));
|
|
|
|
$this->assertSame(
|
|
$expectedHeaders,
|
|
$this->authHelper->addAuthenticationHeader($headers, $origin, $url)
|
|
);
|
|
}
|
|
|
|
public function gitlabPrivateTokenProvider(): array
|
|
{
|
|
return array(
|
|
array('private-token'),
|
|
array('gitlab-ci-token'),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @dataProvider gitlabPrivateTokenProvider
|
|
*
|
|
* @param string $password
|
|
*/
|
|
public function testAddAuthenticationHeaderWithGitlabPrivateToken(string $password): void
|
|
{
|
|
$headers = array(
|
|
'Accept-Encoding: gzip',
|
|
'Connection: close',
|
|
);
|
|
$origin = 'gitlab.com';
|
|
$url = 'https://api.gitlab.com/';
|
|
$auth = array(
|
|
'username' => 'my_username',
|
|
'password' => $password,
|
|
);
|
|
|
|
$this->expectsAuthentication($origin, $auth);
|
|
|
|
$this->config->expects($this->once())
|
|
->method('get')
|
|
->with('gitlab-domains')
|
|
->willReturn(array($origin));
|
|
|
|
$this->io->expects($this->once())
|
|
->method('writeError')
|
|
->with('Using GitLab private token authentication', true, IOInterface::DEBUG);
|
|
|
|
$expectedHeaders = array_merge($headers, array('PRIVATE-TOKEN: ' . $auth['username']));
|
|
|
|
$this->assertSame(
|
|
$expectedHeaders,
|
|
$this->authHelper->addAuthenticationHeader($headers, $origin, $url)
|
|
);
|
|
}
|
|
|
|
public function testAddAuthenticationHeaderWithBitbucketOathToken(): void
|
|
{
|
|
$headers = array(
|
|
'Accept-Encoding: gzip',
|
|
'Connection: close',
|
|
);
|
|
$origin = 'bitbucket.org';
|
|
$url = 'https://bitbucket.org/site/oauth2/authorize';
|
|
$auth = array(
|
|
'username' => 'x-token-auth',
|
|
'password' => 'my_password',
|
|
);
|
|
|
|
$this->expectsAuthentication($origin, $auth);
|
|
|
|
$this->config->expects($this->once())
|
|
->method('get')
|
|
->with('gitlab-domains')
|
|
->willReturn(array());
|
|
|
|
$this->io->expects($this->once())
|
|
->method('writeError')
|
|
->with('Using Bitbucket OAuth token authentication', true, IOInterface::DEBUG);
|
|
|
|
$expectedHeaders = array_merge($headers, array('Authorization: Bearer ' . $auth['password']));
|
|
|
|
$this->assertSame(
|
|
$expectedHeaders,
|
|
$this->authHelper->addAuthenticationHeader($headers, $origin, $url)
|
|
);
|
|
}
|
|
|
|
public function bitbucketPublicUrlProvider(): array
|
|
{
|
|
return array(
|
|
array('https://bitbucket.org/user/repo/downloads/whatever'),
|
|
array('https://bbuseruploads.s3.amazonaws.com/9421ee72-638e-43a9-82ea-39cfaae2bfaa/downloads/b87c59d9-54f3-4922-b711-d89059ec3bcf'),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @dataProvider bitbucketPublicUrlProvider
|
|
*
|
|
* @param string $url
|
|
*/
|
|
public function testAddAuthenticationHeaderWithBitbucketPublicUrl(string $url): void
|
|
{
|
|
$headers = array(
|
|
'Accept-Encoding: gzip',
|
|
'Connection: close',
|
|
);
|
|
$origin = 'bitbucket.org';
|
|
$auth = array(
|
|
'username' => 'x-token-auth',
|
|
'password' => 'my_password',
|
|
);
|
|
|
|
$this->expectsAuthentication($origin, $auth);
|
|
|
|
$this->config->expects($this->once())
|
|
->method('get')
|
|
->with('gitlab-domains')
|
|
->willReturn(array());
|
|
|
|
$this->assertSame(
|
|
$headers,
|
|
$this->authHelper->addAuthenticationHeader($headers, $origin, $url)
|
|
);
|
|
}
|
|
|
|
public function basicHttpAuthenticationProvider(): array
|
|
{
|
|
return array(
|
|
array(
|
|
Bitbucket::OAUTH2_ACCESS_TOKEN_URL,
|
|
'bitbucket.org',
|
|
array(
|
|
'username' => 'x-token-auth',
|
|
'password' => 'my_password',
|
|
),
|
|
),
|
|
array(
|
|
'https://some-api.url.com',
|
|
'some-api.url.com',
|
|
array(
|
|
'username' => 'my_username',
|
|
'password' => 'my_password',
|
|
),
|
|
),
|
|
array(
|
|
'https://gitlab.com',
|
|
'gitlab.com',
|
|
array(
|
|
'username' => 'my_username',
|
|
'password' => 'my_password',
|
|
),
|
|
),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @dataProvider basicHttpAuthenticationProvider
|
|
*
|
|
* @param string $url
|
|
* @param string $origin
|
|
* @param array<string, string|null> $auth
|
|
*
|
|
* @phpstan-param array{username: string|null, password: string|null} $auth
|
|
*/
|
|
public function testAddAuthenticationHeaderWithBasicHttpAuthentication(string $url, string $origin, array $auth): void
|
|
{
|
|
$headers = array(
|
|
'Accept-Encoding: gzip',
|
|
'Connection: close',
|
|
);
|
|
|
|
$this->expectsAuthentication($origin, $auth);
|
|
|
|
$this->config->expects($this->once())
|
|
->method('get')
|
|
->with('gitlab-domains')
|
|
->willReturn(array($origin));
|
|
|
|
$this->io->expects($this->once())
|
|
->method('writeError')
|
|
->with(
|
|
'Using HTTP basic authentication with username "' . $auth['username'] . '"',
|
|
true,
|
|
IOInterface::DEBUG
|
|
);
|
|
|
|
$expectedHeaders = array_merge(
|
|
$headers,
|
|
array('Authorization: Basic ' . base64_encode($auth['username'] . ':' . $auth['password']))
|
|
);
|
|
|
|
$this->assertSame(
|
|
$expectedHeaders,
|
|
$this->authHelper->addAuthenticationHeader($headers, $origin, $url)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @dataProvider bitbucketPublicUrlProvider
|
|
*
|
|
* @param string $url
|
|
*/
|
|
public function testIsPublicBitBucketDownloadWithBitbucketPublicUrl(string $url): void
|
|
{
|
|
$this->assertTrue($this->authHelper->isPublicBitBucketDownload($url));
|
|
}
|
|
|
|
public function testIsPublicBitBucketDownloadWithNonBitbucketPublicUrl(): void
|
|
{
|
|
$this->assertFalse(
|
|
$this->authHelper->isPublicBitBucketDownload(
|
|
'https://bitbucket.org/site/oauth2/authorize'
|
|
)
|
|
);
|
|
}
|
|
|
|
public function testStoreAuthAutomatically(): void
|
|
{
|
|
$origin = 'github.com';
|
|
$storeAuth = true;
|
|
$auth = array(
|
|
'username' => 'my_username',
|
|
'password' => 'my_password',
|
|
);
|
|
|
|
/** @var \Composer\Config\ConfigSourceInterface&\PHPUnit\Framework\MockObject\MockObject $configSource */
|
|
$configSource = $this
|
|
->getMockBuilder('Composer\Config\ConfigSourceInterface')
|
|
->disableOriginalConstructor()
|
|
->getMock();
|
|
|
|
$this->config->expects($this->once())
|
|
->method('getAuthConfigSource')
|
|
->willReturn($configSource);
|
|
|
|
$this->io->expects($this->once())
|
|
->method('getAuthentication')
|
|
->with($origin)
|
|
->willReturn($auth);
|
|
|
|
$configSource->expects($this->once())
|
|
->method('addConfigSetting')
|
|
->with('http-basic.'.$origin, $auth);
|
|
|
|
$this->authHelper->storeAuth($origin, $storeAuth);
|
|
}
|
|
|
|
public function testStoreAuthWithPromptYesAnswer(): void
|
|
{
|
|
$origin = 'github.com';
|
|
$storeAuth = 'prompt';
|
|
$auth = array(
|
|
'username' => 'my_username',
|
|
'password' => 'my_password',
|
|
);
|
|
$answer = 'y';
|
|
$configSourceName = 'https://api.gitlab.com/source';
|
|
|
|
/** @var \Composer\Config\ConfigSourceInterface&\PHPUnit\Framework\MockObject\MockObject $configSource */
|
|
$configSource = $this
|
|
->getMockBuilder('Composer\Config\ConfigSourceInterface')
|
|
->disableOriginalConstructor()
|
|
->getMock();
|
|
|
|
$this->config->expects($this->once())
|
|
->method('getAuthConfigSource')
|
|
->willReturn($configSource);
|
|
|
|
$configSource->expects($this->once())
|
|
->method('getName')
|
|
->willReturn($configSourceName);
|
|
|
|
$this->io->expects($this->once())
|
|
->method('askAndValidate')
|
|
->with(
|
|
'Do you want to store credentials for '.$origin.' in '.$configSourceName.' ? [Yn] ',
|
|
$this->anything(),
|
|
null,
|
|
'y'
|
|
)
|
|
->willReturnCallback(function ($question, $validator, $attempts, $default) use ($answer): string {
|
|
$validator($answer);
|
|
|
|
return $answer;
|
|
});
|
|
|
|
$this->io->expects($this->once())
|
|
->method('getAuthentication')
|
|
->with($origin)
|
|
->willReturn($auth);
|
|
|
|
$configSource->expects($this->once())
|
|
->method('addConfigSetting')
|
|
->with('http-basic.'.$origin, $auth);
|
|
|
|
$this->authHelper->storeAuth($origin, $storeAuth);
|
|
}
|
|
|
|
public function testStoreAuthWithPromptNoAnswer(): void
|
|
{
|
|
$origin = 'github.com';
|
|
$storeAuth = 'prompt';
|
|
$answer = 'n';
|
|
$configSourceName = 'https://api.gitlab.com/source';
|
|
|
|
/** @var \Composer\Config\ConfigSourceInterface&\PHPUnit\Framework\MockObject\MockObject $configSource */
|
|
$configSource = $this
|
|
->getMockBuilder('Composer\Config\ConfigSourceInterface')
|
|
->disableOriginalConstructor()
|
|
->getMock();
|
|
|
|
$this->config->expects($this->once())
|
|
->method('getAuthConfigSource')
|
|
->willReturn($configSource);
|
|
|
|
$configSource->expects($this->once())
|
|
->method('getName')
|
|
->willReturn($configSourceName);
|
|
|
|
$this->io->expects($this->once())
|
|
->method('askAndValidate')
|
|
->with(
|
|
'Do you want to store credentials for '.$origin.' in '.$configSourceName.' ? [Yn] ',
|
|
$this->anything(),
|
|
null,
|
|
'y'
|
|
)
|
|
->willReturnCallback(function ($question, $validator, $attempts, $default) use ($answer): string {
|
|
$validator($answer);
|
|
|
|
return $answer;
|
|
});
|
|
|
|
$this->authHelper->storeAuth($origin, $storeAuth);
|
|
}
|
|
|
|
public function testStoreAuthWithPromptInvalidAnswer(): void
|
|
{
|
|
self::expectException('RuntimeException');
|
|
|
|
$origin = 'github.com';
|
|
$storeAuth = 'prompt';
|
|
$answer = 'invalid';
|
|
$configSourceName = 'https://api.gitlab.com/source';
|
|
|
|
/** @var \Composer\Config\ConfigSourceInterface&\PHPUnit\Framework\MockObject\MockObject $configSource */
|
|
$configSource = $this
|
|
->getMockBuilder('Composer\Config\ConfigSourceInterface')
|
|
->disableOriginalConstructor()
|
|
->getMock();
|
|
|
|
$this->config->expects($this->once())
|
|
->method('getAuthConfigSource')
|
|
->willReturn($configSource);
|
|
|
|
$configSource->expects($this->once())
|
|
->method('getName')
|
|
->willReturn($configSourceName);
|
|
|
|
$this->io->expects($this->once())
|
|
->method('askAndValidate')
|
|
->with(
|
|
'Do you want to store credentials for '.$origin.' in '.$configSourceName.' ? [Yn] ',
|
|
$this->anything(),
|
|
null,
|
|
'y'
|
|
)
|
|
->willReturnCallback(function ($question, $validator, $attempts, $default) use ($answer): string {
|
|
$validator($answer);
|
|
|
|
return $answer;
|
|
});
|
|
|
|
$this->authHelper->storeAuth($origin, $storeAuth);
|
|
}
|
|
|
|
public function testPromptAuthIfNeededGitLabNoAuthChange(): void
|
|
{
|
|
self::expectException('Composer\Downloader\TransportException');
|
|
|
|
$origin = 'gitlab.com';
|
|
|
|
$this->io
|
|
->method('hasAuthentication')
|
|
->with($origin)
|
|
->willReturn(true);
|
|
|
|
$this->io
|
|
->method('getAuthentication')
|
|
->with($origin)
|
|
->willReturn(array(
|
|
'username' => 'gitlab-user',
|
|
'password' => 'gitlab-password',
|
|
));
|
|
|
|
$this->io
|
|
->expects($this->once())
|
|
->method('setAuthentication')
|
|
->with('gitlab.com', 'gitlab-user', 'gitlab-password');
|
|
|
|
$this->config
|
|
->method('get')
|
|
->willReturnMap(array(
|
|
array('github-domains', 0, array()),
|
|
array('gitlab-domains', 0, array('gitlab.com')),
|
|
array('gitlab-token', 0, array('gitlab.com' => array('username' => 'gitlab-user', 'token' => 'gitlab-password'))),
|
|
));
|
|
|
|
$this->authHelper->promptAuthIfNeeded('https://gitlab.com/acme/archive.zip', $origin, 404, 'GitLab requires authentication and it was not provided');
|
|
}
|
|
|
|
/**
|
|
* @param string $origin
|
|
* @param array<string, string|null> $auth
|
|
*
|
|
* @return void
|
|
*
|
|
* @phpstan-param array{username: string|null, password: string|null} $auth
|
|
*/
|
|
private function expectsAuthentication(string $origin, array $auth): void
|
|
{
|
|
$this->io->expects($this->once())
|
|
->method('hasAuthentication')
|
|
->with($origin)
|
|
->willReturn(true);
|
|
|
|
$this->io->expects($this->once())
|
|
->method('getAuthentication')
|
|
->with($origin)
|
|
->willReturn($auth);
|
|
}
|
|
}
|