SecurityHeaderMiddleware::updateCspHeader() - Code Metrics - Inspection of "Provide additional configuration options for CSP a..." - signify-nz/silverstripe-security-headers - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#6)

unknown

created 2021-08-24 23:36 UTC

SecurityHeaderMiddleware::updateCspHeader() A

↳ Parent: SecurityHeaderMiddleware

Complexity

Conditions	5
Paths	7

Size

Total Lines	20
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	5
eloc	9
c	1
b	0
f	0
nc	7
nop	1
dl	0
loc	20
rs	9.6111

<?php

namespace Signify\Middleware;

use Signify\Extensions\SecurityHeaderSiteconfigExtension;
use SilverStripe\Control\Director;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Control\Middleware\HTTPMiddleware;
use SilverStripe\Core\ClassInfo;
use SilverStripe\Core\Extensible;
use SilverStripe\Core\Config\Configurable;
use SilverStripe\Dev\TestOnly;
use SilverStripe\ORM\DB;
use SilverStripe\ORM\DataObject;
use SilverStripe\SiteConfig\SiteConfig;

class SecurityHeaderMiddleware implements HTTPMiddleware
{
    use Configurable;
    use Extensible;

    /**
     * An array of HTTP headers.
     * @config
     * @var array
     */
    private static $headers = [

        'global' => array(),
    ];

    /**
     * Whether to automatically add the CMS report endpoint to the CSP config.
     * @config
     * @var string
     */
    private static $enable_reporting = true;


    /**
     * The URI to report CSP violations to.
     * See routes.yml
     * @config
     * @var string
     */
    private static $report_uri = 'cspviolations/report';


    /**
     * Whether to use the report-to header and CSP directive.
     * @config
     * @var string
     */
    private static $use_report_to = false;


    /**
     * Whether subdomains should report to the same endpoint.
     * @config
     * @var string
     */
    private static $report_to_subdomains = false;


    /**
     * The group name for the report-to CSP directive.
     * @config
     * @var string
     */
    private static $report_to_group = 'signify-csp-violation';


    /**
     * Can isCSPReportingOnly be used safely.
     *
     * This is not a config option.
     *
     * @var boolean
     */
    private static $is_csp_reporting_safe = false;


    public function process(HTTPRequest $request, callable $delegate)
    {
        $response = $delegate($request);

        $headersConfig = (array) $this->config()->get('headers');
        if (empty($headersConfig['global'])) {
            return $response;
        }

        // Disable CSP
        if ($this->disableCSP()) {
            return $response;
        }

        $headersToSend = $headersConfig['global'];

        if (!$this->disableReporting() && $this->config()->get('use_report_to')) {
            $this->addReportToHeader($headersToSend);
        }

        // Update CSP header.
        if (array_key_exists('Content-Security-Policy', $headersToSend)) {
            $header = 'Content-Security-Policy';
            $headerValue = $headersToSend['Content-Security-Policy'];
            // Set report only mode if appropriate.
            if ($this->isCSPReportingOnly()) {
                unset($headersToSend['Content-Security-Policy']);
                $header = 'Content-Security-Policy-Report-Only';
            }
            // Update CSP header value.
            $headersToSend[$header] = $this->updateCspHeader($headerValue);
        }
        $this->extend('updateHeaders', $headersToSend, $request);

        // Add headers to response.
        foreach ($headersToSend as $header => $value) {
            if (empty($value)) {
                continue;
            }
            $value = preg_replace('/\v/', '', $value);
            $this->extend('updateHeader', $header, $value, $request);
            if ($value) {
                $response->addHeader($header, $value);
            }
        }

        return $response;
    }

    /**
     * Return true if the Disable CSP is checked
     *
     * @return boolean
     */
    public function disableCSP()
    {
        if (
            self::isCSPReportingAvailable() &&
            SiteConfig::current_site_config()->CSPReportingOnly == SecurityHeaderSiteconfigExtension::CSP_DISABLE
        ) {
            return true;
        }

        return false;
    }

    /**
     * Return true if the Disable reporting is checked
     *
     * The CMS setting can disable reporting even if the 'enable_reporting' is true
     *
     * @return boolean
     */
    public function disableReporting()
    {
        if (self::isCSPReportingAvailable()) {
            return SiteConfig::current_site_config()->CSPReportingOnly ==
            SecurityHeaderSiteconfigExtension::CSP_WITHOUT_REPORTING ||
            !$this->config()->get('enable_reporting');
        }

        return false;
    }

