The Unified and Autonomous Development Platform
feat: SSO support for Microsoft Entra ID (#1751)
Robin Shen57d00ede31fc
diff --git a/pom.xml b/pom.xmlindex e7e40dd45a..24995fa27c 100644--- a/pom.xml+++ b/pom.xml@@ -269,7 +269,7 @@<dependency><groupId>com.nimbusds</groupId><artifactId>oauth2-oidc-sdk</artifactId>- <version>9.35</version>+ <version>11.9.1</version></dependency><dependency><groupId>com.zaxxer</groupId>diff --git a/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java b/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.javaindex 14be01b253..1d82adfbeb 100644--- a/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java+++ b/server-core/src/main/java/io/onedev/server/data/migration/DataMigrator.java@@ -6220,6 +6220,19 @@ public class DataMigrator {valueElement.addElement("userSearchBases").addElement("string").setText(userSearchBaseElement.getText().trim());userSearchBaseElement.detach();}+ } else if (key.equals("SSO_CONNECTORS")) {+ Element valueElement = element.element("value");+ if (valueElement != null) {+ for (var connectorElement: valueElement.elements()) {+ if (connectorElement.getName().contains("OpenIdConnector")) {+ var requestScopes = "openid email profile";+ var groupsClaim = connectorElement.elementText("groupsClaim");+ if (groupsClaim != null)+ requestScopes += " " + groupsClaim;+ connectorElement.addElement("requestScopes").setText(requestScopes);+ }+ }+ }}}dom.writeToFile(file, false);diff --git a/server-core/src/main/java/io/onedev/server/model/support/administration/SecuritySetting.java b/server-core/src/main/java/io/onedev/server/model/support/administration/SecuritySetting.javaindex 6d55a9871b..54be755798 100644--- a/server-core/src/main/java/io/onedev/server/model/support/administration/SecuritySetting.java+++ b/server-core/src/main/java/io/onedev/server/model/support/administration/SecuritySetting.java@@ -99,7 +99,7 @@ public class SecuritySetting implements Serializable {this.enforce2FA = enforce2FA;}- @Editable(order=500, name="CORS Allowed Origins", placeholder = "Specify allowed CORS origin, hit ENTER to add more", description = "" ++ @Editable(order=500, name="CORS Allowed Origins", placeholder = "Input allowed CORS origin, hit ENTER to add", description = "" +"Optionally specify allowed <a href='https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS' target='_blank'>CORS</a> origins. " +"For a CORS simple or preflight request, if value of request header <code>Origin</code> is included here, " +"the response header <code>Access-Control-Allow-Origin</code> will be set to the same value")diff --git a/server-plugin/server-plugin-authenticator-ldap/src/main/java/io/onedev/server/plugin/authenticator/ldap/ActiveDirectoryAuthenticator.java b/server-plugin/server-plugin-authenticator-ldap/src/main/java/io/onedev/server/plugin/authenticator/ldap/ActiveDirectoryAuthenticator.javaindex 82a69c8b2c..f57f9a8458 100644--- a/server-plugin/server-plugin-authenticator-ldap/src/main/java/io/onedev/server/plugin/authenticator/ldap/ActiveDirectoryAuthenticator.java+++ b/server-plugin/server-plugin-authenticator-ldap/src/main/java/io/onedev/server/plugin/authenticator/ldap/ActiveDirectoryAuthenticator.java@@ -45,7 +45,7 @@ public class ActiveDirectoryAuthenticator extends LdapAuthenticator {super.setManagerDN(managerDN);}- @Editable(order=500, placeholder = "Input user search base. Hit ENTER to add more", description=+ @Editable(order=500, placeholder = "Input user search base. Hit ENTER to add", description="Specify base nodes for user search. For example: <i>cn=Users, dc=example, dc=com</i>")@Size(min=1, message = "At least one user search base should be specified")@Overridediff --git a/server-plugin/server-plugin-authenticator-ldap/src/main/java/io/onedev/server/plugin/authenticator/ldap/LdapAuthenticator.java b/server-plugin/server-plugin-authenticator-ldap/src/main/java/io/onedev/server/plugin/authenticator/ldap/LdapAuthenticator.javaindex 878e3ef42c..793085957a 100644--- a/server-plugin/server-plugin-authenticator-ldap/src/main/java/io/onedev/server/plugin/authenticator/ldap/LdapAuthenticator.java+++ b/server-plugin/server-plugin-authenticator-ldap/src/main/java/io/onedev/server/plugin/authenticator/ldap/LdapAuthenticator.java@@ -103,7 +103,7 @@ public class LdapAuthenticator extends Authenticator {this.managerPassword = managerPassword;}- @Editable(order=500, placeholder = "Input user search base. Hit ENTER to add more", description=+ @Editable(order=500, placeholder = "Input user search base. Hit ENTER to add", description="Specifies base nodes for user search. For example: <i>ou=users, dc=example, dc=com</i>")@Size(min=1, message = "At least one user search base should be specified")public List<String> getUserSearchBases() {diff --git a/server-plugin/server-plugin-mailservice-office365/src/main/java/io/onedev/server/plugin/mailservice/office365/Office365MailService.java b/server-plugin/server-plugin-mailservice-office365/src/main/java/io/onedev/server/plugin/mailservice/office365/Office365MailService.javaindex 3c8240c16b..64324286c4 100644--- a/server-plugin/server-plugin-mailservice-office365/src/main/java/io/onedev/server/plugin/mailservice/office365/Office365MailService.java+++ b/server-plugin/server-plugin-mailservice-office365/src/main/java/io/onedev/server/plugin/mailservice/office365/Office365MailService.java@@ -47,7 +47,7 @@ public class Office365MailService implements MailService {private transient MailPosition mailPosition;- @Editable(order=100, name="Application (client) ID", description="Specify application (tenant) ID of this OneDev instance registered in Azure AD")+ @Editable(order=100, name="Application (client) ID", description="Specify application (client) ID of the app registered in Entra ID")@NotEmptypublic String getClientId() {return clientId;@@ -57,7 +57,7 @@ public class Office365MailService implements MailService {this.clientId = clientId;}- @Editable(order=150, name="Directory (tenant) ID", description="Specify ID of the Azure AD this OneDev instance is registered in")+ @Editable(order=150, name="Directory (tenant) ID", description="Specify directory (tenant) ID of the app registered in Entra ID")@NotEmptypublic String getTenantId() {return tenantId;@@ -67,7 +67,7 @@ public class Office365MailService implements MailService {this.tenantId = tenantId;}- @Editable(order=200, description="Client secret of this OneDev instance registered in Azure AD")+ @Editable(order=200, description="Specify client secret of the app registered in Entra ID")@Password@NotEmptypublic String getClientSecret() {diff --git a/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/EntraIdConnector.java b/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/EntraIdConnector.javanew file mode 100644index 0000000000..fad3b73934--- /dev/null+++ b/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/EntraIdConnector.java@@ -0,0 +1,131 @@+package io.onedev.server.plugin.sso.openid;++import com.fasterxml.jackson.databind.ObjectMapper;+import com.nimbusds.oauth2.sdk.ParseException;+import com.nimbusds.oauth2.sdk.http.HTTPRequest;+import com.nimbusds.oauth2.sdk.http.HTTPResponse;+import com.nimbusds.oauth2.sdk.token.BearerAccessToken;+import io.onedev.commons.utils.StringUtils;+import io.onedev.server.OneDev;+import io.onedev.server.annotation.Editable;+import io.onedev.server.annotation.Password;+import net.minidev.json.JSONArray;+import net.minidev.json.JSONObject;+import org.apache.shiro.authc.AuthenticationException;+import org.apache.wicket.request.cycle.RequestCycle;+import org.apache.wicket.request.mapper.parameter.PageParameters;+import org.apache.wicket.request.resource.PackageResourceReference;+import org.apache.wicket.request.resource.ResourceReference;++import javax.validation.constraints.NotEmpty;+import javax.ws.rs.core.MediaType;+import java.io.IOException;+import java.net.URI;+import java.util.ArrayList;+import java.util.HashMap;+import java.util.List;+import java.util.Objects;++import static java.util.stream.Collectors.toList;++@Editable(name="Microsoft Entra ID", order=125)+public class EntraIdConnector extends OpenIdConnector {++ private static final long serialVersionUID = 1L;++ private String tenantId;++ public EntraIdConnector() {+ setName("EntraID");+ }++ @Editable(order=1000, name="Application (client) ID", description="Specify application (client) ID of the app registered in Entra ID")+ @NotEmpty+ public String getClientId() {+ return super.getClientId();+ }++ public void setClientId(String clientId) {+ this.setClientId(clientId);+ }++ @Editable(order=1050, name="Directory (tenant) ID", description="Specify directory (tenant) ID of the app registered in Entra ID")+ @NotEmpty+ public String getTenantId() {+ return tenantId;+ }++ public void setTenantId(String tenantId) {+ this.tenantId = tenantId;+ }++ @Editable(order=1100, description="Specify client secret of the app registered in Entra ID")+ @Password+ @NotEmpty+ public String getClientSecret() {+ return super.getClientSecret();+ }++ public void setClientSecret(String clientSecret) {+ super.setClientSecret(clientSecret);+ }++ @Override+ public String getConfigurationDiscoveryUrl() {+ return "https://login.microsoftonline.com/" + getTenantId() + "/v2.0/.well-known/openid-configuration";+ }++ @Override+ public String getRequestScopes() {+ return "openid email profile";+ }++ @Override+ public String getButtonImageUrl() {+ ResourceReference logo = new PackageResourceReference(GitHubConnector.class, "entraid.png");+ return RequestCycle.get().urlFor(logo, new PageParameters()).toString();+ }++ @Override+ protected List<String> convertGroups(BearerAccessToken accessToken, List<String> groups) {+ try {+ var httpRequest = new HTTPRequest(HTTPRequest.Method.GET,+ URI.create(String.format("https://graph.microsoft.com/v1.0/%s/groups", getTenantId())));+ httpRequest.setAccept(MediaType.APPLICATION_JSON);+ httpRequest.setAuthorization(accessToken.toAuthorizationHeader());+ var httpResponse = httpRequest.send();+ if (httpResponse.getStatusCode() == HTTPResponse.SC_OK) {+ var groupNames = new HashMap<String, String>();+ JSONObject json = httpResponse.getContentAsJSONObject();+ var jsonArray = (JSONArray) json.get("value");+ for (var jsonArrayElement: jsonArray) {+ var groupInfo = (JSONObject) jsonArrayElement;+ var groupId = groupInfo.getAsString("id");+ var groupName = groupInfo.getAsString("displayName");+ groupNames.put(groupId, groupName);+ }+ return groups.stream()+ .map(groupNames::get)+ .filter(Objects::nonNull)+ .collect(toList());+ } else {+ List<String> details = new ArrayList<>();+ var body = httpResponse.getBody();+ if (StringUtils.isNotBlank(body)) {+ try {+ var errorNode = OneDev.getInstance(ObjectMapper.class).readTree(body).get("error");+ details.add("code: " + errorNode.get("code").asText());+ details.add("message: " + errorNode.get("message").asText());+ } catch (Exception e) {+ details.add("response: " + body);+ }+ }+ details.add("http status code: " + httpResponse.getStatusCode());+ throw new AuthenticationException(StringUtils.join(details, ", "));+ }+ } catch (IOException | ParseException e) {+ throw new RuntimeException(e);+ }+ }++}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 d53390d2ac..59526045c1 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@@ -51,8 +51,8 @@ public class GitHubConnector extends OpenIdConnector {}@Override- protected String getBaseScope() {- return super.getBaseScope() + " user:email";+ public String getRequestScopes() {+ return "openid profile user:email";}@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 db2df9d114..0c513011f8 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@@ -18,13 +18,13 @@ import com.nimbusds.openid.connect.sdk.*;import io.onedev.commons.utils.ExceptionUtils;import io.onedev.commons.utils.StringUtils;import io.onedev.server.OneDev;+import io.onedev.server.annotation.Editable;+import io.onedev.server.annotation.Password;+import io.onedev.server.annotation.UrlSegment;import io.onedev.server.entitymanager.SettingManager;import io.onedev.server.model.support.administration.sso.SsoAuthenticated;import io.onedev.server.model.support.administration.sso.SsoConnector;import io.onedev.server.util.OAuthUtils;-import io.onedev.server.annotation.UrlSegment;-import io.onedev.server.annotation.Editable;-import io.onedev.server.annotation.Password;import io.onedev.server.web.page.admin.ssosetting.SsoProcessPage;import net.minidev.json.JSONArray;import net.minidev.json.JSONObject;@@ -32,6 +32,9 @@ import org.apache.shiro.authc.AuthenticationException;import org.apache.wicket.Session;import org.apache.wicket.request.cycle.RequestCycle;import org.apache.wicket.request.flow.RedirectToUrlException;+import org.apache.wicket.request.mapper.parameter.PageParameters;+import org.apache.wicket.request.resource.PackageResourceReference;+import org.apache.wicket.request.resource.ResourceReference;import org.joda.time.DateTime;import org.slf4j.Logger;import org.slf4j.LoggerFactory;@@ -57,15 +60,22 @@ public class OpenIdConnector extends SsoConnector {private static final String SESSION_ATTR_STATE = "state";+ private String configurationDiscoveryUrl;+private String clientId;private String clientSecret;- private String configurationDiscoveryUrl;+ private String requestScopes = "openid email profile";private String groupsClaim;- private String buttonImageUrl = "https://openid.net/images/logo/openid-icon-100x100.png";+ private String buttonImageUrl;++ public OpenIdConnector() {+ ResourceReference logo = new PackageResourceReference(OpenIdConnector.class, "openid.png");+ buttonImageUrl = RequestCycle.get().urlFor(logo, new PageParameters()).toString();+ }@Overridepublic boolean isManagingMemberships() {@@ -124,28 +134,7 @@ public class OpenIdConnector extends SsoConnector {public void setClientSecret(String clientSecret) {this.clientSecret = clientSecret;}-- @Editable(order=1500, description="Optionally specify the OpenID claim to retrieve groups "- + "of authenticated user")- public String getGroupsClaim() {- return groupsClaim;- }-- public void setGroupsClaim(String groupsClaim) {- this.groupsClaim = groupsClaim;- }-- @Editable(order=19100, description="Specify image on the login button")- @NotEmpty- @Override- public String getButtonImageUrl() {- return buttonImageUrl;- }-- public void setButtonImageUrl(String buttonImageUrl) {- this.buttonImageUrl = buttonImageUrl;- }-+@Overridepublic SsoAuthenticated processLoginResponse() {HttpServletRequest request = (HttpServletRequest) RequestCycle.get().getRequest().getContainerRequest();@@ -226,50 +215,75 @@ public class OpenIdConnector extends SsoConnector {throw new AuthenticationException("ID token was expired");String subject = claims.getSubject();+ String email = claims.getStringClaim("email");+ String userName = claims.getStringClaim("preferred_username");+ String fullName = claims.getStringClaim("name");+ List<String> groups;+ if (getGroupsClaim() != null) {+ var groupsArray = claims.getStringArrayClaim(getGroupsClaim());+ if (groupsArray != null)+ groups = List.of(groupsArray);+ else+ groups = null;+ } else {+ groups = null;+ }- BearerAccessToken accessToken = tokenResponse.getOIDCTokens().getBearerAccessToken();+ var accessToken = tokenResponse.getOIDCTokens().getBearerAccessToken();+ if (email == null || userName == null || fullName == null+ || getGroupsClaim() != null && groups == null) {- UserInfoRequest userInfoRequest = new UserInfoRequest(- new URI(getCachedProviderMetadata().getUserInfoEndpoint()), accessToken);- HTTPResponse httpResponse = userInfoRequest.toHTTPRequest().send();+ UserInfoRequest userInfoRequest = new UserInfoRequest(+ new URI(getCachedProviderMetadata().getUserInfoEndpoint()), accessToken);+ HTTPResponse httpResponse = userInfoRequest.toHTTPRequest().send();- if (httpResponse.getStatusCode() == HTTPResponse.SC_OK) {- JSONObject json = httpResponse.getContentAsJSONObject();- if (!subject.equals(json.get("sub")))- throw new AuthenticationException("OIDC error: Inconsistent sub in ID token and userinfo");-- String email = getStringValue(json.get("email"));- if (StringUtils.isBlank(email))- throw new AuthenticationException("OIDC error: No email claim returned");-- String userName = getStringValue(json.get("preferred_username"));- if (StringUtils.isBlank(userName))- userName = email;- userName = StringUtils.substringBefore(userName, "@");-- String fullName = getStringValue(json.get("name"));+ if (httpResponse.getStatusCode() == HTTPResponse.SC_OK) {+ JSONObject json = httpResponse.getContentAsJSONObject();+ if (!subject.equals(json.get("sub")))+ throw new AuthenticationException("OIDC error: Inconsistent sub in ID token and userinfo");++ if (email == null) {+ email = getStringValue(json.get("email"));+ if (email == null)+ throw new AuthenticationException("OIDC error: No email claim returned");+ }++ if (userName == null) {+ userName = getStringValue(json.get("preferred_username"));+ if (userName == null)+ userName = email;+ userName = StringUtils.substringBefore(userName, "@");+ }++ if (fullName == null)+ fullName = getStringValue(json.get("name"));- List<String> groupNames;- if (getGroupsClaim() != null) {- groupNames = new ArrayList<>();- JSONArray jsonArray = (JSONArray) json.get(getGroupsClaim());- if (jsonArray != null) {- for (Object group: jsonArray)- groupNames.add((String) group);+ if (getGroupsClaim() != null && groups == null) {+ var jsonArray = (JSONArray) json.get(getGroupsClaim());+ if (jsonArray != null) {+ groups = new ArrayList<>();+ for (Object group: jsonArray)+ groups.add((String) group);+ } else {+ logger.warn("No groups claim returned");+ }}} else {- groupNames = null;+ throw buildException(UserInfoErrorResponse.parse(httpResponse).getErrorObject());}-- return new SsoAuthenticated(userName, email, fullName, groupNames, null, this);- } else {- throw buildException(UserInfoErrorResponse.parse(httpResponse).getErrorObject());}+ if (groups != null)+ groups = convertGroups(accessToken, groups);+ return new SsoAuthenticated(userName, email, fullName, groups, null, this);} catch (Exception e) {throw ExceptionUtils.unchecked(e);}}+ protected List<String> convertGroups(BearerAccessToken accessToken, List<String> groups) {+ return groups;+ }+protected RuntimeException buildException(ErrorObject error) {return new AuthenticationException(OAuthUtils.getErrorMessage(error));}@@ -283,9 +297,7 @@ public class OpenIdConnector extends SsoConnector {Session.get().setAttribute(SESSION_ATTR_STATE, state.getValue());Session.get().setAttribute(SESSION_ATTR_PROVIDER_METADATA, discoverProviderMetadata());- String scopes = getBaseScope();- if (getGroupsClaim() != null)- scopes = scopes + " " + getGroupsClaim();+ String scopes = getRequestScopes();AuthenticationRequest request = new AuthenticationRequest(new URI(getCachedProviderMetadata().getAuthorizationEndpoint()),@@ -296,11 +308,39 @@ public class OpenIdConnector extends SsoConnector {throw new RuntimeException(e);}}++ @Editable(order=10000, group = "More Settings", description = "Specify OpenID scopes to request")+ @NotEmpty+ public String getRequestScopes() {+ return requestScopes;+ }++ public void setRequestScopes(String requestScopes) {+ this.requestScopes = requestScopes;+ }++ @Editable(order=10100, group = "More Settings", description="Optionally specify the OpenID claim to retrieve " ++ "groups of authenticated user. Depending on the provider, you may need to request additional scopes " ++ "above to make this claim available")+ public String getGroupsClaim() {+ return groupsClaim;+ }++ public void setGroupsClaim(String groupsClaim) {+ this.groupsClaim = groupsClaim;+ }- protected String getBaseScope() {- return "openid email profile";+ @Editable(order=10200, group="More Settings", description="Specify image on the login button")+ @NotEmpty+ @Override+ public String getButtonImageUrl() {+ return buttonImageUrl;}+ public void setButtonImageUrl(String buttonImageUrl) {+ this.buttonImageUrl = buttonImageUrl;+ }+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.javaindex c0793dd516..eb5f60adb0 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,9 @@ public class OpenIdModule extends AbstractPluginModule {@Overridepublic Collection<Class<?>> getImplementations() {- return Sets.newHashSet(GitHubConnector.class, OpenIdConnector.class, TwitchConnector.class);+ return Sets.newHashSet(+ GitHubConnector.class, EntraIdConnector.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.javaindex e710732f40..3b75151c39 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@@ -54,7 +54,7 @@ public class TwitchConnector extends OpenIdConnector {}@Override- protected String getBaseScope() {+ public String getRequestScopes() {return "openid user:read:email";}diff --git a/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/entraid.png b/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/entraid.pngnew file mode 100644index 0000000000..7358c45302Binary files /dev/null and b/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/entraid.png differdiff --git a/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/openid.png b/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/openid.pngnew file mode 100644index 0000000000..9c81c36d10Binary files /dev/null and b/server-plugin/server-plugin-sso-openid/src/main/java/io/onedev/server/plugin/sso/openid/openid.png differ