3 namespace MediaWiki\Session
;
12 * @covers MediaWiki\Session\BotPasswordSessionProvider
14 class BotPasswordSessionProviderTest
extends MediaWikiTestCase
{
18 private function getProvider( $name = null, $prefix = null ) {
19 global $wgSessionProviders;
23 'sessionCookieName' => $name,
24 'sessionCookieOptions' => [],
26 if ( $prefix !== null ) {
27 $params['sessionCookieOptions']['prefix'] = $prefix;
30 if ( !$this->config
) {
31 $this->config
= new \
HashConfig( [
32 'CookiePrefix' => 'wgCookiePrefix',
33 'EnableBotPasswords' => true,
34 'BotPasswordsDatabase' => false,
35 'SessionProviders' => $wgSessionProviders +
[
36 'MediaWiki\\Session\\BotPasswordSessionProvider' => [
37 'class' => 'MediaWiki\\Session\\BotPasswordSessionProvider',
38 'args' => [ $params ],
43 $manager = new SessionManager( [
44 'config' => new \
MultiConfig( [ $this->config
, \RequestContext
::getMain()->getConfig() ] ),
45 'logger' => new \Psr\Log\NullLogger
,
46 'store' => new TestBagOStuff
,
49 return $manager->getProvider( 'MediaWiki\\Session\\BotPasswordSessionProvider' );
52 protected function setUp() {
55 $this->setMwGlobals( [
56 'wgEnableBotPasswords' => true,
57 'wgBotPasswordsDatabase' => false,
58 'wgCentralIdLookupProvider' => 'local',
59 'wgGrantPermissions' => [
60 'test' => [ 'read' => true ],
65 public function addDBDataOnce() {
66 $passwordFactory = new \
PasswordFactory();
67 $passwordFactory->init( \RequestContext
::getMain()->getConfig() );
68 // A is unsalted MD5 (thus fast) ... we don't care about security here, this is test only
69 $passwordFactory->setDefaultType( 'A' );
70 $pwhash = $passwordFactory->newFromPlaintext( 'foobaz' );
72 $userId = \CentralIdLookup
::factory( 'local' )->centralIdFromName( 'UTSysop' );
74 $dbw = wfGetDB( DB_MASTER
);
77 [ 'bp_user' => $userId, 'bp_app_id' => 'BotPasswordSessionProvider' ],
84 'bp_app_id' => 'BotPasswordSessionProvider',
85 'bp_password' => $pwhash->toString(),
86 'bp_token' => 'token!',
87 'bp_restrictions' => '{"IPAddresses":["127.0.0.0/8"]}',
88 'bp_grants' => '["test"]',
94 public function testConstructor() {
96 $provider = new BotPasswordSessionProvider();
97 $this->fail( 'Expected exception not thrown' );
98 } catch ( \InvalidArgumentException
$ex ) {
100 'MediaWiki\\Session\\BotPasswordSessionProvider::__construct: priority must be specified',
106 $provider = new BotPasswordSessionProvider( [
107 'priority' => SessionInfo
::MIN_PRIORITY
- 1
109 $this->fail( 'Expected exception not thrown' );
110 } catch ( \InvalidArgumentException
$ex ) {
112 'MediaWiki\\Session\\BotPasswordSessionProvider::__construct: Invalid priority',
118 $provider = new BotPasswordSessionProvider( [
119 'priority' => SessionInfo
::MAX_PRIORITY +
1
121 $this->fail( 'Expected exception not thrown' );
122 } catch ( \InvalidArgumentException
$ex ) {
124 'MediaWiki\\Session\\BotPasswordSessionProvider::__construct: Invalid priority',
129 $provider = new BotPasswordSessionProvider( [
132 $priv = \TestingAccessWrapper
::newFromObject( $provider );
133 $this->assertSame( 40, $priv->priority
);
134 $this->assertSame( '_BPsession', $priv->sessionCookieName
);
135 $this->assertSame( [], $priv->sessionCookieOptions
);
137 $provider = new BotPasswordSessionProvider( [
139 'sessionCookieName' => null,
141 $priv = \TestingAccessWrapper
::newFromObject( $provider );
142 $this->assertSame( '_BPsession', $priv->sessionCookieName
);
144 $provider = new BotPasswordSessionProvider( [
146 'sessionCookieName' => 'Foo',
147 'sessionCookieOptions' => [ 'Bar' ],
149 $priv = \TestingAccessWrapper
::newFromObject( $provider );
150 $this->assertSame( 'Foo', $priv->sessionCookieName
);
151 $this->assertSame( [ 'Bar' ], $priv->sessionCookieOptions
);
154 public function testBasics() {
155 $provider = $this->getProvider();
157 $this->assertTrue( $provider->persistsSessionID() );
158 $this->assertFalse( $provider->canChangeUser() );
160 $this->assertNull( $provider->newSessionInfo() );
161 $this->assertNull( $provider->newSessionInfo( 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' ) );
164 public function testProvideSessionInfo() {
165 $provider = $this->getProvider();
166 $request = new \FauxRequest
;
167 $request->setCookie( '_BPsession', 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', 'wgCookiePrefix' );
169 if ( !defined( 'MW_API' ) ) {
170 $this->assertNull( $provider->provideSessionInfo( $request ) );
171 define( 'MW_API', 1 );
174 $info = $provider->provideSessionInfo( $request );
175 $this->assertInstanceOf( 'MediaWiki\\Session\\SessionInfo', $info );
176 $this->assertSame( 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', $info->getId() );
178 $this->config
->set( 'EnableBotPasswords', false );
179 $this->assertNull( $provider->provideSessionInfo( $request ) );
180 $this->config
->set( 'EnableBotPasswords', true );
182 $this->assertNull( $provider->provideSessionInfo( new \FauxRequest
) );
185 public function testNewSessionInfoForRequest() {
186 $provider = $this->getProvider();
187 $user = \User
::newFromName( 'UTSysop' );
188 $request = $this->getMock( 'FauxRequest', [ 'getIP' ] );
189 $request->expects( $this->any() )->method( 'getIP' )
190 ->will( $this->returnValue( '127.0.0.1' ) );
191 $bp = \BotPassword
::newFromUser( $user, 'BotPasswordSessionProvider' );
193 $session = $provider->newSessionForRequest( $user, $bp, $request );
194 $this->assertInstanceOf( 'MediaWiki\\Session\\Session', $session );
196 $this->assertEquals( $session->getId(), $request->getSession()->getId() );
197 $this->assertEquals( $user->getName(), $session->getUser()->getName() );
199 $this->assertEquals( [
200 'centralId' => $bp->getUserCentralId(),
201 'appId' => $bp->getAppId(),
202 'token' => $bp->getToken(),
203 'rights' => [ 'read' ],
204 ], $session->getProviderMetadata() );
206 $this->assertEquals( [ 'read' ], $session->getAllowedUserRights() );
209 public function testCheckSessionInfo() {
210 $logger = new \
TestLogger( true );
211 $provider = $this->getProvider();
212 $provider->setLogger( $logger );
214 $user = \User
::newFromName( 'UTSysop' );
215 $request = $this->getMock( 'FauxRequest', [ 'getIP' ] );
216 $request->expects( $this->any() )->method( 'getIP' )
217 ->will( $this->returnValue( '127.0.0.1' ) );
218 $bp = \BotPassword
::newFromUser( $user, 'BotPasswordSessionProvider' );
221 'provider' => $provider,
222 'id' => 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',
223 'userInfo' => UserInfo
::newFromUser( $user, true ),
224 'persisted' => false,
226 'centralId' => $bp->getUserCentralId(),
227 'appId' => $bp->getAppId(),
228 'token' => $bp->getToken(),
231 $dataMD = $data['metadata'];
233 foreach ( array_keys( $data['metadata'] ) as $key ) {
234 $data['metadata'] = $dataMD;
235 unset( $data['metadata'][$key] );
236 $info = new SessionInfo( SessionInfo
::MIN_PRIORITY
, $data );
237 $metadata = $info->getProviderMetadata();
239 $this->assertFalse( $provider->refreshSessionInfo( $info, $request, $metadata ) );
241 [ LogLevel
::INFO
, 'Session "{session}": Missing metadata: {missing}' ]
242 ], $logger->getBuffer() );
243 $logger->clearBuffer();
246 $data['metadata'] = $dataMD;
247 $data['metadata']['appId'] = 'Foobar';
248 $info = new SessionInfo( SessionInfo
::MIN_PRIORITY
, $data );
249 $metadata = $info->getProviderMetadata();
250 $this->assertFalse( $provider->refreshSessionInfo( $info, $request, $metadata ) );
252 [ LogLevel
::INFO
, 'Session "{session}": No BotPassword for {centralId} {appId}' ],
253 ], $logger->getBuffer() );
254 $logger->clearBuffer();
256 $data['metadata'] = $dataMD;
257 $data['metadata']['token'] = 'Foobar';
258 $info = new SessionInfo( SessionInfo
::MIN_PRIORITY
, $data );
259 $metadata = $info->getProviderMetadata();
260 $this->assertFalse( $provider->refreshSessionInfo( $info, $request, $metadata ) );
262 [ LogLevel
::INFO
, 'Session "{session}": BotPassword token check failed' ],
263 ], $logger->getBuffer() );
264 $logger->clearBuffer();
266 $request2 = $this->getMock( 'FauxRequest', [ 'getIP' ] );
267 $request2->expects( $this->any() )->method( 'getIP' )
268 ->will( $this->returnValue( '10.0.0.1' ) );
269 $data['metadata'] = $dataMD;
270 $info = new SessionInfo( SessionInfo
::MIN_PRIORITY
, $data );
271 $metadata = $info->getProviderMetadata();
272 $this->assertFalse( $provider->refreshSessionInfo( $info, $request2, $metadata ) );
274 [ LogLevel
::INFO
, 'Session "{session}": Restrictions check failed' ],
275 ], $logger->getBuffer() );
276 $logger->clearBuffer();
278 $info = new SessionInfo( SessionInfo
::MIN_PRIORITY
, $data );
279 $metadata = $info->getProviderMetadata();
280 $this->assertTrue( $provider->refreshSessionInfo( $info, $request, $metadata ) );
281 $this->assertSame( [], $logger->getBuffer() );
282 $this->assertEquals( $dataMD +
[ 'rights' => [ 'read' ] ], $metadata );
285 public function testGetAllowedUserRights() {
286 $logger = new \
TestLogger( true );
287 $provider = $this->getProvider();
288 $provider->setLogger( $logger );
290 $backend = TestUtils
::getDummySessionBackend();
291 $backendPriv = \TestingAccessWrapper
::newFromObject( $backend );
294 $provider->getAllowedUserRights( $backend );
295 $this->fail( 'Expected exception not thrown' );
296 } catch ( \InvalidArgumentException
$ex ) {
297 $this->assertSame( 'Backend\'s provider isn\'t $this', $ex->getMessage() );
300 $backendPriv->provider
= $provider;
301 $backendPriv->providerMetadata
= [ 'rights' => [ 'foo', 'bar', 'baz' ] ];
302 $this->assertSame( [ 'foo', 'bar', 'baz' ], $provider->getAllowedUserRights( $backend ) );
303 $this->assertSame( [], $logger->getBuffer() );
305 $backendPriv->providerMetadata
= [ 'foo' => 'bar' ];
306 $this->assertSame( [], $provider->getAllowedUserRights( $backend ) );
310 'MediaWiki\\Session\\BotPasswordSessionProvider::getAllowedUserRights: ' .
311 'No provider metadata, returning no rights allowed'
313 ], $logger->getBuffer() );
314 $logger->clearBuffer();
316 $backendPriv->providerMetadata
= [ 'rights' => 'bar' ];
317 $this->assertSame( [], $provider->getAllowedUserRights( $backend ) );
321 'MediaWiki\\Session\\BotPasswordSessionProvider::getAllowedUserRights: ' .
322 'No provider metadata, returning no rights allowed'
324 ], $logger->getBuffer() );
325 $logger->clearBuffer();
327 $backendPriv->providerMetadata
= null;
328 $this->assertSame( [], $provider->getAllowedUserRights( $backend ) );
332 'MediaWiki\\Session\\BotPasswordSessionProvider::getAllowedUserRights: ' .
333 'No provider metadata, returning no rights allowed'
335 ], $logger->getBuffer() );
336 $logger->clearBuffer();