Browse Source

Moved OAuth2 config to separate table in DB

pull/3557/head
vzikratyi 6 years ago
parent
commit
61a6fdbc03
  1. 53
      application/src/main/data/upgrade/3.1.0/schema_update.sql
  2. 35
      application/src/main/java/org/thingsboard/server/controller/BaseController.java
  3. 67
      application/src/main/java/org/thingsboard/server/controller/OAuth2Controller.java
  4. 3
      application/src/main/java/org/thingsboard/server/install/ThingsboardInstallService.java
  5. 9
      application/src/main/java/org/thingsboard/server/service/install/SqlDatabaseUpgradeService.java
  6. 6
      application/src/main/java/org/thingsboard/server/service/security/auth/oauth2/Oauth2AuthenticationSuccessHandler.java
  7. 2
      application/src/main/java/org/thingsboard/server/service/security/permission/Resource.java
  8. 8
      application/src/main/java/org/thingsboard/server/service/security/permission/TenantAdminPermissions.java
  9. 29
      common/dao-api/src/main/java/org/thingsboard/server/dao/oauth2/OAuth2Service.java
  10. 2
      common/data/src/main/java/org/thingsboard/server/common/data/EntityType.java
  11. 2
      common/data/src/main/java/org/thingsboard/server/common/data/id/EntityIdFactory.java
  12. 16
      common/data/src/main/java/org/thingsboard/server/common/data/id/OAuth2ClientRegistrationId.java
  13. 19
      common/data/src/main/java/org/thingsboard/server/common/data/oauth2/OAuth2ClientInfo.java
  14. 41
      common/data/src/main/java/org/thingsboard/server/common/data/oauth2/OAuth2ClientRegistration.java
  15. 2
      common/data/src/main/java/org/thingsboard/server/common/data/oauth2/OAuth2ClientsParams.java
  16. 6
      dao/src/main/java/org/thingsboard/server/dao/model/ModelConstants.java
  17. 204
      dao/src/main/java/org/thingsboard/server/dao/model/sql/OAuth2ClientRegistrationEntity.java
  18. 10
      dao/src/main/java/org/thingsboard/server/dao/oauth2/HybridClientRegistrationRepository.java
  19. 36
      dao/src/main/java/org/thingsboard/server/dao/oauth2/OAuth2ClientRegistrationDao.java
  20. 644
      dao/src/main/java/org/thingsboard/server/dao/oauth2/OAuth2ServiceImpl.java
  21. 18
      dao/src/main/java/org/thingsboard/server/dao/oauth2/OAuth2Utils.java
  22. 86
      dao/src/main/java/org/thingsboard/server/dao/sql/oauth2/JpaOAuth2ClientRegistrationDao.java
  23. 37
      dao/src/main/java/org/thingsboard/server/dao/sql/oauth2/OAuth2ClientRegistrationRepository.java
  24. 2
      dao/src/main/java/org/thingsboard/server/dao/tenant/TenantServiceImpl.java
  25. 37
      dao/src/main/resources/sql/schema-entities-hsql.sql
  26. 36
      dao/src/main/resources/sql/schema-entities.sql
  27. 471
      dao/src/test/java/org/thingsboard/server/dao/service/BaseOAuth2ServiceTest.java
  28. 1
      dao/src/test/resources/sql/hsql/drop-all-tables.sql
  29. 1
      dao/src/test/resources/sql/psql/drop-all-tables.sql
  30. 1
      dao/src/test/resources/sql/timescale/drop-all-tables.sql

53
application/src/main/data/upgrade/3.1.0/schema_update.sql

@ -0,0 +1,53 @@
--
-- Copyright © 2016-2020 The Thingsboard Authors
--
-- Licensed 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.
--
DROP TABLE IF EXISTS oauth2_client_registration;
CREATE TABLE IF NOT EXISTS oauth2_client_registration (
id uuid NOT NULL CONSTRAINT oauth2_client_registration_pkey PRIMARY KEY,
created_time bigint NOT NULL,
additional_info varchar,
tenant_id uuid,
registration_id varchar(255),
domain_name varchar(255),
client_id varchar(255),
client_secret varchar(255),
authorization_uri varchar(255),
token_uri varchar(255),
redirect_uri_template varchar(255),
scope varchar(255),
user_info_uri varchar(255),
user_name_attribute_name varchar(255),
jwk_set_uri varchar(255),
client_authentication_method varchar(255),
login_button_label varchar(255),
login_button_icon varchar(255),
allow_user_creation boolean,
activate_user boolean,
type varchar(31),
basic_email_attribute_key varchar(31),
basic_first_name_attribute_key varchar(31),
basic_last_name_attribute_key varchar(31),
basic_tenant_name_strategy varchar(31),
basic_tenant_name_pattern varchar(255),
basic_customer_name_pattern varchar(255),
basic_default_dashboard_name varchar(255),
basic_always_full_screen boolean,
custom_url varchar(255),
custom_username varchar(255),
custom_password varchar(255),
CONSTRAINT oauth2_registration_id_unq_key UNIQUE (registration_id)
);

35
application/src/main/java/org/thingsboard/server/controller/BaseController.java

