nextcloud/tests/lib/AppFramework/Middleware/Security/SecurityMiddlewareTest.php

668 lines
17 KiB
PHP
Raw Normal View History

2013-08-17 13:16:48 +04:00
<?php
/**
* @author Bernhard Posselt <dev@bernhard-posselt.com>
* @author Lukas Reschke <lukas@owncloud.com>
2013-08-17 13:16:48 +04:00
*
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @license AGPL-3.0
2013-08-17 13:16:48 +04:00
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
2013-08-17 13:16:48 +04:00
*
* This program is distributed in the hope that it will be useful,
2013-08-17 13:16:48 +04:00
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
2013-08-17 13:16:48 +04:00
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
2013-08-17 13:16:48 +04:00
*
*/
2016-05-18 19:40:34 +03:00
namespace Test\AppFramework\Middleware\Security;
2013-08-17 13:16:48 +04:00
use OC\AppFramework\Http;
2013-08-17 13:16:48 +04:00
use OC\AppFramework\Http\Request;
use OC\AppFramework\Middleware\Security\Exceptions\AppNotEnabledException;
use OC\AppFramework\Middleware\Security\Exceptions\CrossSiteRequestForgeryException;
use OC\AppFramework\Middleware\Security\Exceptions\NotAdminException;
use OC\AppFramework\Middleware\Security\Exceptions\NotLoggedInException;
use OC\AppFramework\Middleware\Security\Exceptions\SecurityException;
use OC\Appframework\Middleware\Security\Exceptions\StrictCookieMissingException;
2016-05-18 19:40:34 +03:00
use OC\AppFramework\Middleware\Security\SecurityMiddleware;
use OC\AppFramework\Utility\ControllerMethodReflector;
use OCP\App\IAppManager;
use OCP\AppFramework\Controller;
use OCP\AppFramework\Http\JSONResponse;
use OCP\AppFramework\Http\RedirectResponse;
use OCP\AppFramework\Http\TemplateResponse;
2016-09-15 13:12:30 +03:00
use OCP\IConfig;
use OCP\IL10N;
use OCP\ILogger;
use OCP\INavigationManager;
use OCP\IRequest;
use OCP\IURLGenerator;
2016-09-15 13:12:30 +03:00
use OCP\Security\ISecureRandom;
2013-08-17 13:16:48 +04:00
class SecurityMiddlewareTest extends \Test\TestCase {
2013-08-17 13:16:48 +04:00
/** @var SecurityMiddleware|\PHPUnit\Framework\MockObject\MockObject */
2013-08-17 13:16:48 +04:00
private $middleware;
/** @var Controller|\PHPUnit\Framework\MockObject\MockObject */
2013-08-17 13:16:48 +04:00
private $controller;
/** @var SecurityException */
2013-08-17 13:16:48 +04:00
private $secException;
/** @var SecurityException */
2013-08-17 13:16:48 +04:00
private $secAjaxException;
/** @var IRequest|\PHPUnit\Framework\MockObject\MockObject */
2013-08-17 13:16:48 +04:00
private $request;
/** @var ControllerMethodReflector */
private $reader;
/** @var ILogger|\PHPUnit\Framework\MockObject\MockObject */
private $logger;
/** @var INavigationManager|\PHPUnit\Framework\MockObject\MockObject */
private $navigationManager;
/** @var IURLGenerator|\PHPUnit\Framework\MockObject\MockObject */
private $urlGenerator;
/** @var IAppManager|\PHPUnit\Framework\MockObject\MockObject */
private $appManager;
/** @var IL10N|\PHPUnit\Framework\MockObject\MockObject */
private $l10n;
2013-08-17 13:16:48 +04:00
protected function setUp(): void {
parent::setUp();
2016-09-15 13:12:30 +03:00
$this->controller = $this->createMock(Controller::class);
$this->reader = new ControllerMethodReflector();
2016-09-15 13:12:30 +03:00
$this->logger = $this->createMock(ILogger::class);
$this->navigationManager = $this->createMock(INavigationManager::class);
$this->urlGenerator = $this->createMock(IURLGenerator::class);
$this->request = $this->createMock(IRequest::class);
$this->l10n = $this->createMock(IL10N::class);
$this->middleware = $this->getMiddleware(true, true, false);
2013-08-17 13:16:48 +04:00
$this->secException = new SecurityException('hey', false);
$this->secAjaxException = new SecurityException('hey', true);
}
private function getMiddleware(bool $isLoggedIn, bool $isAdminUser, bool $isSubAdmin, bool $isAppEnabledForUser = true): SecurityMiddleware {
$this->appManager = $this->createMock(IAppManager::class);
$this->appManager->expects($this->any())
->method('isEnabledForUser')
->willReturn($isAppEnabledForUser);
return new SecurityMiddleware(
$this->request,
$this->reader,
$this->navigationManager,
$this->urlGenerator,
$this->logger,
'files',
$isLoggedIn,
Add public API to give developers the possibility to adjust the global CSP defaults Allows to inject something into the default content policy. This is for example useful when you're injecting Javascript code into a view belonging to another controller and cannot modify its Content-Security-Policy itself. Note that the adjustment is only applied to applications that use AppFramework controllers. To use this from your `app.php` use `\OC::$server->getContentSecurityPolicyManager()->addDefaultPolicy($policy)`, $policy has to be of type `\OCP\AppFramework\Http\ContentSecurityPolicy`. To test this add something like the following into an `app.php` of any enabled app: ``` $manager = \OC::$server->getContentSecurityPolicyManager(); $policy = new \OCP\AppFramework\Http\ContentSecurityPolicy(false); $policy->addAllowedFrameDomain('asdf'); $policy->addAllowedScriptDomain('yolo.com'); $policy->allowInlineScript(false); $manager->addDefaultPolicy($policy); $policy = new \OCP\AppFramework\Http\ContentSecurityPolicy(false); $policy->addAllowedFontDomain('yolo.com'); $manager->addDefaultPolicy($policy); $policy = new \OCP\AppFramework\Http\ContentSecurityPolicy(false); $policy->addAllowedFrameDomain('banana.com'); $manager->addDefaultPolicy($policy); ``` If you now open the files app the policy should be: ``` Content-Security-Policy:default-src 'none';script-src yolo.com 'self' 'unsafe-eval';style-src 'self' 'unsafe-inline';img-src 'self' data: blob:;font-src yolo.com 'self';connect-src 'self';media-src 'self';frame-src asdf banana.com 'self' ```
2016-01-28 16:33:02 +03:00
$isAdminUser,
$isSubAdmin,
$this->appManager,
$this->l10n
);
2013-08-17 13:16:48 +04:00
}
/**
* @PublicPage
* @NoCSRFRequired
2013-08-17 13:16:48 +04:00
*/
public function testSetNavigationEntry() {
$this->navigationManager->expects($this->once())
->method('setActiveEntry')
->with($this->equalTo('files'));
$this->reader->reflect(__CLASS__, __FUNCTION__);
$this->middleware->beforeController($this->controller, __FUNCTION__);
2013-08-17 13:16:48 +04:00
}
/**
* @param string $method
* @param string $test
*/
2013-08-17 13:16:48 +04:00
private function ajaxExceptionStatus($method, $test, $status) {
$isLoggedIn = false;
$isAdminUser = false;
2013-08-17 13:16:48 +04:00
// isAdminUser requires isLoggedIn call to return true
if ($test === 'isAdminUser') {
$isLoggedIn = true;
}
$sec = $this->getMiddleware($isLoggedIn, $isAdminUser, false);
2013-08-17 13:16:48 +04:00
try {
$this->reader->reflect(__CLASS__, $method);
$sec->beforeController($this->controller, $method);
} catch (SecurityException $ex) {
2013-08-17 13:16:48 +04:00
$this->assertEquals($status, $ex->getCode());
}
2014-05-28 17:23:57 +04:00
// add assertion if everything should work fine otherwise phpunit will
// complain
if ($status === 0) {
$this->addToAssertionCount(1);
2014-05-28 17:23:57 +04:00
}
2013-08-17 13:16:48 +04:00
}
public function testAjaxStatusLoggedInCheck() {
$this->ajaxExceptionStatus(
2014-05-28 17:23:57 +04:00
__FUNCTION__,
2013-08-17 13:16:48 +04:00
'isLoggedIn',
Http::STATUS_UNAUTHORIZED
);
}
/**
* @NoCSRFRequired
2013-08-17 13:16:48 +04:00
*/
public function testAjaxNotAdminCheck() {
$this->ajaxExceptionStatus(
2014-05-28 17:23:57 +04:00
__FUNCTION__,
2013-08-17 13:16:48 +04:00
'isAdminUser',
Http::STATUS_FORBIDDEN
);
}
/**
* @PublicPage
2013-08-17 13:16:48 +04:00
*/
public function testAjaxStatusCSRFCheck() {
$this->ajaxExceptionStatus(
2014-05-28 17:23:57 +04:00
__FUNCTION__,
2013-08-17 13:16:48 +04:00
'passesCSRFCheck',
Http::STATUS_PRECONDITION_FAILED
);
}
/**
* @PublicPage
* @NoCSRFRequired
2013-08-17 13:16:48 +04:00
*/
public function testAjaxStatusAllGood() {
$this->ajaxExceptionStatus(
2014-05-28 17:23:57 +04:00
__FUNCTION__,
2013-08-17 13:16:48 +04:00
'isLoggedIn',
0
);
$this->ajaxExceptionStatus(
2014-05-28 17:23:57 +04:00
__FUNCTION__,
2013-08-17 13:16:48 +04:00
'isAdminUser',
0
);
$this->ajaxExceptionStatus(
2014-05-28 17:23:57 +04:00
__FUNCTION__,
2013-08-17 13:16:48 +04:00
'passesCSRFCheck',
0
);
}
2013-08-17 13:16:48 +04:00
/**
* @PublicPage
* @NoCSRFRequired
2013-08-17 13:16:48 +04:00
*/
public function testNoChecks() {
$this->request->expects($this->never())
->method('passesCSRFCheck')
->willReturn(false);
$sec = $this->getMiddleware(false, false, false);
$this->reader->reflect(__CLASS__, __FUNCTION__);
$sec->beforeController($this->controller, __FUNCTION__);
2013-08-17 13:16:48 +04:00
}
/**
* @param string $method
* @param string $expects
*/
private function securityCheck($method, $expects, $shouldFail = false) {
// admin check requires login
if ($expects === 'isAdminUser') {
$isLoggedIn = true;
$isAdminUser = !$shouldFail;
} else {
$isLoggedIn = !$shouldFail;
$isAdminUser = false;
}
$sec = $this->getMiddleware($isLoggedIn, $isAdminUser, false);
2013-08-17 13:16:48 +04:00
if ($shouldFail) {
$this->expectException(SecurityException::class);
} else {
$this->addToAssertionCount(1);
2013-08-17 13:16:48 +04:00
}
$this->reader->reflect(__CLASS__, $method);
$sec->beforeController($this->controller, $method);
2013-08-17 13:16:48 +04:00
}
/**
* @PublicPage
2013-08-17 13:16:48 +04:00
*/
public function testCsrfCheck() {
$this->expectException(\OC\AppFramework\Middleware\Security\Exceptions\CrossSiteRequestForgeryException::class);
$this->request->expects($this->once())
2013-10-07 13:25:50 +04:00
->method('passesCSRFCheck')
->willReturn(false);
$this->request->expects($this->once())
->method('passesStrictCookieCheck')
->willReturn(true);
$this->reader->reflect(__CLASS__, __FUNCTION__);
$this->middleware->beforeController($this->controller, __FUNCTION__);
2013-10-07 13:25:50 +04:00
}
/**
* @PublicPage
* @NoCSRFRequired
*/
public function testNoCsrfCheck() {
$this->request->expects($this->never())
2013-10-07 13:25:50 +04:00
->method('passesCSRFCheck')
->willReturn(false);
2013-10-07 13:25:50 +04:00
$this->reader->reflect(__CLASS__, __FUNCTION__);
$this->middleware->beforeController($this->controller, __FUNCTION__);
2013-08-17 13:16:48 +04:00
}
/**
* @PublicPage
*/
public function testPassesCsrfCheck() {
$this->request->expects($this->once())
->method('passesCSRFCheck')
->willReturn(true);
$this->request->expects($this->once())
->method('passesStrictCookieCheck')
->willReturn(true);
$this->reader->reflect(__CLASS__, __FUNCTION__);
$this->middleware->beforeController($this->controller, __FUNCTION__);
}
2013-08-17 13:16:48 +04:00
/**
* @PublicPage
2013-08-17 13:16:48 +04:00
*/
public function testFailCsrfCheck() {
$this->expectException(\OC\AppFramework\Middleware\Security\Exceptions\CrossSiteRequestForgeryException::class);
$this->request->expects($this->once())
2013-10-07 13:25:50 +04:00
->method('passesCSRFCheck')
->willReturn(false);
$this->request->expects($this->once())
->method('passesStrictCookieCheck')
->willReturn(true);
2013-10-07 13:25:50 +04:00
$this->reader->reflect(__CLASS__, __FUNCTION__);
$this->middleware->beforeController($this->controller, __FUNCTION__);
2013-08-17 13:16:48 +04:00
}
/**
* @PublicPage
* @StrictCookieRequired
*/
public function testStrictCookieRequiredCheck() {
$this->expectException(\OC\Appframework\Middleware\Security\Exceptions\StrictCookieMissingException::class);
$this->request->expects($this->never())
->method('passesCSRFCheck');
$this->request->expects($this->once())
->method('passesStrictCookieCheck')
->willReturn(false);
$this->reader->reflect(__CLASS__, __FUNCTION__);
$this->middleware->beforeController($this->controller, __FUNCTION__);
}
/**
* @PublicPage
* @NoCSRFRequired
*/
public function testNoStrictCookieRequiredCheck() {
$this->request->expects($this->never())
->method('passesStrictCookieCheck')
->willReturn(false);
$this->reader->reflect(__CLASS__, __FUNCTION__);
$this->middleware->beforeController($this->controller, __FUNCTION__);
}
/**
* @PublicPage
* @NoCSRFRequired
* @StrictCookieRequired
*/
public function testPassesStrictCookieRequiredCheck() {
$this->request
->expects($this->once())
->method('passesStrictCookieCheck')
->willReturn(true);
$this->reader->reflect(__CLASS__, __FUNCTION__);
$this->middleware->beforeController($this->controller, __FUNCTION__);
}
2013-08-17 13:16:48 +04:00
public function dataCsrfOcsController() {
$controller = $this->getMockBuilder('OCP\AppFramework\Controller')
->disableOriginalConstructor()
->getMock();
$ocsController = $this->getMockBuilder('OCP\AppFramework\OCSController')
->disableOriginalConstructor()
->getMock();
return [
[$controller, false, false, true],
[$controller, false, true, true],
[$controller, true, false, true],
[$controller, true, true, true],
[$ocsController, false, false, true],
[$ocsController, false, true, false],
[$ocsController, true, false, false],
[$ocsController, true, true, false],
];
}
/**
* @dataProvider dataCsrfOcsController
* @param Controller $controller
* @param bool $hasOcsApiHeader
* @param bool $hasBearerAuth
* @param bool $exception
*/
public function testCsrfOcsController(Controller $controller, bool $hasOcsApiHeader, bool $hasBearerAuth, bool $exception) {
$this->request
->method('getHeader')
->willReturnCallback(function ($header) use ($hasOcsApiHeader, $hasBearerAuth) {
if ($header === 'OCS-APIREQUEST' && $hasOcsApiHeader) {
return 'true';
}
if ($header === 'Authorization' && $hasBearerAuth) {
return 'Bearer TOKEN!';
}
return '';
});
$this->request->expects($this->once())
->method('passesStrictCookieCheck')
->willReturn(true);
try {
$this->middleware->beforeController($controller, 'foo');
$this->assertFalse($exception);
} catch (CrossSiteRequestForgeryException $e) {
$this->assertTrue($exception);
}
}
2013-08-17 13:16:48 +04:00
/**
* @NoCSRFRequired
* @NoAdminRequired
2013-08-17 13:16:48 +04:00
*/
public function testLoggedInCheck() {
$this->securityCheck(__FUNCTION__, 'isLoggedIn');
2013-08-17 13:16:48 +04:00
}
/**
* @NoCSRFRequired
* @NoAdminRequired
2013-08-17 13:16:48 +04:00
*/
public function testFailLoggedInCheck() {
$this->securityCheck(__FUNCTION__, 'isLoggedIn', true);
2013-08-17 13:16:48 +04:00
}
/**
* @NoCSRFRequired
2013-08-17 13:16:48 +04:00
*/
public function testIsAdminCheck() {
$this->securityCheck(__FUNCTION__, 'isAdminUser');
2013-08-17 13:16:48 +04:00
}
/**
* @NoCSRFRequired
* @SubAdminRequired
*/
public function testIsNotSubAdminCheck() {
$this->reader->reflect(__CLASS__,__FUNCTION__);
$sec = $this->getMiddleware(true, false, false);
$this->expectException(SecurityException::class);
$sec->beforeController($this, __METHOD__);
}
/**
* @NoCSRFRequired
* @SubAdminRequired
*/
public function testIsSubAdminCheck() {
$this->reader->reflect(__CLASS__,__FUNCTION__);
$sec = $this->getMiddleware(true, false, true);
$sec->beforeController($this, __METHOD__);
$this->addToAssertionCount(1);
}
/**
* @NoCSRFRequired
* @SubAdminRequired
*/
public function testIsSubAdminAndAdminCheck() {
$this->reader->reflect(__CLASS__,__FUNCTION__);
$sec = $this->getMiddleware(true, true, true);
$sec->beforeController($this, __METHOD__);
$this->addToAssertionCount(1);
}
2013-08-17 13:16:48 +04:00
/**
* @NoCSRFRequired
2013-08-17 13:16:48 +04:00
*/
public function testFailIsAdminCheck() {
$this->securityCheck(__FUNCTION__, 'isAdminUser', true);
2013-08-17 13:16:48 +04:00
}
public function testAfterExceptionNotCaughtThrowsItAgain() {
2013-08-17 13:16:48 +04:00
$ex = new \Exception();
$this->expectException(\Exception::class);
2013-08-17 13:16:48 +04:00
$this->middleware->afterException($this->controller, 'test', $ex);
}
public function testAfterExceptionReturnsRedirectForNotLoggedInUser() {
2013-08-17 13:16:48 +04:00
$this->request = new Request(
[
'server' =>
[
'HTTP_ACCEPT' => 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
'REQUEST_URI' => 'nextcloud/index.php/apps/specialapp'
]
],
2016-09-15 13:12:30 +03:00
$this->createMock(ISecureRandom::class),
$this->createMock(IConfig::class)
);
$this->middleware = $this->getMiddleware(false, false, false);
$this->urlGenerator
->expects($this->once())
->method('linkToRoute')
->with(
'core.login.showLoginForm',
[
'redirect_url' => 'nextcloud/index.php/apps/specialapp',
]
)
->willReturn('http://localhost/nextcloud/index.php/login?redirect_url=nextcloud/index.php/apps/specialapp');
$this->logger
->expects($this->once())
->method('logException');
$response = $this->middleware->afterException(
$this->controller,
'test',
new NotLoggedInException()
);
$expected = new RedirectResponse('http://localhost/nextcloud/index.php/login?redirect_url=nextcloud/index.php/apps/specialapp');
$this->assertEquals($expected , $response);
}
public function testAfterExceptionRedirectsToWebRootAfterStrictCookieFail() {
$this->request = new Request(
[
'server' => [
'HTTP_ACCEPT' => 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
'REQUEST_URI' => 'nextcloud/index.php/apps/specialapp',
],
],
2016-09-15 13:12:30 +03:00
$this->createMock(ISecureRandom::class),
$this->createMock(IConfig::class)
);
$this->middleware = $this->getMiddleware(false, false, false);
$response = $this->middleware->afterException(
$this->controller,
'test',
new StrictCookieMissingException()
);
$expected = new RedirectResponse(\OC::$WEBROOT . '/');
$this->assertEquals($expected , $response);
}
/**
* @return array
*/
public function exceptionProvider() {
return [
[
new AppNotEnabledException(),
],
[
new CrossSiteRequestForgeryException(),
],
[
new NotAdminException(''),
],
];
}
/**
* @dataProvider exceptionProvider
* @param SecurityException $exception
*/
public function testAfterExceptionReturnsTemplateResponse(SecurityException $exception) {
$this->request = new Request(
[
'server' =>
[
'HTTP_ACCEPT' => 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
'REQUEST_URI' => 'nextcloud/index.php/apps/specialapp'
]
],
2016-09-15 13:12:30 +03:00
$this->createMock(ISecureRandom::class),
$this->createMock(IConfig::class)
);
$this->middleware = $this->getMiddleware(false, false, false);
$this->logger
->expects($this->once())
->method('logException');
$response = $this->middleware->afterException(
$this->controller,
'test',
$exception
);
$expected = new TemplateResponse('core', '403', ['message' => $exception->getMessage()], 'guest');
$expected->setStatus($exception->getCode());
$this->assertEquals($expected , $response);
2013-08-17 13:16:48 +04:00
}
public function testAfterAjaxExceptionReturnsJSONError() {
2013-08-17 13:16:48 +04:00
$response = $this->middleware->afterException($this->controller, 'test',
$this->secAjaxException);
2013-08-17 13:16:48 +04:00
$this->assertTrue($response instanceof JSONResponse);
}
public function dataRestrictedApp() {
return [
[false, false, false,],
[false, false, true,],
[false, true, false,],
[false, true, true,],
[ true, false, false,],
[ true, false, true,],
[ true, true, false,],
[ true, true, true,],
];
}
/**
* @PublicPage
* @NoAdminRequired
* @NoCSRFRequired
*/
public function testRestrictedAppLoggedInPublicPage() {
$middleware = $this->getMiddleware(true, false, false);
$this->reader->reflect(__CLASS__,__FUNCTION__);
$this->appManager->method('getAppPath')
->with('files')
->willReturn('foo');
$this->appManager->method('isEnabledForUser')
->with('files')
->willReturn(false);
$middleware->beforeController($this->controller, __FUNCTION__);
$this->addToAssertionCount(1);
}
/**
* @PublicPage
* @NoAdminRequired
* @NoCSRFRequired
*/
public function testRestrictedAppNotLoggedInPublicPage() {
$middleware = $this->getMiddleware(false, false, false);
$this->reader->reflect(__CLASS__,__FUNCTION__);
$this->appManager->method('getAppPath')
->with('files')
->willReturn('foo');
$this->appManager->method('isEnabledForUser')
->with('files')
->willReturn(false);
$middleware->beforeController($this->controller, __FUNCTION__);
$this->addToAssertionCount(1);
}
/**
* @NoAdminRequired
* @NoCSRFRequired
*/
public function testRestrictedAppLoggedIn() {
$middleware = $this->getMiddleware(true, false, false, false);
$this->reader->reflect(__CLASS__,__FUNCTION__);
$this->appManager->method('getAppPath')
->with('files')
->willReturn('foo');
$this->expectException(AppNotEnabledException::class);
$middleware->beforeController($this->controller, __FUNCTION__);
}
2013-08-17 13:16:48 +04:00
}