Skip to content

Firefly III: a personal finances manager

6.5 KB
Raw Blame
<?php

/**
 * SecureHeaders.php
 * Copyright (c) 2019 [email protected]
 *
 * This file is part of Firefly III (https://github.com/firefly-iii).
 *
 * 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 <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace FireflyIII\Http\Middleware;

use Barryvdh\Debugbar\Facades\Debugbar;
use Closure;
use Exception;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Vite;

/**
 * Class SecureHeaders
 */
class SecureHeaders
{
    /**
     * Handle an incoming request.
     *
     * @return mixed
     *
     * @throws Exception
     */
    public function handle(Request $request, Closure $next)
    {
        // generate and share nonce.
        $nonce              = base64_encode(random_bytes(16));
        Vite::useCspNonce($nonce);
        if (class_exists(Debugbar::class)) {
            Debugbar::getJavascriptRenderer()->setCspNonce($nonce);
        }
        app('view')->share('JS_NONCE', $nonce);

        $response           = $next($request);
        $trackingScriptSrc  = $this->getTrackingScriptSource();
        $csp                = [
            "default-src 'none'",
            "object-src 'none'",
            sprintf("script-src 'strict-dynamic' 'nonce-%1s'", $nonce),
            // sprintf("style-src 'self' 'nonce-%1s'", $nonce), // safe variant
            "style-src 'self' 'unsafe-inline'", // unsafe variant
            "base-uri 'self'",
            // "form-action 'self'", // safe
            "font-src 'self' data:",
            sprintf("connect-src 'self' https://api.pwnedpasswords.com %s", $trackingScriptSrc),
            sprintf("img-src 'self' data:  https://tile.openstreetmap.org 'nonce-%1s' ", $nonce),
            "manifest-src 'self'",
        ];

        //        // overrule in development mode
        //        if (true === config('firefly.is_local_dev')) {
        //            $ip  = '192.168.96.165';
        //            $csp = [
        //                "default-src 'none'",
        //                "object-src 'none'",
        //                sprintf("script-src 'unsafe-eval' 'strict-dynamic' 'nonce-%1s'", $nonce),
        //                //                 sprintf("style-src 'self' 'nonce-%1s' https://10.0.0.15:5173/", $nonce), // safe variant
        //                sprintf("style-src 'self' 'unsafe-inline' https://%s:5173/", $ip), // unsafe variant
        //                "base-uri 'self'",
        //                "form-action 'self'",
        //                sprintf("font-src 'self' data: https://%s:5173/", $ip),
        //                sprintf('connect-src \'self\' %1$s https://%2$s:5173/ wss://%2$s:5173/', $trackingScriptSrc, $ip),
        //                sprintf("img-src 'self' data: 'nonce-%1s'", $nonce),
        //                "manifest-src 'self'",
        //            ];
        //        }

        $route              = $request->route();
        $customUrl          = '';
        $authGuard          = (string) config('firefly.authentication_guard');
        $logoutUrl          = (string) config('firefly.custom_logout_url');
        if ('remote_user_guard' === $authGuard && '' !== $logoutUrl) {
            $customUrl = $logoutUrl;
        }

        if ('' !== $customUrl && null !== $route && 'oauth/authorize' !== $route->uri) {
            $csp[] = sprintf("form-action 'self' %s", $customUrl);
        }

        $disableFrameHeader = config('firefly.disable_frame_header');
        $disableCSP         = config('firefly.disable_csp_header');
        if (false === $disableFrameHeader) {
            if (method_exists($response, 'header')) {
                $response->header('X-Frame-Options', 'deny');
            }
            if (!method_exists($response, 'header')) {
                $response->headers->set('X-Frame-Options', 'deny');
            }
        }
        if (false === $disableCSP && !$response->headers->has('Content-Security-Policy')) {
            if (method_exists($response, 'header')) {
                $response->header('Content-Security-Policy', implode('; ', $csp));
            }
            if (!method_exists($response, 'header')) {
                $response->headers->set('Content-Security-Policy', implode('; ', $csp));
            }
        }
        $permissionsPolicy  = 'unload=(), geolocation=(), microphone=(), camera=(), payment=(), magnetometer=(), gyroscope=()';
        if (method_exists($response, 'header')) {
            $response->header('X-XSS-Protection', '1; mode=block');
            $response->header('X-Content-Type-Options', 'nosniff');
            $response->header('Referrer-Policy', 'no-referrer');
            $response->header('X-Permitted-Cross-Domain-Policies', 'none');
            $response->header('X-Robots-Tag', 'none');
            $response->header('Permissions-Policy', $permissionsPolicy);
            $response->header('Cross-Origin-Opener-Policy', 'same-origin');
            $response->header('Cross-Origin-Resource-Policy', 'same-origin');
        }
        if (!method_exists($response, 'header')) {
            $response->headers->set('X-XSS-Protection', '1; mode=block');
            $response->headers->set('X-Content-Type-Options', 'nosniff');
            $response->headers->set('Referrer-Policy', 'no-referrer');
            $response->headers->set('X-Permitted-Cross-Domain-Policies', 'none');
            $response->headers->set('X-Robots-Tag', 'none');
            $response->headers->set('Permissions-Policy', $permissionsPolicy);
            $response->headers->set('Cross-Origin-Opener-Policy', 'same-origin');
            $response->headers->set('Cross-Origin-Resource-Policy', 'same-origin');
        }

        return $response;
    }

    /**
     * Return part of a CSP header allowing scripts from Matomo.
     */
    private function getTrackingScriptSource(): string
    {
        if ('' !== (string) config('firefly.tracker_site_id') && '' !== (string) config('firefly.tracker_url')) {
            return (string) config('firefly.tracker_url');
        }

        return '';
    }
}