Laravel-CSP 项目教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00410/article/details/141586638

Laravel-CSP 项目教程

laravel-cspSet content security policy headers in a Laravel app项目地址:https://gitcode.com/gh_mirrors/la/laravel-csp

1. 项目的目录结构及介绍

Laravel-CSP 项目的目录结构如下：

laravel-csp/
├── config/
│   └── csp.php
├── src/
│   ├── Policies/
│   ├── Value/
│   ├── CspServiceProvider.php
│   ├── Directive.php
│   ├── Exceptions/
│   ├── Helpers.php
│   ├── Nonce/
│   ├── Report/
│   └── Tag.php
├── tests/
│   ├── Feature/
│   └── Unit/
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .php-cs-fixer.dist.php
├── CHANGELOG.md
├── composer.json
├── LICENSE.md
├── phpunit.xml.dist
└── README.md

目录介绍

config/: 包含项目的配置文件 csp.php。
src/: 包含项目的核心代码，包括策略、值、服务提供者、指令、异常处理、辅助函数、随机数生成器、报告和标签等。
tests/: 包含项目的测试代码，分为功能测试和单元测试。
.editorconfig: 编辑器配置文件。
.gitattributes: Git 属性配置文件。
.gitignore: Git 忽略文件配置。
.php-cs-fixer.dist.php: PHP CS Fixer 配置文件。
CHANGELOG.md: 项目更新日志。
composer.json: Composer 依赖管理文件。
LICENSE.md: 项目许可证。
phpunit.xml.dist: PHPUnit 配置文件。
README.md: 项目说明文档。

2. 项目的启动文件介绍

Laravel-CSP 项目的启动文件主要是 CspServiceProvider.php，位于 src/ 目录下。

CspServiceProvider.php

该文件是 Laravel 服务提供者，负责注册和启动 CSP 相关的服务。主要功能包括：

namespace Spatie\Csp;

use Illuminate\Support\ServiceProvider;
use Spatie\Csp\Policies\Policy;
use Spatie\Csp\Nonce\NonceGenerator;

class CspServiceProvider extends ServiceProvider
{
    public function boot()
    {
        $this->publishes([
            __DIR__.'/../config/csp.php' => config_path('csp.php'),
        ], 'config');

        if (config('csp.enabled')) {
            $this->app['router']->aliasMiddleware('csp', Middleware\AddCspHeaders::class);
        }
    }

    public function register()
    {
        $this->mergeConfigFrom(__DIR__.'/../config/csp.php', 'csp');

        $this->app->bind(Policy::class, config('csp.policy'));

        $this->app->bind(NonceGenerator::class, config('csp.nonce_generator'));
    }
}

3. 项目的配置文件介绍

Laravel-CSP 项目的配置文件是 config/csp.php，该文件定义了 CSP 策略和相关设置。

config/csp.php

配置文件的主要内容如下：

return [
    'enabled' => env('CSP_ENABLED', true),

    'nonce_generator' => \Spatie\Csp\Nonce\RandomString::class,

    'policy' => \Spatie\Csp\Policies\Basic::class,

    'report_only' => false,

    'report_uri' => env('CSP_REPORT_URI', null),

    'add_default_scheme_to_report_uri' => true,

    'prefix' => 'csp-',

    'custom_report_uri' => false,

    'report_sample' => false,

    'enforce' => true,

    'directives' => [
        // 定义各种指令
    ],
];