[ZEPPELIN-2775] Strict-Transport-Security and X-XSS-Protection Headers The HTTP Strict-Transport-Security response header (often abbreviated as HSTS) is a security feature that lets a web site tell browsers that it should only be communicated with using HTTPS, instead of using HTTP. Note: The Strict-Transport-Security header is ignored by the browser when your site is accessed using HTTP; this is because an attacker may intercept HTTP connections and inject the header or remove it. When your site is accessed over HTTPS with no certificate errors, the browser knows your site is HTTPS capable and will honor the Strict-Transport-Security header.
The HTTP X-XSS-Protection response header is a feature of Internet Explorer, Chrome and Safari that stops pages from loading when they detect reflected cross-site scripting (XSS) attacks. [Bug Fix | Improvement ] * [ZEPPELIN-2775](https://issues.apache.org/jira/browse/ZEPPELIN-2775) Make a curl call to Zeppelin? Go to Chrome Browser and select "More Tools" -> "Developer Tools" from the right-side menu. Under Network Section, select any request and check for "Response Headers". You should see below headers along with existing ones. > strict-transport-security:max-age=631138519 > x-xss-protection:1; mode=block <img width="1436" alt="screen shot 2017-07-14 at 8 19 14 pm" src="https://user-images.githubusercontent.com/6433184/28217231-16ce6cee-68d2-11e7-91aa-77ad083612c7.png";> * Does this needs documentation? Author: krishna-pandey <[email protected]> Closes #2492 from krishna-pandey/ZEPPELIN-2775 and squashes the following commits: 7d9978e49 [krishna-pandey] Modified Documentation as per review. 6733289ed [krishna-pandey] Adding documentation for HTTP Security Headers 754d2d71e [krishna-pandey] Supplying String instead of Int (required for Response Header) 468231cc6 [krishna-pandey] Added configurable Strict-Transport-Security and X-XSS-Protection Headers Project: http://git-wip-us.apache.org/repos/asf/zeppelin/repo Commit: http://git-wip-us.apache.org/repos/asf/zeppelin/commit/d0ee507b Tree: http://git-wip-us.apache.org/repos/asf/zeppelin/tree/d0ee507b Diff: http://git-wip-us.apache.org/repos/asf/zeppelin/diff/d0ee507b Branch: refs/heads/branch-0.7 Commit: d0ee507bc13bd26da33bd1ec9286581b1edef05b Parents: 4a0a6bf Author: krishna-pandey <[email protected]> Authored: Tue Aug 15 11:14:18 2017 -0700 Committer: Prabhjyot Singh <[email protected]> Committed: Tue Aug 15 11:14:18 2017 -0700 ---------------------------------------------------------------------- conf/zeppelin-site.xml.template | 14 +++ docs/_includes/themes/zeppelin/_navigation.html | 1 + docs/index.md | 1 + docs/security/http_security_headers.md | 110 +++++++++++++++++++ .../org/apache/zeppelin/server/CorsFilter.java | 7 +- .../zeppelin/conf/ZeppelinConfiguration.java | 12 +- 6 files changed, 143 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/zeppelin/blob/d0ee507b/conf/zeppelin-site.xml.template ---------------------------------------------------------------------- diff --git a/conf/zeppelin-site.xml.template b/conf/zeppelin-site.xml.template index c7c878b..ec24719 100755 --- a/conf/zeppelin-site.xml.template +++ b/conf/zeppelin-site.xml.template @@ -343,4 +343,18 @@ </property> --> +<!-- +<property> + <name>zeppelin.server.strict.transport</name> + <value>max-age=631138519</value> + <description>The HTTP Strict-Transport-Security response header is a security feature that lets a web site tell browsers that it should only be communicated with using HTTPS, instead of using HTTP. Enable this when Zeppelin is running on HTTPS. Value is in Seconds, the default value is equivalent to 20 years.</description> +</property> +--> +<!-- +<property> + <name>zeppelin.server.xxss.protection</name> + <value>1</value> + <description>The HTTP X-XSS-Protection response header is a feature of Internet Explorer, Chrome and Safari that stops pages from loading when they detect reflected cross-site scripting (XSS) attacks. When value is set to 1 and a cross-site scripting attack is detected, the browser will sanitize the page (remove the unsafe parts).</description> +</property> +--> </configuration> http://git-wip-us.apache.org/repos/asf/zeppelin/blob/d0ee507b/docs/_includes/themes/zeppelin/_navigation.html ---------------------------------------------------------------------- diff --git a/docs/_includes/themes/zeppelin/_navigation.html b/docs/_includes/themes/zeppelin/_navigation.html index a53036b..dca27ef 100644 --- a/docs/_includes/themes/zeppelin/_navigation.html +++ b/docs/_includes/themes/zeppelin/_navigation.html @@ -114,6 +114,7 @@ <li><a href="{{BASE_PATH}}/security/shiroauthentication.html">Shiro Authentication</a></li> <li><a href="{{BASE_PATH}}/security/notebook_authorization.html">Notebook Authorization</a></li> <li><a href="{{BASE_PATH}}/security/datasource_authorization.html">Data Source Authorization</a></li> + <li><a href="{{BASE_PATH}}/security/http_security_headers.html">HTTP Security Headers</a></li> <li><a href="{{BASE_PATH}}/security/helium_authorization.html">Helium Authorization</a></li> <li role="separator" class="divider"></li> <li class="title"><span><b>Advanced</b><span></li> http://git-wip-us.apache.org/repos/asf/zeppelin/blob/d0ee507b/docs/index.md ---------------------------------------------------------------------- diff --git a/docs/index.md b/docs/index.md index b7cf8db..33e5b4a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -172,6 +172,7 @@ Join to our [Mailing list](https://zeppelin.apache.org/community.html) and repor * [Shiro Authentication](./security/shiroauthentication.html) * [Notebook Authorization](./security/notebook_authorization.html) * [Data Source Authorization](./security/datasource_authorization.html) + * [HTTP Security Headers](./security/http_security_headers.html) * [Helium Authorization](./security/helium_authorization.html) * Advanced * [Apache Zeppelin on Vagrant VM](./install/virtual_machine.html) http://git-wip-us.apache.org/repos/asf/zeppelin/blob/d0ee507b/docs/security/http_security_headers.md ---------------------------------------------------------------------- diff --git a/docs/security/http_security_headers.md b/docs/security/http_security_headers.md new file mode 100644 index 0000000..1c55d18 --- /dev/null +++ b/docs/security/http_security_headers.md @@ -0,0 +1,110 @@ +--- +layout: page +title: "Setting up HTTP Response Headers" +description: "There are multiple HTTP Security Headers which can be configured in Apache Zeppelin. This page describes how to enable them by providing appropriate value in Zeppelin configuration file." +group: setup/security +--- +<!-- +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> +{% include JB/setup %} + +# Setting up HTTP Response Headers for Zeppelin + +<div id="toc"></div> + +Apache Zeppelin can be configured to include HTTP Headers which aids in preventing Cross Site Scripting (XSS), Cross-Frame Scripting (XFS) and also enforces HTTP Strict Transport Security. Apache Zeppelin also has configuration available to set the Application Server Version to desired value. + +## Setting up HTTP Strict Transport Security (HSTS) Response Header + +Enabling HSTS Response Header prevents Man-in-the-middle attacks by automatically redirecting HTTP requests to HTTPS when Zeppelin Server is running on SSL. Read on how to configure SSL for Zeppelin [here] (../operation/configuration.html). Even if web page contains any resource which gets served over HTTP or any HTTP links, it will automatically be redirected to HTTPS for the target domain. +It also prevents MITM attack by not allowing User to override the invalid certificate message, when Attacker presents invalid SSL certificate to the User. + +The following property needs to be updated in the zeppelin-site.xml in order to enable HSTS. You can choose appropriate value for "max-age". + +``` +<property> + <name>zeppelin.server.strict.transport</name> + <value>max-age=631138519</value> + <description>The HTTP Strict-Transport-Security response header is a security feature that lets a web site tell browsers that it should only be communicated with using HTTPS, instead of using HTTP. Enable this when Zeppelin is running on HTTPS. Value is in Seconds, the default value is equivalent to 20 years.</description> +</property> +``` + + +Possible values are: + +* max-age=\<expire-time> +* max-age=\<expire-time>; includeSubDomains +* max-age=\<expire-time>; preload + +Read more about HSTS [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security). + +## Setting up X-XSS-PROTECTION Header + +The HTTP X-XSS-Protection response header is a feature of Internet Explorer, Chrome and Safari Web browsers that initiates configured action when they detect reflected cross-site scripting (XSS) attacks. + +The following property needs to be updated in the zeppelin-site.xml in order to set X-XSS-PROTECTION header. + +``` +<property> + <name>zeppelin.server.xxss.protection</name> + <value>1; mode=block</value> + <description>The HTTP X-XSS-Protection response header is a feature of Internet Explorer, Chrome and Safari that stops pages from loading when they detect reflected cross-site scripting (XSS) attacks. When value is set to 1 and a cross-site scripting attack is detected, the browser will sanitize the page (remove the unsafe parts).</description> +</property> +``` + + +You can choose appropriate value from below. + +* 0 (Disables XSS filtering) +* 1 (Enables XSS filtering. If a cross-site scripting attack is detected, the browser will sanitize the page.) +* 1; mode=block (Enables XSS filtering. The browser will prevent rendering of the page if an attack is detected.) + +Read more about HTTP X-XSS-Protection response header [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection). + +## Setting up X-Frame-Options Header + +The X-Frame-Options HTTP response header can indicate browser to avoid clickjacking attacks, by ensuring that their content is not embedded into other sites in a `<frame>`,`<iframe>` or `<object>`. + +The following property needs to be updated in the zeppelin-site.xml in order to set X-Frame-Options header. + +``` +<property> + <name>zeppelin.server.xframe.options</name> + <value>SAMEORIGIN</value> + <description>The X-Frame-Options HTTP response header can be used to indicate whether or not a browser should be allowed to render a page in a frame/iframe/object.</description> +</property> +``` + + +You can choose appropriate value from below. + +* DENY +* SAMEORIGIN +* ALLOW-FROM _uri_ + +## Setting up Server Header + +Security conscious organisations does not want to reveal the Application Server name and version to prevent finding this information easily by Attacker while fingerprinting the Application. The exact version number can tell an Attacker if the current Application Server is patched for or vulnerable to certain publicly known CVE associated to it. + +The following property needs to be updated in the zeppelin-site.xml in order to set Server header. + +``` +<property> + <name>zeppelin.server.jetty.name</name> + <value>Jetty(7.6.0.v20120127)</value> + <description>Hardcoding Application Server name to Prevent Fingerprinting</description> +</property> +``` + +The value can be any "String". \ No newline at end of file http://git-wip-us.apache.org/repos/asf/zeppelin/blob/d0ee507b/zeppelin-server/src/main/java/org/apache/zeppelin/server/CorsFilter.java ---------------------------------------------------------------------- diff --git a/zeppelin-server/src/main/java/org/apache/zeppelin/server/CorsFilter.java b/zeppelin-server/src/main/java/org/apache/zeppelin/server/CorsFilter.java index d29af7b..3a74bf4 100644 --- a/zeppelin-server/src/main/java/org/apache/zeppelin/server/CorsFilter.java +++ b/zeppelin-server/src/main/java/org/apache/zeppelin/server/CorsFilter.java @@ -80,7 +80,12 @@ public class CorsFilter implements Filter { DateFormat fullDateFormatEN = DateFormat.getDateTimeInstance(DateFormat.FULL, DateFormat.FULL, new Locale("EN", "en")); response.addHeader("Date", fullDateFormatEN.format(new Date())); - response.addHeader("X-FRAME-OPTIONS", ZeppelinConfiguration.create().getXFrameOptions()); + ZeppelinConfiguration zeppelinConfiguration = ZeppelinConfiguration.create(); + response.addHeader("X-FRAME-OPTIONS", zeppelinConfiguration.getXFrameOptions()); + if (zeppelinConfiguration.useSsl()) { + response.addHeader("Strict-Transport-Security", zeppelinConfiguration.getStrictTransport()); + } + response.addHeader("X-XSS-Protection", zeppelinConfiguration.getXxssProtection()); } @Override http://git-wip-us.apache.org/repos/asf/zeppelin/blob/d0ee507b/zeppelin-zengine/src/main/java/org/apache/zeppelin/conf/ZeppelinConfiguration.java ---------------------------------------------------------------------- diff --git a/zeppelin-zengine/src/main/java/org/apache/zeppelin/conf/ZeppelinConfiguration.java b/zeppelin-zengine/src/main/java/org/apache/zeppelin/conf/ZeppelinConfiguration.java index d2bb648..242a890 100644 --- a/zeppelin-zengine/src/main/java/org/apache/zeppelin/conf/ZeppelinConfiguration.java +++ b/zeppelin-zengine/src/main/java/org/apache/zeppelin/conf/ZeppelinConfiguration.java @@ -484,6 +484,14 @@ public class ZeppelinConfiguration extends XMLConfiguration { return getString(ConfVars.ZEPPELIN_SERVER_XFRAME_OPTIONS); } + public String getXxssProtection() { + return getString(ConfVars.ZEPPELIN_SERVER_X_XSS_PROTECTION); + } + + public String getStrictTransport() { + return getString(ConfVars.ZEPPELIN_SERVER_STRICT_TRANSPORT); + } + public Map<String, String> dumpConfigurations(ZeppelinConfiguration conf, ConfigurationKeyPredicate predicate) { @@ -629,7 +637,9 @@ public class ZeppelinConfiguration extends XMLConfiguration { ZEPPELIN_WEBSOCKET_MAX_TEXT_MESSAGE_SIZE("zeppelin.websocket.max.text.message.size", "1024000"), ZEPPELIN_SERVER_DEFAULT_DIR_ALLOWED("zeppelin.server.default.dir.allowed", false), ZEPPELIN_SERVER_XFRAME_OPTIONS("zeppelin.server.xframe.options", "SAMEORIGIN"), - ZEPPELIN_SERVER_JETTY_NAME("zeppelin.server.jetty.name", null); + ZEPPELIN_SERVER_JETTY_NAME("zeppelin.server.jetty.name", null), + ZEPPELIN_SERVER_STRICT_TRANSPORT("zeppelin.server.strict.transport", "max-age=631138519"), + ZEPPELIN_SERVER_X_XSS_PROTECTION("zeppelin.server.xxss.protection", "1"); private String varName; @SuppressWarnings("rawtypes")
![https://user-images.githubusercontent.com/6433184/28217231-16ce6cee-68d2-11e7-91aa-77ad083612c7.png"](https://user-images.githubusercontent.com/6433184/28217231-16ce6cee-68d2-11e7-91aa-77ad083612c7.png"){kind=link}