Browse Source
# Conflicts: # application/src/main/data/upgrade/3.2.2/schema_update_event.sqlpull/4882/head
Sergey Matvienko
5 years ago
151 changed files with 3592 additions and 1300 deletions
@ -0,0 +1,45 @@ |
|||
/** |
|||
* Copyright © 2016-2021 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.service.queue; |
|||
|
|||
import lombok.Builder; |
|||
import lombok.Data; |
|||
import lombok.Getter; |
|||
import lombok.RequiredArgsConstructor; |
|||
import org.thingsboard.server.common.msg.queue.TopicPartitionInfo; |
|||
import org.thingsboard.server.gen.transport.TransportProtos; |
|||
import org.thingsboard.server.queue.TbQueueConsumer; |
|||
import org.thingsboard.server.queue.common.TbProtoQueueMsg; |
|||
|
|||
import java.util.Collections; |
|||
import java.util.Map; |
|||
import java.util.Queue; |
|||
import java.util.Set; |
|||
import java.util.concurrent.ConcurrentHashMap; |
|||
import java.util.concurrent.ConcurrentLinkedQueue; |
|||
import java.util.concurrent.ConcurrentMap; |
|||
import java.util.concurrent.locks.ReentrantLock; |
|||
|
|||
@RequiredArgsConstructor |
|||
@Data |
|||
public class TbTopicWithConsumerPerPartition { |
|||
private final String topic; |
|||
@Getter |
|||
private final ReentrantLock lock = new ReentrantLock(); //NonfairSync
|
|||
private volatile Set<TopicPartitionInfo> partitions = Collections.emptySet(); |
|||
private final ConcurrentMap<TopicPartitionInfo, TbQueueConsumer<TbProtoQueueMsg<TransportProtos.ToRuleEngineMsg>>> consumers = new ConcurrentHashMap<>(); |
|||
private final Queue<Set<TopicPartitionInfo>> subscribeQueue = new ConcurrentLinkedQueue<>(); |
|||
} |
|||
@ -0,0 +1,58 @@ |
|||
/** |
|||
* Copyright © 2016-2021 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.actors.device; |
|||
|
|||
import org.junit.Before; |
|||
import org.junit.Test; |
|||
import org.thingsboard.common.util.LinkedHashMapRemoveEldest; |
|||
import org.thingsboard.server.actors.ActorSystemContext; |
|||
import org.thingsboard.server.common.data.id.DeviceId; |
|||
import org.thingsboard.server.common.data.id.TenantId; |
|||
import org.thingsboard.server.dao.device.DeviceService; |
|||
|
|||
import static org.hamcrest.CoreMatchers.instanceOf; |
|||
import static org.hamcrest.CoreMatchers.is; |
|||
import static org.hamcrest.CoreMatchers.notNullValue; |
|||
import static org.hamcrest.MatcherAssert.assertThat; |
|||
import static org.mockito.BDDMockito.willReturn; |
|||
import static org.mockito.Mockito.mock; |
|||
|
|||
public class DeviceActorMessageProcessorTest { |
|||
|
|||
public static final long MAX_CONCURRENT_SESSIONS_PER_DEVICE = 10L; |
|||
ActorSystemContext systemContext; |
|||
DeviceService deviceService; |
|||
TenantId tenantId = TenantId.SYS_TENANT_ID; |
|||
DeviceId deviceId = DeviceId.fromString("78bf9b26-74ef-4af2-9cfb-ad6cf24ad2ec"); |
|||
|
|||
DeviceActorMessageProcessor processor; |
|||
|
|||
@Before |
|||
public void setUp() { |
|||
systemContext = mock(ActorSystemContext.class); |
|||
deviceService = mock(DeviceService.class); |
|||
willReturn(MAX_CONCURRENT_SESSIONS_PER_DEVICE).given(systemContext).getMaxConcurrentSessionsPerDevice(); |
|||
willReturn(deviceService).given(systemContext).getDeviceService(); |
|||
processor = new DeviceActorMessageProcessor(systemContext, tenantId, deviceId); |
|||
} |
|||
|
|||
@Test |
|||
public void givenSystemContext_whenNewInstance_thenVerifySessionMapMaxSize() { |
|||
assertThat(processor.sessions, instanceOf(LinkedHashMapRemoveEldest.class)); |
|||
assertThat(processor.sessions.getMaxEntries(), is(MAX_CONCURRENT_SESSIONS_PER_DEVICE)); |
|||
assertThat(processor.sessions.getRemovalConsumer(), notNullValue()); |
|||
} |
|||
} |
|||
@ -0,0 +1,152 @@ |
|||
/** |
|||
* Copyright © 2016-2021 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.transport.lwm2m.client; |
|||
|
|||
import lombok.extern.slf4j.Slf4j; |
|||
import org.eclipse.leshan.client.resource.BaseInstanceEnabler; |
|||
import org.eclipse.leshan.client.servers.ServerIdentity; |
|||
import org.eclipse.leshan.core.model.ObjectModel; |
|||
import org.eclipse.leshan.core.node.LwM2mResource; |
|||
import org.eclipse.leshan.core.response.ExecuteResponse; |
|||
import org.eclipse.leshan.core.response.ReadResponse; |
|||
import org.eclipse.leshan.core.response.WriteResponse; |
|||
|
|||
import javax.security.auth.Destroyable; |
|||
import java.util.Arrays; |
|||
import java.util.List; |
|||
import java.util.concurrent.Executors; |
|||
import java.util.concurrent.ScheduledExecutorService; |
|||
import java.util.concurrent.TimeUnit; |
|||
import java.util.concurrent.atomic.AtomicInteger; |
|||
|
|||
@Slf4j |
|||
public class FwLwM2MDevice extends BaseInstanceEnabler implements Destroyable { |
|||
|
|||
private static final List<Integer> supportedResources = Arrays.asList(0, 1, 2, 3, 5, 6, 7, 9); |
|||
|
|||
private final ScheduledExecutorService scheduler = Executors.newSingleThreadScheduledExecutor(); |
|||
|
|||
private final AtomicInteger state = new AtomicInteger(0); |
|||
|
|||
private final AtomicInteger updateResult = new AtomicInteger(0); |
|||
|
|||
@Override |
|||
public ReadResponse read(ServerIdentity identity, int resourceId) { |
|||
if (!identity.isSystem()) |
|||
log.info("Read on Device resource /{}/{}/{}", getModel().id, getId(), resourceId); |
|||
switch (resourceId) { |
|||
case 3: |
|||
return ReadResponse.success(resourceId, getState()); |
|||
case 5: |
|||
return ReadResponse.success(resourceId, getUpdateResult()); |
|||
case 6: |
|||
return ReadResponse.success(resourceId, getPkgName()); |
|||
case 7: |
|||
return ReadResponse.success(resourceId, getPkgVersion()); |
|||
case 9: |
|||
return ReadResponse.success(resourceId, getFirmwareUpdateDeliveryMethod()); |
|||
default: |
|||
return super.read(identity, resourceId); |
|||
} |
|||
} |
|||
|
|||
@Override |
|||
public ExecuteResponse execute(ServerIdentity identity, int resourceId, String params) { |
|||
String withParams = null; |
|||
if (params != null && params.length() != 0) { |
|||
withParams = " with params " + params; |
|||
} |
|||
log.info("Execute on Device resource /{}/{}/{} {}", getModel().id, getId(), resourceId, withParams != null ? withParams : ""); |
|||
|
|||
switch (resourceId) { |
|||
case 2: |
|||
startUpdating(); |
|||
return ExecuteResponse.success(); |
|||
default: |
|||
return super.execute(identity, resourceId, params); |
|||
} |
|||
} |
|||
|
|||
@Override |
|||
public WriteResponse write(ServerIdentity identity, boolean replace, int resourceId, LwM2mResource value) { |
|||
log.info("Write on Device resource /{}/{}/{}", getModel().id, getId(), resourceId); |
|||
|
|||
switch (resourceId) { |
|||
case 0: |
|||
startDownloading(); |
|||
return WriteResponse.success(); |
|||
case 1: |
|||
startDownloading(); |
|||
return WriteResponse.success(); |
|||
default: |
|||
return super.write(identity, replace, resourceId, value); |
|||
} |
|||
} |
|||
|
|||
private int getState() { |
|||
return state.get(); |
|||
} |
|||
|
|||
private int getUpdateResult() { |
|||
return updateResult.get(); |
|||
} |
|||
|
|||
private String getPkgName() { |
|||
return "firmware"; |
|||
} |
|||
|
|||
private String getPkgVersion() { |
|||
return "1.0.0"; |
|||
} |
|||
|
|||
private int getFirmwareUpdateDeliveryMethod() { |
|||
return 1; |
|||
} |
|||
|
|||
@Override |
|||
public List<Integer> getAvailableResourceIds(ObjectModel model) { |
|||
return supportedResources; |
|||
} |
|||
|
|||
@Override |
|||
public void destroy() { |
|||
scheduler.shutdownNow(); |
|||
} |
|||
|
|||
private void startDownloading() { |
|||
scheduler.schedule(() -> { |
|||
state.set(1); |
|||
fireResourcesChange(3); |
|||
state.set(2); |
|||
fireResourcesChange(3); |
|||
}, 100, TimeUnit.MILLISECONDS); |
|||
} |
|||
|
|||
private void startUpdating() { |
|||
scheduler.schedule(() -> { |
|||
try { |
|||
state.set(3); |
|||
fireResourcesChange(3); |
|||
Thread.sleep(100); |
|||
updateResult.set(1); |
|||
fireResourcesChange(5); |
|||
} catch (Exception e) { |
|||
|
|||
} |
|||
}, 100, TimeUnit.MILLISECONDS); |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,155 @@ |
|||
/** |
|||
* Copyright © 2016-2021 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.transport.lwm2m.client; |
|||
|
|||
import lombok.SneakyThrows; |
|||
import lombok.extern.slf4j.Slf4j; |
|||
import org.eclipse.leshan.client.resource.BaseInstanceEnabler; |
|||
import org.eclipse.leshan.client.servers.ServerIdentity; |
|||
import org.eclipse.leshan.core.model.ObjectModel; |
|||
import org.eclipse.leshan.core.node.LwM2mResource; |
|||
import org.eclipse.leshan.core.response.ExecuteResponse; |
|||
import org.eclipse.leshan.core.response.ReadResponse; |
|||
import org.eclipse.leshan.core.response.WriteResponse; |
|||
|
|||
import javax.security.auth.Destroyable; |
|||
import java.util.Arrays; |
|||
import java.util.List; |
|||
import java.util.concurrent.Executors; |
|||
import java.util.concurrent.ScheduledExecutorService; |
|||
import java.util.concurrent.TimeUnit; |
|||
import java.util.concurrent.atomic.AtomicInteger; |
|||
|
|||
@Slf4j |
|||
public class SwLwM2MDevice extends BaseInstanceEnabler implements Destroyable { |
|||
|
|||
private static final List<Integer> supportedResources = Arrays.asList(0, 1, 2, 3, 4, 6, 7, 9); |
|||
|
|||
private final ScheduledExecutorService scheduler = Executors.newSingleThreadScheduledExecutor(); |
|||
|
|||
private final AtomicInteger state = new AtomicInteger(0); |
|||
|
|||
private final AtomicInteger updateResult = new AtomicInteger(0); |
|||
|
|||
@Override |
|||
public ReadResponse read(ServerIdentity identity, int resourceId) { |
|||
if (!identity.isSystem()) |
|||
log.info("Read on Device resource /{}/{}/{}", getModel().id, getId(), resourceId); |
|||
switch (resourceId) { |
|||
case 0: |
|||
return ReadResponse.success(resourceId, getPkgName()); |
|||
case 1: |
|||
return ReadResponse.success(resourceId, getPkgVersion()); |
|||
case 7: |
|||
return ReadResponse.success(resourceId, getUpdateState()); |
|||
case 9: |
|||
return ReadResponse.success(resourceId, getUpdateResult()); |
|||
default: |
|||
return super.read(identity, resourceId); |
|||
} |
|||
} |
|||
|
|||
@Override |
|||
public ExecuteResponse execute(ServerIdentity identity, int resourceId, String params) { |
|||
String withParams = null; |
|||
if (params != null && params.length() != 0) { |
|||
withParams = " with params " + params; |
|||
} |
|||
log.info("Execute on Device resource /{}/{}/{} {}", getModel().id, getId(), resourceId, withParams != null ? withParams : ""); |
|||
|
|||
switch (resourceId) { |
|||
case 4: |
|||
startUpdating(); |
|||
return ExecuteResponse.success(); |
|||
case 6: |
|||
return ExecuteResponse.success(); |
|||
default: |
|||
return super.execute(identity, resourceId, params); |
|||
} |
|||
} |
|||
|
|||
@Override |
|||
public WriteResponse write(ServerIdentity identity, boolean replace, int resourceId, LwM2mResource value) { |
|||
log.info("Write on Device resource /{}/{}/{}", getModel().id, getId(), resourceId); |
|||
|
|||
switch (resourceId) { |
|||
case 2: |
|||
startDownloading(); |
|||
return WriteResponse.success(); |
|||
case 3: |
|||
startDownloading(); |
|||
return WriteResponse.success(); |
|||
default: |
|||
return super.write(identity, replace, resourceId, value); |
|||
} |
|||
} |
|||
|
|||
private int getUpdateState() { |
|||
return state.get(); |
|||
} |
|||
|
|||
private int getUpdateResult() { |
|||
return updateResult.get(); |
|||
} |
|||
|
|||
private String getPkgName() { |
|||
return "software"; |
|||
} |
|||
|
|||
private String getPkgVersion() { |
|||
return "1.0.0"; |
|||
} |
|||
|
|||
@Override |
|||
public List<Integer> getAvailableResourceIds(ObjectModel model) { |
|||
return supportedResources; |
|||
} |
|||
|
|||
@Override |
|||
public void destroy() { |
|||
scheduler.shutdownNow(); |
|||
} |
|||
|
|||
private void startDownloading() { |
|||
scheduler.schedule(() -> { |
|||
try { |
|||
state.set(1); |
|||
updateResult.set(1); |
|||
fireResourcesChange(7, 9); |
|||
Thread.sleep(100); |
|||
state.set(2); |
|||
fireResourcesChange(7); |
|||
Thread.sleep(100); |
|||
state.set(3); |
|||
fireResourcesChange(7); |
|||
Thread.sleep(100); |
|||
updateResult.set(3); |
|||
fireResourcesChange(9); |
|||
} catch (Exception e) { |
|||
|
|||
} |
|||
}, 100, TimeUnit.MILLISECONDS); |
|||
} |
|||
|
|||
private void startUpdating() { |
|||
scheduler.schedule(() -> { |
|||
state.set(4); |
|||
updateResult.set(2); |
|||
fireResourcesChange(7, 9); |
|||
}, 100, TimeUnit.MILLISECONDS); |
|||
} |
|||
|
|||
} |
|||
@ -1,4 +1,7 @@ |
|||
transport.lwm2m.security.key_store=lwm2m/credentials/serverKeyStore.jks |
|||
transport.lwm2m.security.key_store_password=server |
|||
edges.enabled=true |
|||
transport.lwm2m.bootstrap.security.alias=server |
|||
transport.lwm2m.server.security.key_alias=server |
|||
transport.lwm2m.server.security.key_password=server |
|||
transport.lwm2m.bootstrap.security.key_alias=server |
|||
transport.lwm2m.bootstrap.security.key_password=server |
|||
@ -0,0 +1,204 @@ |
|||
<?xml version="1.0" encoding="UTF-8"?> |
|||
|
|||
<!-- |
|||
FILE INFORMATION |
|||
|
|||
OMA Permanent Document |
|||
File: OMA-SUP-XML_LWM2M_Firmware_Update-V1_0_3-20190617-A |
|||
Type: xml |
|||
Date: 2019-Jun-17 |
|||
|
|||
Public Reachable Information |
|||
Path: http://www.openmobilealliance.org/tech/profiles |
|||
Name: LWM2M_Firmware_Update-v1_0_3.xml |
|||
|
|||
NORMATIVE INFORMATION |
|||
|
|||
Information about this file can be found in the latest revision of |
|||
|
|||
OMA-TS-LightweightM2M-V1_0_2 |
|||
OMA-TS-LightweightM2M_Core-V1_1_1 |
|||
|
|||
This is available at http://www.openmobilealliance.org/ |
|||
|
|||
Send comments to https://github.com/OpenMobileAlliance/OMA_LwM2M_for_Developers/issues |
|||
|
|||
LEGAL DISCLAIMER |
|||
|
|||
Copyright 2019 Open Mobile Alliance. |
|||
|
|||
Redistribution and use in source and binary forms, with or without |
|||
modification, are permitted provided that the following conditions |
|||
are met: |
|||
|
|||
1. Redistributions of source code must retain the above copyright |
|||
notice, this list of conditions and the following disclaimer. |
|||
2. Redistributions in binary form must reproduce the above copyright |
|||
notice, this list of conditions and the following disclaimer in the |
|||
documentation and/or other materials provided with the distribution. |
|||
3. Neither the name of the copyright holder nor the names of its |
|||
contributors may be used to endorse or promote products derived |
|||
from this software without specific prior written permission. |
|||
|
|||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
|||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
|||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
|||
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
|||
COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
|||
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
|||
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
|||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
|||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
|||
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
|||
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
|||
POSSIBILITY OF SUCH DAMAGE. |
|||
|
|||
The above license is used as a license under copyright only. Please |
|||
reference the OMA IPR Policy for patent licensing terms: |
|||
https://www.omaspecworks.org/about/intellectual-property-rights/ |
|||
|
|||
--> |
|||
|
|||
<LWM2M xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.openmobilealliance.org/tech/profiles/LWM2M.xsd"> |
|||
<Object ObjectType="MODefinition"> |
|||
<Name>Firmware Update V_1_0</Name> |
|||
<Description1><![CDATA[This LwM2M Object enables management of firmware which is to be updated. This Object includes installing a firmware package, updating firmware, and performing actions after updating firmware. The firmware update MAY require to reboot the device; it will depend on a number of factors, such as the operating system architecture and the extent of the updated software. |
|||
The envisioned functionality is to allow a LwM2M Client to connect to any LwM2M Server to obtain a firmware image using the object and resource structure defined in this section experiencing communication security protection using TLS/DTLS. There are, however, other design decisions that need to be taken into account to allow a manufacturer of a device to securely install firmware on a device. Examples for such design decisions are how to manage the firmware update repository at the server side (which may include user interface considerations), the techniques to provide additional application layer security protection of the firmware image, how many versions of firmware images to store on the device, and how to execute the firmware update process considering the hardware specific details of a given IoT hardware product. These aspects are considered to be outside the scope of this version of the specification. |
|||
A LwM2M Server may also instruct a LwM2M Client to fetch a firmware image from a dedicated server (instead of pushing firmware images to the LwM2M Client). The Package URI resource is contained in the Firmware object and can be used for this purpose. |
|||
A LwM2M Client MUST support block-wise transfer [CoAP_Blockwise] if it implements the Firmware Update object. |
|||
A LwM2M Server MUST support block-wise transfer. Other protocols, such as HTTP/HTTPs, MAY also be used for downloading firmware updates (via the Package URI resource). For constrained devices it is, however, RECOMMENDED to use CoAP for firmware downloads to avoid the need for additional protocol implementations.]]></Description1> |
|||
<ObjectID>5</ObjectID> |
|||
<ObjectURN>urn:oma:lwm2m:oma:5</ObjectURN> |
|||
<LWM2MVersion>1.0</LWM2MVersion> |
|||
<ObjectVersion>1.0</ObjectVersion> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Resources> |
|||
<Item ID="0"> |
|||
<Name>Package</Name> |
|||
<Operations>W</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>Opaque</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Firmware package]]></Description> |
|||
</Item> |
|||
<Item ID="1"> |
|||
<Name>Package URI</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration>0..255</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[URI from where the device can download the firmware package by an alternative mechanism. As soon the device has received the Package URI it performs the download at the next practical opportunity. |
|||
The URI format is defined in RFC 3986. For example, coaps://example.org/firmware is a syntactically valid URI. The URI scheme determines the protocol to be used. For CoAP this endpoint MAY be a LwM2M Server but does not necessarily need to be. A CoAP server implementing block-wise transfer is sufficient as a server hosting a firmware repository and the expectation is that this server merely serves as a separate file server making firmware images available to LwM2M Clients.]]></Description> |
|||
</Item> |
|||
<Item ID="2"> |
|||
<Name>Update</Name> |
|||
<Operations>E</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type></Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Updates firmware by using the firmware package stored in Package, or, by using the firmware downloaded from the Package URI. |
|||
This Resource is only executable when the value of the State Resource is Downloaded.]]></Description> |
|||
</Item> |
|||
<Item ID="3"> |
|||
<Name>State</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..3</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Indicates current state with respect to this firmware update. This value is set by the LwM2M Client. |
|||
0: Idle (before downloading or after successful updating) |
|||
1: Downloading (The data sequence is on the way) |
|||
2: Downloaded |
|||
3: Updating |
|||
If writing the firmware package to Package Resource has completed, or, if the device has downloaded the firmware package from the Package URI the state changes to Downloaded. |
|||
Writing an empty string to Package URI Resource or setting the Package Resource to NULL (‘\0’), resets the Firmware Update State Machine: the State Resource value is set to Idle and the Update Result Resource value is set to 0. |
|||
When in Downloaded state, and the executable Resource Update is triggered, the state changes to Updating. |
|||
If the Update Resource failed, the state returns at Downloaded. |
|||
If performing the Update Resource was successful, the state changes from Updating to Idle. |
|||
The firmware update state machine is illustrated in Figure 29 of the LwM2M version 1.0 specification (and also in Figure E.6.1-1 of this specification).]]></Description> |
|||
</Item> |
|||
<Item ID="5"> |
|||
<Name>Update Result</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..9</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Contains the result of downloading or updating the firmware |
|||
0: Initial value. Once the updating process is initiated (Download /Update), this Resource MUST be reset to Initial value. |
|||
1: Firmware updated successfully. |
|||
2: Not enough flash memory for the new firmware package. |
|||
3: Out of RAM during downloading process. |
|||
4: Connection lost during downloading process. |
|||
5: Integrity check failure for new downloaded package. |
|||
6: Unsupported package type. |
|||
7: Invalid URI. |
|||
8: Firmware update failed. |
|||
9: Unsupported protocol. A LwM2M client indicates the failure to retrieve the firmware image using the URI provided in the Package URI resource by writing the value 9 to the /5/0/5 (Update Result resource) when the URI contained a URI scheme unsupported by the client. Consequently, the LwM2M Client is unable to retrieve the firmware image using the URI provided by the LwM2M Server in the Package URI when it refers to an unsupported protocol.]]></Description> |
|||
</Item> |
|||
<Item ID="6"> |
|||
<Name>PkgName</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration>0..255</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Name of the Firmware Package]]></Description> |
|||
</Item> |
|||
<Item ID="7"> |
|||
<Name>PkgVersion</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration>0..255</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Version of the Firmware package]]></Description> |
|||
</Item> |
|||
<Item ID="8"> |
|||
<Name>Firmware Update Protocol Support</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Multiple</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..5</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[This resource indicates what protocols the LwM2M Client implements to retrieve firmware images. The LwM2M server uses this information to decide what URI to include in the Package URI. A LwM2M Server MUST NOT include a URI in the Package URI object that uses a protocol that is unsupported by the LwM2M client. |
|||
For example, if a LwM2M client indicates that it supports CoAP and CoAPS then a LwM2M Server must not provide an HTTP URI in the Packet URI. |
|||
The following values are defined by this version of the specification: |
|||
0: CoAP (as defined in RFC 7252) with the additional support for block-wise transfer. CoAP is the default setting. |
|||
1: CoAPS (as defined in RFC 7252) with the additional support for block-wise transfer |
|||
2: HTTP 1.1 (as defined in RFC 7230) |
|||
3: HTTPS 1.1 (as defined in RFC 7230) |
|||
4: CoAP over TCP (as defined in RFC 8323) |
|||
5: CoAP over TLS (as defined in RFC 8323) |
|||
Additional values MAY be defined in the future. Any value not understood by the LwM2M Server MUST be ignored.]]></Description> |
|||
</Item> |
|||
<Item ID="9"> |
|||
<Name>Firmware Update Delivery Method</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..2</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[The LwM2M Client uses this resource to indicate its support for transferring firmware images to the client either via the Package Resource (=push) or via the Package URI Resource (=pull) mechanism. |
|||
0: Pull only |
|||
1: Push only |
|||
2: Both. In this case the LwM2M Server MAY choose the preferred mechanism for conveying the firmware image to the LwM2M Client.]]></Description> |
|||
</Item> |
|||
</Resources> |
|||
<Description2><![CDATA[]]></Description2> |
|||
</Object> |
|||
</LWM2M> |
|||
@ -0,0 +1,321 @@ |
|||
<?xml version="1.0" encoding="UTF-8"?> |
|||
|
|||
<!-- |
|||
FILE INFORMATION |
|||
|
|||
OMA Permanent Document |
|||
File: OMA-SUP-XML_9-V1_0_2-20210119-A.xml |
|||
Path: http://www.openmobilealliance.org/release/LWM2M_SWMGMT |
|||
|
|||
OMNA LwM2M Registry |
|||
Path: https://github.com/OpenMobileAlliance/lwm2m-registry |
|||
Name: 9.xml |
|||
|
|||
NORMATIVE INFORMATION |
|||
|
|||
Information about this file can be found in the latest revision of |
|||
|
|||
OMA-TS-LightweightM2M-V1_0 |
|||
|
|||
This is available at http://www.openmobilealliance.org/release/LightweightM2M/ |
|||
|
|||
Send comments to https://github.com/OpenMobileAlliance/OMA_LwM2M_for_Developers/issues |
|||
|
|||
LEGAL DISCLAIMER |
|||
|
|||
Copyright 2021 Open Mobile Alliance. |
|||
|
|||
Redistribution and use in source and binary forms, with or without |
|||
modification, are permitted provided that the following conditions |
|||
are met: |
|||
|
|||
1. Redistributions of source code must retain the above copyright |
|||
notice, this list of conditions and the following disclaimer. |
|||
2. Redistributions in binary form must reproduce the above copyright |
|||
notice, this list of conditions and the following disclaimer in the |
|||
documentation and/or other materials provided with the distribution. |
|||
3. Neither the name of the copyright holder nor the names of its |
|||
contributors may be used to endorse or promote products derived |
|||
from this software without specific prior written permission. |
|||
|
|||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
|||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
|||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
|||
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
|||
COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
|||
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
|||
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
|||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
|||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
|||
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
|||
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
|||
POSSIBILITY OF SUCH DAMAGE. |
|||
|
|||
The above license is used as a license under copyright only. Please |
|||
reference the OMA IPR Policy for patent licensing terms: |
|||
https://www.omaspecworks.org/about/intellectual-property-rights/ |
|||
|
|||
--> |
|||
|
|||
<LWM2M xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://openmobilealliance.org/tech/profiles/LWM2M.xsd"> |
|||
<Object ObjectType="MODefinition"> |
|||
<Name>LWM2M Software Management</Name> |
|||
<Description1><![CDATA[This LwM2M objects provides the resources needed to perform software management on the device. Each software component is managed via a dedicated Software Management Object instance.]]></Description1> |
|||
<ObjectID>9</ObjectID> |
|||
<ObjectURN>urn:oma:lwm2m:oma:9</ObjectURN> |
|||
<LWM2MVersion>1.0</LWM2MVersion> |
|||
<ObjectVersion>1.0</ObjectVersion> |
|||
<MultipleInstances>Multiple</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Resources> |
|||
<Item ID="0"> |
|||
<Name>PkgName</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration>0..255 bytes</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Name of the software package]]></Description> |
|||
</Item> |
|||
<Item ID="1"> |
|||
<Name>PkgVersion</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration>0..255 bytes</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Version of the software package]]></Description> |
|||
</Item> |
|||
<Item ID="2"> |
|||
<Name>Package</Name> |
|||
<Operations>W</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Opaque</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Software package |
|||
The package can be in one single software component, or any delivery material used by the Device to determine the software component(s) and proceed to their installation. |
|||
Can be archive file, executable, manifest. This resource to be used when it is single block of delivery. |
|||
]]> </Description> |
|||
</Item> |
|||
<Item ID="3"> |
|||
<Name>Package URI</Name> |
|||
<Operations>W</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration>0..255 bytes</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[URI from where the device can download the software package by an alternative mechanism. As soon the device has received the Package URI it performs the download at the next practical opportunity. |
|||
Can be direct link to a single software component or link to archive file, executable, or manifest, used by the Device to determine, then access to the software component(s). This resource to be used when it is single block of delivery. |
|||
]]> </Description> |
|||
</Item> |
|||
|
|||
<Item ID="4"> |
|||
<Name>Install</Name> |
|||
<Operations>E</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type></Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Installs software from the package either stored in Package resource, or, downloaded from the Package URI. This Resource is only executable when the value of the State Resource is DELIVERED.]]></Description> |
|||
</Item> |
|||
<Item ID="5"> |
|||
<Name>Checkpoint</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Objlnk</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Link to a "Checkpoint" object which allows to specify conditions/dependencies for a software update. E.g. power connected, sufficient memory, target system.]]></Description> |
|||
</Item> |
|||
<Item ID="6"> |
|||
<Name>Uninstall</Name> |
|||
<Operations>E</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type></Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Uninstalls the software package. |
|||
This executable resource may have one argument. |
|||
If used with no argument or argument is 0, the Package is removed i from the Device. If the argument is 1 ("ForUpdate"), the Client MUST prepare itself for receiving a Package used to upgrade the Software already in place. Update State is set back to INITIAL state. |
|||
]]> </Description> |
|||
</Item> |
|||
<Item ID="7"> |
|||
<Name>Update State</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..4</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Indicates current state with respect to this software update. This value is set by the LwM2M Client. |
|||
0: INITIAL |
|||
Before downloading. |
|||
(see 5.1.2.1) |
|||
1: DOWNLOAD STARTED |
|||
The downloading process has started and is on-going. |
|||
(see 5.1.2.2) |
|||
2: DOWNLOADED |
|||
The package has been completely downloaded |
|||
(see 5.1.2.3) |
|||
3: DELIVERED |
|||
In that state, the package has been correctly downloaded and is ready to be installed. |
|||
(see 5.1.2.4) |
|||
If executing the Install Resource failed, the state remains at DELIVERED. |
|||
If executing the Install Resource was successful, the state changes from DELIVERED to INSTALLED. |
|||
After executing the UnInstall Resource, the state changes to INITIAL. |
|||
4: INSTALLED |
|||
In that state the software is correctly installed and can be activated or deactivated according to the Activation State Machine. |
|||
(see 5.1.2.5) |
|||
]]> </Description> |
|||
</Item> |
|||
<Item ID="8"> |
|||
<Name>Update Supported Objects</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Boolean</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[If this value is true, the LwM2M Client MUST inform the registered LwM2M Servers of Objects and Object Instances parameter by sending an Update or Registration message after the software update operation at the next practical opportunity if supported Objects in the LwM2M Client have changed, in order for the LwM2M Servers to promptly manage newly installed Objects. |
|||
If false, Objects and Object Instances parameter MUST be reported at the next periodic Update message. |
|||
The default value is false. |
|||
]]> </Description> |
|||
</Item> |
|||
<Item ID="9"> |
|||
<Name>Update Result</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..200</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Contains the result of downloading or installing/uninstalling the software |
|||
0: Initial value. Prior to download any new package in the Device, Update Result MUST be reset to this initial value. One side effect of executing the Uninstall resource is to reset Update Result to this initial value "0". |
|||
1: Downloading. The package downloading process is on-going. |
|||
2: Software successfully installed. |
|||
3: Successfully Downloaded and package integrity verified |
|||
(( 4-49, for expansion, of other scenarios)) |
|||
50: Not enough storage for the new software package. |
|||
51: Out of memory during downloading process. |
|||
52: Connection lost during downloading process. |
|||
53: Package integrity check failure. |
|||
54: Unsupported package type. |
|||
56: Invalid URI |
|||
57: Device defined update error |
|||
58: Software installation failure |
|||
59: Uninstallation Failure during forUpdate(arg=0) |
|||
60-200 : (for expansion, selection to be in blocks depending on new introduction of features) |
|||
This Resource MAY be reported by sending Observe operation. |
|||
]]> </Description> |
|||
</Item> |
|||
<Item ID="10"> |
|||
<Name>Activate</Name> |
|||
<Operations>E</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type></Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[This action activates the software previously successfully installed (the Package Installation State Machine is currently in the INSTALLED state)]]></Description> |
|||
</Item> |
|||
<Item ID="11"> |
|||
<Name>Deactivate</Name> |
|||
<Operations>E</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type></Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[This action deactivates softwareif the Package Installation State Machine is currently in the INSTALLED state.]]></Description> |
|||
</Item> |
|||
<Item ID="12"> |
|||
<Name>Activation State</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>Boolean</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Indicates the current activation state of this software: |
|||
0: DISABLED |
|||
Activation State is DISABLED if the Software Activation State Machine is in the INACTIVE state or not alive. |
|||
1: ENABLED |
|||
Activation State is ENABLED only if the Software Activation State Machine is in the ACTIVE state |
|||
]]> </Description> |
|||
</Item> |
|||
<Item ID="13"> |
|||
<Name>Package Settings</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Objlnk</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Link to "Package Settings" object which allows to modify at any time software configuration settings. This is an application specific object. |
|||
Note: OMA might provide a template for a Package Settings object in a future release of this specification. |
|||
]]> </Description> |
|||
</Item> |
|||
<Item ID="14"> |
|||
<Name>User Name</Name> |
|||
<Operations>W</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration>0..255 bytes</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[User Name for access to SW Update Package in pull mode. |
|||
Key based mechanism can alternatively use for talking to the component server instead of user name and password combination. |
|||
]]> </Description> |
|||
</Item> |
|||
<Item ID="15"> |
|||
<Name>Password</Name> |
|||
<Operations>W</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration>0..255 bytes</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Password for access to SW Update Package in pull mode.]]></Description> |
|||
</Item> |
|||
<Item ID="16"> |
|||
<Name>Status Reason</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Contains the status of the actions done by the client on the SW Component(s) referred by the present SW Update Package. The status is defined in Appendix B.]]></Description> |
|||
</Item> |
|||
<Item ID="17"> |
|||
<Name>Software Component Link</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Multiple</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Objlnk</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Reference to SW Components downloaded and installed in scope of the present SW Update Package Note: When resource 17 objlink exist, resources 2, 3 and 12 in this table are ignored.]]></Description> |
|||
</Item> |
|||
<Item ID="18"> |
|||
<Name>Software Component tree length</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..255</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Software Component tree length indicates the number of instances existing for this software package in the Software Component Object.]]></Description> |
|||
</Item> |
|||
</Resources> |
|||
<Description2><![CDATA[]]></Description2> |
|||
</Object> |
|||
</LWM2M> |
|||
@ -1,110 +0,0 @@ |
|||
/** |
|||
* Copyright © 2016-2021 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.transport.lwm2m.secure; |
|||
|
|||
import lombok.extern.slf4j.Slf4j; |
|||
import org.eclipse.leshan.core.util.Hex; |
|||
|
|||
import java.security.InvalidAlgorithmParameterException; |
|||
import java.security.KeyPair; |
|||
import java.security.KeyPairGenerator; |
|||
import java.security.NoSuchAlgorithmException; |
|||
import java.security.NoSuchProviderException; |
|||
import java.security.PrivateKey; |
|||
import java.security.PublicKey; |
|||
import java.security.SecureRandom; |
|||
import java.security.interfaces.ECPublicKey; |
|||
import java.security.spec.ECGenParameterSpec; |
|||
import java.util.Arrays; |
|||
|
|||
@Slf4j |
|||
public class LWM2MGenerationPSkRPkECC { |
|||
|
|||
public LWM2MGenerationPSkRPkECC() { |
|||
generationPSkKey(); |
|||
generationRPKECCKey(); |
|||
} |
|||
|
|||
private void generationPSkKey() { |
|||
/* PSK */ |
|||
int lenPSkKey = 32; |
|||
/* Start PSK |
|||
Clients and Servers MUST support PSK keys of up to 64 bytes in length, as required by [RFC7925] |
|||
SecureRandom object must be unpredictable, and all SecureRandom output sequences must be cryptographically strong, as described in [RFC4086] |
|||
*/ |
|||
SecureRandom randomPSK = new SecureRandom(); |
|||
byte[] bytesPSK = new byte[lenPSkKey]; |
|||
randomPSK.nextBytes(bytesPSK); |
|||
log.info("\nCreating new PSK: \n for the next start PSK -> security key: [{}]", Hex.encodeHexString(bytesPSK)); |
|||
} |
|||
|
|||
private void generationRPKECCKey() { |
|||
/* RPK */ |
|||
String algorithm = "EC"; |
|||
String provider = "SunEC"; |
|||
String nameParameterSpec = "secp256r1"; |
|||
|
|||
/* Start RPK |
|||
Elliptic Curve parameters : [secp256r1 [NIST P-256, X9.62 prime256v1] (1.2.840.10045.3.1.7)] |
|||
*/ |
|||
KeyPairGenerator kpg = null; |
|||
try { |
|||
kpg = KeyPairGenerator.getInstance(algorithm, provider); |
|||
} catch (NoSuchAlgorithmException | NoSuchProviderException e) { |
|||
log.error("", e); |
|||
} |
|||
ECGenParameterSpec ecsp = new ECGenParameterSpec(nameParameterSpec); |
|||
try { |
|||
kpg.initialize(ecsp); |
|||
} catch (InvalidAlgorithmParameterException e) { |
|||
log.error("", e); |
|||
} |
|||
|
|||
KeyPair kp = kpg.genKeyPair(); |
|||
PrivateKey privKey = kp.getPrivate(); |
|||
PublicKey pubKey = kp.getPublic(); |
|||
|
|||
if (pubKey instanceof ECPublicKey) { |
|||
ECPublicKey ecPublicKey = (ECPublicKey) pubKey; |
|||
/* Get x coordinate */ |
|||
byte[] x = ecPublicKey.getW().getAffineX().toByteArray(); |
|||
if (x[0] == 0) |
|||
x = Arrays.copyOfRange(x, 1, x.length); |
|||
|
|||
/* Get Y coordinate */ |
|||
byte[] y = ecPublicKey.getW().getAffineY().toByteArray(); |
|||
if (y[0] == 0) |
|||
y = Arrays.copyOfRange(y, 1, y.length); |
|||
|
|||
/* Get Curves params */ |
|||
String privHex = Hex.encodeHexString(privKey.getEncoded()); |
|||
log.info("\nCreating new RPK for the next start... \n" + |
|||
" Public Key (Hex): [{}]\n" + |
|||
" Private Key (Hex): [{}]" + |
|||
" public_x : [{}] \n" + |
|||
" public_y : [{}] \n" + |
|||
" private_encode : [{}] \n" + |
|||
" Elliptic Curve parameters : [{}] \n", |
|||
Hex.encodeHexString(pubKey.getEncoded()), |
|||
privHex, |
|||
Hex.encodeHexString(x), |
|||
Hex.encodeHexString(y), |
|||
privHex, |
|||
ecPublicKey.getParams().toString()); |
|||
} |
|||
} |
|||
} |
|||
|
|||
@ -0,0 +1,53 @@ |
|||
/** |
|||
* Copyright © 2016-2021 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.common.util; |
|||
|
|||
import lombok.EqualsAndHashCode; |
|||
import lombok.Getter; |
|||
import lombok.ToString; |
|||
|
|||
import java.util.LinkedHashMap; |
|||
import java.util.Map; |
|||
import java.util.function.BiConsumer; |
|||
|
|||
/** |
|||
* LinkedHashMap that removed eldest entries (by insert order) |
|||
* It guaranteed that size is not greater then maxEntries parameter. And remove time is constant O(1). |
|||
* Example: |
|||
* LinkedHashMapRemoveEldest<Long, String> map = |
|||
* new LinkedHashMapRemoveEldest<>(MAX_ENTRIES, this::removeConsumer); |
|||
* */ |
|||
@Getter |
|||
@ToString(callSuper = true) |
|||
@EqualsAndHashCode(callSuper = true) |
|||
public class LinkedHashMapRemoveEldest<K, V> extends LinkedHashMap<K, V> { |
|||
final long maxEntries; |
|||
final BiConsumer<K, V> removalConsumer; |
|||
|
|||
public LinkedHashMapRemoveEldest(long maxEntries, BiConsumer<K, V> removalConsumer) { |
|||
this.maxEntries = maxEntries; |
|||
this.removalConsumer = removalConsumer; |
|||
} |
|||
|
|||
@Override |
|||
protected boolean removeEldestEntry(Map.Entry<K, V> eldest) { |
|||
if (size() <= maxEntries) { |
|||
return false; |
|||
} |
|||
removalConsumer.accept(eldest.getKey(), eldest.getValue()); |
|||
return true; |
|||
} |
|||
} |
|||
@ -0,0 +1,64 @@ |
|||
/** |
|||
* Copyright © 2016-2021 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.common.util; |
|||
|
|||
import org.hamcrest.Matchers; |
|||
import org.junit.Test; |
|||
|
|||
import java.util.LinkedHashMap; |
|||
|
|||
import static org.hamcrest.CoreMatchers.instanceOf; |
|||
import static org.hamcrest.CoreMatchers.is; |
|||
import static org.hamcrest.CoreMatchers.notNullValue; |
|||
import static org.hamcrest.MatcherAssert.assertThat; |
|||
|
|||
public class LinkedHashMapRemoveEldestTest { |
|||
|
|||
public static final long MAX_ENTRIES = 10L; |
|||
long removeCount = 0; |
|||
|
|||
void removalConsumer(Long id, String name) { |
|||
removeCount++; |
|||
assertThat(id, is(Matchers.lessThan(MAX_ENTRIES))); |
|||
assertThat(name, is(id.toString())); |
|||
} |
|||
|
|||
@Test |
|||
public void givenMap_whenOverSized_thenVerifyRemovedEldest() { |
|||
//given
|
|||
LinkedHashMapRemoveEldest<Long, String> map = |
|||
new LinkedHashMapRemoveEldest<>(MAX_ENTRIES, this::removalConsumer); |
|||
|
|||
assertThat(map.getMaxEntries(), is(MAX_ENTRIES)); |
|||
assertThat(map.getRemovalConsumer(), notNullValue()); |
|||
assertThat(map, instanceOf(LinkedHashMap.class)); |
|||
assertThat(map, instanceOf(LinkedHashMapRemoveEldest.class)); |
|||
assertThat(map.size(), is(0)); |
|||
|
|||
//when
|
|||
for (long i = 0; i < MAX_ENTRIES * 2; i++) { |
|||
map.put(i, String.valueOf(i)); |
|||
} |
|||
|
|||
//then
|
|||
assertThat((long) map.size(), is(MAX_ENTRIES)); |
|||
assertThat(removeCount, is(MAX_ENTRIES)); |
|||
for (long i = MAX_ENTRIES; i < MAX_ENTRIES * 2; i++) { |
|||
assertThat(map.get(i), is(String.valueOf(i))); |
|||
} |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,63 @@ |
|||
/** |
|||
* Copyright © 2016-2021 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.attributes; |
|||
|
|||
import com.google.common.util.concurrent.MoreExecutors; |
|||
import org.junit.Test; |
|||
import org.thingsboard.server.dao.cache.CacheExecutorService; |
|||
|
|||
import static org.hamcrest.CoreMatchers.is; |
|||
import static org.hamcrest.MatcherAssert.assertThat; |
|||
import static org.mockito.ArgumentMatchers.any; |
|||
import static org.mockito.BDDMockito.willCallRealMethod; |
|||
import static org.mockito.Mockito.mock; |
|||
|
|||
public class CachedAttributesServiceTest { |
|||
|
|||
public static final String REDIS = "redis"; |
|||
|
|||
@Test |
|||
public void givenLocalCacheTypeName_whenEquals_thenOK() { |
|||
assertThat(CachedAttributesService.LOCAL_CACHE_TYPE, is("caffeine")); |
|||
} |
|||
|
|||
@Test |
|||
public void givenCacheType_whenGetExecutor_thenDirectExecutor() { |
|||
CachedAttributesService cachedAttributesService = mock(CachedAttributesService.class); |
|||
CacheExecutorService cacheExecutorService = mock(CacheExecutorService.class); |
|||
willCallRealMethod().given(cachedAttributesService).getExecutor(any(), any()); |
|||
|
|||
assertThat(cachedAttributesService.getExecutor(null, cacheExecutorService), is(MoreExecutors.directExecutor())); |
|||
|
|||
assertThat(cachedAttributesService.getExecutor("", cacheExecutorService), is(MoreExecutors.directExecutor())); |
|||
|
|||
assertThat(cachedAttributesService.getExecutor(CachedAttributesService.LOCAL_CACHE_TYPE, cacheExecutorService), is(MoreExecutors.directExecutor())); |
|||
|
|||
} |
|||
|
|||
@Test |
|||
public void givenCacheType_whenGetExecutor_thenReturnCacheExecutorService() { |
|||
CachedAttributesService cachedAttributesService = mock(CachedAttributesService.class); |
|||
CacheExecutorService cacheExecutorService = mock(CacheExecutorService.class); |
|||
willCallRealMethod().given(cachedAttributesService).getExecutor(any(String.class), any(CacheExecutorService.class)); |
|||
|
|||
assertThat(cachedAttributesService.getExecutor(REDIS, cacheExecutorService), is(cacheExecutorService)); |
|||
|
|||
assertThat(cachedAttributesService.getExecutor("unknownCacheType", cacheExecutorService), is(cacheExecutorService)); |
|||
|
|||
} |
|||
|
|||
} |
|||
File diff suppressed because one or more lines are too long
Some files were not shown because too many files changed in this diff
Loading…
Reference in new issue