-
-
Notifications
You must be signed in to change notification settings - Fork 827
/
Copy pathAbstractFlowsTest.php
387 lines (343 loc) · 11.9 KB
/
AbstractFlowsTest.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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
<?php
namespace Civi\Authx;
use Civi\Test\EndToEndInterface;
use Civi\Test\HttpTestTrait;
use GuzzleHttp\Psr7\AppendStream;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Psr7\Uri;
use Psr\Http\Message\ResponseInterface;
use function GuzzleHttp\Psr7\stream_for;
class AbstractFlowsTest extends \PHPUnit\Framework\TestCase implements EndToEndInterface {
use HttpTestTrait;
/**
* Backup copy of the original settings.
*
* @var array
*/
protected $settingsBackup;
/**
* List of CMS-dependent quirks that should be ignored during testing.
* @var array
*/
protected $quirks = [];
public static function setUpBeforeClass(): void {
\Civi\Test::e2e()
->installMe(__DIR__)
->callback(
function() {
\CRM_Utils_System::synchronizeUsersIfAllowed();
},
'synchronizeUsers'
)
->apply();
}
public function setUp(): void {
$this->quirks = $this->findQuirks();
parent::setUp();
$this->settingsBackup = [];
foreach (\Civi\Authx\Meta::getFlowTypes() as $flowType) {
foreach (["authx_{$flowType}_cred", "authx_{$flowType}_user", "authx_guards"] as $setting) {
$this->settingsBackup[$setting] = \Civi::settings()->get($setting);
}
}
\Civi::settings()->set('authx_guards', []);
}
public function tearDown(): void {
foreach ($this->settingsBackup as $setting => $value) {
\Civi::settings()->set($setting, $value);
}
parent::tearDown();
}
public function getCredTypes() {
$exs = [];
$exs[] = ['pass'];
$exs[] = ['api_key'];
$exs[] = ['jwt'];
return $exs;
}
public function getFlowTypes() {
$exs = [];
$exs[] = ['param'];
$exs[] = ['header'];
$exs[] = ['xheader'];
return $exs;
}
/**
* Apply authentication options to a prepared HTTP request.
*
* @param \Psr\Http\Message\RequestInterface $request
* The original HTTP request (without any authentication options).
* @param string $credType
* Ex: 'pass', 'jwt', 'api_key'
* @param string $flowType
* Ex: 'param', 'header', 'xheader'
* @param int $cid
* Authenticate as a specific contact (contact ID#).
* @return \Psr\Http\Message\RequestInterface
* The new HTTP request (with authentication options).
*/
protected function applyAuth($request, $credType, $flowType, $cid) {
$credFunc = 'cred' . ucfirst(preg_replace(';[^a-zA-Z0-9];', '', $credType));
$flowFunc = 'auth' . ucfirst(preg_replace(';[^a-zA-Z0-9];', '', $flowType));
return $this->$flowFunc($request, $this->$credFunc($cid));
}
// ------------------------------------------------
// Library: Base requests
/**
* Make an AJAX request with info about the current contact.
*
* @return \GuzzleHttp\Psr7\Request
*/
public function requestMyContact() {
$p = (['where' => [['id', '=', 'user_contact_id']]]);
$uri = (new Uri('civicrm/authx/id'))
->withQuery('params=' . urlencode(json_encode($p)));
$req = new Request('GET', $uri);
return $req;
}
/**
* Assert the AJAX response provided the expected contact.
*
* @param int $cid
* The expected contact ID
* @param int|null $uid
* The expected user ID
* @param string $credType
* @param string $flow
* @param \Psr\Http\Message\ResponseInterface $response
*/
public function assertMyContact($cid, $uid, $credType, $flow, ResponseInterface $response): void {
$this->assertContentType('application/json', $response);
$this->assertStatusCode(200, $response);
$j = json_decode((string) $response->getBody(), 1);
$formattedFailure = $this->formatFailure($response);
$this->assertEquals($cid, $j['contact_id'], "Response did not give expected contact ID\n" . $formattedFailure);
$this->assertEquals($uid, $j['user_id'], "Response did not give expected user ID\n" . $formattedFailure);
if ($flow !== NULL) {
$this->assertEquals($flow, $j['flow'], "Response did not give expected flow type\n" . $formattedFailure);
}
if ($credType !== NULL) {
$this->assertEquals($credType, $j['cred'], "Response did not give expected cred type\n" . $formattedFailure);
}
}
/**
* Assert the AJAX request provided empty contact information
*
* @param \Psr\Http\Message\ResponseInterface $response
* @param string $additionalMessage
*/
public function assertAnonymousContact(ResponseInterface $response, $additionalMessage = ''): void {
$formattedFailure = $this->formatFailure($response);
$this->assertContentType('application/json', $response);
$this->assertStatusCode(200, $response);
$j = json_decode((string) $response->getBody(), 1);
if (json_last_error() !== JSON_ERROR_NONE || empty($j)) {
$this->fail('Malformed JSON' . $formattedFailure);
}
$this->assertTrue(array_key_exists('contact_id', $j) && $j['contact_id'] === NULL, 'contact_id should be null' . $formattedFailure . ' ' . $additionalMessage);
$this->assertTrue(array_key_exists('user_id', $j) && $j['user_id'] === NULL, 'user_id should be null' . $formattedFailure . ' ' . $additionalMessage);
}
/**
* Assert that the $response indicates the user cannot view the dashboard.
*
* @param \Psr\Http\Message\ResponseInterface $response
*/
public function assertDashboardUnauthorized($response = NULL): void {
$response = $this->resolveResponse($response);
if (!in_array('authErrorShowsForm', $this->quirks)) {
$this->assertStatusCode(403, $response);
}
$this->assertFalse(
(bool) preg_match(';crm-dashboard-groups;', (string) $response->getBody()),
'Response should not contain a dashboard' . $this->formatFailure($response)
);
}
public function assertDashboardOk($response = NULL): void {
$response = $this->resolveResponse($response);
$this->assertStatusCode(200, $response);
$this->assertContentType('text/html', $response);
// If the first two assertions pass but the next fails, then... perhaps the
// local site permissions are wrong?
$this->assertTrue(
(bool) preg_match(';crm-dashboard-groups;', (string) $response->getBody()),
'Response should contain a dashboard' . $this->formatFailure($response)
);
}
// ------------------------------------------------
// Library: Flow functions
/**
* Add query parameter ("&_authx=<CRED>").
*
* @param \GuzzleHttp\Psr7\Request $request
* @param string $cred
* The credential add to the request (e.g. "Basic ASDF==" or "Bearer FDSA").
* @return \GuzzleHttp\Psr7\Request
*/
public function authParam(Request $request, $cred) {
$query = $request->getUri()->getQuery();
return $request->withUri(
$request->getUri()->withQuery($query . '&_authx=' . urlencode($cred))
);
}
/**
* Add query parameter ("&_authx=<CRED>&_authxSes=1").
*
* @param \GuzzleHttp\Psr7\Request $request
* @param string $cred
* The credential add to the request (e.g. "Basic ASDF==" or "Bearer FDSA").
* @return \GuzzleHttp\Psr7\Request
*/
public function authAuto(Request $request, $cred) {
$query = $request->getUri()->getQuery();
return $request->withUri(
$request->getUri()->withQuery($query . '&_authx=' . urlencode($cred) . '&_authxSes=1')
);
}
public function authLogin(Request $request, $cred) {
return $request->withMethod('POST')
->withBody(new AppendStream([
stream_for('_authx=' . urlencode($cred) . '&'),
$request->getBody(),
]));
}
public function authHeader(Request $request, $cred) {
return $request->withHeader('Authorization', $cred);
}
public function authXHeader(Request $request, $cred) {
return $request->withHeader('X-Civi-Auth', $cred);
}
public function authNone(Request $request, $cred) {
return $request;
}
// ------------------------------------------------
// Library: Credential functions
/**
* @param int $cid
* @return string
* The credential add to the request (e.g. "Basic ASDF==" or "Bearer FDSA").
*/
public function credPass($cid) {
if ($cid === $this->getDemoCID()) {
return 'Basic ' . base64_encode($GLOBALS['_CV']['DEMO_USER'] . ':' . $GLOBALS['_CV']['DEMO_PASS']);
}
else {
$this->fail("This test does have the password the requested contact.");
}
}
public function credApikey($cid) {
$api_key = md5(\random_bytes(16));
\civicrm_api3('Contact', 'create', [
'id' => $cid,
'api_key' => $api_key,
]);
return 'Bearer ' . $api_key;
}
public function credJwt($cid, $expired = FALSE) {
if (empty(\Civi::service('crypto.registry')->findKeysByTag('SIGN'))) {
$this->markTestIncomplete('Cannot test JWT. No CIVICRM_SIGN_KEYS are defined.');
}
$token = \Civi::service('crypto.jwt')->encode([
'exp' => $expired ? time() - 60 * 60 : time() + 60 * 60,
'sub' => "cid:$cid",
'scope' => 'authx',
]);
return 'Bearer ' . $token;
}
public function credNone($cid) {
return NULL;
}
/**
* Assert that a request was not authenticated.
*
* @param string $mode
* Expect that the 'prohibited' or 'anon'
* @param \Psr\Http\Message\ResponseInterface $response
*/
protected function assertNotAuthenticated(string $mode, $response) {
switch ($mode) {
case 'anon':
$this->assertAnonymousContact($response);
break;
case 'prohibit':
$this->assertFailedDueToProhibition($response);
break;
default:
throw new \RuntimeException("Invalid option: mode=$mode");
}
}
/**
* @param \Psr\Http\Message\ResponseInterface $response
*/
protected function assertFailedDueToProhibition($response): void {
$this->assertBodyRegexp(';HTTP 401;', $response);
$this->assertContentType('text/plain', $response);
if (!in_array('sendsExcessCookies', $this->quirks)) {
$this->assertNoCookies($response);
}
$this->assertStatusCode(401, $response);
}
/**
* @param \Psr\Http\Message\ResponseInterface $response
*/
protected function assertNoCookies($response = NULL) {
$response = $this->resolveResponse($response);
$this->assertEmpty(
preg_grep('/Set-Cookie/i', array_keys($response->getHeaders())),
'Response should not have cookies' . $this->formatFailure($response)
);
return $this;
}
/**
* @param \Psr\Http\Message\ResponseInterface $response
*/
protected function assertHasCookies($response = NULL) {
$response = $this->resolveResponse($response);
$this->assertNotEmpty(
preg_grep('/Set-Cookie/i', array_keys($response->getHeaders())),
'Response should have cookies' . $this->formatFailure($response)
);
return $this;
}
/**
* @return int
* @throws \CRM_Core_Exception
*/
protected function getDemoCID(): int {
if (!isset(\Civi::$statics[__CLASS__]['demoId'])) {
\Civi::$statics[__CLASS__]['demoId'] = (int) \civicrm_api3('Contact', 'getvalue', [
'id' => '@user:' . $GLOBALS['_CV']['DEMO_USER'],
'return' => 'id',
]);
}
return \Civi::$statics[__CLASS__]['demoId'];
}
protected function getDemoUID(): int {
return \CRM_Core_Config::singleton()->userSystem->getUfId($GLOBALS['_CV']['DEMO_USER']);
}
public function getLebowskiCID() {
if (!isset(\Civi::$statics[__CLASS__]['lebowskiCID'])) {
$contact = \civicrm_api3('Contact', 'create', [
'contact_type' => 'Individual',
'first_name' => 'Jeffrey',
'last_name' => 'Lebowski',
'external_identifier' => __CLASS__,
'options' => [
'match' => 'external_identifier',
],
]);
\Civi::$statics[__CLASS__]['lebowskiCID'] = $contact['id'];
}
return \Civi::$statics[__CLASS__]['lebowskiCID'];
}
/**
* @return array|string[]
*/
protected function findQuirks(): array {
$quirks = [
'Joomla' => ['sendsExcessCookies', 'authErrorShowsForm'],
'WordPress' => ['sendsExcessCookies'],
'Standalone' => ['sendsExcessCookies'],
];
return $quirks[CIVICRM_UF] ?? [];
}
}