Add tests for configuring cookie creation.

cakephp · Nov 8, 2013 · b9113aa · b9113aa
1 parent 9d62f2d
commit b9113aa
Show file tree

Hide file tree

Showing 2 changed files with 82 additions and 0 deletions.
diff --git a/Cake/Controller/Component/CsrfComponent.php b/Cake/Controller/Component/CsrfComponent.php
@@ -62,6 +62,9 @@ class CsrfComponent extends Component {
  * the request is a GET request, and the cookie value
  * is absent a cookie will be set.
  *
+ * RequestAction requests do not get checked, nor will
+ * they set a cookie should it be missing.
+ *
  * @param Cake\Event\Event $event
  * @return void
  */
@@ -71,6 +74,10 @@ public function startup(Event $event) {
 		$response = $controller->response;
 		$cookieName = $this->settings['cookieName'];
 
+		if ($request->is('requested')) {
+			return;
+		}
+
 		if ($request->is('get') && $request->cookie($cookieName) === null) {
 			$this->_setCookie($request, $response);
 		}

diff --git a/Cake/Test/TestCase/Controller/Component/CsrfComponentTest.php b/Cake/Test/TestCase/Controller/Component/CsrfComponentTest.php
@@ -164,4 +164,79 @@ public function testInvalidTokenRequestData($method) {
 		$this->component->startUp($event);
 	}
 
+/**
+ * Test that CSRF checks are not applied to request action requests.
+ *
+ * @return void
+ */
+	public function testCsrfValidationSkipsRequestAction() {
+		$_SERVER['REQUEST_METHOD'] = 'POST';
+
+		$controller = $this->getMock('Cake\Controller\Controller');
+		$controller->request = new Request([
+			'params' => ['requested' => 1],
+			'post' => ['_csrfToken' => 'nope'],
+			'cookies' => ['csrfToken' => 'testing123']
+		]);
+		$controller->response = new Response();
+
+		$event = new Event('Controller.startup', $controller);
+		$result = $this->component->startUp($event);
+		$this->assertNull($result, 'No error.');
+	}
+
+/**
+ * Test that the configuration options work.
+ *
+ * @return void
+ */
+	public function testConfigurationCookieCreate() {
+		$_SERVER['REQUEST_METHOD'] = 'GET';
+
+		$controller = $this->getMock('Cake\Controller\Controller');
+		$controller->request = new Request(['base' => '/dir']);
+		$controller->response = new Response();
+
+		$component = new CsrfComponent($this->registry, [
+			'cookieName' => 'token',
+			'expiry' => 90,
+		]);
+
+		$event = new Event('Controller.startup', $controller);
+		$component->startUp($event);
+
+		$this->assertEmpty($controller->response->cookie('csrfToken'));
+		$cookie = $controller->response->cookie('token');
+		$this->assertNotEmpty($cookie, 'Should set a token.');
+		$this->assertRegExp('/^[a-f0-9]+$/', $cookie['value'], 'Should look like a hash.');
+		$this->assertEquals(90, $cookie['expiry'], 'session duration.');
+		$this->assertEquals('/dir', $cookie['path'], 'session path.');
+	}
+
+/**
+ * Test that the configuration options work.
+ *
+ * @return void
+ */
+	public function testConfigurationValidate() {
+		$_SERVER['REQUEST_METHOD'] = 'POST';
+
+		$controller = $this->getMock('Cake\Controller\Controller');
+		$controller->request = new Request([
+			'cookies' => ['csrfToken' => 'nope', 'token' => 'yes'],
+			'post' => ['_csrfToken' => 'no match', 'token' => 'yes'],
+		]);
+		$controller->response = new Response();
+
+		$component = new CsrfComponent($this->registry, [
+			'cookieName' => 'token',
+			'field' => 'token',
+			'expiry' => 90,
+		]);
+
+		$event = new Event('Controller.startup', $controller);
+		$result = $component->startUp($event);
+		$this->assertNull($result, 'Config settings should work.');
+	}
+
 }