/
CsrfComponentTest.php
247 lines (211 loc) · 7.05 KB
/
CsrfComponentTest.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Test\TestCase\Controller\Component;
use Cake\Controller\ComponentRegistry;
use Cake\Controller\Component\CsrfComponent;
use Cake\Event\Event;
use Cake\Network\Request;
use Cake\Network\Response;
use Cake\TestSuite\TestCase;
/**
* CsrfComponent test.
*/
class CsrfComponentTest extends TestCase {
/**
* setup
*
* @return void
*/
public function setUp() {
parent::setUp();
$controller = $this->getMock('Cake\Controller\Controller');
$this->registry = new ComponentRegistry($controller);
$this->component = new CsrfComponent($this->registry);
}
/**
* teardown
*
* @return void
*/
public function tearDown() {
parent::tearDown();
unset($this->component);
}
/**
* Test setting the cookie value
*
* @return void
*/
public function testSettingCookie() {
$_SERVER['REQUEST_METHOD'] = 'GET';
$controller = $this->getMock('Cake\Controller\Controller');
$controller->request = new Request(['base' => '/dir']);
$controller->response = new Response();
$event = new Event('Controller.startup', $controller);
$this->component->startUp($event);
$cookie = $controller->response->cookie('csrfToken');
$this->assertNotEmpty($cookie, 'Should set a token.');
$this->assertRegExp('/^[a-f0-9]+$/', $cookie['value'], 'Should look like a hash.');
$this->assertEquals(0, $cookie['expiry'], 'session duration.');
$this->assertEquals('/dir', $cookie['path'], 'session path.');
$this->assertEquals($cookie['value'], $controller->request->params['_csrfToken']);
}
/**
* Data provider for HTTP method tests.
*
* @return void
*/
public static function httpMethodProvider() {
return [
['PATCH'], ['PUT'], ['POST'], ['DELETE']
];
}
/**
* Test that the X-CSRF-Token works with the various http methods.
*
* @dataProvider httpMethodProvider
* @return void
*/
public function testValidTokenInHeader($method) {
$_SERVER['REQUEST_METHOD'] = $method;
$_SERVER['HTTP_X_CSRF_TOKEN'] = 'testing123';
$controller = $this->getMock('Cake\Controller\Controller');
$controller->request = new Request(['cookies' => ['csrfToken' => 'testing123']]);
$controller->response = new Response();
$event = new Event('Controller.startup', $controller);
$result = $this->component->startUp($event);
$this->assertNull($result, 'No exception means valid.');
}
/**
* Test that the X-CSRF-Token works with the various http methods.
*
* @dataProvider httpMethodProvider
* @expectedException \Cake\Network\Exception\ForbiddenException
* @return void
*/
public function testInvalidTokenInHeader($method) {
$_SERVER['REQUEST_METHOD'] = $method;
$_SERVER['HTTP_X_CSRF_TOKEN'] = 'nope';
$controller = $this->getMock('Cake\Controller\Controller');
$controller->request = new Request([
'cookies' => ['csrfToken' => 'testing123']
]);
$controller->response = new Response();
$event = new Event('Controller.startup', $controller);
$this->component->startUp($event);
}
/**
* Test that request data works with the various http methods.
*
* @dataProvider httpMethodProvider
* @return void
*/
public function testValidTokenRequestData($method) {
$_SERVER['REQUEST_METHOD'] = $method;
$controller = $this->getMock('Cake\Controller\Controller');
$controller->request = new Request([
'post' => ['_csrfToken' => 'testing123'],
'cookies' => ['csrfToken' => 'testing123']
]);
$controller->response = new Response();
$event = new Event('Controller.startup', $controller);
$result = $this->component->startUp($event);
$this->assertNull($result, 'No exception means valid.');
}
/**
* Test that request data works with the various http methods.
*
* @dataProvider httpMethodProvider
* @expectedException \Cake\Network\Exception\ForbiddenException
* @return void
*/
public function testInvalidTokenRequestData($method) {
$_SERVER['REQUEST_METHOD'] = $method;
$controller = $this->getMock('Cake\Controller\Controller');
$controller->request = new Request([
'post' => ['_csrfToken' => 'nope'],
'cookies' => ['csrfToken' => 'testing123']
]);
$controller->response = new Response();
$event = new Event('Controller.startup', $controller);
$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.');
$this->assertEquals('testing123', $controller->request->params['_csrfToken']);
}
/**
* 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,
'secure' => true
]);
$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.');
$this->assertTrue($cookie['secure'], 'cookie security flag missing');
}
/**
* 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.');
}
}