Skip to content
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

Add support for Keycloak #464

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
Expand Up @@ -148,6 +148,7 @@ class FormSecurityConfiguration extends WebSecurityConfigurerAdapter {
gitlab: new OAuth2UserConverterService.GitLabUserConverter(),
auth0: new OAuth2UserConverterService.Auth0UserConverter(),
hydra: new OAuth2UserConverterService.HydraUserConverter(),
keycloak: new OAuth2UserConverterService.KeycloakUserConverter(),
]
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -206,4 +206,34 @@ class OAuth2UserConverterService {
)
}
}

static class KeycloakUserConverter implements OAuth2UserConverter {
static final String USERNAME = 'preferred_username'
static final String NAME = 'name'
static final String FIRST_NAME = 'given_name'
static final String LAST_NAME = 'family_name'
static final String EMAIL = 'email'

String providerId = 'keycloak'

@Override
UserInfo convert(String providerId, OAuth2User oAuth2User) {
String username = oAuth2User.getName()
assert username, "Error getting name attribute of oAuth2User [${oAuth2User}] from providerId [$providerId]"

String firstName = oAuth2User.attributes.get(FIRST_NAME)
String lastName = oAuth2User.attributes.get(LAST_NAME)
String email = oAuth2User.attributes.get(EMAIL)
if (!(firstName && lastName && email)) {
throw new SkillsAuthorizationException("First Name [$firstName], Last Name [$lastName], and email [$email] must be configured in Keycloak")
}

return new UserInfo(
username: "${username}-${providerId}",
email: email,
firstName: firstName,
lastName: lastName,
)
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,39 @@ class OAuth2UserConverterServiceSpec extends Specification {
result == expected
}

def "Keycloak OAuth Converter"() {
OAuth2UserConverterService service = new OAuth2UserConverterService()
service.lookup = new FormSecurityConfiguration().oAuth2UserConverterMap()

final String providerId = 'keycloak'
final String userName = 'joeuser'
final String firstName = 'Joe'
final String lastName = 'User'
final String email = "${userName}@email.com"
Map<String, Object> attributes = [
preferred_username: userName,
name: "${firstName} ${lastName}",
given_name: firstName,
family_name: lastName,
email: email,
]

OAuth2User oAuth2User = createOAuth2User(userName, attributes)
UserInfo expected = new UserInfo(
username: "${userName}-${providerId}",
usernameForDisplay: userName,
email: email,
firstName: firstName,
lastName: lastName
)

when:
UserInfo result = service.convert(providerId, oAuth2User)

then:
result == expected
}

private OAuth2User createOAuth2User(String providerUserId, Map<String, Object> attributes) {
return new OAuth2User() {
@Override
Expand Down