From c42f5bc5f666290b99a1662b9048d3163bee0be9 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 26 Oct 2021 13:26:46 +0200 Subject: [PATCH] Add an OCP for trusted domain helper Signed-off-by: Joas Schilling --- lib/composer/composer/autoload_classmap.php | 1 + lib/composer/composer/autoload_static.php | 1 + lib/private/Security/TrustedDomainHelper.php | 32 ++++++----- lib/public/Security/ITrustedDomainHelper.php | 56 +++++++++++++++++++ .../lib/Security/TrustedDomainHelperTest.php | 33 +++++++---- 5 files changed, 100 insertions(+), 23 deletions(-) create mode 100644 lib/public/Security/ITrustedDomainHelper.php diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php index f40f3c92be7..c85b22972dc 100644 --- a/lib/composer/composer/autoload_classmap.php +++ b/lib/composer/composer/autoload_classmap.php @@ -494,6 +494,7 @@ return array( 'OCP\\Security\\ICrypto' => $baseDir . '/lib/public/Security/ICrypto.php', 'OCP\\Security\\IHasher' => $baseDir . '/lib/public/Security/IHasher.php', 'OCP\\Security\\ISecureRandom' => $baseDir . '/lib/public/Security/ISecureRandom.php', + 'OCP\\Security\\ITrustedDomainHelper' => $baseDir . '/lib/public/Security/ITrustedDomainHelper.php', 'OCP\\Security\\VerificationToken\\IVerificationToken' => $baseDir . '/lib/public/Security/VerificationToken/IVerificationToken.php', 'OCP\\Security\\VerificationToken\\InvalidTokenException' => $baseDir . '/lib/public/Security/VerificationToken/InvalidTokenException.php', 'OCP\\Session\\Exceptions\\SessionNotAvailableException' => $baseDir . '/lib/public/Session/Exceptions/SessionNotAvailableException.php', diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php index 13fffdd53ad..c3e5e8d5dd1 100644 --- a/lib/composer/composer/autoload_static.php +++ b/lib/composer/composer/autoload_static.php @@ -523,6 +523,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c 'OCP\\Security\\ICrypto' => __DIR__ . '/../../..' . '/lib/public/Security/ICrypto.php', 'OCP\\Security\\IHasher' => __DIR__ . '/../../..' . '/lib/public/Security/IHasher.php', 'OCP\\Security\\ISecureRandom' => __DIR__ . '/../../..' . '/lib/public/Security/ISecureRandom.php', + 'OCP\\Security\\ITrustedDomainHelper' => __DIR__ . '/../../..' . '/lib/public/Security/ITrustedDomainHelper.php', 'OCP\\Security\\VerificationToken\\IVerificationToken' => __DIR__ . '/../../..' . '/lib/public/Security/VerificationToken/IVerificationToken.php', 'OCP\\Security\\VerificationToken\\InvalidTokenException' => __DIR__ . '/../../..' . '/lib/public/Security/VerificationToken/InvalidTokenException.php', 'OCP\\Session\\Exceptions\\SessionNotAvailableException' => __DIR__ . '/../../..' . '/lib/public/Session/Exceptions/SessionNotAvailableException.php', diff --git a/lib/private/Security/TrustedDomainHelper.php b/lib/private/Security/TrustedDomainHelper.php index 49f4194d77f..175e4cbd356 100644 --- a/lib/private/Security/TrustedDomainHelper.php +++ b/lib/private/Security/TrustedDomainHelper.php @@ -31,13 +31,9 @@ namespace OC\Security; use OC\AppFramework\Http\Request; use OCP\IConfig; +use OCP\Security\ITrustedDomainHelper; -/** - * Class TrustedDomain - * - * @package OC\Security - */ -class TrustedDomainHelper { +class TrustedDomainHelper implements ITrustedDomainHelper { /** @var IConfig */ private $config; @@ -65,13 +61,23 @@ class TrustedDomainHelper { } /** - * Checks whether a domain is considered as trusted from the list - * of trusted domains. If no trusted domains have been configured, returns - * true. - * This is used to prevent Host Header Poisoning. - * @param string $domainWithPort - * @return bool true if the given domain is trusted or if no trusted domains - * have been configured + * {@inheritDoc} + */ + public function isTrustedUrl(string $url): bool { + $parsedUrl = parse_url($url); + if (empty($parsedUrl['host'])) { + return false; + } + + if (isset($parsedUrl['port']) && $parsedUrl['port']) { + return $this->isTrustedDomain($parsedUrl['host'] . ':' . $parsedUrl['port']); + } + + return $this->isTrustedDomain($parsedUrl['host']); + } + + /** + * {@inheritDoc} */ public function isTrustedDomain(string $domainWithPort): bool { // overwritehost is always trusted diff --git a/lib/public/Security/ITrustedDomainHelper.php b/lib/public/Security/ITrustedDomainHelper.php new file mode 100644 index 00000000000..4737625b6e8 --- /dev/null +++ b/lib/public/Security/ITrustedDomainHelper.php @@ -0,0 +1,56 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * 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. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace OCP\Security; + +/** + * Allows checking domains and full URLs against the list of trusted domains for + * this server in the config file. + * + * @package OCP\Security + * @since 23.0.0 + */ +interface ITrustedDomainHelper { + /** + * Checks whether a given URL is considered as trusted from the list + * of trusted domains in the server's config file. If no trusted domains + * have been configured and the url is valid, returns true. + * + * @param string $url + * @return bool + * @since 23.0.0 + */ + public function isTrustedUrl(string $url): bool; + + /** + * Checks whether a given domain is considered as trusted from the list + * of trusted domains in the server's config file. If no trusted domains + * have been configured, returns true. + * This is used to prevent Host Header Poisoning. + * + * @param string $domainWithPort + * @return bool + * @since 23.0.0 + */ + public function isTrustedDomain(string $domainWithPort): bool; +} diff --git a/tests/lib/Security/TrustedDomainHelperTest.php b/tests/lib/Security/TrustedDomainHelperTest.php index aedc4cb6a17..3fedf8964c5 100644 --- a/tests/lib/Security/TrustedDomainHelperTest.php +++ b/tests/lib/Security/TrustedDomainHelperTest.php @@ -27,6 +27,23 @@ class TrustedDomainHelperTest extends \Test\TestCase { $this->config = $this->getMockBuilder(IConfig::class)->getMock(); } + /** + * @dataProvider trustedDomainDataProvider + * @param string $trustedDomains + * @param string $testDomain + * @param bool $result + */ + public function testIsTrustedUrl($trustedDomains, $testDomain, $result) { + $this->config->method('getSystemValue') + ->willReturnMap([ + ['overwritehost', '', ''], + ['trusted_domains', [], $trustedDomains], + ]); + + $trustedDomainHelper = new TrustedDomainHelper($this->config); + $this->assertEquals($result, $trustedDomainHelper->isTrustedUrl('https://' . $testDomain . '/index.php/something')); + } + /** * @dataProvider trustedDomainDataProvider * @param string $trustedDomains @@ -34,14 +51,11 @@ class TrustedDomainHelperTest extends \Test\TestCase { * @param bool $result */ public function testIsTrustedDomain($trustedDomains, $testDomain, $result) { - $this->config->expects($this->at(0)) - ->method('getSystemValue') - ->with('overwritehost') - ->willReturn(''); - $this->config->expects($this->at(1)) - ->method('getSystemValue') - ->with('trusted_domains') - ->willReturn($trustedDomains); + $this->config->method('getSystemValue') + ->willReturnMap([ + ['overwritehost', '', ''], + ['trusted_domains', [], $trustedDomains], + ]); $trustedDomainHelper = new TrustedDomainHelper($this->config); $this->assertEquals($result, $trustedDomainHelper->isTrustedDomain($testDomain)); @@ -122,8 +136,7 @@ class TrustedDomainHelperTest extends \Test\TestCase { } public function testIsTrustedDomainOverwriteHost() { - $this->config->expects($this->at(0)) - ->method('getSystemValue') + $this->config->method('getSystemValue') ->with('overwritehost') ->willReturn('myproxyhost'); -- 2.39.5