AuthComponentTest.php 55 KB

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