4 changed files with 871 additions and 861 deletions
@ -0,0 +1,369 @@
@@ -0,0 +1,369 @@
|
||||
[[headers]] |
||||
= Security HTTP Response Headers |
||||
|
||||
[NOTE] |
||||
==== |
||||
This portion of the documentation discusses the general topic of Security HTTP Response Headers. |
||||
Refer to the relevant sections for specific information on Security HTTP Response Headers <<servlet-headers,servlet>> and <<webflux-headers,WebFlux>> based applications. |
||||
==== |
||||
|
||||
There are many https://www.owasp.org/index.php/OWASP_Secure_Headers_Project#tab=Headers[HTTP response headers] that can be used to increase the security of web applications. |
||||
This section is dedicated to the various HTTP response headers that Spring Security provides explicit support for. |
||||
If necessary, Spring Security can also be configured to provide <<headers-custom,custom headers>>. |
||||
|
||||
[[headers-default]] |
||||
== Default Security Headers |
||||
|
||||
[NOTE] |
||||
==== |
||||
Refer to the relevant sections to see how to customize the defaults for both <<servlet-headers-default,servlet>> and <<webflux-headers-default,webflux>> based applications. |
||||
==== |
||||
|
||||
Spring Security provides a default set of security related HTTP response headers to provide secure defaults. |
||||
|
||||
The default for Spring Security is to include the following headers: |
||||
|
||||
.Default Security HTTP Response Headers |
||||
==== |
||||
[source,http] |
||||
---- |
||||
Cache-Control: no-cache, no-store, max-age=0, must-revalidate |
||||
Pragma: no-cache |
||||
Expires: 0 |
||||
X-Content-Type-Options: nosniff |
||||
Strict-Transport-Security: max-age=31536000 ; includeSubDomains |
||||
X-Frame-Options: DENY |
||||
X-XSS-Protection: 1; mode=block |
||||
---- |
||||
==== |
||||
|
||||
NOTE: Strict-Transport-Security is only added on HTTPS requests |
||||
|
||||
If the defaults do not meet your needs, you can easily remove, modify, or add headers from these defaults. |
||||
For additional details on each of these headers, refer to the corresponding sections: |
||||
|
||||
* <<headers-cache-control,Cache Control>> |
||||
* <<headers-content-type-options,Content Type Options>> |
||||
* <<headers-hsts,HTTP Strict Transport Security>> |
||||
* <<headers-frame-options,X-Frame-Options>> |
||||
* <<headers-xss-protection,X-XSS-Protection>> |
||||
|
||||
[[headers-cache-control]] |
||||
== Cache Control |
||||
|
||||
[NOTE] |
||||
==== |
||||
Refer to the relevant sections to see how to customize the defaults for both <<servlet-headers-cache-control,servlet>> and <<webflux-headers-cache-control,webflux>> based applications. |
||||
==== |
||||
|
||||
Spring Security's default is to disable caching to protect user's content. |
||||
|
||||
If a user authenticates to view sensitive information and then logs out, we don't want a malicious user to be able to click the back button to view the sensitive information. |
||||
The cache control headers that are sent by default are: |
||||
|
||||
.Default Cache Control HTTP Response Headers |
||||
==== |
||||
[source] |
||||
---- |
||||
Cache-Control: no-cache, no-store, max-age=0, must-revalidate |
||||
Pragma: no-cache |
||||
Expires: 0 |
||||
---- |
||||
==== |
||||
|
||||
In order to be secure by default, Spring Security adds these headers by default. |
||||
However, if your application provides it's own cache control headers Spring Security will back out of the way. |
||||
This allows for applications to ensure that static resources like CSS and JavaScript can be cached. |
||||
|
||||
|
||||
[[headers-content-type-options]] |
||||
== Content Type Options |
||||
|
||||
[NOTE] |
||||
==== |
||||
Refer to the relevant sections to see how to customize the defaults for both <<servlet-headers-content-type-options,servlet>> and <<webflux-headers-content-type-options,webflux>> based applications. |
||||
==== |
||||
|
||||
Historically browsers, including Internet Explorer, would try to guess the content type of a request using https://en.wikipedia.org/wiki/Content_sniffing[content sniffing]. |
||||
This allowed browsers to improve the user experience by guessing the content type on resources that had not specified the content type. |
||||
For example, if a browser encountered a JavaScript file that did not have the content type specified, it would be able to guess the content type and then execute it. |
||||
|
||||
[NOTE] |
||||
==== |
||||
There are many additional things one should do (i.e. only display the document in a distinct domain, ensure Content-Type header is set, sanitize the document, etc) when allowing content to be uploaded. |
||||
However, these measures are out of the scope of what Spring Security provides. |
||||
It is also important to point out when disabling content sniffing, you must specify the content type in order for things to work properly. |
||||
==== |
||||
|
||||
The problem with content sniffing is that this allowed malicious users to use polyglots (i.e. a file that is valid as multiple content types) to execute XSS attacks. |
||||
For example, some sites may allow users to submit a valid postscript document to a website and view it. |
||||
A malicious user might create a http://webblaze.cs.berkeley.edu/papers/barth-caballero-song.pdf[postscript document that is also a valid JavaScript file] and execute a XSS attack with it. |
||||
|
||||
Spring Security disables content sniffing by default by adding the following header to HTTP responses: |
||||
|
||||
.nosniff HTTP Response Header |
||||
==== |
||||
[source,http] |
||||
---- |
||||
X-Content-Type-Options: nosniff |
||||
---- |
||||
==== |
||||
|
||||
[[headers-hsts]] |
||||
== HTTP Strict Transport Security (HSTS) |
||||
|
||||
[NOTE] |
||||
==== |
||||
Refer to the relevant sections to see how to customize the defaults for both <<servlet-headers-hsts,servlet>> and <<webflux-headers-hsts,webflux>> based applications. |
||||
==== |
||||
|
||||
When you type in your bank's website, do you enter mybank.example.com or do you enter https://mybank.example.com[]? |
||||
If you omit the https protocol, you are potentially vulnerable to https://en.wikipedia.org/wiki/Man-in-the-middle_attack[Man in the Middle attacks]. |
||||
Even if the website performs a redirect to https://mybank.example.com a malicious user could intercept the initial HTTP request and manipulate the response (i.e. redirect to https://mibank.example.com and steal their credentials). |
||||
|
||||
Many users omit the https protocol and this is why https://tools.ietf.org/html/rfc6797[HTTP Strict Transport Security (HSTS)] was created. |
||||
Once mybank.example.com is added as a https://tools.ietf.org/html/rfc6797#section-5.1[HSTS host], a browser can know ahead of time that any request to mybank.example.com should be interpreted as https://mybank.example.com. |
||||
This greatly reduces the possibility of a Man in the Middle attack occurring. |
||||
|
||||
[NOTE] |
||||
==== |
||||
In accordance with https://tools.ietf.org/html/rfc6797#section-7.2[RFC6797], the HSTS header is only injected into HTTPS responses. |
||||
In order for the browser to acknowledge the header, the browser must first trust the CA that signed the SSL certificate used to make the connection (not just the SSL certificate). |
||||
==== |
||||
|
||||
One way for a site to be marked as a HSTS host is to have the host preloaded into the browser. |
||||
Another is to add the `Strict-Transport-Security` header to the response. |
||||
For example, Spring Security's default behavior is to add the following header which instructs the browser to treat the domain as an HSTS host for a year (there are approximately 31536000 seconds in a year): |
||||
|
||||
|
||||
.Strict Transport Security HTTP Response Header |
||||
==== |
||||
[source] |
||||
---- |
||||
Strict-Transport-Security: max-age=31536000 ; includeSubDomains ; preload |
||||
---- |
||||
==== |
||||
|
||||
The optional `includeSubDomains` directive instructs the browser that subdomains (i.e. secure.mybank.example.com) should also be treated as an HSTS domain. |
||||
|
||||
The optional `preload` directive instructs the browser that domain should be preloaded in browser as HSTS domain. |
||||
For more details on HSTS preload please see https://hstspreload.org. |
||||
|
||||
[[headers-hpkp]] |
||||
== HTTP Public Key Pinning (HPKP) |
||||
|
||||
[NOTE] |
||||
==== |
||||
In order to remain passive Spring Security still provides <<servlet-headers-hpkp,support for HPKP in servlet environments>>, but for the reasons listed above HPKP is no longer recommended by the security team. |
||||
==== |
||||
|
||||
https://developer.mozilla.org/en-US/docs/Web/HTTP/Public_Key_Pinning[HTTP Public Key Pinning (HPKP)] specifies to a web client which public key to use with certain web server to prevent Man in the Middle (MITM) attacks with forged certificates. |
||||
When used correctly, HPKP could add additional layers of protection against compromised certificates. |
||||
However, due to the complexity of HPKP many experts no longer recommend using it and https://www.chromestatus.com/feature/5903385005916160[Chrome has even removed support] for it. |
||||
|
||||
[[headers-hpkp-deprecated]] |
||||
For additional details around why HPKP is no longer recommended read https://blog.qualys.com/ssllabs/2016/09/06/is-http-public-key-pinning-dead[ |
||||
Is HTTP Public Key Pinning Dead?] and https://scotthelme.co.uk/im-giving-up-on-hpkp/[I'm giving up on HPKP]. |
||||
|
||||
[[headers-frame-options]] |
||||
== X-Frame-Options |
||||
|
||||
[NOTE] |
||||
==== |
||||
Refer to the relevant sections to see how to customize the defaults for both <<servlet-headers-frame-options,servlet>> and <<webflux-headers-frame-options,webflux>> based applications. |
||||
==== |
||||
|
||||
Allowing your website to be added to a frame can be a security issue. |
||||
For example, using clever CSS styling users could be tricked into clicking on something that they were not intending (https://www.youtube.com/watch?v=3mk0RySeNsU[video demo]). |
||||
For example, a user that is logged into their bank might click a button that grants access to other users. |
||||
This sort of attack is known as https://en.wikipedia.org/wiki/Clickjacking[Clickjacking]. |
||||
|
||||
[NOTE] |
||||
==== |
||||
Another modern approach to dealing with clickjacking is to use <<headers-csp>>. |
||||
==== |
||||
|
||||
There are a number ways to mitigate clickjacking attacks. |
||||
For example, to protect legacy browsers from clickjacking attacks you can use https://www.owasp.org/index.php/Clickjacking_Defense_Cheat_Sheet#Best-for-now_Legacy_Browser_Frame_Breaking_Script[frame breaking code]. |
||||
While not perfect, the frame breaking code is the best you can do for the legacy browsers. |
||||
|
||||
A more modern approach to address clickjacking is to use https://developer.mozilla.org/en-US/docs/HTTP/X-Frame-Options[X-Frame-Options] header. |
||||
By default Spring Security disables rendering pages within an iframe using with the following header: |
||||
|
||||
[source] |
||||
---- |
||||
X-Frame-Options: DENY |
||||
---- |
||||
|
||||
[[headers-xss-protection]] |
||||
== X-XSS-Protection |
||||
|
||||
[NOTE] |
||||
==== |
||||
Refer to the relevant sections to see how to customize the defaults for both <<servlet-headers-xss-protection,servlet>> and <<webflux-headers-xss-protection,webflux>> based applications. |
||||
==== |
||||
|
||||
Some browsers have built in support for filtering out https://www.owasp.org/index.php/Testing_for_Reflected_Cross_site_scripting_(OWASP-DV-001)[reflected XSS attacks]. |
||||
This is by no means foolproof, but does assist in XSS protection. |
||||
|
||||
The filtering is typically enabled by default, so adding the header typically just ensures it is enabled and instructs the browser what to do when a XSS attack is detected. |
||||
For example, the filter might try to change the content in the least invasive way to still render everything. |
||||
At times, this type of replacement can become a https://hackademix.net/2009/11/21/ies-xss-filter-creates-xss-vulnerabilities/[XSS vulnerability in itself]. |
||||
Instead, it is best to block the content rather than attempt to fix it. |
||||
By default Spring Security blocks the content using the following header: |
||||
|
||||
[source] |
||||
---- |
||||
X-XSS-Protection: 1; mode=block |
||||
---- |
||||
|
||||
|
||||
[[headers-csp]] |
||||
== Content Security Policy (CSP) |
||||
|
||||
[NOTE] |
||||
==== |
||||
Refer to the relevant sections to see how to configure both <<servlet-headers-csp,servlet>> and <<webflux-headers-csp,webflux>> based applications. |
||||
==== |
||||
|
||||
https://www.w3.org/TR/CSP2/[Content Security Policy (CSP)] is a mechanism that web applications can leverage to mitigate content injection vulnerabilities, such as cross-site scripting (XSS). |
||||
CSP is a declarative policy that provides a facility for web application authors to declare and ultimately inform the client (user-agent) about the sources from which the web application expects to load resources. |
||||
|
||||
[NOTE] |
||||
==== |
||||
Content Security Policy is not intended to solve all content injection vulnerabilities. |
||||
Instead, CSP can be leveraged to help reduce the harm caused by content injection attacks. |
||||
As a first line of defense, web application authors should validate their input and encode their output. |
||||
==== |
||||
|
||||
A web application may employ the use of CSP by including one of the following HTTP headers in the response: |
||||
|
||||
* `Content-Security-Policy` |
||||
* `Content-Security-Policy-Report-Only` |
||||
|
||||
Each of these headers are used as a mechanism to deliver a security policy to the client. |
||||
A security policy contains a set of security policy directives, each responsible for declaring the restrictions for a particular resource representation. |
||||
|
||||
For example, a web application can declare that it expects to load scripts from specific, trusted sources, by including the following header in the response: |
||||
|
||||
.Content Security Policy Example |
||||
==== |
||||
[source] |
||||
---- |
||||
Content-Security-Policy: script-src https://trustedscripts.example.com |
||||
---- |
||||
==== |
||||
|
||||
An attempt to load a script from another source other than what is declared in the `script-src` directive will be blocked by the user-agent. |
||||
Additionally, if the https://www.w3.org/TR/CSP2/#directive-report-uri[report-uri] directive is declared in the security policy, then the violation will be reported by the user-agent to the declared URL. |
||||
|
||||
For example, if a web application violates the declared security policy, the following response header will instruct the user-agent to send violation reports to the URL specified in the policy's `report-uri` directive. |
||||
|
||||
.Content Security Policy with report-uri |
||||
==== |
||||
[source] |
||||
---- |
||||
Content-Security-Policy: script-src https://trustedscripts.example.com; report-uri /csp-report-endpoint/ |
||||
---- |
||||
==== |
||||
|
||||
https://www.w3.org/TR/CSP2/#violation-reports[Violation reports] are standard JSON structures that can be captured either by the web application's own API or by a publicly hosted CSP violation reporting service, such as, https://report-uri.io/. |
||||
|
||||
The `Content-Security-Policy-Report-Only` header provides the capability for web application authors and administrators to monitor security policies, rather than enforce them. |
||||
This header is typically used when experimenting and/or developing security policies for a site. |
||||
When a policy is deemed effective, it can be enforced by using the `Content-Security-Policy` header field instead. |
||||
|
||||
Given the following response header, the policy declares that scripts may be loaded from one of two possible sources. |
||||
|
||||
.Content Security Policy Report Only |
||||
==== |
||||
[source] |
||||
---- |
||||
Content-Security-Policy-Report-Only: script-src 'self' https://trustedscripts.example.com; report-uri /csp-report-endpoint/ |
||||
---- |
||||
==== |
||||
|
||||
If the site violates this policy, by attempting to load a script from _evil.com_, the user-agent will send a violation report to the declared URL specified by the _report-uri_ directive, but still allow the violating resource to load nevertheless. |
||||
|
||||
Applying Content Security Policy to a web application is often a non-trivial undertaking. |
||||
The following resources may provide further assistance in developing effective security policies for your site. |
||||
|
||||
https://www.html5rocks.com/en/tutorials/security/content-security-policy/[An Introduction to Content Security Policy] |
||||
|
||||
https://developer.mozilla.org/en-US/docs/Web/Security/CSP[CSP Guide - Mozilla Developer Network] |
||||
|
||||
https://www.w3.org/TR/CSP2/[W3C Candidate Recommendation] |
||||
|
||||
[[headers-referrer]] |
||||
== Referrer Policy |
||||
|
||||
[NOTE] |
||||
==== |
||||
Refer to the relevant sections to see how to configure both <<servlet-headers-referrer,servlet>> and <<webflux-headers-referrer,webflux>> based applications. |
||||
==== |
||||
|
||||
https://www.w3.org/TR/referrer-policy[Referrer Policy] is a mechanism that web applications can leverage to manage the referrer field, which contains the last |
||||
page the user was on. |
||||
|
||||
Spring Security's approach is to use https://www.w3.org/TR/referrer-policy/[Referrer Policy] header, which provides different https://www.w3.org/TR/referrer-policy/#referrer-policies[policies]: |
||||
|
||||
.Referrer Policy Example |
||||
==== |
||||
[source] |
||||
---- |
||||
Referrer-Policy: same-origin |
||||
---- |
||||
==== |
||||
|
||||
The Referrer-Policy response header instructs the browser to let the destination knows the source where the user was previously. |
||||
|
||||
[[headers-feature]] |
||||
== Feature Policy |
||||
|
||||
[NOTE] |
||||
==== |
||||
Refer to the relevant sections to see how to configure both <<servlet-headers-feature,servlet>> and <<webflux-headers-feature,webflux>> based applications. |
||||
==== |
||||
|
||||
https://wicg.github.io/feature-policy/[Feature Policy] is a mechanism that allows web developers to selectively enable, disable, and modify the behavior of certain APIs and web features in the browser. |
||||
|
||||
.Feature Policy Example |
||||
==== |
||||
[source] |
||||
---- |
||||
Feature-Policy: geolocation 'self' |
||||
---- |
||||
==== |
||||
|
||||
With Feature Policy, developers can opt-in to a set of "policies" for the browser to enforce on specific features used throughout your site. |
||||
These policies restrict what APIs the site can access or modify the browser's default behavior for certain features. |
||||
|
||||
|
||||
[[headers-clear-site-data]] |
||||
== Clear Site Data |
||||
|
||||
[NOTE] |
||||
==== |
||||
Refer to the relevant sections to see how to configure both <<servlet-headers-clear-site-data,servlet>> and <<webflux-headers-clear-site-data,webflux>> based applications. |
||||
==== |
||||
|
||||
https://www.w3.org/TR/clear-site-data/[Clear Site Data] is a mechanism by which any browser-side data - cookies, local storage, and the like - can be removed when an HTTP response contains this header: |
||||
|
||||
[source] |
||||
---- |
||||
Clear-Site-Data: "cache", "cookies", "storage", "executionContexts" |
||||
---- |
||||
|
||||
This is a nice clean-up action to perform on logout. |
||||
|
||||
|
||||
[[headers-custom]] |
||||
== Custom Headers |
||||
|
||||
[NOTE] |
||||
==== |
||||
Refer to the relevant sections to see how to configure both <<servlet-headers-custom,servlet>> based applications. |
||||
==== |
||||
|
||||
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. |
||||
Loading…
Reference in new issue