SbloodyS commented on code in PR #17340: URL: https://github.com/apache/dolphinscheduler/pull/17340#discussion_r2313348625
########## dolphinscheduler-api-test/dolphinscheduler-api-test-case/src/test/java/org/apache/dolphinscheduler/api/test/cases/OidcLoginAPITest.java: ########## @@ -0,0 +1,117 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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.apache.dolphinscheduler.api.test.cases; + +import org.apache.dolphinscheduler.api.test.core.DolphinScheduler; +import org.apache.dolphinscheduler.api.test.entity.HttpResponse; +import org.apache.dolphinscheduler.api.test.pages.OidcLoginPage; + +import java.util.List; +import java.util.Map; +import java.util.UUID; + +import lombok.extern.slf4j.Slf4j; + +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.Order; +import org.junit.jupiter.api.Test; + +@DolphinScheduler(composeFiles = "docker/oidc-login/docker-compose.yaml") Review Comment: Please add this to https://github.com/apache/dolphinscheduler/blob/bccb8ec6ab4212f1dd80b9cb2b2d4c520cc93729/.github/workflows/api-test.yml#L120-L121 ########## dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/security/impl/oidc/OidcAuthenticator.java: ########## @@ -0,0 +1,390 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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.apache.dolphinscheduler.api.security.impl.oidc; + +import org.apache.dolphinscheduler.api.enums.Status; +import org.apache.dolphinscheduler.api.exceptions.ServiceException; +import org.apache.dolphinscheduler.api.security.impl.AbstractSsoAuthenticator; +import org.apache.dolphinscheduler.api.service.UsersService; +import org.apache.dolphinscheduler.common.constants.Constants; +import org.apache.dolphinscheduler.common.enums.UserType; +import org.apache.dolphinscheduler.dao.entity.User; + +import java.net.URI; +import java.security.MessageDigest; +import java.util.Collections; +import java.util.Date; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; + +import javax.servlet.http.HttpServletRequest; + +import lombok.NonNull; +import lombok.extern.slf4j.Slf4j; + +import org.springframework.beans.factory.annotation.Value; +import org.springframework.stereotype.Component; +import org.springframework.web.context.request.RequestContextHolder; +import org.springframework.web.context.request.ServletRequestAttributes; + +import com.nimbusds.jwt.JWT; +import com.nimbusds.jwt.JWTClaimsSet; +import com.nimbusds.oauth2.sdk.AuthorizationCode; +import com.nimbusds.oauth2.sdk.AuthorizationCodeGrant; +import com.nimbusds.oauth2.sdk.ParseException; +import com.nimbusds.oauth2.sdk.ResponseType; +import com.nimbusds.oauth2.sdk.Scope; +import com.nimbusds.oauth2.sdk.TokenRequest; +import com.nimbusds.oauth2.sdk.TokenResponse; +import com.nimbusds.oauth2.sdk.auth.ClientAuthentication; +import com.nimbusds.oauth2.sdk.auth.ClientSecretBasic; +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.id.State; +import com.nimbusds.oauth2.sdk.token.AccessToken; +import com.nimbusds.openid.connect.sdk.AuthenticationRequest; +import com.nimbusds.openid.connect.sdk.Nonce; +import com.nimbusds.openid.connect.sdk.OIDCTokenResponse; +import com.nimbusds.openid.connect.sdk.OIDCTokenResponseParser; +import com.nimbusds.openid.connect.sdk.UserInfoRequest; +import com.nimbusds.openid.connect.sdk.UserInfoResponse; +import com.nimbusds.openid.connect.sdk.claims.IDTokenClaimsSet; +import com.nimbusds.openid.connect.sdk.claims.UserInfo; +import com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata; +import com.nimbusds.openid.connect.sdk.token.OIDCTokens; + +@Slf4j +@Component("oidcAuthenticator") +public class OidcAuthenticator extends AbstractSsoAuthenticator { + + private final OidcConfigProperties oidcConfig; + private final UsersService usersService; + + @Value("${api.base-url:http://localhost:12345/dolphinscheduler}";) + private String apiBaseUrl; Review Comment: There are multiple parameters like this, and we should merge them into one. ########## dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/security/impl/oidc/OidcAuthenticator.java: ########## @@ -0,0 +1,390 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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.apache.dolphinscheduler.api.security.impl.oidc; + +import org.apache.dolphinscheduler.api.enums.Status; +import org.apache.dolphinscheduler.api.exceptions.ServiceException; +import org.apache.dolphinscheduler.api.security.impl.AbstractSsoAuthenticator; +import org.apache.dolphinscheduler.api.service.UsersService; +import org.apache.dolphinscheduler.common.constants.Constants; +import org.apache.dolphinscheduler.common.enums.UserType; +import org.apache.dolphinscheduler.dao.entity.User; + +import java.net.URI; +import java.security.MessageDigest; +import java.util.Collections; +import java.util.Date; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; + +import javax.servlet.http.HttpServletRequest; + +import lombok.NonNull; +import lombok.extern.slf4j.Slf4j; + +import org.springframework.beans.factory.annotation.Value; +import org.springframework.stereotype.Component; +import org.springframework.web.context.request.RequestContextHolder; +import org.springframework.web.context.request.ServletRequestAttributes; + +import com.nimbusds.jwt.JWT; +import com.nimbusds.jwt.JWTClaimsSet; +import com.nimbusds.oauth2.sdk.AuthorizationCode; +import com.nimbusds.oauth2.sdk.AuthorizationCodeGrant; +import com.nimbusds.oauth2.sdk.ParseException; +import com.nimbusds.oauth2.sdk.ResponseType; +import com.nimbusds.oauth2.sdk.Scope; +import com.nimbusds.oauth2.sdk.TokenRequest; +import com.nimbusds.oauth2.sdk.TokenResponse; +import com.nimbusds.oauth2.sdk.auth.ClientAuthentication; +import com.nimbusds.oauth2.sdk.auth.ClientSecretBasic; +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.id.State; +import com.nimbusds.oauth2.sdk.token.AccessToken; +import com.nimbusds.openid.connect.sdk.AuthenticationRequest; +import com.nimbusds.openid.connect.sdk.Nonce; +import com.nimbusds.openid.connect.sdk.OIDCTokenResponse; +import com.nimbusds.openid.connect.sdk.OIDCTokenResponseParser; +import com.nimbusds.openid.connect.sdk.UserInfoRequest; +import com.nimbusds.openid.connect.sdk.UserInfoResponse; +import com.nimbusds.openid.connect.sdk.claims.IDTokenClaimsSet; +import com.nimbusds.openid.connect.sdk.claims.UserInfo; +import com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata; +import com.nimbusds.openid.connect.sdk.token.OIDCTokens; + +@Slf4j +@Component("oidcAuthenticator") +public class OidcAuthenticator extends AbstractSsoAuthenticator { + + private final OidcConfigProperties oidcConfig; + private final UsersService usersService; + + @Value("${api.base-url:http://localhost:12345/dolphinscheduler}";) + private String apiBaseUrl; + + private static final String SANITIZE_REGEX = "[\n\r\t]"; + private static final String EMAIL_ATTRIBUTE = "email"; + + private final Map<String, OIDCProviderMetadata> providerMetadataCache = new ConcurrentHashMap<>(); + + public OidcAuthenticator(OidcConfigProperties oidcConfig, UsersService usersService) { + this.oidcConfig = oidcConfig; + this.usersService = usersService; + } + + @Override + public User login(@NonNull String state, String code) { + + try { + ServletRequestAttributes servletRequestAttributes = + (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); + if (servletRequestAttributes == null) { + log.error("ServletRequestAttributes is null, cannot get session"); + return null; + } + + HttpServletRequest request = servletRequestAttributes.getRequest(); + String originalState = (String) request.getSession().getAttribute(Constants.SSO_LOGIN_USER_STATE); + request.getSession().removeAttribute(Constants.SSO_LOGIN_USER_STATE); + + if (originalState == null || !MessageDigest.isEqual(originalState.getBytes(), state.getBytes())) { + String sanitizedState = state.replaceAll(SANITIZE_REGEX, "_"); + log.error("State validation failed. Expected: {}, Actual: {}", originalState, sanitizedState); + return null; + } + + String[] stateParts = state.split(":", 2); Review Comment: Please using Constants instead. ########## dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/security/impl/oidc/OidcAuthenticator.java: ########## @@ -0,0 +1,390 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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.apache.dolphinscheduler.api.security.impl.oidc; + +import org.apache.dolphinscheduler.api.enums.Status; +import org.apache.dolphinscheduler.api.exceptions.ServiceException; +import org.apache.dolphinscheduler.api.security.impl.AbstractSsoAuthenticator; +import org.apache.dolphinscheduler.api.service.UsersService; +import org.apache.dolphinscheduler.common.constants.Constants; +import org.apache.dolphinscheduler.common.enums.UserType; +import org.apache.dolphinscheduler.dao.entity.User; + +import java.net.URI; +import java.security.MessageDigest; +import java.util.Collections; +import java.util.Date; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; + +import javax.servlet.http.HttpServletRequest; + +import lombok.NonNull; +import lombok.extern.slf4j.Slf4j; + +import org.springframework.beans.factory.annotation.Value; +import org.springframework.stereotype.Component; +import org.springframework.web.context.request.RequestContextHolder; +import org.springframework.web.context.request.ServletRequestAttributes; + +import com.nimbusds.jwt.JWT; +import com.nimbusds.jwt.JWTClaimsSet; +import com.nimbusds.oauth2.sdk.AuthorizationCode; +import com.nimbusds.oauth2.sdk.AuthorizationCodeGrant; +import com.nimbusds.oauth2.sdk.ParseException; +import com.nimbusds.oauth2.sdk.ResponseType; +import com.nimbusds.oauth2.sdk.Scope; +import com.nimbusds.oauth2.sdk.TokenRequest; +import com.nimbusds.oauth2.sdk.TokenResponse; +import com.nimbusds.oauth2.sdk.auth.ClientAuthentication; +import com.nimbusds.oauth2.sdk.auth.ClientSecretBasic; +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.id.State; +import com.nimbusds.oauth2.sdk.token.AccessToken; +import com.nimbusds.openid.connect.sdk.AuthenticationRequest; +import com.nimbusds.openid.connect.sdk.Nonce; +import com.nimbusds.openid.connect.sdk.OIDCTokenResponse; +import com.nimbusds.openid.connect.sdk.OIDCTokenResponseParser; +import com.nimbusds.openid.connect.sdk.UserInfoRequest; +import com.nimbusds.openid.connect.sdk.UserInfoResponse; +import com.nimbusds.openid.connect.sdk.claims.IDTokenClaimsSet; +import com.nimbusds.openid.connect.sdk.claims.UserInfo; +import com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata; +import com.nimbusds.openid.connect.sdk.token.OIDCTokens; + +@Slf4j +@Component("oidcAuthenticator") +public class OidcAuthenticator extends AbstractSsoAuthenticator { + + private final OidcConfigProperties oidcConfig; + private final UsersService usersService; + + @Value("${api.base-url:http://localhost:12345/dolphinscheduler}";) + private String apiBaseUrl; + + private static final String SANITIZE_REGEX = "[\n\r\t]"; + private static final String EMAIL_ATTRIBUTE = "email"; + + private final Map<String, OIDCProviderMetadata> providerMetadataCache = new ConcurrentHashMap<>(); + + public OidcAuthenticator(OidcConfigProperties oidcConfig, UsersService usersService) { + this.oidcConfig = oidcConfig; + this.usersService = usersService; + } + + @Override + public User login(@NonNull String state, String code) { + + try { + ServletRequestAttributes servletRequestAttributes = + (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); + if (servletRequestAttributes == null) { + log.error("ServletRequestAttributes is null, cannot get session"); + return null; + } + + HttpServletRequest request = servletRequestAttributes.getRequest(); + String originalState = (String) request.getSession().getAttribute(Constants.SSO_LOGIN_USER_STATE); + request.getSession().removeAttribute(Constants.SSO_LOGIN_USER_STATE); + + if (originalState == null || !MessageDigest.isEqual(originalState.getBytes(), state.getBytes())) { + String sanitizedState = state.replaceAll(SANITIZE_REGEX, "_"); + log.error("State validation failed. Expected: {}, Actual: {}", originalState, sanitizedState); + return null; + } + + String[] stateParts = state.split(":", 2); + if (stateParts.length != 2) { + String sanitizedState = state.replaceAll(SANITIZE_REGEX, "_"); Review Comment: Same here. ########## dolphinscheduler-api-test/dolphinscheduler-api-test-case/src/test/java/org/apache/dolphinscheduler/api/test/entity/HttpResponse.java: ########## @@ -29,4 +32,12 @@ public class HttpResponse { private int statusCode; private HttpResponseBody body; + + private Map<String, String> headers = new HashMap<>(); + + public HttpResponse(int statusCode, HttpResponseBody body) { + this.statusCode = statusCode; + this.body = body; + this.headers = new HashMap<>(); + } Review Comment: Why we need this sinice we already hava `@AllArgsConstructor` and `private Map<String, String> headers = new HashMap<>();` ########## dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/security/impl/oidc/OidcAuthenticator.java: ########## @@ -0,0 +1,390 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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.apache.dolphinscheduler.api.security.impl.oidc; + +import org.apache.dolphinscheduler.api.enums.Status; +import org.apache.dolphinscheduler.api.exceptions.ServiceException; +import org.apache.dolphinscheduler.api.security.impl.AbstractSsoAuthenticator; +import org.apache.dolphinscheduler.api.service.UsersService; +import org.apache.dolphinscheduler.common.constants.Constants; +import org.apache.dolphinscheduler.common.enums.UserType; +import org.apache.dolphinscheduler.dao.entity.User; + +import java.net.URI; +import java.security.MessageDigest; +import java.util.Collections; +import java.util.Date; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; + +import javax.servlet.http.HttpServletRequest; + +import lombok.NonNull; +import lombok.extern.slf4j.Slf4j; + +import org.springframework.beans.factory.annotation.Value; +import org.springframework.stereotype.Component; +import org.springframework.web.context.request.RequestContextHolder; +import org.springframework.web.context.request.ServletRequestAttributes; + +import com.nimbusds.jwt.JWT; +import com.nimbusds.jwt.JWTClaimsSet; +import com.nimbusds.oauth2.sdk.AuthorizationCode; +import com.nimbusds.oauth2.sdk.AuthorizationCodeGrant; +import com.nimbusds.oauth2.sdk.ParseException; +import com.nimbusds.oauth2.sdk.ResponseType; +import com.nimbusds.oauth2.sdk.Scope; +import com.nimbusds.oauth2.sdk.TokenRequest; +import com.nimbusds.oauth2.sdk.TokenResponse; +import com.nimbusds.oauth2.sdk.auth.ClientAuthentication; +import com.nimbusds.oauth2.sdk.auth.ClientSecretBasic; +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.id.State; +import com.nimbusds.oauth2.sdk.token.AccessToken; +import com.nimbusds.openid.connect.sdk.AuthenticationRequest; +import com.nimbusds.openid.connect.sdk.Nonce; +import com.nimbusds.openid.connect.sdk.OIDCTokenResponse; +import com.nimbusds.openid.connect.sdk.OIDCTokenResponseParser; +import com.nimbusds.openid.connect.sdk.UserInfoRequest; +import com.nimbusds.openid.connect.sdk.UserInfoResponse; +import com.nimbusds.openid.connect.sdk.claims.IDTokenClaimsSet; +import com.nimbusds.openid.connect.sdk.claims.UserInfo; +import com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata; +import com.nimbusds.openid.connect.sdk.token.OIDCTokens; + +@Slf4j +@Component("oidcAuthenticator") +public class OidcAuthenticator extends AbstractSsoAuthenticator { + + private final OidcConfigProperties oidcConfig; + private final UsersService usersService; + + @Value("${api.base-url:http://localhost:12345/dolphinscheduler}";) + private String apiBaseUrl; + + private static final String SANITIZE_REGEX = "[\n\r\t]"; + private static final String EMAIL_ATTRIBUTE = "email"; + + private final Map<String, OIDCProviderMetadata> providerMetadataCache = new ConcurrentHashMap<>(); + + public OidcAuthenticator(OidcConfigProperties oidcConfig, UsersService usersService) { + this.oidcConfig = oidcConfig; + this.usersService = usersService; + } + + @Override + public User login(@NonNull String state, String code) { + + try { + ServletRequestAttributes servletRequestAttributes = + (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); + if (servletRequestAttributes == null) { + log.error("ServletRequestAttributes is null, cannot get session"); + return null; + } + + HttpServletRequest request = servletRequestAttributes.getRequest(); + String originalState = (String) request.getSession().getAttribute(Constants.SSO_LOGIN_USER_STATE); + request.getSession().removeAttribute(Constants.SSO_LOGIN_USER_STATE); + + if (originalState == null || !MessageDigest.isEqual(originalState.getBytes(), state.getBytes())) { + String sanitizedState = state.replaceAll(SANITIZE_REGEX, "_"); + log.error("State validation failed. Expected: {}, Actual: {}", originalState, sanitizedState); + return null; + } + + String[] stateParts = state.split(":", 2); + if (stateParts.length != 2) { + String sanitizedState = state.replaceAll(SANITIZE_REGEX, "_"); + log.error("Invalid state format: {}", sanitizedState); + return null; + } + + String providerId = stateParts[0]; + OidcProviderConfig providerConfig = oidcConfig.getProviders().get(providerId); + if (providerConfig == null) { + String sanitizedProviderId = providerId.replaceAll(SANITIZE_REGEX, "_"); + log.error("Provider not found: {}", sanitizedProviderId); + return null; + } + + OIDCProviderMetadata providerMetadata = getProviderMetadata(providerId, providerConfig); + OIDCTokens tokens = exchangeCodeForTokens(providerMetadata, providerConfig, code, providerId); + IDTokenClaimsSet idTokenClaims = validateIdToken(providerMetadata, providerConfig, tokens.getIDToken()); + UserInfo userInfo = getUserInfo(providerMetadata, tokens.getAccessToken()); + + String username = extractUsername(providerConfig, idTokenClaims, userInfo); + String email = extractEmail(idTokenClaims, userInfo); + List<String> groups = extractGroups(providerConfig, idTokenClaims, userInfo); + + User user = usersService.getUserByUserName(username); + + if (user == null && oidcConfig.getUser().isAutoCreate()) { + UserType userType = determineUserType(groups); + user = usersService.createUser(userType, username, email); + } + + return user; + } catch (Exception e) { + log.error("An error occurred during OIDC authentication.", e); + return null; + } + } + + @Override + public String getSignInUrl(String state) { + + try { + String[] stateParts = state.split(":", 2); + String providerId = stateParts[0]; + OidcProviderConfig providerConfig = oidcConfig.getProviders().get(providerId); + + OIDCProviderMetadata providerMetadata = getProviderMetadata(providerId, providerConfig); + ClientID clientID = new ClientID(providerConfig.getClientId()); + URI redirectURI = new URI(getCallbackUrl(providerId)); + Scope scope = parseScope(providerConfig.getScope()); + State nimbusState = new State(state); + Nonce nonce = new Nonce(); + + AuthenticationRequest authRequest = new AuthenticationRequest.Builder( + new ResponseType(ResponseType.Value.CODE), + scope, + clientID, + redirectURI) + .state(nimbusState) + .nonce(nonce) + .endpointURI(providerMetadata.getAuthorizationEndpointURI()) + .build(); + + return authRequest.toURI().toString(); + } catch (Exception e) { + log.error("Error generating OIDC sign-in URL", e); Review Comment: ```suggestion log.error("Error generating OIDC sign-in URL: ", e); ``` ########## dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/security/impl/oidc/OidcAuthenticator.java: ########## @@ -0,0 +1,390 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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.apache.dolphinscheduler.api.security.impl.oidc; + +import org.apache.dolphinscheduler.api.enums.Status; +import org.apache.dolphinscheduler.api.exceptions.ServiceException; +import org.apache.dolphinscheduler.api.security.impl.AbstractSsoAuthenticator; +import org.apache.dolphinscheduler.api.service.UsersService; +import org.apache.dolphinscheduler.common.constants.Constants; +import org.apache.dolphinscheduler.common.enums.UserType; +import org.apache.dolphinscheduler.dao.entity.User; + +import java.net.URI; +import java.security.MessageDigest; +import java.util.Collections; +import java.util.Date; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; + +import javax.servlet.http.HttpServletRequest; + +import lombok.NonNull; +import lombok.extern.slf4j.Slf4j; + +import org.springframework.beans.factory.annotation.Value; +import org.springframework.stereotype.Component; +import org.springframework.web.context.request.RequestContextHolder; +import org.springframework.web.context.request.ServletRequestAttributes; + +import com.nimbusds.jwt.JWT; +import com.nimbusds.jwt.JWTClaimsSet; +import com.nimbusds.oauth2.sdk.AuthorizationCode; +import com.nimbusds.oauth2.sdk.AuthorizationCodeGrant; +import com.nimbusds.oauth2.sdk.ParseException; +import com.nimbusds.oauth2.sdk.ResponseType; +import com.nimbusds.oauth2.sdk.Scope; +import com.nimbusds.oauth2.sdk.TokenRequest; +import com.nimbusds.oauth2.sdk.TokenResponse; +import com.nimbusds.oauth2.sdk.auth.ClientAuthentication; +import com.nimbusds.oauth2.sdk.auth.ClientSecretBasic; +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.id.State; +import com.nimbusds.oauth2.sdk.token.AccessToken; +import com.nimbusds.openid.connect.sdk.AuthenticationRequest; +import com.nimbusds.openid.connect.sdk.Nonce; +import com.nimbusds.openid.connect.sdk.OIDCTokenResponse; +import com.nimbusds.openid.connect.sdk.OIDCTokenResponseParser; +import com.nimbusds.openid.connect.sdk.UserInfoRequest; +import com.nimbusds.openid.connect.sdk.UserInfoResponse; +import com.nimbusds.openid.connect.sdk.claims.IDTokenClaimsSet; +import com.nimbusds.openid.connect.sdk.claims.UserInfo; +import com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata; +import com.nimbusds.openid.connect.sdk.token.OIDCTokens; + +@Slf4j +@Component("oidcAuthenticator") +public class OidcAuthenticator extends AbstractSsoAuthenticator { + + private final OidcConfigProperties oidcConfig; + private final UsersService usersService; + + @Value("${api.base-url:http://localhost:12345/dolphinscheduler}";) + private String apiBaseUrl; + + private static final String SANITIZE_REGEX = "[\n\r\t]"; + private static final String EMAIL_ATTRIBUTE = "email"; + + private final Map<String, OIDCProviderMetadata> providerMetadataCache = new ConcurrentHashMap<>(); + + public OidcAuthenticator(OidcConfigProperties oidcConfig, UsersService usersService) { + this.oidcConfig = oidcConfig; + this.usersService = usersService; + } + + @Override + public User login(@NonNull String state, String code) { + + try { + ServletRequestAttributes servletRequestAttributes = + (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); + if (servletRequestAttributes == null) { + log.error("ServletRequestAttributes is null, cannot get session"); + return null; + } + + HttpServletRequest request = servletRequestAttributes.getRequest(); + String originalState = (String) request.getSession().getAttribute(Constants.SSO_LOGIN_USER_STATE); + request.getSession().removeAttribute(Constants.SSO_LOGIN_USER_STATE); + + if (originalState == null || !MessageDigest.isEqual(originalState.getBytes(), state.getBytes())) { + String sanitizedState = state.replaceAll(SANITIZE_REGEX, "_"); + log.error("State validation failed. Expected: {}, Actual: {}", originalState, sanitizedState); + return null; + } + + String[] stateParts = state.split(":", 2); + if (stateParts.length != 2) { + String sanitizedState = state.replaceAll(SANITIZE_REGEX, "_"); + log.error("Invalid state format: {}", sanitizedState); + return null; + } + + String providerId = stateParts[0]; + OidcProviderConfig providerConfig = oidcConfig.getProviders().get(providerId); + if (providerConfig == null) { + String sanitizedProviderId = providerId.replaceAll(SANITIZE_REGEX, "_"); Review Comment: Same here. ########## dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/controller/LoginController.java: ########## @@ -82,17 +88,27 @@ @Slf4j public class LoginController extends BaseController { - @Autowired - private SessionService sessionService; - - @Autowired - private Authenticator authenticator; + private final SessionService sessionService; + private final Authenticator authenticator; + private final OAuth2Configuration oAuth2Configuration; + private final OidcConfigProperties oidcConfigProperties; + private final UsersService usersService; Review Comment: Why change this? ########## dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/security/impl/oidc/OidcAuthenticator.java: ########## @@ -0,0 +1,390 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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.apache.dolphinscheduler.api.security.impl.oidc; + +import org.apache.dolphinscheduler.api.enums.Status; +import org.apache.dolphinscheduler.api.exceptions.ServiceException; +import org.apache.dolphinscheduler.api.security.impl.AbstractSsoAuthenticator; +import org.apache.dolphinscheduler.api.service.UsersService; +import org.apache.dolphinscheduler.common.constants.Constants; +import org.apache.dolphinscheduler.common.enums.UserType; +import org.apache.dolphinscheduler.dao.entity.User; + +import java.net.URI; +import java.security.MessageDigest; +import java.util.Collections; +import java.util.Date; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; + +import javax.servlet.http.HttpServletRequest; + +import lombok.NonNull; +import lombok.extern.slf4j.Slf4j; + +import org.springframework.beans.factory.annotation.Value; +import org.springframework.stereotype.Component; +import org.springframework.web.context.request.RequestContextHolder; +import org.springframework.web.context.request.ServletRequestAttributes; + +import com.nimbusds.jwt.JWT; +import com.nimbusds.jwt.JWTClaimsSet; +import com.nimbusds.oauth2.sdk.AuthorizationCode; +import com.nimbusds.oauth2.sdk.AuthorizationCodeGrant; +import com.nimbusds.oauth2.sdk.ParseException; +import com.nimbusds.oauth2.sdk.ResponseType; +import com.nimbusds.oauth2.sdk.Scope; +import com.nimbusds.oauth2.sdk.TokenRequest; +import com.nimbusds.oauth2.sdk.TokenResponse; +import com.nimbusds.oauth2.sdk.auth.ClientAuthentication; +import com.nimbusds.oauth2.sdk.auth.ClientSecretBasic; +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.id.State; +import com.nimbusds.oauth2.sdk.token.AccessToken; +import com.nimbusds.openid.connect.sdk.AuthenticationRequest; +import com.nimbusds.openid.connect.sdk.Nonce; +import com.nimbusds.openid.connect.sdk.OIDCTokenResponse; +import com.nimbusds.openid.connect.sdk.OIDCTokenResponseParser; +import com.nimbusds.openid.connect.sdk.UserInfoRequest; +import com.nimbusds.openid.connect.sdk.UserInfoResponse; +import com.nimbusds.openid.connect.sdk.claims.IDTokenClaimsSet; +import com.nimbusds.openid.connect.sdk.claims.UserInfo; +import com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata; +import com.nimbusds.openid.connect.sdk.token.OIDCTokens; + +@Slf4j +@Component("oidcAuthenticator") +public class OidcAuthenticator extends AbstractSsoAuthenticator { + + private final OidcConfigProperties oidcConfig; + private final UsersService usersService; + + @Value("${api.base-url:http://localhost:12345/dolphinscheduler}";) + private String apiBaseUrl; + + private static final String SANITIZE_REGEX = "[\n\r\t]"; + private static final String EMAIL_ATTRIBUTE = "email"; + + private final Map<String, OIDCProviderMetadata> providerMetadataCache = new ConcurrentHashMap<>(); + + public OidcAuthenticator(OidcConfigProperties oidcConfig, UsersService usersService) { + this.oidcConfig = oidcConfig; + this.usersService = usersService; + } + + @Override + public User login(@NonNull String state, String code) { + + try { + ServletRequestAttributes servletRequestAttributes = + (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); + if (servletRequestAttributes == null) { + log.error("ServletRequestAttributes is null, cannot get session"); + return null; + } + + HttpServletRequest request = servletRequestAttributes.getRequest(); + String originalState = (String) request.getSession().getAttribute(Constants.SSO_LOGIN_USER_STATE); + request.getSession().removeAttribute(Constants.SSO_LOGIN_USER_STATE); + + if (originalState == null || !MessageDigest.isEqual(originalState.getBytes(), state.getBytes())) { + String sanitizedState = state.replaceAll(SANITIZE_REGEX, "_"); + log.error("State validation failed. Expected: {}, Actual: {}", originalState, sanitizedState); + return null; + } + + String[] stateParts = state.split(":", 2); + if (stateParts.length != 2) { + String sanitizedState = state.replaceAll(SANITIZE_REGEX, "_"); + log.error("Invalid state format: {}", sanitizedState); + return null; + } + + String providerId = stateParts[0]; + OidcProviderConfig providerConfig = oidcConfig.getProviders().get(providerId); + if (providerConfig == null) { + String sanitizedProviderId = providerId.replaceAll(SANITIZE_REGEX, "_"); + log.error("Provider not found: {}", sanitizedProviderId); + return null; + } + + OIDCProviderMetadata providerMetadata = getProviderMetadata(providerId, providerConfig); + OIDCTokens tokens = exchangeCodeForTokens(providerMetadata, providerConfig, code, providerId); + IDTokenClaimsSet idTokenClaims = validateIdToken(providerMetadata, providerConfig, tokens.getIDToken()); + UserInfo userInfo = getUserInfo(providerMetadata, tokens.getAccessToken()); + + String username = extractUsername(providerConfig, idTokenClaims, userInfo); + String email = extractEmail(idTokenClaims, userInfo); + List<String> groups = extractGroups(providerConfig, idTokenClaims, userInfo); + + User user = usersService.getUserByUserName(username); + + if (user == null && oidcConfig.getUser().isAutoCreate()) { + UserType userType = determineUserType(groups); + user = usersService.createUser(userType, username, email); + } + + return user; + } catch (Exception e) { + log.error("An error occurred during OIDC authentication.", e); + return null; + } + } + + @Override + public String getSignInUrl(String state) { + + try { + String[] stateParts = state.split(":", 2); Review Comment: Same here. ########## dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/security/impl/oidc/OidcAuthenticator.java: ########## @@ -0,0 +1,390 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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.apache.dolphinscheduler.api.security.impl.oidc; + +import org.apache.dolphinscheduler.api.enums.Status; +import org.apache.dolphinscheduler.api.exceptions.ServiceException; +import org.apache.dolphinscheduler.api.security.impl.AbstractSsoAuthenticator; +import org.apache.dolphinscheduler.api.service.UsersService; +import org.apache.dolphinscheduler.common.constants.Constants; +import org.apache.dolphinscheduler.common.enums.UserType; +import org.apache.dolphinscheduler.dao.entity.User; + +import java.net.URI; +import java.security.MessageDigest; +import java.util.Collections; +import java.util.Date; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; + +import javax.servlet.http.HttpServletRequest; + +import lombok.NonNull; +import lombok.extern.slf4j.Slf4j; + +import org.springframework.beans.factory.annotation.Value; +import org.springframework.stereotype.Component; +import org.springframework.web.context.request.RequestContextHolder; +import org.springframework.web.context.request.ServletRequestAttributes; + +import com.nimbusds.jwt.JWT; +import com.nimbusds.jwt.JWTClaimsSet; +import com.nimbusds.oauth2.sdk.AuthorizationCode; +import com.nimbusds.oauth2.sdk.AuthorizationCodeGrant; +import com.nimbusds.oauth2.sdk.ParseException; +import com.nimbusds.oauth2.sdk.ResponseType; +import com.nimbusds.oauth2.sdk.Scope; +import com.nimbusds.oauth2.sdk.TokenRequest; +import com.nimbusds.oauth2.sdk.TokenResponse; +import com.nimbusds.oauth2.sdk.auth.ClientAuthentication; +import com.nimbusds.oauth2.sdk.auth.ClientSecretBasic; +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.id.State; +import com.nimbusds.oauth2.sdk.token.AccessToken; +import com.nimbusds.openid.connect.sdk.AuthenticationRequest; +import com.nimbusds.openid.connect.sdk.Nonce; +import com.nimbusds.openid.connect.sdk.OIDCTokenResponse; +import com.nimbusds.openid.connect.sdk.OIDCTokenResponseParser; +import com.nimbusds.openid.connect.sdk.UserInfoRequest; +import com.nimbusds.openid.connect.sdk.UserInfoResponse; +import com.nimbusds.openid.connect.sdk.claims.IDTokenClaimsSet; +import com.nimbusds.openid.connect.sdk.claims.UserInfo; +import com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata; +import com.nimbusds.openid.connect.sdk.token.OIDCTokens; + +@Slf4j +@Component("oidcAuthenticator") +public class OidcAuthenticator extends AbstractSsoAuthenticator { + + private final OidcConfigProperties oidcConfig; + private final UsersService usersService; + + @Value("${api.base-url:http://localhost:12345/dolphinscheduler}";) + private String apiBaseUrl; + + private static final String SANITIZE_REGEX = "[\n\r\t]"; + private static final String EMAIL_ATTRIBUTE = "email"; + + private final Map<String, OIDCProviderMetadata> providerMetadataCache = new ConcurrentHashMap<>(); + + public OidcAuthenticator(OidcConfigProperties oidcConfig, UsersService usersService) { + this.oidcConfig = oidcConfig; + this.usersService = usersService; + } + + @Override + public User login(@NonNull String state, String code) { + + try { + ServletRequestAttributes servletRequestAttributes = + (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); + if (servletRequestAttributes == null) { + log.error("ServletRequestAttributes is null, cannot get session"); + return null; + } + + HttpServletRequest request = servletRequestAttributes.getRequest(); + String originalState = (String) request.getSession().getAttribute(Constants.SSO_LOGIN_USER_STATE); + request.getSession().removeAttribute(Constants.SSO_LOGIN_USER_STATE); + + if (originalState == null || !MessageDigest.isEqual(originalState.getBytes(), state.getBytes())) { + String sanitizedState = state.replaceAll(SANITIZE_REGEX, "_"); + log.error("State validation failed. Expected: {}, Actual: {}", originalState, sanitizedState); + return null; + } + + String[] stateParts = state.split(":", 2); + if (stateParts.length != 2) { + String sanitizedState = state.replaceAll(SANITIZE_REGEX, "_"); + log.error("Invalid state format: {}", sanitizedState); + return null; + } + + String providerId = stateParts[0]; + OidcProviderConfig providerConfig = oidcConfig.getProviders().get(providerId); + if (providerConfig == null) { + String sanitizedProviderId = providerId.replaceAll(SANITIZE_REGEX, "_"); + log.error("Provider not found: {}", sanitizedProviderId); + return null; + } + + OIDCProviderMetadata providerMetadata = getProviderMetadata(providerId, providerConfig); + OIDCTokens tokens = exchangeCodeForTokens(providerMetadata, providerConfig, code, providerId); + IDTokenClaimsSet idTokenClaims = validateIdToken(providerMetadata, providerConfig, tokens.getIDToken()); + UserInfo userInfo = getUserInfo(providerMetadata, tokens.getAccessToken()); + + String username = extractUsername(providerConfig, idTokenClaims, userInfo); + String email = extractEmail(idTokenClaims, userInfo); + List<String> groups = extractGroups(providerConfig, idTokenClaims, userInfo); + + User user = usersService.getUserByUserName(username); + + if (user == null && oidcConfig.getUser().isAutoCreate()) { + UserType userType = determineUserType(groups); + user = usersService.createUser(userType, username, email); + } + + return user; + } catch (Exception e) { + log.error("An error occurred during OIDC authentication.", e); Review Comment: ```suggestion log.error("An error occurred during OIDC authentication: ", e); ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
