Skip to content

Commit 6f8544f

Browse files
committed
Polish ContentSecurityPolicy Nonce Support
Signed-off-by: Josh Cummings <[email protected]>
1 parent 5c9fc06 commit 6f8544f

7 files changed

Lines changed: 19 additions & 14 deletions

File tree

‎config/src/main/java/org/springframework/security/config/web/server/ServerHttpSecurity.java‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2486,7 +2486,7 @@ public final class HeaderSpec {
24862486

24872487
private CrossOriginResourcePolicyServerHttpHeadersWriter crossOriginResourcePolicy = new CrossOriginResourcePolicyServerHttpHeadersWriter();
24882488

2489-
private ContentSecurityPolicyNonceGeneratingWebFilter nonceGeneratingFilter;
2489+
private @Nullable ContentSecurityPolicyNonceGeneratingWebFilter nonceGeneratingFilter;
24902490

24912491
private HeaderSpec() {
24922492
this.writers = new ArrayList<>(Arrays.asList(this.cacheControl, this.contentTypeOptions, this.hsts,
@@ -2847,10 +2847,12 @@ public final class ContentSecurityPolicySpec {
28472847

28482848
private @Nullable ServerWebExchangeMatcher exchangeMatcher;
28492849

2850+
private final ContentSecurityPolicyNonceGeneratingWebFilter nonceGeneratingFilter = new ContentSecurityPolicyNonceGeneratingWebFilter();
2851+
28502852
private ContentSecurityPolicySpec() {
28512853
HeaderSpec.this.contentSecurityPolicy.setPolicyDirectives(DEFAULT_SRC_SELF_POLICY);
28522854
HeaderSpec.this.contentSecurityPolicy.setExchangeMatcher(ServerWebExchangeMatchers.anyExchange());
2853-
HeaderSpec.this.nonceGeneratingFilter = new ContentSecurityPolicyNonceGeneratingWebFilter();
2855+
HeaderSpec.this.nonceGeneratingFilter = this.nonceGeneratingFilter;
28542856
}
28552857

28562858
/**
@@ -2894,7 +2896,7 @@ private ContentSecurityPolicySpec(String policyDirectives) {
28942896
*/
28952897
public ContentSecurityPolicySpec nonceAttributeName(String nonceAttributeName) {
28962898
Assert.hasLength(nonceAttributeName, "NonceAttributeName must not be null or empty");
2897-
HeaderSpec.this.nonceGeneratingFilter.setAttributeName(nonceAttributeName);
2899+
this.nonceGeneratingFilter.setAttributeName(nonceAttributeName);
28982900
return this;
28992901
}
29002902

‎config/src/main/kotlin/org/springframework/security/config/annotation/web/headers/ContentSecurityPolicyDsl.kt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ class ContentSecurityPolicyDsl {
5858
*/
5959
var requestMatcher: RequestMatcher? = null
6060

61-
private var requireCspPathPatterns: Array<out String>? = null
61+
private var requestMatcherPatterns: Array<out String>? = null
6262

6363
/**
6464
* Specify the matching path patterns for determining when CSP should be applied.
@@ -72,7 +72,7 @@ class ContentSecurityPolicyDsl {
7272
* @see requestMatcher
7373
*/
7474
fun requestMatchers(vararg pathPatterns: String) {
75-
requireCspPathPatterns = pathPatterns
75+
requestMatcherPatterns = pathPatterns
7676
}
7777

7878
internal fun get(): (HeadersConfigurer<HttpSecurity>.ContentSecurityPolicyConfig) -> Unit {
@@ -87,7 +87,7 @@ class ContentSecurityPolicyDsl {
8787
}
8888
nonceAttributeName?.also(contentSecurityPolicy::nonceAttributeName)
8989
requestMatcher?.also(contentSecurityPolicy::requestMatcher)
90-
requireCspPathPatterns?.also(contentSecurityPolicy::requestMatchers)
90+
requestMatcherPatterns?.also(contentSecurityPolicy::requestMatchers)
9191
}
9292
}
9393
}

‎config/src/main/kotlin/org/springframework/security/config/web/server/ServerContentSecurityPolicyDsl.kt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ class ServerContentSecurityPolicyDsl {
5555
*/
5656
var exchangeMatcher: ServerWebExchangeMatcher? = null
5757

58-
private var requireCspPathPatterns: Array<out String>? = null
58+
private var exchangeMatcherPatterns: Array<out String>? = null
5959

6060
/**
6161
* Specify the matching path patterns for determining when CSP should be applied.
@@ -68,7 +68,7 @@ class ServerContentSecurityPolicyDsl {
6868
* @see exchangeMatcher
6969
*/
7070
fun exchangeMatchers(vararg pathPatterns: String) {
71-
requireCspPathPatterns = pathPatterns
71+
exchangeMatcherPatterns = pathPatterns
7272
}
7373

7474
internal fun get(): (ServerHttpSecurity.HeaderSpec.ContentSecurityPolicySpec) -> Unit {
@@ -81,7 +81,7 @@ class ServerContentSecurityPolicyDsl {
8181
}
8282
nonceAttributeName?.also(contentSecurityPolicy::nonceAttributeName)
8383
exchangeMatcher?.also(contentSecurityPolicy::exchangeMatcher)
84-
requireCspPathPatterns?.also(contentSecurityPolicy::exchangeMatchers)
84+
exchangeMatcherPatterns?.also(contentSecurityPolicy::exchangeMatchers)
8585
}
8686
}
8787
}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,6 @@ public ContentSecurityPolicyHeaderWriter(String policyDirectives) {
151151
* jakarta.servlet.http.HttpServletResponse)
152152
*/
153153
@Override
154-
@SuppressWarnings("unchecked")
155154
public void writeHeaders(HttpServletRequest request, HttpServletResponse response) {
156155
if (!this.requestMatcher.matches(request)) {
157156
return;
@@ -165,7 +164,8 @@ public void writeHeaders(HttpServletRequest request, HttpServletResponse respons
165164
.getAttribute(ContentSecurityPolicyNonce.class.getName());
166165
Assert.state(nonce != null,
167166
() -> "Failed to replace {nonce} placeholders since no nonce found as a request attribute "
168-
+ ContentSecurityPolicyNonce.class.getName());
167+
+ ContentSecurityPolicyNonce.class.getName()
168+
+ ". Please ensure that a ContentSecurityPolicyNonceGeneratingFilter runs before headers are written.");
169169
csp = this.policyDirectives.replace(NONCE_PLACEHOLDER, nonce.getNonce());
170170
}
171171
else {

‎web/src/main/java/org/springframework/security/web/server/header/ContentSecurityPolicyServerHttpHeadersWriter.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,8 @@ public Mono<Void> writeHttpHeaders(ServerWebExchange exchange) {
9595
if (deferredNonce == null) {
9696
return Mono.error(new IllegalStateException(
9797
"Failed to replace {nonce} placeholders since no nonce found as an exchange attribute "
98-
+ ContentSecurityPolicyNonce.class.getName()));
98+
+ ContentSecurityPolicyNonce.class.getName()
99+
+ ". Please ensure that a ContentSecurityPolicyNonceGeneratingWebFilter runs before headers are written."));
99100
}
100101
return deferredNonce.doOnNext((ContentSecurityPolicyNonce nonce) -> {
101102
String cspWithNonce = csp.replace(NONCE_PLACEHOLDER, nonce.getNonce());

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,8 @@ public void writeNonceBasedCspWhenNonceUnsetThenThrows() {
144144
this.writer.setPolicyDirectives("script-src 'nonce-{nonce}'");
145145
assertThatIllegalStateException().isThrownBy(() -> this.writer.writeHeaders(this.request, this.response))
146146
.withMessage("Failed to replace {nonce} placeholders since no nonce found as a request attribute "
147-
+ ContentSecurityPolicyNonce.class.getName());
147+
+ ContentSecurityPolicyNonce.class.getName()
148+
+ ". Please ensure that a ContentSecurityPolicyNonceGeneratingFilter runs before headers are written.");
148149
}
149150

150151
}

‎web/src/test/java/org/springframework/security/web/server/header/ContentSecurityPolicyServerHttpHeadersWriterTests.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,8 @@ public void writeNonceBasedCspWhenNonceUnsetThenEmitError() {
115115
StepVerifier.create(this.writer.writeHttpHeaders(this.exchange))
116116
.expectErrorSatisfies((ex) -> assertThat(ex).isInstanceOf(IllegalStateException.class)
117117
.hasMessage("Failed to replace {nonce} placeholders since no nonce found as an exchange attribute "
118-
+ ContentSecurityPolicyNonce.class.getName()))
118+
+ ContentSecurityPolicyNonce.class.getName()
119+
+ ". Please ensure that a ContentSecurityPolicyNonceGeneratingWebFilter runs before headers are written."))
119120
.verify();
120121
}
121122

0 commit comments

Comments
 (0)