@ -47,22 +47,10 @@ import org.thingsboard.server.common.data.asset.AssetInfo;
import org.thingsboard.server.common.data.audit.ActionType;
import org.thingsboard.server.common.data.exception.ThingsboardErrorCode;
import org.thingsboard.server.common.data.exception.ThingsboardException;
import org.thingsboard.server.common.data.id.AlarmId;
import org.thingsboard.server.common.data.id.AssetId;
import org.thingsboard.server.common.data.id.CustomerId;
import org.thingsboard.server.common.data.id.DashboardId;
import org.thingsboard.server.common.data.id.DeviceId;
import org.thingsboard.server.common.data.id.EntityId;
import org.thingsboard.server.common.data.id.EntityIdFactory;
import org.thingsboard.server.common.data.id.EntityViewId;
import org.thingsboard.server.common.data.id.RuleChainId;
import org.thingsboard.server.common.data.id.RuleNodeId;
import org.thingsboard.server.common.data.id.TenantId;
import org.thingsboard.server.common.data.id.UserId;
import org.thingsboard.server.common.data.id.WidgetTypeId;
import org.thingsboard.server.common.data.id.WidgetsBundleId;
import org.thingsboard.server.common.data.id.*;
import org.thingsboard.server.common.data.kv.AttributeKvEntry;
import org.thingsboard.server.common.data.kv.DataType;
import org.thingsboard.server.common.data.oauth2.OAuth2ClientRegistration;
import org.thingsboard.server.common.data.page.PageLink;
import org.thingsboard.server.common.data.page.SortOrder;
import org.thingsboard.server.common.data.page.TimePageLink;
@ -87,6 +75,7 @@ import org.thingsboard.server.dao.entityview.EntityViewService;
import org.thingsboard.server.dao.exception.DataValidationException;
import org.thingsboard.server.dao.exception.IncorrectParameterException;
import org.thingsboard.server.dao.model.ModelConstants;
import org.thingsboard.server.dao.oauth2.OAuth2Service;
import org.thingsboard.server.dao.relation.RelationService;
import org.thingsboard.server.dao.rule.RuleChainService;
import org.thingsboard.server.dao.tenant.TenantService;
@ -161,6 +150,9 @@ public abstract class BaseController {
@Autowired
protected DashboardService dashboardService;
@Autowired
protected OAuth2Service oAuth2Service;
@Autowired
protected ComponentDiscoveryService componentDescriptorService;
@ -390,6 +382,9 @@ public abstract class BaseController {
case WIDGET_TYPE:
checkWidgetTypeId(new WidgetTypeId(entityId.getId()), operation);
return;
case OAUTH2_CLIENT_REGISTRATION:
checkOAuth2ClientRegistrationId(new OAuth2ClientRegistrationId(entityId.getId()), operation);
return;
default:
throw new IllegalArgumentException("Unsupported entity type: " + entityId.getEntityType());
}
@ -542,6 +537,18 @@ public abstract class BaseController {
}
}
OAuth2ClientRegistration checkOAuth2ClientRegistrationId(OAuth2ClientRegistrationId clientRegistrationId, Operation operation) throws ThingsboardException {
try {
validateId(clientRegistrationId, "Incorrect oAuth2ClientRegistrationId " + clientRegistrationId);
OAuth2ClientRegistration clientRegistration = oAuth2Service.findClientRegistrationById(getCurrentUser().getTenantId(), clientRegistrationId);
checkNotNull(clientRegistration);
accessControlService.checkPermission(getCurrentUser(), Resource.OAUTH2_CONFIGURATION, operation, clientRegistrationId, clientRegistration);
return clientRegistration;
} catch (Exception e) {
throw handleException(e, false);
}
}
ComponentDescriptor checkComponentDescriptorByClazz(String clazz) throws ThingsboardException {
try {
log.debug("[{}] Lookup component descriptor", clazz);

67
application/src/main/java/org/thingsboard/server/controller/OAuth2Controller.java

@ -20,8 +20,12 @@ import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.*;
import org.thingsboard.server.common.data.Dashboard;
import org.thingsboard.server.common.data.EntityType;
import org.thingsboard.server.common.data.audit.ActionType;
import org.thingsboard.server.common.data.exception.ThingsboardException;
import org.thingsboard.server.common.data.id.EntityId;
import org.thingsboard.server.common.data.id.DashboardId;
import org.thingsboard.server.common.data.id.OAuth2ClientRegistrationId;
import org.thingsboard.server.common.data.id.TenantId;
import org.thingsboard.server.common.data.oauth2.OAuth2ClientInfo;
import org.thingsboard.server.common.data.oauth2.OAuth2ClientRegistration;
@ -40,14 +44,14 @@ import java.util.List;
@RequestMapping("/api")
@Slf4j
public class OAuth2Controller extends BaseController {
@Autowired
private OAuth2Service oauth2Service;
public static final String CLIENT_REGISTRATION_ID = "clientRegistrationId";
private static final String REGISTRATION_ID = "registrationId";
@RequestMapping(value = "/noauth/oauth2Clients", method = RequestMethod.POST)
@ResponseBody
public List<OAuth2ClientInfo> getOAuth2Clients(HttpServletRequest request) throws ThingsboardException {
try {
return oauth2Service.getOAuth2Clients(request.getServerName());
return oAuth2Service.getOAuth2Clients(request.getServerName());
} catch (Exception e) {
throw handleException(e);
}
@ -60,13 +64,15 @@ public class OAuth2Controller extends BaseController {
try {
Authority authority = getCurrentUser().getAuthority();
checkOAuth2ConfigPermissions(Operation.READ);
OAuth2ClientsParams oAuth2ClientsParams = null;
List<OAuth2ClientRegistration> clientRegistrations = null;
if (Authority.SYS_ADMIN.equals(authority)) {
oAuth2ClientsParams = oauth2Service.getSystemOAuth2ClientsParams();
clientRegistrations = oAuth2Service.findClientRegistrationsByTenantId(TenantId.SYS_TENANT_ID);
} else if (Authority.TENANT_ADMIN.equals(authority)) {
oAuth2ClientsParams = oauth2Service.getTenantOAuth2ClientsParams(getCurrentUser().getTenantId());
clientRegistrations = oAuth2Service.findClientRegistrationsByTenantId(getCurrentUser().getTenantId());
} else {
throw new IllegalStateException("Authority " + authority + " cannot get client registrations.");
}
return oAuth2ClientsParams;
return new OAuth2ClientsParams(clientRegistrations);
} catch (Exception e) {
throw handleException(e);
}
@ -75,18 +81,37 @@ public class OAuth2Controller extends BaseController {
@PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
@RequestMapping(value = "/oauth2/config", method = RequestMethod.POST)
@ResponseStatus(value = HttpStatus.OK)
public OAuth2ClientsParams saveClientParams(@RequestBody OAuth2ClientsParams oAuth2ClientsParams) throws ThingsboardException {
public OAuth2ClientRegistration saveClientRegistration(@RequestBody OAuth2ClientRegistration clientRegistration) throws ThingsboardException {
try {
Authority authority = getCurrentUser().getAuthority();
checkOAuth2ConfigPermissions(Operation.WRITE);
OAuth2ClientsParams savedOAuth2ClientsParams = null;
if (Authority.SYS_ADMIN.equals(authority)) {
savedOAuth2ClientsParams = oauth2Service.saveSystemOAuth2ClientsParams(oAuth2ClientsParams);
} else if (Authority.TENANT_ADMIN.equals(authority)) {
savedOAuth2ClientsParams = oauth2Service.saveTenantOAuth2ClientsParams(getCurrentUser().getTenantId(), oAuth2ClientsParams);
}
return savedOAuth2ClientsParams;
clientRegistration.setTenantId(getCurrentUser().getTenantId());
checkEntity(clientRegistration.getId(), clientRegistration, Resource.OAUTH2_CONFIGURATION);
return oAuth2Service.saveClientRegistration(clientRegistration);
} catch (Exception e) {
throw handleException(e);
}
}
@PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN')")
@RequestMapping(value = "/oauth2/config/{clientRegistrationId}", method = RequestMethod.DELETE)
@ResponseStatus(value = HttpStatus.OK)
public void deleteClientRegistration(@PathVariable(CLIENT_REGISTRATION_ID) String strClientRegistrationId) throws ThingsboardException {
checkParameter(CLIENT_REGISTRATION_ID, strClientRegistrationId);
try {
OAuth2ClientRegistrationId clientRegistrationId = new OAuth2ClientRegistrationId(toUUID(strClientRegistrationId));
OAuth2ClientRegistration clientRegistration = checkOAuth2ClientRegistrationId(clientRegistrationId, Operation.DELETE);
oAuth2Service.deleteClientRegistrationById(getCurrentUser().getTenantId(), clientRegistrationId);
logEntityAction(clientRegistrationId, clientRegistration,
null,
ActionType.DELETED, null, strClientRegistrationId);
} catch (Exception e) {
logEntityAction(emptyId(EntityType.OAUTH2_CLIENT_REGISTRATION),
null,
null,
ActionType.DELETED, e, strClientRegistrationId);
throw handleException(e);
}
}
@ -96,7 +121,7 @@ public class OAuth2Controller extends BaseController {
@ResponseBody
public Boolean isOAuth2ConfigurationAllowed() throws ThingsboardException {
try {
return oauth2Service.isOAuth2ClientRegistrationAllowed(getTenantId());
return oAuth2Service.isOAuth2ClientRegistrationAllowed(getTenantId());
} catch (Exception e) {
throw handleException(e);
}
@ -105,4 +130,8 @@ public class OAuth2Controller extends BaseController {
private void checkOAuth2ConfigPermissions(Operation operation) throws ThingsboardException {
accessControlService.checkPermission(getCurrentUser(), Resource.OAUTH2_CONFIGURATION, operation);
}
private void checkOAuth2ConfigPermissions(Operation operation, OAuth2ClientRegistration clientRegistration) throws ThingsboardException {
accessControlService.checkPermission(getCurrentUser(), Resource.OAUTH2_CONFIGURATION, operation, clientRegistration.getId(), clientRegistration);
}
}

3
application/src/main/java/org/thingsboard/server/install/ThingsboardInstallService.java

@ -173,6 +173,9 @@ public class ThingsboardInstallService {
databaseEntitiesUpgradeService.upgradeDatabase("3.0.1");
log.info("Updating system data...");
systemDataLoaderService.updateSystemWidgets();
case "3.1.0":
log.info("Upgrading ThingsBoard from version 3.1.0 to 3.2.0 ...");
databaseEntitiesUpgradeService.upgradeDatabase("3.1.0");
break;
default:
throw new RuntimeException("Unable to upgrade ThingsBoard, unsupported fromVersion: " + upgradeFromVersion);

9
application/src/main/java/org/thingsboard/server/service/install/SqlDatabaseUpgradeService.java

@ -294,6 +294,15 @@ public class SqlDatabaseUpgradeService implements DatabaseEntitiesUpgradeService
} catch (Exception e) {
log.error("Failed updating schema!!!", e);
}
case "3.1.0":
try (Connection conn = DriverManager.getConnection(dbUrl, dbUserName, dbPassword)) {
log.info("Updating schema ...");
schemaUpdateFile = Paths.get(installScripts.getDataDir(), "upgrade", "3.1.0", "schema_update.sql");
loadSql(schemaUpdateFile, conn);
log.info("Schema updated.");
} catch (Exception e) {
log.error("Failed updating schema!!!", e);
}
break;
default:
throw new RuntimeException("Unable to upgrade SQL database, unsupported fromVersion: " + fromVersion);

6
application/src/main/java/org/thingsboard/server/service/security/auth/oauth2/Oauth2AuthenticationSuccessHandler.java

@ -65,11 +65,9 @@ public class Oauth2AuthenticationSuccessHandler extends SimpleUrlAuthenticationS
try {
OAuth2AuthenticationToken token = (OAuth2AuthenticationToken) authentication;
Pair<TenantId, OAuth2ClientRegistration> clientRegistrationPair = oAuth2Service.getClientRegistrationWithTenant(token.getAuthorizedClientRegistrationId());
TenantId tenantId = clientRegistrationPair.getKey();
OAuth2ClientRegistration clientRegistration = clientRegistrationPair.getValue();
OAuth2ClientRegistration clientRegistration = oAuth2Service.findClientRegistrationByRegistrationId(token.getAuthorizedClientRegistrationId());
OAuth2ClientMapper mapper = oauth2ClientMapperProvider.getOAuth2ClientMapperByType(clientRegistration.getMapperConfig().getType());
SecurityUser securityUser = mapper.getOrCreateUserByClientPrincipal(token, tenantId, clientRegistration.getMapperConfig());
SecurityUser securityUser = mapper.getOrCreateUserByClientPrincipal(token, clientRegistration.getTenantId(), clientRegistration.getMapperConfig());
JwtToken accessToken = tokenFactory.createAccessJwtToken(securityUser);
JwtToken refreshToken = refreshTokenRepository.requestRefreshToken(securityUser);

2
application/src/main/java/org/thingsboard/server/service/security/permission/Resource.java

@ -32,7 +32,7 @@ public enum Resource {
USER(EntityType.USER),
WIDGETS_BUNDLE(EntityType.WIDGETS_BUNDLE),
WIDGET_TYPE(EntityType.WIDGET_TYPE),
OAUTH2_CONFIGURATION(),
OAUTH2_CONFIGURATION(EntityType.OAUTH2_CLIENT_REGISTRATION),
;
private final EntityType entityType;

8
application/src/main/java/org/thingsboard/server/service/security/permission/TenantAdminPermissions.java

@ -113,5 +113,13 @@ public class TenantAdminPermissions extends AbstractPermissions {
public boolean hasPermission(SecurityUser user, Operation operation) {
return oAuth2Service.isOAuth2ClientRegistrationAllowed(user.getTenantId());
}
@Override
public boolean hasPermission(SecurityUser user, Operation operation, EntityId entityId, HasTenantId entity) {
if (!user.getTenantId().equals(entity.getTenantId())) {
return false;
}
return hasPermission(user, operation);
}
};
}

29
common/dao-api/src/main/java/org/thingsboard/server/dao/oauth2/OAuth2Service.java

@ -15,39 +15,30 @@
*/
package org.thingsboard.server.dao.oauth2;
import org.apache.commons.lang3.tuple.Pair;
import org.thingsboard.server.common.data.id.CustomerId;
import org.thingsboard.server.common.data.id.EntityId;
import org.thingsboard.server.common.data.id.OAuth2ClientRegistrationId;
import org.thingsboard.server.common.data.id.TenantId;
import org.thingsboard.server.common.data.oauth2.ExtendedOAuth2ClientRegistration;
import org.thingsboard.server.common.data.oauth2.OAuth2ClientInfo;
import org.thingsboard.server.common.data.oauth2.OAuth2ClientRegistration;
import org.thingsboard.server.common.data.oauth2.OAuth2ClientsParams;
import java.util.List;
import java.util.Map;
import java.util.UUID;
public interface OAuth2Service {
Pair<TenantId, OAuth2ClientRegistration> getClientRegistrationWithTenant(String registrationId);
ExtendedOAuth2ClientRegistration getExtendedClientRegistration(String registrationId);
List<OAuth2ClientInfo> getOAuth2Clients(String domainName);
OAuth2ClientsParams saveSystemOAuth2ClientsParams(OAuth2ClientsParams oAuth2ClientsParams);
OAuth2ClientRegistration saveClientRegistration(OAuth2ClientRegistration clientRegistration);
OAuth2ClientsParams saveTenantOAuth2ClientsParams(TenantId tenantId, OAuth2ClientsParams oAuth2ClientsParams);
List<OAuth2ClientRegistration> findClientRegistrationsByTenantId(TenantId tenantId);
OAuth2ClientsParams getSystemOAuth2ClientsParams();
OAuth2ClientRegistration findClientRegistrationByRegistrationId(String registrationId);
OAuth2ClientsParams getTenantOAuth2ClientsParams(TenantId tenantId);
OAuth2ClientRegistration findClientRegistrationById(TenantId tenantId, OAuth2ClientRegistrationId id);
void deleteTenantOAuth2ClientsParams(TenantId tenantId);
List<OAuth2ClientRegistration> findAllClientRegistrations();
void deleteSystemOAuth2ClientsParams();
void deleteClientRegistrationsByTenantId(TenantId tenantId);
boolean isOAuth2ClientRegistrationAllowed(TenantId tenantId);
Map<TenantId, OAuth2ClientsParams> getAllOAuth2ClientsParams();
void deleteClientRegistrationById(TenantId tenantId, OAuth2ClientRegistrationId id);
boolean isOAuth2ClientRegistrationAllowed(TenantId tenantId);
}

2
common/data/src/main/java/org/thingsboard/server/common/data/EntityType.java

@ -19,5 +19,5 @@ package org.thingsboard.server.common.data;
* @author Andrew Shvayka
*/
public enum EntityType {
TENANT, CUSTOMER, USER, DASHBOARD, ASSET, DEVICE, ALARM, RULE_CHAIN, RULE_NODE, ENTITY_VIEW, WIDGETS_BUNDLE, WIDGET_TYPE
TENANT, CUSTOMER, USER, DASHBOARD, ASSET, DEVICE, ALARM, RULE_CHAIN, RULE_NODE, ENTITY_VIEW, WIDGETS_BUNDLE, WIDGET_TYPE, OAUTH2_CLIENT_REGISTRATION
}

2
common/data/src/main/java/org/thingsboard/server/common/data/id/EntityIdFactory.java

@ -62,6 +62,8 @@ public class EntityIdFactory {
return new WidgetsBundleId(uuid);
case WIDGET_TYPE:
return new WidgetTypeId(uuid);
case OAUTH2_CLIENT_REGISTRATION:
return new OAuth2ClientRegistrationId(uuid);
}
throw new IllegalArgumentException("EntityType " + type + " is not supported!");
}

16
common/data/src/main/java/org/thingsboard/server/common/data/id/OAuth2IntegrationId.java → common/data/src/main/java/org/thingsboard/server/common/data/id/OAuth2ClientRegistrationId.java

@ -17,19 +17,23 @@ package org.thingsboard.server.common.data.id;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import org.thingsboard.server.common.data.EntityType;
import java.util.UUID;
public class OAuth2IntegrationId extends UUIDBased {
private static final long serialVersionUID = 1L;
public class OAuth2ClientRegistrationId extends UUIDBased implements EntityId {
@JsonCreator
public OAuth2IntegrationId(@JsonProperty("id") UUID id) {
public OAuth2ClientRegistrationId(@JsonProperty("id") UUID id) {
super(id);
}
public static OAuth2IntegrationId fromString(String oauth2IntegrationId) {
return new OAuth2IntegrationId(UUID.fromString(oauth2IntegrationId));
public static OAuth2ClientRegistrationId fromString(String clientRegistrationId) {
return new OAuth2ClientRegistrationId(UUID.fromString(clientRegistrationId));
}
@Override
public EntityType getEntityType() {
return EntityType.OAUTH2_CLIENT_REGISTRATION;
}
}

19
common/data/src/main/java/org/thingsboard/server/common/data/oauth2/OAuth2ClientInfo.java

@ -17,27 +17,20 @@ package org.thingsboard.server.common.data.oauth2;
import lombok.Data;
import lombok.EqualsAndHashCode;
import org.thingsboard.server.common.data.BaseData;
import org.thingsboard.server.common.data.id.OAuth2IntegrationId;
import lombok.NoArgsConstructor;
import lombok.AllArgsConstructor;
@EqualsAndHashCode(callSuper = true)
@EqualsAndHashCode
@Data
public class OAuth2ClientInfo extends BaseData<OAuth2IntegrationId> {
@NoArgsConstructor
@AllArgsConstructor
public class OAuth2ClientInfo {
private String name;
private String icon;
private String url;
public OAuth2ClientInfo() {
super();
}
public OAuth2ClientInfo(OAuth2IntegrationId id) {
super(id);
}
public OAuth2ClientInfo(OAuth2ClientInfo oauth2ClientInfo) {
super(oauth2ClientInfo);
this.name = oauth2ClientInfo.getName();
this.icon = oauth2ClientInfo.getIcon();
this.url = oauth2ClientInfo.getUrl();

41
common/data/src/main/java/org/thingsboard/server/common/data/oauth2/OAuth2ClientRegistration.java

@ -15,21 +15,26 @@
*/
package org.thingsboard.server.common.data.oauth2;
import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.*;
import org.thingsboard.server.common.data.BaseData;
import org.thingsboard.server.common.data.id.OAuth2IntegrationId;
import org.thingsboard.server.common.data.HasName;
import org.thingsboard.server.common.data.HasTenantId;
import org.thingsboard.server.common.data.id.OAuth2ClientRegistrationId;
import org.thingsboard.server.common.data.id.TenantId;
import java.util.List;
@EqualsAndHashCode
@EqualsAndHashCode(callSuper = true)
@Data
@ToString(exclude = {"clientSecret"})
@Builder(toBuilder = true)
@NoArgsConstructor
@AllArgsConstructor
public class OAuth2ClientRegistration {
public class OAuth2ClientRegistration extends BaseData<OAuth2ClientRegistrationId> implements HasTenantId, HasName {
private TenantId tenantId;
private String registrationId;
private String domainName;
private String redirectUriTemplate;
private OAuth2MapperConfig mapperConfig;
private String clientId;
private String clientSecret;
@ -42,4 +47,30 @@ public class OAuth2ClientRegistration {
private String clientAuthenticationMethod;
private String loginButtonLabel;
private String loginButtonIcon;
public OAuth2ClientRegistration(OAuth2ClientRegistration clientRegistration) {
super(clientRegistration);
this.tenantId = clientRegistration.getTenantId();
this.registrationId = clientRegistration.getRegistrationId();
this.domainName = clientRegistration.getDomainName();
this.redirectUriTemplate = clientRegistration.getRedirectUriTemplate();
this.mapperConfig = clientRegistration.mapperConfig;
this.clientId = clientRegistration.clientId;
this.clientSecret = clientRegistration.clientSecret;
this.authorizationUri = clientRegistration.authorizationUri;
this.accessTokenUri = clientRegistration.accessTokenUri;
this.scope = clientRegistration.scope;
this.userInfoUri = clientRegistration.userInfoUri;
this.userNameAttributeName = clientRegistration.userNameAttributeName;
this.jwkSetUri = clientRegistration.jwkSetUri;
this.clientAuthenticationMethod = clientRegistration.clientAuthenticationMethod;
this.loginButtonLabel = clientRegistration.loginButtonLabel;
this.loginButtonIcon = clientRegistration.loginButtonIcon;
}
@Override
@JsonProperty(access = JsonProperty.Access.READ_ONLY)
public String getName() {
return loginButtonLabel;
}
}

2
common/data/src/main/java/org/thingsboard/server/common/data/oauth2/OAuth2ClientsParams.java

@ -26,5 +26,5 @@ import java.util.List;
@NoArgsConstructor
@AllArgsConstructor
public class OAuth2ClientsParams {
private List<OAuth2ClientsDomainParams> clientsDomainsParams;
private List<OAuth2ClientRegistration> clientRegistrations;
}

6
dao/src/main/java/org/thingsboard/server/dao/model/ModelConstants.java

@ -355,22 +355,22 @@ public class ModelConstants {
public static final String RULE_NODE_CONFIGURATION_PROPERTY = "configuration";
/**
* Cassandra OAuth2 client registration constants.
* OAuth2 client registration constants.
*/
public static final String OAUTH2_TENANT_ID_PROPERTY = TENANT_ID_PROPERTY;
public static final String OAUTH2_CLIENT_REGISTRATION_COLUMN_FAMILY_NAME = "oauth2_client_registration";
public static final String OAUTH2_CLIENT_REGISTRATION_ID_PROPERTY = "registration_id";
public static final String OAUTH2_DOMAIN_NAME_PROPERTY = "domain_name";
public static final String OAUTH2_CLIENT_ID_PROPERTY = "client_id";
public static final String OAUTH2_CLIENT_SECRET_PROPERTY = "client_secret";
public static final String OAUTH2_AUTHORIZATION_URI_PROPERTY = "authorization_uri";
public static final String OAUTH2_TOKEN_URI_PROPERTY = "token_uri";
public static final String OAUTH2_REDIRECT_URI_TEMPLATE_PROPERTY = "redirect_uri_template";
public static final String OAUTH2_SCOPE_PROPERTY = "scope";
public static final String OAUTH2_AUTHORIZATION_GRANT_TYPE_PROPERTY = "authorization_grant_type";
public static final String OAUTH2_USER_INFO_URI_PROPERTY = "user_info_uri";
public static final String OAUTH2_USER_NAME_ATTRIBUTE_NAME_PROPERTY = "user_name_attribute_name";
public static final String OAUTH2_JWK_SET_URI_PROPERTY = "jwk_set_uri";
public static final String OAUTH2_CLIENT_AUTHENTICATION_METHOD_PROPERTY = "client_authentication_method";
public static final String OAUTH2_CLIENT_NAME_PROPERTY = "client_name";
public static final String OAUTH2_LOGIN_BUTTON_LABEL_PROPERTY = "login_button_label";
public static final String OAUTH2_LOGIN_BUTTON_ICON_PROPERTY = "login_button_icon";
public static final String OAUTH2_ALLOW_USER_CREATION_PROPERTY = "allow_user_creation";

204
dao/src/main/java/org/thingsboard/server/dao/model/sql/OAuth2ClientRegistrationEntity.java

@ -0,0 +1,204 @@
/**
* Copyright © 2016-2020 The Thingsboard Authors
*
* Licensed 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.thingsboard.server.dao.model.sql;
import lombok.Data;
import lombok.EqualsAndHashCode;
import org.hibernate.annotations.TypeDef;
import org.thingsboard.server.common.data.id.OAuth2ClientRegistrationId;
import org.thingsboard.server.common.data.id.TenantId;
import org.thingsboard.server.common.data.oauth2.*;
import org.thingsboard.server.dao.model.BaseSqlEntity;
import org.thingsboard.server.dao.model.ModelConstants;
import org.thingsboard.server.dao.util.mapping.JsonStringType;
import javax.persistence.*;
import java.util.Arrays;
import java.util.UUID;
@Data
@EqualsAndHashCode(callSuper = true)
@Entity
@TypeDef(name = "json", typeClass = JsonStringType.class)
@Table(name = ModelConstants.OAUTH2_CLIENT_REGISTRATION_COLUMN_FAMILY_NAME)
public class OAuth2ClientRegistrationEntity extends BaseSqlEntity<OAuth2ClientRegistration> {
@Column(name = ModelConstants.OAUTH2_TENANT_ID_PROPERTY, columnDefinition = "uuid")
private UUID tenantId;
@Column(name = ModelConstants.OAUTH2_CLIENT_REGISTRATION_ID_PROPERTY)
private String registrationId;
@Column(name = ModelConstants.OAUTH2_DOMAIN_NAME_PROPERTY)
private String domainName;
@Column(name = ModelConstants.OAUTH2_CLIENT_ID_PROPERTY)
private String clientId;
@Column(name = ModelConstants.OAUTH2_CLIENT_SECRET_PROPERTY)
private String clientSecret;
@Column(name = ModelConstants.OAUTH2_AUTHORIZATION_URI_PROPERTY)
private String authorizationUri;
@Column(name = ModelConstants.OAUTH2_TOKEN_URI_PROPERTY)
private String tokenUri;
@Column(name = ModelConstants.OAUTH2_REDIRECT_URI_TEMPLATE_PROPERTY)
private String redirectUriTemplate;
@Column(name = ModelConstants.OAUTH2_SCOPE_PROPERTY)
private String scope;
@Column(name = ModelConstants.OAUTH2_USER_INFO_URI_PROPERTY)
private String userInfoUri;
@Column(name = ModelConstants.OAUTH2_USER_NAME_ATTRIBUTE_NAME_PROPERTY)
private String userNameAttributeName;
@Column(name = ModelConstants.OAUTH2_JWK_SET_URI_PROPERTY)
private String jwkSetUri;
@Column(name = ModelConstants.OAUTH2_CLIENT_AUTHENTICATION_METHOD_PROPERTY)
private String clientAuthenticationMethod;
@Column(name = ModelConstants.OAUTH2_LOGIN_BUTTON_LABEL_PROPERTY)
private String loginButtonLabel;
@Column(name = ModelConstants.OAUTH2_LOGIN_BUTTON_ICON_PROPERTY)
private String loginButtonIcon;
@Column(name = ModelConstants.OAUTH2_ALLOW_USER_CREATION_PROPERTY)
private Boolean allowUserCreation;
@Column(name = ModelConstants.OAUTH2_ACTIVATE_USER_PROPERTY)
private Boolean activateUser;
@Enumerated(EnumType.STRING)
@Column(name = ModelConstants.OAUTH2_MAPPER_TYPE_PROPERTY)
private MapperType type;
@Column(name = ModelConstants.OAUTH2_EMAIL_ATTRIBUTE_KEY_PROPERTY)
private String emailAttributeKey;
@Column(name = ModelConstants.OAUTH2_FIRST_NAME_ATTRIBUTE_KEY_PROPERTY)
private String firstNameAttributeKey;
@Column(name = ModelConstants.OAUTH2_LAST_NAME_ATTRIBUTE_KEY_PROPERTY)
private String lastNameAttributeKey;
@Enumerated(EnumType.STRING)
@Column(name = ModelConstants.OAUTH2_TENANT_NAME_STRATEGY_PROPERTY)
private TenantNameStrategyType tenantNameStrategy;
@Column(name = ModelConstants.OAUTH2_TENANT_NAME_PATTERN_PROPERTY)
private String tenantNamePattern;
@Column(name = ModelConstants.OAUTH2_CUSTOMER_NAME_PATTERN_PROPERTY)
private String customerNamePattern;
@Column(name = ModelConstants.OAUTH2_DEFAULT_DASHBOARD_NAME_PROPERTY)
private String defaultDashboardName;
@Column(name = ModelConstants.OAUTH2_ALWAYS_FULL_SCREEN_PROPERTY)
private Boolean alwaysFullScreen;
@Column(name = ModelConstants.OAUTH2_MAPPER_URL_PROPERTY)
private String url;
@Column(name = ModelConstants.OAUTH2_MAPPER_USERNAME_PROPERTY)
private String username;
@Column(name = ModelConstants.OAUTH2_MAPPER_PASSWORD_PROPERTY)
private String password;
public OAuth2ClientRegistrationEntity() {
super();
}
public OAuth2ClientRegistrationEntity(OAuth2ClientRegistration clientRegistration) {
if (clientRegistration.getId() != null) {
this.setUuid(clientRegistration.getId().getId());
}
if (clientRegistration.getTenantId() != null) {
this.tenantId = clientRegistration.getTenantId().getId();
}
this.domainName = clientRegistration.getDomainName();
this.createdTime = clientRegistration.getCreatedTime();
this.registrationId = clientRegistration.getRegistrationId();
this.clientId = clientRegistration.getClientId();
this.clientSecret = clientRegistration.getClientSecret();
this.authorizationUri = clientRegistration.getAuthorizationUri();
this.tokenUri = clientRegistration.getAccessTokenUri();
this.redirectUriTemplate = clientRegistration.getRedirectUriTemplate();
this.scope = clientRegistration.getScope().stream().reduce((result, element) -> result + "," + element).orElse("");
this.userInfoUri = clientRegistration.getUserInfoUri();
this.userNameAttributeName = clientRegistration.getUserNameAttributeName();
this.jwkSetUri = clientRegistration.getJwkSetUri();
this.clientAuthenticationMethod = clientRegistration.getClientAuthenticationMethod();
this.loginButtonLabel = clientRegistration.getLoginButtonLabel();
this.loginButtonIcon = clientRegistration.getLoginButtonIcon();
OAuth2MapperConfig mapperConfig = clientRegistration.getMapperConfig();
if (mapperConfig != null) {
this.allowUserCreation = mapperConfig.isAllowUserCreation();
this.activateUser = mapperConfig.isActivateUser();
this.type = mapperConfig.getType();
OAuth2BasicMapperConfig basicConfig = mapperConfig.getBasic();
if (basicConfig != null) {
this.emailAttributeKey = basicConfig.getEmailAttributeKey();
this.firstNameAttributeKey = basicConfig.getFirstNameAttributeKey();
this.lastNameAttributeKey = basicConfig.getLastNameAttributeKey();
this.tenantNameStrategy = basicConfig.getTenantNameStrategy();
this.tenantNamePattern = basicConfig.getTenantNamePattern();
this.customerNamePattern = basicConfig.getCustomerNamePattern();
this.defaultDashboardName = basicConfig.getDefaultDashboardName();
this.alwaysFullScreen = basicConfig.isAlwaysFullScreen();
}
OAuth2CustomMapperConfig customConfig = mapperConfig.getCustom();
if (customConfig != null) {
this.url = customConfig.getUrl();
this.username = customConfig.getUsername();
this.password = customConfig.getPassword();
}
}
}
@Override
public OAuth2ClientRegistration toData() {
OAuth2ClientRegistration clientRegistration = new OAuth2ClientRegistration();
clientRegistration.setId(new OAuth2ClientRegistrationId(id));
clientRegistration.setTenantId(new TenantId(tenantId));
clientRegistration.setRegistrationId(registrationId);
clientRegistration.setDomainName(domainName);
clientRegistration.setCreatedTime(createdTime);
clientRegistration.setMapperConfig(
OAuth2MapperConfig.builder()
.allowUserCreation(allowUserCreation)
.activateUser(activateUser)
.type(type)
.basic(
type == MapperType.BASIC ?
OAuth2BasicMapperConfig.builder()
.emailAttributeKey(emailAttributeKey)
.firstNameAttributeKey(firstNameAttributeKey)
.lastNameAttributeKey(lastNameAttributeKey)
.tenantNameStrategy(tenantNameStrategy)
.tenantNamePattern(tenantNamePattern)
.customerNamePattern(customerNamePattern)
.defaultDashboardName(defaultDashboardName)
.alwaysFullScreen(alwaysFullScreen)
.build()
: null
)
.custom(
type == MapperType.CUSTOM ?
OAuth2CustomMapperConfig.builder()
.url(url)
.username(username)
.password(password)
.build()
: null
)
.build()
);
clientRegistration.setClientId(clientId);
clientRegistration.setClientSecret(clientSecret);
clientRegistration.setAuthorizationUri(authorizationUri);
clientRegistration.setAccessTokenUri(tokenUri);
clientRegistration.setRedirectUriTemplate(redirectUriTemplate);
clientRegistration.setScope(Arrays.asList(scope.split(",")));
clientRegistration.setUserInfoUri(userInfoUri);
clientRegistration.setUserNameAttributeName(userNameAttributeName);
clientRegistration.setJwkSetUri(jwkSetUri);
clientRegistration.setClientAuthenticationMethod(clientAuthenticationMethod);
clientRegistration.setLoginButtonLabel(loginButtonLabel);
clientRegistration.setLoginButtonIcon(loginButtonIcon);
return clientRegistration;
}
}

10
dao/src/main/java/org/thingsboard/server/dao/oauth2/HybridClientRegistrationRepository.java

@ -32,19 +32,19 @@ public class HybridClientRegistrationRepository implements ClientRegistrationRep
@Override
public ClientRegistration findByRegistrationId(String registrationId) {
ExtendedOAuth2ClientRegistration localExtendedClientRegistration = oAuth2Service.getExtendedClientRegistration(registrationId);
return localExtendedClientRegistration == null ?
null : toSpringClientRegistration(localExtendedClientRegistration.getRedirectUriTemplate(), localExtendedClientRegistration.getClientRegistration());
OAuth2ClientRegistration oAuth2ClientRegistration = oAuth2Service.findClientRegistrationByRegistrationId(registrationId);
return oAuth2ClientRegistration == null ?
null : toSpringClientRegistration(oAuth2ClientRegistration);
}
private ClientRegistration toSpringClientRegistration(String redirectUriTemplate, OAuth2ClientRegistration localClientRegistration){
private ClientRegistration toSpringClientRegistration(OAuth2ClientRegistration localClientRegistration){
return ClientRegistration.withRegistrationId(localClientRegistration.getRegistrationId())
.clientName(localClientRegistration.getRegistrationId())
.clientId(localClientRegistration.getClientId())
.authorizationUri(localClientRegistration.getAuthorizationUri())
.clientSecret(localClientRegistration.getClientSecret())
.tokenUri(localClientRegistration.getAccessTokenUri())
.redirectUriTemplate(redirectUriTemplate)
.redirectUriTemplate(localClientRegistration.getRedirectUriTemplate())
.scope(localClientRegistration.getScope())
.authorizationGrantType(AuthorizationGrantType.AUTHORIZATION_CODE)
.userInfoUri(localClientRegistration.getUserInfoUri())

36
dao/src/main/java/org/thingsboard/server/dao/oauth2/OAuth2ClientRegistrationDao.java

@ -0,0 +1,36 @@
/**
* Copyright © 2016-2020 The Thingsboard Authors
*
* Licensed 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.thingsboard.server.dao.oauth2;
import org.thingsboard.server.common.data.oauth2.OAuth2ClientRegistration;
import org.thingsboard.server.dao.Dao;
import java.util.List;
import java.util.UUID;
public interface OAuth2ClientRegistrationDao extends Dao<OAuth2ClientRegistration> {
OAuth2ClientRegistration findByRegistrationId(String registrationId);
List<OAuth2ClientRegistration> findAll();
List<OAuth2ClientRegistration> findByTenantId(UUID tenantId);
List<OAuth2ClientRegistration> findByDomainName(String domainName);
boolean removeByRegistrationId(String registrationId);
int removeByTenantId(UUID tenantId);
}

644
dao/src/main/java/org/thingsboard/server/dao/oauth2/OAuth2ServiceImpl.java

@ -15,366 +15,119 @@
*/
package org.thingsboard.server.dao.oauth2;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.MoreExecutors;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.tuple.ImmutablePair;
import org.apache.commons.lang3.tuple.Pair;
import org.hibernate.exception.ConstraintViolationException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import org.springframework.util.StringUtils;
import org.thingsboard.server.common.data.*;
import org.thingsboard.server.common.data.id.*;
import org.thingsboard.server.common.data.kv.*;
import org.thingsboard.server.common.data.Tenant;
import org.thingsboard.server.common.data.exception.ThingsboardErrorCode;
import org.thingsboard.server.common.data.exception.ThingsboardException;
import org.thingsboard.server.common.data.id.OAuth2ClientRegistrationId;
import org.thingsboard.server.common.data.id.TenantId;
import org.thingsboard.server.common.data.oauth2.*;
import org.thingsboard.server.dao.attributes.AttributesService;
import org.thingsboard.server.dao.entity.AbstractEntityService;
import org.thingsboard.server.dao.exception.DataValidationException;
import org.thingsboard.server.dao.exception.IncorrectParameterException;
import org.thingsboard.server.dao.lock.LockKey;
import org.thingsboard.server.dao.lock.LockService;
import org.thingsboard.server.dao.settings.AdminSettingsService;
import org.thingsboard.server.dao.service.DataValidator;
import org.thingsboard.server.dao.tenant.TenantService;
import java.io.IOException;
import java.util.*;
import java.util.concurrent.ExecutionException;
import java.util.function.Consumer;
import javax.transaction.Transactional;
import java.util.List;
import java.util.UUID;
import java.util.stream.Collectors;
import static org.thingsboard.server.dao.oauth2.OAuth2Utils.*;
import static org.thingsboard.server.dao.oauth2.OAuth2Utils.ALLOW_OAUTH2_CONFIGURATION;
import static org.thingsboard.server.dao.service.Validator.validateId;
import static org.thingsboard.server.dao.service.Validator.validateString;
@Slf4j
@Service
public class OAuth2ServiceImpl implements OAuth2Service {
private static final ObjectMapper mapper = new ObjectMapper();
@Autowired
private Environment environment;
@Autowired
private AdminSettingsService adminSettingsService;
@Autowired
private AttributesService attributesService;
public class OAuth2ServiceImpl extends AbstractEntityService implements OAuth2Service {
public static final String INCORRECT_TENANT_ID = "Incorrect tenantId ";
public static final String INCORRECT_CLIENT_REGISTRATION_ID = "Incorrect clientRegistrationId ";
public static final String INCORRECT_REGISTRATION_ID = "Incorrect registrationId ";
public static final String INCORRECT_DOMAIN_NAME = "Incorrect domainName ";
@Autowired
private TenantService tenantService;
@Autowired
private LockService lockService;
private boolean isInstall() {
return environment.acceptsProfiles("install");
}
@Override
public Pair<TenantId, OAuth2ClientRegistration> getClientRegistrationWithTenant(String registrationId) {
return getExtendedOAuth2ClientRegistrationWithTenant(registrationId)
.map(pair -> ImmutablePair.of(pair.getLeft(), pair.getRight().getClientRegistration()))
.orElse(null);
}
@Override
public ExtendedOAuth2ClientRegistration getExtendedClientRegistration(String registrationId) {
return getExtendedOAuth2ClientRegistrationWithTenant(registrationId)
.map(Pair::getValue)
.orElse(null);
}
private Optional<Pair<TenantId, ExtendedOAuth2ClientRegistration>> getExtendedOAuth2ClientRegistrationWithTenant(String registrationId) {
return getAllOAuth2ClientsParams().entrySet().stream()
.map(entry -> {
TenantId tenantId = entry.getKey();
return entry.getValue().getClientsDomainsParams().stream()
.flatMap(domainParams ->
domainParams.getClientRegistrations().stream()
.map(clientRegistration -> new ExtendedOAuth2ClientRegistration(domainParams.getRedirectUriTemplate(), clientRegistration))
)
.filter(registration -> registrationId.equals(registration.getClientRegistration().getRegistrationId()))
.findFirst()
.map(extendedClientRegistration -> ImmutablePair.of(tenantId, extendedClientRegistration))
.orElse(null);
})
.filter(Objects::nonNull)
.findFirst()
.map(entry -> ImmutablePair.of(entry.getKey(), entry.getValue()))
;
}
private OAuth2ClientRegistrationDao clientRegistrationDao;
@Override
public List<OAuth2ClientInfo> getOAuth2Clients(String domainName) {
OAuth2ClientsDomainParams oAuth2ClientsDomainParams = getMergedOAuth2ClientsParams(domainName);
return oAuth2ClientsDomainParams != null && oAuth2ClientsDomainParams.getClientRegistrations() != null ?
oAuth2ClientsDomainParams.getClientRegistrations().stream()
.map(OAuth2Utils::toClientInfo)
.collect(Collectors.toList())
: Collections.emptyList()
;
}
@Override
public OAuth2ClientsParams saveSystemOAuth2ClientsParams(OAuth2ClientsParams oAuth2ClientsParams) {
validate(oAuth2ClientsParams);
validateRegistrationIdUniqueness(oAuth2ClientsParams, TenantId.SYS_TENANT_ID);
transactionalSaveSystemOAuth2ClientsParams(oAuth2ClientsParams);
return getSystemOAuth2ClientsParams();
}
@Transactional
private void transactionalSaveSystemOAuth2ClientsParams(OAuth2ClientsParams oAuth2ClientsParams) {
long acquireStart = System.currentTimeMillis();
lockService.transactionLock(LockKey.OAUTH2_CONFIG);
log.trace("[{}] Waited for lock {} ms.", TenantId.SYS_TENANT_ID, System.currentTimeMillis() - acquireStart);
validateRegistrationIdUniqueness(oAuth2ClientsParams, TenantId.SYS_TENANT_ID);
AdminSettings oauth2SystemAdminSettings = adminSettingsService.findAdminSettingsByKey(TenantId.SYS_TENANT_ID, OAUTH2_CLIENT_REGISTRATIONS_PARAMS);
if (oauth2SystemAdminSettings == null) {
oauth2SystemAdminSettings = createSystemAdminSettings();
}
String json = toJson(oAuth2ClientsParams);
((ObjectNode) oauth2SystemAdminSettings.getJsonValue()).put(SYSTEM_SETTINGS_OAUTH2_VALUE, json);
adminSettingsService.saveAdminSettings(TenantId.SYS_TENANT_ID, oauth2SystemAdminSettings);
log.trace("Executing getOAuth2Clients [{}]", domainName);
validateString(domainName, INCORRECT_DOMAIN_NAME + domainName);
return clientRegistrationDao.findByDomainName(domainName).stream()
.map(OAuth2Utils::toClientInfo)
.collect(Collectors.toList());
}
@Override
public OAuth2ClientsParams saveTenantOAuth2ClientsParams(TenantId tenantId, OAuth2ClientsParams oAuth2ClientsParams) {
validate(oAuth2ClientsParams);
validateRegistrationIdUniqueness(oAuth2ClientsParams, tenantId);
transactionalSaveTenantOAuth2ClientsParams(tenantId, oAuth2ClientsParams);
return getTenantOAuth2ClientsParams(tenantId);
}
@Transactional
private void transactionalSaveTenantOAuth2ClientsParams(TenantId tenantId, OAuth2ClientsParams oAuth2ClientsParams) {
long acquireStart = System.currentTimeMillis();
lockService.transactionLock(LockKey.OAUTH2_CONFIG);
log.trace("[{}] Waited for lock {} ms.", tenantId, System.currentTimeMillis() - acquireStart);
validateRegistrationIdUniqueness(oAuth2ClientsParams, tenantId);
Set<String> domainNames = oAuth2ClientsParams.getClientsDomainsParams().stream()
.map(OAuth2ClientsDomainParams::getDomainName)
.collect(Collectors.toSet());
processTenantAdminSettings(tenantId, domainNames);
List<AttributeKvEntry> attributes = createOAuth2ClientsParamsAttributes(oAuth2ClientsParams);
public OAuth2ClientRegistration saveClientRegistration(OAuth2ClientRegistration clientRegistration) {
log.trace("Executing saveClientRegistration [{}]", clientRegistration);
clientRegistrationValidator.validate(clientRegistration, OAuth2ClientRegistration::getTenantId);
OAuth2ClientRegistration savedClientRegistration;
try {
attributesService.save(tenantId, tenantId, DataConstants.SERVER_SCOPE, attributes).get();
} catch (Exception e) {
log.error("Unable to save OAuth2 Client Registration Params to attributes!", e);
throw new IncorrectParameterException("Unable to save OAuth2 Client Registration Params to attributes!");
}
}
private List<AttributeKvEntry> createOAuth2ClientsParamsAttributes(OAuth2ClientsParams oAuth2ClientsParams) {
String json = toJson(oAuth2ClientsParams);
List<AttributeKvEntry> attributes = new ArrayList<>();
long ts = System.currentTimeMillis();
attributes.add(new BaseAttributeKvEntry(new StringDataEntry(OAUTH2_CLIENT_REGISTRATIONS_PARAMS, json), ts));
return attributes;
}
private void processTenantAdminSettings(TenantId tenantId, Set<String> domainNames) {
OAuth2ClientsParams existentClientsParams = getTenantOAuth2ClientsParams(tenantId);
Set<String> existentDomainNames = existentClientsParams != null && existentClientsParams.getClientsDomainsParams() != null ?
existentClientsParams.getClientsDomainsParams().stream()
.map(OAuth2ClientsDomainParams::getDomainName)
.collect(Collectors.toSet())
: Collections.emptySet();
Set<String> domainNamesToAdd = domainNames.stream()
.filter(domainName -> !existentDomainNames.contains(domainName))
.collect(Collectors.toSet());
Set<String> domainNamesToDelete = existentDomainNames.stream()
.filter(domainName -> !domainNames.contains(domainName))
.collect(Collectors.toSet());
domainNamesToAdd.forEach(domainName -> {
String domainSettingsKey = constructAdminSettingsDomainKey(domainName);
if (adminSettingsService.findAdminSettingsByKey(tenantId, domainSettingsKey) != null) {
log.error("Current domain name [{}] already registered in the system!", domainName);
throw new IncorrectParameterException("Current domain name [" + domainName + "] already registered in the system!");
}
});
domainNamesToAdd.forEach(domainName -> {
String domainSettingsKey = constructAdminSettingsDomainKey(domainName);
AdminSettings tenantAdminSettings = createTenantAdminSettings(tenantId, domainSettingsKey);
adminSettingsService.saveAdminSettings(tenantId, tenantAdminSettings);
});
domainNamesToDelete.forEach(domainName -> {
String domainSettingsKey = constructAdminSettingsDomainKey(domainName);
adminSettingsService.deleteAdminSettingsByKey(tenantId, domainSettingsKey);
});
}
private AdminSettings createTenantAdminSettings(TenantId tenantId, String clientRegistrationsKey) {
AdminSettings clientRegistrationParamsSettings = new AdminSettings();
clientRegistrationParamsSettings.setKey(clientRegistrationsKey);
ObjectNode node = mapper.createObjectNode();
node.put("entityType", EntityType.TENANT.name());
node.put("entityId", tenantId.toString());
clientRegistrationParamsSettings.setJsonValue(node);
return clientRegistrationParamsSettings;
}
private AdminSettings createSystemAdminSettings() {
AdminSettings clientRegistrationParamsSettings = new AdminSettings();
clientRegistrationParamsSettings.setKey(OAUTH2_CLIENT_REGISTRATIONS_PARAMS);
ObjectNode clientRegistrationsNode = mapper.createObjectNode();
clientRegistrationParamsSettings.setJsonValue(clientRegistrationsNode);
return clientRegistrationParamsSettings;
}
private void validateRegistrationIdUniqueness(OAuth2ClientsParams inputOAuth2ClientsParams, TenantId tenantId) {
List<String> registrationIds = toClientRegistrationStream(inputOAuth2ClientsParams)
.map(OAuth2ClientRegistration::getRegistrationId)
.collect(Collectors.toList());
boolean regIdDuplicates = registrationIds.stream()
.anyMatch(registrationId -> Collections.frequency(registrationIds, registrationId) > 1);
if (regIdDuplicates) {
throw new DataValidationException("All registration IDs should be unique!");
}
getAllOAuth2ClientsParams().forEach((paramsTenantId, oAuth2ClientsParams) -> {
if (tenantId.equals(paramsTenantId)) return;
Set<String> duplicatedRegistrationIds = toClientRegistrationStream(oAuth2ClientsParams)
.map(OAuth2ClientRegistration::getRegistrationId)
.filter(registrationIds::contains)
.collect(Collectors.toSet());
if (!duplicatedRegistrationIds.isEmpty()) {
log.error("RegistrationIds [{}] are already registered in the system!", duplicatedRegistrationIds);
throw new IncorrectParameterException("RegistrationIds [" + duplicatedRegistrationIds + "] are already registered in the system!");
}
});
}
private void validate(OAuth2ClientsParams oAuth2ClientsParams) {
validateRedirectUris(oAuth2ClientsParams);
validateDomainNames(oAuth2ClientsParams);
toClientRegistrationStream(oAuth2ClientsParams)
.forEach(validator);
}
private void validateDomainNames(OAuth2ClientsParams oAuth2ClientsParams) {
List<String> domainNames = oAuth2ClientsParams.getClientsDomainsParams().stream()
.map(OAuth2ClientsDomainParams::getDomainName)
.collect(Collectors.toList());
domainNames.forEach(domainName -> {
if (StringUtils.isEmpty(domainName)) {
throw new DataValidationException("Domain name should be specified!");
savedClientRegistration = clientRegistrationDao.save(clientRegistration.getTenantId(), clientRegistration);
} catch (Exception t) {
ConstraintViolationException e = extractConstraintViolationException(t).orElse(null);
if (e != null && e.getConstraintName() != null && e.getConstraintName().equalsIgnoreCase("oauth2_registration_id_unq_key")) {
throw new DataValidationException("Client registration with such registrationId already exists!");
} else {
throw t;
}
});
boolean duplicateDomainNames = domainNames.stream()
.anyMatch(domainName -> Collections.frequency(domainNames, domainName) > 1);
if (duplicateDomainNames) {
throw new DataValidationException("All domain names should be unique!");
}
return savedClientRegistration;
}
private void validateRedirectUris(OAuth2ClientsParams oAuth2ClientsParams) {
oAuth2ClientsParams.getClientsDomainsParams().stream()
.forEach(oAuth2ClientsDomainParams -> {
if (StringUtils.isEmpty(oAuth2ClientsDomainParams.getRedirectUriTemplate())) {
throw new DataValidationException("Redirect uri template should be specified!");
}
});
@Override
public List<OAuth2ClientRegistration> findClientRegistrationsByTenantId(TenantId tenantId) {
log.trace("Executing findClientRegistrationsByTenantId [{}]", tenantId);
validateId(tenantId, INCORRECT_TENANT_ID + tenantId);
return clientRegistrationDao.findByTenantId(tenantId.getId());
}
@Override
public OAuth2ClientsParams getSystemOAuth2ClientsParams() {
AdminSettings oauth2ClientsParamsSettings = adminSettingsService.findAdminSettingsByKey(TenantId.SYS_TENANT_ID, OAUTH2_CLIENT_REGISTRATIONS_PARAMS);
String json = null;
if (oauth2ClientsParamsSettings != null) {
json = oauth2ClientsParamsSettings.getJsonValue().get(SYSTEM_SETTINGS_OAUTH2_VALUE).asText();
}
return constructOAuth2ClientsParams(json);
public OAuth2ClientRegistration findClientRegistrationByRegistrationId(String registrationId) {
log.trace("Executing findClientRegistrationByRegistrationId [{}]", registrationId);
validateString(registrationId, INCORRECT_REGISTRATION_ID + registrationId);
return clientRegistrationDao.findByRegistrationId(registrationId);
}
@Override
public OAuth2ClientsParams getTenantOAuth2ClientsParams(TenantId tenantId) {
ListenableFuture<String> jsonFuture;
if (isOAuth2ClientRegistrationAllowed(tenantId)) {
jsonFuture = getOAuth2ClientsParamsAttribute(tenantId);
} else {
jsonFuture = Futures.immediateFuture("");
}
try {
return Futures.transform(jsonFuture, this::constructOAuth2ClientsParams, MoreExecutors.directExecutor()).get();
} catch (InterruptedException | ExecutionException e) {
log.error("Failed to read OAuth2 Clients Params from attributes!", e);
throw new RuntimeException("Failed to read OAuth2 Clients Params from attributes!", e);
}
public OAuth2ClientRegistration findClientRegistrationById(TenantId tenantId, OAuth2ClientRegistrationId id) {
log.trace("Executing findClientRegistrationById [{}]", id);
validateId(id, INCORRECT_CLIENT_REGISTRATION_ID + id);
return clientRegistrationDao.findById(tenantId, id.getId());
}
// TODO this is just for test, maybe there's a better way to test it without exporting to interface
@Override
public Map<TenantId, OAuth2ClientsParams> getAllOAuth2ClientsParams() {
OAuth2ClientsParams systemOAuth2ClientsParams = getSystemOAuth2ClientsParams();
ListenableFuture<Map<UUID, String>> jsonFuture = getAllOAuth2ClientsParamsAttribute();
try {
return Futures.transform(jsonFuture,
clientsParamsByKvEntryKey -> {
Map<TenantId, OAuth2ClientsParams> tenantClientParams = clientsParamsByKvEntryKey != null ?
clientsParamsByKvEntryKey.entrySet().stream()
.collect(Collectors.toMap(
entry -> new TenantId(entry.getKey()),
entry -> constructOAuth2ClientsParams(entry.getValue())
))
: new HashMap<>();
if (systemOAuth2ClientsParams.getClientsDomainsParams() != null) {
tenantClientParams.put(TenantId.SYS_TENANT_ID, systemOAuth2ClientsParams);
}
return tenantClientParams;
},
MoreExecutors.directExecutor()
).get();
} catch (InterruptedException | ExecutionException e) {
log.error("Failed to read OAuth2 Clients Params from attributes!", e);
throw new RuntimeException("Failed to read OAuth2 Clients Params from attributes!", e);
}
public List<OAuth2ClientRegistration> findAllClientRegistrations() {
log.trace("Executing findAllClientRegistrations");
return clientRegistrationDao.findAll();
}
@Override
public void deleteTenantOAuth2ClientsParams(TenantId tenantId) {
OAuth2ClientsParams params = getTenantOAuth2ClientsParams(tenantId);
if (params == null || params.getClientsDomainsParams() == null) return;
params.getClientsDomainsParams().forEach(domainParams -> {
String settingsKey = constructAdminSettingsDomainKey(domainParams.getDomainName());
adminSettingsService.deleteAdminSettingsByKey(tenantId, settingsKey);
});
attributesService.removeAll(tenantId, tenantId, DataConstants.SERVER_SCOPE, Collections.singletonList(OAUTH2_CLIENT_REGISTRATIONS_PARAMS));
@Transactional
public void deleteClientRegistrationsByTenantId(TenantId tenantId) {
log.trace("Executing deleteClientRegistrationsByTenantId [{}]", tenantId);
validateId(tenantId, INCORRECT_TENANT_ID + tenantId);
clientRegistrationDao.removeByTenantId(tenantId.getId());
}
@Override
public void deleteSystemOAuth2ClientsParams() {
adminSettingsService.deleteAdminSettingsByKey(TenantId.SYS_TENANT_ID, OAuth2Utils.OAUTH2_CLIENT_REGISTRATIONS_PARAMS);
public void deleteClientRegistrationById(TenantId tenantId, OAuth2ClientRegistrationId id) {
log.trace("Executing deleteClientRegistrationById [{}]", id);
validateId(id, INCORRECT_CLIENT_REGISTRATION_ID + id);
clientRegistrationDao.removeById(tenantId, id.getId());
}
@Override
public boolean isOAuth2ClientRegistrationAllowed(TenantId tenantId) {
log.trace("Executing isOAuth2ClientRegistrationAllowed [{}]", tenantId);
validateId(tenantId, INCORRECT_TENANT_ID + tenantId);
Tenant tenant = tenantService.findTenantById(tenantId);
if (tenant == null) return false;
JsonNode allowOAuth2ConfigurationJsonNode = tenant.getAdditionalInfo() != null ? tenant.getAdditionalInfo().get(ALLOW_OAUTH2_CONFIGURATION) : null;
@ -385,185 +138,98 @@ public class OAuth2ServiceImpl implements OAuth2Service {
}
}
private ListenableFuture<String> getOAuth2ClientsParamsAttribute(TenantId tenantId) {
ListenableFuture<List<AttributeKvEntry>> attributeKvEntriesFuture;
try {
attributeKvEntriesFuture = attributesService.find(tenantId, tenantId, DataConstants.SERVER_SCOPE,
Collections.singletonList(OAUTH2_CLIENT_REGISTRATIONS_PARAMS));
} catch (Exception e) {
log.error("Unable to read OAuth2 Clients Params from attributes!", e);
throw new IncorrectParameterException("Unable to read OAuth2 Clients Params from attributes!");
}
return Futures.transform(attributeKvEntriesFuture, attributeKvEntries -> {
if (attributeKvEntries != null && !attributeKvEntries.isEmpty()) {
AttributeKvEntry kvEntry = attributeKvEntries.get(0);
return kvEntry.getValueAsString();
} else {
return "";
}
}, MoreExecutors.directExecutor());
}
// TODO maybe it's better to load all tenants and get attribute for each one
private ListenableFuture<Map<UUID, String>> getAllOAuth2ClientsParamsAttribute() {
ListenableFuture<List<EntityAttributeKvEntry>> entityAttributeKvEntriesFuture;
try {
entityAttributeKvEntriesFuture = attributesService.findAllByAttributeKey(OAUTH2_CLIENT_REGISTRATIONS_PARAMS);
} catch (Exception e) {
log.error("Unable to read OAuth2 Clients Params from attributes!", e);
throw new IncorrectParameterException("Unable to read OAuth2 Clients Params from attributes!");
}
return Futures.transform(entityAttributeKvEntriesFuture, attributeKvEntries -> {
if (attributeKvEntries != null && !attributeKvEntries.isEmpty()) {
return attributeKvEntries.stream()
.collect(Collectors.toMap(EntityAttributeKvEntry::getEntityId, EntityAttributeKvEntry::getValueAsString));
} else {
return Collections.emptyMap();
}
}, MoreExecutors.directExecutor());
}
private OAuth2ClientsDomainParams getMergedOAuth2ClientsParams(String domainName) {
OAuth2ClientsDomainParams result = OAuth2ClientsDomainParams.builder()
.domainName(domainName)
.clientRegistrations(new ArrayList<>())
.build();
OAuth2ClientsParams systemOAuth2ClientsParams = getSystemOAuth2ClientsParams();
OAuth2ClientsDomainParams systemOAuth2ClientsDomainParams = systemOAuth2ClientsParams != null && systemOAuth2ClientsParams.getClientsDomainsParams() != null ?
systemOAuth2ClientsParams.getClientsDomainsParams().stream()
.filter(oAuth2ClientsDomainParams -> domainName.equals(oAuth2ClientsDomainParams.getDomainName()))
.findFirst()
.orElse(null)
: null;
result = mergeDomainParams(result, systemOAuth2ClientsDomainParams);
AdminSettings oauth2ClientsSettings = adminSettingsService.findAdminSettingsByKey(TenantId.SYS_TENANT_ID, constructAdminSettingsDomainKey(domainName));
if (oauth2ClientsSettings != null) {
String strEntityType = oauth2ClientsSettings.getJsonValue().get("entityType").asText();
String strEntityId = oauth2ClientsSettings.getJsonValue().get("entityId").asText();
EntityId entityId = EntityIdFactory.getByTypeAndId(strEntityType, strEntityId);
if (!entityId.getEntityType().equals(EntityType.TENANT)) {
log.error("Only tenant can configure OAuth2 for certain domain!");
throw new IllegalStateException("Only tenant can configure OAuth2 for certain domain!");
}
TenantId tenantId = (TenantId) entityId;
OAuth2ClientsParams tenantOAuth2ClientsParams = getTenantOAuth2ClientsParams(tenantId);
OAuth2ClientsDomainParams tenantDomainsParams = tenantOAuth2ClientsParams != null && tenantOAuth2ClientsParams.getClientsDomainsParams() != null ?
tenantOAuth2ClientsParams.getClientsDomainsParams().stream().findFirst().orElse(null) : null;
result = mergeDomainParams(result, tenantDomainsParams);
}
return result;
}
private OAuth2ClientsDomainParams mergeDomainParams(OAuth2ClientsDomainParams sourceParams, OAuth2ClientsDomainParams newParams) {
if (newParams == null) return sourceParams;
OAuth2ClientsDomainParams.OAuth2ClientsDomainParamsBuilder mergedParamsBuilder = sourceParams.toBuilder();
if (newParams.getClientRegistrations() != null) {
List<OAuth2ClientRegistration> mergedClientRegistrations = sourceParams.getClientRegistrations() != null ?
sourceParams.getClientRegistrations() : new ArrayList<>();
mergedClientRegistrations.addAll(newParams.getClientRegistrations());
mergedParamsBuilder.clientRegistrations(mergedClientRegistrations);
}
return mergedParamsBuilder.build();
}
private DataValidator<OAuth2ClientRegistration> clientRegistrationValidator =
new DataValidator<OAuth2ClientRegistration>() {
private OAuth2ClientsParams constructOAuth2ClientsParams(String json) {
OAuth2ClientsParams result = null;
if (!StringUtils.isEmpty(json)) {
try {
result = mapper.readValue(json, OAuth2ClientsParams.class);
} catch (IOException e) {
log.error("Unable to read OAuth2 Clients Params from JSON!", e);
throw new IncorrectParameterException("Unable to read OAuth2 Clients Params from JSON!");
}
}
if (result == null) {
result = new OAuth2ClientsParams();
}
return result;
}
@Override
protected void validateCreate(TenantId tenantId, OAuth2ClientRegistration clientRegistration) {
}
private String toJson(OAuth2ClientsParams oAuth2ClientsParams) {
String json;
try {
json = mapper.writeValueAsString(oAuth2ClientsParams);
} catch (JsonProcessingException e) {
log.error("Unable to convert OAuth2 Client Registration Params to JSON!", e);
throw new IncorrectParameterException("Unable to convert OAuth2 Client Registration Params to JSON!");
}
return json;
}
@Override
protected void validateUpdate(TenantId tenantId, OAuth2ClientRegistration clientRegistration) {
}
private final Consumer<OAuth2ClientRegistration> validator = clientRegistration -> {
if (StringUtils.isEmpty(clientRegistration.getRegistrationId())) {
throw new DataValidationException("Registration ID should be specified!");
}
if (StringUtils.isEmpty(clientRegistration.getClientId())) {
throw new DataValidationException("Client ID should be specified!");
}
if (StringUtils.isEmpty(clientRegistration.getClientSecret())) {
throw new DataValidationException("Client secret should be specified!");
}
if (StringUtils.isEmpty(clientRegistration.getAuthorizationUri())) {
throw new DataValidationException("Authorization uri should be specified!");
}
if (StringUtils.isEmpty(clientRegistration.getAccessTokenUri())) {
throw new DataValidationException("Token uri should be specified!");
}
if (StringUtils.isEmpty(clientRegistration.getScope())) {
throw new DataValidationException("Scope should be specified!");
}
if (StringUtils.isEmpty(clientRegistration.getUserInfoUri())) {
throw new DataValidationException("User info uri should be specified!");
}
if (StringUtils.isEmpty(clientRegistration.getUserNameAttributeName())) {
throw new DataValidationException("User name attribute name should be specified!");
}
if (StringUtils.isEmpty(clientRegistration.getJwkSetUri())) {
throw new DataValidationException("Jwk set uri should be specified!");
}
if (StringUtils.isEmpty(clientRegistration.getClientAuthenticationMethod())) {
throw new DataValidationException("Client authentication method should be specified!");
}
if (StringUtils.isEmpty(clientRegistration.getLoginButtonLabel())) {
throw new DataValidationException("Login button label should be specified!");
}
OAuth2MapperConfig mapperConfig = clientRegistration.getMapperConfig();
if (mapperConfig == null) {
throw new DataValidationException("Mapper config should be specified!");
}
if (mapperConfig.getType() == null) {
throw new DataValidationException("Mapper config type should be specified!");
}
if (mapperConfig.getType() == MapperType.BASIC) {
OAuth2BasicMapperConfig basicConfig = mapperConfig.getBasic();
if (basicConfig == null) {
throw new DataValidationException("Basic config should be specified!");
}
if (StringUtils.isEmpty(basicConfig.getEmailAttributeKey())) {
throw new DataValidationException("Email attribute key should be specified!");
}
if (basicConfig.getTenantNameStrategy() == null) {
throw new DataValidationException("Tenant name strategy should be specified!");
}
if (basicConfig.getTenantNameStrategy() == TenantNameStrategyType.CUSTOM
&& StringUtils.isEmpty(basicConfig.getTenantNamePattern())) {
throw new DataValidationException("Tenant name pattern should be specified!");
}
}
if (mapperConfig.getType() == MapperType.CUSTOM) {
OAuth2CustomMapperConfig customConfig = mapperConfig.getCustom();
if (customConfig == null) {
throw new DataValidationException("Custom config should be specified!");
}
if (StringUtils.isEmpty(customConfig.getUrl())) {
throw new DataValidationException("Custom mapper URL should be specified!");
}
}
};
@Override
protected void validateDataImpl(TenantId tenantId, OAuth2ClientRegistration clientRegistration) {
if (StringUtils.isEmpty(clientRegistration.getRegistrationId())) {
throw new DataValidationException("Registration ID should be specified!");
}
if (StringUtils.isEmpty(clientRegistration.getDomainName())) {
throw new DataValidationException("Domain name should be specified!");
}
if (StringUtils.isEmpty(clientRegistration.getRedirectUriTemplate())) {
throw new DataValidationException("Redirect URI template should be specified!");
}
if (StringUtils.isEmpty(clientRegistration.getClientId())) {
throw new DataValidationException("Client ID should be specified!");
}
if (StringUtils.isEmpty(clientRegistration.getClientSecret())) {
throw new DataValidationException("Client secret should be specified!");
}
if (StringUtils.isEmpty(clientRegistration.getAuthorizationUri())) {
throw new DataValidationException("Authorization uri should be specified!");
}
if (StringUtils.isEmpty(clientRegistration.getAccessTokenUri())) {
throw new DataValidationException("Token uri should be specified!");
}
if (StringUtils.isEmpty(clientRegistration.getScope())) {
throw new DataValidationException("Scope should be specified!");
}
if (StringUtils.isEmpty(clientRegistration.getUserInfoUri())) {
throw new DataValidationException("User info uri should be specified!");
}
if (StringUtils.isEmpty(clientRegistration.getUserNameAttributeName())) {
throw new DataValidationException("User name attribute name should be specified!");
}
if (StringUtils.isEmpty(clientRegistration.getJwkSetUri())) {
throw new DataValidationException("Jwk set uri should be specified!");
}
if (StringUtils.isEmpty(clientRegistration.getClientAuthenticationMethod())) {
throw new DataValidationException("Client authentication method should be specified!");
}
if (StringUtils.isEmpty(clientRegistration.getLoginButtonLabel())) {
throw new DataValidationException("Login button label should be specified!");
}
OAuth2MapperConfig mapperConfig = clientRegistration.getMapperConfig();
if (mapperConfig == null) {
throw new DataValidationException("Mapper config should be specified!");
}
if (mapperConfig.getType() == null) {
throw new DataValidationException("Mapper config type should be specified!");
}
if (mapperConfig.getType() == MapperType.BASIC) {
OAuth2BasicMapperConfig basicConfig = mapperConfig.getBasic();
if (basicConfig == null) {
throw new DataValidationException("Basic config should be specified!");
}
if (StringUtils.isEmpty(basicConfig.getEmailAttributeKey())) {
throw new DataValidationException("Email attribute key should be specified!");
}
if (basicConfig.getTenantNameStrategy() == null) {
throw new DataValidationException("Tenant name strategy should be specified!");
}
if (basicConfig.getTenantNameStrategy() == TenantNameStrategyType.CUSTOM
&& StringUtils.isEmpty(basicConfig.getTenantNamePattern())) {
throw new DataValidationException("Tenant name pattern should be specified!");
}
}
if (mapperConfig.getType() == MapperType.CUSTOM) {
OAuth2CustomMapperConfig customConfig = mapperConfig.getCustom();
if (customConfig == null) {
throw new DataValidationException("Custom config should be specified!");
}
if (StringUtils.isEmpty(customConfig.getUrl())) {
throw new DataValidationException("Custom mapper URL should be specified!");
}
}
if (clientRegistration.getTenantId() == null) {
throw new DataValidationException("Client registration should be assigned to tenant!");
} else if (!TenantId.SYS_TENANT_ID.equals(clientRegistration.getTenantId())) {
Tenant tenant = tenantService.findTenantById(clientRegistration.getTenantId());
if (tenant == null) {
throw new DataValidationException("Client registration is referencing to non-existent tenant!");
}
}
}
};
}

18
dao/src/main/java/org/thingsboard/server/dao/oauth2/OAuth2Utils.java

@ -23,22 +23,9 @@ import org.thingsboard.server.common.data.oauth2.OAuth2ClientsParams;
import java.util.stream.Stream;
public class OAuth2Utils {
public static final String OAUTH2_CLIENT_REGISTRATIONS_PARAMS = "oauth2ClientRegistrationsParams";
public static final String OAUTH2_CLIENT_REGISTRATIONS_DOMAIN_NAME_PREFIX = "oauth2ClientRegistrationsDomainNamePrefix";
public static final String ALLOW_OAUTH2_CONFIGURATION = "allowOAuth2Configuration";
public static final String SYSTEM_SETTINGS_OAUTH2_VALUE = "value";
public static final String OAUTH2_AUTHORIZATION_PATH_TEMPLATE = "/oauth2/authorization/%s";
public static String constructAdminSettingsDomainKey(String domainName) {
String clientRegistrationsKey;
if (StringUtils.isEmpty(domainName)) {
clientRegistrationsKey = OAUTH2_CLIENT_REGISTRATIONS_PARAMS;
} else {
clientRegistrationsKey = OAUTH2_CLIENT_REGISTRATIONS_DOMAIN_NAME_PREFIX + "_" + domainName;
}
return clientRegistrationsKey;
}
public static OAuth2ClientInfo toClientInfo(OAuth2ClientRegistration clientRegistration) {
OAuth2ClientInfo client = new OAuth2ClientInfo();
client.setName(clientRegistration.getLoginButtonLabel());
@ -46,9 +33,4 @@ public class OAuth2Utils {
client.setIcon(clientRegistration.getLoginButtonIcon());
return client;
}
public static Stream<OAuth2ClientRegistration> toClientRegistrationStream(OAuth2ClientsParams oAuth2ClientsParams) {
return oAuth2ClientsParams.getClientsDomainsParams().stream()
.flatMap(oAuth2ClientsDomainParams -> oAuth2ClientsDomainParams.getClientRegistrations().stream());
}
}

86
dao/src/main/java/org/thingsboard/server/dao/sql/oauth2/JpaOAuth2ClientRegistrationDao.java

@ -0,0 +1,86 @@
/**
* Copyright © 2016-2020 The Thingsboard Authors
*
* Licensed 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.thingsboard.server.dao.sql.oauth2;
import lombok.RequiredArgsConstructor;
import org.springframework.data.repository.CrudRepository;
import org.springframework.stereotype.Component;
import org.thingsboard.server.common.data.oauth2.OAuth2ClientRegistration;
import org.thingsboard.server.dao.DaoUtil;
import org.thingsboard.server.dao.model.sql.OAuth2ClientRegistrationEntity;
import org.thingsboard.server.dao.oauth2.OAuth2ClientRegistrationDao;
import org.thingsboard.server.dao.sql.JpaAbstractDao;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
import java.util.UUID;
import java.util.stream.Collectors;
@Component
@RequiredArgsConstructor
public class JpaOAuth2ClientRegistrationDao extends JpaAbstractDao<OAuth2ClientRegistrationEntity, OAuth2ClientRegistration> implements OAuth2ClientRegistrationDao {
private final OAuth2ClientRegistrationRepository repository;
@Override
protected Class<OAuth2ClientRegistrationEntity> getEntityClass() {
return OAuth2ClientRegistrationEntity.class;
}
@Override
protected CrudRepository<OAuth2ClientRegistrationEntity, UUID> getCrudRepository() {
return repository;
}
@Override
public OAuth2ClientRegistration findByRegistrationId(String registrationId) {
Optional<OAuth2ClientRegistrationEntity> entity = repository.findByRegistrationId(registrationId);
return DaoUtil.getData(entity);
}
@Override
public List<OAuth2ClientRegistration> findAll() {
Iterable<OAuth2ClientRegistrationEntity> entities = repository.findAll();
List<OAuth2ClientRegistration> result = new ArrayList<>();
entities.forEach(entity -> {
result.add(DaoUtil.getData(entity));
});
return result;
}
@Override
public List<OAuth2ClientRegistration> findByTenantId(UUID tenantId) {
List<OAuth2ClientRegistrationEntity> entities = repository.findAllByTenantId(tenantId);
return entities.stream().map(DaoUtil::getData).collect(Collectors.toList());
}
@Override
public List<OAuth2ClientRegistration> findByDomainName(String domainName) {
List<OAuth2ClientRegistrationEntity> entities = repository.findAllByDomainName(domainName);
return entities.stream().map(DaoUtil::getData).collect(Collectors.toList());
}
@Override
public boolean removeByRegistrationId(String registrationId) {
repository.deleteByRegistrationId(registrationId);
return !repository.existsByRegistrationId(registrationId);
}
@Override
public int removeByTenantId(UUID tenantId) {
return repository.deleteByTenantId(tenantId);
}
}

37
dao/src/main/java/org/thingsboard/server/dao/sql/oauth2/OAuth2ClientRegistrationRepository.java

@ -0,0 +1,37 @@
/**
* Copyright © 2016-2020 The Thingsboard Authors
*
* Licensed 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.thingsboard.server.dao.sql.oauth2;
import org.springframework.data.repository.CrudRepository;
import org.thingsboard.server.dao.model.sql.OAuth2ClientRegistrationEntity;
import java.util.List;
import java.util.Optional;
import java.util.UUID;
public interface OAuth2ClientRegistrationRepository extends CrudRepository<OAuth2ClientRegistrationEntity, UUID> {
Optional<OAuth2ClientRegistrationEntity> findByRegistrationId(String registrationId);
List<OAuth2ClientRegistrationEntity> findAllByTenantId(UUID tenantId);
List<OAuth2ClientRegistrationEntity> findAllByDomainName(String domainName);
int deleteByRegistrationId(String registrationId);
int deleteByTenantId(UUID tenantId);
boolean existsByRegistrationId(String registrationId);
}

2
dao/src/main/java/org/thingsboard/server/dao/tenant/TenantServiceImpl.java

@ -105,7 +105,7 @@ public class TenantServiceImpl extends AbstractEntityService implements TenantSe
public void deleteTenant(TenantId tenantId) {
log.trace("Executing deleteTenant [{}]", tenantId);
Validator.validateId(tenantId, INCORRECT_TENANT_ID + tenantId);
oAuth2Service.deleteTenantOAuth2ClientsParams(tenantId);
oAuth2Service.deleteClientRegistrationsByTenantId(tenantId);
customerService.deleteCustomersByTenantId(tenantId);
widgetsBundleService.deleteWidgetsBundlesByTenantId(tenantId);
dashboardService.deleteDashboardsByTenantId(tenantId);

37
dao/src/main/resources/sql/schema-entities-hsql.sql

@ -289,3 +289,40 @@ CREATE TABLE IF NOT EXISTS ts_kv_dictionary (
key_id int GENERATED BY DEFAULT AS IDENTITY(start with 0 increment by 1) UNIQUE,
CONSTRAINT ts_key_id_pkey PRIMARY KEY (key)
);
CREATE TABLE IF NOT EXISTS oauth2_client_registration (
id uuid NOT NULL CONSTRAINT oauth2_client_registration_pkey PRIMARY KEY,
created_time bigint NOT NULL,
additional_info varchar,
tenant_id uuid,
registration_id varchar(255),
domain_name varchar(255),
client_id varchar(255),
client_secret varchar(255),
authorization_uri varchar(255),
token_uri varchar(255),
redirect_uri_template varchar(255),
scope varchar(255),
user_info_uri varchar(255),
user_name_attribute_name varchar(255),
jwk_set_uri varchar(255),
client_authentication_method varchar(255),
login_button_label varchar(255),
login_button_icon varchar(255),
allow_user_creation boolean,
activate_user boolean,
type varchar(31),
basic_email_attribute_key varchar(31),
basic_first_name_attribute_key varchar(31),
basic_last_name_attribute_key varchar(31),
basic_tenant_name_strategy varchar(31),
basic_tenant_name_pattern varchar(255),
basic_customer_name_pattern varchar(255),
basic_default_dashboard_name varchar(255),
basic_always_full_screen boolean,
custom_url varchar(255),
custom_username varchar(255),
custom_password varchar(255),
CONSTRAINT oauth2_registration_id_unq_key UNIQUE (registration_id)
);

36
dao/src/main/resources/sql/schema-entities.sql

@ -306,6 +306,42 @@ CREATE TABLE IF NOT EXISTS ts_kv_dictionary
CONSTRAINT ts_key_id_pkey PRIMARY KEY (key)
);
CREATE TABLE IF NOT EXISTS oauth2_client_registration (
id uuid NOT NULL CONSTRAINT oauth2_client_registration_pkey PRIMARY KEY,
created_time bigint NOT NULL,
additional_info varchar,
tenant_id uuid,
registration_id varchar(255),
domain_name varchar(255),
client_id varchar(255),
client_secret varchar(255),
authorization_uri varchar(255),
token_uri varchar(255),
redirect_uri_template varchar(255),
scope varchar(255),
user_info_uri varchar(255),
user_name_attribute_name varchar(255),
jwk_set_uri varchar(255),
client_authentication_method varchar(255),
login_button_label varchar(255),
login_button_icon varchar(255),
allow_user_creation boolean,
activate_user boolean,
type varchar(31),
basic_email_attribute_key varchar(31),
basic_first_name_attribute_key varchar(31),
basic_last_name_attribute_key varchar(31),
basic_tenant_name_strategy varchar(31),
basic_tenant_name_pattern varchar(255),
basic_customer_name_pattern varchar(255),
basic_default_dashboard_name varchar(255),
basic_always_full_screen boolean,
custom_url varchar(255),
custom_username varchar(255),
custom_password varchar(255),
CONSTRAINT oauth2_registration_id_unq_key UNIQUE (registration_id)
);
CREATE OR REPLACE PROCEDURE cleanup_events_by_ttl(IN ttl bigint, IN debug_ttl bigint, INOUT deleted bigint)
LANGUAGE plpgsql AS
$$

471
dao/src/test/java/org/thingsboard/server/dao/service/BaseOAuth2ServiceTest.java

@ -23,6 +23,7 @@ import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.thingsboard.server.common.data.DataConstants;
import org.thingsboard.server.common.data.Tenant;
import org.thingsboard.server.common.data.id.OAuth2ClientRegistrationId;
import org.thingsboard.server.common.data.id.TenantId;
import org.thingsboard.server.common.data.oauth2.*;
import org.thingsboard.server.dao.attributes.AttributesService;
@ -30,6 +31,7 @@ import org.thingsboard.server.dao.exception.DataValidationException;
import org.thingsboard.server.dao.oauth2.OAuth2Service;
import org.thingsboard.server.dao.oauth2.OAuth2Utils;
import javax.transaction.Transactional;
import java.io.IOException;
import java.util.*;
import java.util.stream.Collectors;
@ -55,24 +57,15 @@ public class BaseOAuth2ServiceTest extends AbstractServiceTest {
Assert.assertNotNull(savedTenant);
tenantId = savedTenant.getId();
Assert.assertNull(oAuth2Service.getSystemOAuth2ClientsParams().getClientsDomainsParams());
Assert.assertNull(oAuth2Service.getTenantOAuth2ClientsParams(tenantId).getClientsDomainsParams());
Assert.assertTrue(attributesService.findAll(tenantId, tenantId, DataConstants.SERVER_SCOPE).get().isEmpty());
Assert.assertNull(adminSettingsService.findAdminSettingsByKey(TenantId.SYS_TENANT_ID, OAuth2Utils.OAUTH2_CLIENT_REGISTRATIONS_PARAMS));
Assert.assertTrue(oAuth2Service.findAllClientRegistrations().isEmpty());
}
@After
public void after() throws Exception {
clearSysAdmin();
tenantService.deleteTenant(tenantId);
oAuth2Service.deleteClientRegistrationsByTenantId(TenantId.SYS_TENANT_ID);
Assert.assertNull(oAuth2Service.getSystemOAuth2ClientsParams().getClientsDomainsParams());
Assert.assertNull(oAuth2Service.getTenantOAuth2ClientsParams(tenantId).getClientsDomainsParams());
Assert.assertTrue(attributesService.findAll(tenantId, tenantId, DataConstants.SERVER_SCOPE).get().isEmpty());
Assert.assertNull(adminSettingsService.findAdminSettingsByKey(TenantId.SYS_TENANT_ID, OAuth2Utils.OAUTH2_CLIENT_REGISTRATIONS_PARAMS));
Assert.assertTrue(oAuth2Service.findAllClientRegistrations().isEmpty());
}
@Test
@ -93,226 +86,107 @@ public class BaseOAuth2ServiceTest extends AbstractServiceTest {
Assert.assertTrue(oAuth2Service.isOAuth2ClientRegistrationAllowed(tenantId));
}
@Test
public void testSaveSystemOAuth2() throws IOException {
updateTenantAllowOAuth2Setting(true);
Assert.assertTrue(oAuth2Service.isOAuth2ClientRegistrationAllowed(tenantId));
}
@Test(expected = DataValidationException.class)
public void testSaveSystemParamsWithDuplicateDomains() {
oAuth2Service.saveSystemOAuth2ClientsParams(clientsParamsWithDuplicateDomains());
}
@Test(expected = DataValidationException.class)
public void testSaveSystemParamsWithDuplicateRegistrationIds() {
oAuth2Service.saveSystemOAuth2ClientsParams(clientsParamsWithDuplicateRegistrationIds());
}
@Test(expected = DataValidationException.class)
public void testSaveTenantParamsWithDuplicateRegistrationIds() {
oAuth2Service.saveTenantOAuth2ClientsParams(tenantId, clientsParamsWithDuplicateRegistrationIds());
}
@Test
public void testSaveSystemParams() {
OAuth2ClientsParams clientsParams = validClientsParams();
OAuth2ClientsParams savedClientParams = oAuth2Service.saveSystemOAuth2ClientsParams(clientsParams);
Assert.assertNotNull(adminSettingsService.findAdminSettingsByKey(TenantId.SYS_TENANT_ID, OAuth2Utils.OAUTH2_CLIENT_REGISTRATIONS_PARAMS));
Assert.assertEquals(clientsParams, savedClientParams);
}
@Test
public void testSaveSystemParamsWithMultipleDomains() {
OAuth2ClientsParams clientsParams = validClientsParamsWithThreeDomains();
OAuth2ClientsParams savedClientParams = oAuth2Service.saveSystemOAuth2ClientsParams(clientsParams);
public void testSaveDuplicateRegistrationId() {
OAuth2ClientRegistration first = validClientRegistration("duplicated_reg_id", TenantId.SYS_TENANT_ID);
OAuth2ClientRegistration second = validClientRegistration("duplicated_reg_id", tenantId);
Assert.assertNotNull(adminSettingsService.findAdminSettingsByKey(TenantId.SYS_TENANT_ID, OAuth2Utils.OAUTH2_CLIENT_REGISTRATIONS_PARAMS));
Assert.assertEquals(clientsParams, savedClientParams);
oAuth2Service.saveClientRegistration(first);
oAuth2Service.saveClientRegistration(second);
}
@Test
public void testFindSystemParams() {
OAuth2ClientsParams clientsParams = validClientsParams();
oAuth2Service.saveSystemOAuth2ClientsParams(clientsParams);
Assert.assertNotNull(adminSettingsService.findAdminSettingsByKey(TenantId.SYS_TENANT_ID, OAuth2Utils.OAUTH2_CLIENT_REGISTRATIONS_PARAMS));
OAuth2ClientsParams foundClientParams = oAuth2Service.getSystemOAuth2ClientsParams();
Assert.assertNotNull(foundClientParams);
Assert.assertEquals(clientsParams, foundClientParams);
}
@Test
public void testSaveTenantParams() {
OAuth2ClientsParams clientsParams = validClientsParams();
OAuth2ClientsDomainParams domainParams = clientsParams.getClientsDomainsParams().get(0);
String domainKey = OAuth2Utils.constructAdminSettingsDomainKey(domainParams.getDomainName());
Assert.assertNull(adminSettingsService.findAdminSettingsByKey(tenantId, domainKey));
OAuth2ClientsParams savedClientParams = oAuth2Service.saveTenantOAuth2ClientsParams(tenantId, clientsParams);
Assert.assertNotNull(adminSettingsService.findAdminSettingsByKey(tenantId, domainKey));
Assert.assertNotNull(savedClientParams);
OAuth2ClientsDomainParams savedDomainParams = savedClientParams.getClientsDomainsParams().get(0);
Assert.assertEquals(domainParams.getDomainName(), savedDomainParams.getDomainName());
Assert.assertEquals(domainParams.getClientRegistrations(), savedDomainParams.getClientRegistrations());
public void testCreateNewSystemParams() {
OAuth2ClientRegistration clientRegistration = validClientRegistration(UUID.randomUUID().toString(), TenantId.SYS_TENANT_ID);
OAuth2ClientRegistration savedClientRegistration = oAuth2Service.saveClientRegistration(clientRegistration);
Assert.assertNotNull(savedClientRegistration);
Assert.assertNotNull(savedClientRegistration.getId());
clientRegistration.setId(savedClientRegistration.getId());
clientRegistration.setCreatedTime(savedClientRegistration.getCreatedTime());
Assert.assertEquals(clientRegistration, savedClientRegistration);
}
@Test
public void testSaveTenantMultipleParams() {
OAuth2ClientsParams clientsParams = validClientsParamsWithThreeDomains();
clientsParams.getClientsDomainsParams().forEach(oAuth2ClientsDomainParams -> {
String domainName = oAuth2ClientsDomainParams.getDomainName();
String domainKey = OAuth2Utils.constructAdminSettingsDomainKey(domainName);
Assert.assertNull(adminSettingsService.findAdminSettingsByKey(tenantId, domainKey));
});
OAuth2ClientsParams savedClientParams = oAuth2Service.saveTenantOAuth2ClientsParams(tenantId, clientsParams);
Assert.assertNotNull(savedClientParams);
clientsParams.getClientsDomainsParams().forEach(oAuth2ClientsDomainParams -> {
String domainName = oAuth2ClientsDomainParams.getDomainName();
String domainKey = OAuth2Utils.constructAdminSettingsDomainKey(domainName);
Assert.assertNotNull(adminSettingsService.findAdminSettingsByKey(tenantId, domainKey));
});
Assert.assertEquals(clientsParams, savedClientParams);
public void testFindSystemParamsByTenant() {
OAuth2ClientRegistration clientRegistration = validClientRegistration(UUID.randomUUID().toString(), TenantId.SYS_TENANT_ID);
oAuth2Service.saveClientRegistration(clientRegistration);
List<OAuth2ClientRegistration> clientRegistrationsByTenantId = oAuth2Service.findClientRegistrationsByTenantId(TenantId.SYS_TENANT_ID);
Assert.assertEquals(1, clientRegistrationsByTenantId.size());
Assert.assertEquals(1, oAuth2Service.findAllClientRegistrations().size());
OAuth2ClientRegistration foundClientRegistration = clientRegistrationsByTenantId.get(0);
Assert.assertNotNull(foundClientRegistration);
clientRegistration.setId(foundClientRegistration.getId());
clientRegistration.setCreatedTime(foundClientRegistration.getCreatedTime());
Assert.assertEquals(clientRegistration, foundClientRegistration);
}
@Test
public void testRewriteSameDomainTenantParams() {
OAuth2ClientsParams clientsParams = validClientsParamsWithThreeDomains();
oAuth2Service.saveTenantOAuth2ClientsParams(tenantId, clientsParams);
List<OAuth2ClientsDomainParams> clientsDomainsParams = clientsParams.getClientsDomainsParams();
OAuth2ClientsParams updatedClientsParams = validClientsParamsWithThreeDomains();
String sameDomainName = clientsDomainsParams.get(0).getDomainName();
updatedClientsParams.getClientsDomainsParams().get(0).setDomainName(sameDomainName);
OAuth2ClientsParams rewrittenClientParams = oAuth2Service.saveTenantOAuth2ClientsParams(tenantId, updatedClientsParams);
Assert.assertEquals(updatedClientsParams, rewrittenClientParams);
clientsParams.getClientsDomainsParams().forEach(oAuth2ClientsDomainParams -> {
String domainName = oAuth2ClientsDomainParams.getDomainName();
String domainKey = OAuth2Utils.constructAdminSettingsDomainKey(domainName);
if (domainName.equals(sameDomainName)) {
Assert.assertNotNull(adminSettingsService.findAdminSettingsByKey(tenantId, domainKey));
} else {
Assert.assertNull(adminSettingsService.findAdminSettingsByKey(tenantId, domainKey));
}
});
updatedClientsParams.getClientsDomainsParams().forEach(oAuth2ClientsDomainParams -> {
String domainName = oAuth2ClientsDomainParams.getDomainName();
String domainKey = OAuth2Utils.constructAdminSettingsDomainKey(domainName);
Assert.assertNotNull(adminSettingsService.findAdminSettingsByKey(tenantId, domainKey));
});
public void testCreateNewTenantParams() {
OAuth2ClientRegistration clientRegistration = validClientRegistration(UUID.randomUUID().toString(), tenantId);
OAuth2ClientRegistration savedClientRegistration = oAuth2Service.saveClientRegistration(clientRegistration);
Assert.assertNotNull(savedClientRegistration);
Assert.assertNotNull(savedClientRegistration.getId());
clientRegistration.setId(savedClientRegistration.getId());
clientRegistration.setCreatedTime(savedClientRegistration.getCreatedTime());
Assert.assertEquals(clientRegistration, savedClientRegistration);
}
@Test
public void testAddDeleteTenantDomainParams() {
OAuth2ClientsParams clientsParams = validClientsParamsWithThreeDomains();
oAuth2Service.saveTenantOAuth2ClientsParams(tenantId, clientsParams);
List<OAuth2ClientsDomainParams> clientsDomainsParams = clientsParams.getClientsDomainsParams();
OAuth2ClientsParams updatedClientsParams = validClientsParamsWithThreeDomains();
for (int i = 0; i < updatedClientsParams.getClientsDomainsParams().size(); i++) {
String domainName = clientsDomainsParams.get(i).getDomainName();
updatedClientsParams.getClientsDomainsParams().get(i).setDomainName(domainName);
}
OAuth2ClientsParams rewrittenClientParams = oAuth2Service.saveTenantOAuth2ClientsParams(tenantId, updatedClientsParams);
Assert.assertEquals(updatedClientsParams, rewrittenClientParams);
clientsParams.getClientsDomainsParams().forEach(oAuth2ClientsDomainParams -> {
String domainName = oAuth2ClientsDomainParams.getDomainName();
String domainKey = OAuth2Utils.constructAdminSettingsDomainKey(domainName);
Assert.assertNotNull(adminSettingsService.findAdminSettingsByKey(tenantId, domainKey));
});
public void testFindTenantParams() {
OAuth2ClientRegistration clientRegistration = validClientRegistration(UUID.randomUUID().toString(), tenantId);
oAuth2Service.saveClientRegistration(clientRegistration);
List<OAuth2ClientRegistration> clientRegistrationsByTenantId = oAuth2Service.findClientRegistrationsByTenantId(tenantId);
Assert.assertEquals(1, clientRegistrationsByTenantId.size());
Assert.assertEquals(1, oAuth2Service.findAllClientRegistrations().size());
OAuth2ClientRegistration foundClientRegistration = clientRegistrationsByTenantId.get(0);
Assert.assertNotNull(foundClientRegistration);
clientRegistration.setId(foundClientRegistration.getId());
clientRegistration.setCreatedTime(foundClientRegistration.getCreatedTime());
Assert.assertEquals(clientRegistration, foundClientRegistration);
}
@Test
public void testFindTenantParams() {
OAuth2ClientsParams clientsParams = validClientsParams();
OAuth2ClientsDomainParams domainParams = clientsParams.getClientsDomainsParams().get(0);
String domainKey = OAuth2Utils.constructAdminSettingsDomainKey(domainParams.getDomainName());
public void testGetClientRegistrationWithTenant() {
OAuth2ClientRegistration tenantClientRegistration = validClientRegistration(UUID.randomUUID().toString(), tenantId);
OAuth2ClientRegistration sysAdminClientRegistration = validClientRegistration(UUID.randomUUID().toString(), TenantId.SYS_TENANT_ID);
Assert.assertNull(adminSettingsService.findAdminSettingsByKey(tenantId, domainKey));
OAuth2ClientRegistration savedTenantClientRegistration = oAuth2Service.saveClientRegistration(tenantClientRegistration);
OAuth2ClientRegistration savedSysAdminClientRegistration = oAuth2Service.saveClientRegistration(sysAdminClientRegistration);
OAuth2ClientsParams savedClientsParams = oAuth2Service.saveTenantOAuth2ClientsParams(tenantId, clientsParams);
Assert.assertEquals(2, oAuth2Service.findAllClientRegistrations().size());
Assert.assertNotNull(adminSettingsService.findAdminSettingsByKey(tenantId, domainKey));
Assert.assertEquals(savedTenantClientRegistration, oAuth2Service.findClientRegistrationsByTenantId(tenantId).get(0));
Assert.assertEquals(savedSysAdminClientRegistration, oAuth2Service.findClientRegistrationsByTenantId(TenantId.SYS_TENANT_ID).get(0));
OAuth2ClientsParams foundClientsParams = oAuth2Service.getTenantOAuth2ClientsParams(tenantId);
Assert.assertEquals(savedClientsParams, foundClientsParams);
}
Assert.assertEquals(savedTenantClientRegistration,
oAuth2Service.findClientRegistrationByRegistrationId(savedTenantClientRegistration.getRegistrationId()));
Assert.assertEquals(savedSysAdminClientRegistration,
oAuth2Service.findClientRegistrationByRegistrationId(savedSysAdminClientRegistration.getRegistrationId()));
@Test
public void testGetClientRegistrationWithTenant() {
OAuth2ClientsParams tenantClientsParams = validClientsParams();
OAuth2ClientsParams sysAdminClientsParams = validClientsParams();
oAuth2Service.saveTenantOAuth2ClientsParams(tenantId, tenantClientsParams);
oAuth2Service.saveSystemOAuth2ClientsParams(sysAdminClientsParams);
OAuth2Utils.toClientRegistrationStream(tenantClientsParams)
.forEach(clientRegistration -> {
Pair<TenantId, OAuth2ClientRegistration> pair = oAuth2Service.getClientRegistrationWithTenant(clientRegistration.getRegistrationId());
Assert.assertEquals(tenantId, pair.getKey());
Assert.assertEquals(clientRegistration.getRegistrationId(), pair.getValue().getRegistrationId());
});
OAuth2Utils.toClientRegistrationStream(sysAdminClientsParams)
.forEach(clientRegistration -> {
Pair<TenantId, OAuth2ClientRegistration> pair = oAuth2Service.getClientRegistrationWithTenant(clientRegistration.getRegistrationId());
Assert.assertNotNull(pair);
Assert.assertEquals(TenantId.SYS_TENANT_ID, pair.getKey());
Assert.assertEquals(clientRegistration.getRegistrationId(), pair.getValue().getRegistrationId());
});
}
@Test
public void testGetExtendedClientRegistration() {
OAuth2ClientsParams tenantClientsParams = validClientsParams();
OAuth2ClientsParams sysAdminClientsParams = validClientsParams();
oAuth2Service.saveTenantOAuth2ClientsParams(tenantId, tenantClientsParams);
oAuth2Service.saveSystemOAuth2ClientsParams(sysAdminClientsParams);
Stream.concat(
OAuth2Utils.toClientRegistrationStream(tenantClientsParams),
OAuth2Utils.toClientRegistrationStream(sysAdminClientsParams)
)
.forEach(clientRegistration -> {
ExtendedOAuth2ClientRegistration foundExtendedClientRegistration = oAuth2Service.getExtendedClientRegistration(clientRegistration.getRegistrationId());
Assert.assertNotNull(foundExtendedClientRegistration);
Assert.assertEquals(clientRegistration, foundExtendedClientRegistration.getClientRegistration());
});
Assert.assertEquals(savedTenantClientRegistration,
oAuth2Service.findClientRegistrationById(tenantId, savedTenantClientRegistration.getId()));
Assert.assertEquals(savedSysAdminClientRegistration,
oAuth2Service.findClientRegistrationById(TenantId.SYS_TENANT_ID, savedSysAdminClientRegistration.getId()));
}
@Test
public void testGetOAuth2Clients() {
OAuth2ClientsParams tenantClientsParams = validClientsParams();
OAuth2ClientsParams sysAdminClientsParams = validClientsParams();
OAuth2ClientsDomainParams tenantDomainParams = tenantClientsParams.getClientsDomainsParams().get(0);
OAuth2ClientsDomainParams systemDomainParams = sysAdminClientsParams.getClientsDomainsParams().get(0);
systemDomainParams.setDomainName(tenantDomainParams.getDomainName());
String testDomainName = "test_domain";
OAuth2ClientRegistration tenantClientRegistration = validClientRegistration(testDomainName, UUID.randomUUID().toString(), tenantId);
OAuth2ClientRegistration sysAdminClientRegistration = validClientRegistration(testDomainName, UUID.randomUUID().toString(), TenantId.SYS_TENANT_ID);
oAuth2Service.saveTenantOAuth2ClientsParams(tenantId, tenantClientsParams);
oAuth2Service.saveSystemOAuth2ClientsParams(sysAdminClientsParams);
oAuth2Service.saveClientRegistration(tenantClientRegistration);
oAuth2Service.saveClientRegistration(sysAdminClientRegistration);
List<OAuth2ClientInfo> oAuth2Clients = oAuth2Service.getOAuth2Clients(tenantDomainParams.getDomainName());
Set<String> actualLabels = Stream.concat(
tenantDomainParams.getClientRegistrations().stream()
.map(OAuth2ClientRegistration::getLoginButtonLabel),
systemDomainParams.getClientRegistrations().stream()
.map(OAuth2ClientRegistration::getLoginButtonLabel)
).collect(Collectors.toSet());
List<OAuth2ClientInfo> oAuth2Clients = oAuth2Service.getOAuth2Clients(testDomainName);
Set<String> actualLabels = new HashSet<>(Arrays.asList(tenantClientRegistration.getLoginButtonLabel(),
sysAdminClientRegistration.getLoginButtonLabel()));
Set<String> foundLabels = oAuth2Clients.stream().map(OAuth2ClientInfo::getName).collect(Collectors.toSet());
Assert.assertEquals(actualLabels, foundLabels);
@ -320,67 +194,39 @@ public class BaseOAuth2ServiceTest extends AbstractServiceTest {
@Test
public void testGetEmptyOAuth2Clients() {
String testDomainName = "test_domain";
OAuth2ClientRegistration tenantClientRegistration = validClientRegistration(testDomainName, UUID.randomUUID().toString(), tenantId);
OAuth2ClientRegistration sysAdminClientRegistration = validClientRegistration(testDomainName, UUID.randomUUID().toString(), TenantId.SYS_TENANT_ID);
oAuth2Service.saveClientRegistration(tenantClientRegistration);
oAuth2Service.saveClientRegistration(sysAdminClientRegistration);
List<OAuth2ClientInfo> oAuth2Clients = oAuth2Service.getOAuth2Clients("random-domain");
Assert.assertTrue(oAuth2Clients.isEmpty());
}
@Test
public void testGetAllOAuth2ClientsParams() {
OAuth2ClientsParams tenantClientsParams = validClientsParams();
OAuth2ClientsParams sysAdminClientsParams = validClientsParams();
Map<TenantId, OAuth2ClientsParams> emptyParams = oAuth2Service.getAllOAuth2ClientsParams();
Assert.assertTrue(emptyParams.isEmpty());
OAuth2ClientsParams savedTenantParams = oAuth2Service.saveTenantOAuth2ClientsParams(tenantId, tenantClientsParams);
OAuth2ClientsParams savedSystemParams = oAuth2Service.saveSystemOAuth2ClientsParams(sysAdminClientsParams);
Map<TenantId, OAuth2ClientsParams> clientsParams = oAuth2Service.getAllOAuth2ClientsParams();
OAuth2ClientsParams foundTenantParams = clientsParams.get(tenantId);
Assert.assertEquals(savedTenantParams, foundTenantParams);
OAuth2ClientsParams foundSystemParams = clientsParams.get(TenantId.SYS_TENANT_ID);
Assert.assertEquals(savedSystemParams, foundSystemParams);
}
@Test
public void testDeleteSystemOAuth2ClientsParams() {
OAuth2ClientsParams sysAdminClientsParams = validClientsParams();
Assert.assertNull(oAuth2Service.getSystemOAuth2ClientsParams().getClientsDomainsParams());
oAuth2Service.saveSystemOAuth2ClientsParams(sysAdminClientsParams);
Assert.assertNotNull(oAuth2Service.getSystemOAuth2ClientsParams().getClientsDomainsParams());
oAuth2Service.deleteSystemOAuth2ClientsParams();
Assert.assertNull(adminSettingsService.findAdminSettingsByKey(TenantId.SYS_TENANT_ID, OAuth2Utils.OAUTH2_CLIENT_REGISTRATIONS_PARAMS));
public void testDeleteOAuth2ClientRegistration() {
OAuth2ClientRegistration tenantClientRegistration = validClientRegistration(UUID.randomUUID().toString(), tenantId);
OAuth2ClientRegistration sysAdminClientRegistration = validClientRegistration(UUID.randomUUID().toString(), TenantId.SYS_TENANT_ID);
OAuth2ClientRegistration savedTenantRegistration = oAuth2Service.saveClientRegistration(tenantClientRegistration);
OAuth2ClientRegistration savedSysAdminRegistration = oAuth2Service.saveClientRegistration(sysAdminClientRegistration);
oAuth2Service.deleteClientRegistrationById(tenantId, savedTenantRegistration.getId());
List<OAuth2ClientRegistration> foundRegistrations = oAuth2Service.findAllClientRegistrations();
Assert.assertEquals(1, foundRegistrations.size());
Assert.assertEquals(savedSysAdminRegistration, foundRegistrations.get(0));
}
@Test
public void testDeleteTenantOAuth2ClientsParams() {
OAuth2ClientsParams tenantClientsParams = validClientsParams();
Assert.assertNull(oAuth2Service.getTenantOAuth2ClientsParams(tenantId).getClientsDomainsParams());
oAuth2Service.saveTenantOAuth2ClientsParams(tenantId, tenantClientsParams);
Assert.assertNotNull(oAuth2Service.getTenantOAuth2ClientsParams(tenantId).getClientsDomainsParams());
oAuth2Service.deleteTenantOAuth2ClientsParams(tenantId);
Assert.assertNull(oAuth2Service.getTenantOAuth2ClientsParams(tenantId).getClientsDomainsParams());
tenantClientsParams.getClientsDomainsParams().forEach(oAuth2ClientsDomainParams -> {
String domainName = oAuth2ClientsDomainParams.getDomainName();
String domainKey = OAuth2Utils.constructAdminSettingsDomainKey(domainName);
Assert.assertNull(adminSettingsService.findAdminSettingsByKey(tenantId, domainKey));
});
}
private void clearSysAdmin() {
oAuth2Service.deleteSystemOAuth2ClientsParams();
Assert.assertNull(adminSettingsService.findAdminSettingsByKey(TenantId.SYS_TENANT_ID, OAuth2Utils.OAUTH2_CLIENT_REGISTRATIONS_PARAMS));
public void testDeleteTenantOAuth2ClientRegistrations() {
oAuth2Service.saveClientRegistration(validClientRegistration(UUID.randomUUID().toString(), tenantId));
oAuth2Service.saveClientRegistration(validClientRegistration(UUID.randomUUID().toString(), tenantId));
oAuth2Service.saveClientRegistration(validClientRegistration(UUID.randomUUID().toString(), tenantId));
Assert.assertEquals(3, oAuth2Service.findAllClientRegistrations().size());
Assert.assertEquals(3, oAuth2Service.findClientRegistrationsByTenantId(tenantId).size());
oAuth2Service.deleteClientRegistrationsByTenantId(tenantId);
Assert.assertEquals(0, oAuth2Service.findAllClientRegistrations().size());
Assert.assertEquals(0, oAuth2Service.findClientRegistrationsByTenantId(tenantId).size());
}
private void updateTenantAllowOAuth2Setting(Boolean allowOAuth2) throws IOException {
@ -394,87 +240,17 @@ public class BaseOAuth2ServiceTest extends AbstractServiceTest {
}
}
private OAuth2ClientsParams validClientsParams() {
OAuth2ClientRegistration first = validClientRegistration();
OAuth2ClientRegistration second = validClientRegistration();
return OAuth2ClientsParams.builder()
.clientsDomainsParams(Collections.singletonList(
OAuth2ClientsDomainParams.builder()
.domainName(UUID.randomUUID().toString())
.redirectUriTemplate("http://localhost:8080/login/oauth2/code/")
.clientRegistrations(Arrays.asList(first, second))
.build()
))
.build();
}
private OAuth2ClientsParams validClientsParamsWithThreeDomains() {
OAuth2ClientRegistration first = validClientRegistration();
OAuth2ClientRegistration second = validClientRegistration();
OAuth2ClientRegistration third = validClientRegistration();
return OAuth2ClientsParams.builder()
.clientsDomainsParams(Arrays.asList(
OAuth2ClientsDomainParams.builder()
.domainName(UUID.randomUUID().toString())
.redirectUriTemplate("http://localhost:8080/login/oauth2/code/")
.clientRegistrations(Arrays.asList(first, second))
.build(),
OAuth2ClientsDomainParams.builder()
.domainName(UUID.randomUUID().toString())
.redirectUriTemplate("http://localhost:8080/login/oauth2/code/")
.clientRegistrations(Arrays.asList(third))
.build()
))
.build();
}
private OAuth2ClientsParams clientsParamsWithDuplicateDomains() {
OAuth2ClientRegistration first = validClientRegistration();
OAuth2ClientRegistration second = validClientRegistration();
OAuth2ClientRegistration third = validClientRegistration();
return OAuth2ClientsParams.builder()
.clientsDomainsParams(Arrays.asList(
OAuth2ClientsDomainParams.builder()
.domainName("domain")
.redirectUriTemplate("http://localhost:8080/login/oauth2/code/")
.clientRegistrations(Collections.singletonList(first))
.build(),
OAuth2ClientsDomainParams.builder()
.domainName("domain")
.redirectUriTemplate("http://localhost:8080/login/oauth2/code/")
.clientRegistrations(Collections.singletonList(second))
.build(),
OAuth2ClientsDomainParams.builder()
.domainName(UUID.randomUUID().toString())
.redirectUriTemplate("http://localhost:8080/login/oauth2/code/")
.clientRegistrations(Collections.singletonList(third))
.build()
))
.build();
}
private OAuth2ClientsParams clientsParamsWithDuplicateRegistrationIds() {
OAuth2ClientRegistration first = validClientRegistration();
first.setRegistrationId("registrationId");
OAuth2ClientRegistration second = validClientRegistration();
OAuth2ClientRegistration third = validClientRegistration();
third.setRegistrationId("registrationId");
return OAuth2ClientsParams.builder()
.clientsDomainsParams(Arrays.asList(
OAuth2ClientsDomainParams.builder()
.domainName(UUID.randomUUID().toString())
.redirectUriTemplate("http://localhost:8080/login/oauth2/code/")
.clientRegistrations(Arrays.asList(first, second, third))
.build()
))
.build();
private OAuth2ClientRegistration validClientRegistration(String registrationId, TenantId tenantId) {
return validClientRegistration("domainName", registrationId, tenantId);
}
private OAuth2ClientRegistration validClientRegistration() {
return OAuth2ClientRegistration.builder()
.registrationId(UUID.randomUUID().toString())
.mapperConfig(OAuth2MapperConfig.builder()
private OAuth2ClientRegistration validClientRegistration(String domainName, String registrationId, TenantId tenantId) {
OAuth2ClientRegistration clientRegistration = new OAuth2ClientRegistration();
clientRegistration.setTenantId(tenantId);
clientRegistration.setRegistrationId(registrationId);
clientRegistration.setDomainName(domainName);
clientRegistration.setMapperConfig(
OAuth2MapperConfig.builder()
.allowUserCreation(true)
.activateUser(true)
.type(MapperType.CUSTOM)
@ -483,17 +259,20 @@ public class BaseOAuth2ServiceTest extends AbstractServiceTest {
.url("localhost:8082")
.build()
)
.build())
.clientId("clientId")
.clientSecret("clientSecret")
.authorizationUri("authorizationUri")
.accessTokenUri("tokenUri")
.scope(Arrays.asList("scope1", "scope2"))
.userInfoUri("userInfoUri")
.userNameAttributeName("userNameAttributeName")
.jwkSetUri("jwkSetUri")
.clientAuthenticationMethod("clientAuthenticationMethod")
.loginButtonLabel("loginButtonLabel")
.build();
.build()
);
clientRegistration.setClientId("clientId");
clientRegistration.setClientSecret("clientSecret");
clientRegistration.setAuthorizationUri("authorizationUri");
clientRegistration.setAccessTokenUri("tokenUri");
clientRegistration.setRedirectUriTemplate("redirectUriTemplate");
clientRegistration.setScope(Arrays.asList("scope1", "scope2"));
clientRegistration.setUserInfoUri("userInfoUri");
clientRegistration.setUserNameAttributeName("userNameAttributeName");
clientRegistration.setJwkSetUri("jwkSetUri");
clientRegistration.setClientAuthenticationMethod("clientAuthenticationMethod");
clientRegistration.setLoginButtonLabel("loginButtonLabel");
clientRegistration.setLoginButtonIcon("loginButtonIcon");
return clientRegistration;
}
}

1
dao/src/test/resources/sql/hsql/drop-all-tables.sql

@ -20,4 +20,5 @@ DROP TABLE IF EXISTS widgets_bundle;
DROP TABLE IF EXISTS rule_node;
DROP TABLE IF EXISTS rule_chain;
DROP TABLE IF EXISTS entity_view;
DROP TABLE IF EXISTS oauth2_client_registration;
DROP FUNCTION IF EXISTS to_uuid;

1
dao/src/test/resources/sql/psql/drop-all-tables.sql

@ -21,4 +21,5 @@ DROP TABLE IF EXISTS widgets_bundle;
DROP TABLE IF EXISTS rule_node;
DROP TABLE IF EXISTS rule_chain;
DROP TABLE IF EXISTS entity_view;
DROP TABLE IF EXISTS oauth2_client_registration;
DROP TABLE IF EXISTS tb_schema_settings;

1
dao/src/test/resources/sql/timescale/drop-all-tables.sql

@ -21,4 +21,5 @@ DROP TABLE IF EXISTS widgets_bundle;
DROP TABLE IF EXISTS rule_node;
DROP TABLE IF EXISTS rule_chain;
DROP TABLE IF EXISTS entity_view;
DROP TABLE IF EXISTS oauth2_client_registration;
DROP TABLE IF EXISTS tb_schema_settings;
Loading…
Cancel
Save