spring-security-config/org.springframework.security.config.web.server/ServerHeadersDsl

ServerHeadersDsl

class ServerHeadersDsl

A Kotlin DSL to configure ServerHttpSecurity headers using idiomatic Kotlin code.

Author

Eleftheria Stein

Since

5.4

Constructors

ServerHeadersDsl

constructor()

Functions

cache

fun cache(cacheControlConfig: ServerCacheControlDsl.() -> Unit)

Allows customizing the CacheControlServerHttpHeadersWriter. Specifically it adds the following headers:

contentSecurityPolicy

fun contentSecurityPolicy(contentSecurityPolicyConfig: ServerContentSecurityPolicyDsl.() -> Unit)

Allows configuration for Content Security Policy (CSP) Level 2.

contentTypeOptions

fun contentTypeOptions(contentTypeOptionsConfig: ServerContentTypeOptionsDsl.() -> Unit)

Configures the ContentTypeOptionsServerHttpHeadersWriter which inserts the

crossOriginEmbedderPolicy

fun crossOriginEmbedderPolicy(crossOriginEmbedderPolicyConfig: ServerCrossOriginEmbedderPolicyDsl.() -> Unit)

Allows configuration for Cross-Origin-Embedder-Policy header.

crossOriginOpenerPolicy

fun crossOriginOpenerPolicy(crossOriginOpenerPolicyConfig: ServerCrossOriginOpenerPolicyDsl.() -> Unit)

Allows configuration for Cross-Origin-Opener-Policy header.

crossOriginResourcePolicy

fun crossOriginResourcePolicy(crossOriginResourcePolicyConfig: ServerCrossOriginResourcePolicyDsl.() -> Unit)

Allows configuration for Cross-Origin-Resource-Policy header.

disable

fun disable()

Disables HTTP response headers.

featurePolicy

fun ~~featurePolicy~~(policyDirectives: String)

Allows configuration for Feature Policy.

frameOptions

fun frameOptions(frameOptionsConfig: ServerFrameOptionsDsl.() -> Unit)

Allows customizing the XFrameOptionsServerHttpHeadersWriter which add the X-Frame-Options header.

hsts

fun hsts(hstsConfig: ServerHttpStrictTransportSecurityDsl.() -> Unit)

Allows customizing the StrictTransportSecurityServerHttpHeadersWriter which provides support for HTTP Strict Transport Security (HSTS).

permissionsPolicy

fun permissionsPolicy(permissionsPolicyConfig: ServerPermissionsPolicyDsl.() -> Unit)

Allows configuration for Permissions Policy.

referrerPolicy

fun referrerPolicy(referrerPolicyConfig: ServerReferrerPolicyDsl.() -> Unit)

Allows configuration for Referrer Policy.

writer

fun writer(writer: ServerHttpHeadersWriter)

Configures custom headers writer

xssProtection

fun xssProtection(xssProtectionConfig: ServerXssProtectionDsl.() -> Unit)

Note this is not comprehensive XSS protection!