MediaWiki  master
ImmutableSessionProviderWithCookieTest.php
Go to the documentation of this file.
1 <?php
2 
3 namespace MediaWiki\Session;
4 
6 use User;
8 
15 
16  private function getProvider( $name, $prefix = null ) {
17  $config = new \HashConfig();
18  $config->set( 'CookiePrefix', 'wgCookiePrefix' );
19 
20  $params = [
21  'sessionCookieName' => $name,
22  'sessionCookieOptions' => [],
23  ];
24  if ( $prefix !== null ) {
25  $params['sessionCookieOptions']['prefix'] = $prefix;
26  }
27 
28  $provider = $this->getMockBuilder( ImmutableSessionProviderWithCookie::class )
29  ->setConstructorArgs( [ $params ] )
30  ->getMockForAbstractClass();
31  $provider->setLogger( new \TestLogger() );
32  $provider->setConfig( $config );
33  $provider->setManager( new SessionManager() );
34 
35  return $provider;
36  }
37 
38  public function testConstructor() {
39  $provider = $this->getMockBuilder( ImmutableSessionProviderWithCookie::class )
40  ->getMockForAbstractClass();
41  $priv = TestingAccessWrapper::newFromObject( $provider );
42  $this->assertNull( $priv->sessionCookieName );
43  $this->assertSame( [], $priv->sessionCookieOptions );
44 
45  $provider = $this->getMockBuilder( ImmutableSessionProviderWithCookie::class )
46  ->setConstructorArgs( [ [
47  'sessionCookieName' => 'Foo',
48  'sessionCookieOptions' => [ 'Bar' ],
49  ] ] )
50  ->getMockForAbstractClass();
51  $priv = TestingAccessWrapper::newFromObject( $provider );
52  $this->assertSame( 'Foo', $priv->sessionCookieName );
53  $this->assertSame( [ 'Bar' ], $priv->sessionCookieOptions );
54 
55  try {
56  $provider = $this->getMockBuilder( ImmutableSessionProviderWithCookie::class )
57  ->setConstructorArgs( [ [
58  'sessionCookieName' => false,
59  ] ] )
60  ->getMockForAbstractClass();
61  $this->fail( 'Expected exception not thrown' );
62  } catch ( \InvalidArgumentException $ex ) {
63  $this->assertSame(
64  'sessionCookieName must be a string',
65  $ex->getMessage()
66  );
67  }
68 
69  try {
70  $provider = $this->getMockBuilder( ImmutableSessionProviderWithCookie::class )
71  ->setConstructorArgs( [ [
72  'sessionCookieOptions' => 'x',
73  ] ] )
74  ->getMockForAbstractClass();
75  $this->fail( 'Expected exception not thrown' );
76  } catch ( \InvalidArgumentException $ex ) {
77  $this->assertSame(
78  'sessionCookieOptions must be an array',
79  $ex->getMessage()
80  );
81  }
82  }
83 
84  public function testBasics() {
85  $provider = $this->getProvider( null );
86  $this->assertFalse( $provider->persistsSessionID() );
87  $this->assertFalse( $provider->canChangeUser() );
88 
89  $provider = $this->getProvider( 'Foo' );
90  $this->assertTrue( $provider->persistsSessionID() );
91  $this->assertFalse( $provider->canChangeUser() );
92 
93  $msg = $provider->whyNoSession();
94  $this->assertInstanceOf( \Message::class, $msg );
95  $this->assertSame( 'sessionprovider-nocookies', $msg->getKey() );
96  }
97 
98  public function testGetVaryCookies() {
99  $provider = $this->getProvider( null );
100  $this->assertSame( [], $provider->getVaryCookies() );
101 
102  $provider = $this->getProvider( 'Foo' );
103  $this->assertSame( [ 'wgCookiePrefixFoo' ], $provider->getVaryCookies() );
104 
105  $provider = $this->getProvider( 'Foo', 'Bar' );
106  $this->assertSame( [ 'BarFoo' ], $provider->getVaryCookies() );
107 
108  $provider = $this->getProvider( 'Foo', '' );
109  $this->assertSame( [ 'Foo' ], $provider->getVaryCookies() );
110  }
111 
112  public function testGetSessionIdFromCookie() {
113  $this->setMwGlobals( 'wgCookiePrefix', 'wgCookiePrefix' );
114  $request = new \FauxRequest();
115  $request->setCookies( [
116  '' => 'empty---------------------------',
117  'Foo' => 'foo-----------------------------',
118  'wgCookiePrefixFoo' => 'wgfoo---------------------------',
119  'BarFoo' => 'foobar--------------------------',
120  'bad' => 'bad',
121  ], '' );
122 
123  $provider = TestingAccessWrapper::newFromObject( $this->getProvider( null ) );
124  try {
125  $provider->getSessionIdFromCookie( $request );
126  $this->fail( 'Expected exception not thrown' );
127  } catch ( \BadMethodCallException $ex ) {
128  $this->assertSame(
129  'MediaWiki\\Session\\ImmutableSessionProviderWithCookie::getSessionIdFromCookie ' .
130  'may not be called when $this->sessionCookieName === null',
131  $ex->getMessage()
132  );
133  }
134 
135  $provider = TestingAccessWrapper::newFromObject( $this->getProvider( 'Foo' ) );
136  $this->assertSame(
137  'wgfoo---------------------------',
138  $provider->getSessionIdFromCookie( $request )
139  );
140 
141  $provider = TestingAccessWrapper::newFromObject( $this->getProvider( 'Foo', 'Bar' ) );
142  $this->assertSame(
143  'foobar--------------------------',
144  $provider->getSessionIdFromCookie( $request )
145  );
146 
147  $provider = TestingAccessWrapper::newFromObject( $this->getProvider( 'Foo', '' ) );
148  $this->assertSame(
149  'foo-----------------------------',
150  $provider->getSessionIdFromCookie( $request )
151  );
152 
153  $provider = TestingAccessWrapper::newFromObject( $this->getProvider( 'bad', '' ) );
154  $this->assertSame( null, $provider->getSessionIdFromCookie( $request ) );
155 
156  $provider = TestingAccessWrapper::newFromObject( $this->getProvider( 'none', '' ) );
157  $this->assertSame( null, $provider->getSessionIdFromCookie( $request ) );
158  }
159 
160  protected function getSentRequest() {
161  $sentResponse = $this->getMockBuilder( \FauxResponse::class )
162  ->setMethods( [ 'headersSent', 'setCookie', 'header' ] )
163  ->getMock();
164  $sentResponse->expects( $this->any() )->method( 'headersSent' )
165  ->will( $this->returnValue( true ) );
166  $sentResponse->expects( $this->never() )->method( 'setCookie' );
167  $sentResponse->expects( $this->never() )->method( 'header' );
168 
169  $sentRequest = $this->getMockBuilder( \FauxRequest::class )
170  ->setMethods( [ 'response' ] )->getMock();
171  $sentRequest->expects( $this->any() )->method( 'response' )
172  ->will( $this->returnValue( $sentResponse ) );
173  return $sentRequest;
174  }
175 
181  public function testPersistSession( $secure, $remember ) {
182  $this->setMwGlobals( [
183  'wgCookieExpiration' => 100,
184  'wgSecureLogin' => false,
185  ] );
186 
187  $provider = $this->getProvider( 'session' );
188  $provider->setLogger( new \Psr\Log\NullLogger() );
189  $priv = TestingAccessWrapper::newFromObject( $provider );
190  $priv->sessionCookieOptions = [
191  'prefix' => 'x',
192  'path' => 'CookiePath',
193  'domain' => 'CookieDomain',
194  'secure' => false,
195  'httpOnly' => true,
196  ];
197 
198  $sessionId = 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa';
199  $user = User::newFromName( 'UTSysop' );
200  $this->assertFalse( $user->requiresHTTPS(), 'sanity check' );
201 
202  $backend = new SessionBackend(
203  new SessionId( $sessionId ),
205  'provider' => $provider,
206  'id' => $sessionId,
207  'persisted' => true,
208  'userInfo' => UserInfo::newFromUser( $user, true ),
209  'idIsSafe' => true,
210  ] ),
211  new TestBagOStuff(),
212  new \Psr\Log\NullLogger(),
213  10
214  );
215  TestingAccessWrapper::newFromObject( $backend )->usePhpSessionHandling = false;
216  $backend->setRememberUser( $remember );
217  $backend->setForceHTTPS( $secure );
218 
219  // No cookie
220  $priv->sessionCookieName = null;
221  $request = new \FauxRequest();
222  $provider->persistSession( $backend, $request );
223  $this->assertSame( [], $request->response()->getCookies() );
224 
225  // Cookie
226  $priv->sessionCookieName = 'session';
227  $request = new \FauxRequest();
228  $time = time();
229  $provider->persistSession( $backend, $request );
230 
231  $cookie = $request->response()->getCookieData( 'xsession' );
232  $this->assertInternalType( 'array', $cookie );
233  if ( isset( $cookie['expire'] ) && $cookie['expire'] > 0 ) {
234  // Round expiry so we don't randomly fail if the seconds ticked during the test.
235  $cookie['expire'] = round( $cookie['expire'] - $time, -2 );
236  }
237  $this->assertEquals( [
238  'value' => $sessionId,
239  'expire' => null,
240  'path' => 'CookiePath',
241  'domain' => 'CookieDomain',
242  'secure' => $secure,
243  'httpOnly' => true,
244  'raw' => false,
245  ], $cookie );
246 
247  $cookie = $request->response()->getCookieData( 'forceHTTPS' );
248  if ( $secure ) {
249  $this->assertInternalType( 'array', $cookie );
250  if ( isset( $cookie['expire'] ) && $cookie['expire'] > 0 ) {
251  // Round expiry so we don't randomly fail if the seconds ticked during the test.
252  $cookie['expire'] = round( $cookie['expire'] - $time, -2 );
253  }
254  $this->assertEquals( [
255  'value' => 'true',
256  'expire' => null,
257  'path' => 'CookiePath',
258  'domain' => 'CookieDomain',
259  'secure' => false,
260  'httpOnly' => true,
261  'raw' => false,
262  ], $cookie );
263  } else {
264  $this->assertNull( $cookie );
265  }
266 
267  // Headers sent
268  $request = $this->getSentRequest();
269  $provider->persistSession( $backend, $request );
270  $this->assertSame( [], $request->response()->getCookies() );
271  }
272 
273  public static function providePersistSession() {
274  return [
275  [ false, false ],
276  [ false, true ],
277  [ true, false ],
278  [ true, true ],
279  ];
280  }
281 
282  public function testUnpersistSession() {
283  $provider = $this->getProvider( 'session', '' );
284  $provider->setLogger( new \Psr\Log\NullLogger() );
285  $priv = TestingAccessWrapper::newFromObject( $provider );
286 
287  // No cookie
288  $priv->sessionCookieName = null;
289  $request = new \FauxRequest();
290  $provider->unpersistSession( $request );
291  $this->assertSame( null, $request->response()->getCookie( 'session', '' ) );
292 
293  // Cookie
294  $priv->sessionCookieName = 'session';
295  $request = new \FauxRequest();
296  $provider->unpersistSession( $request );
297  $this->assertSame( '', $request->response()->getCookie( 'session', '' ) );
298 
299  // Headers sent
300  $request = $this->getSentRequest();
301  $provider->unpersistSession( $request );
302  $this->assertSame( null, $request->response()->getCookie( 'session', '' ) );
303  }
304 
305 }
const MIN_PRIORITY
Minimum allowed priority.
Definition: SessionInfo.php:36
Config $config
Definition: MediaWiki.php:43
This is the actual workhorse for Session.
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
static newFromUser(User $user, $verified=false)
Create an instance from an existing User object.
Definition: UserInfo.php:116
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1813
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:1996
BagOStuff with utility functions for MediaWiki\\Session\\* testing.
A logger that may be configured to either buffer logs or to print them to the output where PHPUnit wi...
Definition: TestLogger.php:33
$params
Session Database MediaWiki\Session\ImmutableSessionProviderWithCookie.
setMwGlobals( $pairs, $value=null)
Sets a global, maintaining a stashed version of the previous global to be restored in tearDown...
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
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
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:276
This serves as the entry point to the MediaWiki session handling system.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:585
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:2626
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1487
Value object returned by SessionProvider.
Definition: SessionInfo.php:34