    /**
     * Returns true if the Content-Security-Policy-Report-Only header should be used.
     *
     * @return boolean
     */
    public function isCSPReportingOnly()
    {
        if (
            self::isCSPReportingAvailable() &&
            SiteConfig::current_site_config()->CSPReportingOnly == SecurityHeaderSiteconfigExtension::CSP_REPORTING_ONLY
        ) {
            return true;
        }

        return false;
    }

    protected function getReportURI()
    {
        return Director::absoluteURL($this->config()->get('report_uri'));
    }

    protected function getIncludeSubdomains()
    {
        return $this->config()->get('report_to_subdomains');
    }

    protected function getReportToGroup()
    {
        return $this->config()->get('report_to_group');
    }

    protected function getReportURIDirective()
    {
        return "report-uri {$this->getReportURI()}";
    }

    protected function getReportToDirective()
    {
        return "report-to {$this->getReportToGroup()}";
    }

    protected function addReportToHeader(&$headers)
    {
        if (array_key_exists('Report-To', $headers)) {
            $headers['Report-To'] = $headers['Report-To'] . ',' . $this->getReportToHeader();
        } else {
            $headers['Report-To'] = $this->getReportToHeader();
        }
    }

    protected function getReportToHeader()
    {
        $header = [
            'group' => $this->getReportToGroup(),
            'max_age' => 1800,
            'endpoints' => [[
                'url' => $this->getReportURI(),
            ],],
            'include_subdomains' => $this->getIncludeSubdomains(),
        ];
        return json_encode($header);
    }

    protected function updateCspHeader($cspHeader)
    {
        if (!$this->disableReporting()) {
            // Add or update report-uri directive.
            if (strpos($cspHeader, 'report-uri')) {
                $cspHeader = str_replace('report-uri', $this->getReportURIDirective(), $cspHeader);
            } else {
                $cspHeader = rtrim($cspHeader, ';') . "; {$this->getReportURIDirective()};";
            }

            // Add report-to directive.
            // Note that unlike report-uri, only the first endpoint is used if multiple are declared.
            if ($this->config()->get('use_report_to')) {
                if (strpos($cspHeader, 'report-to') === false) {
                    $cspHeader = rtrim($cspHeader, ';') . "; {$this->getReportToDirective()};";
                }
            }
        }

        return $cspHeader;
    }

    /**
     * Is the CSPReportingOnly field safe to read.
     *
     * If the module is installed and the codebase is flushed before the database has been built,
     * accessing SiteConfig causes an error.
     *
     * @return boolean
     */
    private static function isCSPReportingAvailable()
    {
        // Cached true value.
        if (self::$is_csp_reporting_safe) {
            return self::$is_csp_reporting_safe;
        }

        // Check if all tables and fields required for the class exist in the database.
        $requiredClasses = ClassInfo::dataClassesFor(SiteConfig::class);
        $schema = DataObject::getSchema();
        foreach (array_unique($requiredClasses) as $required) {
            // Skip test classes, as not all test classes are scaffolded at once
            if (is_a($required, TestOnly::class, true)) {
                continue;
            }

            // if any of the tables aren't created in the database
            $table = $schema->tableName($required);
            if (!ClassInfo::hasTable($table)) {
                return false;
            }

            // if any of the tables don't have any fields mapped as table columns
            $dbFields = DB::field_list($table);
            if (!$dbFields) {

                return false;
            }

            // if any of the tables are missing fields mapped as table columns
            $objFields = $schema->databaseFields($required, false);
            $missingFields = array_diff_key($objFields, $dbFields);
            if ($missingFields) {

                return false;
            }
        }

        self::$is_csp_reporting_safe = true;

        return true;
    }
}


