Skip to content

Add configurable authorities split regex #12073

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2018 the original author or authors.
* Copyright 2002-2022 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.
Expand Down Expand Up @@ -45,10 +45,14 @@ public final class JwtGrantedAuthoritiesConverter implements Converter<Jwt, Coll

private static final String DEFAULT_AUTHORITY_PREFIX = "SCOPE_";

private static final String DEFAULT_AUTHORITIES_SPLIT_REGEX = " ";

private static final Collection<String> WELL_KNOWN_AUTHORITIES_CLAIM_NAMES = Arrays.asList("scope", "scp");

private String authorityPrefix = DEFAULT_AUTHORITY_PREFIX;

private String authoritiesSplitRegex = DEFAULT_AUTHORITIES_SPLIT_REGEX;

private String authoritiesClaimName;

/**
Expand Down Expand Up @@ -77,6 +81,18 @@ public void setAuthorityPrefix(String authorityPrefix) {
this.authorityPrefix = authorityPrefix;
}

/**
* Sets the regex to use for splitting the value of the authorities claim into
* {@link GrantedAuthority authorities}. Defaults to
* {@link JwtGrantedAuthoritiesConverter#DEFAULT_AUTHORITIES_SPLIT_REGEX}.
* @param authoritiesSplitRegex The regex used to split the authorities
* @since 6.1
*/
public void setAuthoritiesSplitRegex(String authoritiesSplitRegex) {
Assert.notNull(authoritiesSplitRegex, "authoritiesSplitRegex cannot be null");
this.authoritiesSplitRegex = authoritiesSplitRegex;
}

/**
* Sets the name of token claim to use for mapping {@link GrantedAuthority
* authorities} by this converter. Defaults to
Expand Down Expand Up @@ -113,7 +129,7 @@ private Collection<String> getAuthorities(Jwt jwt) {
Object authorities = jwt.getClaim(claimName);
if (authorities instanceof String) {
if (StringUtils.hasText((String) authorities)) {
return Arrays.asList(((String) authorities).split(" "));
return Arrays.asList(((String) authorities).split(this.authoritiesSplitRegex));
}
return Collections.emptyList();
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2018 the original author or authors.
* Copyright 2002-2022 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.
Expand Down Expand Up @@ -256,4 +256,18 @@ public void convertWhenTokenHasNoCustomClaimNameThenCustomClaimNameAttributeIsTr
assertThat(authorities).isEmpty();
}

@Test
public void convertWithCustomAuthoritiesSplitRegexWhenTokenHasScopeAttributeThenTranslatedToAuthorities() {
// @formatter:off
Jwt jwt = TestJwts.jwt()
.claim("scope", "message:read,message:write")
.build();
// @formatter:on
JwtGrantedAuthoritiesConverter jwtGrantedAuthoritiesConverter = new JwtGrantedAuthoritiesConverter();
jwtGrantedAuthoritiesConverter.setAuthoritiesSplitRegex(",");
Collection<GrantedAuthority> authorities = jwtGrantedAuthoritiesConverter.convert(jwt);
assertThat(authorities).containsExactly(new SimpleGrantedAuthority("SCOPE_message:read"),
new SimpleGrantedAuthority("SCOPE_message:write"));
}

}