532 lines
15 KiB
PHP
532 lines
15 KiB
PHP
<?php
|
||
/**
|
||
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
||
*
|
||
* @author Lukas Reschke <lukas@statuscode.ch>
|
||
* @author Pavel Krasikov <klonishe@gmail.com>
|
||
* @author Pierre Rudloff <contact@rudloff.pro>
|
||
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
||
* @author Thomas Citharel <nextcloud@tcit.fr>
|
||
*
|
||
* @license AGPL-3.0
|
||
*
|
||
* 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.
|
||
*
|
||
* 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, version 3,
|
||
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
||
*
|
||
*/
|
||
|
||
namespace OCP\AppFramework\Http;
|
||
|
||
/**
|
||
* Class EmptyContentSecurityPolicy is a simple helper which allows applications
|
||
* to modify the Content-Security-Policy sent by ownCloud. Per default the policy
|
||
* is forbidding everything.
|
||
*
|
||
* As alternative with sane exemptions look at ContentSecurityPolicy
|
||
*
|
||
* @see \OCP\AppFramework\Http\ContentSecurityPolicy
|
||
* @package OCP\AppFramework\Http
|
||
* @since 9.0.0
|
||
*/
|
||
class EmptyContentSecurityPolicy {
|
||
/** @var bool Whether inline JS snippets are allowed */
|
||
protected $inlineScriptAllowed = null;
|
||
/** @var string Whether JS nonces should be used */
|
||
protected $useJsNonce = null;
|
||
/**
|
||
* @var bool Whether eval in JS scripts is allowed
|
||
* TODO: Disallow per default
|
||
* @link https://github.com/owncloud/core/issues/11925
|
||
*/
|
||
protected $evalScriptAllowed = null;
|
||
/** @var array Domains from which scripts can get loaded */
|
||
protected $allowedScriptDomains = null;
|
||
/**
|
||
* @var bool Whether inline CSS is allowed
|
||
* TODO: Disallow per default
|
||
* @link https://github.com/owncloud/core/issues/13458
|
||
*/
|
||
protected $inlineStyleAllowed = null;
|
||
/** @var array Domains from which CSS can get loaded */
|
||
protected $allowedStyleDomains = null;
|
||
/** @var array Domains from which images can get loaded */
|
||
protected $allowedImageDomains = null;
|
||
/** @var array Domains to which connections can be done */
|
||
protected $allowedConnectDomains = null;
|
||
/** @var array Domains from which media elements can be loaded */
|
||
protected $allowedMediaDomains = null;
|
||
/** @var array Domains from which object elements can be loaded */
|
||
protected $allowedObjectDomains = null;
|
||
/** @var array Domains from which iframes can be loaded */
|
||
protected $allowedFrameDomains = null;
|
||
/** @var array Domains from which fonts can be loaded */
|
||
protected $allowedFontDomains = null;
|
||
/** @var array Domains from which web-workers and nested browsing content can load elements */
|
||
protected $allowedChildSrcDomains = null;
|
||
/** @var array Domains which can embed this Nextcloud instance */
|
||
protected $allowedFrameAncestors = null;
|
||
/** @var array Domains from which web-workers can be loaded */
|
||
protected $allowedWorkerSrcDomains = null;
|
||
/** @var array Domains which can be used as target for forms */
|
||
protected $allowedFormActionDomains = null;
|
||
|
||
/** @var array Locations to report violations to */
|
||
protected $reportTo = null;
|
||
|
||
/**
|
||
* Whether inline JavaScript snippets are allowed or forbidden
|
||
* @param bool $state
|
||
* @return $this
|
||
* @since 8.1.0
|
||
* @deprecated 10.0 CSP tokens are now used
|
||
*/
|
||
public function allowInlineScript($state = false) {
|
||
$this->inlineScriptAllowed = $state;
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Use the according JS nonce
|
||
* This method is only for CSPMiddleware, custom values are ignored in mergePolicies of ContentSecurityPolicyManager
|
||
*
|
||
* @param string $nonce
|
||
* @return $this
|
||
* @since 11.0.0
|
||
*/
|
||
public function useJsNonce($nonce) {
|
||
$this->useJsNonce = $nonce;
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Whether eval in JavaScript is allowed or forbidden
|
||
* @param bool $state
|
||
* @return $this
|
||
* @since 8.1.0
|
||
* @deprecated Eval should not be used anymore. Please update your scripts. This function will stop functioning in a future version of Nextcloud.
|
||
*/
|
||
public function allowEvalScript($state = true) {
|
||
$this->evalScriptAllowed = $state;
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Allows to execute JavaScript files from a specific domain. Use * to
|
||
* allow JavaScript from all domains.
|
||
* @param string $domain Domain to whitelist. Any passed value needs to be properly sanitized.
|
||
* @return $this
|
||
* @since 8.1.0
|
||
*/
|
||
public function addAllowedScriptDomain($domain) {
|
||
$this->allowedScriptDomains[] = $domain;
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Remove the specified allowed script domain from the allowed domains.
|
||
*
|
||
* @param string $domain
|
||
* @return $this
|
||
* @since 8.1.0
|
||
*/
|
||
public function disallowScriptDomain($domain) {
|
||
$this->allowedScriptDomains = array_diff($this->allowedScriptDomains, [$domain]);
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Whether inline CSS snippets are allowed or forbidden
|
||
* @param bool $state
|
||
* @return $this
|
||
* @since 8.1.0
|
||
*/
|
||
public function allowInlineStyle($state = true) {
|
||
$this->inlineStyleAllowed = $state;
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Allows to execute CSS files from a specific domain. Use * to allow
|
||
* CSS from all domains.
|
||
* @param string $domain Domain to whitelist. Any passed value needs to be properly sanitized.
|
||
* @return $this
|
||
* @since 8.1.0
|
||
*/
|
||
public function addAllowedStyleDomain($domain) {
|
||
$this->allowedStyleDomains[] = $domain;
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Remove the specified allowed style domain from the allowed domains.
|
||
*
|
||
* @param string $domain
|
||
* @return $this
|
||
* @since 8.1.0
|
||
*/
|
||
public function disallowStyleDomain($domain) {
|
||
$this->allowedStyleDomains = array_diff($this->allowedStyleDomains, [$domain]);
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Allows using fonts from a specific domain. Use * to allow
|
||
* fonts from all domains.
|
||
* @param string $domain Domain to whitelist. Any passed value needs to be properly sanitized.
|
||
* @return $this
|
||
* @since 8.1.0
|
||
*/
|
||
public function addAllowedFontDomain($domain) {
|
||
$this->allowedFontDomains[] = $domain;
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Remove the specified allowed font domain from the allowed domains.
|
||
*
|
||
* @param string $domain
|
||
* @return $this
|
||
* @since 8.1.0
|
||
*/
|
||
public function disallowFontDomain($domain) {
|
||
$this->allowedFontDomains = array_diff($this->allowedFontDomains, [$domain]);
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Allows embedding images from a specific domain. Use * to allow
|
||
* images from all domains.
|
||
* @param string $domain Domain to whitelist. Any passed value needs to be properly sanitized.
|
||
* @return $this
|
||
* @since 8.1.0
|
||
*/
|
||
public function addAllowedImageDomain($domain) {
|
||
$this->allowedImageDomains[] = $domain;
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Remove the specified allowed image domain from the allowed domains.
|
||
*
|
||
* @param string $domain
|
||
* @return $this
|
||
* @since 8.1.0
|
||
*/
|
||
public function disallowImageDomain($domain) {
|
||
$this->allowedImageDomains = array_diff($this->allowedImageDomains, [$domain]);
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* To which remote domains the JS connect to.
|
||
* @param string $domain Domain to whitelist. Any passed value needs to be properly sanitized.
|
||
* @return $this
|
||
* @since 8.1.0
|
||
*/
|
||
public function addAllowedConnectDomain($domain) {
|
||
$this->allowedConnectDomains[] = $domain;
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Remove the specified allowed connect domain from the allowed domains.
|
||
*
|
||
* @param string $domain
|
||
* @return $this
|
||
* @since 8.1.0
|
||
*/
|
||
public function disallowConnectDomain($domain) {
|
||
$this->allowedConnectDomains = array_diff($this->allowedConnectDomains, [$domain]);
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* From which domains media elements can be embedded.
|
||
* @param string $domain Domain to whitelist. Any passed value needs to be properly sanitized.
|
||
* @return $this
|
||
* @since 8.1.0
|
||
*/
|
||
public function addAllowedMediaDomain($domain) {
|
||
$this->allowedMediaDomains[] = $domain;
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Remove the specified allowed media domain from the allowed domains.
|
||
*
|
||
* @param string $domain
|
||
* @return $this
|
||
* @since 8.1.0
|
||
*/
|
||
public function disallowMediaDomain($domain) {
|
||
$this->allowedMediaDomains = array_diff($this->allowedMediaDomains, [$domain]);
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* From which domains objects such as <object>, <embed> or <applet> are executed
|
||
* @param string $domain Domain to whitelist. Any passed value needs to be properly sanitized.
|
||
* @return $this
|
||
* @since 8.1.0
|
||
*/
|
||
public function addAllowedObjectDomain($domain) {
|
||
$this->allowedObjectDomains[] = $domain;
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Remove the specified allowed object domain from the allowed domains.
|
||
*
|
||
* @param string $domain
|
||
* @return $this
|
||
* @since 8.1.0
|
||
*/
|
||
public function disallowObjectDomain($domain) {
|
||
$this->allowedObjectDomains = array_diff($this->allowedObjectDomains, [$domain]);
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Which domains can be embedded in an iframe
|
||
* @param string $domain Domain to whitelist. Any passed value needs to be properly sanitized.
|
||
* @return $this
|
||
* @since 8.1.0
|
||
*/
|
||
public function addAllowedFrameDomain($domain) {
|
||
$this->allowedFrameDomains[] = $domain;
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Remove the specified allowed frame domain from the allowed domains.
|
||
*
|
||
* @param string $domain
|
||
* @return $this
|
||
* @since 8.1.0
|
||
*/
|
||
public function disallowFrameDomain($domain) {
|
||
$this->allowedFrameDomains = array_diff($this->allowedFrameDomains, [$domain]);
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Domains from which web-workers and nested browsing content can load elements
|
||
* @param string $domain Domain to whitelist. Any passed value needs to be properly sanitized.
|
||
* @return $this
|
||
* @since 8.1.0
|
||
* @deprecated 15.0.0 use addAllowedWorkerSrcDomains or addAllowedFrameDomain
|
||
*/
|
||
public function addAllowedChildSrcDomain($domain) {
|
||
$this->allowedChildSrcDomains[] = $domain;
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Remove the specified allowed child src domain from the allowed domains.
|
||
*
|
||
* @param string $domain
|
||
* @return $this
|
||
* @since 8.1.0
|
||
* @deprecated 15.0.0 use the WorkerSrcDomains or FrameDomain
|
||
*/
|
||
public function disallowChildSrcDomain($domain) {
|
||
$this->allowedChildSrcDomains = array_diff($this->allowedChildSrcDomains, [$domain]);
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Domains which can embed an iFrame of the Nextcloud instance
|
||
*
|
||
* @param string $domain
|
||
* @return $this
|
||
* @since 13.0.0
|
||
*/
|
||
public function addAllowedFrameAncestorDomain($domain) {
|
||
$this->allowedFrameAncestors[] = $domain;
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Domains which can embed an iFrame of the Nextcloud instance
|
||
*
|
||
* @param string $domain
|
||
* @return $this
|
||
* @since 13.0.0
|
||
*/
|
||
public function disallowFrameAncestorDomain($domain) {
|
||
$this->allowedFrameAncestors = array_diff($this->allowedFrameAncestors, [$domain]);
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Domain from which workers can be loaded
|
||
*
|
||
* @param string $domain
|
||
* @return $this
|
||
* @since 15.0.0
|
||
*/
|
||
public function addAllowedWorkerSrcDomain(string $domain) {
|
||
$this->allowedWorkerSrcDomains[] = $domain;
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Remove domain from which workers can be loaded
|
||
*
|
||
* @param string $domain
|
||
* @return $this
|
||
* @since 15.0.0
|
||
*/
|
||
public function disallowWorkerSrcDomain(string $domain) {
|
||
$this->allowedWorkerSrcDomains = array_diff($this->allowedWorkerSrcDomains, [$domain]);
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Domain to where forms can submit
|
||
*
|
||
* @since 17.0.0
|
||
*
|
||
* @return $this
|
||
*/
|
||
public function addAllowedFormActionDomain(string $domain) {
|
||
$this->allowedFormActionDomains[] = $domain;
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Remove domain to where forms can submit
|
||
*
|
||
* @return $this
|
||
* @since 17.0.0
|
||
*/
|
||
public function disallowFormActionDomain(string $domain) {
|
||
$this->allowedFormActionDomains = array_diff($this->allowedFormActionDomains, [$domain]);
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Add location to report CSP violations to
|
||
*
|
||
* @param string $location
|
||
* @return $this
|
||
* @since 15.0.0
|
||
*/
|
||
public function addReportTo(string $location) {
|
||
$this->reportTo[] = $location;
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Get the generated Content-Security-Policy as a string
|
||
* @return string
|
||
* @since 8.1.0
|
||
*/
|
||
public function buildPolicy() {
|
||
$policy = "default-src 'none';";
|
||
$policy .= "base-uri 'none';";
|
||
$policy .= "manifest-src 'self';";
|
||
|
||
if (!empty($this->allowedScriptDomains) || $this->inlineScriptAllowed || $this->evalScriptAllowed) {
|
||
$policy .= 'script-src ';
|
||
if (is_string($this->useJsNonce)) {
|
||
$policy .= '\'nonce-'.base64_encode($this->useJsNonce).'\'';
|
||
$allowedScriptDomains = array_flip($this->allowedScriptDomains);
|
||
unset($allowedScriptDomains['\'self\'']);
|
||
$this->allowedScriptDomains = array_flip($allowedScriptDomains);
|
||
if (count($allowedScriptDomains) !== 0) {
|
||
$policy .= ' ';
|
||
}
|
||
}
|
||
if (is_array($this->allowedScriptDomains)) {
|
||
$policy .= implode(' ', $this->allowedScriptDomains);
|
||
}
|
||
if ($this->inlineScriptAllowed) {
|
||
$policy .= ' \'unsafe-inline\'';
|
||
}
|
||
if ($this->evalScriptAllowed) {
|
||
$policy .= ' \'unsafe-eval\'';
|
||
}
|
||
$policy .= ';';
|
||
}
|
||
|
||
if (!empty($this->allowedStyleDomains) || $this->inlineStyleAllowed) {
|
||
$policy .= 'style-src ';
|
||
if (is_array($this->allowedStyleDomains)) {
|
||
$policy .= implode(' ', $this->allowedStyleDomains);
|
||
}
|
||
if ($this->inlineStyleAllowed) {
|
||
$policy .= ' \'unsafe-inline\'';
|
||
}
|
||
$policy .= ';';
|
||
}
|
||
|
||
if (!empty($this->allowedImageDomains)) {
|
||
$policy .= 'img-src ' . implode(' ', $this->allowedImageDomains);
|
||
$policy .= ';';
|
||
}
|
||
|
||
if (!empty($this->allowedFontDomains)) {
|
||
$policy .= 'font-src ' . implode(' ', $this->allowedFontDomains);
|
||
$policy .= ';';
|
||
}
|
||
|
||
if (!empty($this->allowedConnectDomains)) {
|
||
$policy .= 'connect-src ' . implode(' ', $this->allowedConnectDomains);
|
||
$policy .= ';';
|
||
}
|
||
|
||
if (!empty($this->allowedMediaDomains)) {
|
||
$policy .= 'media-src ' . implode(' ', $this->allowedMediaDomains);
|
||
$policy .= ';';
|
||
}
|
||
|
||
if (!empty($this->allowedObjectDomains)) {
|
||
$policy .= 'object-src ' . implode(' ', $this->allowedObjectDomains);
|
||
$policy .= ';';
|
||
}
|
||
|
||
if (!empty($this->allowedFrameDomains)) {
|
||
$policy .= 'frame-src ';
|
||
$policy .= implode(' ', $this->allowedFrameDomains);
|
||
$policy .= ';';
|
||
}
|
||
|
||
if (!empty($this->allowedChildSrcDomains)) {
|
||
$policy .= 'child-src ' . implode(' ', $this->allowedChildSrcDomains);
|
||
$policy .= ';';
|
||
}
|
||
|
||
if (!empty($this->allowedFrameAncestors)) {
|
||
$policy .= 'frame-ancestors ' . implode(' ', $this->allowedFrameAncestors);
|
||
$policy .= ';';
|
||
}
|
||
|
||
if (!empty($this->allowedWorkerSrcDomains)) {
|
||
$policy .= 'worker-src ' . implode(' ', $this->allowedWorkerSrcDomains);
|
||
$policy .= ';';
|
||
}
|
||
|
||
if (!empty($this->allowedFormActionDomains)) {
|
||
$policy .= 'form-action ' . implode(' ', $this->allowedFormActionDomains);
|
||
$policy .= ';';
|
||
}
|
||
|
||
if (!empty($this->reportTo)) {
|
||
$policy .= 'report-uri ' . implode(' ', $this->reportTo);
|
||
$policy .= ';';
|
||
}
|
||
|
||
return rtrim($policy, ';');
|
||
}
|
||
}
|