The Unified and Autonomous Development Platform
feat(sso): add OpenID sign-out flow
Chief Work Horse2439dee4018e
diff --git a/server-core/src/main/java/io/onedev/server/model/support/administration/sso/SsoConnector.java b/server-core/src/main/java/io/onedev/server/model/support/administration/sso/SsoConnector.javaindex 607e44923d..f37c526128 100644--- a/server-core/src/main/java/io/onedev/server/model/support/administration/sso/SsoConnector.java+++ b/server-core/src/main/java/io/onedev/server/model/support/administration/sso/SsoConnector.java@@ -8,6 +8,7 @@ import io.onedev.server.OneDev;import io.onedev.server.annotation.Editable;import io.onedev.server.service.SettingService;import io.onedev.server.web.page.security.SsoProcessPage;+import org.jspecify.annotations.Nullable;@Editablepublic abstract class SsoConnector implements Serializable {@@ -30,4 +31,9 @@ public abstract class SsoConnector implements Serializable {public abstract String buildAuthUrl(String providerName);+ @Nullable+ public String buildLogoutUrl(String providerName) {+ return null;+ }+}diff --git a/server-core/src/main/java/io/onedev/server/web/WebSession.java b/server-core/src/main/java/io/onedev/server/web/WebSession.javaindex 37767dbd7a..bef268cf28 100644--- a/server-core/src/main/java/io/onedev/server/web/WebSession.java+++ b/server-core/src/main/java/io/onedev/server/web/WebSession.java@@ -40,6 +40,8 @@ public class WebSession extends org.apache.wicket.protocol.http.WebSession {private volatile Map<Long, Chat> anonymousChats = new ConcurrentHashMap<>();private volatile String chatInput;++ private volatile String ssoLogoutUrl;public WebSession(Request request) {super(request);@@ -68,8 +70,18 @@ public class WebSession extends org.apache.wicket.protocol.http.WebSession {activeChatId = null;anonymousChats.clear();chatInput = null;+ ssoLogoutUrl = null;}+ @Nullable+ public String getSsoLogoutUrl() {+ return ssoLogoutUrl;+ }++ public void setSsoLogoutUrl(@Nullable String ssoLogoutUrl) {+ this.ssoLogoutUrl = ssoLogoutUrl;+ }+@Nullablepublic Cursor getIssueCursor() {return issueCursor;diff --git a/server-core/src/main/java/io/onedev/server/web/page/security/LogoutPage.java b/server-core/src/main/java/io/onedev/server/web/page/security/LogoutPage.javaindex 84446e2880..ee9b86dc15 100644--- a/server-core/src/main/java/io/onedev/server/web/page/security/LogoutPage.java+++ b/server-core/src/main/java/io/onedev/server/web/page/security/LogoutPage.java@@ -7,15 +7,20 @@ import static io.onedev.server.web.translation.Translation._T;import org.apache.wicket.RestartResponseException;import org.apache.wicket.request.mapper.parameter.PageParameters;+import org.apache.wicket.request.flow.RedirectToUrlException;public class LogoutPage extends BasePage {public LogoutPage(PageParameters params) {super(params);var session = WebSession.get();+ var ssoLogoutUrl = session.getSsoLogoutUrl();session.logout();session.warn(_T("You've been logged out"));- throw new RestartResponseException(getApplication().getHomePage());+ if (ssoLogoutUrl != null)+ throw new RedirectToUrlException(ssoLogoutUrl);+ else+ throw new RestartResponseException(getApplication().getHomePage());}}diff --git a/server-core/src/main/java/io/onedev/server/web/page/security/SsoProcessPage.java b/server-core/src/main/java/io/onedev/server/web/page/security/SsoProcessPage.javaindex 34a304ec03..d36d0ebe99 100644--- a/server-core/src/main/java/io/onedev/server/web/page/security/SsoProcessPage.java+++ b/server-core/src/main/java/io/onedev/server/web/page/security/SsoProcessPage.java@@ -51,6 +51,7 @@ import io.onedev.server.service.SsoProviderService;import io.onedev.server.service.UserService;import io.onedev.server.util.Path;import io.onedev.server.util.PathNode;+import io.onedev.server.web.WebSession;import io.onedev.server.web.component.tabbable.ActionTab;import io.onedev.server.web.component.tabbable.Tab;import io.onedev.server.web.component.tabbable.Tabbable;@@ -232,6 +233,8 @@ public class SsoProcessPage extends SimplePage {throw new AuthenticationException(_T("Unsolicited OIDC authentication response"));SecurityUtils.getSubject().runAs(user.getPrincipals());+ WebSession.get().setSsoLogoutUrl(+ getProvider().getConnector().buildLogoutUrl(getProvider().getName()));throw new RedirectToUrlException(redirectUrlAfterLogin);}diff --git a/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/GitHubConnector.java b/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/GitHubConnector.javaindex 4eb99bc82c..dee6265dc3 100644--- a/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/GitHubConnector.java+++ b/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/GitHubConnector.java@@ -34,7 +34,8 @@ public class GitHubConnector extends OpenIdConnector {"https://github.com","https://github.com/login/oauth/authorize","https://github.com/login/oauth/access_token",- "https://api.github.com/user");+ "https://api.github.com/user",+ null);}@Overridediff --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.javaindex d21f3c5808..4caf03efd7 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@@ -14,6 +14,7 @@ import javax.servlet.http.HttpServletRequest;import javax.validation.constraints.NotEmpty;import org.apache.shiro.authc.AuthenticationException;+import org.apache.http.client.utils.URIBuilder;import org.apache.wicket.Session;import org.apache.wicket.request.cycle.RequestCycle;import org.joda.time.DateTime;@@ -61,6 +62,7 @@ import io.onedev.server.annotation.Password;import io.onedev.server.model.support.administration.sso.SsoAuthenticated;import io.onedev.server.model.support.administration.sso.SsoConnector;import io.onedev.server.security.TrustCertsSSLSocketFactory;+import io.onedev.server.service.SettingService;import io.onedev.server.util.oauth.OAuthUtils;import net.minidev.json.JSONArray;import net.minidev.json.JSONObject;@@ -75,6 +77,8 @@ public class OpenIdConnector extends SsoConnector {private static final String SESSION_ATTR_PROVIDER_METADATA = "endpoints";private static final String SESSION_ATTR_STATE = "state";++ private static final String SESSION_ATTR_ID_TOKEN = "idToken";private String configurationDiscoveryUrl;@@ -87,6 +91,8 @@ public class OpenIdConnector extends SsoConnector {private String groupsClaim;private String buttonImageUrl;++ private boolean useOpenIdLogout;public OpenIdConnector() {buttonImageUrl = "/wicket/resource/" + OpenIdConnector.class.getName() + "/openid.png";@@ -210,6 +216,7 @@ public class OpenIdConnector extends SsoConnector {protected SsoAuthenticated processTokenResponse(OIDCTokenResponse tokenResponse) {try {JWT idToken = tokenResponse.getOIDCTokens().getIDToken();+ Session.get().setAttribute(SESSION_ATTR_ID_TOKEN, idToken.serialize());JWTClaimsSet claims = idToken.getJWTClaimsSet();if (!claims.getIssuer().equals(getCachedProviderMetadata().getIssuer()))@@ -358,16 +365,48 @@ public class OpenIdConnector extends SsoConnector {public void setButtonImageUrl(String buttonImageUrl) {this.buttonImageUrl = buttonImageUrl;}++ @Editable(name="Use OpenID Sign Out", order=10300, group="More Settings", description="Check to sign out from OpenID provider when logging out of OneDev. The provider discovery metadata must advertise an end session endpoint")+ public boolean isUseOpenIdLogout() {+ return useOpenIdLogout;+ }++ public void setUseOpenIdLogout(boolean useOpenIdLogout) {+ this.useOpenIdLogout = useOpenIdLogout;+ }++ @Override+ public String buildLogoutUrl(String providerName) {+ if (isUseOpenIdLogout()) {+ var metadata = getCachedProviderMetadata();+ var idToken = (String) Session.get().getAttribute(SESSION_ATTR_ID_TOKEN);+ if (metadata.getEndSessionEndpoint() != null && idToken != null) {+ try {+ var serverUrl = OneDev.getInstance(SettingService.class)+ .getSystemSetting().getServerUrl();+ return new URIBuilder(metadata.getEndSessionEndpoint())+ .addParameter("id_token_hint", idToken)+ .addParameter("post_logout_redirect_uri", serverUrl)+ .build().toString();+ } catch (URISyntaxException e) {+ throw new RuntimeException(e);+ }+ }+ }+ return null;+ }protected ProviderMetadata discoverProviderMetadata() {try {JsonNode json = OneDev.getInstance(ObjectMapper.class).readTree(new URI(getConfigurationDiscoveryUrl()).toURL());+ var endSessionEndpointNode = json.get("end_session_endpoint");return new ProviderMetadata(json.get("issuer").asText(),json.get("authorization_endpoint").asText(),json.get("token_endpoint").asText(),- json.get("userinfo_endpoint").asText());+ json.get("userinfo_endpoint").asText(),+ endSessionEndpointNode != null ? endSessionEndpointNode.asText() : null);} catch (IOException | URISyntaxException e) {if (e.getMessage() != null) {logger.error(_T("Error discovering OIDC metadata"), e);diff --git a/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/ProviderMetadata.java b/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/ProviderMetadata.javaindex 00bf6001ef..081f0cf4c5 100644--- a/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/ProviderMetadata.java+++ b/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/ProviderMetadata.java@@ -2,6 +2,8 @@ package io.onedev.server.plugin.sso.openid;import java.io.Serializable;+import org.jspecify.annotations.Nullable;+public class ProviderMetadata implements Serializable {private static final long serialVersionUID = 1L;@@ -13,13 +15,17 @@ public class ProviderMetadata implements Serializable {private final String tokenEndpoint;private final String userInfoEndpoint;++ @Nullable+ private final String endSessionEndpoint;public ProviderMetadata(String issuer, String authorizationEndpoint,- String tokenEndpoint, String userInfoEndpoint) {+ String tokenEndpoint, String userInfoEndpoint, @Nullable String endSessionEndpoint) {this.issuer = issuer;this.authorizationEndpoint = authorizationEndpoint;this.tokenEndpoint = tokenEndpoint;this.userInfoEndpoint = userInfoEndpoint;+ this.endSessionEndpoint = endSessionEndpoint;}public String getIssuer() {@@ -37,5 +43,10 @@ public class ProviderMetadata implements Serializable {public String getUserInfoEndpoint() {return userInfoEndpoint;}++ @Nullable+ public String getEndSessionEndpoint() {+ return endSessionEndpoint;+ }-}\ No newline at end of file+}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.javaindex ea88c4a619..6b59ef29e1 100644--- 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@@ -35,7 +35,8 @@ public class TwitchConnector extends OpenIdConnector {"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");+ "https://id.twitch.tv/oauth2/userinfo",+ null);}@Override