类 CspMiddleware
内容安全策略中间件
选项
scriptNonce启用以在 script-src 指令中添加 nonce 策略。styleNonce启用以在 style-src 指令中添加 nonce 策略。
命名空间: Cake\Http\Middleware
属性摘要
-
$_config protected
array<string, mixed>运行时配置
-
$_configInitialized protected
bool配置属性是否已使用默认值配置
-
$_defaultConfig protected
array<string, mixed>配置选项。
-
$csp protected
ParagonIE\CSPBuilder\CSPBuilderCSP 生成器
方法摘要
-
__construct() public
构造函数
-
_configDelete() protected
删除单个配置键。
-
_configRead() protected
读取配置键。
-
_configWrite() protected
写入配置键。
-
configShallow() public
将提供的配置与现有配置合并。与
config()不同，它对嵌套键进行递归合并，此方法进行简单合并。 -
getConfig() public
返回配置。
-
getConfigOrFail() public
返回此特定键的配置。
-
process() public
将 nonce（如果已启用）添加到请求，并将 CSP 标头应用于响应。
-
setConfig() public
设置配置。
方法详情
__construct() ¶ public
__construct(ParagonIE\CSPBuilder\CSPBuilder|array $csp, array<string, mixed> $config = [])构造函数
参数
-
ParagonIE\CSPBuilder\CSPBuilder|array$csp CSP 对象或配置数组
-
array<string, mixed>$config 可选 配置选项。
_configDelete() ¶ protected
_configDelete(string $key): void删除单个配置键。
参数
-
string$key 要删除的键。
返回
void抛出
Cake\Core\Exception\CakeException如果尝试覆盖现有配置
_configRead() ¶ protected
_configRead(string|null $key): mixed读取配置键。
参数
-
string|null$key 要读取的键。
返回
mixed_configWrite() ¶ protected
_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void写入配置键。
参数
-
array<string, mixed>|string$key 要写入的键。
-
mixed$value 要写入的值。
-
string|bool$merge 可选 True 表示递归合并，'shallow' 表示简单合并，false 表示覆盖，默认为 false。
返回
void抛出
Cake\Core\Exception\CakeException如果尝试覆盖现有配置
configShallow() ¶ public
configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this将提供的配置与现有配置合并。与 config() 不同，它对嵌套键进行递归合并，此方法进行简单合并。
设置特定值
$this->configShallow('key', $value);设置嵌套值
$this->configShallow('some.nested.key', $value);同时更新多个配置设置
$this->configShallow(['one' => 'value', 'another' => 'value']);参数
-
array<string, mixed>|string$key 要设置的键，或配置的完整数组。
-
mixed|null$value 可选 要设置的值。
返回
$thisgetConfig() ¶ public
getConfig(string|null $key = null, mixed $default = null): mixed返回配置。
用法
读取整个配置
$this->getConfig();读取特定值
$this->getConfig('key');读取嵌套值
$this->getConfig('some.nested.key');使用默认值读取
$this->getConfig('some-key', 'default-value');参数
-
string|null$key 可选 要获取的键，或整个配置的 null。
-
mixed$default 可选 键不存在时的返回值。
返回
mixedgetConfigOrFail() ¶ public
getConfigOrFail(string $key): mixed返回此特定键的配置。
此键的配置值必须存在，不能为 null。
参数
-
string$key 要获取的键。
返回
mixed抛出
InvalidArgumentExceptionprocess() ¶ public
process(ServerRequestInterface $request, RequestHandlerInterface $handler): Psr\Http\Message\ResponseInterface将 nonce（如果已启用）添加到请求，并将 CSP 标头应用于响应。
处理传入的服务器请求以生成响应。如果无法生成响应本身，它可能会委托给提供的请求处理程序来执行此操作。
参数
-
ServerRequestInterface$request 请求。
-
RequestHandlerInterface$handler 请求处理程序。
返回
Psr\Http\Message\ResponseInterfacesetConfig() ¶ public
setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this设置配置。
用法
设置特定值
$this->setConfig('key', $value);设置嵌套值
$this->setConfig('some.nested.key', $value);同时更新多个配置设置
$this->setConfig(['one' => 'value', 'another' => 'value']);参数
-
array<string, mixed>|string$key 要设置的键，或配置的完整数组。
-
mixed|null$value 可选 要设置的值。
-
bool$merge 可选 是否递归合并或覆盖现有配置，默认为 true。
返回
$this抛出
Cake\Core\Exception\CakeException尝试设置无效键时。