AuthComponentTest.php 55 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619
  1. <?php
  2. /**
  3. * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
  4. * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
  5. *
  6. * Licensed under The MIT License
  7. * For full copyright and license information, please see the LICENSE.txt
  8. * Redistributions of files must retain the above copyright notice
  9. *
  10. * @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
  11. * @link https://cakephp.org CakePHP(tm) Project
  12. * @since 1.2.0
  13. * @license https://opensource.org/licenses/mit-license.php MIT License
  14. */
  15. namespace Cake\Test\TestCase\Controller\Component;
  16. use Cake\Auth\BaseAuthorize;
  17. use Cake\Auth\FormAuthenticate;
  18. use Cake\Controller\Component\AuthComponent;
  19. use Cake\Core\Configure;
  20. use Cake\Event\Event;
  21. use Cake\Event\EventManager;
  22. use Cake\Http\Response;
  23. use Cake\Http\ServerRequest;
  24. use Cake\Routing\Router;
  25. use Cake\Routing\Route\InflectedRoute;
  26. use Cake\TestSuite\TestCase;
  27. use Cake\Utility\Security;
  28. use TestApp\Controller\AuthTestController;
  29. use TestApp\Controller\Component\TestAuthComponent;
  30. /**
  31. * AuthComponentTest class
  32. */
  33. class AuthComponentTest extends TestCase
  34. {
  35. /**
  36. * AuthComponent property
  37. *
  38. * @var \TestApp\Controller\Component\TestAuthComponent
  39. */
  40. public $Auth;
  41. /**
  42. * fixtures property
  43. *
  44. * @var array
  45. */
  46. public $fixtures = ['core.auth_users', 'core.users'];
  47. /**
  48. * setUp method
  49. *
  50. * @return void
  51. */
  52. public function setUp()
  53. {
  54. parent::setUp();
  55. Security::salt('YJfIxfs2guVoUubWDYhG93b0qyJfIxfs2guwvniR2G0FgaC9mi');
  56. static::setAppNamespace();
  57. Router::scope('/', function ($routes) {
  58. $routes->fallbacks(InflectedRoute::class);
  59. });
  60. $request = new ServerRequest();
  61. $request->env('REQUEST_METHOD', 'GET');
  62. $response = $this->getMockBuilder('Cake\Http\Response')
  63. ->setMethods(['stop'])
  64. ->getMock();
  65. $this->Controller = new AuthTestController($request, $response);
  66. $this->Auth = new TestAuthComponent($this->Controller->components());
  67. $Users = $this->getTableLocator()->get('AuthUsers');
  68. $Users->updateAll(['password' => password_hash('cake', PASSWORD_BCRYPT)], []);
  69. }
  70. /**
  71. * tearDown method
  72. *
  73. * @return void
  74. */
  75. public function tearDown()
  76. {
  77. parent::tearDown();
  78. $_SESSION = [];
  79. unset($this->Controller, $this->Auth);
  80. }
  81. /**
  82. * testNoAuth method
  83. *
  84. * @return void
  85. */
  86. public function testNoAuth()
  87. {
  88. $this->assertFalse($this->Auth->isAuthorized());
  89. }
  90. /**
  91. * testIsErrorOrTests
  92. *
  93. * @return void
  94. * @triggers Controller.startup $this->Controller
  95. */
  96. public function testIsErrorOrTests()
  97. {
  98. $event = new Event('Controller.startup', $this->Controller);
  99. $this->Controller->name = 'Error';
  100. $this->assertNull($this->Controller->Auth->startup($event));
  101. $this->Controller->name = 'Post';
  102. $this->Controller->request['action'] = 'thisdoesnotexist';
  103. $this->assertNull($this->Controller->Auth->startup($event));
  104. }
  105. /**
  106. * testIdentify method
  107. *
  108. * @return void
  109. */
  110. public function testIdentify()
  111. {
  112. $AuthLoginFormAuthenticate = $this->getMockBuilder(FormAuthenticate::class)
  113. ->setMethods(['authenticate'])
  114. ->disableOriginalConstructor()
  115. ->getMock();
  116. $this->Auth->authenticate = [
  117. 'AuthLoginForm' => [
  118. 'userModel' => 'AuthUsers'
  119. ]
  120. ];
  121. $this->Auth->setAuthenticateObject(0, $AuthLoginFormAuthenticate);
  122. $this->Auth->request->data = [
  123. 'AuthUsers' => [
  124. 'username' => 'mark',
  125. 'password' => Security::hash('cake', null, true)
  126. ]
  127. ];
  128. $user = [
  129. 'id' => 1,
  130. 'username' => 'mark'
  131. ];
  132. $AuthLoginFormAuthenticate->expects($this->once())
  133. ->method('authenticate')
  134. ->with($this->Auth->request)
  135. ->will($this->returnValue($user));
  136. $result = $this->Auth->identify();
  137. $this->assertEquals($user, $result);
  138. $this->assertSame($AuthLoginFormAuthenticate, $this->Auth->authenticationProvider());
  139. }
  140. /**
  141. * Test identify with user record as ArrayObject instance.
  142. *
  143. * @return void
  144. */
  145. public function testIdentifyArrayAccess()
  146. {
  147. $AuthLoginFormAuthenticate = $this->getMockBuilder(FormAuthenticate::class)
  148. ->setMethods(['authenticate'])
  149. ->disableOriginalConstructor()
  150. ->getMock();
  151. $this->Auth->authenticate = [
  152. 'AuthLoginForm' => [
  153. 'userModel' => 'AuthUsers'
  154. ]
  155. ];
  156. $this->Auth->setAuthenticateObject(0, $AuthLoginFormAuthenticate);
  157. $this->Auth->request->data = [
  158. 'AuthUsers' => [
  159. 'username' => 'mark',
  160. 'password' => Security::hash('cake', null, true)
  161. ]
  162. ];
  163. $user = new \ArrayObject([
  164. 'id' => 1,
  165. 'username' => 'mark'
  166. ]);
  167. $AuthLoginFormAuthenticate->expects($this->once())
  168. ->method('authenticate')
  169. ->with($this->Auth->request)
  170. ->will($this->returnValue($user));
  171. $result = $this->Auth->identify();
  172. $this->assertEquals($user, $result);
  173. $this->assertSame($AuthLoginFormAuthenticate, $this->Auth->authenticationProvider());
  174. }
  175. /**
  176. * testAuthorizeFalse method
  177. *
  178. * @return void
  179. * @triggers Controller.startup $this->Controller
  180. */
  181. public function testAuthorizeFalse()
  182. {
  183. $event = new Event('Controller.startup', $this->Controller);
  184. $Users = $this->getTableLocator()->get('Users');
  185. $user = $Users->find('all')->hydrate(false)->first();
  186. $this->Controller->Auth->storage()->write($user);
  187. $this->Controller->Auth->config('userModel', 'Users');
  188. $this->Controller->Auth->config('authorize', false);
  189. $this->Controller->request->addParams(Router::parse('auth_test/add'));
  190. $result = $this->Controller->Auth->startup($event);
  191. $this->assertNull($result);
  192. $this->Controller->Auth->storage()->delete();
  193. $result = $this->Controller->Auth->startup($event);
  194. $this->assertTrue($event->isStopped());
  195. $this->assertInstanceOf('Cake\Http\Response', $result);
  196. $this->assertTrue($this->Auth->session->check('Flash.flash'));
  197. $this->Controller->request->addParams(Router::parse('auth_test/camelCase'));
  198. $result = $this->Controller->Auth->startup($event);
  199. $this->assertInstanceOf('Cake\Http\Response', $result);
  200. }
  201. /**
  202. * testIsAuthorizedMissingFile function
  203. *
  204. * @expectedException \Cake\Core\Exception\Exception
  205. * @return void
  206. */
  207. public function testIsAuthorizedMissingFile()
  208. {
  209. $this->Controller->Auth->config('authorize', 'Missing');
  210. $this->Controller->Auth->isAuthorized(['User' => ['id' => 1]]);
  211. }
  212. /**
  213. * test that isAuthorized calls methods correctly
  214. *
  215. * @return void
  216. */
  217. public function testIsAuthorizedDelegation()
  218. {
  219. $AuthMockOneAuthorize = $this->getMockBuilder(BaseAuthorize::class)
  220. ->setMethods(['authorize'])
  221. ->disableOriginalConstructor()
  222. ->getMock();
  223. $AuthMockTwoAuthorize = $this->getMockBuilder(BaseAuthorize::class)
  224. ->setMethods(['authorize'])
  225. ->disableOriginalConstructor()
  226. ->getMock();
  227. $AuthMockThreeAuthorize = $this->getMockBuilder(BaseAuthorize::class)
  228. ->setMethods(['authorize'])
  229. ->disableOriginalConstructor()
  230. ->getMock();
  231. $this->Auth->setAuthorizeObject(0, $AuthMockOneAuthorize);
  232. $this->Auth->setAuthorizeObject(1, $AuthMockTwoAuthorize);
  233. $this->Auth->setAuthorizeObject(2, $AuthMockThreeAuthorize);
  234. $request = $this->Auth->request;
  235. $AuthMockOneAuthorize->expects($this->once())
  236. ->method('authorize')
  237. ->with(['User'], $request)
  238. ->will($this->returnValue(false));
  239. $AuthMockTwoAuthorize->expects($this->once())
  240. ->method('authorize')
  241. ->with(['User'], $request)
  242. ->will($this->returnValue(true));
  243. $AuthMockThreeAuthorize->expects($this->never())
  244. ->method('authorize');
  245. $this->assertTrue($this->Auth->isAuthorized(['User'], $request));
  246. $this->assertSame($AuthMockTwoAuthorize, $this->Auth->authorizationProvider());
  247. }
  248. /**
  249. * test isAuthorized passing it an ArrayObject instance.
  250. *
  251. * @return void
  252. */
  253. public function testIsAuthorizedWithArrayObject()
  254. {
  255. $AuthMockOneAuthorize = $this->getMockBuilder(BaseAuthorize::class)
  256. ->setMethods(['authorize'])
  257. ->disableOriginalConstructor()
  258. ->getMock();
  259. $this->Auth->setAuthorizeObject(0, $AuthMockOneAuthorize);
  260. $request = $this->Auth->request;
  261. $user = new \ArrayObject(['User']);
  262. $AuthMockOneAuthorize->expects($this->once())
  263. ->method('authorize')
  264. ->with($user, $request)
  265. ->will($this->returnValue(true));
  266. $this->assertTrue($this->Auth->isAuthorized($user, $request));
  267. $this->assertSame($AuthMockOneAuthorize, $this->Auth->authorizationProvider());
  268. }
  269. /**
  270. * test that isAuthorized will use the session user if none is given.
  271. *
  272. * @return void
  273. */
  274. public function testIsAuthorizedUsingUserInSession()
  275. {
  276. $AuthMockFourAuthorize = $this->getMockBuilder(BaseAuthorize::class)
  277. ->setMethods(['authorize'])
  278. ->disableOriginalConstructor()
  279. ->getMock();
  280. $this->Auth->config('authorize', ['AuthMockFour']);
  281. $this->Auth->setAuthorizeObject(0, $AuthMockFourAuthorize);
  282. $user = ['user' => 'mark'];
  283. $this->Auth->session->write('Auth.User', $user);
  284. $request = $this->Controller->request;
  285. $AuthMockFourAuthorize->expects($this->once())
  286. ->method('authorize')
  287. ->with($user, $request)
  288. ->will($this->returnValue(true));
  289. $this->assertTrue($this->Auth->isAuthorized(null, $request));
  290. }
  291. /**
  292. * test that loadAuthorize resets the loaded objects each time.
  293. *
  294. * @return void
  295. */
  296. public function testLoadAuthorizeResets()
  297. {
  298. $this->Controller->Auth->config('authorize', ['Controller']);
  299. $result = $this->Controller->Auth->constructAuthorize();
  300. $this->assertCount(1, $result);
  301. $result = $this->Controller->Auth->constructAuthorize();
  302. $this->assertCount(1, $result);
  303. }
  304. /**
  305. * testLoadAuthenticateNoFile function
  306. *
  307. * @expectedException \Cake\Core\Exception\Exception
  308. * @return void
  309. */
  310. public function testLoadAuthenticateNoFile()
  311. {
  312. $this->Controller->Auth->config('authenticate', 'Missing');
  313. $this->Controller->Auth->identify($this->Controller->request, $this->Controller->response);
  314. }
  315. /**
  316. * test the * key with authenticate
  317. *
  318. * @return void
  319. */
  320. public function testAllConfigWithAuthorize()
  321. {
  322. $this->Controller->Auth->config('authorize', [
  323. AuthComponent::ALL => ['actionPath' => 'controllers/'],
  324. 'Controller',
  325. ]);
  326. $objects = array_values($this->Controller->Auth->constructAuthorize());
  327. $result = $objects[0];
  328. $this->assertEquals('controllers/', $result->config('actionPath'));
  329. }
  330. /**
  331. * test that loadAuthorize resets the loaded objects each time.
  332. *
  333. * @return void
  334. */
  335. public function testLoadAuthenticateResets()
  336. {
  337. $this->Controller->Auth->config('authenticate', ['Form']);
  338. $result = $this->Controller->Auth->constructAuthenticate();
  339. $this->assertCount(1, $result);
  340. $result = $this->Controller->Auth->constructAuthenticate();
  341. $this->assertCount(1, $result);
  342. }
  343. /**
  344. * test the * key with authenticate
  345. *
  346. * @return void
  347. */
  348. public function testAllConfigWithAuthenticate()
  349. {
  350. $this->Controller->Auth->config('authenticate', [
  351. AuthComponent::ALL => ['userModel' => 'AuthUsers'],
  352. 'Form'
  353. ]);
  354. $objects = array_values($this->Controller->Auth->constructAuthenticate());
  355. $result = $objects[0];
  356. $this->assertEquals('AuthUsers', $result->config('userModel'));
  357. }
  358. /**
  359. * test defining the same Authenticate object but with different password hashers
  360. *
  361. * @return void
  362. */
  363. public function testSameAuthenticateWithDifferentHashers()
  364. {
  365. $this->Controller->Auth->config('authenticate', [
  366. 'FormSimple' => ['className' => 'Form', 'passwordHasher' => 'Default'],
  367. 'FormBlowfish' => ['className' => 'Form', 'passwordHasher' => 'Fallback'],
  368. ]);
  369. $objects = $this->Controller->Auth->constructAuthenticate();
  370. $this->assertCount(2, $objects);
  371. $this->assertInstanceOf('Cake\Auth\FormAuthenticate', $objects['FormSimple']);
  372. $this->assertInstanceOf('Cake\Auth\FormAuthenticate', $objects['FormBlowfish']);
  373. $this->assertInstanceOf('Cake\Auth\DefaultPasswordHasher', $objects['FormSimple']->passwordHasher());
  374. $this->assertInstanceOf('Cake\Auth\FallbackPasswordHasher', $objects['FormBlowfish']->passwordHasher());
  375. }
  376. /**
  377. * Tests that deny always takes precedence over allow
  378. *
  379. * @return void
  380. * @triggers Controller.startup $this->Controller
  381. */
  382. public function testAllowDenyAll()
  383. {
  384. $event = new Event('Controller.startup', $this->Controller);
  385. $this->Controller->Auth->allow();
  386. $this->Controller->Auth->deny(['add', 'camelCase']);
  387. $this->Controller->request['action'] = 'delete';
  388. $this->assertNull($this->Controller->Auth->startup($event));
  389. $this->Controller->request['action'] = 'add';
  390. $this->assertInstanceOf('Cake\Http\Response', $this->Controller->Auth->startup($event));
  391. $this->Controller->request['action'] = 'camelCase';
  392. $this->assertInstanceOf('Cake\Http\Response', $this->Controller->Auth->startup($event));
  393. $this->Controller->Auth->allow();
  394. $this->Controller->Auth->deny(['add', 'camelCase']);
  395. $this->Controller->request['action'] = 'delete';
  396. $this->assertNull($this->Controller->Auth->startup($event));
  397. $this->Controller->request['action'] = 'camelCase';
  398. $this->assertInstanceOf('Cake\Http\Response', $this->Controller->Auth->startup($event));
  399. $this->Controller->Auth->allow();
  400. $this->Controller->Auth->deny();
  401. $this->Controller->request['action'] = 'camelCase';
  402. $this->assertInstanceOf('Cake\Http\Response', $this->Controller->Auth->startup($event));
  403. $this->Controller->request['action'] = 'add';
  404. $this->assertInstanceOf('Cake\Http\Response', $this->Controller->Auth->startup($event));
  405. $this->Controller->Auth->allow('camelCase');
  406. $this->Controller->Auth->deny();
  407. $this->Controller->request['action'] = 'camelCase';
  408. $this->assertInstanceOf('Cake\Http\Response', $this->Controller->Auth->startup($event));
  409. $this->Controller->request['action'] = 'login';
  410. $this->assertInstanceOf('Cake\Http\Response', $this->Controller->Auth->startup($event));
  411. $this->Controller->Auth->deny();
  412. $this->Controller->Auth->allow(null);
  413. $this->Controller->request['action'] = 'camelCase';
  414. $this->assertNull($this->Controller->Auth->startup($event));
  415. $this->Controller->Auth->allow();
  416. $this->Controller->Auth->deny(null);
  417. $this->Controller->request['action'] = 'camelCase';
  418. $this->assertInstanceOf('Cake\Http\Response', $this->Controller->Auth->startup($event));
  419. }
  420. /**
  421. * test that deny() converts camel case inputs to lowercase.
  422. *
  423. * @return void
  424. * @triggers Controller.startup $this->Controller
  425. */
  426. public function testDenyWithCamelCaseMethods()
  427. {
  428. $event = new Event('Controller.startup', $this->Controller);
  429. $this->Controller->Auth->allow();
  430. $this->Controller->Auth->deny(['add', 'camelCase']);
  431. $url = '/auth_test/camelCase';
  432. $this->Controller->request->addParams(Router::parse($url));
  433. $this->Controller->request->query['url'] = Router::normalize($url);
  434. $this->assertInstanceOf('Cake\Http\Response', $this->Controller->Auth->startup($event));
  435. $url = '/auth_test/CamelCase';
  436. $this->Controller->request->addParams(Router::parse($url));
  437. $this->Controller->request->query['url'] = Router::normalize($url);
  438. $this->assertInstanceOf('Cake\Http\Response', $this->Controller->Auth->startup($event));
  439. }
  440. /**
  441. * test that allow() and allowedActions work with camelCase method names.
  442. *
  443. * @return void
  444. * @triggers Controller.startup $this->Controller
  445. */
  446. public function testAllowedActionsWithCamelCaseMethods()
  447. {
  448. $event = new Event('Controller.startup', $this->Controller);
  449. $url = '/auth_test/camelCase';
  450. $this->Controller->request->addParams(Router::parse($url));
  451. $this->Controller->request->query['url'] = Router::normalize($url);
  452. $this->Controller->Auth->loginAction = ['controller' => 'AuthTest', 'action' => 'login'];
  453. $this->Controller->Auth->userModel = 'AuthUsers';
  454. $this->Controller->Auth->allow();
  455. $result = $this->Controller->Auth->startup($event);
  456. $this->assertNull($result, 'startup() should return null, as action is allowed. %s');
  457. $url = '/auth_test/camelCase';
  458. $this->Controller->request->addParams(Router::parse($url));
  459. $this->Controller->request->query['url'] = Router::normalize($url);
  460. $this->Controller->Auth->loginAction = ['controller' => 'AuthTest', 'action' => 'login'];
  461. $this->Controller->Auth->userModel = 'AuthUsers';
  462. $this->Controller->Auth->allowedActions = ['delete', 'camelCase', 'add'];
  463. $result = $this->Controller->Auth->startup($event);
  464. $this->assertNull($result, 'startup() should return null, as action is allowed. %s');
  465. $this->Controller->Auth->allowedActions = ['delete', 'add'];
  466. $this->assertInstanceOf('Cake\Http\Response', $this->Controller->Auth->startup($event));
  467. $url = '/auth_test/delete';
  468. $this->Controller->request->addParams(Router::parse($url));
  469. $this->Controller->request->query['url'] = Router::normalize($url);
  470. $this->Controller->Auth->loginAction = ['controller' => 'AuthTest', 'action' => 'login'];
  471. $this->Controller->Auth->userModel = 'AuthUsers';
  472. $this->Controller->Auth->allow(['delete', 'add']);
  473. $result = $this->Controller->Auth->startup($event);
  474. $this->assertNull($result, 'startup() should return null, as action is allowed. %s');
  475. }
  476. /**
  477. * testAllowedActionsSetWithAllowMethod method
  478. *
  479. * @return void
  480. */
  481. public function testAllowedActionsSetWithAllowMethod()
  482. {
  483. $url = '/auth_test/action_name';
  484. $this->Controller->request->addParams(Router::parse($url));
  485. $this->Controller->request->query['url'] = Router::normalize($url);
  486. $this->Controller->Auth->allow(['action_name', 'anotherAction']);
  487. $this->assertEquals(['action_name', 'anotherAction'], $this->Controller->Auth->allowedActions);
  488. }
  489. /**
  490. * testLoginRedirect method
  491. *
  492. * @return void
  493. * @triggers Controller.startup $this->Controller
  494. */
  495. public function testLoginRedirect()
  496. {
  497. $this->Auth->session->write('Auth', [
  498. 'AuthUsers' => ['id' => '1', 'username' => 'nate']
  499. ]);
  500. $this->Auth->request->addParams(Router::parse('users/login'));
  501. $this->Auth->request->url = 'users/login';
  502. $this->Auth->request->env('HTTP_REFERER', false);
  503. $this->Auth->config('loginRedirect', [
  504. 'controller' => 'pages',
  505. 'action' => 'display',
  506. 'welcome'
  507. ]);
  508. $event = new Event('Controller.startup', $this->Controller);
  509. $this->Auth->startup($event);
  510. $expected = Router::normalize($this->Auth->config('loginRedirect'));
  511. $this->assertEquals($expected, $this->Auth->redirectUrl());
  512. $this->Auth->session->delete('Auth');
  513. $url = '/posts/view/1';
  514. $this->Auth->session->write(
  515. 'Auth',
  516. ['AuthUsers' => ['id' => '1', 'username' => 'nate']]
  517. );
  518. $this->Auth->request->addParams(Router::parse($url));
  519. $this->Auth->request->here = $url;
  520. $this->Auth->config('authorize', 'controller');
  521. $this->Auth->config('loginAction', [
  522. 'controller' => 'AuthTest', 'action' => 'login'
  523. ]);
  524. $event = new Event('Controller.startup', $this->Controller);
  525. $response = $this->Auth->startup($event);
  526. $expected = Router::url([
  527. 'controller' => 'AuthTest', 'action' => 'login', '?' => ['redirect' => $url]
  528. ], true);
  529. $redirectHeader = $response->header()['Location'];
  530. $this->assertEquals($expected, $redirectHeader);
  531. // Auth.redirect gets set when accessing a protected action without being authenticated
  532. $this->Auth->session->delete('Auth');
  533. $url = '/posts/view/1';
  534. $this->Auth->request->addParams(Router::parse($url));
  535. $this->Auth->request->url = $this->Auth->request->here = Router::normalize($url);
  536. $this->Auth->config('loginAction', ['controller' => 'AuthTest', 'action' => 'login']);
  537. $event = new Event('Controller.startup', $this->Controller);
  538. $response = $this->Auth->startup($event);
  539. $this->assertInstanceOf('Cake\Http\Response', $response);
  540. $expected = Router::url(['controller' => 'AuthTest', 'action' => 'login', '?' => ['redirect' => '/posts/view/1']], true);
  541. $redirectHeader = $response->header()['Location'];
  542. $this->assertEquals($expected, $redirectHeader);
  543. }
  544. /**
  545. * testLoginRedirect method with non GET
  546. *
  547. * @return void
  548. */
  549. public function testLoginRedirectPost()
  550. {
  551. $this->Auth->session->delete('Auth');
  552. $url = '/posts/view/1';
  553. $this->Auth->request->addParams(Router::parse($url));
  554. $this->Auth->request->env('HTTP_REFERER', Router::url('/foo/bar', true));
  555. $this->Auth->request->env('REQUEST_METHOD', 'POST');
  556. $this->Auth->request->url = $this->Auth->request->here = Router::normalize($url);
  557. $this->Auth->config('loginAction', ['controller' => 'AuthTest', 'action' => 'login']);
  558. $event = new Event('Controller.startup', $this->Controller);
  559. $response = $this->Auth->startup($event);
  560. $this->assertInstanceOf('Cake\Http\Response', $response);
  561. $expected = Router::url(['controller' => 'AuthTest', 'action' => 'login', '?' => ['redirect' => '/foo/bar']], true);
  562. $redirectHeader = $response->header()['Location'];
  563. $this->assertEquals($expected, $redirectHeader);
  564. }
  565. /**
  566. * testLoginRedirect method with non GET and no referrer
  567. *
  568. * @return void
  569. */
  570. public function testLoginRedirectPostNoReferer()
  571. {
  572. $this->Auth->session->delete('Auth');
  573. $url = '/posts/view/1';
  574. $this->Auth->request->addParams(Router::parse($url));
  575. $this->Auth->request->env('REQUEST_METHOD', 'POST');
  576. $this->Auth->request->url = $this->Auth->request->here = Router::normalize($url);
  577. $this->Auth->config('loginAction', ['controller' => 'AuthTest', 'action' => 'login']);
  578. $event = new Event('Controller.startup', $this->Controller);
  579. $response = $this->Auth->startup($event);
  580. $this->assertInstanceOf('Cake\Http\Response', $response);
  581. $expected = Router::url(['controller' => 'AuthTest', 'action' => 'login'], true);
  582. $redirectHeader = $response->header()['Location'];
  583. $this->assertEquals($expected, $redirectHeader);
  584. }
  585. /**
  586. * @return void
  587. */
  588. public function testLoginRedirectQueryString()
  589. {
  590. // QueryString parameters are preserved when redirecting with redirect key
  591. $this->Auth->session->delete('Auth');
  592. $url = '/posts/view/29';
  593. $this->Auth->request->addParams(Router::parse($url));
  594. $this->Auth->request->url = $this->Auth->request->here = Router::normalize($url);
  595. $this->Auth->request->query = [
  596. 'print' => 'true',
  597. 'refer' => 'menu'
  598. ];
  599. $this->Auth->config('loginAction', ['controller' => 'AuthTest', 'action' => 'login']);
  600. $event = new Event('Controller.startup', $this->Controller);
  601. $response = $this->Auth->startup($event);
  602. $expected = Router::url(['controller' => 'AuthTest', 'action' => 'login', '?' => ['redirect' => '/posts/view/29?print=true&refer=menu']], true);
  603. $redirectHeader = $response->header()['Location'];
  604. $this->assertEquals($expected, $redirectHeader);
  605. }
  606. /**
  607. * @return void
  608. */
  609. public function testLoginRedirectQueryStringWithComplexLoginActionUrl()
  610. {
  611. $this->Auth->session->delete('Auth');
  612. $url = '/posts/view/29';
  613. $this->Auth->request->addParams(Router::parse($url));
  614. $this->Auth->request->url = $this->Auth->request->here = Router::normalize($url);
  615. $this->Auth->request->query = [
  616. 'print' => 'true',
  617. 'refer' => 'menu'
  618. ];
  619. $this->Auth->session->delete('Auth');
  620. $this->Auth->config('loginAction', '/auth_test/login/passed-param?a=b');
  621. $event = new Event('Controller.startup', $this->Controller);
  622. $response = $this->Auth->startup($event);
  623. $redirectHeader = $response->header()['Location'];
  624. $expected = Router::url(['controller' => 'AuthTest', 'action' => 'login', 'passed-param', '?' => ['a' => 'b', 'redirect' => '/posts/view/29?print=true&refer=menu']], true);
  625. $this->assertEquals($expected, $redirectHeader);
  626. }
  627. /**
  628. * @return void
  629. */
  630. public function testLoginRedirectDifferentBaseUrl()
  631. {
  632. $appConfig = Configure::read('App');
  633. Configure::write('App', [
  634. 'dir' => APP_DIR,
  635. 'webroot' => 'webroot',
  636. 'base' => false,
  637. 'baseUrl' => '/cake/index.php'
  638. ]);
  639. $this->Auth->session->delete('Auth');
  640. $url = '/posts/add';
  641. $this->Auth->request = $this->Controller->request = new ServerRequest($url);
  642. $this->Auth->request->env('REQUEST_METHOD', 'GET');
  643. $this->Auth->request->addParams(Router::parse($url));
  644. $this->Auth->request->url = Router::normalize($url);
  645. $this->Auth->config('loginAction', ['controller' => 'Users', 'action' => 'login']);
  646. $event = new Event('Controller.startup', $this->Controller);
  647. $response = $this->Auth->startup($event);
  648. $expected = Router::url(['controller' => 'Users', 'action' => 'login', '?' => ['redirect' => '/posts/add']], true);
  649. $redirectHeader = $response->header()['Location'];
  650. $this->assertEquals($expected, $redirectHeader);
  651. $this->Auth->session->delete('Auth');
  652. Configure::write('App', $appConfig);
  653. }
  654. /**
  655. * testNoLoginRedirectForAuthenticatedUser method
  656. *
  657. * @return void
  658. * @triggers Controller.startup $this->Controller
  659. */
  660. public function testNoLoginRedirectForAuthenticatedUser()
  661. {
  662. $this->Controller->request['controller'] = 'auth_test';
  663. $this->Controller->request['action'] = 'login';
  664. $this->Controller->here = '/auth_test/login';
  665. $this->Auth->request->url = 'auth_test/login';
  666. $this->Auth->session->write('Auth.User.id', '1');
  667. $this->Auth->config('authenticate', ['Form']);
  668. $this->getMockBuilder(BaseAuthorize::class)
  669. ->setMethods(['authorize'])
  670. ->disableOriginalConstructor()
  671. ->setMockClassName('NoLoginRedirectMockAuthorize')
  672. ->getMock();
  673. $this->Auth->config('authorize', ['NoLoginRedirectMockAuthorize']);
  674. $this->Auth->config('loginAction', ['controller' => 'auth_test', 'action' => 'login']);
  675. $event = new Event('Controller.startup', $this->Controller);
  676. $return = $this->Auth->startup($event);
  677. $this->assertNull($return);
  678. $this->assertNull($this->Controller->testUrl);
  679. }
  680. /**
  681. * Default to loginRedirect, if set, on authError.
  682. *
  683. * @return void
  684. * @triggers Controller.startup $Controller
  685. */
  686. public function testDefaultToLoginRedirect()
  687. {
  688. $url = '/party/on';
  689. $this->Auth->request = $request = new ServerRequest($url);
  690. $request->env('HTTP_REFERER', false);
  691. $request->addParams(Router::parse($url));
  692. $request->addPaths([
  693. 'base' => 'dirname',
  694. 'webroot' => '/dirname/',
  695. ]);
  696. Router::pushRequest($request);
  697. $this->Auth->config('authorize', ['Controller']);
  698. $this->Auth->setUser(['username' => 'mariano', 'password' => 'cake']);
  699. $this->Auth->config('loginRedirect', [
  700. 'controller' => 'something',
  701. 'action' => 'else'
  702. ]);
  703. $response = new Response();
  704. $Controller = $this->getMockBuilder('Cake\Controller\Controller')
  705. ->setMethods(['on', 'redirect'])
  706. ->setConstructorArgs([$request, $response])
  707. ->getMock();
  708. $event = new Event('Controller.startup', $Controller);
  709. // Should not contain basedir when redirect is called.
  710. $expected = '/something/else';
  711. $Controller->expects($this->once())
  712. ->method('redirect')
  713. ->with($this->equalTo($expected));
  714. $this->Auth->startup($event);
  715. }
  716. /**
  717. * testRedirectToUnauthorizedRedirect
  718. *
  719. * @return void
  720. * @triggers Controller.startup $Controller
  721. */
  722. public function testRedirectToUnauthorizedRedirect()
  723. {
  724. $url = '/party/on';
  725. $this->Auth->Flash = $this->getMockBuilder('Cake\Controller\Component\FlashComponent')
  726. ->setMethods(['set'])
  727. ->setConstructorArgs([$this->Controller->components()])
  728. ->getMock();
  729. $this->Auth->request = $request = new ServerRequest([
  730. 'url' => $url,
  731. 'session' => $this->Auth->session
  732. ]);
  733. $this->Auth->request->addParams(Router::parse($url));
  734. $this->Auth->config('authorize', ['Controller']);
  735. $this->Auth->setUser(['username' => 'admad', 'password' => 'cake']);
  736. $expected = ['controller' => 'no_can_do', 'action' => 'jack'];
  737. $this->Auth->config('unauthorizedRedirect', $expected);
  738. $response = new Response();
  739. $Controller = $this->getMockBuilder('Cake\Controller\Controller')
  740. ->setMethods(['on', 'redirect'])
  741. ->setConstructorArgs([$request, $response])
  742. ->getMock();
  743. $Controller->expects($this->once())
  744. ->method('redirect')
  745. ->with($this->equalTo($expected));
  746. $this->Auth->Flash->expects($this->once())
  747. ->method('set');
  748. $event = new Event('Controller.startup', $Controller);
  749. $this->Auth->startup($event);
  750. }
  751. /**
  752. * test unauthorized redirect defaults to loginRedirect
  753. * which is a string URL.
  754. *
  755. * @return void
  756. */
  757. public function testRedirectToUnauthorizedRedirectLoginAction()
  758. {
  759. $url = '/party/on';
  760. $this->Auth->Flash = $this->getMockBuilder('Cake\Controller\Component\FlashComponent')
  761. ->setMethods(['set'])
  762. ->setConstructorArgs([$this->Controller->components()])
  763. ->getMock();
  764. $this->Auth->request = $request = new ServerRequest([
  765. 'url' => $url,
  766. 'session' => $this->Auth->session
  767. ]);
  768. $this->Auth->request->addParams(Router::parse($url));
  769. $this->Auth->config('authorize', ['Controller']);
  770. $this->Auth->setUser(['username' => 'admad', 'password' => 'cake']);
  771. $this->Auth->config('unauthorizedRedirect', true);
  772. $this->Auth->config('loginAction', '/users/login');
  773. $response = new Response();
  774. $Controller = $this->getMockBuilder('Cake\Controller\Controller')
  775. ->setMethods(['on', 'redirect'])
  776. ->setConstructorArgs([$request, $response])
  777. ->getMock();
  778. // Uses referrer instead of loginAction.
  779. $Controller->expects($this->once())
  780. ->method('redirect')
  781. ->with($this->equalTo('/'));
  782. $event = new Event('Controller.startup', $Controller);
  783. $this->Auth->startup($event);
  784. }
  785. /**
  786. * testRedirectToUnauthorizedRedirectSuppressedAuthError
  787. *
  788. * @return void
  789. * @triggers Controller.startup $Controller
  790. */
  791. public function testRedirectToUnauthorizedRedirectSuppressedAuthError()
  792. {
  793. $url = '/party/on';
  794. $this->Auth->session = $this->getMockBuilder('Cake\Network\Session')
  795. ->setMethods(['flash'])
  796. ->getMock();
  797. $this->Auth->request = $Request = new ServerRequest($url);
  798. $this->Auth->request->addParams(Router::parse($url));
  799. $this->Auth->config('authorize', ['Controller']);
  800. $this->Auth->setUser(['username' => 'admad', 'password' => 'cake']);
  801. $expected = ['controller' => 'no_can_do', 'action' => 'jack'];
  802. $this->Auth->config('unauthorizedRedirect', $expected);
  803. $this->Auth->config('authError', false);
  804. $Response = new Response();
  805. $Controller = $this->getMockBuilder('Cake\Controller\Controller')
  806. ->setMethods(['on', 'redirect'])
  807. ->setConstructorArgs([$Request, $Response])
  808. ->getMock();
  809. $Controller->expects($this->once())
  810. ->method('redirect')
  811. ->with($this->equalTo($expected));
  812. $this->Auth->session->expects($this->never())
  813. ->method('flash');
  814. $event = new Event('Controller.startup', $Controller);
  815. $this->Auth->startup($event);
  816. }
  817. /**
  818. * Throw ForbiddenException if config `unauthorizedRedirect` is set to false
  819. *
  820. * @expectedException \Cake\Network\Exception\ForbiddenException
  821. * @return void
  822. * @triggers Controller.startup $Controller
  823. */
  824. public function testForbiddenException()
  825. {
  826. $url = '/party/on';
  827. $this->Auth->request = $request = new ServerRequest($url);
  828. $this->Auth->request->addParams(Router::parse($url));
  829. $this->Auth->config([
  830. 'authorize' => ['Controller'],
  831. 'unauthorizedRedirect' => false
  832. ]);
  833. $this->Auth->setUser(['username' => 'baker', 'password' => 'cake']);
  834. $response = new Response();
  835. $Controller = $this->getMockBuilder('Cake\Controller\Controller')
  836. ->setMethods(['on', 'redirect'])
  837. ->setConstructorArgs([$request, $response])
  838. ->getMock();
  839. $event = new Event('Controller.startup', $Controller);
  840. $this->Auth->startup($event);
  841. }
  842. /**
  843. * Test that no redirects or authorization tests occur on the loginAction
  844. *
  845. * @return void
  846. * @triggers Controller.startup $this->Controller
  847. */
  848. public function testNoRedirectOnLoginAction()
  849. {
  850. $event = new Event('Controller.startup', $this->Controller);
  851. $controller = $this->getMockBuilder('Cake\Controller\Controller')
  852. ->setMethods(['redirect'])
  853. ->getMock();
  854. $controller->methods = ['login'];
  855. $url = '/AuthTest/login';
  856. $this->Auth->request = $controller->request = new ServerRequest($url);
  857. $this->Auth->request->addParams(Router::parse($url));
  858. $this->Auth->config([
  859. 'loginAction', ['controller' => 'AuthTest', 'action' => 'login'],
  860. 'authorize', ['Controller']
  861. ]);
  862. $controller->expects($this->never())
  863. ->method('redirect');
  864. $this->Auth->startup($event);
  865. }
  866. /**
  867. * Ensure that no redirect is performed when a 404 is reached
  868. * And the user doesn't have a session.
  869. *
  870. * @return void
  871. * @triggers Controller.startup $this->Controller
  872. */
  873. public function testNoRedirectOn404()
  874. {
  875. $event = new Event('Controller.startup', $this->Controller);
  876. $this->Auth->session->delete('Auth');
  877. $this->Auth->request->addParams(Router::parse('auth_test/something_totally_wrong'));
  878. $result = $this->Auth->startup($event);
  879. $this->assertNull($result, 'Auth redirected a missing action %s');
  880. }
  881. /**
  882. * testAdminRoute method
  883. *
  884. * @return void
  885. * @triggers Controller.startup $this->Controller
  886. */
  887. public function testAdminRoute()
  888. {
  889. $event = new Event('Controller.startup', $this->Controller);
  890. Router::reload();
  891. Router::prefix('admin', function ($routes) {
  892. $routes->fallbacks(InflectedRoute::class);
  893. });
  894. Router::scope('/', function ($routes) {
  895. $routes->fallbacks(InflectedRoute::class);
  896. });
  897. $url = '/admin/auth_test/add';
  898. $this->Auth->request->addParams(Router::parse($url));
  899. $this->Auth->request->base = '';
  900. $this->Auth->request->here = $url;
  901. Router::setRequestInfo($this->Auth->request);
  902. $this->Auth->config('loginAction', [
  903. 'prefix' => 'admin',
  904. 'controller' => 'auth_test',
  905. 'action' => 'login'
  906. ]);
  907. $response = $this->Auth->startup($event);
  908. $redirectHeader = $response->header()['Location'];
  909. $expected = Router::url([
  910. 'prefix' => 'admin',
  911. 'controller' => 'auth_test',
  912. 'action' => 'login',
  913. '?' => ['redirect' => '/admin/auth_test/add']
  914. ], true);
  915. $this->assertEquals($expected, $redirectHeader);
  916. }
  917. /**
  918. * testAjaxLogin method
  919. *
  920. * @return void
  921. * @triggers Controller.startup $this->Controller
  922. */
  923. public function testAjaxLogin()
  924. {
  925. $this->Controller->request = new ServerRequest([
  926. 'url' => '/ajax_auth/add',
  927. 'environment' => ['HTTP_X_REQUESTED_WITH' => 'XMLHttpRequest'],
  928. ]);
  929. $this->Controller->request->params['action'] = 'add';
  930. $event = new Event('Controller.startup', $this->Controller);
  931. $this->Auth->config('ajaxLogin', 'test_element');
  932. $this->Auth->RequestHandler->ajaxLayout = 'ajax2';
  933. $response = $this->Auth->startup($event);
  934. $this->assertTrue($event->isStopped());
  935. $this->assertEquals(403, $response->statusCode());
  936. $this->assertEquals(
  937. "Ajax!\nthis is the test element",
  938. str_replace("\r\n", "\n", $response->body())
  939. );
  940. }
  941. /**
  942. * test ajax unauthenticated
  943. *
  944. * @return void
  945. * @triggers Controller.startup $this->Controller
  946. */
  947. public function testAjaxUnauthenticated()
  948. {
  949. $this->Controller->request = new ServerRequest([
  950. 'url' => '/ajax_auth/add',
  951. 'environment' => ['HTTP_X_REQUESTED_WITH' => 'XMLHttpRequest'],
  952. ]);
  953. $this->Controller->request->params['action'] = 'add';
  954. $event = new Event('Controller.startup', $this->Controller);
  955. $response = $this->Auth->startup($event);
  956. $this->assertTrue($event->isStopped());
  957. $this->assertEquals(403, $response->statusCode());
  958. $this->assertArrayNotHasKey('Location', $response->header());
  959. }
  960. /**
  961. * testLoginActionRedirect method
  962. *
  963. * @return void
  964. * @triggers Controller.startup $this->Controller
  965. */
  966. public function testLoginActionRedirect()
  967. {
  968. $event = new Event('Controller.startup', $this->Controller);
  969. Router::reload();
  970. Router::prefix('admin', function ($routes) {
  971. $routes->fallbacks(InflectedRoute::class);
  972. });
  973. Router::scope('/', function ($routes) {
  974. $routes->fallbacks(InflectedRoute::class);
  975. });
  976. $url = '/admin/auth_test/login';
  977. $request = $this->Auth->request;
  978. $request->addParams([
  979. 'plugin' => null,
  980. 'controller' => 'auth_test',
  981. 'action' => 'login',
  982. 'prefix' => 'admin',
  983. 'pass' => [],
  984. ])->addPaths([
  985. 'base' => null,
  986. 'here' => $url,
  987. 'webroot' => '/',
  988. ]);
  989. $request->url = ltrim($url, '/');
  990. Router::setRequestInfo($request);
  991. $this->Auth->config('loginAction', [
  992. 'prefix' => 'admin',
  993. 'controller' => 'auth_test',
  994. 'action' => 'login'
  995. ]);
  996. $this->Auth->startup($event);
  997. $this->assertNull($this->Controller->testUrl);
  998. }
  999. /**
  1000. * Stateless auth methods like Basic should populate data that can be
  1001. * accessed by $this->user().
  1002. *
  1003. * @return void
  1004. * @triggers Controller.startup $this->Controller
  1005. */
  1006. public function testStatelessAuthWorksWithUser()
  1007. {
  1008. $event = new Event('Controller.startup', $this->Controller);
  1009. $url = '/auth_test/add';
  1010. $this->Auth->request->addParams(Router::parse($url));
  1011. $this->Auth->request->env('PHP_AUTH_USER', 'mariano');
  1012. $this->Auth->request->env('PHP_AUTH_PW', 'cake');
  1013. $this->Auth->config('authenticate', [
  1014. 'Basic' => ['userModel' => 'AuthUsers']
  1015. ]);
  1016. $this->Auth->config('storage', 'Memory');
  1017. $this->Auth->startup($event);
  1018. $result = $this->Auth->user();
  1019. $this->assertEquals('mariano', $result['username']);
  1020. $this->assertInstanceOf(
  1021. 'Cake\Auth\BasicAuthenticate',
  1022. $this->Auth->authenticationProvider()
  1023. );
  1024. $result = $this->Auth->user('username');
  1025. $this->assertEquals('mariano', $result);
  1026. $this->assertFalse(isset($_SESSION['Auth']), 'No user data in session');
  1027. }
  1028. /**
  1029. * test $settings in Controller::$components
  1030. *
  1031. * @return void
  1032. */
  1033. public function testComponentSettings()
  1034. {
  1035. $this->Auth->config([
  1036. 'loginAction' => ['controller' => 'people', 'action' => 'login'],
  1037. 'logoutRedirect' => ['controller' => 'people', 'action' => 'login'],
  1038. ]);
  1039. $expected = [
  1040. 'loginAction' => ['controller' => 'people', 'action' => 'login'],
  1041. 'logoutRedirect' => ['controller' => 'people', 'action' => 'login'],
  1042. ];
  1043. $this->assertEquals(
  1044. $expected['loginAction'],
  1045. $this->Auth->config('loginAction')
  1046. );
  1047. $this->assertEquals(
  1048. $expected['logoutRedirect'],
  1049. $this->Auth->config('logoutRedirect')
  1050. );
  1051. }
  1052. /**
  1053. * test that logout deletes the session variables. and returns the correct URL
  1054. *
  1055. * @return void
  1056. */
  1057. public function testLogout()
  1058. {
  1059. $this->Auth->session->write('Auth.User.id', '1');
  1060. $this->Auth->config('logoutRedirect', '/');
  1061. $result = $this->Auth->logout();
  1062. $this->assertEquals('/', $result);
  1063. $this->assertNull($this->Auth->session->read('Auth.AuthUsers'));
  1064. }
  1065. /**
  1066. * Test that Auth.afterIdentify and Auth.logout events are triggered
  1067. *
  1068. * @return void
  1069. */
  1070. public function testEventTriggering()
  1071. {
  1072. $this->Auth->config('authenticate', [
  1073. 'Test' => ['className' => 'TestApp\Auth\TestAuthenticate']
  1074. ]);
  1075. $user = $this->Auth->identify();
  1076. $this->Auth->logout();
  1077. $authObject = $this->Auth->authenticationProvider();
  1078. $expected = ['afterIdentify', 'logout'];
  1079. $this->assertEquals($expected, $authObject->callStack);
  1080. $expected = ['id' => 1, 'username' => 'admad'];
  1081. $this->assertEquals($expected, $user);
  1082. $this->assertInstanceOf(
  1083. 'TestApp\Auth\TestAuthenticate',
  1084. $authObject->authenticationProvider
  1085. );
  1086. // Callback for Auth.afterIdentify returns a value
  1087. $authObject->modifiedUser = true;
  1088. $user = $this->Auth->identify();
  1089. $expected = ['id' => 1, 'username' => 'admad', 'extra' => 'foo'];
  1090. $this->assertEquals($expected, $user);
  1091. }
  1092. /**
  1093. * testAfterIdentifyForStatelessAuthentication
  1094. *
  1095. * @return void
  1096. * @triggers Controller.startup $this->Controller
  1097. */
  1098. public function testAfterIdentifyForStatelessAuthentication()
  1099. {
  1100. $event = new Event('Controller.startup', $this->Controller);
  1101. $url = '/auth_test/add';
  1102. $this->Auth->request->addParams(Router::parse($url));
  1103. $this->Auth->request->env('PHP_AUTH_USER', 'mariano');
  1104. $this->Auth->request->env('PHP_AUTH_PW', 'cake');
  1105. $this->Auth->config('authenticate', [
  1106. 'Basic' => ['userModel' => 'AuthUsers']
  1107. ]);
  1108. $this->Auth->config('storage', 'Memory');
  1109. EventManager::instance()->on('Auth.afterIdentify', function (Event $event) {
  1110. $user = $event->getData(0);
  1111. $user['from_callback'] = true;
  1112. return $user;
  1113. });
  1114. $this->Auth->startup($event);
  1115. $this->assertEquals('mariano', $this->Auth->user('username'));
  1116. $this->assertTrue($this->Auth->user('from_callback'));
  1117. }
  1118. /**
  1119. * test setting user info to session.
  1120. *
  1121. * @return void
  1122. */
  1123. public function testSetUser()
  1124. {
  1125. $storage = $this->getMockBuilder('Cake\Auth\Storage\SessionStorage')
  1126. ->setMethods(['write'])
  1127. ->setConstructorArgs([$this->Auth->request, $this->Auth->response])
  1128. ->getMock();
  1129. $this->Auth->storage($storage);
  1130. $user = ['username' => 'mark', 'role' => 'admin'];
  1131. $storage->expects($this->once())
  1132. ->method('write')
  1133. ->with($user);
  1134. $this->Auth->setUser($user);
  1135. }
  1136. /**
  1137. * testGettingUserAfterSetUser
  1138. *
  1139. * @return void
  1140. */
  1141. public function testGettingUserAfterSetUser()
  1142. {
  1143. $this->assertFalse((bool)$this->Auth->user());
  1144. $user = [
  1145. 'username' => 'mariano',
  1146. 'password' => '$2a$10$u05j8FjsvLBNdfhBhc21LOuVMpzpabVXQ9OpC2wO3pSO0q6t7HHMO',
  1147. 'created' => new \DateTime('2007-03-17 01:16:23'),
  1148. 'updated' => new \DateTime('2007-03-17 01:18:31')
  1149. ];
  1150. $this->Auth->setUser($user);
  1151. $this->assertTrue((bool)$this->Auth->user());
  1152. $this->assertEquals($user['username'], $this->Auth->user('username'));
  1153. }
  1154. /**
  1155. * test flash settings.
  1156. *
  1157. * @return void
  1158. * @triggers Controller.startup $this->Controller)
  1159. */
  1160. public function testFlashSettings()
  1161. {
  1162. $this->Auth->Flash = $this->getMockBuilder('Cake\Controller\Component\FlashComponent')
  1163. ->setConstructorArgs([$this->Controller->components()])
  1164. ->getMock();
  1165. $this->Controller->request->params['action'] = 'add';
  1166. $this->Auth->startup(new Event('Controller.startup', $this->Controller));
  1167. $this->Auth->Flash->expects($this->at(0))
  1168. ->method('set')
  1169. ->with(
  1170. 'Auth failure',
  1171. [
  1172. 'key' => 'auth-key',
  1173. 'element' => 'error',
  1174. 'params' => ['class' => 'error']
  1175. ]
  1176. );
  1177. $this->Auth->Flash->expects($this->at(1))
  1178. ->method('set')
  1179. ->with('Auth failure', ['key' => 'auth-key', 'element' => 'custom']);
  1180. $this->Auth->config('flash', [
  1181. 'key' => 'auth-key'
  1182. ]);
  1183. $this->Auth->flash('Auth failure');
  1184. $this->Auth->config('flash', [
  1185. 'key' => 'auth-key',
  1186. 'element' => 'custom'
  1187. ], false);
  1188. $this->Auth->flash('Auth failure');
  1189. }
  1190. /**
  1191. * test the various states of Auth::redirect()
  1192. *
  1193. * @return void
  1194. */
  1195. public function testRedirectSet()
  1196. {
  1197. $value = ['controller' => 'users', 'action' => 'home'];
  1198. $result = $this->Auth->redirectUrl($value);
  1199. $this->assertEquals('/users/home', $result);
  1200. }
  1201. /**
  1202. * Tests redirect using redirect key from the query string.
  1203. *
  1204. * @return void
  1205. */
  1206. public function testRedirectQueryStringRead()
  1207. {
  1208. $this->Auth->config('loginAction', ['controller' => 'users', 'action' => 'login']);
  1209. $this->Auth->request->query = ['redirect' => '/users/custom'];
  1210. $result = $this->Auth->redirectUrl();
  1211. $this->assertEquals('/users/custom', $result);
  1212. }
  1213. /**
  1214. * Tests redirectUrl with duplicate base.
  1215. *
  1216. * @return void
  1217. */
  1218. public function testRedirectQueryStringReadDuplicateBase()
  1219. {
  1220. $this->Auth->request->webroot = '/waves/';
  1221. $this->Auth->request->base = '/waves';
  1222. $this->Auth->request->query = ['redirect' => '/waves/add'];
  1223. Router::setRequestInfo($this->Auth->request);
  1224. $result = $this->Auth->redirectUrl();
  1225. $this->assertEquals('/waves/add', $result);
  1226. }
  1227. /**
  1228. * test that redirect does not return loginAction if that is what's passed as redirect.
  1229. * instead loginRedirect should be used.
  1230. *
  1231. * @return void
  1232. */
  1233. public function testRedirectQueryStringReadEqualToLoginAction()
  1234. {
  1235. $this->Auth->config([
  1236. 'loginAction' => ['controller' => 'users', 'action' => 'login'],
  1237. 'loginRedirect' => ['controller' => 'users', 'action' => 'home']
  1238. ]);
  1239. $this->Auth->request->query = ['redirect' => '/users/login'];
  1240. $result = $this->Auth->redirectUrl();
  1241. $this->assertEquals('/users/home', $result);
  1242. }
  1243. /**
  1244. * Tests that redirect does not return loginAction if that contains a host,
  1245. * instead loginRedirect should be used.
  1246. *
  1247. * @return void
  1248. */
  1249. public function testRedirectQueryStringInvalid()
  1250. {
  1251. $this->Auth->config([
  1252. 'loginAction' => ['controller' => 'users', 'action' => 'login'],
  1253. 'loginRedirect' => ['controller' => 'users', 'action' => 'home']
  1254. ]);
  1255. $this->Auth->request->query = ['redirect' => 'http://some.domain.example/users/login'];
  1256. $result = $this->Auth->redirectUrl();
  1257. $this->assertEquals('/users/home', $result);
  1258. $this->Auth->request->query = ['redirect' => '//some.domain.example/users/login'];
  1259. $result = $this->Auth->redirectUrl();
  1260. $this->assertEquals('/users/home', $result);
  1261. }
  1262. /**
  1263. * test that the returned URL doesn't contain the base URL.
  1264. *
  1265. * @return void This test method doesn't return anything.
  1266. */
  1267. public function testRedirectUrlWithBaseSet()
  1268. {
  1269. $App = Configure::read('App');
  1270. Configure::write('App', [
  1271. 'dir' => APP_DIR,
  1272. 'webroot' => 'webroot',
  1273. 'base' => false,
  1274. 'baseUrl' => '/cake/index.php'
  1275. ]);
  1276. $url = '/users/login';
  1277. $this->Auth->request = $this->Controller->request = new ServerRequest($url);
  1278. $this->Auth->request->addParams(Router::parse($url));
  1279. $this->Auth->request->url = Router::normalize($url);
  1280. Router::setRequestInfo($this->Auth->request);
  1281. $this->Auth->config('loginAction', ['controller' => 'users', 'action' => 'login']);
  1282. $this->Auth->config('loginRedirect', ['controller' => 'users', 'action' => 'home']);
  1283. $result = $this->Auth->redirectUrl();
  1284. $this->assertEquals('/users/home', $result);
  1285. Configure::write('App', $App);
  1286. Router::reload();
  1287. }
  1288. /**
  1289. * testUser method
  1290. *
  1291. * @return void
  1292. */
  1293. public function testUser()
  1294. {
  1295. $data = [
  1296. 'User' => [
  1297. 'id' => '2',
  1298. 'username' => 'mark',
  1299. 'group_id' => 1,
  1300. 'Group' => [
  1301. 'id' => '1',
  1302. 'name' => 'Members'
  1303. ],
  1304. 'is_admin' => false,
  1305. ]];
  1306. $this->Auth->session->write('Auth', $data);
  1307. $result = $this->Auth->user();
  1308. $this->assertEquals($data['User'], $result);
  1309. $result = $this->Auth->user('username');
  1310. $this->assertEquals($data['User']['username'], $result);
  1311. $result = $this->Auth->user('Group.name');
  1312. $this->assertEquals($data['User']['Group']['name'], $result);
  1313. $result = $this->Auth->user('invalid');
  1314. $this->assertEquals(null, $result);
  1315. $result = $this->Auth->user('Company.invalid');
  1316. $this->assertEquals(null, $result);
  1317. $result = $this->Auth->user('is_admin');
  1318. $this->assertFalse($result);
  1319. }
  1320. /**
  1321. * testStatelessAuthNoRedirect method
  1322. *
  1323. * @expectedException \Cake\Network\Exception\UnauthorizedException
  1324. * @expectedExceptionCode 401
  1325. * @return void
  1326. * @triggers Controller.startup $this->Controller
  1327. */
  1328. public function testStatelessAuthNoRedirect()
  1329. {
  1330. $event = new Event('Controller.startup', $this->Controller);
  1331. $_SESSION = [];
  1332. $this->Auth->config('authenticate', ['Basic']);
  1333. $this->Controller->request['action'] = 'add';
  1334. $result = $this->Auth->startup($event);
  1335. }
  1336. /**
  1337. * testStatelessAuthRedirect method
  1338. *
  1339. * @return void
  1340. * @triggers Controller.startup $this->Controller
  1341. */
  1342. public function testStatelessAuthRedirectToLogin()
  1343. {
  1344. $this->Auth->response = $this->getMockBuilder('Cake\Http\Response')
  1345. ->setMethods(['stop', 'statusCode', 'send'])
  1346. ->getMock();
  1347. $event = new Event('Controller.startup', $this->Controller);
  1348. $this->Auth->authenticate = ['Basic', 'Form'];
  1349. $this->Controller->request['action'] = 'add';
  1350. $this->Auth->response->expects($this->never())->method('statusCode');
  1351. $this->Auth->response->expects($this->never())->method('send');
  1352. $this->assertInstanceOf('Cake\Http\Response', $this->Auth->startup($event));
  1353. $this->assertEquals('/users/login?redirect=%2Fauth_test', $this->Controller->testUrl);
  1354. }
  1355. /**
  1356. * test for BC getting/setting AuthComponent::$sessionKey gets/sets `key`
  1357. * config of session storage.
  1358. *
  1359. * @return void
  1360. */
  1361. public function testSessionKeyBC()
  1362. {
  1363. $this->assertEquals('Auth.User', $this->Auth->sessionKey);
  1364. $this->Auth->sessionKey = 'Auth.Member';
  1365. $this->assertEquals('Auth.Member', $this->Auth->sessionKey);
  1366. $this->assertEquals('Auth.Member', $this->Auth->storage()->config('key'));
  1367. $this->Auth->sessionKey = false;
  1368. $this->assertInstanceOf('Cake\Auth\Storage\MemoryStorage', $this->Auth->storage());
  1369. }
  1370. /**
  1371. * Test that setting config 'earlyAuth' to true make AuthComponent do the initial
  1372. * checks in beforeFilter() instead of startup().
  1373. *
  1374. * @return void
  1375. */
  1376. public function testCheckAuthInConfig()
  1377. {
  1378. $this->Controller->components()->set('Auth', $this->Auth);
  1379. $this->Auth->earlyAuthTest = true;
  1380. $this->Auth->authCheckCalledFrom = null;
  1381. $this->Controller->startupProcess();
  1382. $this->assertEquals('Controller.startup', $this->Auth->authCheckCalledFrom);
  1383. $this->Auth->authCheckCalledFrom = null;
  1384. $this->Auth->config('checkAuthIn', 'Controller.initialize');
  1385. $this->Controller->startupProcess();
  1386. $this->assertEquals('Controller.initialize', $this->Auth->authCheckCalledFrom);
  1387. }
  1388. }