Document custom HttpMessageConverter support for WebAuthn

rwinch · rwinch · commit 1f9845485ce1 · 2025-01-17T21:08:16.000-06:00
Issue gh-16397
diff --git a/docs/modules/ROOT/pages/servlet/authentication/passkeys.adoc b/docs/modules/ROOT/pages/servlet/authentication/passkeys.adoc
@@ -70,6 +70,7 @@ SecurityFilterChain filterChain(HttpSecurity http) {
 			.allowedOrigins("https://example.com")
 			// optional properties
 			.creationOptionsRepository(new CustomPublicKeyCredentialCreationOptionsRepository())
+			.messageConverter(new CustomHttpMessageConverter())
 		);
 	return http.build();
 }
@@ -100,6 +101,7 @@ open fun filterChain(http: HttpSecurity): SecurityFilterChain {
 			allowedOrigins = setOf("https://example.com")
 			// optional properties
 			creationOptionsRepository = CustomPublicKeyCredentialCreationOptionsRepository()
+			messageConverter = CustomHttpMessageConverter()
 		}
 	}
 }
diff --git a/docs/modules/ROOT/pages/whats-new.adoc b/docs/modules/ROOT/pages/whats-new.adoc
@@ -17,4 +17,5 @@ Note that this may affect reports that operate on this key name.
 
 == WebAuthn
 
+* https://github.com/spring-projects/spring-security/pull/16397[gh-16397] - Added the ability to configure a custom `HttpMessageConverter` for Passkeys using the optional xref:servlet/authentication/passkeys.adoc#passkeys-configuration[`messageConverter` property] on the `webAuthn` DSL.
 * https://github.com/spring-projects/spring-security/pull/16396[gh-16396] - Added the ability to configure a custom xref:servlet/authentication/passkeys.adoc#passkeys-configuration-pkccor[`PublicKeyCredentialCreationOptionsRepository`]

Original file line number	Diff line number	Diff line change
`@@ -70,6 +70,7 @@ SecurityFilterChain filterChain(HttpSecurity http) {`
`70`	`70`	`.allowedOrigins("https://example.com")`
`71`	`71`	`// optional properties`
`72`	`72`	`.creationOptionsRepository(new CustomPublicKeyCredentialCreationOptionsRepository())`
	`73`	`+ .messageConverter(new CustomHttpMessageConverter())`
`73`	`74`	`);`
`74`	`75`	`return http.build();`
`75`	`76`	`}`
`@@ -100,6 +101,7 @@ open fun filterChain(http: HttpSecurity): SecurityFilterChain {`
`100`	`101`	`allowedOrigins = setOf("https://example.com")`
`101`	`102`	`// optional properties`
`102`	`103`	`creationOptionsRepository = CustomPublicKeyCredentialCreationOptionsRepository()`
	`104`	`+ messageConverter = CustomHttpMessageConverter()`
`103`	`105`	`}`
`104`	`106`	`}`
`105`	`107`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,4 +17,5 @@ Note that this may affect reports that operate on this key name.`
`17`	`17`
`18`	`18`	`== WebAuthn`
`19`	`19`
	`20`	+* https://github.com/spring-projects/spring-security/pull/16397[gh-16397] - Added the ability to configure a custom `HttpMessageConverter` for Passkeys using the optional xref:servlet/authentication/passkeys.adoc#passkeys-configuration[`messageConverter` property] on the `webAuthn` DSL.
`20`	`21`	* https://github.com/spring-projects/spring-security/pull/16396[gh-16396] - Added the ability to configure a custom xref:servlet/authentication/passkeys.adoc#passkeys-configuration-pkccor[`PublicKeyCredentialCreationOptionsRepository`]