Consider having HeaderWriters check before writing

All HeadersWriter only write Header if its not already
written.

Fixes: spring-projectsgh-6454 spring-projectsgh-5193

Author: ankurpathak

web/src/main/java/org/springframework/security/web/header/writers/ContentSecurityPolicyHeaderWriter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -73,6 +73,7 @@
  * </p>
  *
  * @author Joe Grandja
+ * @author Ankur Pathak
  * @since 4.1
  */
 public final class ContentSecurityPolicyHeaderWriter implements HeaderWriter {
@@ -100,7 +101,10 @@ public ContentSecurityPolicyHeaderWriter(String policyDirectives) {
 	 */
 	@Override
 	public void writeHeaders(HttpServletRequest request, HttpServletResponse response) {
-		response.setHeader((!reportOnly ? CONTENT_SECURITY_POLICY_HEADER : CONTENT_SECURITY_POLICY_REPORT_ONLY_HEADER), policyDirectives);
+		String headerName = !reportOnly ? CONTENT_SECURITY_POLICY_HEADER : CONTENT_SECURITY_POLICY_REPORT_ONLY_HEADER;
+		if (!response.containsHeader(headerName)) {
+			response.setHeader(headerName, policyDirectives);
+		}
 	}
 
 	/**

web/src/main/java/org/springframework/security/web/header/writers/FeaturePolicyHeaderWriter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2018 the original author or authors.
+ * Copyright 2002-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -33,6 +33,7 @@
  * responsible for declaring the restrictions for a particular feature type.
  *
  * @author Vedran Pavic
+ * @author Ankur Pathak
  * @since 5.1
  */
 public final class FeaturePolicyHeaderWriter implements HeaderWriter {
@@ -54,7 +55,9 @@ public FeaturePolicyHeaderWriter(String policyDirectives) {
 
 	@Override
 	public void writeHeaders(HttpServletRequest request, HttpServletResponse response) {
-		response.setHeader(FEATURE_POLICY_HEADER, this.policyDirectives);
+		if (!response.containsHeader(FEATURE_POLICY_HEADER)) {
+			response.setHeader(FEATURE_POLICY_HEADER, this.policyDirectives);
+		}
 	}
 
 	/**

web/src/main/java/org/springframework/security/web/header/writers/HpkpHeaderWriter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -100,6 +100,7 @@
  * </p>
  *
  * @author Tim Ysewyn
+ * @author Ankur Pathak
  * @since 4.1
  */
 public final class HpkpHeaderWriter implements HeaderWriter {
@@ -174,7 +175,10 @@ public HpkpHeaderWriter() {
 	public void writeHeaders(HttpServletRequest request, HttpServletResponse response) {
 		if (requestMatcher.matches(request)) {
 			if (!pins.isEmpty()) {
-				response.setHeader(reportOnly ? HPKP_RO_HEADER_NAME : HPKP_HEADER_NAME, hpkpHeaderValue);
+				String headerName = reportOnly ? HPKP_RO_HEADER_NAME : HPKP_HEADER_NAME;
+				if (!response.containsHeader(headerName)) {
+					response.setHeader(headerName, hpkpHeaderValue);
+				}
 			} if (logger.isDebugEnabled()) {
 				logger.debug("Not injecting HPKP header since there aren't any pins");
 			}

web/src/main/java/org/springframework/security/web/header/writers/HstsHeaderWriter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -53,6 +53,7 @@
  * </p>
  *
  * @author Rob Winch
+ * @author Ankur Pathak
  * @since 3.2
  */
 public final class HstsHeaderWriter implements HeaderWriter {
@@ -159,7 +160,9 @@ public HstsHeaderWriter() {
 	 */
 	public void writeHeaders(HttpServletRequest request, HttpServletResponse response) {
 		if (this.requestMatcher.matches(request)) {
-			response.setHeader(HSTS_HEADER_NAME, this.hstsHeaderValue);
+			if (!response.containsHeader(HSTS_HEADER_NAME)) {
+				response.setHeader(HSTS_HEADER_NAME, this.hstsHeaderValue);
+			}
 		}
 		else if (this.logger.isDebugEnabled()) {
 			this.logger

web/src/main/java/org/springframework/security/web/header/writers/ReferrerPolicyHeaderWriter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -49,6 +49,7 @@
  *
  * @author Eddú Meléndez
  * @author Kazuki Shimizu
+ * @author Ankur Pathak
  * @since 4.2
  */
 public class ReferrerPolicyHeaderWriter implements HeaderWriter {
@@ -89,7 +90,9 @@ public void setPolicy(ReferrerPolicy policy) {
 	 */
 	@Override
 	public void writeHeaders(HttpServletRequest request, HttpServletResponse response) {
-		response.setHeader(REFERRER_POLICY_HEADER, this.policy.getPolicy());
+		if (!response.containsHeader(REFERRER_POLICY_HEADER)) {
+			response.setHeader(REFERRER_POLICY_HEADER, this.policy.getPolicy());
+		}
 	}
 
 	public enum ReferrerPolicy {

web/src/main/java/org/springframework/security/web/header/writers/StaticHeadersWriter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -30,6 +30,7 @@
  *
  * @author Marten Deinum
  * @author Rob Winch
+ * @author Ankur Pathak
  * @since 3.2
  */
 public class StaticHeadersWriter implements HeaderWriter {
@@ -56,8 +57,10 @@ public StaticHeadersWriter(String headerName, String... headerValues) {
 
 	public void writeHeaders(HttpServletRequest request, HttpServletResponse response) {
 		for (Header header : headers) {
-			for (String value : header.getValues()) {
-				response.addHeader(header.getName(), value);
+			if (!response.containsHeader(header.getName())) {
+				for (String value : header.getValues()) {
+					response.addHeader(header.getName(), value);
+				}
 			}
 		}
 	}
@@ -66,4 +69,4 @@ public void writeHeaders(HttpServletRequest request, HttpServletResponse respons
 	public String toString() {
 		return getClass().getName() + " [headers=" + headers + "]";
 	}
-}
+}

web/src/main/java/org/springframework/security/web/header/writers/XXssProtectionHeaderWriter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,6 +26,7 @@
  * >X-XSS-Protection header</a>.
  *
  * @author Rob Winch
+ * @author Ankur Pathak
  * @since 3.2
  */
 public final class XXssProtectionHeaderWriter implements HeaderWriter {
@@ -47,7 +48,9 @@ public XXssProtectionHeaderWriter() {
 	}
 
 	public void writeHeaders(HttpServletRequest request, HttpServletResponse response) {
-		response.setHeader(XSS_PROTECTION_HEADER, headerValue);
+		if (!response.containsHeader(XSS_PROTECTION_HEADER)) {
+			response.setHeader(XSS_PROTECTION_HEADER, headerValue);
+		}
 	}
 
 	/**

web/src/main/java/org/springframework/security/web/header/writers/frameoptions/XFrameOptionsHeaderWriter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2018 the original author or authors.
+ * Copyright 2002-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,6 +27,7 @@
  *
  * @author Marten Deinum
  * @author Rob Winch
+ * @author Ankur Pathak
  * @since 3.2
  *
  * @see AllowFromStrategy
@@ -84,10 +85,14 @@ public void writeHeaders(HttpServletRequest request, HttpServletResponse respons
 		if (XFrameOptionsMode.ALLOW_FROM.equals(frameOptionsMode)) {
 			String allowFromValue = this.allowFromStrategy.getAllowFromValue(request);
 			if (XFrameOptionsMode.DENY.getMode().equals(allowFromValue)) {
-				response.setHeader(XFRAME_OPTIONS_HEADER, XFrameOptionsMode.DENY.getMode());
+				if (!response.containsHeader(XFRAME_OPTIONS_HEADER)) {
+					response.setHeader(XFRAME_OPTIONS_HEADER, XFrameOptionsMode.DENY.getMode());
+				}
 			} else if (allowFromValue != null) {
-				response.setHeader(XFRAME_OPTIONS_HEADER,
-						XFrameOptionsMode.ALLOW_FROM.getMode() + " " + allowFromValue);
+				if (!response.containsHeader(XFRAME_OPTIONS_HEADER)) {
+					response.setHeader(XFRAME_OPTIONS_HEADER,
+							XFrameOptionsMode.ALLOW_FROM.getMode() + " " + allowFromValue);
+				}
 			}
 		}
 		else {

web/src/test/java/org/springframework/security/web/header/writers/ContentSecurityPolicyHeaderWriterTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,12 +24,16 @@
 
 /**
  * @author Joe Grandja
+ * @author Ankur Pathak
  */
 public class ContentSecurityPolicyHeaderWriterTests {
 	private static final String DEFAULT_POLICY_DIRECTIVES = "default-src 'self'";
 	private MockHttpServletRequest request;
 	private MockHttpServletResponse response;
 	private ContentSecurityPolicyHeaderWriter writer;
+	private static final String CONTENT_SECURITY_POLICY_HEADER = "Content-Security-Policy";
+	private static final String CONTENT_SECURITY_POLICY_REPORT_ONLY_HEADER = "Content-Security-Policy-Report-Only";
+
 
 	@Before
 	public void setup() {
@@ -87,4 +91,21 @@ public void writeHeadersContentSecurityPolicyInvalid() {
 		writer = new ContentSecurityPolicyHeaderWriter(null);
 	}
 
-}
+
+	@Test
+	public void writeHeaderOnlyIfNotPresentContentSecurityPolicyHeader(){
+		String value = new String("value");
+		this.response.setHeader(CONTENT_SECURITY_POLICY_HEADER, value);
+		this.writer.writeHeaders(this.request, this.response);
+		assertThat(this.response.getHeader(CONTENT_SECURITY_POLICY_HEADER)).isSameAs(value);
+	}
+
+	@Test
+	public void writeHeaderOnlyIfNotPresentContentSecurityPolicyReportOnlyHeader(){
+		String value = new String("value");
+		this.response.setHeader(CONTENT_SECURITY_POLICY_REPORT_ONLY_HEADER, value);
+		this.writer.setReportOnly(true);
+		this.writer.writeHeaders(this.request, this.response);
+		assertThat(this.response.getHeader(CONTENT_SECURITY_POLICY_REPORT_ONLY_HEADER)).isSameAs(value);
+	}
+}

web/src/test/java/org/springframework/security/web/header/writers/FeaturePolicyHeaderWriterTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2018 the original author or authors.
+ * Copyright 2002-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -29,6 +29,7 @@
  * Tests for {@link FeaturePolicyHeaderWriter}.
  *
  * @author Vedran Pavic
+ * @author Ankur Pathak
  */
 public class FeaturePolicyHeaderWriterTests {
 
@@ -40,6 +41,8 @@ public class FeaturePolicyHeaderWriterTests {
 
 	private FeaturePolicyHeaderWriter writer;
 
+	private static final String FEATURE_POLICY_HEADER = "Feature-Policy";
+
 	@Before
 	public void setUp() {
 		this.request = new MockHttpServletRequest();
@@ -70,4 +73,12 @@ public void createWriterWithEmptyDirectivesShouldThrowException() {
 				.hasMessage("policyDirectives must not be null or empty");
 	}
 
+	@Test
+	public void writeHeaderOnlyIfNotPresent(){
+		String value = new String("value");
+		this.response.setHeader(FEATURE_POLICY_HEADER, value);
+		this.writer.writeHeaders(this.request, this.response);
+		assertThat(this.response.getHeader(FEATURE_POLICY_HEADER)).isSameAs(value);
+	}
+
 }

web/src/test/java/org/springframework/security/web/header/writers/HpkpHeaderWriterTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -30,6 +30,7 @@
 
 /**
  * @author Tim Ysewyn
+ * @author Ankur Pathak
  *
  */
 public class HpkpHeaderWriterTests {
@@ -47,6 +48,10 @@ public class HpkpHeaderWriterTests {
 
 	private HpkpHeaderWriter writer;
 
+	private static final String HPKP_HEADER_NAME = "Public-Key-Pins";
+
+	private static final String HPKP_RO_HEADER_NAME = "Public-Key-Pins-Report-Only";
+
 	@Before
 	public void setup() {
 		request = new MockHttpServletRequest();
@@ -196,4 +201,22 @@ public void addSha256PinsWithNullPin() {
 	public void setIncorrectReportUri() {
 		writer.setReportUri("some url here...");
 	}
+
+	@Test
+	public void writeHeaderOnlyIfNotPresentPublicKeyPins(){
+		String value = new String("value");
+		this.response.setHeader(HPKP_HEADER_NAME, value);
+		this.writer.setReportOnly(false);
+		this.writer.writeHeaders(this.request, this.response);
+		assertThat(this.response.getHeader(HPKP_HEADER_NAME)).isSameAs(value);
+	}
+
+	@Test
+	public void writeHeaderOnlyIfNotPresentPublicKeyPinsReportOnly(){
+		String value = new String("value");
+		this.response.setHeader(HPKP_RO_HEADER_NAME, value);
+		this.writer.setReportOnly(false);
+		this.writer.writeHeaders(this.request, this.response);
+		assertThat(this.response.getHeader(HPKP_RO_HEADER_NAME)).isSameAs(value);
+	}
 }