1			<?php
2
3			namespace Signify\Middleware;
4
5			use Signify\Extensions\SecurityHeaderSiteconfigExtension;
6			use SilverStripe\Control\Director;
7			use SilverStripe\Control\HTTPRequest;
8			use SilverStripe\Control\Middleware\HTTPMiddleware;
9			use SilverStripe\Core\ClassInfo;
10			use SilverStripe\Core\Extensible;
11			use SilverStripe\Core\Config\Configurable;
12			use SilverStripe\Dev\TestOnly;
13			use SilverStripe\ORM\DB;
14			use SilverStripe\ORM\DataObject;
15			use SilverStripe\SiteConfig\SiteConfig;
16
17			class SecurityHeaderMiddleware implements HTTPMiddleware
18			{
19			use Configurable;
20			use Extensible;
21
22			/**
23			* An array of HTTP headers.
24			* @config
25			* @var array
26			*/
27			private static $headers = [
			0 ignored issues – show introduced 2020-11-30 05:33 UTC by Report Bug Copy Issue Report The private property `$headers` is not used, and could be removed. Loading history...
28			'global' => array(),
29			];
30
31			/**
32			* Whether to automatically add the CMS report endpoint to the CSP config.
33			* @config
34			* @var string
35			*/
36			private static $enable_reporting = true;
			0 ignored issues – show introduced 2020-11-30 05:33 UTC by Report Bug Copy Issue Report The private property `$enable_reporting` is not used, and could be removed. Loading history...
37
38			/**
39			* The URI to report CSP violations to.
40			* See routes.yml
41			* @config
42			* @var string
43			*/
44			private static $report_uri = 'cspviolations/report';
			0 ignored issues – show introduced 2020-11-30 05:33 UTC by Report Bug Copy Issue Report The private property `$report_uri` is not used, and could be removed. Loading history...
45
46			/**
47			* Whether to use the report-to header and CSP directive.
48			* @config
49			* @var string
50			*/
51			private static $use_report_to = false;
			0 ignored issues – show introduced 2020-11-30 05:33 UTC by Report Bug Copy Issue Report The private property `$use_report_to` is not used, and could be removed. Loading history...
52
53			/**
54			* Whether subdomains should report to the same endpoint.
55			* @config
56			* @var string
57			*/
58			private static $report_to_subdomains = false;
			0 ignored issues – show introduced 2020-11-30 05:33 UTC by Report Bug Copy Issue Report The private property `$report_to_subdomains` is not used, and could be removed. Loading history...
59
60			/**
61			* The group name for the report-to CSP directive.
62			* @config
63			* @var string
64			*/
65			private static $report_to_group = 'signify-csp-violation';
			0 ignored issues – show introduced 2020-11-30 05:33 UTC by Report Bug Copy Issue Report The private property `$report_to_group` is not used, and could be removed. Loading history...
66
67			/**
68			* Can isCSPReportingOnly be used safely.
69			*
70			* This is not a config option.
71			*
72			* @var boolean
73			*/
74			private static $is_csp_reporting_safe = false;
75
76
77			public function process(HTTPRequest $request, callable $delegate)
78			{
79			$response = $delegate($request);
80
81			$headersConfig = (array) $this->config()->get('headers');
82			if (empty($headersConfig['global'])) {
83			return $response;
84			}
85
86			// Disable CSP
87			if ($this->disableCSP()) {
88			return $response;
89			}
90
91			$headersToSend = $headersConfig['global'];
92
93			if (!$this->disableReporting() && $this->config()->get('use_report_to')) {
94			$this->addReportToHeader($headersToSend);
95			}
96
97			// Update CSP header.
98			if (array_key_exists('Content-Security-Policy', $headersToSend)) {
99			$header = 'Content-Security-Policy';
100			$headerValue = $headersToSend['Content-Security-Policy'];
101			// Set report only mode if appropriate.
102			if ($this->isCSPReportingOnly()) {
103			unset($headersToSend['Content-Security-Policy']);
104			$header = 'Content-Security-Policy-Report-Only';
105			}
106			// Update CSP header value.
107			$headersToSend[$header] = $this->updateCspHeader($headerValue);
108			}
109			$this->extend('updateHeaders', $headersToSend, $request);
110
111			// Add headers to response.
112			foreach ($headersToSend as $header => $value) {
113			if (empty($value)) {
114			continue;
115			}
116			$value = preg_replace('/\v/', '', $value);
117			$this->extend('updateHeader', $header, $value, $request);
118			if ($value) {
119			$response->addHeader($header, $value);
120			}
121			}
122
123			return $response;
124			}
125
126			/**
127			* Return true if the Disable CSP is checked
128			*
129			* @return boolean
130			*/
131			public function disableCSP()
132			{
133			if (
134			self::isCSPReportingAvailable() &&
135			SiteConfig::current_site_config()->CSPReportingOnly == SecurityHeaderSiteconfigExtension::CSP_DISABLE
136			) {
137			return true;
138			}
139
140			return false;
141			}
142
143			/**
144			* Return true if the Disable reporting is checked
145			*
146			* The CMS setting can disable reporting even if the 'enable_reporting' is true
147			*
148			* @return boolean
149			*/
150			public function disableReporting()
151			{
152			if (self::isCSPReportingAvailable()) {
153			return SiteConfig::current_site_config()->CSPReportingOnly ==
154			SecurityHeaderSiteconfigExtension::CSP_WITHOUT_REPORTING \|\|
155			!$this->config()->get('enable_reporting');
156			}
157
158			return false;
159			}
160
161			/**
162			* Returns true if the Content-Security-Policy-Report-Only header should be used.
163			*
164			* @return boolean
165			*/
166			public function isCSPReportingOnly()
167			{
168			if (
169			self::isCSPReportingAvailable() &&
170			SiteConfig::current_site_config()->CSPReportingOnly == SecurityHeaderSiteconfigExtension::CSP_REPORTING_ONLY
171			) {
172			return true;
173			}
174
175			return false;
176			}
177
178			protected function getReportURI()
179			{
180			return Director::absoluteURL($this->config()->get('report_uri'));
181			}
182
183			protected function getIncludeSubdomains()
184			{
185			return $this->config()->get('report_to_subdomains');
186			}
187
188			protected function getReportToGroup()
189			{
190			return $this->config()->get('report_to_group');
191			}
192
193			protected function getReportURIDirective()
194			{
195			return "report-uri {$this->getReportURI()}";
196			}
197
198			protected function getReportToDirective()
199			{
200			return "report-to {$this->getReportToGroup()}";
201			}
202
203			protected function addReportToHeader(&$headers)
204			{
205			if (array_key_exists('Report-To', $headers)) {
206			$headers['Report-To'] = $headers['Report-To'] . ',' . $this->getReportToHeader();
207			} else {
208			$headers['Report-To'] = $this->getReportToHeader();
209			}
210			}
211
212			protected function getReportToHeader()
213			{
214			$header = [
215			'group' => $this->getReportToGroup(),
216			'max_age' => 1800,
217			'endpoints' => [[
218			'url' => $this->getReportURI(),
219			],],
220			'include_subdomains' => $this->getIncludeSubdomains(),
221			];
222			return json_encode($header);
223			}
224
225			protected function updateCspHeader($cspHeader)
226			{
227			if (!$this->disableReporting()) {
228			// Add or update report-uri directive.
229			if (strpos($cspHeader, 'report-uri')) {
230			$cspHeader = str_replace('report-uri', $this->getReportURIDirective(), $cspHeader);
231			} else {
232			$cspHeader = rtrim($cspHeader, ';') . "; {$this->getReportURIDirective()};";
233			}
234
235			// Add report-to directive.
236			// Note that unlike report-uri, only the first endpoint is used if multiple are declared.
237			if ($this->config()->get('use_report_to')) {
238			if (strpos($cspHeader, 'report-to') === false) {
239			$cspHeader = rtrim($cspHeader, ';') . "; {$this->getReportToDirective()};";
240			}
241			}
242			}
243
244			return $cspHeader;
245			}
246
247			/**
248			* Is the CSPReportingOnly field safe to read.
249			*
250			* If the module is installed and the codebase is flushed before the database has been built,
251			* accessing SiteConfig causes an error.
252			*
253			* @return boolean
254			*/
255			private static function isCSPReportingAvailable()
256			{
257			// Cached true value.
258			if (self::$is_csp_reporting_safe) {
259			return self::$is_csp_reporting_safe;
260			}
261
262			// Check if all tables and fields required for the class exist in the database.
263			$requiredClasses = ClassInfo::dataClassesFor(SiteConfig::class);
264			$schema = DataObject::getSchema();
265			foreach (array_unique($requiredClasses) as $required) {
266			// Skip test classes, as not all test classes are scaffolded at once
267			if (is_a($required, TestOnly::class, true)) {
268			continue;
269			}
270
271			// if any of the tables aren't created in the database
272			$table = $schema->tableName($required);
273			if (!ClassInfo::hasTable($table)) {
274			return false;
275			}
276
277			// if any of the tables don't have any fields mapped as table columns
278			$dbFields = DB::field_list($table);
279			if (!$dbFields) {
			0 ignored issues – show Bug Best Practice introduced 2021-06-04 02:24 UTC by Report Bug Copy Issue Report The expression `$dbFields` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
280			return false;
281			}
282
283			// if any of the tables are missing fields mapped as table columns
284			$objFields = $schema->databaseFields($required, false);
285			$missingFields = array_diff_key($objFields, $dbFields);
286			if ($missingFields) {
			0 ignored issues – show Bug Best Practice introduced 2021-06-04 02:24 UTC by Report Bug Copy Issue Report The expression `$missingFields` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
287			return false;
288			}
289			}
290
291			self::$is_csp_reporting_safe = true;
292
293			return true;
294			}
295			}
296

signify-nz / silverstripe-security-headers

Pull Request — master (#6)

SecurityHeaderMiddleware::updateCspHeader() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like