12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220 |
- [[servlet-headers]]
- = Security HTTP Response Headers
- You can use xref:features/exploits/headers.adoc#headers[Security HTTP Response Headers] to increase the security of web applications.
- This section is dedicated to servlet-based support for Security HTTP Response Headers.
- [[servlet-headers-default]]
- == Default Security Headers
- Spring Security provides a xref:features/exploits/headers.adoc#headers-default[default set of Security HTTP Response Headers] to provide secure defaults.
- While each of these headers are considered best practice, it should be noted that not all clients use the headers, so additional testing is encouraged.
- You can customize specific headers.
- For example, assume that you want the defaults but you wish to specify `SAMEORIGIN` for <<servlet-headers-frame-options,X-Frame-Options>>.
- You can do so with the following configuration:
- .Customize Default Security Headers
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- public class WebSecurityConfig {
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- // ...
- .headers(headers -> headers
- .frameOptions(frameOptions -> frameOptions
- .sameOrigin()
- )
- );
- return http.build();
- }
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <!-- ... -->
- <headers>
- <frame-options policy="SAMEORIGIN" />
- </headers>
- </http>
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- @EnableWebSecurity
- class SecurityConfig {
- @Bean
- open fun filterChain(http: HttpSecurity): SecurityFilterChain {
- http {
- // ...
- headers {
- frameOptions {
- sameOrigin = true
- }
- }
- }
- return http.build()
- }
- }
- ----
- ====
- If you do not want the defaults to be added and want explicit control over what should be used, you can disable the defaults.
- The next code listing shows how to do so.
- If you use Spring Security's configuration, the following adds only xref:features/exploits/headers.adoc#headers-cache-control[Cache Control]:
- .Customize Cache Control Headers
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- public class WebSecurityConfig {
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- // ...
- .headers(headers -> headers
- // do not use any default headers unless explicitly listed
- .defaultsDisabled()
- .cacheControl(withDefaults())
- );
- return http.build();
- }
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <!-- ... -->
- <headers defaults-disabled="true">
- <cache-control/>
- </headers>
- </http>
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- @EnableWebSecurity
- class SecurityConfig {
- @Bean
- open fun filterChain(http: HttpSecurity): SecurityFilterChain {
- http {
- // ...
- headers {
- // do not use any default headers unless explicitly listed
- defaultsDisabled = true
- cacheControl {
- }
- }
- }
- return http.build()
- }
- }
- ----
- ====
- If necessary, you can disable all of the HTTP Security response headers with the following configuration:
- .Disable All HTTP Security Headers
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- public class WebSecurityConfig {
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- // ...
- .headers(headers -> headers.disable());
- return http.build();
- }
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <!-- ... -->
- <headers disabled="true" />
- </http>
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- @EnableWebSecurity
- class SecurityConfig {
- @Bean
- open fun filterChain(http: HttpSecurity): SecurityFilterChain {
- http {
- // ...
- headers {
- disable()
- }
- }
- return http.build()
- }
- }
- ----
- ====
- [[servlet-headers-cache-control]]
- == Cache Control
- Spring Security includes xref:features/exploits/headers.adoc#headers-cache-control[Cache Control] headers by default.
- However, if you actually want to cache specific responses, your application can selectively invoke https://docs.oracle.com/javaee/6/api/javax/servlet/http/HttpServletResponse.html#setHeader(java.lang.String,java.lang.String)[`HttpServletResponse.setHeader(String,String)`] to override the header set by Spring Security.
- You can use this to ensure that content (such as CSS, JavaScript, and images) is properly cached.
- When you use Spring Web MVC, this is typically done within your configuration.
- You can find details on how to do this in the https://docs.spring.io/spring/docs/5.0.0.RELEASE/spring-framework-reference/web.html#mvc-config-static-resources[Static Resources] portion of the Spring Reference documentation
- If necessary, you can also disable Spring Security's cache control HTTP response headers.
- .Cache Control Disabled
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- public class WebSecurityConfig {
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- // ...
- .headers(headers -> headers
- .cacheControl(cache -> cache.disable())
- );
- return http.build();
- }
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <!-- ... -->
- <headers>
- <cache-control disabled="true"/>
- </headers>
- </http>
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- @EnableWebSecurity
- class SecurityConfig {
- @Bean
- open fun filterChain(http: HttpSecurity): SecurityFilterChain {
- http {
- headers {
- cacheControl {
- disable()
- }
- }
- }
- return http.build()
- }
- }
- ----
- ====
- [[servlet-headers-content-type-options]]
- == Content Type Options
- Spring Security includes xref:features/exploits/headers.adoc#headers-content-type-options[Content-Type] headers by default.
- However, you can disable it:
- .Content Type Options Disabled
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- public class WebSecurityConfig {
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- // ...
- .headers(headers -> headers
- .contentTypeOptions(contentTypeOptions -> contentTypeOptions.disable())
- );
- return http.build();
- }
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <!-- ... -->
- <headers>
- <content-type-options disabled="true"/>
- </headers>
- </http>
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- @EnableWebSecurity
- class SecurityConfig {
- @Bean
- open fun filterChain(http: HttpSecurity): SecurityFilterChain {
- http {
- headers {
- contentTypeOptions {
- disable()
- }
- }
- }
- return http.build()
- }
- }
- ----
- ====
- [[servlet-headers-hsts]]
- == HTTP Strict Transport Security (HSTS)
- By default, Spring Security provides the xref:features/exploits/headers.adoc#headers-hsts[Strict Transport Security] header.
- However, you can explicitly customize the results.
- The following example explicitly provides HSTS:
- .Strict Transport Security
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- public class WebSecurityConfig {
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- // ...
- .headers(headers -> headers
- .httpStrictTransportSecurity(hsts -> hsts
- .includeSubDomains(true)
- .preload(true)
- .maxAgeInSeconds(31536000)
- )
- );
- return http.build();
- }
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <!-- ... -->
- <headers>
- <hsts
- include-subdomains="true"
- max-age-seconds="31536000"
- preload="true" />
- </headers>
- </http>
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- @EnableWebSecurity
- class SecurityConfig {
- @Bean
- open fun filterChain(http: HttpSecurity): SecurityFilterChain {
- http {
- headers {
- httpStrictTransportSecurity {
- includeSubDomains = true
- preload = true
- maxAgeInSeconds = 31536000
- }
- }
- }
- return http.build()
- }
- }
- ----
- ====
- [[servlet-headers-hpkp]]
- == HTTP Public Key Pinning (HPKP)
- Spring Security provides servlet support for xref:features/exploits/headers.adoc#headers-hpkp[HTTP Public Key Pinning], but it is xref:features/exploits/headers.adoc#headers-hpkp-deprecated[no longer recommended].
- You can enable HPKP headers with the following configuration:
- .HTTP Public Key Pinning
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- public class WebSecurityConfig {
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- // ...
- .headers(headers -> headers
- .httpPublicKeyPinning(hpkp -> hpkp
- .includeSubDomains(true)
- .reportUri("https://example.net/pkp-report")
- .addSha256Pins("d6qzRu9zOECb90Uez27xWltNsj0e1Md7GkYYkVoZWmM=", "E9CZ9INDbd+2eRQozYqqbQ2yXLVKB9+xcprMF+44U1g=")
- )
- );
- return http.build();
- }
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <!-- ... -->
- <headers>
- <hpkp
- include-subdomains="true"
- report-uri="https://example.net/pkp-report">
- <pins>
- <pin algorithm="sha256">d6qzRu9zOECb90Uez27xWltNsj0e1Md7GkYYkVoZWmM=</pin>
- <pin algorithm="sha256">E9CZ9INDbd+2eRQozYqqbQ2yXLVKB9+xcprMF+44U1g=</pin>
- </pins>
- </hpkp>
- </headers>
- </http>
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- @EnableWebSecurity
- class SecurityConfig {
- @Bean
- open fun filterChain(http: HttpSecurity): SecurityFilterChain {
- http {
- headers {
- httpPublicKeyPinning {
- includeSubDomains = true
- reportUri = "https://example.net/pkp-report"
- pins = mapOf("d6qzRu9zOECb90Uez27xWltNsj0e1Md7GkYYkVoZWmM=" to "sha256",
- "E9CZ9INDbd+2eRQozYqqbQ2yXLVKB9+xcprMF+44U1g=" to "sha256")
- }
- }
- }
- return http.build()
- }
- }
- ----
- ====
- [[servlet-headers-frame-options]]
- == X-Frame-Options
- By default, Spring Security instructs browsers to block reflected XSS attacks by using the xref:features/exploits/headers.adoc#headers-frame-options[X-Frame-Options].
- For example, the following configuration specifies that Spring Security should no longer instruct browsers to block the content:
- .X-Frame-Options: SAMEORIGIN
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- public class WebSecurityConfig {
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- // ...
- .headers(headers -> headers
- .frameOptions(frameOptions -> frameOptions
- .sameOrigin()
- )
- );
- return http.build();
- }
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <!-- ... -->
- <headers>
- <frame-options
- policy="SAMEORIGIN" />
- </headers>
- </http>
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- @EnableWebSecurity
- class SecurityConfig {
- @Bean
- open fun filterChain(http: HttpSecurity): SecurityFilterChain {
- http {
- headers {
- frameOptions {
- sameOrigin = true
- }
- }
- }
- return http.build()
- }
- }
- ----
- ====
- [[servlet-headers-xss-protection]]
- == X-XSS-Protection
- By default, Spring Security instructs browsers to block reflected XSS attacks by using the <<headers-xss-protection,X-XSS-Protection header>.
- However, you can change this default.
- For example, the following configuration specifies that Spring Security should no longer instruct browsers to block the content:
- .X-XSS-Protection Customization
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- public class WebSecurityConfig {
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- // ...
- .headers(headers -> headers
- .xssProtection(xss -> xss
- .block(false)
- )
- );
- return http.build();
- }
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <!-- ... -->
- <headers>
- <xss-protection block="false"/>
- </headers>
- </http>
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- @EnableWebSecurity
- class SecurityConfig {
- @Bean
- open fun filterChain(http: HttpSecurity): SecurityFilterChain {
- // ...
- http {
- headers {
- xssProtection {
- block = false
- }
- }
- }
- return http.build()
- }
- }
- ----
- ====
- [[servlet-headers-csp]]
- == Content Security Policy (CSP)
- Spring Security does not add xref:features/exploits/headers.adoc#headers-csp[Content Security Policy] by default, because a reasonable default is impossible to know without knowing the context of the application.
- The web application author must declare the security policy (or policies) to enforce or monitor for the protected resources.
- Consider the following security policy:
- .Content Security Policy Example
- ====
- [source,http]
- ----
- Content-Security-Policy: script-src 'self' https://trustedscripts.example.com; object-src https://trustedplugins.example.com; report-uri /csp-report-endpoint/
- ----
- ====
- Given the preceding security policy, you can enable the CSP header:
- .Content Security Policy
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- public class WebSecurityConfig {
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- // ...
- .headers(headers -> headers
- .contentSecurityPolicy(csp -> csp
- .policyDirectives("script-src 'self' https://trustedscripts.example.com; object-src https://trustedplugins.example.com; report-uri /csp-report-endpoint/")
- )
- );
- return http.build();
- }
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <!-- ... -->
- <headers>
- <content-security-policy
- policy-directives="script-src 'self' https://trustedscripts.example.com; object-src https://trustedplugins.example.com; report-uri /csp-report-endpoint/" />
- </headers>
- </http>
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- @EnableWebSecurity
- class SecurityConfig {
- @Bean
- open fun filterChain(http: HttpSecurity): SecurityFilterChain {
- http {
- // ...
- headers {
- contentSecurityPolicy {
- policyDirectives = "script-src 'self' https://trustedscripts.example.com; object-src https://trustedplugins.example.com; report-uri /csp-report-endpoint/"
- }
- }
- }
- return http.build()
- }
- }
- ----
- ====
- To enable the CSP `report-only` header, provide the following configuration:
- .Content Security Policy Report Only
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- public class WebSecurityConfig {
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- // ...
- .headers(headers -> headers
- .contentSecurityPolicy(csp -> csp
- .policyDirectives("script-src 'self' https://trustedscripts.example.com; object-src https://trustedplugins.example.com; report-uri /csp-report-endpoint/")
- .reportOnly()
- )
- );
- return http.build();
- }
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <!-- ... -->
- <headers>
- <content-security-policy
- policy-directives="script-src 'self' https://trustedscripts.example.com; object-src https://trustedplugins.example.com; report-uri /csp-report-endpoint/"
- report-only="true" />
- </headers>
- </http>
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- @EnableWebSecurity
- class SecurityConfig {
- @Bean
- open fun filterChain(http: HttpSecurity): SecurityFilterChain {
- http {
- // ...
- headers {
- contentSecurityPolicy {
- policyDirectives = "script-src 'self' https://trustedscripts.example.com; object-src https://trustedplugins.example.com; report-uri /csp-report-endpoint/"
- reportOnly = true
- }
- }
- }
- return http.build()
- }
- }
- ----
- ====
- [[servlet-headers-referrer]]
- == Referrer Policy
- Spring Security does not add xref:features/exploits/headers.adoc#headers-referrer[Referrer Policy] headers by default.
- You can enable the Referrer Policy header by using the configuration:
- .Referrer Policy
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- public class WebSecurityConfig {
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- // ...
- .headers(headers -> headers
- .referrerPolicy(referrer -> referrer
- .policy(ReferrerPolicy.SAME_ORIGIN)
- )
- );
- return http.build();
- }
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <!-- ... -->
- <headers>
- <referrer-policy policy="same-origin" />
- </headers>
- </http>
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- @EnableWebSecurity
- class SecurityConfig {
- @Bean
- open fun filterChain(http: HttpSecurity): SecurityFilterChain {
- http {
- // ...
- headers {
- referrerPolicy {
- policy = ReferrerPolicy.SAME_ORIGIN
- }
- }
- }
- return http.build()
- }
- }
- ----
- ====
- [[servlet-headers-feature]]
- == Feature Policy
- Spring Security does not add xref:features/exploits/headers.adoc#headers-feature[Feature Policy] headers by default.
- Consider the following `Feature-Policy` header:
- .Feature-Policy Example
- ====
- [source]
- ----
- Feature-Policy: geolocation 'self'
- ----
- ====
- You can enable the preceding feature policy header by using the following configuration:
- .Feature-Policy
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- public class WebSecurityConfig {
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- // ...
- .headers(headers -> headers
- .featurePolicy("geolocation 'self'")
- );
- return http.build();
- }
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <!-- ... -->
- <headers>
- <feature-policy policy-directives="geolocation 'self'" />
- </headers>
- </http>
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- @EnableWebSecurity
- class SecurityConfig {
- @Bean
- open fun filterChain(http: HttpSecurity): SecurityFilterChain {
- http {
- // ...
- headers {
- featurePolicy("geolocation 'self'")
- }
- }
- return http.build()
- }
- }
- ----
- ====
- [[servlet-headers-permissions]]
- == Permissions Policy
- Spring Security does not add xref:features/exploits/headers.adoc#headers-permissions[Permissions Policy] headers by default.
- Consider the following `Permissions-Policy` header:
- .Permissions-Policy Example
- ====
- [source]
- ----
- Permissions-Policy: geolocation=(self)
- ----
- ====
- You can enable the preceding permissions policy header using the following configuration:
- .Permissions-Policy
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- public class WebSecurityConfig {
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- // ...
- .headers(headers -> headers
- .permissionsPolicy(permissions -> permissions
- .policy("geolocation=(self)")
- )
- );
- return http.build();
- }
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <!-- ... -->
- <headers>
- <permissions-policy policy="geolocation=(self)" />
- </headers>
- </http>
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- @EnableWebSecurity
- class SecurityConfig {
- @Bean
- open fun filterChain(http: HttpSecurity): SecurityFilterChain {
- http {
- // ...
- headers {
- permissionPolicy {
- policy = "geolocation=(self)"
- }
- }
- }
- return http.build()
- }
- }
- ----
- ====
- [[servlet-headers-clear-site-data]]
- == Clear Site Data
- Spring Security does not add xref:features/exploits/headers.adoc#headers-clear-site-data[Clear-Site-Data] headers by default.
- Consider the following Clear-Site-Data header:
- .Clear-Site-Data Example
- ====
- ----
- Clear-Site-Data: "cache", "cookies"
- ----
- ====
- You can send the preceding header on log out with the following configuration:
- .Clear-Site-Data
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- public class WebSecurityConfig {
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- // ...
- .logout((logout) -> logout
- .addLogoutHandler(new HeaderWriterLogoutHandler(new ClearSiteDataHeaderWriter(CACHE, COOKIES)))
- );
- return http.build();
- }
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- @EnableWebSecurity
- class SecurityConfig {
- @Bean
- open fun filterChain(http: HttpSecurity): SecurityFilterChain {
- http {
- // ...
- logout {
- addLogoutHandler(HeaderWriterLogoutHandler(ClearSiteDataHeaderWriter(CACHE, COOKIES)))
- }
- }
- return http.build()
- }
- }
- ----
- ====
- [[servlet-headers-custom]]
- == Custom Headers
- Spring Security has mechanisms to make it convenient to add the more common security headers to your application.
- However, it also provides hooks to enable adding custom headers.
- [[servlet-headers-static]]
- === Static Headers
- There may be times when you wish to inject custom security headers that are not supported out of the box into your application.
- Consider the following custom security header:
- [source]
- ----
- X-Custom-Security-Header: header-value
- ----
- Given the preceding header, you could add the headers to the response by using the following configuration:
- .StaticHeadersWriter
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- public class WebSecurityConfig {
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- // ...
- .headers(headers -> headers
- .addHeaderWriter(new StaticHeadersWriter("X-Custom-Security-Header","header-value"))
- );
- return http.build();
- }
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <!-- ... -->
- <headers>
- <header name="X-Custom-Security-Header" value="header-value"/>
- </headers>
- </http>
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- @EnableWebSecurity
- class SecurityConfig {
- @Bean
- open fun filterChain(http: HttpSecurity): SecurityFilterChain {
- http {
- // ...
- headers {
- addHeaderWriter(StaticHeadersWriter("X-Custom-Security-Header","header-value"))
- }
- }
- return http.build()
- }
- }
- ----
- ====
- [[servlet-headers-writer]]
- === Headers Writer
- When the namespace or Java configuration does not support the headers you want, you can create a custom `HeadersWriter` instance or even provide a custom implementation of the `HeadersWriter`.
- The next example use a custom instance of `XFrameOptionsHeaderWriter`.
- If you wanted to explicitly configure <<servlet-headers-frame-options>>, you could do so with the following configuration:
- .Headers Writer
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- public class WebSecurityConfig {
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- // ...
- .headers(headers -> headers
- .addHeaderWriter(new XFrameOptionsHeaderWriter(XFrameOptionsMode.SAMEORIGIN))
- );
- return http.build();
- }
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <!-- ... -->
- <headers>
- <header ref="frameOptionsWriter"/>
- </headers>
- </http>
- <!-- Requires the c-namespace.
- See https://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#beans-c-namespace
- -->
- <beans:bean id="frameOptionsWriter"
- class="org.springframework.security.web.header.writers.frameoptions.XFrameOptionsHeaderWriter"
- c:frameOptionsMode="SAMEORIGIN"/>
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- @EnableWebSecurity
- class SecurityConfig {
- @Bean
- open fun filterChain(http: HttpSecurity): SecurityFilterChain {
- http {
- // ...
- headers {
- addHeaderWriter(XFrameOptionsHeaderWriter(XFrameOptionsMode.SAMEORIGIN))
- }
- }
- return http.build()
- }
- }
- ----
- ====
- [[headers-delegatingrequestmatcherheaderwriter]]
- === DelegatingRequestMatcherHeaderWriter
- At times, you may want to write a header only for certain requests.
- For example, perhaps you want to protect only your login page from being framed.
- You could use the `DelegatingRequestMatcherHeaderWriter` to do so.
- The following configuration example uses `DelegatingRequestMatcherHeaderWriter`:
- .DelegatingRequestMatcherHeaderWriter Java Configuration
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- public class WebSecurityConfig {
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- RequestMatcher matcher = new AntPathRequestMatcher("/login");
- DelegatingRequestMatcherHeaderWriter headerWriter =
- new DelegatingRequestMatcherHeaderWriter(matcher,new XFrameOptionsHeaderWriter());
- http
- // ...
- .headers(headers -> headers
- .frameOptions(frameOptions -> frameOptions.disable())
- .addHeaderWriter(headerWriter)
- );
- return http.build();
- }
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <!-- ... -->
- <headers>
- <frame-options disabled="true"/>
- <header ref="headerWriter"/>
- </headers>
- </http>
- <beans:bean id="headerWriter"
- class="org.springframework.security.web.header.writers.DelegatingRequestMatcherHeaderWriter">
- <beans:constructor-arg>
- <bean class="org.springframework.security.web.util.matcher.AntPathRequestMatcher"
- c:pattern="/login"/>
- </beans:constructor-arg>
- <beans:constructor-arg>
- <beans:bean
- class="org.springframework.security.web.header.writers.frameoptions.XFrameOptionsHeaderWriter"/>
- </beans:constructor-arg>
- </beans:bean>
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- @EnableWebSecurity
- class SecurityConfig {
- @Bean
- open fun filterChain(http: HttpSecurity): SecurityFilterChain {
- val matcher: RequestMatcher = AntPathRequestMatcher("/login")
- val headerWriter = DelegatingRequestMatcherHeaderWriter(matcher, XFrameOptionsHeaderWriter())
- http {
- headers {
- frameOptions {
- disable()
- }
- addHeaderWriter(headerWriter)
- }
- }
- return http.build()
- }
- }
- ----
- ====
|