How-to: Customize client metadata during dynamic client registration

[jgrandja]

We should provide a guide that demonstrates how to customize the client metadata in OidcClientRegistration when it's provided to the OpenID Connect 1.0 Dynamic Client Registration Endpoint OidcClientRegistrationAuthenticationProvider.

Related gh-647

[jgrandja]

The extension point for customizing client metadata before it's saved to RegisteredClientRepository is OidcClientRegistrationAuthenticationProvider.setRegisteredClientConverter().

Here is a sample configuration:

@Bean
public SecurityFilterChain authorizationServerSecurityFilterChain(HttpSecurity http) throws Exception {
	OAuth2AuthorizationServerConfigurer authorizationServerConfigurer =
			new OAuth2AuthorizationServerConfigurer();
	authorizationServerConfigurer
		.oidc(oidc ->
			oidc
				.clientRegistrationEndpoint(clientRegistration ->
					clientRegistration
						.authenticationProviders(configureRegisteredClientConverter())
				)
			);

	...

}

private Consumer<List<AuthenticationProvider>> configureRegisteredClientConverter() {
	return (authenticationProviders) ->
		authenticationProviders.forEach(authenticationProvider -> {
			if (authenticationProvider instanceof OidcClientRegistrationAuthenticationProvider) {
				OidcClientRegistrationAuthenticationProvider clientRegistrationAuthenticationProvider =
						(OidcClientRegistrationAuthenticationProvider) authenticationProvider;
				clientRegistrationAuthenticationProvider.setRegisteredClientConverter(
						new CustomRegisteredClientConverter());
			}
		});
}

private static final class CustomRegisteredClientConverter implements Converter<OidcClientRegistration, RegisteredClient> {

	@Override
	public RegisteredClient convert(OidcClientRegistration clientRegistration) {
		// TODO Implement conversion from OidcClientRegistration to RegisteredClient
		// See default implementation OidcClientRegistrationAuthenticationProvider.OidcClientRegistrationRegisteredClientConverter
	}

}

[ddubson]

@jgrandja can I be assigned this issue?

Should the contents of this how-to be appended to the existing "Register a client dynamically" guide? or should it be a follow-up standalone how-to guide?

[jgrandja]

@ddubson

Should the contents of this how-to be appended to the existing "Register a client dynamically" guide?

Yes. Please add it to the existing guide.