Skip to content

The Unified and Autonomous Development Platform

feat: add Twitch as an authentication provider

knard09178eb8b973
diff --git a/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/OpenIdConnector.java b/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/OpenIdConnector.java
index 865f098b3c..b976646537 100644
--- a/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/OpenIdConnector.java
+++ b/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/OpenIdConnector.java
@@ -167,13 +167,14 @@ public class OpenIdConnector extends SsoConnector {
ClientID clientID = new ClientID(getClientId());
Secret clientSecret = new Secret(getClientSecret());
- ClientAuthentication clientAuth = new ClientSecretBasic(clientID, clientSecret);
+ ClientAuthentication clientAuth = createTokenRequestAuthentication(clientID, clientSecret);
TokenRequest tokenRequest = new TokenRequest(
new URI(getCachedProviderMetadata().getTokenEndpoint()), clientAuth, codeGrant);
HTTPRequest httpRequest = tokenRequest.toHTTPRequest();
httpRequest.setAccept(ContentType.APPLICATION_JSON.toString());
- TokenResponse tokenResponse = OIDCTokenResponseParser.parse(httpRequest.send());
+ HTTPResponse httpResponse = httpRequest.send();
+ TokenResponse tokenResponse = parseOIDCTokenResponse(httpResponse);
if (tokenResponse.indicatesSuccess())
return processTokenResponse((OIDCTokenResponse)tokenResponse.toSuccessResponse());
@@ -184,7 +185,15 @@ public class OpenIdConnector extends SsoConnector {
throw new RuntimeException(e);
}
}
-
+
+ protected TokenResponse parseOIDCTokenResponse(HTTPResponse response) throws ParseException {
+ return OIDCTokenResponseParser.parse(response);
+ }
+
+ protected ClientAuthentication createTokenRequestAuthentication(ClientID id, Secret secret) {
+ return new ClientSecretBasic(id, secret);
+ }
+
@Nullable
private String getStringValue(Object jsonValue) {
if (jsonValue instanceof String) {
@@ -274,7 +283,7 @@ public class OpenIdConnector extends SsoConnector {
Session.get().setAttribute(SESSION_ATTR_STATE, state.getValue());
Session.get().setAttribute(SESSION_ATTR_PROVIDER_METADATA, discoverProviderMetadata());
- String scopes = "openid email profile";
+ String scopes = getBaseScope();
if (getGroupsClaim() != null)
scopes = scopes + " " + getGroupsClaim();
@@ -288,6 +297,10 @@ public class OpenIdConnector extends SsoConnector {
}
}
+ protected String getBaseScope() {
+ return "openid email profile";
+ }
+
protected ProviderMetadata discoverProviderMetadata() {
try {
JsonNode json = OneDev.getInstance(ObjectMapper.class).readTree(
diff --git a/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/OpenIdModule.java b/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/OpenIdModule.java
index 518670eb59..c0793dd516 100644
--- a/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/OpenIdModule.java
+++ b/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/OpenIdModule.java
@@ -28,7 +28,7 @@ public class OpenIdModule extends AbstractPluginModule {
@Override
public Collection<Class<?>> getImplementations() {
- return Sets.newHashSet(GitHubConnector.class, OpenIdConnector.class);
+ return Sets.newHashSet(GitHubConnector.class, OpenIdConnector.class, TwitchConnector.class);
}
});
diff --git a/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/TwitchConnector.java b/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/TwitchConnector.java
new file mode 100644
index 0000000000..1a32e9b887
--- /dev/null
+++ b/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/TwitchConnector.java
@@ -0,0 +1,91 @@
+package io.onedev.server.plugin.sso.openid;
+
+import java.net.URLEncoder;
+import java.nio.charset.StandardCharsets;
+
+import com.nimbusds.oauth2.sdk.ParseException;
+import com.nimbusds.oauth2.sdk.Scope;
+import com.nimbusds.oauth2.sdk.TokenErrorResponse;
+import com.nimbusds.oauth2.sdk.TokenResponse;
+import com.nimbusds.oauth2.sdk.auth.ClientAuthentication;
+import com.nimbusds.oauth2.sdk.auth.ClientSecretPost;
+import com.nimbusds.oauth2.sdk.auth.Secret;
+import com.nimbusds.oauth2.sdk.http.HTTPResponse;
+import com.nimbusds.oauth2.sdk.id.ClientID;
+import com.nimbusds.oauth2.sdk.token.BearerAccessToken;
+import com.nimbusds.openid.connect.sdk.OIDCTokenResponse;
+import com.nimbusds.openid.connect.sdk.token.OIDCTokens;
+
+import io.onedev.server.annotation.Editable;
+import net.minidev.json.JSONArray;
+import net.minidev.json.JSONObject;
+
+@Editable(name="OpenID (Twitch)", order=200, description="")
+public class TwitchConnector extends OpenIdConnector {
+
+ private static final long serialVersionUID = 1L;
+
+ public TwitchConnector() {
+ setName("Twitch");
+ }
+
+ @Override
+ public String getConfigurationDiscoveryUrl() {
+ return super.getConfigurationDiscoveryUrl();
+ }
+
+ @Override
+ protected ProviderMetadata discoverProviderMetadata() {
+ return new ProviderMetadata(
+ "https://id.twitch.tv/oauth2",
+ "https://id.twitch.tv/oauth2/authorize?claims=" + URLEncoder.encode("{\"id_token\":{}, \"userinfo\":{\"email\": null,\"preferred_username\": null}}", StandardCharsets.UTF_8),
+ "https://id.twitch.tv/oauth2/token",
+ "https://id.twitch.tv/oauth2/userinfo");
+ }
+
+ @Override
+ public String getGroupsClaim() {
+ return super.getGroupsClaim();
+ }
+
+ @Override
+ public boolean isManagingMemberships() {
+ return false;
+ }
+
+ @Override
+ protected String getBaseScope() {
+ return "openid user:read:email";
+ }
+
+ @Override
+ protected ClientAuthentication createTokenRequestAuthentication(ClientID id, Secret secret) {
+ return new ClientSecretPost(id, secret);
+ }
+
+ @Override
+ protected TokenResponse parseOIDCTokenResponse(HTTPResponse response) throws ParseException {
+ JSONObject responseJson = response.getContentAsJSONObject();
+ if (response.getStatusCode() == HTTPResponse.SC_OK) {
+ Object scopeValue = responseJson.remove("scope");
+ Scope scope;
+ if (scopeValue instanceof JSONArray) {
+ JSONArray scopeArray = (JSONArray) scopeValue;
+ String[] scopeArrayString = scopeArray.stream().map(Object::toString).toArray(String[]::new);
+ scope = new Scope(scopeArrayString);
+ } else if(scopeValue instanceof String) {
+ String scopeString = (String) scopeValue;
+ scope = new Scope(scopeString);
+ } else {
+ scope = new Scope();
+ }
+ OIDCTokenResponse token = OIDCTokenResponse.parse(responseJson);
+ OIDCTokens oidcTokens = token.getOIDCTokens();
+ BearerAccessToken accessToken = oidcTokens.getBearerAccessToken();
+ BearerAccessToken fixedBearerToken = new BearerAccessToken(accessToken.getValue(), accessToken.getLifetime(), scope, accessToken.getIssuedTokenType());
+ return new OIDCTokenResponse(new OIDCTokens(oidcTokens.getIDToken(), fixedBearerToken, oidcTokens.getRefreshToken()), token.getCustomParameters());
+ } else {
+ return TokenErrorResponse.parse(responseJson);
+ }
+ }
+}