SecurityHeaders (suave)

SecurityHeaders Module

Namespace: Suave
Assembly: Suave.dll

Security Headers module for comprehensive HTTP security header management

Types

Type	Description
CSPConfig	Content Security Policy configuration
CSPDirective	Content Security Policy Level 3 directives
CSPRule	CSP directive with sources
CSPSource	CSP source values
CacheControl	Cache-Control security settings
CrossDomainPolicy	X-Permitted-Cross-Domain-Policies
FrameOptions	X-Frame-Options values
HSTSConfig	HSTS configuration
PermissionsAllowlist	Permissions-Policy allowlist
PermissionsDirective	Permissions-Policy directive
PermissionsRule	Permissions-Policy rule
ReferrerPolicy	Referrer-Policy values
SecurityHeadersConfig	Comprehensive security headers configuration

Functions and values

Function or value	Description
`balancedConfig` Full Usage: `balancedConfig` Returns: `SecurityHeadersConfig`	Balanced security configuration - reasonable defaults for most applications Returns: `SecurityHeadersConfig`
`emptyConfig` Full Usage: `emptyConfig` Returns: `SecurityHeadersConfig`	Empty configuration - no security headers Returns: `SecurityHeadersConfig`
`generateNonce ()` Full Usage: `generateNonce ()` Parameters: () : `unit` Returns: `string`	Generate a cryptographically random nonce for CSP () : `unit` Returns: `string`
`relaxedConfig` Full Usage: `relaxedConfig` Returns: `SecurityHeadersConfig`	Relaxed security configuration - minimal restrictions Returns: `SecurityHeadersConfig`
`securityHeaders config ctx` Full Usage: `securityHeaders config ctx` Parameters: config : `SecurityHeadersConfig` ctx : `HttpContext` Returns: `Async<HttpContext option>`	Apply security headers WebPart config : `SecurityHeadersConfig` ctx : `HttpContext` Returns: `Async<HttpContext option>`
`strictConfig` Full Usage: `strictConfig` Returns: `SecurityHeadersConfig`	Strict security configuration - maximum protection, may break some features Returns: `SecurityHeadersConfig`
`withCSPReportOnly reportOnly config` Full Usage: `withCSPReportOnly reportOnly config` Parameters: reportOnly : `bool` config : `SecurityHeadersConfig` Returns: `SecurityHeadersConfig`	Set CSP to report-only mode reportOnly : `bool` config : `SecurityHeadersConfig` Returns: `SecurityHeadersConfig`
`withCSPRule directive sources config` Full Usage: `withCSPRule directive sources config` Parameters: directive : `CSPDirective` sources : `CSPSource list` config : `SecurityHeadersConfig` Returns: `SecurityHeadersConfig`	Add a CSP rule to configuration directive : `CSPDirective` sources : `CSPSource list` config : `SecurityHeadersConfig` Returns: `SecurityHeadersConfig`
`withFrameOptions options config` Full Usage: `withFrameOptions options config` Parameters: options : `FrameOptions` config : `SecurityHeadersConfig` Returns: `SecurityHeadersConfig`	Set X-Frame-Options options : `FrameOptions` config : `SecurityHeadersConfig` Returns: `SecurityHeadersConfig`
`withHSTS maxAge includeSubDomains preload config` Full Usage: `withHSTS maxAge includeSubDomains preload config` Parameters: maxAge : `int` includeSubDomains : `bool` preload : `bool` config : `SecurityHeadersConfig` Returns: `SecurityHeadersConfig`	Set HSTS configuration maxAge : `int` includeSubDomains : `bool` preload : `bool` config : `SecurityHeadersConfig` Returns: `SecurityHeadersConfig`
`withPermissionsRule directive allowlist config` Full Usage: `withPermissionsRule directive allowlist config` Parameters: directive : `PermissionsDirective` allowlist : `PermissionsAllowlist` config : `SecurityHeadersConfig` Returns: `SecurityHeadersConfig`	Add a Permissions-Policy rule directive : `PermissionsDirective` allowlist : `PermissionsAllowlist` config : `SecurityHeadersConfig` Returns: `SecurityHeadersConfig`
`withReferrerPolicy policy config` Full Usage: `withReferrerPolicy policy config` Parameters: policy : `ReferrerPolicy` config : `SecurityHeadersConfig` Returns: `SecurityHeadersConfig`	Set Referrer-Policy policy : `ReferrerPolicy` config : `SecurityHeadersConfig` Returns: `SecurityHeadersConfig`
`withSecureCache cache config` Full Usage: `withSecureCache cache config` Parameters: cache : `CacheControl` config : `SecurityHeadersConfig` Returns: `SecurityHeadersConfig`	Set Cache-Control for security cache : `CacheControl` config : `SecurityHeadersConfig` Returns: `SecurityHeadersConfig`