AndrewVolosytnykhThingsboard
5 years ago
198 changed files with 8733 additions and 4821 deletions
File diff suppressed because one or more lines are too long
@ -0,0 +1,222 @@ |
|||
/** |
|||
* 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; |
|||
|
|||
import com.fasterxml.jackson.core.type.TypeReference; |
|||
import org.apache.commons.io.IOUtils; |
|||
import org.eclipse.leshan.core.util.Hex; |
|||
import org.junit.After; |
|||
import org.junit.Assert; |
|||
import org.junit.Before; |
|||
import org.thingsboard.common.util.JacksonUtil; |
|||
import org.thingsboard.server.common.data.DeviceProfile; |
|||
import org.thingsboard.server.common.data.DeviceProfileProvisionType; |
|||
import org.thingsboard.server.common.data.DeviceProfileType; |
|||
import org.thingsboard.server.common.data.DeviceTransportType; |
|||
import org.thingsboard.server.common.data.ResourceType; |
|||
import org.thingsboard.server.common.data.TbResource; |
|||
import org.thingsboard.server.common.data.device.profile.DefaultDeviceProfileConfiguration; |
|||
import org.thingsboard.server.common.data.device.profile.DeviceProfileData; |
|||
import org.thingsboard.server.common.data.device.profile.DisabledDeviceProfileProvisionConfiguration; |
|||
import org.thingsboard.server.common.data.device.profile.Lwm2mDeviceProfileTransportConfiguration; |
|||
import org.thingsboard.server.controller.AbstractWebsocketTest; |
|||
import org.thingsboard.server.controller.TbTestWebSocketClient; |
|||
import org.thingsboard.server.dao.service.DaoSqlTest; |
|||
|
|||
import java.io.IOException; |
|||
import java.io.InputStream; |
|||
import java.math.BigInteger; |
|||
import java.security.AlgorithmParameters; |
|||
import java.security.GeneralSecurityException; |
|||
import java.security.KeyFactory; |
|||
import java.security.KeyStore; |
|||
import java.security.PrivateKey; |
|||
import java.security.PublicKey; |
|||
import java.security.cert.Certificate; |
|||
import java.security.cert.X509Certificate; |
|||
import java.security.spec.ECGenParameterSpec; |
|||
import java.security.spec.ECParameterSpec; |
|||
import java.security.spec.ECPoint; |
|||
import java.security.spec.ECPrivateKeySpec; |
|||
import java.security.spec.ECPublicKeySpec; |
|||
import java.security.spec.KeySpec; |
|||
import java.util.Base64; |
|||
import java.util.concurrent.Executors; |
|||
import java.util.concurrent.ScheduledExecutorService; |
|||
|
|||
@DaoSqlTest |
|||
public class AbstractLwM2MIntegrationTest extends AbstractWebsocketTest { |
|||
|
|||
protected DeviceProfile deviceProfile; |
|||
protected ScheduledExecutorService executor; |
|||
protected TbTestWebSocketClient wsClient; |
|||
|
|||
protected final PublicKey clientPublicKey; // client public key used for RPK
|
|||
protected final PrivateKey clientPrivateKey; // client private key used for RPK
|
|||
protected final PublicKey serverPublicKey; // server public key used for RPK
|
|||
protected final PrivateKey serverPrivateKey; // server private key used for RPK
|
|||
|
|||
// client private key used for X509
|
|||
protected final PrivateKey clientPrivateKeyFromCert; |
|||
// server private key used for X509
|
|||
protected final PrivateKey serverPrivateKeyFromCert; |
|||
// client certificate signed by rootCA with a good CN (CN start by leshan_integration_test)
|
|||
protected final X509Certificate clientX509Cert; |
|||
// client certificate signed by rootCA but with bad CN (CN does not start by leshan_integration_test)
|
|||
protected final X509Certificate clientX509CertWithBadCN; |
|||
// client certificate self-signed with a good CN (CN start by leshan_integration_test)
|
|||
protected final X509Certificate clientX509CertSelfSigned; |
|||
// client certificate signed by another CA (not rootCA) with a good CN (CN start by leshan_integration_test)
|
|||
protected final X509Certificate clientX509CertNotTrusted; |
|||
// server certificate signed by rootCA
|
|||
protected final X509Certificate serverX509Cert; |
|||
// self-signed server certificate
|
|||
protected final X509Certificate serverX509CertSelfSigned; |
|||
// rootCA used by the server
|
|||
protected final X509Certificate rootCAX509Cert; |
|||
// certificates trustedby the server (should contain rootCA)
|
|||
protected final Certificate[] trustedCertificates = new Certificate[1]; |
|||
|
|||
public AbstractLwM2MIntegrationTest() { |
|||
// create client credentials
|
|||
try { |
|||
// Get point values
|
|||
byte[] publicX = Hex |
|||
.decodeHex("89c048261979208666f2bfb188be1968fc9021c416ce12828c06f4e314c167b5".toCharArray()); |
|||
byte[] publicY = Hex |
|||
.decodeHex("cbf1eb7587f08e01688d9ada4be859137ca49f79394bad9179326b3090967b68".toCharArray()); |
|||
byte[] privateS = Hex |
|||
.decodeHex("e67b68d2aaeb6550f19d98cade3ad62b39532e02e6b422e1f7ea189dabaea5d2".toCharArray()); |
|||
|
|||
// Get Elliptic Curve Parameter spec for secp256r1
|
|||
AlgorithmParameters algoParameters = AlgorithmParameters.getInstance("EC"); |
|||
algoParameters.init(new ECGenParameterSpec("secp256r1")); |
|||
ECParameterSpec parameterSpec = algoParameters.getParameterSpec(ECParameterSpec.class); |
|||
|
|||
// Create key specs
|
|||
KeySpec publicKeySpec = new ECPublicKeySpec(new ECPoint(new BigInteger(publicX), new BigInteger(publicY)), |
|||
parameterSpec); |
|||
KeySpec privateKeySpec = new ECPrivateKeySpec(new BigInteger(privateS), parameterSpec); |
|||
|
|||
// Get keys
|
|||
clientPublicKey = KeyFactory.getInstance("EC").generatePublic(publicKeySpec); |
|||
clientPrivateKey = KeyFactory.getInstance("EC").generatePrivate(privateKeySpec); |
|||
|
|||
// Get certificates from key store
|
|||
char[] clientKeyStorePwd = "client".toCharArray(); |
|||
KeyStore clientKeyStore = KeyStore.getInstance(KeyStore.getDefaultType()); |
|||
try (InputStream clientKeyStoreFile = this.getClass().getClassLoader().getResourceAsStream("lwm2m/credentials/clientKeyStore.jks")) { |
|||
clientKeyStore.load(clientKeyStoreFile, clientKeyStorePwd); |
|||
} |
|||
|
|||
clientPrivateKeyFromCert = (PrivateKey) clientKeyStore.getKey("client", clientKeyStorePwd); |
|||
clientX509Cert = (X509Certificate) clientKeyStore.getCertificate("client"); |
|||
clientX509CertWithBadCN = (X509Certificate) clientKeyStore.getCertificate("client_bad_cn"); |
|||
clientX509CertSelfSigned = (X509Certificate) clientKeyStore.getCertificate("client_self_signed"); |
|||
clientX509CertNotTrusted = (X509Certificate) clientKeyStore.getCertificate("client_not_trusted"); |
|||
} catch (GeneralSecurityException | IOException e) { |
|||
throw new RuntimeException(e); |
|||
} |
|||
|
|||
// create server credentials
|
|||
try { |
|||
// Get point values
|
|||
byte[] publicX = Hex |
|||
.decodeHex("fcc28728c123b155be410fc1c0651da374fc6ebe7f96606e90d927d188894a73".toCharArray()); |
|||
byte[] publicY = Hex |
|||
.decodeHex("d2ffaa73957d76984633fc1cc54d0b763ca0559a9dff9706e9f4557dacc3f52a".toCharArray()); |
|||
byte[] privateS = Hex |
|||
.decodeHex("1dae121ba406802ef07c193c1ee4df91115aabd79c1ed7f4c0ef7ef6a5449400".toCharArray()); |
|||
|
|||
// Get Elliptic Curve Parameter spec for secp256r1
|
|||
AlgorithmParameters algoParameters = AlgorithmParameters.getInstance("EC"); |
|||
algoParameters.init(new ECGenParameterSpec("secp256r1")); |
|||
ECParameterSpec parameterSpec = algoParameters.getParameterSpec(ECParameterSpec.class); |
|||
|
|||
// Create key specs
|
|||
KeySpec publicKeySpec = new ECPublicKeySpec(new ECPoint(new BigInteger(publicX), new BigInteger(publicY)), |
|||
parameterSpec); |
|||
KeySpec privateKeySpec = new ECPrivateKeySpec(new BigInteger(privateS), parameterSpec); |
|||
|
|||
// Get keys
|
|||
serverPublicKey = KeyFactory.getInstance("EC").generatePublic(publicKeySpec); |
|||
serverPrivateKey = KeyFactory.getInstance("EC").generatePrivate(privateKeySpec); |
|||
|
|||
// Get certificates from key store
|
|||
char[] serverKeyStorePwd = "server".toCharArray(); |
|||
KeyStore serverKeyStore = KeyStore.getInstance(KeyStore.getDefaultType()); |
|||
try (InputStream serverKeyStoreFile = this.getClass().getClassLoader().getResourceAsStream("lwm2m/credentials/serverKeyStore.jks")) { |
|||
serverKeyStore.load(serverKeyStoreFile, serverKeyStorePwd); |
|||
} |
|||
|
|||
serverPrivateKeyFromCert = (PrivateKey) serverKeyStore.getKey("server", serverKeyStorePwd); |
|||
rootCAX509Cert = (X509Certificate) serverKeyStore.getCertificate("rootCA"); |
|||
serverX509Cert = (X509Certificate) serverKeyStore.getCertificate("server"); |
|||
serverX509CertSelfSigned = (X509Certificate) serverKeyStore.getCertificate("server_self_signed"); |
|||
trustedCertificates[0] = rootCAX509Cert; |
|||
} catch (GeneralSecurityException | IOException e) { |
|||
throw new RuntimeException(e); |
|||
} |
|||
} |
|||
|
|||
@Before |
|||
public void beforeTest() throws Exception { |
|||
executor = Executors.newScheduledThreadPool(10); |
|||
loginTenantAdmin(); |
|||
|
|||
String[] resources = new String[]{"1.xml", "2.xml", "3.xml"}; |
|||
for (String resourceName : resources) { |
|||
TbResource lwModel = new TbResource(); |
|||
lwModel.setResourceType(ResourceType.LWM2M_MODEL); |
|||
lwModel.setTitle(resourceName); |
|||
lwModel.setFileName(resourceName); |
|||
lwModel.setTenantId(tenantId); |
|||
byte[] bytes = IOUtils.toByteArray(AbstractLwM2MIntegrationTest.class.getClassLoader().getResourceAsStream("lwm2m/" + resourceName)); |
|||
lwModel.setData(Base64.getEncoder().encodeToString(bytes)); |
|||
lwModel = doPostWithTypedResponse("/api/resource", lwModel, new TypeReference<>() { |
|||
}); |
|||
Assert.assertNotNull(lwModel); |
|||
} |
|||
wsClient = buildAndConnectWebSocketClient(); |
|||
} |
|||
|
|||
protected void createDeviceProfile(String transportConfiguration) throws Exception { |
|||
deviceProfile = new DeviceProfile(); |
|||
|
|||
deviceProfile.setName("LwM2M"); |
|||
deviceProfile.setType(DeviceProfileType.DEFAULT); |
|||
deviceProfile.setTenantId(tenantId); |
|||
deviceProfile.setTransportType(DeviceTransportType.LWM2M); |
|||
deviceProfile.setProvisionType(DeviceProfileProvisionType.DISABLED); |
|||
deviceProfile.setDescription(deviceProfile.getName()); |
|||
|
|||
DeviceProfileData deviceProfileData = new DeviceProfileData(); |
|||
deviceProfileData.setConfiguration(new DefaultDeviceProfileConfiguration()); |
|||
deviceProfileData.setProvisionConfiguration(new DisabledDeviceProfileProvisionConfiguration(null)); |
|||
deviceProfileData.setTransportConfiguration(JacksonUtil.fromString(transportConfiguration, Lwm2mDeviceProfileTransportConfiguration.class)); |
|||
deviceProfile.setProfileData(deviceProfileData); |
|||
|
|||
deviceProfile = doPost("/api/deviceProfile", deviceProfile, DeviceProfile.class); |
|||
Assert.assertNotNull(deviceProfile); |
|||
} |
|||
|
|||
@After |
|||
public void after() { |
|||
executor.shutdownNow(); |
|||
wsClient.close(); |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,163 @@ |
|||
/** |
|||
* 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; |
|||
|
|||
import org.eclipse.californium.core.network.config.NetworkConfig; |
|||
import org.eclipse.leshan.client.object.Security; |
|||
import org.jetbrains.annotations.NotNull; |
|||
import org.junit.Assert; |
|||
import org.junit.Test; |
|||
import org.thingsboard.common.util.JacksonUtil; |
|||
import org.thingsboard.server.common.data.Device; |
|||
import org.thingsboard.server.common.data.query.EntityData; |
|||
import org.thingsboard.server.common.data.query.EntityDataPageLink; |
|||
import org.thingsboard.server.common.data.query.EntityDataQuery; |
|||
import org.thingsboard.server.common.data.query.EntityKey; |
|||
import org.thingsboard.server.common.data.query.EntityKeyType; |
|||
import org.thingsboard.server.common.data.query.SingleEntityFilter; |
|||
import org.thingsboard.server.common.data.security.DeviceCredentials; |
|||
import org.thingsboard.server.common.data.security.DeviceCredentialsType; |
|||
import org.thingsboard.server.service.telemetry.cmd.TelemetryPluginCmdsWrapper; |
|||
import org.thingsboard.server.service.telemetry.cmd.v2.EntityDataCmd; |
|||
import org.thingsboard.server.service.telemetry.cmd.v2.EntityDataUpdate; |
|||
import org.thingsboard.server.service.telemetry.cmd.v2.LatestValueCmd; |
|||
import org.thingsboard.server.transport.lwm2m.client.LwM2MTestClient; |
|||
import org.thingsboard.server.transport.lwm2m.secure.credentials.LwM2MCredentials; |
|||
import org.thingsboard.server.common.data.device.credentials.lwm2m.NoSecClientCredentials; |
|||
|
|||
import java.util.Collections; |
|||
import java.util.List; |
|||
|
|||
import static org.eclipse.leshan.client.object.Security.noSec; |
|||
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; |
|||
|
|||
public class NoSecLwM2MIntegrationTest extends AbstractLwM2MIntegrationTest { |
|||
|
|||
protected final String TRANSPORT_CONFIGURATION = "{\n" + |
|||
" \"type\": \"LWM2M\",\n" + |
|||
" \"observeAttr\": {\n" + |
|||
" \"keyName\": {\n" + |
|||
" \"/3_1.0/0/9\": \"batteryLevel\"\n" + |
|||
" },\n" + |
|||
" \"observe\": [],\n" + |
|||
" \"attribute\": [\n" + |
|||
" ],\n" + |
|||
" \"telemetry\": [\n" + |
|||
" \"/3_1.0/0/9\"\n" + |
|||
" ],\n" + |
|||
" \"attributeLwm2m\": {}\n" + |
|||
" },\n" + |
|||
" \"bootstrap\": {\n" + |
|||
" \"servers\": {\n" + |
|||
" \"binding\": \"UQ\",\n" + |
|||
" \"shortId\": 123,\n" + |
|||
" \"lifetime\": 300,\n" + |
|||
" \"notifIfDisabled\": true,\n" + |
|||
" \"defaultMinPeriod\": 1\n" + |
|||
" },\n" + |
|||
" \"lwm2mServer\": {\n" + |
|||
" \"host\": \"localhost\",\n" + |
|||
" \"port\": 5685,\n" + |
|||
" \"serverId\": 123,\n" + |
|||
" \"securityMode\": \"NO_SEC\",\n" + |
|||
" \"serverPublicKey\": \"\",\n" + |
|||
" \"bootstrapServerIs\": false,\n" + |
|||
" \"clientHoldOffTime\": 1,\n" + |
|||
" \"bootstrapServerAccountTimeout\": 0\n" + |
|||
" },\n" + |
|||
" \"bootstrapServer\": {\n" + |
|||
" \"host\": \"localhost\",\n" + |
|||
" \"port\": 5687,\n" + |
|||
" \"serverId\": 111,\n" + |
|||
" \"securityMode\": \"NO_SEC\",\n" + |
|||
" \"serverPublicKey\": \"\",\n" + |
|||
" \"bootstrapServerIs\": true,\n" + |
|||
" \"clientHoldOffTime\": 1,\n" + |
|||
" \"bootstrapServerAccountTimeout\": 0\n" + |
|||
" }\n" + |
|||
" },\n" + |
|||
" \"clientLwM2mSettings\": {\n" + |
|||
" \"clientOnlyObserveAfterConnect\": 1\n" + |
|||
" }\n" + |
|||
"}"; |
|||
|
|||
private final int port = 5685; |
|||
private final Security security = noSec("coap://localhost:" + port, 123); |
|||
private final NetworkConfig coapConfig = new NetworkConfig().setString("COAP_PORT", Integer.toString(port)); |
|||
|
|||
@NotNull |
|||
private Device createDevice(String deviceAEndpoint) throws Exception { |
|||
Device device = new Device(); |
|||
device.setName("Device A"); |
|||
device.setDeviceProfileId(deviceProfile.getId()); |
|||
device.setTenantId(tenantId); |
|||
device = doPost("/api/device", device, Device.class); |
|||
Assert.assertNotNull(device); |
|||
|
|||
DeviceCredentials deviceCredentials = |
|||
doGet("/api/device/" + device.getId().getId().toString() + "/credentials", DeviceCredentials.class); |
|||
Assert.assertEquals(device.getId(), deviceCredentials.getDeviceId()); |
|||
deviceCredentials.setCredentialsType(DeviceCredentialsType.LWM2M_CREDENTIALS); |
|||
|
|||
LwM2MCredentials noSecCredentials = new LwM2MCredentials(); |
|||
NoSecClientCredentials clientCredentials = new NoSecClientCredentials(); |
|||
clientCredentials.setEndpoint(deviceAEndpoint); |
|||
noSecCredentials.setClient(clientCredentials); |
|||
deviceCredentials.setCredentialsValue(JacksonUtil.toString(noSecCredentials)); |
|||
doPost("/api/device/credentials", deviceCredentials).andExpect(status().isOk()); |
|||
return device; |
|||
} |
|||
|
|||
@Test |
|||
public void testConnectAndObserveTelemetry() throws Exception { |
|||
createDeviceProfile(TRANSPORT_CONFIGURATION); |
|||
|
|||
String deviceAEndpoint = "deviceAEndpoint"; |
|||
|
|||
Device device = createDevice(deviceAEndpoint); |
|||
|
|||
SingleEntityFilter sef = new SingleEntityFilter(); |
|||
sef.setSingleEntity(device.getId()); |
|||
LatestValueCmd latestCmd = new LatestValueCmd(); |
|||
latestCmd.setKeys(Collections.singletonList(new EntityKey(EntityKeyType.TIME_SERIES, "batteryLevel"))); |
|||
EntityDataQuery edq = new EntityDataQuery(sef, new EntityDataPageLink(1, 0, null, null), |
|||
Collections.emptyList(), Collections.emptyList(), Collections.emptyList()); |
|||
|
|||
EntityDataCmd cmd = new EntityDataCmd(1, edq, null, latestCmd, null); |
|||
TelemetryPluginCmdsWrapper wrapper = new TelemetryPluginCmdsWrapper(); |
|||
wrapper.setEntityDataCmds(Collections.singletonList(cmd)); |
|||
|
|||
wsClient.send(mapper.writeValueAsString(wrapper)); |
|||
wsClient.waitForReply(); |
|||
|
|||
wsClient.registerWaitForUpdate(); |
|||
LwM2MTestClient client = new LwM2MTestClient(executor, deviceAEndpoint); |
|||
client.init(security, coapConfig); |
|||
String msg = wsClient.waitForUpdate(); |
|||
|
|||
EntityDataUpdate update = mapper.readValue(msg, EntityDataUpdate.class); |
|||
Assert.assertEquals(1, update.getCmdId()); |
|||
List<EntityData> eData = update.getUpdate(); |
|||
Assert.assertNotNull(eData); |
|||
Assert.assertEquals(1, eData.size()); |
|||
Assert.assertEquals(device.getId(), eData.get(0).getEntityId()); |
|||
Assert.assertNotNull(eData.get(0).getLatest().get(EntityKeyType.TIME_SERIES)); |
|||
var tsValue = eData.get(0).getLatest().get(EntityKeyType.TIME_SERIES).get("batteryLevel"); |
|||
Assert.assertEquals(42, Long.parseLong(tsValue.getValue())); |
|||
client.destroy(); |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,207 @@ |
|||
/** |
|||
* 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; |
|||
|
|||
import org.eclipse.californium.core.network.config.NetworkConfig; |
|||
import org.eclipse.leshan.client.object.Security; |
|||
import org.jetbrains.annotations.NotNull; |
|||
import org.junit.Assert; |
|||
import org.junit.Test; |
|||
import org.thingsboard.common.util.JacksonUtil; |
|||
import org.thingsboard.server.common.data.Device; |
|||
import org.thingsboard.server.common.data.device.credentials.lwm2m.X509ClientCredentials; |
|||
import org.thingsboard.server.common.data.query.EntityData; |
|||
import org.thingsboard.server.common.data.query.EntityDataPageLink; |
|||
import org.thingsboard.server.common.data.query.EntityDataQuery; |
|||
import org.thingsboard.server.common.data.query.EntityKey; |
|||
import org.thingsboard.server.common.data.query.EntityKeyType; |
|||
import org.thingsboard.server.common.data.query.SingleEntityFilter; |
|||
import org.thingsboard.server.common.data.security.DeviceCredentials; |
|||
import org.thingsboard.server.common.data.security.DeviceCredentialsType; |
|||
import org.thingsboard.server.common.transport.util.SslUtil; |
|||
import org.thingsboard.server.service.telemetry.cmd.TelemetryPluginCmdsWrapper; |
|||
import org.thingsboard.server.service.telemetry.cmd.v2.EntityDataCmd; |
|||
import org.thingsboard.server.service.telemetry.cmd.v2.EntityDataUpdate; |
|||
import org.thingsboard.server.service.telemetry.cmd.v2.LatestValueCmd; |
|||
import org.thingsboard.server.transport.lwm2m.client.LwM2MTestClient; |
|||
import org.thingsboard.server.transport.lwm2m.secure.credentials.LwM2MCredentials; |
|||
|
|||
import java.util.Collections; |
|||
import java.util.List; |
|||
|
|||
import static org.eclipse.leshan.client.object.Security.x509; |
|||
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; |
|||
|
|||
public class X509LwM2MIntegrationTest extends AbstractLwM2MIntegrationTest { |
|||
|
|||
protected final String TRANSPORT_CONFIGURATION = "{\n" + |
|||
" \"type\": \"LWM2M\",\n" + |
|||
" \"observeAttr\": {\n" + |
|||
" \"keyName\": {\n" + |
|||
" \"/3_1.0/0/9\": \"batteryLevel\"\n" + |
|||
" },\n" + |
|||
" \"observe\": [],\n" + |
|||
" \"attribute\": [\n" + |
|||
" ],\n" + |
|||
" \"telemetry\": [\n" + |
|||
" \"/3_1.0/0/9\"\n" + |
|||
" ],\n" + |
|||
" \"attributeLwm2m\": {}\n" + |
|||
" },\n" + |
|||
" \"bootstrap\": {\n" + |
|||
" \"servers\": {\n" + |
|||
" \"binding\": \"UQ\",\n" + |
|||
" \"shortId\": 123,\n" + |
|||
" \"lifetime\": 300,\n" + |
|||
" \"notifIfDisabled\": true,\n" + |
|||
" \"defaultMinPeriod\": 1\n" + |
|||
" },\n" + |
|||
" \"lwm2mServer\": {\n" + |
|||
" \"host\": \"localhost\",\n" + |
|||
" \"port\": 5686,\n" + |
|||
" \"serverId\": 123,\n" + |
|||
" \"serverPublicKey\": \"\",\n" + |
|||
" \"bootstrapServerIs\": false,\n" + |
|||
" \"clientHoldOffTime\": 1,\n" + |
|||
" \"bootstrapServerAccountTimeout\": 0\n" + |
|||
" },\n" + |
|||
" \"bootstrapServer\": {\n" + |
|||
" \"host\": \"localhost\",\n" + |
|||
" \"port\": 5687,\n" + |
|||
" \"serverId\": 111,\n" + |
|||
" \"securityMode\": \"NO_SEC\",\n" + |
|||
" \"serverPublicKey\": \"\",\n" + |
|||
" \"bootstrapServerIs\": true,\n" + |
|||
" \"clientHoldOffTime\": 1,\n" + |
|||
" \"bootstrapServerAccountTimeout\": 0\n" + |
|||
" }\n" + |
|||
" },\n" + |
|||
" \"clientLwM2mSettings\": {\n" + |
|||
" \"clientOnlyObserveAfterConnect\": 1\n" + |
|||
" }\n" + |
|||
"}"; |
|||
|
|||
|
|||
private final int port = 5686; |
|||
private final NetworkConfig coapConfig = new NetworkConfig().setString("COAP_SECURE_PORT", Integer.toString(port)); |
|||
private final String endpoint = "deviceAEndpoint"; |
|||
private final String serverUri = "coaps://localhost:" + port; |
|||
|
|||
@NotNull |
|||
private Device createDevice(X509ClientCredentials clientCredentials) throws Exception { |
|||
Device device = new Device(); |
|||
device.setName("Device A"); |
|||
device.setDeviceProfileId(deviceProfile.getId()); |
|||
device.setTenantId(tenantId); |
|||
device = doPost("/api/device", device, Device.class); |
|||
Assert.assertNotNull(device); |
|||
|
|||
DeviceCredentials deviceCredentials = |
|||
doGet("/api/device/" + device.getId().getId().toString() + "/credentials", DeviceCredentials.class); |
|||
Assert.assertEquals(device.getId(), deviceCredentials.getDeviceId()); |
|||
deviceCredentials.setCredentialsType(DeviceCredentialsType.LWM2M_CREDENTIALS); |
|||
|
|||
LwM2MCredentials credentials = new LwM2MCredentials(); |
|||
|
|||
credentials.setClient(clientCredentials); |
|||
|
|||
deviceCredentials.setCredentialsValue(JacksonUtil.toString(credentials)); |
|||
doPost("/api/device/credentials", deviceCredentials).andExpect(status().isOk()); |
|||
return device; |
|||
} |
|||
|
|||
@Test |
|||
public void testConnectAndObserveTelemetry() throws Exception { |
|||
createDeviceProfile(TRANSPORT_CONFIGURATION); |
|||
X509ClientCredentials credentials = new X509ClientCredentials(); |
|||
credentials.setEndpoint(endpoint); |
|||
Device device = createDevice(credentials); |
|||
|
|||
SingleEntityFilter sef = new SingleEntityFilter(); |
|||
sef.setSingleEntity(device.getId()); |
|||
LatestValueCmd latestCmd = new LatestValueCmd(); |
|||
latestCmd.setKeys(Collections.singletonList(new EntityKey(EntityKeyType.TIME_SERIES, "batteryLevel"))); |
|||
EntityDataQuery edq = new EntityDataQuery(sef, new EntityDataPageLink(1, 0, null, null), |
|||
Collections.emptyList(), Collections.emptyList(), Collections.emptyList()); |
|||
|
|||
EntityDataCmd cmd = new EntityDataCmd(1, edq, null, latestCmd, null); |
|||
TelemetryPluginCmdsWrapper wrapper = new TelemetryPluginCmdsWrapper(); |
|||
wrapper.setEntityDataCmds(Collections.singletonList(cmd)); |
|||
|
|||
wsClient.send(mapper.writeValueAsString(wrapper)); |
|||
wsClient.waitForReply(); |
|||
|
|||
wsClient.registerWaitForUpdate(); |
|||
LwM2MTestClient client = new LwM2MTestClient(executor, endpoint); |
|||
Security security = x509(serverUri, 123, clientX509Cert.getEncoded(), clientPrivateKeyFromCert.getEncoded(), serverX509Cert.getEncoded()); |
|||
client.init(security, coapConfig); |
|||
String msg = wsClient.waitForUpdate(); |
|||
|
|||
EntityDataUpdate update = mapper.readValue(msg, EntityDataUpdate.class); |
|||
Assert.assertEquals(1, update.getCmdId()); |
|||
List<EntityData> eData = update.getUpdate(); |
|||
Assert.assertNotNull(eData); |
|||
Assert.assertEquals(1, eData.size()); |
|||
Assert.assertEquals(device.getId(), eData.get(0).getEntityId()); |
|||
Assert.assertNotNull(eData.get(0).getLatest().get(EntityKeyType.TIME_SERIES)); |
|||
var tsValue = eData.get(0).getLatest().get(EntityKeyType.TIME_SERIES).get("batteryLevel"); |
|||
Assert.assertEquals(42, Long.parseLong(tsValue.getValue())); |
|||
client.destroy(); |
|||
} |
|||
|
|||
@Test |
|||
public void testConnectWithCertAndObserveTelemetry() throws Exception { |
|||
createDeviceProfile(TRANSPORT_CONFIGURATION); |
|||
X509ClientCredentials credentials = new X509ClientCredentials(); |
|||
credentials.setEndpoint(endpoint); |
|||
credentials.setCert(SslUtil.getCertificateString(clientX509CertNotTrusted)); |
|||
Device device = createDevice(credentials); |
|||
|
|||
SingleEntityFilter sef = new SingleEntityFilter(); |
|||
sef.setSingleEntity(device.getId()); |
|||
LatestValueCmd latestCmd = new LatestValueCmd(); |
|||
latestCmd.setKeys(Collections.singletonList(new EntityKey(EntityKeyType.TIME_SERIES, "batteryLevel"))); |
|||
EntityDataQuery edq = new EntityDataQuery(sef, new EntityDataPageLink(1, 0, null, null), |
|||
Collections.emptyList(), Collections.emptyList(), Collections.emptyList()); |
|||
|
|||
EntityDataCmd cmd = new EntityDataCmd(1, edq, null, latestCmd, null); |
|||
TelemetryPluginCmdsWrapper wrapper = new TelemetryPluginCmdsWrapper(); |
|||
wrapper.setEntityDataCmds(Collections.singletonList(cmd)); |
|||
|
|||
wsClient.send(mapper.writeValueAsString(wrapper)); |
|||
wsClient.waitForReply(); |
|||
|
|||
wsClient.registerWaitForUpdate(); |
|||
LwM2MTestClient client = new LwM2MTestClient(executor, endpoint); |
|||
|
|||
Security security = x509(serverUri, 123, clientX509CertNotTrusted.getEncoded(), clientPrivateKeyFromCert.getEncoded(), serverX509Cert.getEncoded()); |
|||
|
|||
client.init(security, coapConfig); |
|||
String msg = wsClient.waitForUpdate(); |
|||
|
|||
EntityDataUpdate update = mapper.readValue(msg, EntityDataUpdate.class); |
|||
Assert.assertEquals(1, update.getCmdId()); |
|||
List<EntityData> eData = update.getUpdate(); |
|||
Assert.assertNotNull(eData); |
|||
Assert.assertEquals(1, eData.size()); |
|||
Assert.assertEquals(device.getId(), eData.get(0).getEntityId()); |
|||
Assert.assertNotNull(eData.get(0).getLatest().get(EntityKeyType.TIME_SERIES)); |
|||
var tsValue = eData.get(0).getLatest().get(EntityKeyType.TIME_SERIES).get("batteryLevel"); |
|||
Assert.assertEquals(42, Long.parseLong(tsValue.getValue())); |
|||
client.destroy(); |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,259 @@ |
|||
/** |
|||
* 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.Data; |
|||
import lombok.extern.slf4j.Slf4j; |
|||
import org.eclipse.californium.core.network.config.NetworkConfig; |
|||
import org.eclipse.californium.elements.Connector; |
|||
import org.eclipse.californium.scandium.DTLSConnector; |
|||
import org.eclipse.californium.scandium.config.DtlsConnectorConfig; |
|||
import org.eclipse.californium.scandium.dtls.ClientHandshaker; |
|||
import org.eclipse.californium.scandium.dtls.DTLSSession; |
|||
import org.eclipse.californium.scandium.dtls.HandshakeException; |
|||
import org.eclipse.californium.scandium.dtls.Handshaker; |
|||
import org.eclipse.californium.scandium.dtls.ResumingClientHandshaker; |
|||
import org.eclipse.californium.scandium.dtls.ResumingServerHandshaker; |
|||
import org.eclipse.californium.scandium.dtls.ServerHandshaker; |
|||
import org.eclipse.californium.scandium.dtls.SessionAdapter; |
|||
import org.eclipse.leshan.client.californium.LeshanClient; |
|||
import org.eclipse.leshan.client.californium.LeshanClientBuilder; |
|||
import org.eclipse.leshan.client.engine.DefaultRegistrationEngineFactory; |
|||
import org.eclipse.leshan.client.object.Security; |
|||
import org.eclipse.leshan.client.object.Server; |
|||
import org.eclipse.leshan.client.observer.LwM2mClientObserver; |
|||
import org.eclipse.leshan.client.resource.ObjectsInitializer; |
|||
import org.eclipse.leshan.client.servers.ServerIdentity; |
|||
import org.eclipse.leshan.core.ResponseCode; |
|||
import org.eclipse.leshan.core.californium.DefaultEndpointFactory; |
|||
import org.eclipse.leshan.core.model.LwM2mModel; |
|||
import org.eclipse.leshan.core.model.ObjectLoader; |
|||
import org.eclipse.leshan.core.model.ObjectModel; |
|||
import org.eclipse.leshan.core.model.StaticModel; |
|||
import org.eclipse.leshan.core.node.codec.DefaultLwM2mNodeDecoder; |
|||
import org.eclipse.leshan.core.node.codec.DefaultLwM2mNodeEncoder; |
|||
import org.eclipse.leshan.core.request.BindingMode; |
|||
import org.eclipse.leshan.core.request.BootstrapRequest; |
|||
import org.eclipse.leshan.core.request.DeregisterRequest; |
|||
import org.eclipse.leshan.core.request.RegisterRequest; |
|||
import org.eclipse.leshan.core.request.UpdateRequest; |
|||
|
|||
import java.util.ArrayList; |
|||
import java.util.List; |
|||
import java.util.concurrent.ScheduledExecutorService; |
|||
|
|||
import static org.eclipse.leshan.core.LwM2mId.DEVICE; |
|||
import static org.eclipse.leshan.core.LwM2mId.SECURITY; |
|||
import static org.eclipse.leshan.core.LwM2mId.SERVER; |
|||
|
|||
@Slf4j |
|||
@Data |
|||
public class LwM2MTestClient { |
|||
|
|||
private final ScheduledExecutorService executor; |
|||
private final String endpoint; |
|||
private LeshanClient client; |
|||
|
|||
public void init(Security security, NetworkConfig coapConfig) { |
|||
String[] resources = new String[]{"0.xml", "1.xml", "2.xml", "3.xml"}; |
|||
List<ObjectModel> models = new ArrayList<>(); |
|||
for (String resourceName : resources) { |
|||
models.addAll(ObjectLoader.loadDdfFile(LwM2MTestClient.class.getClassLoader().getResourceAsStream("lwm2m/" + resourceName), resourceName)); |
|||
} |
|||
LwM2mModel model = new StaticModel(models); |
|||
ObjectsInitializer initializer = new ObjectsInitializer(model); |
|||
initializer.setInstancesForObject(SECURITY, security); |
|||
initializer.setInstancesForObject(SERVER, new Server(123, 300, BindingMode.U, false)); |
|||
initializer.setInstancesForObject(DEVICE, new SimpleLwM2MDevice()); |
|||
|
|||
DtlsConnectorConfig.Builder dtlsConfig = new DtlsConnectorConfig.Builder(); |
|||
dtlsConfig.setRecommendedCipherSuitesOnly(true); |
|||
|
|||
DefaultRegistrationEngineFactory engineFactory = new DefaultRegistrationEngineFactory(); |
|||
engineFactory.setReconnectOnUpdate(false); |
|||
engineFactory.setResumeOnConnect(true); |
|||
|
|||
DefaultEndpointFactory endpointFactory = new DefaultEndpointFactory(endpoint) { |
|||
@Override |
|||
protected Connector createSecuredConnector(DtlsConnectorConfig dtlsConfig) { |
|||
|
|||
return new DTLSConnector(dtlsConfig) { |
|||
@Override |
|||
protected void onInitializeHandshaker(Handshaker handshaker) { |
|||
handshaker.addSessionListener(new SessionAdapter() { |
|||
|
|||
@Override |
|||
public void handshakeStarted(Handshaker handshaker) throws HandshakeException { |
|||
if (handshaker instanceof ServerHandshaker) { |
|||
log.info("DTLS Full Handshake initiated by server : STARTED ..."); |
|||
} else if (handshaker instanceof ResumingServerHandshaker) { |
|||
log.info("DTLS abbreviated Handshake initiated by server : STARTED ..."); |
|||
} else if (handshaker instanceof ClientHandshaker) { |
|||
log.info("DTLS Full Handshake initiated by client : STARTED ..."); |
|||
} else if (handshaker instanceof ResumingClientHandshaker) { |
|||
log.info("DTLS abbreviated Handshake initiated by client : STARTED ..."); |
|||
} |
|||
} |
|||
|
|||
@Override |
|||
public void sessionEstablished(Handshaker handshaker, DTLSSession establishedSession) |
|||
throws HandshakeException { |
|||
if (handshaker instanceof ServerHandshaker) { |
|||
log.info("DTLS Full Handshake initiated by server : SUCCEED, handshaker {}", handshaker); |
|||
} else if (handshaker instanceof ResumingServerHandshaker) { |
|||
log.info("DTLS abbreviated Handshake initiated by server : SUCCEED, handshaker {}", handshaker); |
|||
} else if (handshaker instanceof ClientHandshaker) { |
|||
log.info("DTLS Full Handshake initiated by client : SUCCEED, handshaker {}", handshaker); |
|||
} else if (handshaker instanceof ResumingClientHandshaker) { |
|||
log.info("DTLS abbreviated Handshake initiated by client : SUCCEED, handshaker {}", handshaker); |
|||
} |
|||
} |
|||
|
|||
@Override |
|||
public void handshakeFailed(Handshaker handshaker, Throwable error) { |
|||
/** get cause */ |
|||
String cause; |
|||
if (error != null) { |
|||
if (error.getMessage() != null) { |
|||
cause = error.getMessage(); |
|||
} else { |
|||
cause = error.getClass().getName(); |
|||
} |
|||
} else { |
|||
cause = "unknown cause"; |
|||
} |
|||
|
|||
if (handshaker instanceof ServerHandshaker) { |
|||
log.info("DTLS Full Handshake initiated by server : FAILED [{}]", cause); |
|||
} else if (handshaker instanceof ResumingServerHandshaker) { |
|||
log.info("DTLS abbreviated Handshake initiated by server : FAILED [{}]", cause); |
|||
} else if (handshaker instanceof ClientHandshaker) { |
|||
log.info("DTLS Full Handshake initiated by client : FAILED [{}]", cause); |
|||
} else if (handshaker instanceof ResumingClientHandshaker) { |
|||
log.info("DTLS abbreviated Handshake initiated by client : FAILED [{}]", cause); |
|||
} |
|||
} |
|||
}); |
|||
} |
|||
}; |
|||
} |
|||
}; |
|||
|
|||
LeshanClientBuilder builder = new LeshanClientBuilder(endpoint); |
|||
builder.setLocalAddress("0.0.0.0", 11000); |
|||
builder.setObjects(initializer.createAll()); |
|||
builder.setCoapConfig(coapConfig); |
|||
builder.setDtlsConfig(dtlsConfig); |
|||
builder.setRegistrationEngineFactory(engineFactory); |
|||
builder.setEndpointFactory(endpointFactory); |
|||
builder.setSharedExecutor(executor); |
|||
builder.setDecoder(new DefaultLwM2mNodeDecoder(true)); |
|||
builder.setEncoder(new DefaultLwM2mNodeEncoder(true)); |
|||
client = builder.build(); |
|||
|
|||
LwM2mClientObserver observer = new LwM2mClientObserver() { |
|||
@Override |
|||
public void onBootstrapStarted(ServerIdentity bsserver, BootstrapRequest request) { |
|||
log.info("ClientObserver -> onBootstrapStarted..."); |
|||
} |
|||
|
|||
@Override |
|||
public void onBootstrapSuccess(ServerIdentity bsserver, BootstrapRequest request) { |
|||
log.info("ClientObserver -> onBootstrapSuccess..."); |
|||
} |
|||
|
|||
@Override |
|||
public void onBootstrapFailure(ServerIdentity bsserver, BootstrapRequest request, ResponseCode responseCode, String errorMessage, Exception cause) { |
|||
log.info("ClientObserver -> onBootstrapFailure..."); |
|||
} |
|||
|
|||
@Override |
|||
public void onBootstrapTimeout(ServerIdentity bsserver, BootstrapRequest request) { |
|||
log.info("ClientObserver -> onBootstrapTimeout..."); |
|||
} |
|||
|
|||
@Override |
|||
public void onRegistrationStarted(ServerIdentity server, RegisterRequest request) { |
|||
// log.info("ClientObserver -> onRegistrationStarted... EndpointName [{}]", request.getEndpointName());
|
|||
} |
|||
|
|||
@Override |
|||
public void onRegistrationSuccess(ServerIdentity server, RegisterRequest request, String registrationID) { |
|||
log.info("ClientObserver -> onRegistrationSuccess... EndpointName [{}] [{}]", request.getEndpointName(), registrationID); |
|||
} |
|||
|
|||
@Override |
|||
public void onRegistrationFailure(ServerIdentity server, RegisterRequest request, ResponseCode responseCode, String errorMessage, Exception cause) { |
|||
log.info("ClientObserver -> onRegistrationFailure... ServerIdentity [{}]", server); |
|||
} |
|||
|
|||
@Override |
|||
public void onRegistrationTimeout(ServerIdentity server, RegisterRequest request) { |
|||
log.info("ClientObserver -> onRegistrationTimeout... RegisterRequest [{}]", request); |
|||
} |
|||
|
|||
@Override |
|||
public void onUpdateStarted(ServerIdentity server, UpdateRequest request) { |
|||
// log.info("ClientObserver -> onUpdateStarted... UpdateRequest [{}]", request);
|
|||
} |
|||
|
|||
@Override |
|||
public void onUpdateSuccess(ServerIdentity server, UpdateRequest request) { |
|||
// log.info("ClientObserver -> onUpdateSuccess... UpdateRequest [{}]", request);
|
|||
} |
|||
|
|||
@Override |
|||
public void onUpdateFailure(ServerIdentity server, UpdateRequest request, ResponseCode responseCode, String errorMessage, Exception cause) { |
|||
|
|||
} |
|||
|
|||
@Override |
|||
public void onUpdateTimeout(ServerIdentity server, UpdateRequest request) { |
|||
|
|||
} |
|||
|
|||
@Override |
|||
public void onDeregistrationStarted(ServerIdentity server, DeregisterRequest request) { |
|||
log.info("ClientObserver ->onDeregistrationStarted... DeregisterRequest [{}]", request.getRegistrationId()); |
|||
|
|||
} |
|||
|
|||
@Override |
|||
public void onDeregistrationSuccess(ServerIdentity server, DeregisterRequest request) { |
|||
log.info("ClientObserver ->onDeregistrationSuccess... DeregisterRequest [{}]", request.getRegistrationId()); |
|||
|
|||
} |
|||
|
|||
@Override |
|||
public void onDeregistrationFailure(ServerIdentity server, DeregisterRequest request, ResponseCode responseCode, String errorMessage, Exception cause) { |
|||
log.info("ClientObserver ->onDeregistrationFailure... DeregisterRequest [{}] [{}]", request.getRegistrationId(), request.getRegistrationId()); |
|||
} |
|||
|
|||
@Override |
|||
public void onDeregistrationTimeout(ServerIdentity server, DeregisterRequest request) { |
|||
log.info("ClientObserver ->onDeregistrationTimeout... DeregisterRequest [{}] [{}]", request.getRegistrationId(), request.getRegistrationId()); |
|||
} |
|||
}; |
|||
this.client.addObserver(observer); |
|||
|
|||
client.start(); |
|||
} |
|||
|
|||
public void destroy() { |
|||
client.destroy(true); |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,199 @@ |
|||
/** |
|||
* 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.model.ResourceModel; |
|||
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.text.SimpleDateFormat; |
|||
import java.util.Arrays; |
|||
import java.util.Calendar; |
|||
import java.util.HashMap; |
|||
import java.util.List; |
|||
import java.util.Map; |
|||
import java.util.Random; |
|||
import java.util.TimeZone; |
|||
|
|||
@Slf4j |
|||
public class SimpleLwM2MDevice extends BaseInstanceEnabler implements Destroyable { |
|||
|
|||
|
|||
private static final Random RANDOM = new Random(); |
|||
private static final List<Integer> supportedResources = Arrays.asList(0, 1, 2, 3 |
|||
// , 9, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21
|
|||
); |
|||
|
|||
@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, getManufacturer()); |
|||
case 1: |
|||
return ReadResponse.success(resourceid, getModelNumber()); |
|||
case 2: |
|||
return ReadResponse.success(resourceid, getSerialNumber()); |
|||
case 3: |
|||
return ReadResponse.success(resourceid, getFirmwareVersion()); |
|||
case 9: |
|||
return ReadResponse.success(resourceid, getBatteryLevel()); |
|||
case 10: |
|||
return ReadResponse.success(resourceid, getMemoryFree()); |
|||
case 11: |
|||
Map<Integer, Long> errorCodes = new HashMap<>(); |
|||
errorCodes.put(0, getErrorCode()); |
|||
return ReadResponse.success(resourceid, errorCodes, ResourceModel.Type.INTEGER); |
|||
case 14: |
|||
return ReadResponse.success(resourceid, getUtcOffset()); |
|||
case 15: |
|||
return ReadResponse.success(resourceid, getTimezone()); |
|||
case 16: |
|||
return ReadResponse.success(resourceid, getSupportedBinding()); |
|||
case 17: |
|||
return ReadResponse.success(resourceid, getDeviceType()); |
|||
case 18: |
|||
return ReadResponse.success(resourceid, getHardwareVersion()); |
|||
case 19: |
|||
return ReadResponse.success(resourceid, getSoftwareVersion()); |
|||
case 20: |
|||
return ReadResponse.success(resourceid, getBatteryStatus()); |
|||
case 21: |
|||
return ReadResponse.success(resourceid, getMemoryTotal()); |
|||
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 : ""); |
|||
return ExecuteResponse.success(); |
|||
} |
|||
|
|||
@Override |
|||
public WriteResponse write(ServerIdentity identity, int resourceid, LwM2mResource value) { |
|||
log.info("Write on Device resource /{}/{}/{}", getModel().id, getId(), resourceid); |
|||
|
|||
switch (resourceid) { |
|||
case 13: |
|||
return WriteResponse.notFound(); |
|||
case 14: |
|||
setUtcOffset((String) value.getValue()); |
|||
fireResourcesChange(resourceid); |
|||
return WriteResponse.success(); |
|||
case 15: |
|||
setTimezone((String) value.getValue()); |
|||
fireResourcesChange(resourceid); |
|||
return WriteResponse.success(); |
|||
default: |
|||
return super.write(identity, resourceid, value); |
|||
} |
|||
} |
|||
|
|||
private String getManufacturer() { |
|||
return "Leshan Demo Device"; |
|||
} |
|||
|
|||
private String getModelNumber() { |
|||
return "Model 500"; |
|||
} |
|||
|
|||
private String getSerialNumber() { |
|||
return "LT-500-000-0001"; |
|||
} |
|||
|
|||
private String getFirmwareVersion() { |
|||
return "1.0.0"; |
|||
} |
|||
|
|||
private long getErrorCode() { |
|||
return 0; |
|||
} |
|||
|
|||
private int getBatteryLevel() { |
|||
return 42; |
|||
} |
|||
|
|||
private long getMemoryFree() { |
|||
return Runtime.getRuntime().freeMemory() / 1024; |
|||
} |
|||
|
|||
private String utcOffset = new SimpleDateFormat("X").format(Calendar.getInstance().getTime()); |
|||
|
|||
private String getUtcOffset() { |
|||
return utcOffset; |
|||
} |
|||
|
|||
private void setUtcOffset(String t) { |
|||
utcOffset = t; |
|||
} |
|||
|
|||
private String timeZone = TimeZone.getDefault().getID(); |
|||
|
|||
private String getTimezone() { |
|||
return timeZone; |
|||
} |
|||
|
|||
private void setTimezone(String t) { |
|||
timeZone = t; |
|||
} |
|||
|
|||
private String getSupportedBinding() { |
|||
return "U"; |
|||
} |
|||
|
|||
private String getDeviceType() { |
|||
return "Demo"; |
|||
} |
|||
|
|||
private String getHardwareVersion() { |
|||
return "1.0.1"; |
|||
} |
|||
|
|||
private String getSoftwareVersion() { |
|||
return "1.0.2"; |
|||
} |
|||
|
|||
private int getBatteryStatus() { |
|||
return RANDOM.nextInt(7); |
|||
} |
|||
|
|||
private long getMemoryTotal() { |
|||
return Runtime.getRuntime().totalMemory() / 1024; |
|||
} |
|||
|
|||
@Override |
|||
public List<Integer> getAvailableResourceIds(ObjectModel model) { |
|||
return supportedResources; |
|||
} |
|||
|
|||
@Override |
|||
public void destroy() { |
|||
} |
|||
} |
|||
@ -0,0 +1,4 @@ |
|||
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 |
|||
@ -0,0 +1,405 @@ |
|||
<?xml version="1.0" encoding="UTF-8"?> |
|||
|
|||
<!-- |
|||
FILE INFORMATION |
|||
|
|||
OMA Permanent Document |
|||
File: OMA-SUP-XML_0-V1_2-20201110-A.xml |
|||
Path: http://www.openmobilealliance.org/release/ObjLwM2M_Security/ |
|||
|
|||
OMNA LwM2M Registry |
|||
Path: https://github.com/OpenMobileAlliance/lwm2m-registry |
|||
Name: 0.xml |
|||
|
|||
NORMATIVE INFORMATION |
|||
|
|||
Information about this file can be found in the latest revision of |
|||
|
|||
OMA-TS-LightweightM2M_Core-V1_2 |
|||
|
|||
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 2020 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-v1_1.xsd"> |
|||
<Object ObjectType="MODefinition"> |
|||
<Name>LWM2M Security</Name> |
|||
<Description1><![CDATA[This LwM2M Object provides the keying material of a LwM2M Client appropriate to access a specified LwM2M Server. One Object Instance SHOULD address a LwM2M Bootstrap-Server. |
|||
These LwM2M Object Resources MUST only be changed by a LwM2M Bootstrap-Server or Bootstrap from Smartcard and MUST NOT be accessible by any other LwM2M Server.]]></Description1> |
|||
<ObjectID>0</ObjectID> |
|||
<ObjectURN>urn:oma:lwm2m:oma:0:1.2</ObjectURN> |
|||
<LWM2MVersion>1.1</LWM2MVersion> |
|||
<ObjectVersion>1.2</ObjectVersion> |
|||
<MultipleInstances>Multiple</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Resources> |
|||
<Item ID="0"> |
|||
<Name>LWM2M Server URI</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration>0..255</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Uniquely identifies the LwM2M Server or LwM2M Bootstrap-Server. The format of the CoAP URI is defined in Section 6 of RFC 7252.]]></Description> |
|||
</Item> |
|||
<Item ID="1"> |
|||
<Name>Bootstrap-Server</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>Boolean</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Determines if the current instance concerns a LwM2M Bootstrap-Server (true) or a standard LwM2M Server (false)]]></Description> |
|||
</Item> |
|||
<Item ID="2"> |
|||
<Name>Security Mode</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..4</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Determines which security mode is used |
|||
0: Pre-Shared Key mode |
|||
1: Raw Public Key mode |
|||
2: Certificate mode |
|||
3: NoSec mode |
|||
4: Certificate mode with EST]]></Description> |
|||
</Item> |
|||
<Item ID="3"> |
|||
<Name>Public Key or Identity</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>Opaque</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Stores the LwM2M Client's certificate, public key (RPK mode) or PSK Identity (PSK mode).]]></Description> |
|||
</Item> |
|||
<Item ID="4"> |
|||
<Name>Server Public Key</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>Opaque</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Stores the LwM2M Server's, respectively LwM2M Bootstrap-Server's, certificate, public key (RPK mode) or trust anchor. The Certificate Mode Resource determines the content of this resource.]]></Description> |
|||
</Item> |
|||
<Item ID="5"> |
|||
<Name>Secret Key</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>Opaque</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Stores the secret key (PSK mode) or private key (RPK or certificate mode).]]></Description> |
|||
</Item> |
|||
<Item ID="6"> |
|||
<Name>SMS Security Mode</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..255</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Determines which SMS security mode is used: |
|||
0: Reserved for future use |
|||
1: DTLS mode (Device terminated) PSK mode assumed |
|||
2: Secure Packet Structure mode (Smartcard terminated) |
|||
3: NoSec mode |
|||
4: Reserved mode (DTLS mode with multiplexing Security Association support) |
|||
5-203 : Reserved for future use |
|||
204-255: Proprietary modes]]></Description> |
|||
</Item> |
|||
<Item ID="7"> |
|||
<Name>SMS Binding Key Parameters</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Opaque</Type> |
|||
<RangeEnumeration>6</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Stores the KIc, KID, SPI and TAR.]]></Description> |
|||
</Item> |
|||
<Item ID="8"> |
|||
<Name>SMS Binding Secret Key(s)</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Opaque</Type> |
|||
<RangeEnumeration>16,32,48</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Stores the values of the key(s) for the SMS binding.]]></Description> |
|||
</Item> |
|||
<Item ID="9"> |
|||
<Name>LwM2M Server SMS Number</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[MSISDN used by the LwM2M Client to send messages to the LwM2M Server via the SMS binding.]]></Description> |
|||
</Item> |
|||
<Item ID="10"> |
|||
<Name>Short Server ID</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>1..65534</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. |
|||
This Resource MUST be set when the Bootstrap-Server Resource has a value of 'false'. |
|||
The values ID:0 and ID:65535 values MUST NOT be used for identifying the LwM2M Server.]]></Description> |
|||
</Item> |
|||
<Item ID="11"> |
|||
<Name>Client Hold Off Time</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units>s</Units> |
|||
<Description><![CDATA[The number of seconds to wait before initiating a Client Initiated Bootstrap once the LwM2M Client has determined it should initiate this bootstrap mode. |
|||
In case client initiated bootstrap is supported by the LwM2M Client, this resource MUST be supported. This information is relevant for use with a Bootstrap-Server only.]]></Description> |
|||
</Item> |
|||
<Item ID="12"> |
|||
<Name>Bootstrap-Server Account Timeout</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units>s</Units> |
|||
<Description><![CDATA[The LwM2M Client MUST purge the LwM2M Bootstrap-Server Account after the timeout value given by this resource. The lowest timeout value is 1. |
|||
If the value is set to 0, or if this resource is not instantiated, the Bootstrap-Server Account lifetime is infinite.]]></Description> |
|||
</Item> |
|||
<Item ID="13"> |
|||
<Name>Matching Type</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..3</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[The Matching Type Resource specifies how the certificate or raw public key in in the Server Public Key is presented. Four values are currently defined: |
|||
0: Exact match. This is the default value and also corresponds to the functionality of LwM2M v1.0. Hence, if this resource is not present then the content of the Server Public Key Resource corresponds to this value. |
|||
1: SHA-256 hash [RFC6234] |
|||
2: SHA-384 hash [RFC6234] |
|||
3: SHA-512 hash [RFC6234]]]></Description> |
|||
</Item> |
|||
<Item ID="14"> |
|||
<Name>SNI</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[This resource holds the value of the Server Name Indication (SNI) value to be used during the TLS handshake. When this resource is present then the LwM2M Server URI acts as the address of the service while the SNI value is used for matching a presented certificate, or PSK identity.]]></Description> |
|||
</Item> |
|||
<Item ID="15"> |
|||
<Name>Certificate Usage</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..3</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[The Certificate Usage Resource specifies the semantic of the certificate or |
|||
raw public key stored in the Server Public Key Resource, which is used to match |
|||
the certificate presented in the TLS/DTLS handshake. The currently defined values are |
|||
0 for "CA constraint", 1 for "service certificate constraint", 2 for "trust anchor |
|||
assertion", and 3 for "domain-issued certificate". When this resource is absent, |
|||
value (3) for domain issued certificate mode is assumed. More details about the |
|||
semantic of each value can be found in the security consideration section of the |
|||
LwM2M specification.]]></Description> |
|||
</Item> |
|||
<Item ID="16"> |
|||
<Name>DTLS/TLS Ciphersuite</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Multiple</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[When this resource is present it instructs the TLS/DTLS client to propose the indicated ciphersuite(s) in the ClientHello of the handshake. A ciphersuite is indicated as a 32-bit integer value. The IANA TLS ciphersuite registry is maintained at https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml. As an example, the TLS_PSK_WITH_AES_128_CCM_8 ciphersuite is represented with the following string "0xC0,0xA8". To form an integer value the two values are concatenated. In this example, the value is 0xc0a8 or 49320.]]></Description> |
|||
</Item> |
|||
<Item ID="17"><Name>OSCORE Security Mode</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Objlnk</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[If this resource is defined, it provides a link to the OSCORE Object Instance and OSCORE MUST be used by the LwM2M Client with the linked OSCORE Object Instance.]]></Description> |
|||
</Item> |
|||
<Item ID="18"> |
|||
<Name>Groups To Use by Client</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Multiple</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..65535</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[If this resource is defined, it indicates what groups the LwM2M Client should use with a LwM2M Server/LwM2M Bootstrap-Server (ordered from most preferred to least preferred). Resource instance 0 indicates the most preferred group. The values are taken from Section 4.2.7 of RFC 8446. An example is secp256r1 (0x0017).]]></Description> |
|||
</Item> |
|||
<Item ID="19"> |
|||
<Name>Signature Algorithms Supported by Server</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Multiple</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..65535</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[If this resource is defined, it indicates what signature algorithms the LwM2M Server/LwM2M Bootstrap-Server supports. The values are taken from Section 4.2.3 of RFC 8446. An example is ecdsa_secp256r1_sha256(0x0403).]]></Description> |
|||
</Item> |
|||
<Item ID="20"><Name>Signature Algorithms To Use by Client</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Multiple</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..65535</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[If this resource is defined, it indicates what signature algorithms the LwM2M Client should use with a LwM2M Server/LwM2M Bootstrap-Server (ordered from most preferred to least preferred). Resource instance 0 indicates the most preferred group. The values are taken from Section 4.2.3 of RFC 8446. An example is ecdsa_secp256r1_sha256(0x0403).]]></Description> |
|||
</Item> |
|||
<Item ID="21"> |
|||
<Name>Signature Algorithm Certs Supported by Server</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Multiple</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..65535</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[If this resource is defined, it indicates what certificate-specific signature algorithms the the LwM2M Server/LwM2M Bootstrap-Server supports. The values are taken from Section 4.2.3 of RFC 8446. An example is ecdsa_secp256r1_sha256(0x0403).]]></Description> |
|||
</Item> |
|||
<Item ID="22"> |
|||
<Name>TLS 1.3 Features To Use by Client</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..65535</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[If this resource is defined, it indicates which features the LwM2M Client should use with the respective LwM2M Server/LwM2M Bootstrap-Server. The bitmask values listed below are defined. A bit value of '0' means the feature should not be used. bit(0) - PSK Plain, bit(1) - 0-RTT, bit(2) - PSK with PFS, bit(3) - Certificate-based Authentication. Bit(4) to bit(31) are reserved.]]></Description> |
|||
</Item> |
|||
<Item ID="23"> |
|||
<Name>TLS Extensions Supported by Server</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..65535</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[If this resource is defined, it indicates what extensions the LwM2M Server/LwM2M Bootstrap-Server supports in form of a bitmap. The following values are defined: bit(0) - Server Name Indication (RFC 6066), bit (1) - Max Fragment Length (RFC 6066), bit (2) - Status Request (RFC 6066), bit (3) - Heartbeat (RFC 6520), bit (4) - Application Layer Protocol Negotiation (RFC 7301), bit (5) - Signed Certificate Timestamp (RFC 6962), bit (6) - Certificate Compression (draft-ietf-tls-certificate-compression), bit (7) - Record Size Limit (RFC 8449), bit (8) - Ticket Pinning (draft-ietf-tls-pinning-ticket), bit (9) - Certificate Authorities (RFC 8446), bit (10) - OID Filters (RFC 8446), bit (11) - Post Handshake Auth (RFC 8446), bit (12) - Connection ID (draft-ietf-tls-dtls-connection-id/draft-ietf-tls-dtls13). Bit(13) to bit(31) are reserved. ]]></Description> |
|||
</Item> |
|||
<Item ID="24"> |
|||
<Name>TLS Extensions To Use by Client</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..65535</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[If this resource is defined, it indicates what extensions the LwM2M Client should use with the LwM2M Server/LwM2M Bootstrap-Server in form of a bitmap. The following values are defined: bit(0) - Server Name Indication (RFC 6066), bit (1) - Max Fragment Length (RFC 6066), bit (2) - Status Request (RFC 6066), bit (3) - Heartbeat (RFC 6520), bit (4) - Application Layer Protocol Negotiation (RFC 7301), bit (5) - Signed Certificate Timestamp (RFC 6962), bit (6) - Certificate Compression (draft-ietf-tls-certificate-compression), bit (7) - Record Size Limit (RFC 8449), bit (8) - Ticket Pinning (draft-ietf-tls-pinning-ticket), bit (9) - Certificate Authorities (RFC 8446), bit (10) - OID Filters (RFC 8446), bit (11) - Post Handshake Auth (RFC 8446), bit (12) - Connection ID (draft-ietf-tls-dtls-connection-id/draft-ietf-tls-dtls13). Bit(13) to bit(31) are reserved. ]]></Description> |
|||
</Item> |
|||
<Item ID="25"> |
|||
<Name>Secondary LwM2M Server URI</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Multiple</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration>0..255</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[If this resource is present then the LwM2M Server URI in the Security Object, Resource ID 0, is augmented with information about further LwM2M Server URIs that can be used with the same security information found in the LwM2M Security Object. This is useful when a LwM2M Server is reachable via two different transport bindings (i.e. URIs). For example when the same server is reachable with two different URIs, such as a "coaps" and a "coaps+tcp" URI scheme.]]></Description> |
|||
</Item> |
|||
<Item ID="26"><Name>MQTT Server</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Objlnk</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[If this resource is defined, it provides a link to a MQTT Server Object Instance, which offers additional configuration information for use with this MQTT server. This Resource is used only when the URI scheme in the LwM2M Server URI Resource indicates the use of MQTT.]]></Description> |
|||
</Item> |
|||
<Item ID="27"><Name>LwM2M COSE Security</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Multiple</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Objlnk</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[If this resource is defined, it provides a links to LwM2M COSE Object Instances, which contain security-relevant configuration information for use with COSE.]]></Description> |
|||
</Item> |
|||
<Item ID="28"><Name>RDS Destination Port</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..15</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[This resource provides the default RDS Destination Port Number (as defined in 3GPP TS 24.250) to use for contacting the LwM2M or Bootstrap Server when communicating through the SCEF across the Non-IP binding.]]></Description> |
|||
</Item> |
|||
<Item ID="29"><Name>RDS Source Port</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..15</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[This resource provides the default RDS Source Port Number (as defined in 3GPP TS 24.250) to use for contacting the LwM2M or Bootstrap Server when communicating through the SCEF across the Non-IP binding.]]></Description> |
|||
</Item> |
|||
<Item ID="30"><Name>RDS Application ID</Name> |
|||
<Operations></Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[This resource provides the Application ID (as defined in 3GPP TS 24.250) to use for querying the SCEF for the source and destination port numbers for contacting the LwM2M or Bootstrap Server when communicating through the SCEF across the Non-IP binding.]]></Description> |
|||
</Item> |
|||
</Resources> |
|||
<Description2><![CDATA[]]></Description2> |
|||
</Object> |
|||
</LWM2M> |
|||
@ -0,0 +1,360 @@ |
|||
<?xml version="1.0" encoding="UTF-8"?> |
|||
|
|||
<!-- |
|||
FILE INFORMATION |
|||
|
|||
OMA Permanent Document |
|||
File: OMA-SUP-XML_1-V1_2-20201110-A.xml |
|||
Path: http://www.openmobilealliance.org/release/ObjLwM2M_Server/ |
|||
|
|||
OMNA LwM2M Registry |
|||
Path: https://github.com/OpenMobileAlliance/lwm2m-registry |
|||
Name: 1.xml |
|||
|
|||
NORMATIVE INFORMATION |
|||
|
|||
Information about this file can be found in the latest revision of |
|||
|
|||
OMA-TS-LightweightM2M_Core-V1_2 |
|||
|
|||
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 2020 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-v1_1.xsd"> |
|||
<Object ObjectType="MODefinition"> |
|||
<Name>LwM2M Server</Name> |
|||
<Description1><![CDATA[This LwM2M Objects provides the data related to a LwM2M Server. A Bootstrap-Server has no such an Object Instance associated to it.]]></Description1> |
|||
<ObjectID>1</ObjectID> |
|||
<ObjectURN>urn:oma:lwm2m:oma:1:1.2</ObjectURN> |
|||
<LWM2MVersion>1.2</LWM2MVersion> |
|||
<ObjectVersion>1.2</ObjectVersion> |
|||
<MultipleInstances>Multiple</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Resources> |
|||
<Item ID="0"> |
|||
<Name>Short Server ID</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>1..65534</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Used as link to associate server Object Instance.]]></Description> |
|||
</Item> |
|||
<Item ID="1"> |
|||
<Name>Lifetime</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units>s</Units> |
|||
<Description><![CDATA[Specify the lifetime of the registration in seconds (see Client Registration Interface). If the value is set to 0, the lifetime is infinite.]]></Description> |
|||
</Item> |
|||
<Item ID="2"> |
|||
<Name>Default Minimum Period</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units>s</Units> |
|||
<Description><![CDATA[The default value the LwM2M Client should use for the Minimum Period of an Observation in the absence of this parameter being included in an Observation. |
|||
If this Resource doesn’t exist, the default value is 0.]]></Description> |
|||
</Item> |
|||
<Item ID="3"> |
|||
<Name>Default Maximum Period</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units>s</Units> |
|||
<Description><![CDATA[The default value the LwM2M Client should use for the Maximum Period of an Observation in the absence of this parameter being included in an Observation.]]></Description> |
|||
</Item> |
|||
<Item ID="4"> |
|||
<Name>Disable</Name> |
|||
<Operations>E</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type></Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[If this Resource is executed, this LwM2M Server Object is disabled for a certain period defined in the Disabled Timeout Resource. After receiving "Execute" operation, LwM2M Client MUST send response of the operation and perform de-registration process, and underlying network connection between the Client and Server MUST be disconnected to disable the LwM2M Server account. |
|||
After the above process, the LwM2M Client MUST NOT send any message to the Server and ignore all the messages from the LwM2M Server for the period.]]></Description> |
|||
</Item> |
|||
<Item ID="5"> |
|||
<Name>Disable Timeout</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units>s</Units> |
|||
<Description><![CDATA[A period to disable the Server. After this period, the LwM2M Client MUST perform registration process to the Server. If this Resource is not set, a default timeout value is 86400 (1 day).]]></Description> |
|||
</Item> |
|||
<Item ID="6"> |
|||
<Name>Notification Storing When Disabled or Offline</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>Boolean</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[If true, the LwM2M Client stores "Notify" operations to the LwM2M Server while the LwM2M Server account is disabled or the LwM2M Client is offline. After the LwM2M Server account is enabled or the LwM2M Client is online, the LwM2M Client reports the stored "Notify" operations to the Server. |
|||
If false, the LwM2M Client discards all the "Notify" operations or temporarily disables the Observe function while the LwM2M Server is disabled or the LwM2M Client is offline. |
|||
The default value is true. |
|||
The maximum number of storing Notifications per Server is up to the implementation.]]></Description> |
|||
</Item> |
|||
<Item ID="7"> |
|||
<Name>Binding</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[The possible values are those listed in the LwM2M Core Specification. This Resource defines the transport binding configured for the LwM2M Client. |
|||
If the LwM2M Client supports the binding specified in this Resource, the LwM2M Client MUST use that transport for the Current Binding Mode.]]></Description> |
|||
</Item> |
|||
<Item ID="8"> |
|||
<Name>Registration Update Trigger</Name> |
|||
<Operations>E</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type></Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[If this Resource is executed the LwM2M Client MUST perform an "Update" operation with this LwM2M Server. The LwM2M Client can use a transport binding supported in the Current Binding Mode, Preferred Transport resource or the transport specified as an argument in the Registration Update Trigger.]]></Description> |
|||
</Item> |
|||
<Item ID="9"> |
|||
<Name>Bootstrap-Request Trigger</Name> |
|||
<Operations>E</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type></Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[When this Resource is executed the LwM2M Client MUST initiate a "Client Initiated Bootstrap" procedure in using the LwM2M Bootstrap-Server Account.]]></Description> |
|||
</Item> |
|||
<Item ID="10"> |
|||
<Name>APN Link</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Objlnk</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[If this resource is defined, it provides a link to the APN connection profile Object Instance (OMNA registered Object ID:11) to be used to communicate with this server.]]></Description> |
|||
</Item> |
|||
<Item ID="11"> |
|||
<Name>TLS-DTLS Alert Code</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..255</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[If this resource is defined, it contains the most recent TLS / DTLS alert message received from the LwM2M Server respective represented by the AlertDescription defined in Section 7.2 of RFC 5246. This resource set by the LwM2M Client may help the LwM2M Bootstrap-Server to determine the cause of TLS/DTLS connection failure with the respective LwM2M Server.]]></Description> |
|||
</Item> |
|||
<Item ID="12"> |
|||
<Name>Last Bootstrapped</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Time</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[If this resource is defined, it represents the last time that the bootstrap server updated this LwM2M Server Account. The LwM2M Client is responsible for updating this value. When the Bootstrap Server detects that this LwM2M Server Account is "out-of-date", the Bootstrap Server can update the LwM2M Server Account as represented by the LwM2M Server object instance.]]></Description> |
|||
</Item> |
|||
<Item ID="13"> |
|||
<Name>Registration Priority Order</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[The LwM2M Client sequences the LwM2M Server registrations in increasing order of this value. If this value is not defined, registration attempts to this server are not impacted by other server registrations.]]></Description> |
|||
</Item> |
|||
<Item ID="14"> |
|||
<Name>Initial Registration Delay Timer</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units>s</Units> |
|||
<Description><![CDATA[The delay, in seconds, before registration is attempted for this LwM2M Server based upon the completion of registration of the previous LwM2M Server in the registration order. This is only applied until the first successful registration after a successful bootstrapping sequence.]]></Description> |
|||
</Item> |
|||
<Item ID="15"> |
|||
<Name>Registration Failure Block</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Boolean</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[When set to true and registration to this LwM2M server fails, the LwM2M Client blocks registration to other servers in the order. When set to false, the LwM2M Client proceeds with registration to the next server in the order.]]></Description> |
|||
</Item> |
|||
<Item ID="16"> |
|||
<Name>Bootstrap on Registration Failure</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Boolean</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[If set to true, this indicates that the LwM2M Client should re-bootstrap when either registration is explicitly rejected by the LwM2M Server or registration is considered as failing as dictated by the other resource settings. If set to false, the LwM2M Client will continue with the registration attempts as dictated by the other resource settings.]]></Description> |
|||
</Item> |
|||
<Item ID="17"> |
|||
<Name>Communication Retry Count</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[The number of successive communication attempts before which a communication sequence is considered as failed.]]></Description> |
|||
</Item> |
|||
<Item ID="18"> |
|||
<Name>Communication Retry Timer</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units>s</Units> |
|||
<Description><![CDATA[The delay, in seconds, between successive communication attempts in a communication sequence. This value is multiplied by two to the power of the communication retry attempt minus one (2**(retry attempt-1)) to create an exponential back-off.]]></Description> |
|||
</Item> |
|||
<Item ID="19"> |
|||
<Name>Communication Sequence Delay Timer</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units>s</Units> |
|||
<Description><![CDATA[The delay, in seconds, between successive communication sequences. A communication sequence is defined as the exhaustion of the Communication Retry Count and Communication Retry Timer values. A communication sequence can be applied to server registrations or bootstrapping attempts. MAX_VALUE means do not perform another communication sequence.]]></Description> |
|||
</Item> |
|||
<Item ID="20"> |
|||
<Name>Communication Sequence Retry Count</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[The number of successive communication sequences before which a registration attempt is considered as failed.]]></Description> |
|||
</Item> |
|||
<Item ID="21"> |
|||
<Name>Trigger</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Boolean</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Using the Trigger Resource a LwM2M Client can indicate whether it is reachable over SMS (value set to 'true') or not (value set to 'false'). The default value (resource not present) is 'false'. When set to 'true' the LwM2M Server MAY, for example, request the LwM2M Client to perform operations, such as the "Update" operation by sending an "Execute" operation on "Registration Update Trigger" Resource via SMS. No SMS response is expected for such a message.]]></Description> |
|||
</Item> |
|||
<Item ID="22"> |
|||
<Name>Preferred Transport</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration>The possible values are those listed in the LwM2M Core Specification</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Only a single transport binding SHALL be present. When the LwM2M client supports multiple transports, it MAY use this transport to initiate a connection. This resource can also be used to switch between multiple transports e.g. a non-IP device can switch to UDP transport to perform firmware updates.]]></Description> |
|||
</Item> |
|||
<Item ID="23"><Name>Mute Send</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Boolean</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[If true or the Resource is not present, the LwM2M Client Send command capability is de-activated. |
|||
If false, the LwM2M Client Send Command capability is activated.]]></Description> |
|||
</Item> |
|||
<Item ID="24"> |
|||
<Name>Alternate APN Links</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Multiple</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Objlnk</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[If this resource is defined, it provides links to alternate APN connection profile Object Instance (OMNA registered Object ID:11) to be used to communicate with this server if Resource 10 has configuration conflicts.]]></Description> |
|||
</Item> |
|||
<Item ID="25"> |
|||
<Name>Supported Server Versions</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Multiple</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[This resource provides the supported enabler versions of the server to the client as a set of strings. Format for each string is 1*DIGIT"."1*DIGIT"."1*DIGIT where the third DIGIT is optional.]]></Description> |
|||
</Item> |
|||
<Item ID="26"> |
|||
<Name>Default Notification Mode</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..1</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[This resource indicates the default mode for observations to be sent: 0 = Non-Confirmable, 1 = Confirmable.]]></Description> |
|||
</Item> |
|||
<Item ID="27"> |
|||
<Name>Profile ID Hash Algorithm</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..255</RangeEnumeration> |
|||
<Units/> |
|||
<Description><![CDATA[If this resource is defined, it contains the hash algorithm the LwM2M Server would prefer the LwM2M Client to use with the dynamically generated mode of creating Profile IDs. The numerical ID value of the 'Suite Identifiers' registered by RFC 6920 is used in this Resource.]]></Description> |
|||
</Item> |
|||
</Resources> |
|||
<Description2></Description2> |
|||
</Object> |
|||
</LWM2M> |
|||
@ -0,0 +1,123 @@ |
|||
<?xml version="1.0" encoding="UTF-8"?> |
|||
|
|||
<!-- |
|||
FILE INFORMATION |
|||
|
|||
OMA Permanent Document |
|||
File: OMA-SUP-XML_2-V1_1-20201110-A.xml |
|||
Path: http://www.openmobilealliance.org/release/ObjLwM2M_ACL/ |
|||
|
|||
OMNA LwM2M Registry |
|||
Path: https://github.com/OpenMobileAlliance/lwm2m-registry |
|||
Name: 2.xml |
|||
|
|||
NORMATIVE INFORMATION |
|||
|
|||
Information about this file can be found in the latest revision of |
|||
|
|||
OMA-TS-LightweightM2M_Core-V1_2 |
|||
|
|||
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 2020 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>LwM2M Access Control</Name> |
|||
<Description1><![CDATA[Access Control Object is used to check whether the LwM2M Server has access right for performing an operation.]]></Description1> |
|||
<ObjectID>2</ObjectID> |
|||
<ObjectURN>urn:oma:lwm2m:oma:2:1.1</ObjectURN> |
|||
<LWM2MVersion>1.0</LWM2MVersion> |
|||
<ObjectVersion>1.1</ObjectVersion> |
|||
<MultipleInstances>Multiple</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Resources> |
|||
<Item ID="0"> |
|||
<Name>Object ID</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>1..65534</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Resources 0 and 1 point to the Object Instance for which the Instances of the ACL Resource of that Access Control Object Instance are applicable.]]></Description> |
|||
</Item> |
|||
<Item ID="1"> |
|||
<Name>Object Instance ID</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..65535</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[See above]]></Description> |
|||
</Item> |
|||
<Item ID="2"> |
|||
<Name>ACL</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Multiple</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..31</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[The Resource Instance ID MUST be the Short Server ID of a certain LwM2M Server for which associated access rights are contained in the Resource Instance value. |
|||
The Resource Instance ID 0 is a specific ID, determining the ACL Instance which contains the default access rights. |
|||
Each bit set in the Resource Instance value, grants an access right to the LwM2M Server to the corresponding operation. |
|||
The bit order is specified as below. |
|||
1st LSB: R(Read, Observe, Write-Attributes) |
|||
2nd LSB: W(Write) |
|||
3rd LSB: E(Execute) |
|||
4th LSB: D(Delete) |
|||
5th LSB: C(Create) |
|||
Other bits are reserved for future use.]]></Description> |
|||
</Item> |
|||
<Item ID="3"> |
|||
<Name>Access Control Owner</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..65535</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Short Server ID of a certain LwM2M Server; only such an LwM2M Server can manage the Resources of this Object Instance. |
|||
The specific value MAX_ID=65535 means this Access Control Object Instance is created and modified during a Bootstrap phase only.]]></Description> |
|||
</Item> |
|||
</Resources> |
|||
<Description2><![CDATA[]]></Description2> |
|||
</Object> |
|||
</LWM2M> |
|||
@ -0,0 +1,331 @@ |
|||
<?xml version="1.0" encoding="UTF-8"?> |
|||
|
|||
<!-- |
|||
FILE INFORMATION |
|||
|
|||
OMA Permanent Document |
|||
File: OMA-SUP-XML_3-V1_2-20201110-A.xml |
|||
Path: http://www.openmobilealliance.org/release/ObjLwM2M_Device/ |
|||
|
|||
OMNA LwM2M Registry |
|||
Path: https://github.com/OpenMobileAlliance/lwm2m-registry |
|||
Name: 3.xml |
|||
|
|||
NORMATIVE INFORMATION |
|||
|
|||
Information about this file can be found in the latest revision of |
|||
|
|||
OMA-TS-LightweightM2M_Core-V1_2 |
|||
|
|||
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 2020 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-v1_1.xsd"> |
|||
<Object ObjectType="MODefinition"> |
|||
<Name>Device</Name> |
|||
<Description1><![CDATA[This LwM2M Object provides a range of device related information which can be queried by the LwM2M Server, and a device reboot and factory reset function.]]></Description1> |
|||
<ObjectID>3</ObjectID> |
|||
<ObjectURN>urn:oma:lwm2m:oma:3:1.0</ObjectURN> |
|||
<LWM2MVersion>1.1</LWM2MVersion> |
|||
<ObjectVersion>1.0</ObjectVersion> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Resources> |
|||
<Item ID="0"> |
|||
<Name>Manufacturer</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Human readable manufacturer name]]></Description> |
|||
</Item> |
|||
<Item ID="1"> |
|||
<Name>Model Number</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[A model identifier (manufacturer specified string)]]></Description> |
|||
</Item> |
|||
<Item ID="2"> |
|||
<Name>Serial Number</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Serial Number]]></Description> |
|||
</Item> |
|||
<Item ID="3"> |
|||
<Name>Firmware Version</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Current firmware version of the Device.The Firmware Management function could rely on this resource.]]></Description> |
|||
</Item> |
|||
<Item ID="4"> |
|||
<Name>Reboot</Name> |
|||
<Operations>E</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type></Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Reboot the LwM2M Device to restore the Device from unexpected firmware failure.]]></Description> |
|||
</Item> |
|||
<Item ID="5"> |
|||
<Name>Factory Reset</Name> |
|||
<Operations>E</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type></Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Perform factory reset of the LwM2M Device to make the LwM2M Device to go through initial deployment sequence where provisioning and bootstrap sequence is performed. This requires client ensuring post factory reset to have minimal information to allow it to carry out one of the bootstrap methods specified in section 5.2.3. |
|||
When this Resource is executed, "De-register" operation MAY be sent to the LwM2M Server(s) before factory reset of the LwM2M Device.]]></Description> |
|||
</Item> |
|||
<Item ID="6"> |
|||
<Name>Available Power Sources</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Multiple</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..7</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[0: DC power |
|||
1: Internal Battery |
|||
2: External Battery |
|||
3: Fuel Cell |
|||
4: Power over Ethernet |
|||
5: USB |
|||
6: AC (Mains) power |
|||
7: Solar |
|||
The same Resource Instance ID MUST be used to associate a given Power Source (Resource ID:6) with its Present Voltage (Resource ID:7) and its Present Current (Resource ID:8)]]></Description> |
|||
</Item> |
|||
<Item ID="7"> |
|||
<Name>Power Source Voltage</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Multiple</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Present voltage for each Available Power Sources Resource Instance. The unit used for this resource is in mV.]]></Description> |
|||
</Item> |
|||
<Item ID="8"> |
|||
<Name>Power Source Current</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Multiple</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Present current for each Available Power Source. The unit used for this resource is in mA.]]></Description> |
|||
</Item> |
|||
<Item ID="9"> |
|||
<Name>Battery Level</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..100</RangeEnumeration> |
|||
<Units>/100</Units> |
|||
<Description><![CDATA[Contains the current battery level as a percentage (with a range from 0 to 100). This value is only valid for the Device internal Battery if present (one Available Power Sources Resource Instance is 1).]]></Description> |
|||
</Item> |
|||
<Item ID="10"> |
|||
<Name>Memory Free</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Estimated current available amount of storage space which can store data and software in the LwM2M Device (expressed in kilobytes). Note: 1 kilobyte corresponds to 1000 bytes.]]></Description> |
|||
</Item> |
|||
<Item ID="11"> |
|||
<Name>Error Code</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Multiple</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..32</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[0=No error |
|||
1=Low battery power |
|||
2=External power supply off |
|||
3=GPS module failure |
|||
4=Low received signal strength |
|||
5=Out of memory |
|||
6=SMS failure |
|||
7=IP connectivity failure |
|||
8=Peripheral malfunction |
|||
9..15=Reserved for future use |
|||
16..32=Device specific error codes |
|||
|
|||
When the single Device Object Instance is initiated, there is only one error code Resource Instance whose value is equal to 0 that means no error. When the first error happens, the LwM2M Client changes error code Resource Instance to any non-zero value to indicate the error type. When any other error happens, a new error code Resource Instance is created. When an error associated with a Resource Instance is no longer present, that Resource Instance is deleted. When the single existing error is no longer present, the LwM2M Client returns to the original no error state where Instance 0 has value 0. |
|||
This error code Resource MAY be observed by the LwM2M Server. How to deal with LwM2M Client’s error report depends on the policy of the LwM2M Server. Error codes in between 16 and 32 are specific to the Device and may have different meanings among implementations.]]></Description> |
|||
</Item> |
|||
<Item ID="12"> |
|||
<Name>Reset Error Code</Name> |
|||
<Operations>E</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type></Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Delete all error code Resource Instances and create only one zero-value error code that implies no error, then re-evaluate all error conditions and update and create Resources Instances to capture all current error conditions.]]></Description> |
|||
</Item> |
|||
<Item ID="13"> |
|||
<Name>Current Time</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Time</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Current UNIX time of the LwM2M Client. |
|||
The LwM2M Client should be responsible to increase this time value as every second elapses. |
|||
The LwM2M Server is able to write this Resource to make the LwM2M Client synchronized with the LwM2M Server.]]></Description> |
|||
</Item> |
|||
<Item ID="14"> |
|||
<Name>UTC Offset</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Indicates the UTC offset currently in effect for this LwM2M Device. UTC+X [ISO 8601].]]></Description> |
|||
</Item> |
|||
<Item ID="15"> |
|||
<Name>Timezone</Name> |
|||
<Operations>RW</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Indicates in which time zone the LwM2M Device is located, in IANA Timezone (TZ) database format.]]></Description> |
|||
</Item> |
|||
<Item ID="16"> |
|||
<Name>Supported Binding and Modes</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Mandatory</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Indicates which bindings and modes are supported in the LwM2M Client. The possible values are those listed in the LwM2M Core Specification.]]></Description> |
|||
</Item> |
|||
<Item ID="17"><Name>Device Type</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Type of the device (manufacturer specified string: e.g. smart meters / dev Class / ...)]]></Description> |
|||
</Item> |
|||
<Item ID="18"><Name>Hardware Version</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Current hardware version of the device]]></Description> |
|||
</Item> |
|||
<Item ID="19"><Name>Software Version</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Current software version of the device (manufacturer specified string). On elaborated LwM2M device, SW could be split in 2 parts: a firmware one and a higher level software on top. |
|||
Both pieces of Software are together managed by LwM2M Firmware Update Object (Object ID 5)]]></Description> |
|||
</Item> |
|||
<Item ID="20"><Name>Battery Status</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration>0..6</RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[This value is only valid for the Device Internal Battery if present (one Available Power Sources Resource Instance value is 1). |
|||
Battery |
|||
Status Meaning Description |
|||
0 Normal The battery is operating normally and not on power. |
|||
1 Charging The battery is currently charging. |
|||
2 Charge Complete The battery is fully charged and still on power. |
|||
3 Damaged The battery has some problem. |
|||
4 Low Battery The battery is low on charge. |
|||
5 Not Installed The battery is not installed. |
|||
6 Unknown The battery information is not available.]]></Description> |
|||
</Item> |
|||
<Item ID="21"><Name>Memory Total</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Integer</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Total amount of storage space which can store data and software in the LwM2M Device (expressed in kilobytes). Note: 1 kilobyte corresponds to 1000 bytes.]]></Description> |
|||
</Item> |
|||
<Item ID="22"><Name>ExtDevInfo</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Multiple</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>Objlnk</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Reference to external "Device" object instance containing information. For example, such an external device can be a Host Device, which is a device into which the Device containing the LwM2M client is embedded. This Resource may be used to retrieve information about the Host Device.]]></Description> |
|||
</Item></Resources> |
|||
<Description2></Description2> |
|||
</Object> |
|||
</LWM2M> |
|||
Binary file not shown.
Binary file not shown.
@ -0,0 +1,27 @@ |
|||
/** |
|||
* 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.common.data.device.credentials.lwm2m; |
|||
|
|||
import lombok.Getter; |
|||
import lombok.NoArgsConstructor; |
|||
import lombok.Setter; |
|||
|
|||
@Getter |
|||
@Setter |
|||
@NoArgsConstructor |
|||
public abstract class AbstractLwM2MClientCredentials implements LwM2MClientCredentials { |
|||
private String endpoint; |
|||
} |
|||
@ -0,0 +1,34 @@ |
|||
/** |
|||
* 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.common.data.device.credentials.lwm2m; |
|||
|
|||
import lombok.SneakyThrows; |
|||
import org.apache.commons.codec.binary.Hex; |
|||
|
|||
public abstract class HasKey extends AbstractLwM2MClientCredentials { |
|||
private byte[] key; |
|||
|
|||
@SneakyThrows |
|||
public void setKey(String key) { |
|||
if (key != null) { |
|||
this.key = Hex.decodeHex(key.toLowerCase().toCharArray()); |
|||
} |
|||
} |
|||
|
|||
public byte[] getKey() { |
|||
return key; |
|||
} |
|||
} |
|||
@ -0,0 +1,36 @@ |
|||
/** |
|||
* 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.common.data.device.credentials.lwm2m; |
|||
|
|||
import com.fasterxml.jackson.annotation.JsonIgnore; |
|||
import com.fasterxml.jackson.annotation.JsonSubTypes; |
|||
import com.fasterxml.jackson.annotation.JsonTypeInfo; |
|||
|
|||
@JsonTypeInfo( |
|||
use = JsonTypeInfo.Id.NAME, |
|||
property = "securityConfigClientMode") |
|||
@JsonSubTypes({ |
|||
@JsonSubTypes.Type(value = NoSecClientCredentials.class, name = "NO_SEC"), |
|||
@JsonSubTypes.Type(value = PSKClientCredentials.class, name = "PSK"), |
|||
@JsonSubTypes.Type(value = RPKClientCredentials.class, name = "RPK"), |
|||
@JsonSubTypes.Type(value = X509ClientCredentials.class, name = "X509")}) |
|||
public interface LwM2MClientCredentials { |
|||
|
|||
@JsonIgnore |
|||
LwM2MSecurityMode getSecurityConfigClientMode(); |
|||
|
|||
String getEndpoint(); |
|||
} |
|||
@ -0,0 +1,24 @@ |
|||
/** |
|||
* 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.common.data.device.credentials.lwm2m; |
|||
|
|||
public class NoSecClientCredentials extends AbstractLwM2MClientCredentials { |
|||
|
|||
@Override |
|||
public LwM2MSecurityMode getSecurityConfigClientMode() { |
|||
return LwM2MSecurityMode.NO_SEC; |
|||
} |
|||
} |
|||
@ -0,0 +1,30 @@ |
|||
/** |
|||
* 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.common.data.device.credentials.lwm2m; |
|||
|
|||
import lombok.Getter; |
|||
import lombok.Setter; |
|||
|
|||
@Getter |
|||
@Setter |
|||
public class PSKClientCredentials extends HasKey { |
|||
private String identity; |
|||
|
|||
@Override |
|||
public LwM2MSecurityMode getSecurityConfigClientMode() { |
|||
return LwM2MSecurityMode.PSK; |
|||
} |
|||
} |
|||
@ -0,0 +1,24 @@ |
|||
/** |
|||
* 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.common.data.device.credentials.lwm2m; |
|||
|
|||
public class RPKClientCredentials extends HasKey { |
|||
|
|||
@Override |
|||
public LwM2MSecurityMode getSecurityConfigClientMode() { |
|||
return LwM2MSecurityMode.RPK; |
|||
} |
|||
} |
|||
@ -0,0 +1,30 @@ |
|||
/** |
|||
* 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.common.data.device.credentials.lwm2m; |
|||
|
|||
import lombok.Getter; |
|||
import lombok.Setter; |
|||
|
|||
@Getter |
|||
@Setter |
|||
public class X509ClientCredentials extends AbstractLwM2MClientCredentials { |
|||
private String cert; |
|||
|
|||
@Override |
|||
public LwM2MSecurityMode getSecurityConfigClientMode() { |
|||
return LwM2MSecurityMode.X509; |
|||
} |
|||
} |
|||
@ -0,0 +1,26 @@ |
|||
/** |
|||
* 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.common.data.firmware; |
|||
|
|||
public enum ChecksumAlgorithm { |
|||
MD5, |
|||
SHA256, |
|||
SHA384, |
|||
SHA512, |
|||
CRC32, |
|||
MURMUR3_32, |
|||
MURMUR3_128 |
|||
} |
|||
@ -0,0 +1,103 @@ |
|||
/** |
|||
* 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.coap.client; |
|||
|
|||
import lombok.extern.slf4j.Slf4j; |
|||
import org.eclipse.californium.core.CoapClient; |
|||
import org.eclipse.californium.core.CoapHandler; |
|||
import org.eclipse.californium.core.CoapObserveRelation; |
|||
import org.eclipse.californium.core.CoapResponse; |
|||
import org.eclipse.californium.core.coap.CoAP; |
|||
import org.eclipse.californium.core.coap.Request; |
|||
|
|||
import java.net.URI; |
|||
import java.net.URISyntaxException; |
|||
import java.util.concurrent.CountDownLatch; |
|||
import java.util.concurrent.ExecutorService; |
|||
import java.util.concurrent.Executors; |
|||
|
|||
@Slf4j |
|||
public class NoSecObserveClient { |
|||
|
|||
private static final long INFINIT_EXCHANGE_LIFETIME = 0L; |
|||
|
|||
private CoapClient coapClient; |
|||
private CoapObserveRelation observeRelation; |
|||
private ExecutorService executor = Executors.newFixedThreadPool(1); |
|||
private CountDownLatch latch; |
|||
|
|||
public NoSecObserveClient(String host, int port, String accessToken) throws URISyntaxException { |
|||
URI uri = new URI(getFutureUrl(host, port, accessToken)); |
|||
this.coapClient = new CoapClient(uri); |
|||
coapClient.setTimeout(INFINIT_EXCHANGE_LIFETIME); |
|||
this.latch = new CountDownLatch(5); |
|||
} |
|||
|
|||
public void start() { |
|||
executor.submit(() -> { |
|||
try { |
|||
Request request = Request.newGet(); |
|||
request.setObserve(); |
|||
observeRelation = coapClient.observe(request, new CoapHandler() { |
|||
@Override |
|||
public void onLoad(CoapResponse response) { |
|||
String responseText = response.getResponseText(); |
|||
CoAP.ResponseCode code = response.getCode(); |
|||
Integer observe = response.getOptions().getObserve(); |
|||
log.info("CoAP Response received! " + |
|||
"responseText: {}, " + |
|||
"code: {}, " + |
|||
"observe seq number: {}", |
|||
responseText, |
|||
code, |
|||
observe); |
|||
latch.countDown(); |
|||
} |
|||
|
|||
@Override |
|||
public void onError() { |
|||
log.error("Ack error!"); |
|||
latch.countDown(); |
|||
} |
|||
}); |
|||
} catch (Exception e) { |
|||
log.error("Error occurred while sending COAP requests: "); |
|||
} |
|||
}); |
|||
try { |
|||
latch.await(); |
|||
observeRelation.proactiveCancel(); |
|||
} catch (InterruptedException e) { |
|||
log.error("Error occurred: ", e); |
|||
} |
|||
} |
|||
|
|||
private String getFutureUrl(String host, Integer port, String accessToken) { |
|||
return "coap://" + host + ":" + port + "/api/v1/" + accessToken + "/attributes"; |
|||
} |
|||
|
|||
public static void main(String[] args) throws URISyntaxException { |
|||
log.info("Usage: java -cp ... org.thingsboard.server.transport.coap.client.NoSecObserveClient " + |
|||
"host port accessToken"); |
|||
|
|||
String host = args[0]; |
|||
int port = Integer.parseInt(args[1]); |
|||
String accessToken = args[2]; |
|||
|
|||
final NoSecObserveClient client = new NoSecObserveClient(host, port, accessToken); |
|||
client.start(); |
|||
} |
|||
} |
|||
@ -1,58 +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; |
|||
|
|||
public enum LwM2MSecurityMode { |
|||
|
|||
PSK(0, "psk"), |
|||
RPK(1, "rpk"), |
|||
X509(2, "x509"), |
|||
NO_SEC(3, "no_sec"), |
|||
X509_EST(4, "x509_est"), |
|||
REDIS(7, "redis"), |
|||
DEFAULT_MODE(255, "default_mode"); |
|||
|
|||
public int code; |
|||
public String subEndpoint; |
|||
|
|||
LwM2MSecurityMode(int code, String subEndpoint) { |
|||
this.code = code; |
|||
this.subEndpoint = subEndpoint; |
|||
} |
|||
|
|||
public static LwM2MSecurityMode fromSecurityMode(long code) { |
|||
return fromSecurityMode((int) code); |
|||
} |
|||
|
|||
public static LwM2MSecurityMode fromSecurityMode(int code) { |
|||
for (LwM2MSecurityMode sm : LwM2MSecurityMode.values()) { |
|||
if (sm.code == code) { |
|||
return sm; |
|||
} |
|||
} |
|||
throw new IllegalArgumentException(String.format("Unsupported security code : %d", code)); |
|||
} |
|||
|
|||
|
|||
public static LwM2MSecurityMode fromSecurityMode(String subEndpoint) { |
|||
for (LwM2MSecurityMode sm : LwM2MSecurityMode.values()) { |
|||
if (sm.subEndpoint.equals(subEndpoint)) { |
|||
return sm; |
|||
} |
|||
} |
|||
throw new IllegalArgumentException(String.format("Unsupported security subEndpoint : %d", subEndpoint)); |
|||
} |
|||
} |
|||
@ -0,0 +1,67 @@ |
|||
/** |
|||
* 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.RequiredArgsConstructor; |
|||
import org.eclipse.leshan.core.request.Identity; |
|||
import org.eclipse.leshan.core.request.UplinkRequest; |
|||
import org.eclipse.leshan.server.registration.Registration; |
|||
import org.eclipse.leshan.server.security.Authorizer; |
|||
import org.eclipse.leshan.server.security.SecurityChecker; |
|||
import org.eclipse.leshan.server.security.SecurityInfo; |
|||
import org.springframework.stereotype.Component; |
|||
import org.thingsboard.server.queue.util.TbLwM2mTransportComponent; |
|||
import org.thingsboard.server.transport.lwm2m.server.client.LwM2mClientContext; |
|||
import org.thingsboard.server.transport.lwm2m.server.store.TbLwM2MDtlsSessionStore; |
|||
import org.thingsboard.server.transport.lwm2m.server.store.TbLwM2mSecurityStore; |
|||
|
|||
@Component |
|||
@RequiredArgsConstructor |
|||
@TbLwM2mTransportComponent |
|||
public class TbLwM2MAuthorizer implements Authorizer { |
|||
|
|||
private final TbLwM2MDtlsSessionStore sessionStorage; |
|||
private final TbLwM2mSecurityStore securityStore; |
|||
private final SecurityChecker securityChecker = new SecurityChecker(); |
|||
private final LwM2mClientContext clientContext; |
|||
|
|||
@Override |
|||
public Registration isAuthorized(UplinkRequest<?> request, Registration registration, Identity senderIdentity) { |
|||
if (senderIdentity.isX509()) { |
|||
TbX509DtlsSessionInfo sessionInfo = sessionStorage.get(registration.getEndpoint()); |
|||
if (sessionInfo != null) { |
|||
if (sessionInfo.getX509CommonName().endsWith(senderIdentity.getX509CommonName())) { |
|||
clientContext.registerClient(registration, sessionInfo.getCredentials()); |
|||
// X509 certificate is valid and matches endpoint.
|
|||
return registration; |
|||
} else { |
|||
// X509 certificate is not valid.
|
|||
return null; |
|||
} |
|||
} |
|||
// If session info is not found, this may be the trusted certificate, so we still need to check all other options below.
|
|||
} |
|||
SecurityInfo expectedSecurityInfo = null; |
|||
if (securityStore != null) { |
|||
expectedSecurityInfo = securityStore.getByEndpoint(registration.getEndpoint()); |
|||
} |
|||
if (securityChecker.checkSecurityInfo(registration.getEndpoint(), senderIdentity, expectedSecurityInfo)) { |
|||
return registration; |
|||
} else { |
|||
return null; |
|||
} |
|||
} |
|||
} |
|||
@ -0,0 +1,195 @@ |
|||
/** |
|||
* 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.RequiredArgsConstructor; |
|||
import lombok.extern.slf4j.Slf4j; |
|||
import org.eclipse.californium.elements.util.CertPathUtil; |
|||
import org.eclipse.californium.scandium.dtls.AlertMessage; |
|||
import org.eclipse.californium.scandium.dtls.CertificateMessage; |
|||
import org.eclipse.californium.scandium.dtls.CertificateType; |
|||
import org.eclipse.californium.scandium.dtls.CertificateVerificationResult; |
|||
import org.eclipse.californium.scandium.dtls.ConnectionId; |
|||
import org.eclipse.californium.scandium.dtls.DTLSSession; |
|||
import org.eclipse.californium.scandium.dtls.HandshakeException; |
|||
import org.eclipse.californium.scandium.dtls.HandshakeResultHandler; |
|||
import org.eclipse.californium.scandium.dtls.x509.NewAdvancedCertificateVerifier; |
|||
import org.eclipse.californium.scandium.dtls.x509.StaticCertificateVerifier; |
|||
import org.eclipse.californium.scandium.util.ServerNames; |
|||
import org.springframework.beans.factory.annotation.Value; |
|||
import org.springframework.stereotype.Component; |
|||
import org.springframework.util.StringUtils; |
|||
import org.thingsboard.common.util.JacksonUtil; |
|||
import org.thingsboard.server.common.data.DeviceProfile; |
|||
import org.thingsboard.server.common.data.device.credentials.lwm2m.LwM2MSecurityMode; |
|||
import org.thingsboard.server.common.msg.EncryptionUtil; |
|||
import org.thingsboard.server.common.transport.TransportService; |
|||
import org.thingsboard.server.common.transport.TransportServiceCallback; |
|||
import org.thingsboard.server.common.transport.auth.ValidateDeviceCredentialsResponse; |
|||
import org.thingsboard.server.common.transport.util.SslUtil; |
|||
import org.thingsboard.server.gen.transport.TransportProtos; |
|||
import org.thingsboard.server.queue.util.TbLwM2mTransportComponent; |
|||
import org.thingsboard.server.transport.lwm2m.config.LwM2MTransportServerConfig; |
|||
import org.thingsboard.server.transport.lwm2m.secure.credentials.LwM2MCredentials; |
|||
import org.thingsboard.server.common.data.device.credentials.lwm2m.X509ClientCredentials; |
|||
import org.thingsboard.server.transport.lwm2m.server.store.TbLwM2MDtlsSessionStore; |
|||
|
|||
import javax.annotation.PostConstruct; |
|||
import javax.security.auth.x500.X500Principal; |
|||
import java.security.PublicKey; |
|||
import java.security.cert.CertPath; |
|||
import java.security.cert.CertificateEncodingException; |
|||
import java.security.cert.CertificateExpiredException; |
|||
import java.security.cert.CertificateNotYetValidException; |
|||
import java.security.cert.X509Certificate; |
|||
import java.util.Arrays; |
|||
import java.util.List; |
|||
import java.util.concurrent.CountDownLatch; |
|||
import java.util.concurrent.TimeUnit; |
|||
|
|||
@Slf4j |
|||
@Component |
|||
@TbLwM2mTransportComponent |
|||
@RequiredArgsConstructor |
|||
public class TbLwM2MDtlsCertificateVerifier implements NewAdvancedCertificateVerifier { |
|||
|
|||
private final TransportService transportService; |
|||
private final TbLwM2MDtlsSessionStore sessionStorage; |
|||
private final LwM2MTransportServerConfig config; |
|||
|
|||
@SuppressWarnings("deprecation") |
|||
private StaticCertificateVerifier staticCertificateVerifier; |
|||
|
|||
@Value("${transport.lwm2m.server.security.skip_validity_check_for_client_cert:false}") |
|||
private boolean skipValidityCheckForClientCert; |
|||
|
|||
@Override |
|||
public List<CertificateType> getSupportedCertificateType() { |
|||
return Arrays.asList(CertificateType.X_509, CertificateType.RAW_PUBLIC_KEY); |
|||
} |
|||
|
|||
@PostConstruct |
|||
public void init() { |
|||
try { |
|||
/* by default trust all */ |
|||
X509Certificate[] trustedCertificates = new X509Certificate[0]; |
|||
if (config.getKeyStoreValue() != null) { |
|||
X509Certificate rootCAX509Cert = (X509Certificate) config.getKeyStoreValue().getCertificate(config.getRootCertificateAlias()); |
|||
if (rootCAX509Cert != null) { |
|||
trustedCertificates = new X509Certificate[1]; |
|||
trustedCertificates[0] = rootCAX509Cert; |
|||
} |
|||
} |
|||
staticCertificateVerifier = new StaticCertificateVerifier(trustedCertificates); |
|||
} catch (Exception e) { |
|||
log.info("Failed to initialize the "); |
|||
} |
|||
} |
|||
|
|||
@Override |
|||
public CertificateVerificationResult verifyCertificate(ConnectionId cid, ServerNames serverName, Boolean clientUsage, boolean truncateCertificatePath, CertificateMessage message, DTLSSession session) { |
|||
CertPath certChain = message.getCertificateChain(); |
|||
if (certChain == null) { |
|||
//We trust all RPK on this layer, and use TbLwM2MAuthorizer
|
|||
PublicKey publicKey = message.getPublicKey(); |
|||
return new CertificateVerificationResult(cid, publicKey, null); |
|||
} else { |
|||
try { |
|||
boolean x509CredentialsFound = false; |
|||
CertPath certpath = message.getCertificateChain(); |
|||
X509Certificate[] chain = certpath.getCertificates().toArray(new X509Certificate[0]); |
|||
for (X509Certificate cert : chain) { |
|||
try { |
|||
if (!skipValidityCheckForClientCert) { |
|||
cert.checkValidity(); |
|||
} |
|||
|
|||
String strCert = SslUtil.getCertificateString(cert); |
|||
String sha3Hash = EncryptionUtil.getSha3Hash(strCert); |
|||
final ValidateDeviceCredentialsResponse[] deviceCredentialsResponse = new ValidateDeviceCredentialsResponse[1]; |
|||
CountDownLatch latch = new CountDownLatch(1); |
|||
transportService.process(TransportProtos.ValidateDeviceLwM2MCredentialsRequestMsg.newBuilder().setCredentialsId(sha3Hash).build(), |
|||
new TransportServiceCallback<>() { |
|||
@Override |
|||
public void onSuccess(ValidateDeviceCredentialsResponse msg) { |
|||
if (!StringUtils.isEmpty(msg.getCredentials())) { |
|||
deviceCredentialsResponse[0] = msg; |
|||
} |
|||
latch.countDown(); |
|||
} |
|||
|
|||
@Override |
|||
public void onError(Throwable e) { |
|||
log.error(e.getMessage(), e); |
|||
latch.countDown(); |
|||
} |
|||
}); |
|||
if (latch.await(10, TimeUnit.SECONDS)) { |
|||
ValidateDeviceCredentialsResponse msg = deviceCredentialsResponse[0]; |
|||
if (msg != null && org.thingsboard.server.common.data.StringUtils.isNotEmpty(msg.getCredentials())) { |
|||
LwM2MCredentials credentials = JacksonUtil.fromString(msg.getCredentials(), LwM2MCredentials.class); |
|||
if(!credentials.getClient().getSecurityConfigClientMode().equals(LwM2MSecurityMode.X509)){ |
|||
continue; |
|||
} |
|||
X509ClientCredentials config = (X509ClientCredentials) credentials.getClient(); |
|||
String certBody = config.getCert(); |
|||
String endpoint = config.getEndpoint(); |
|||
if (strCert.equals(certBody)) { |
|||
x509CredentialsFound = true; |
|||
DeviceProfile deviceProfile = msg.getDeviceProfile(); |
|||
if (msg.hasDeviceInfo() && deviceProfile != null) { |
|||
sessionStorage.put(endpoint, new TbX509DtlsSessionInfo(cert.getSubjectX500Principal().getName(), msg)); |
|||
break; |
|||
} |
|||
} else { |
|||
log.trace("[{}][{}] Certificate mismatch. Expected: {}, Actual: {}", endpoint, sha3Hash, strCert, certBody); |
|||
} |
|||
} |
|||
} |
|||
} catch (InterruptedException | |
|||
CertificateEncodingException | |
|||
CertificateExpiredException | |
|||
CertificateNotYetValidException e) { |
|||
log.error(e.getMessage(), e); |
|||
} |
|||
} |
|||
if (!x509CredentialsFound) { |
|||
if (staticCertificateVerifier != null) { |
|||
staticCertificateVerifier.verifyCertificate(message, session); |
|||
} else { |
|||
AlertMessage alert = new AlertMessage(AlertMessage.AlertLevel.FATAL, AlertMessage.AlertDescription.INTERNAL_ERROR, |
|||
session.getPeer()); |
|||
throw new HandshakeException("x509 verification not enabled!", alert); |
|||
} |
|||
} |
|||
return new CertificateVerificationResult(cid, certpath, null); |
|||
} catch (HandshakeException e) { |
|||
log.trace("Certificate validation failed!", e); |
|||
return new CertificateVerificationResult(cid, e, null); |
|||
} |
|||
} |
|||
} |
|||
|
|||
@Override |
|||
public List<X500Principal> getAcceptedIssuers() { |
|||
return CertPathUtil.toSubjects(null); |
|||
} |
|||
|
|||
@Override |
|||
public void setResultHandler(HandshakeResultHandler resultHandler) { |
|||
|
|||
} |
|||
} |
|||
@ -0,0 +1,27 @@ |
|||
/** |
|||
* 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.Data; |
|||
import org.thingsboard.server.common.transport.auth.ValidateDeviceCredentialsResponse; |
|||
|
|||
@Data |
|||
public class TbX509DtlsSessionInfo { |
|||
|
|||
private final String x509CommonName; |
|||
private final ValidateDeviceCredentialsResponse credentials; |
|||
|
|||
} |
|||
@ -0,0 +1,26 @@ |
|||
/** |
|||
* 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.credentials; |
|||
|
|||
import lombok.Data; |
|||
import org.thingsboard.server.common.data.device.credentials.lwm2m.LwM2MClientCredentials; |
|||
import org.thingsboard.server.transport.lwm2m.bootstrap.secure.LwM2MBootstrapConfig; |
|||
|
|||
@Data |
|||
public class LwM2MCredentials { |
|||
private LwM2MClientCredentials client; |
|||
private LwM2MBootstrapConfig bootstrap; |
|||
} |
|||
@ -0,0 +1,40 @@ |
|||
/** |
|||
* 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.server.store; |
|||
|
|||
import org.thingsboard.server.transport.lwm2m.secure.TbX509DtlsSessionInfo; |
|||
|
|||
import java.util.concurrent.ConcurrentHashMap; |
|||
|
|||
public class TbL2M2MDtlsSessionInMemoryStore implements TbLwM2MDtlsSessionStore { |
|||
|
|||
private final ConcurrentHashMap<String, TbX509DtlsSessionInfo> store = new ConcurrentHashMap<>(); |
|||
|
|||
@Override |
|||
public void put(String endpoint, TbX509DtlsSessionInfo msg) { |
|||
store.put(endpoint, msg); |
|||
} |
|||
|
|||
@Override |
|||
public TbX509DtlsSessionInfo get(String endpoint) { |
|||
return store.get(endpoint); |
|||
} |
|||
|
|||
@Override |
|||
public void remove(String endpoint) { |
|||
store.remove(endpoint); |
|||
} |
|||
} |
|||
Some files were not shown because too many files changed in this diff
Loading…
Reference in new issue