Browse Source

Add guild checking when federation

pull/1/head
Hiroyuki Wada 6 years ago
parent
commit
3c1925f90a
  1. 51
      ejb/src/main/java/org/keycloak/social/discord/DiscordIdentityProvider.java
  2. 57
      ejb/src/main/java/org/keycloak/social/discord/DiscordIdentityProviderConfig.java
  3. 7
      ejb/src/main/java/org/keycloak/social/discord/DiscordIdentityProviderFactory.java
  4. 4
      ejb/src/main/resources/theme/discord/admin/messages/admin-messages_en.properties
  5. 7
      ejb/src/main/resources/theme/discord/admin/resources/partials/realm-identity-provider-discord-ext.html
  6. 1
      ejb/src/main/resources/theme/discord/admin/resources/partials/realm-identity-provider-discord.html

51
ejb/src/main/java/org/keycloak/social/discord/DiscordIdentityProvider.java

@ -17,9 +17,14 @@
package org.keycloak.social.discord;
import java.io.IOException;
import java.util.Set;
import java.util.stream.Stream;
import javax.ws.rs.core.Response;
import org.jboss.logging.Logger;
import org.keycloak.broker.oidc.AbstractOAuth2IdentityProvider;
import org.keycloak.broker.oidc.OAuth2IdentityProviderConfig;
import org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper;
import org.keycloak.broker.provider.BrokeredIdentityContext;
import org.keycloak.broker.provider.IdentityBrokerException;
@ -27,6 +32,8 @@ import org.keycloak.broker.provider.util.SimpleHttp;
import org.keycloak.broker.social.SocialIdentityProvider;
import org.keycloak.events.EventBuilder;
import org.keycloak.models.KeycloakSession;
import org.keycloak.services.ErrorPageException;
import org.keycloak.services.messages.Messages;
import org.keycloak.social.linkedin.LinkedInIdentityProvider;
import com.fasterxml.jackson.databind.JsonNode;
@ -34,17 +41,19 @@ import com.fasterxml.jackson.databind.JsonNode;
/**
* @author <a href="mailto:wadahiro@gmail.com">Hiroyuki Wada</a>
*/
public class DiscordIdentityProvider extends AbstractOAuth2IdentityProvider<OAuth2IdentityProviderConfig>
implements SocialIdentityProvider<OAuth2IdentityProviderConfig> {
public class DiscordIdentityProvider extends AbstractOAuth2IdentityProvider<DiscordIdentityProviderConfig>
implements SocialIdentityProvider<DiscordIdentityProviderConfig> {
private static final Logger log = Logger.getLogger(LinkedInIdentityProvider.class);
public static final String AUTH_URL = "https://discordapp.com/api/oauth2/authorize";
public static final String TOKEN_URL = "https://discordapp.com/api/oauth2/token";
public static final String PROFILE_URL = "https://discordapp.com/api/users/@me";
public static final String GROUP_URL = "https://discordapp.com/api/users/@me/guilds";
public static final String DEFAULT_SCOPE = "identify email";
public static final String GUILDS_SCOPE = "guilds";
public DiscordIdentityProvider(KeycloakSession session, OAuth2IdentityProviderConfig config) {
public DiscordIdentityProvider(KeycloakSession session, DiscordIdentityProviderConfig config) {
super(session, config);
config.setAuthorizationUrl(AUTH_URL);
config.setTokenUrl(TOKEN_URL);
@ -78,17 +87,43 @@ public class DiscordIdentityProvider extends AbstractOAuth2IdentityProvider<OAut
@Override
protected BrokeredIdentityContext doGetFederatedIdentity(String accessToken) {
log.debug("doGetFederatedIdentity()");
JsonNode profile = null;
try {
JsonNode profile = SimpleHttp.doGet(PROFILE_URL, session).header("Authorization", "Bearer " + accessToken).asJson();
return extractIdentityFromProfile(null, profile);
profile = SimpleHttp.doGet(PROFILE_URL, session).header("Authorization", "Bearer " + accessToken).asJson();
} catch (Exception e) {
throw new IdentityBrokerException("Could not obtain user profile from discord.", e);
}
if (getConfig().hasAllowedGuilds()) {
if (!isAllowedGuild(accessToken)) {
throw new ErrorPageException(session, Response.Status.FORBIDDEN, Messages.INVALID_REQUESTER);
}
}
return extractIdentityFromProfile(null, profile);
}
protected boolean isAllowedGuild(String accessToken) {
try {
JsonNode guilds = SimpleHttp.doGet(GROUP_URL, session).header("Authorization", "Bearer " + accessToken).asJson();
Set<String> allowedGuilds = getConfig().getAllowedGuildsAsSet();
for (JsonNode guild : guilds) {
String guildId = getJsonProperty(guild, "id");
if (allowedGuilds.contains(guildId)) {
return true;
}
}
return false;
} catch (Exception e) {
throw new IdentityBrokerException("Could not obtain guilds the current user is a member of from discord.", e);
}
}
@Override
protected String getDefaultScopes() {
return DEFAULT_SCOPE;
if (getConfig().hasAllowedGuilds()) {
return DEFAULT_SCOPE + " " + GUILDS_SCOPE;
} else {
return DEFAULT_SCOPE;
}
}
}

57
ejb/src/main/java/org/keycloak/social/discord/DiscordIdentityProviderConfig.java

@ -0,0 +1,57 @@
/*
* Copyright 2018 Red Hat, Inc. and/or its affiliates
* and other contributors as indicated by the @author tags.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.keycloak.social.discord;
import java.util.Arrays;
import java.util.Collections;
import java.util.Set;
import java.util.stream.Collectors;
import org.keycloak.broker.oidc.OAuth2IdentityProviderConfig;
import org.keycloak.models.IdentityProviderModel;
/**
* @author <a href="mailto:wadahiro@gmail.com">Hiroyuki Wada</a>
*/
public class DiscordIdentityProviderConfig extends OAuth2IdentityProviderConfig {
public DiscordIdentityProviderConfig(IdentityProviderModel model) {
super(model);
}
public String getAllowedGuilds() {
return getConfig().get("allowedGuilds");
}
public void setAllowedGuilds(String allowedGuilds) {
getConfig().put("allowedGuilds", allowedGuilds);
}
public boolean hasAllowedGuilds() {
String guilds = getConfig().get("allowedGuilds");
return guilds != null && !guilds.trim().isEmpty();
}
public Set<String> getAllowedGuildsAsSet() {
if (hasAllowedGuilds()) {
String guilds = getConfig().get("allowedGuilds");
return Arrays.stream(guilds.split(",")).map(x -> x.trim()).collect(Collectors.toSet());
}
return Collections.emptySet();
}
}

7
ejb/src/main/java/org/keycloak/social/discord/DiscordIdentityProviderFactory.java

@ -14,9 +14,9 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.keycloak.social.discord;
import org.keycloak.broker.oidc.OIDCIdentityProviderConfig;
import org.keycloak.broker.provider.AbstractIdentityProviderFactory;
import org.keycloak.broker.social.SocialIdentityProviderFactory;
import org.keycloak.models.IdentityProviderModel;
@ -25,7 +25,8 @@ import org.keycloak.models.KeycloakSession;
/**
* @author <a href="mailto:wadahiro@gmail.com">Hiroyuki Wada</a>
*/
public class DiscordIdentityProviderFactory extends AbstractIdentityProviderFactory<DiscordIdentityProvider> implements SocialIdentityProviderFactory<DiscordIdentityProvider> {
public class DiscordIdentityProviderFactory extends AbstractIdentityProviderFactory<DiscordIdentityProvider>
implements SocialIdentityProviderFactory<DiscordIdentityProvider> {
public static final String PROVIDER_ID = "discord";
@ -36,7 +37,7 @@ public class DiscordIdentityProviderFactory extends AbstractIdentityProviderFact
@Override
public DiscordIdentityProvider create(KeycloakSession session, IdentityProviderModel model) {
return new DiscordIdentityProvider(session, new OIDCIdentityProviderConfig(model));
return new DiscordIdentityProvider(session, new DiscordIdentityProviderConfig(model));
}
@Override

4
ejb/src/main/resources/theme/discord/admin/messages/admin-messages_en.properties

@ -1,5 +1,7 @@
discord-client-id=Client Id
discord-client-secret=Client Secret
discord-allowed-guilds=Guild Id(s) to allow federation
discord.client-id.tooltip=Client Id for the application you created in your discord developer portal.
discord.client-secret.tooltip=Client Secret for the application that you created in your discord developer portal.
discord.default-scopes.tooltip=The scopes to be sent when asking for authorization. See discord OAuth2 documentation for possible values. If you do not specify anything, scope defaults to 'identify email'.
discord.allowed-guilds.tooltip=If you want to allow federation for specific guild, enter the guild id. Please use a comma as a separator for multiple guilds.
discord.default-scopes.tooltip=The scopes to be sent when asking for authorization. See discord OAuth2 documentation for possible values. If you do not specify anything, scope defaults to 'identify email' In addition, plus 'guilds' if you enter guild id(s) to allow federation.

7
ejb/src/main/resources/theme/discord/admin/resources/partials/realm-identity-provider-discord-ext.html

@ -0,0 +1,7 @@
<div class="form-group clearfix">
<label class="col-md-2 control-label" for="allowdGuilds">{{:: 'discord-allowed-guilds' | translate}}</label>
<div class="col-md-6">
<input class="form-control" id="baseUrl" type="text" ng-model="identityProvider.config.allowedGuilds">
</div>
<kc-tooltip>{{:: 'discord.allowed-guilds.tooltip' | translate}}</kc-tooltip>
</div>

1
ejb/src/main/resources/theme/discord/admin/resources/partials/realm-identity-provider-discord.html

@ -32,6 +32,7 @@
</div>
<kc-tooltip>{{:: 'discord.client-secret.tooltip' | translate}}</kc-tooltip>
</div>
<div data-ng-include data-src="resourceUrl + '/partials/realm-identity-provider-' + identityProvider.providerId + '-ext.html'"></div>
<div class="form-group clearfix">
<label class="col-md-2 control-label" for="defaultScope">{{:: 'default-scopes' | translate}} </label>
<div class="col-md-6">

Loading…
Cancel
Save