libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases Packages Activity Actions

Improve error management in the github provider

Browse source 
Closes https://github.com/keycloak/keycloak/issues/9429
This commit is contained in:
rmartinc 2023-06-20 15:14:53 +02:00 committed by Pedro Igor
parent 165c36f9ff
commit 13870f3a69
2 changed files with 44 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
services/src/main/java/org/keycloak/social/github/GitHubIdentityProvider.java
View file

@ -18,7 +18,7 @@
package org.keycloak.social.github; package org.keycloak.social.github;
import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.ArrayNode; import jakarta.ws.rs.core.Response;
import java.util.Iterator; import java.util.Iterator;
import org.keycloak.broker.oidc.AbstractOAuth2IdentityProvider; import org.keycloak.broker.oidc.AbstractOAuth2IdentityProvider;
import org.keycloak.broker.oidc.OAuth2IdentityProviderConfig; import org.keycloak.broker.oidc.OAuth2IdentityProviderConfig;
@ -137,9 +137,18 @@ public class GitHubIdentityProvider extends AbstractOAuth2IdentityProvider imple
@Override @Override
protected BrokeredIdentityContext doGetFederatedIdentity(String accessToken) { protected BrokeredIdentityContext doGetFederatedIdentity(String accessToken) {
try { try (SimpleHttp.Response response = SimpleHttp.doGet(profileUrl, session)
JsonNode profile = SimpleHttp.doGet(profileUrl, session).header("Authorization", "Bearer " + accessToken).asJson(); .header("Authorization", "Bearer " + accessToken)
.header("Accept", "application/json")
.asResponse()) {
if (Response.Status.fromStatusCode(response.getStatus()).getFamily() != Response.Status.Family.SUCCESSFUL) {
logger.warnf("Profile endpoint returned an error (%d): %s", response.getStatus(), response.asString());
throw new IdentityBrokerException("Profile could not be retrieved from the github endpoint");
}
JsonNode profile = response.asJson();
logger.tracef("profile retrieved from github: %s", profile);
BrokeredIdentityContext user = extractIdentityFromProfile(null, profile); BrokeredIdentityContext user = extractIdentityFromProfile(null, profile);
if (user.getEmail() == null) { if (user.getEmail() == null) {
@ -148,25 +157,38 @@ public class GitHubIdentityProvider extends AbstractOAuth2IdentityProvider imple
return user; return user;
} catch (Exception e) { } catch (Exception e) {
throw new IdentityBrokerException("Could not obtain user profile from github.", e); throw new IdentityBrokerException("Profile could not be retrieved from the github endpoint", e);
} }
} }
private String searchEmail(String accessToken) { private String searchEmail(String accessToken) {
try { try (SimpleHttp.Response response = SimpleHttp.doGet(emailUrl, session)
ArrayNode emails = (ArrayNode) SimpleHttp.doGet(emailUrl, session).header("Authorization", "Bearer " + accessToken).asJson(); .header("Authorization", "Bearer " + accessToken)
.header("Accept", "application/json")
.asResponse()) {
if (Response.Status.fromStatusCode(response.getStatus()).getFamily() != Response.Status.Family.SUCCESSFUL) {
logger.warnf("Primary email endpoint returned an error (%d): %s", response.getStatus(), response.asString());
throw new IdentityBrokerException("Primary email could not be retrieved from the github endpoint");
}
JsonNode emails = response.asJson();
logger.tracef("emails retrieved from github: %s", emails);
if (emails.isArray()) {
Iterator<JsonNode> loop = emails.elements(); Iterator<JsonNode> loop = emails.elements();
while (loop.hasNext()) { while (loop.hasNext()) {
JsonNode mail = loop.next(); JsonNode mail = loop.next();
if (mail.get("primary").asBoolean()) { JsonNode primary = mail.get("primary");
if (primary != null && primary.asBoolean()) {
return getJsonProperty(mail, "email"); return getJsonProperty(mail, "email");
} }
} }
} catch (Exception e) {
throw new IdentityBrokerException("Could not obtain user email from github.", e);
} }
throw new IdentityBrokerException("Primary email from github is not found.");
throw new IdentityBrokerException("Primary email from github is not found in the user's email list.");
} catch (Exception e) {
throw new IdentityBrokerException("Primary email could not be retrieved from the github endpoint", e);
}
} }
@Override @Override

2
testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/broker/SocialLoginTest.java
View file

@ -29,6 +29,7 @@ import org.keycloak.representations.idm.authorization.DecisionStrategy;
import org.keycloak.services.resources.admin.permissions.AdminPermissionManagement; import org.keycloak.services.resources.admin.permissions.AdminPermissionManagement;
import org.keycloak.services.resources.admin.permissions.AdminPermissions; import org.keycloak.services.resources.admin.permissions.AdminPermissions;
import org.keycloak.testsuite.AbstractKeycloakTest; import org.keycloak.testsuite.AbstractKeycloakTest;
import org.keycloak.testsuite.arquillian.annotation.EnableFeature;
import org.keycloak.testsuite.arquillian.annotation.UncaughtServerErrorExpected; import org.keycloak.testsuite.arquillian.annotation.UncaughtServerErrorExpected;
import org.keycloak.testsuite.auth.page.login.UpdateAccount; import org.keycloak.testsuite.auth.page.login.UpdateAccount;
import org.keycloak.testsuite.pages.AppPage; import org.keycloak.testsuite.pages.AppPage;
@ -97,6 +98,7 @@ import com.google.common.collect.ImmutableMap;
* @author <a href="mailto:sthorger@redhat.com">Stian Thorgersen</a> * @author <a href="mailto:sthorger@redhat.com">Stian Thorgersen</a>
* @author Vaclav Muzikar <vmuzikar@redhat.com> * @author Vaclav Muzikar <vmuzikar@redhat.com>
*/ */
@EnableFeature(Profile.Feature.ADMIN_FINE_GRAINED_AUTHZ)
public class SocialLoginTest extends AbstractKeycloakTest { public class SocialLoginTest extends AbstractKeycloakTest {
public static final String SOCIAL_CONFIG = "social.config"; public static final String SOCIAL_CONFIG = "social.config";