MediaWiki  master
SessionTest.php
Go to the documentation of this file.
1 <?php
2 
3 namespace MediaWiki\Session;
4 
7 use User;
9 
15 
16  public function testConstructor() {
18  TestingAccessWrapper::newFromObject( $backend )->requests = [ -1 => 'dummy' ];
19  TestingAccessWrapper::newFromObject( $backend )->id = new SessionId( 'abc' );
20 
21  $session = new Session( $backend, 42, new \TestLogger );
22  $priv = TestingAccessWrapper::newFromObject( $session );
23  $this->assertSame( $backend, $priv->backend );
24  $this->assertSame( 42, $priv->index );
25 
26  $request = new \FauxRequest();
27  $priv2 = TestingAccessWrapper::newFromObject( $session->sessionWithRequest( $request ) );
28  $this->assertSame( $backend, $priv2->backend );
29  $this->assertNotSame( $priv->index, $priv2->index );
30  $this->assertSame( $request, $priv2->getRequest() );
31  }
32 
40  public function testMethods( $m, $args, $index, $ret ) {
41  $mock = $this->getMockBuilder( DummySessionBackend::class )
42  ->setMethods( [ $m, 'deregisterSession' ] )
43  ->getMock();
44  $mock->expects( $this->once() )->method( 'deregisterSession' )
45  ->with( $this->identicalTo( 42 ) );
46 
47  $tmp = $mock->expects( $this->once() )->method( $m );
48  $expectArgs = [];
49  if ( $index ) {
50  $expectArgs[] = $this->identicalTo( 42 );
51  }
52  foreach ( $args as $arg ) {
53  $expectArgs[] = $this->identicalTo( $arg );
54  }
55  $tmp = call_user_func_array( [ $tmp, 'with' ], $expectArgs );
56 
57  $retval = new \stdClass;
58  $tmp->will( $this->returnValue( $retval ) );
59 
60  $session = TestUtils::getDummySession( $mock, 42 );
61 
62  if ( $ret ) {
63  $this->assertSame( $retval, call_user_func_array( [ $session, $m ], $args ) );
64  } else {
65  $this->assertNull( call_user_func_array( [ $session, $m ], $args ) );
66  }
67 
68  // Trigger Session destructor
69  $session = null;
70  }
71 
72  public static function provideMethods() {
73  return [
74  [ 'getId', [], false, true ],
75  [ 'getSessionId', [], false, true ],
76  [ 'resetId', [], false, true ],
77  [ 'getProvider', [], false, true ],
78  [ 'isPersistent', [], false, true ],
79  [ 'persist', [], false, false ],
80  [ 'unpersist', [], false, false ],
81  [ 'shouldRememberUser', [], false, true ],
82  [ 'setRememberUser', [ true ], false, false ],
83  [ 'getRequest', [], true, true ],
84  [ 'getUser', [], false, true ],
85  [ 'getAllowedUserRights', [], false, true ],
86  [ 'canSetUser', [], false, true ],
87  [ 'setUser', [ new \stdClass ], false, false ],
88  [ 'suggestLoginUsername', [], true, true ],
89  [ 'shouldForceHTTPS', [], false, true ],
90  [ 'setForceHTTPS', [ true ], false, false ],
91  [ 'getLoggedOutTimestamp', [], false, true ],
92  [ 'setLoggedOutTimestamp', [ 123 ], false, false ],
93  [ 'getProviderMetadata', [], false, true ],
94  [ 'save', [], false, false ],
95  [ 'delaySave', [], false, true ],
96  [ 'renew', [], false, false ],
97  ];
98  }
99 
100  public function testDataAccess() {
101  $session = TestUtils::getDummySession();
102  $backend = TestingAccessWrapper::newFromObject( $session )->backend;
103 
104  $this->assertEquals( 1, $session->get( 'foo' ) );
105  $this->assertEquals( 'zero', $session->get( 0 ) );
106  $this->assertFalse( $backend->dirty );
107 
108  $this->assertEquals( null, $session->get( 'null' ) );
109  $this->assertEquals( 'default', $session->get( 'null', 'default' ) );
110  $this->assertFalse( $backend->dirty );
111 
112  $session->set( 'foo', 55 );
113  $this->assertEquals( 55, $backend->data['foo'] );
114  $this->assertTrue( $backend->dirty );
115  $backend->dirty = false;
116 
117  $session->set( 1, 'one' );
118  $this->assertEquals( 'one', $backend->data[1] );
119  $this->assertTrue( $backend->dirty );
120  $backend->dirty = false;
121 
122  $session->set( 1, 'one' );
123  $this->assertFalse( $backend->dirty );
124 
125  $this->assertTrue( $session->exists( 'foo' ) );
126  $this->assertTrue( $session->exists( 1 ) );
127  $this->assertFalse( $session->exists( 'null' ) );
128  $this->assertFalse( $session->exists( 100 ) );
129  $this->assertFalse( $backend->dirty );
130 
131  $session->remove( 'foo' );
132  $this->assertArrayNotHasKey( 'foo', $backend->data );
133  $this->assertTrue( $backend->dirty );
134  $backend->dirty = false;
135  $session->remove( 1 );
136  $this->assertArrayNotHasKey( 1, $backend->data );
137  $this->assertTrue( $backend->dirty );
138  $backend->dirty = false;
139 
140  $session->remove( 101 );
141  $this->assertFalse( $backend->dirty );
142 
143  $backend->data = [ 'a', 'b', '?' => 'c' ];
144  $this->assertSame( 3, $session->count() );
145  $this->assertSame( 3, count( $session ) );
146  $this->assertFalse( $backend->dirty );
147 
148  $data = [];
149  foreach ( $session as $key => $value ) {
150  $data[$key] = $value;
151  }
152  $this->assertEquals( $backend->data, $data );
153  $this->assertFalse( $backend->dirty );
154 
155  $this->assertEquals( $backend->data, iterator_to_array( $session ) );
156  $this->assertFalse( $backend->dirty );
157  }
158 
159  public function testArrayAccess() {
160  $logger = new \TestLogger;
161  $session = TestUtils::getDummySession( null, -1, $logger );
162  $backend = TestingAccessWrapper::newFromObject( $session )->backend;
163 
164  $this->assertEquals( 1, $session['foo'] );
165  $this->assertEquals( 'zero', $session[0] );
166  $this->assertFalse( $backend->dirty );
167 
168  $logger->setCollect( true );
169  $this->assertEquals( null, $session['null'] );
170  $logger->setCollect( false );
171  $this->assertFalse( $backend->dirty );
172  $this->assertSame( [
173  [ LogLevel::DEBUG, 'Undefined index (auto-adds to session with a null value): null' ]
174  ], $logger->getBuffer() );
175  $logger->clearBuffer();
176 
177  $session['foo'] = 55;
178  $this->assertEquals( 55, $backend->data['foo'] );
179  $this->assertTrue( $backend->dirty );
180  $backend->dirty = false;
181 
182  $session[1] = 'one';
183  $this->assertEquals( 'one', $backend->data[1] );
184  $this->assertTrue( $backend->dirty );
185  $backend->dirty = false;
186 
187  $session[1] = 'one';
188  $this->assertFalse( $backend->dirty );
189 
190  $session['bar'] = [ 'baz' => [] ];
191  $session['bar']['baz']['quux'] = 2;
192  $this->assertEquals( [ 'baz' => [ 'quux' => 2 ] ], $backend->data['bar'] );
193 
194  $logger->setCollect( true );
195  $session['bar2']['baz']['quux'] = 3;
196  $logger->setCollect( false );
197  $this->assertEquals( [ 'baz' => [ 'quux' => 3 ] ], $backend->data['bar2'] );
198  $this->assertSame( [
199  [ LogLevel::DEBUG, 'Undefined index (auto-adds to session with a null value): bar2' ]
200  ], $logger->getBuffer() );
201  $logger->clearBuffer();
202 
203  $backend->dirty = false;
204  $this->assertTrue( isset( $session['foo'] ) );
205  $this->assertTrue( isset( $session[1] ) );
206  $this->assertFalse( isset( $session['null'] ) );
207  $this->assertFalse( isset( $session['missing'] ) );
208  $this->assertFalse( isset( $session[100] ) );
209  $this->assertFalse( $backend->dirty );
210 
211  unset( $session['foo'] );
212  $this->assertArrayNotHasKey( 'foo', $backend->data );
213  $this->assertTrue( $backend->dirty );
214  $backend->dirty = false;
215  unset( $session[1] );
216  $this->assertArrayNotHasKey( 1, $backend->data );
217  $this->assertTrue( $backend->dirty );
218  $backend->dirty = false;
219 
220  unset( $session[101] );
221  $this->assertFalse( $backend->dirty );
222  }
223 
224  public function testClear() {
225  $session = TestUtils::getDummySession();
226  $priv = TestingAccessWrapper::newFromObject( $session );
227 
228  $backend = $this->getMockBuilder( DummySessionBackend::class )
229  ->setMethods( [ 'canSetUser', 'setUser', 'save' ] )
230  ->getMock();
231  $backend->expects( $this->once() )->method( 'canSetUser' )
232  ->will( $this->returnValue( true ) );
233  $backend->expects( $this->once() )->method( 'setUser' )
234  ->with( $this->callback( function ( $user ) {
235  return $user instanceof User && $user->isAnon();
236  } ) );
237  $backend->expects( $this->once() )->method( 'save' );
238  $priv->backend = $backend;
239  $session->clear();
240  $this->assertSame( [], $backend->data );
241  $this->assertTrue( $backend->dirty );
242 
243  $backend = $this->getMockBuilder( DummySessionBackend::class )
244  ->setMethods( [ 'canSetUser', 'setUser', 'save' ] )
245  ->getMock();
246  $backend->data = [];
247  $backend->expects( $this->once() )->method( 'canSetUser' )
248  ->will( $this->returnValue( true ) );
249  $backend->expects( $this->once() )->method( 'setUser' )
250  ->with( $this->callback( function ( $user ) {
251  return $user instanceof User && $user->isAnon();
252  } ) );
253  $backend->expects( $this->once() )->method( 'save' );
254  $priv->backend = $backend;
255  $session->clear();
256  $this->assertFalse( $backend->dirty );
257 
258  $backend = $this->getMockBuilder( DummySessionBackend::class )
259  ->setMethods( [ 'canSetUser', 'setUser', 'save' ] )
260  ->getMock();
261  $backend->expects( $this->once() )->method( 'canSetUser' )
262  ->will( $this->returnValue( false ) );
263  $backend->expects( $this->never() )->method( 'setUser' );
264  $backend->expects( $this->once() )->method( 'save' );
265  $priv->backend = $backend;
266  $session->clear();
267  $this->assertSame( [], $backend->data );
268  $this->assertTrue( $backend->dirty );
269  }
270 
271  public function testTokens() {
272  $session = TestUtils::getDummySession();
273  $priv = TestingAccessWrapper::newFromObject( $session );
274  $backend = $priv->backend;
275 
276  $token = TestingAccessWrapper::newFromObject( $session->getToken() );
277  $this->assertArrayHasKey( 'wsTokenSecrets', $backend->data );
278  $this->assertArrayHasKey( 'default', $backend->data['wsTokenSecrets'] );
279  $secret = $backend->data['wsTokenSecrets']['default'];
280  $this->assertSame( $secret, $token->secret );
281  $this->assertSame( '', $token->salt );
282  $this->assertTrue( $token->wasNew() );
283 
284  $token = TestingAccessWrapper::newFromObject( $session->getToken( 'foo' ) );
285  $this->assertSame( $secret, $token->secret );
286  $this->assertSame( 'foo', $token->salt );
287  $this->assertFalse( $token->wasNew() );
288 
289  $backend->data['wsTokenSecrets']['secret'] = 'sekret';
290  $token = TestingAccessWrapper::newFromObject(
291  $session->getToken( [ 'bar', 'baz' ], 'secret' )
292  );
293  $this->assertSame( 'sekret', $token->secret );
294  $this->assertSame( 'bar|baz', $token->salt );
295  $this->assertFalse( $token->wasNew() );
296 
297  $session->resetToken( 'secret' );
298  $this->assertArrayHasKey( 'wsTokenSecrets', $backend->data );
299  $this->assertArrayHasKey( 'default', $backend->data['wsTokenSecrets'] );
300  $this->assertArrayNotHasKey( 'secret', $backend->data['wsTokenSecrets'] );
301 
302  $session->resetAllTokens();
303  $this->assertArrayNotHasKey( 'wsTokenSecrets', $backend->data );
304  }
305 
310  public function testSecretsRoundTripping( $data ) {
311  $session = TestUtils::getDummySession();
312 
313  // Simple round-trip
314  $session->setSecret( 'secret', $data );
315  $this->assertNotEquals( $data, $session->get( 'secret' ) );
316  $this->assertEquals( $data, $session->getSecret( 'secret', 'defaulted' ) );
317  }
318 
319  public static function provideSecretsRoundTripping() {
320  return [
321  [ 'Foobar' ],
322  [ 42 ],
323  [ [ 'foo', 'bar' => 'baz', 'subarray' => [ 1, 2, 3 ] ] ],
324  [ (object)[ 'foo', 'bar' => 'baz', 'subarray' => [ 1, 2, 3 ] ] ],
325  [ true ],
326  [ false ],
327  [ null ],
328  ];
329  }
330 
331  public function testSecrets() {
332  $logger = new \TestLogger;
333  $session = TestUtils::getDummySession( null, -1, $logger );
334 
335  // Simple defaulting
336  $this->assertEquals( 'defaulted', $session->getSecret( 'test', 'defaulted' ) );
337 
338  // Bad encrypted data
339  $session->set( 'test', 'foobar' );
340  $logger->setCollect( true );
341  $this->assertEquals( 'defaulted', $session->getSecret( 'test', 'defaulted' ) );
342  $logger->setCollect( false );
343  $this->assertSame( [
344  [ LogLevel::WARNING, 'Invalid sealed-secret format' ]
345  ], $logger->getBuffer() );
346  $logger->clearBuffer();
347 
348  // Tampered data
349  $session->setSecret( 'test', 'foobar' );
350  $encrypted = $session->get( 'test' );
351  $session->set( 'test', $encrypted . 'x' );
352  $logger->setCollect( true );
353  $this->assertEquals( 'defaulted', $session->getSecret( 'test', 'defaulted' ) );
354  $logger->setCollect( false );
355  $this->assertSame( [
356  [ LogLevel::WARNING, 'Sealed secret has been tampered with, aborting.' ]
357  ], $logger->getBuffer() );
358  $logger->clearBuffer();
359 
360  // Unserializable data
361  $iv = random_bytes( 16 );
362  list( $encKey, $hmacKey ) = TestingAccessWrapper::newFromObject( $session )->getSecretKeys();
363  $ciphertext = openssl_encrypt( 'foobar', 'aes-256-ctr', $encKey, OPENSSL_RAW_DATA, $iv );
364  $sealed = base64_encode( $iv ) . '.' . base64_encode( $ciphertext );
365  $hmac = hash_hmac( 'sha256', $sealed, $hmacKey, true );
366  $encrypted = base64_encode( $hmac ) . '.' . $sealed;
367  $session->set( 'test', $encrypted );
368  \Wikimedia\suppressWarnings();
369  $this->assertEquals( 'defaulted', $session->getSecret( 'test', 'defaulted' ) );
370  \Wikimedia\restoreWarnings();
371  }
372 
373 }
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:1982
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
globals will be eliminated from MediaWiki replaced by an application object which would be passed to constructors Whether that would be an convenient solution remains to be but certainly PHP makes such object oriented programming models easier than they were in previous versions For the time being MediaWiki programmers will have to work in an environment with some global context At the time of globals were initialised on startup by MediaWiki of these were configuration which are documented in DefaultSettings php There is no comprehensive documentation for the remaining however some of the most important ones are listed below They are typically initialised either in index php or in Setup php $wgTitle Title object created from the request URL $wgOut OutputPage object for HTTP response $wgUser User object for the user associated with the current request $wgLang Language object selected by user preferences $wgContLang Language object associated with the wiki being viewed $wgParser Parser object Parser extensions register their hooks here $wgRequest WebRequest object
Definition: globals.txt:25
testMethods( $m, $args, $index, $ret)
provideMethods
Definition: SessionTest.php:40
$value
if( $line===false) $args
Definition: cdb.php:64
Session MediaWiki\Session\Session.
Definition: SessionTest.php:14
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:48
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:1982
A logger that may be configured to either buffer logs or to print them to the output where PHPUnit wi...
Definition: TestLogger.php:33
static getDummySessionBackend()
If you need a SessionBackend for testing but don&#39;t want to create a real one, use this...
Definition: TestUtils.php:65
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
Manages data for an an authenticated session.
Definition: Session.php:48
testSecretsRoundTripping( $data)
provideSecretsRoundTripping
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
static getDummySession( $backend=null, $index=-1, $logger=null)
If you need a Session for testing but don&#39;t want to create a backend to construct one...
Definition: TestUtils.php:86
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
Value object holding the session ID in a manner that can be globally updated.
Definition: SessionId.php:38
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2633
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473