BookStackApp-BookStack/tests/Auth/Saml2Test.php at phpstan · OneToolsCollection/BookStackApp-BookStack

History

428 lines (354 loc) · 29.2 KB

Raw

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

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

<?php

namespace Tests\Auth;

use BookStack\Auth\Role;

use BookStack\Auth\User;

use Tests\TestCase;

class Saml2Test extends TestCase

{

protected function setUp(): void

{

parent::setUp();

// Set default config for SAML2

config()->set([

'auth.method' => 'saml2',

'auth.defaults.guard' => 'saml2',

'saml2.name' => 'SingleSignOn-Testing',

'saml2.email_attribute' => 'email',

'saml2.display_name_attributes' => ['first_name', 'last_name'],

'saml2.external_id_attribute' => 'uid',

'saml2.user_to_groups' => false,

'saml2.group_attribute' => 'user_groups',

'saml2.remove_from_groups' => false,

'saml2.onelogin_overrides' => null,

'saml2.onelogin.idp.entityId' => 'http://saml.local/saml2/idp/metadata.php',

'saml2.onelogin.idp.singleSignOnService.url' => 'http://saml.local/saml2/idp/SSOService.php',

'saml2.onelogin.idp.singleLogoutService.url' => 'http://saml.local/saml2/idp/SingleLogoutService.php',

'saml2.autoload_from_metadata' => false,

'saml2.onelogin.idp.x509cert' => $this->testCert,

'saml2.onelogin.debug' => false,

'saml2.onelogin.security.requestedAuthnContext' => true,

]);

}

public function test_metadata_endpoint_displays_xml_as_expected()

{

$req = $this->get('/saml2/metadata');

$req->assertHeader('Content-Type', 'text/xml; charset=UTF-8');

$req->assertSee('md:EntityDescriptor');

$req->assertSee(url('/saml2/acs'));

}

public function test_onelogin_overrides_functions_as_expected()

{

$json = '{"sp": {"assertionConsumerService": {"url": "https://example.com/super-cats"}}, "contactPerson": {"technical": {"givenName": "Barry Scott", "emailAddress": "barry@example.com"}}}';

config()->set(['saml2.onelogin_overrides' => $json]);

$req = $this->get('/saml2/metadata');

$req->assertSee('https://example.com/super-cats');

$req->assertSee('md:ContactPerson');

$req->assertSee('<md:GivenName>Barry Scott</md:GivenName>', false);

}

public function test_login_option_shows_on_login_page()

{

$req = $this->get('/login');

$req->assertSeeText('SingleSignOn-Testing');

$req->assertElementExists('form[action$="/saml2/login"][method=POST] button');

}

public function test_login()

{

$req = $this->post('/saml2/login');

$redirect = $req->headers->get('location');

$this->assertStringStartsWith('http://saml.local/saml2/idp/SSOService.php', $redirect, 'Login redirects to SSO location');

config()->set(['saml2.onelogin.strict' => false]);

$this->assertFalse($this->isAuthenticated());

$acsPost = $this->post('/saml2/acs', ['SAMLResponse' => $this->acsPostData]);

$redirect = $acsPost->headers->get('Location');

$acsId = explode('?id=', $redirect)[1];

$this->assertTrue(strlen($acsId) > 12);

$this->assertStringContainsString('/saml2/acs?id=', $redirect);

$this->assertTrue(cache()->has('saml2_acs:' . $acsId));

$acsGet = $this->get($redirect);

$acsGet->assertRedirect('/');

$this->assertFalse(cache()->has('saml2_acs:' . $acsId));

$this->assertTrue($this->isAuthenticated());

$this->assertDatabaseHas('users', [

'email' => 'user@example.com',

'external_auth_id' => 'user',

'email_confirmed' => false,

'name' => 'Barry Scott',

]);

}

public function test_acs_process_id_randomly_generated()

{

$acsPost = $this->post('/saml2/acs', ['SAMLResponse' => $this->acsPostData]);

$redirectA = $acsPost->headers->get('Location');

$acsPost = $this->post('/saml2/acs', ['SAMLResponse' => $this->acsPostData]);

$redirectB = $acsPost->headers->get('Location');

$this->assertFalse($redirectA === $redirectB);

}

public function test_process_acs_endpoint_cant_be_called_with_invalid_id()

{

$resp = $this->get('/saml2/acs');

$resp->assertRedirect('/login');

$this->followRedirects($resp)->assertSeeText('Login using SingleSignOn-Testing failed, system did not provide successful authorization');

$resp = $this->get('/saml2/acs?id=abc123');

$resp->assertRedirect('/login');

$this->followRedirects($resp)->assertSeeText('Login using SingleSignOn-Testing failed, system did not provide successful authorization');

}

public function test_group_role_sync_on_login()

{

config()->set([

'saml2.onelogin.strict' => false,

'saml2.user_to_groups' => true,

'saml2.remove_from_groups' => false,

]);

$memberRole = Role::factory()->create(['external_auth_id' => 'member']);

$adminRole = Role::getSystemRole('admin');

$this->followingRedirects()->post('/saml2/acs', ['SAMLResponse' => $this->acsPostData]);

$user = User::query()->where('external_auth_id', '=', 'user')->first();

$userRoleIds = $user->roles()->pluck('id');

$this->assertContains($memberRole->id, $userRoleIds, 'User was assigned to member role');

$this->assertContains($adminRole->id, $userRoleIds, 'User was assigned to admin role');

}

public function test_group_role_sync_removal_option_works_as_expected()

{

config()->set([

'saml2.onelogin.strict' => false,

'saml2.user_to_groups' => true,

'saml2.remove_from_groups' => true,

]);

$acsPost = $this->followingRedirects()->post('/saml2/acs', ['SAMLResponse' => $this->acsPostData]);

$user = User::query()->where('external_auth_id', '=', 'user')->first();

$randomRole = Role::factory()->create(['external_auth_id' => 'random']);

$user->attachRole($randomRole);

$this->assertContains($randomRole->id, $user->roles()->pluck('id'));

auth()->logout();

$acsPost = $this->followingRedirects()->post('/saml2/acs', ['SAMLResponse' => $this->acsPostData]);

$this->assertNotContains($randomRole->id, $user->roles()->pluck('id'));

}

public function test_logout_link_directs_to_saml_path()

{

config()->set([

'saml2.onelogin.strict' => false,

]);

$resp = $this->actingAs($this->getEditor())->get('/');

$resp->assertElementExists('a[href$="/saml2/logout"]');

$resp->assertElementContains('a[href$="/saml2/logout"]', 'Logout');

}

public function test_logout_sls_flow()

{

config()->set([

'saml2.onelogin.strict' => false,

]);

$handleLogoutResponse = function () {

$this->assertTrue($this->isAuthenticated());

$req = $this->get('/saml2/sls');

$req->assertRedirect('/');

$this->assertFalse($this->isAuthenticated());

};

$this->followingRedirects()->post('/saml2/acs', ['SAMLResponse' => $this->acsPostData]);

$req = $this->get('/saml2/logout');

$redirect = $req->headers->get('location');

$this->assertStringStartsWith('http://saml.local/saml2/idp/SingleLogoutService.php', $redirect);

$this->withGet(['SAMLResponse' => $this->sloResponseData], $handleLogoutResponse);

}

public function test_logout_sls_flow_when_sls_not_configured()

{

config()->set([

'saml2.onelogin.strict' => false,

'saml2.onelogin.idp.singleLogoutService.url' => null,

]);

$this->followingRedirects()->post('/saml2/acs', ['SAMLResponse' => $this->acsPostData]);

$this->assertTrue($this->isAuthenticated());

$req = $this->get('/saml2/logout');

$req->assertRedirect('/');

$this->assertFalse($this->isAuthenticated());

}

public function test_dump_user_details_option_works()

{

config()->set([

'saml2.onelogin.strict' => false,

'saml2.dump_user_details' => true,

]);

$acsPost = $this->followingRedirects()->post('/saml2/acs', ['SAMLResponse' => $this->acsPostData]);

$acsPost->assertJsonStructure([

'id_from_idp',

'attrs_from_idp' => [],

'attrs_after_parsing' => [],

]);

}

public function test_saml_routes_are_only_active_if_saml_enabled()

{

config()->set(['auth.method' => 'standard']);

$getRoutes = ['/logout', '/metadata', '/sls'];

foreach ($getRoutes as $route) {

$req = $this->get('/saml2' . $route);

$this->assertPermissionError($req);

}

$postRoutes = ['/login', '/acs'];

foreach ($postRoutes as $route) {

$req = $this->post('/saml2' . $route);

$this->assertPermissionError($req);

}

public function test_forgot_password_routes_inaccessible()

{

$resp = $this->get('/password/email');