Igor Kulikov
7 years ago
committed by
GitHub
GitHub
30 changed files with 743 additions and 109 deletions
@ -0,0 +1,25 @@ |
|||
/** |
|||
* Copyright © 2016-2019 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.controller.claim.data; |
|||
|
|||
import lombok.Data; |
|||
|
|||
@Data |
|||
public class ClaimRequest { |
|||
|
|||
private final String secretKey; |
|||
|
|||
} |
|||
@ -0,0 +1,35 @@ |
|||
/** |
|||
* Copyright © 2016-2019 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.device; |
|||
|
|||
import com.google.common.util.concurrent.ListenableFuture; |
|||
import org.thingsboard.server.common.data.Device; |
|||
import org.thingsboard.server.common.data.id.CustomerId; |
|||
import org.thingsboard.server.common.data.id.DeviceId; |
|||
import org.thingsboard.server.common.data.id.TenantId; |
|||
import org.thingsboard.server.dao.device.claim.ClaimResponse; |
|||
|
|||
import java.util.List; |
|||
|
|||
public interface ClaimDevicesService { |
|||
|
|||
ListenableFuture<Void> registerClaimingInfo(TenantId tenantId, DeviceId deviceId, String secretKey, long durationMs); |
|||
|
|||
ListenableFuture<ClaimResponse> claimDevice(Device device, CustomerId customerId, String secretKey); |
|||
|
|||
ListenableFuture<List<Void>> reClaimDevice(TenantId tenantId, Device device); |
|||
|
|||
} |
|||
@ -0,0 +1,171 @@ |
|||
/** |
|||
* Copyright © 2016-2019 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.device; |
|||
|
|||
import com.google.common.util.concurrent.Futures; |
|||
import com.google.common.util.concurrent.ListenableFuture; |
|||
import lombok.extern.slf4j.Slf4j; |
|||
import org.springframework.beans.factory.annotation.Autowired; |
|||
import org.springframework.beans.factory.annotation.Value; |
|||
import org.springframework.cache.Cache; |
|||
import org.springframework.cache.CacheManager; |
|||
import org.springframework.stereotype.Service; |
|||
import org.thingsboard.server.common.data.DataConstants; |
|||
import org.thingsboard.server.common.data.Device; |
|||
import org.thingsboard.server.common.data.id.CustomerId; |
|||
import org.thingsboard.server.common.data.id.DeviceId; |
|||
import org.thingsboard.server.common.data.id.TenantId; |
|||
import org.thingsboard.server.common.data.kv.AttributeKvEntry; |
|||
import org.thingsboard.server.common.data.kv.BaseAttributeKvEntry; |
|||
import org.thingsboard.server.common.data.kv.BooleanDataEntry; |
|||
import org.thingsboard.server.dao.attributes.AttributesService; |
|||
import org.thingsboard.server.dao.device.claim.ClaimData; |
|||
import org.thingsboard.server.dao.device.claim.ClaimResponse; |
|||
import org.thingsboard.server.dao.model.ModelConstants; |
|||
|
|||
import java.util.Collections; |
|||
import java.util.List; |
|||
import java.util.Optional; |
|||
|
|||
import static org.thingsboard.server.common.data.CacheConstants.CLAIM_DEVICES_CACHE; |
|||
|
|||
@Service |
|||
@Slf4j |
|||
public class ClaimDevicesServiceImpl implements ClaimDevicesService { |
|||
|
|||
private static final String CLAIM_ATTRIBUTE_NAME = "claimingAllowed"; |
|||
|
|||
@Autowired |
|||
private DeviceService deviceService; |
|||
@Autowired |
|||
private AttributesService attributesService; |
|||
@Autowired |
|||
private CacheManager cacheManager; |
|||
|
|||
@Value("${security.claim.allowClaimingByDefault}") |
|||
private boolean isAllowedClaimingByDefault; |
|||
|
|||
@Value("${security.claim.duration}") |
|||
private long systemDurationMs; |
|||
|
|||
@Override |
|||
public ListenableFuture<Void> registerClaimingInfo(TenantId tenantId, DeviceId deviceId, String secretKey, long durationMs) { |
|||
ListenableFuture<Device> deviceFuture = deviceService.findDeviceByIdAsync(tenantId, deviceId); |
|||
return Futures.transformAsync(deviceFuture, device -> { |
|||
Cache cache = cacheManager.getCache(CLAIM_DEVICES_CACHE); |
|||
List<Object> key = constructCacheKey(device.getId()); |
|||
|
|||
if (isAllowedClaimingByDefault) { |
|||
if (device.getCustomerId().getId().equals(ModelConstants.NULL_UUID)) { |
|||
persistInCache(secretKey, durationMs, cache, key); |
|||
return Futures.immediateFuture(null); |
|||
} |
|||
log.warn("The device [{}] has been already claimed!", device.getName()); |
|||
throw new IllegalArgumentException(); |
|||
} else { |
|||
ListenableFuture<List<AttributeKvEntry>> claimingAllowedFuture = attributesService.find(tenantId, device.getId(), |
|||
DataConstants.SERVER_SCOPE, Collections.singletonList(CLAIM_ATTRIBUTE_NAME)); |
|||
return Futures.transform(claimingAllowedFuture, list -> { |
|||
if (list != null && !list.isEmpty()) { |
|||
Optional<Boolean> claimingAllowedOptional = list.get(0).getBooleanValue(); |
|||
if (claimingAllowedOptional.isPresent() && claimingAllowedOptional.get() |
|||
&& device.getCustomerId().getId().equals(ModelConstants.NULL_UUID)) { |
|||
persistInCache(secretKey, durationMs, cache, key); |
|||
return null; |
|||
} |
|||
} |
|||
log.warn("Failed to find claimingAllowed attribute for device or it is already claimed![{}]", device.getName()); |
|||
throw new IllegalArgumentException(); |
|||
}); |
|||
} |
|||
}); |
|||
} |
|||
|
|||
@Override |
|||
public ListenableFuture<ClaimResponse> claimDevice(Device device, CustomerId customerId, String secretKey) { |
|||
List<Object> key = constructCacheKey(device.getId()); |
|||
Cache cache = cacheManager.getCache(CLAIM_DEVICES_CACHE); |
|||
ClaimData claimData = cache.get(key, ClaimData.class); |
|||
if (claimData != null) { |
|||
long currTs = System.currentTimeMillis(); |
|||
if (currTs > claimData.getExpirationTime() || !secretKey.equals(claimData.getSecretKey())) { |
|||
log.warn("The claiming timeout occurred or wrong 'secretKey' provided for the device [{}]", device.getName()); |
|||
cache.evict(key); |
|||
return Futures.immediateFuture(ClaimResponse.FAILURE); |
|||
} else { |
|||
if (device.getCustomerId().getId().equals(ModelConstants.NULL_UUID)) { |
|||
device.setCustomerId(customerId); |
|||
deviceService.saveDevice(device); |
|||
return Futures.transform(removeClaimingSavedData(cache, key, device), result -> ClaimResponse.SUCCESS); |
|||
} |
|||
return Futures.transform(removeClaimingSavedData(cache, key, device), result -> ClaimResponse.CLAIMED); |
|||
} |
|||
} else { |
|||
log.warn("Failed to find the device's claiming message![{}]", device.getName()); |
|||
return Futures.immediateFuture(ClaimResponse.CLAIMED); |
|||
} |
|||
} |
|||
|
|||
@Override |
|||
public ListenableFuture<List<Void>> reClaimDevice(TenantId tenantId, Device device) { |
|||
if (!device.getCustomerId().getId().equals(ModelConstants.NULL_UUID)) { |
|||
cacheEviction(device.getId()); |
|||
|
|||
device.setCustomerId(null); |
|||
deviceService.saveDevice(device); |
|||
if (isAllowedClaimingByDefault) { |
|||
return Futures.immediateFuture(Collections.emptyList()); |
|||
} |
|||
return attributesService.save(tenantId, device.getId(), DataConstants.SERVER_SCOPE, Collections.singletonList( |
|||
new BaseAttributeKvEntry(new BooleanDataEntry(CLAIM_ATTRIBUTE_NAME, true), |
|||
System.currentTimeMillis()))); |
|||
} |
|||
cacheEviction(device.getId()); |
|||
return Futures.immediateFuture(Collections.emptyList()); |
|||
} |
|||
|
|||
private List<Object> constructCacheKey(DeviceId deviceId) { |
|||
return Collections.singletonList(deviceId); |
|||
} |
|||
|
|||
private void persistInCache(String secretKey, long durationMs, Cache cache, List<Object> key) { |
|||
ClaimData claimData = new ClaimData(secretKey, |
|||
System.currentTimeMillis() + validateDurationMs(durationMs)); |
|||
cache.putIfAbsent(key, claimData); |
|||
} |
|||
|
|||
private long validateDurationMs(long durationMs) { |
|||
if (durationMs > 0L) { |
|||
return durationMs; |
|||
} |
|||
return systemDurationMs; |
|||
} |
|||
|
|||
private ListenableFuture<List<Void>> removeClaimingSavedData(Cache cache, List<Object> key, Device device) { |
|||
cache.evict(key); |
|||
if (isAllowedClaimingByDefault) { |
|||
return Futures.immediateFuture(null); |
|||
} |
|||
return attributesService.removeAll(device.getTenantId(), |
|||
device.getId(), DataConstants.SERVER_SCOPE, Collections.singletonList(CLAIM_ATTRIBUTE_NAME)); |
|||
} |
|||
|
|||
private void cacheEviction(DeviceId deviceId) { |
|||
Cache cache = cacheManager.getCache(CLAIM_DEVICES_CACHE); |
|||
cache.evict(constructCacheKey(deviceId)); |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,28 @@ |
|||
/** |
|||
* Copyright © 2016-2019 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.device.claim; |
|||
|
|||
import lombok.AllArgsConstructor; |
|||
import lombok.Data; |
|||
|
|||
@AllArgsConstructor |
|||
@Data |
|||
public class ClaimData { |
|||
|
|||
private final String secretKey; |
|||
private final long expirationTime; |
|||
|
|||
} |
|||
@ -0,0 +1,24 @@ |
|||
/** |
|||
* Copyright © 2016-2019 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.device.claim; |
|||
|
|||
public enum ClaimResponse { |
|||
|
|||
SUCCESS, |
|||
FAILURE, |
|||
CLAIMED |
|||
|
|||
} |
|||
Loading…
Reference in new issue