AuthComponentTest.php 57 KB

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