Page MenuHomeWickedGov Phorge
Files F4151808

AuthorizationProviderTest.php
No OneTemporary
Actions

Size
5 KB
Referenced Files
None
Subscribers
None

AuthorizationProviderTest.php
View Options

<?php
namespace MediaWiki\Extension\OAuth\Tests;
use DateTime;
use MediaWiki\Extension\OAuth\AuthorizationProvider\AuthorizationProvider;
use MediaWiki\Extension\OAuth\AuthorizationProvider\Grant\AuthorizationCodeAccessTokens;
use MediaWiki\Extension\OAuth\AuthorizationProvider\Grant\AuthorizationCodeAuthorization;
use MediaWiki\Extension\OAuth\AuthorizationProvider\Grant\ClientCredentials;
use MediaWiki\Extension\OAuth\AuthorizationProvider\Grant\RefreshToken;
use MediaWiki\Extension\OAuth\AuthorizationProvider\IAuthorizationProvider;
use MediaWiki\Extension\OAuth\AuthorizationServerFactory;
use MediaWiki\User\User;
use MediaWikiIntegrationTestCase;
use Psr\Log\NullLogger;
use ReflectionClass;
use Wikimedia\TestingAccessWrapper;
/**
* @covers \MediaWiki\Extension\OAuth\AuthorizationProvider\Grant\AuthorizationCodeAuthorization
* @covers \MediaWiki\Extension\OAuth\AuthorizationProvider\Grant\AuthorizationCodeAccessTokens
* @covers \MediaWiki\Extension\OAuth\AuthorizationProvider\Grant\ClientCredentials
* @covers \MediaWiki\Extension\OAuth\AuthorizationProvider\Grant\RefreshToken
* @group OAuth
* @group Database
*/
class AuthorizationProviderTest extends MediaWikiIntegrationTestCase {
protected function setUp(): void {
parent::setUp();
$this->overrideConfigValues( [
'OAuthSecretKey' => base64_encode( random_bytes( 32 ) )
] );
}
protected function getServer() {
$serverFactory = AuthorizationServerFactory::factory();
return $serverFactory->getAuthorizationServer();
}
protected function getOAuthConfig() {
$services = $this->getServiceContainer();
return $services->getConfigFactory()->makeConfig( 'mwoauth' );
}
/**
* @dataProvider provideGrantsArguments
*/
public function testSettingUser( $class ) {
/** @var IAuthorizationProvider $authorizationProvider */
$authorizationProvider = new $class(
$this->getOAuthConfig(),
$this->getServer(),
new NullLogger()
);
$authReflection = new ReflectionClass( $class );
$userProperty = $authReflection->getProperty( 'user' );
$userProperty->setAccessible( true );
$user = $this->getTestUser()->getUser();
$authorizationProvider->setUser( $user );
$actualValue = $userProperty->getValue( $authorizationProvider );
$this->assertInstanceOf(
User::class, $actualValue,
"Value of user set must be an instance of " . User::class .
", " . get_class( $actualValue ) . " found"
);
$this->assertSame(
$user->getName(), $actualValue->getName(),
"User passed to $class must be the same as the one actually set"
);
}
/**
* @dataProvider provideGrantsArguments
*/
public function testGrants( $class, $grantName, $needsApproval ) {
$server = $this->getServer();
/** @var IAuthorizationProvider $authorizationProvider */
$authorizationProvider = new $class(
$this->getOAuthConfig(),
$server,
new NullLogger()
);
if ( $needsApproval ) {
$this->assertTrue(
$authorizationProvider->needsUserApproval(), "$class must require user approval"
);
} else {
$this->assertFalse(
$authorizationProvider->needsUserApproval(), "$class must not require user approval"
);
}
// Test if the provider enabled corresponding grant on the server
$serverReflection = new ReflectionClass( get_class( $server ) );
$enabledGrantsProp = $serverReflection->getProperty( 'enabledGrantTypes' );
$enabledGrantsProp->setAccessible( true );
$enabledGrants = $enabledGrantsProp->getValue( $server );
// In our case, each class is handling a single grant, so only that grant must be enabled
$this->assertCount( 1, $enabledGrants,
'Authorization server must have exactly one grant enabled' );
$this->assertArrayHasKey(
$grantName, $enabledGrants, "Grant \"$grantName\" must be enabled for $class"
);
}
public static function provideGrantsArguments() {
return [
[ AuthorizationCodeAuthorization::class, 'authorization_code', true ],
[ AuthorizationCodeAccessTokens::class, 'authorization_code', false ],
[ ClientCredentials::class, 'client_credentials', false ],
[ RefreshToken::class, 'refresh_token', false ],
];
}
/**
* @dataProvider provideExpirationInterval
* @param string $global Value for setting
* @param int $expect Expected DateTimeInterval->getTimestamp()
*/
public function testGetGrantExpirationInterval( $global, $expect ) {
$this->overrideConfigValue( 'OAuth2GrantExpirationInterval', $global );
$server = $this->getServer();
/** @var IAuthorizationProvider $authorizationProvider */
$authorizationProvider = $this->getMockBuilder( AuthorizationProvider::class )
->setConstructorArgs( [
$this->getOAuthConfig(),
$server,
new NullLogger()
] )
->getMockForAbstractClass();
$interval = TestingAccessWrapper::newFromObject( $authorizationProvider )
->getGrantExpirationInterval();
// No way to get the interval directly, so add it to a 0 timestamp then extract the timestamp...
$actual = ( new DateTime( '@0' ) )->add( $interval )->getTimestamp();
$this->assertSame( $expect, $actual );
}
/**
* @dataProvider provideExpirationInterval
* @param string $global Value for setting
* @param int $expect Expected DateTimeInterval->getTimestamp()
*/
public function testGetRefreshTokenTTL( $global, $expect ) {
$this->overrideConfigValue( 'OAuth2RefreshTokenTTL', $global );
$server = $this->getServer();
/** @var IAuthorizationProvider $authorizationProvider */
$authorizationProvider = $this->getMockBuilder( AuthorizationProvider::class )
->setConstructorArgs( [
$this->getOAuthConfig(),
$server,
new NullLogger()
] )
->getMockForAbstractClass();
$interval = TestingAccessWrapper::newFromObject( $authorizationProvider )
->getRefreshTokenTTL();
// No way to get the interval directly, so add it to a 0 timestamp then extract the timestamp...
$actual = ( new DateTime( '@0' ) )->add( $interval )->getTimestamp();
$this->assertSame( $expect, $actual );
}
public static function provideExpirationInterval() {
return [
[ 'P30D', 2592000 ],
[ false, 31556995200 ],
[ 'infinity', 31556995200 ],
];
}
}

File Metadata

Mime Type
text/x-php
Expires
Aug 19 2026, 20:07 (7 w, 1 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
d0/b4/faf346fd50154dda8d89818de107
Default Alt Text
AuthorizationProviderTest.php (5 KB)

Event Timeline