ViacheslavKlimov
3 years ago
15 changed files with 1294 additions and 10 deletions
@ -0,0 +1,171 @@ |
|||
/** |
|||
* Copyright © 2016-2023 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.monitoring.client; |
|||
|
|||
import lombok.Getter; |
|||
import lombok.Setter; |
|||
import lombok.SneakyThrows; |
|||
import lombok.extern.slf4j.Slf4j; |
|||
import org.apache.commons.lang3.StringUtils; |
|||
import org.eclipse.californium.core.network.CoapEndpoint; |
|||
import org.eclipse.californium.core.network.config.NetworkConfig; |
|||
import org.eclipse.californium.core.observe.ObservationStore; |
|||
import org.eclipse.californium.scandium.DTLSConnector; |
|||
import org.eclipse.californium.scandium.config.DtlsConnectorConfig; |
|||
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.resource.BaseInstanceEnabler; |
|||
import org.eclipse.leshan.client.resource.DummyInstanceEnabler; |
|||
import org.eclipse.leshan.client.resource.ObjectsInitializer; |
|||
import org.eclipse.leshan.client.servers.ServerIdentity; |
|||
import org.eclipse.leshan.core.californium.EndpointFactory; |
|||
import org.eclipse.leshan.core.model.InvalidDDFFileException; |
|||
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.DefaultLwM2mDecoder; |
|||
import org.eclipse.leshan.core.node.codec.DefaultLwM2mEncoder; |
|||
import org.eclipse.leshan.core.response.ReadResponse; |
|||
import org.thingsboard.monitoring.util.ResourceUtils; |
|||
|
|||
import javax.security.auth.Destroyable; |
|||
import java.io.IOException; |
|||
import java.net.InetSocketAddress; |
|||
import java.util.ArrayList; |
|||
import java.util.Collections; |
|||
import java.util.List; |
|||
|
|||
import static org.eclipse.leshan.client.object.Security.noSec; |
|||
import static org.eclipse.leshan.core.LwM2mId.ACCESS_CONTROL; |
|||
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 |
|||
public class Lwm2mClient extends BaseInstanceEnabler implements Destroyable { |
|||
|
|||
@Getter |
|||
@Setter |
|||
private LeshanClient leshanClient; |
|||
|
|||
private static final List<Integer> supportedResources = Collections.singletonList(0); |
|||
|
|||
private String data = ""; |
|||
|
|||
private String serverUri; |
|||
private String endpoint; |
|||
|
|||
public Lwm2mClient(String serverUri, String endpoint) { |
|||
this.serverUri = serverUri; |
|||
this.endpoint = endpoint; |
|||
} |
|||
|
|||
public Lwm2mClient() { |
|||
} |
|||
|
|||
public void initClient() throws InvalidDDFFileException, IOException { |
|||
String[] resources = new String[]{"0.xml", "1.xml", "2.xml", "test-model.xml"}; |
|||
List<ObjectModel> models = new ArrayList<>(); |
|||
for (String resourceName : resources) { |
|||
models.addAll(ObjectLoader.loadDdfFile(ResourceUtils.getResourceAsStream("lwm2m/models/" + resourceName), resourceName)); |
|||
} |
|||
|
|||
Security security = noSec(serverUri, 123); |
|||
NetworkConfig coapConfig = new NetworkConfig().setString(NetworkConfig.Keys.COAP_PORT, StringUtils.substringAfterLast(serverUri, ":")); |
|||
|
|||
LeshanClient leshanClient; |
|||
|
|||
LwM2mModel model = new StaticModel(models); |
|||
ObjectsInitializer initializer = new ObjectsInitializer(model); |
|||
initializer.setInstancesForObject(SECURITY, security); |
|||
initializer.setInstancesForObject(SERVER, new Server(123, 300)); |
|||
initializer.setInstancesForObject(DEVICE, this); |
|||
initializer.setClassForObject(ACCESS_CONTROL, DummyInstanceEnabler.class); |
|||
DtlsConnectorConfig.Builder dtlsConfig = new DtlsConnectorConfig.Builder(); |
|||
dtlsConfig.setRecommendedCipherSuitesOnly(true); |
|||
dtlsConfig.setClientOnly(); |
|||
|
|||
DefaultRegistrationEngineFactory engineFactory = new DefaultRegistrationEngineFactory(); |
|||
engineFactory.setReconnectOnUpdate(false); |
|||
engineFactory.setResumeOnConnect(true); |
|||
|
|||
EndpointFactory endpointFactory = new EndpointFactory() { |
|||
|
|||
@Override |
|||
public CoapEndpoint createUnsecuredEndpoint(InetSocketAddress address, NetworkConfig coapConfig, |
|||
ObservationStore store) { |
|||
CoapEndpoint.Builder builder = new CoapEndpoint.Builder(); |
|||
builder.setInetSocketAddress(address); |
|||
builder.setNetworkConfig(coapConfig); |
|||
return builder.build(); |
|||
} |
|||
|
|||
@Override |
|||
public CoapEndpoint createSecuredEndpoint(DtlsConnectorConfig dtlsConfig, NetworkConfig coapConfig, |
|||
ObservationStore store) { |
|||
CoapEndpoint.Builder builder = new CoapEndpoint.Builder(); |
|||
DtlsConnectorConfig.Builder dtlsConfigBuilder = new DtlsConnectorConfig.Builder(dtlsConfig); |
|||
builder.setConnector(new DTLSConnector(dtlsConfigBuilder.build())); |
|||
builder.setNetworkConfig(coapConfig); |
|||
return builder.build(); |
|||
} |
|||
}; |
|||
|
|||
LeshanClientBuilder builder = new LeshanClientBuilder(endpoint); |
|||
builder.setObjects(initializer.createAll()); |
|||
builder.setCoapConfig(coapConfig); |
|||
builder.setDtlsConfig(dtlsConfig); |
|||
builder.setRegistrationEngineFactory(engineFactory); |
|||
builder.setEndpointFactory(endpointFactory); |
|||
builder.setDecoder(new DefaultLwM2mDecoder(false)); |
|||
builder.setEncoder(new DefaultLwM2mEncoder(false)); |
|||
leshanClient = builder.build(); |
|||
|
|||
setLeshanClient(leshanClient); |
|||
|
|||
leshanClient.start(); |
|||
} |
|||
|
|||
@Override |
|||
public List<Integer> getAvailableResourceIds(ObjectModel model) { |
|||
return supportedResources; |
|||
} |
|||
|
|||
@Override |
|||
public ReadResponse read(ServerIdentity identity, int resourceId) { |
|||
if (supportedResources.contains(resourceId)) { |
|||
return ReadResponse.success(resourceId, data); |
|||
} |
|||
return super.read(identity, resourceId); |
|||
} |
|||
|
|||
@SneakyThrows |
|||
public void send(String data, int resource) { |
|||
this.data = data; |
|||
fireResourcesChange(resource); |
|||
} |
|||
|
|||
@Override |
|||
public void destroy() { |
|||
if (leshanClient != null) { |
|||
leshanClient.destroy(true); |
|||
} |
|||
} |
|||
} |
|||
@ -0,0 +1,33 @@ |
|||
/** |
|||
* Copyright © 2016-2023 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.monitoring.config.service; |
|||
|
|||
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; |
|||
import org.springframework.boot.context.properties.ConfigurationProperties; |
|||
import org.springframework.stereotype.Component; |
|||
import org.thingsboard.monitoring.config.TransportType; |
|||
|
|||
@Component |
|||
@ConditionalOnProperty(name = "monitoring.transports.lwm2m.enabled", havingValue = "true") |
|||
@ConfigurationProperties(prefix = "monitoring.transports.lwm2m") |
|||
public class Lwm2mTransportMonitoringConfig extends TransportMonitoringConfig { |
|||
|
|||
@Override |
|||
public TransportType getTransportType() { |
|||
return TransportType.LWM2M; |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,72 @@ |
|||
/** |
|||
* Copyright © 2016-2023 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.monitoring.transport.impl; |
|||
|
|||
import lombok.extern.slf4j.Slf4j; |
|||
import org.springframework.beans.factory.config.ConfigurableBeanFactory; |
|||
import org.springframework.context.annotation.Scope; |
|||
import org.springframework.stereotype.Service; |
|||
import org.thingsboard.monitoring.client.Lwm2mClient; |
|||
import org.thingsboard.monitoring.config.MonitoringTargetConfig; |
|||
import org.thingsboard.monitoring.config.TransportType; |
|||
import org.thingsboard.monitoring.config.service.Lwm2mTransportMonitoringConfig; |
|||
import org.thingsboard.monitoring.transport.TransportHealthChecker; |
|||
|
|||
@Service |
|||
@Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE) |
|||
@Slf4j |
|||
public class Lwm2mTransportHealthChecker extends TransportHealthChecker<Lwm2mTransportMonitoringConfig> { |
|||
|
|||
private Lwm2mClient lwm2mClient; |
|||
|
|||
protected Lwm2mTransportHealthChecker(Lwm2mTransportMonitoringConfig config, MonitoringTargetConfig target) { |
|||
super(config, target); |
|||
} |
|||
|
|||
@Override |
|||
protected void initClient() throws Exception { |
|||
if (lwm2mClient == null || lwm2mClient.getLeshanClient() == null || lwm2mClient.isDestroyed()) { |
|||
String endpoint = target.getDevice().getCredentials().getCredentialsId(); |
|||
lwm2mClient = new Lwm2mClient(target.getBaseUrl(), endpoint); |
|||
lwm2mClient.initClient(); |
|||
log.debug("Initialized LwM2M client for endpoint '{}'", endpoint); |
|||
} |
|||
} |
|||
|
|||
@Override |
|||
protected void sendTestPayload(String payload) throws Exception { |
|||
lwm2mClient.send(payload, 0); |
|||
} |
|||
|
|||
@Override |
|||
protected String createTestPayload(String testValue) { |
|||
return testValue; |
|||
} |
|||
|
|||
@Override |
|||
protected void destroyClient() throws Exception { |
|||
if (lwm2mClient != null) { |
|||
lwm2mClient.destroy(); |
|||
lwm2mClient = null; |
|||
} |
|||
} |
|||
|
|||
@Override |
|||
protected TransportType getTransportType() { |
|||
return TransportType.LWM2M; |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,42 @@ |
|||
/** |
|||
* Copyright © 2016-2023 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.monitoring.util; |
|||
|
|||
import lombok.SneakyThrows; |
|||
import org.thingsboard.common.util.JacksonUtil; |
|||
|
|||
import java.io.InputStream; |
|||
|
|||
public class ResourceUtils { |
|||
|
|||
@SneakyThrows |
|||
public static <T> T getResource(String path, Class<T> type) { |
|||
InputStream resource = ResourceUtils.class.getClassLoader().getResourceAsStream(path); |
|||
if (resource == null) { |
|||
throw new IllegalArgumentException("Resource not found for path " + path); |
|||
} |
|||
return JacksonUtil.OBJECT_MAPPER.readValue(resource, type); |
|||
} |
|||
|
|||
public static InputStream getResourceAsStream(String path) { |
|||
InputStream resource = ResourceUtils.class.getClassLoader().getResourceAsStream(path); |
|||
if (resource == null) { |
|||
throw new IllegalArgumentException("Resource not found for path " + path); |
|||
} |
|||
return resource; |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,59 @@ |
|||
{ |
|||
"name": "LwM2M Monitoring", |
|||
"type": "DEFAULT", |
|||
"image": null, |
|||
"defaultQueueName": null, |
|||
"transportType": "LWM2M", |
|||
"provisionType": "DISABLED", |
|||
"description": "", |
|||
"profileData": { |
|||
"configuration": { |
|||
"type": "DEFAULT" |
|||
}, |
|||
"transportConfiguration": { |
|||
"observeAttr": { |
|||
"observe": [ |
|||
"/3_1.0/0/0" |
|||
], |
|||
"attribute": [], |
|||
"telemetry": [ |
|||
"/3_1.0/0/0" |
|||
], |
|||
"keyName": { |
|||
"/3_1.0/0/0": "testData" |
|||
}, |
|||
"attributeLwm2m": {} |
|||
}, |
|||
"bootstrap": [ |
|||
{ |
|||
"shortServerId": 123, |
|||
"bootstrapServerIs": false, |
|||
"host": "0.0.0.0", |
|||
"port": 5685, |
|||
"clientHoldOffTime": 1, |
|||
"serverPublicKey": "", |
|||
"serverCertificate": "", |
|||
"bootstrapServerAccountTimeout": 0, |
|||
"lifetime": 300, |
|||
"defaultMinPeriod": 1, |
|||
"notifIfDisabled": true, |
|||
"binding": "U", |
|||
"securityMode": "NO_SEC" |
|||
} |
|||
], |
|||
"clientLwM2mSettings": { |
|||
"clientOnlyObserveAfterConnect": 1, |
|||
"fwUpdateStrategy": 1, |
|||
"swUpdateStrategy": 1, |
|||
"powerMode": "DRX", |
|||
"compositeOperationsSupport": false |
|||
}, |
|||
"bootstrapServerUpdateEnable": false, |
|||
"type": "LWM2M" |
|||
}, |
|||
"alarms": null, |
|||
"provisionConfiguration": { |
|||
"type": "DISABLED" |
|||
} |
|||
} |
|||
} |
|||
@ -0,0 +1,364 @@ |
|||
<?xml version="1.0" encoding="UTF-8"?> |
|||
<!-- |
|||
|
|||
Copyright © 2016-2023 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. |
|||
|
|||
--> |
|||
<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,319 @@ |
|||
<?xml version="1.0" encoding="UTF-8"?> |
|||
<!-- |
|||
|
|||
Copyright © 2016-2023 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. |
|||
|
|||
--> |
|||
<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,83 @@ |
|||
<?xml version="1.0" encoding="UTF-8"?> |
|||
<!-- |
|||
|
|||
Copyright © 2016-2023 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. |
|||
|
|||
--> |
|||
<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,45 @@ |
|||
<?xml version="1.0" encoding="UTF-8"?> |
|||
<!-- |
|||
|
|||
Copyright © 2016-2023 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. |
|||
|
|||
--> |
|||
<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 Monitoring</Name> |
|||
<Description1> |
|||
<![CDATA[]]></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>Test data</Name> |
|||
<Operations>R</Operations> |
|||
<MultipleInstances>Single</MultipleInstances> |
|||
<Mandatory>Optional</Mandatory> |
|||
<Type>String</Type> |
|||
<RangeEnumeration></RangeEnumeration> |
|||
<Units></Units> |
|||
<Description><![CDATA[Test data]]></Description> |
|||
</Item> |
|||
</Resources> |
|||
<Description2></Description2> |
|||
</Object> |
|||
</LWM2M> |
|||
@ -0,0 +1,6 @@ |
|||
{ |
|||
"title": "", |
|||
"resourceType": "LWM2M_MODEL", |
|||
"fileName": "test-model.xml", |
|||
"data": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPCEtLQoKICAgIENvcHlyaWdodCDCqSAyMDE2LTIwMjIgVGhlIFRoaW5nc2JvYXJkIEF1dGhvcnMKCiAgICBMaWNlbnNlZCB1bmRlciB0aGUgQXBhY2hlIExpY2Vuc2UsIFZlcnNpb24gMi4wICh0aGUgIkxpY2Vuc2UiKTsKICAgIHlvdSBtYXkgbm90IHVzZSB0aGlzIGZpbGUgZXhjZXB0IGluIGNvbXBsaWFuY2Ugd2l0aCB0aGUgTGljZW5zZS4KICAgIFlvdSBtYXkgb2J0YWluIGEgY29weSBvZiB0aGUgTGljZW5zZSBhdAoKICAgICAgICBodHRwOi8vd3d3LmFwYWNoZS5vcmcvbGljZW5zZXMvTElDRU5TRS0yLjAKCiAgICBVbmxlc3MgcmVxdWlyZWQgYnkgYXBwbGljYWJsZSBsYXcgb3IgYWdyZWVkIHRvIGluIHdyaXRpbmcsIHNvZnR3YXJlCiAgICBkaXN0cmlidXRlZCB1bmRlciB0aGUgTGljZW5zZSBpcyBkaXN0cmlidXRlZCBvbiBhbiAiQVMgSVMiIEJBU0lTLAogICAgV0lUSE9VVCBXQVJSQU5USUVTIE9SIENPTkRJVElPTlMgT0YgQU5ZIEtJTkQsIGVpdGhlciBleHByZXNzIG9yIGltcGxpZWQuCiAgICBTZWUgdGhlIExpY2Vuc2UgZm9yIHRoZSBzcGVjaWZpYyBsYW5ndWFnZSBnb3Zlcm5pbmcgcGVybWlzc2lvbnMgYW5kCiAgICBsaW1pdGF0aW9ucyB1bmRlciB0aGUgTGljZW5zZS4KCi0tPgo8TFdNMk0geG1sbnM6eHNpPSJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYS1pbnN0YW5jZSIKICAgICAgIHhzaTpub05hbWVzcGFjZVNjaGVtYUxvY2F0aW9uPSJodHRwOi8vd3d3Lm9wZW5tb2JpbGVhbGxpYW5jZS5vcmcvdGVjaC9wcm9maWxlcy9MV00yTS12MV8xLnhzZCI+CiAgICA8T2JqZWN0IE9iamVjdFR5cGU9Ik1PRGVmaW5pdGlvbiI+CiAgICAgICAgPE5hbWU+THdNMk0gTW9uaXRvcmluZzwvTmFtZT4KICAgICAgICA8RGVzY3JpcHRpb24xPgogICAgICAgICAgICA8IVtDREFUQVtdXT48L0Rlc2NyaXB0aW9uMT4KICAgICAgICA8T2JqZWN0SUQ+MzwvT2JqZWN0SUQ+CiAgICAgICAgPE9iamVjdFVSTj51cm46b21hOmx3bTJtOm9tYTozOjEuMDwvT2JqZWN0VVJOPgogICAgICAgIDxMV00yTVZlcnNpb24+MS4xPC9MV00yTVZlcnNpb24+CiAgICAgICAgPE9iamVjdFZlcnNpb24+MS4wPC9PYmplY3RWZXJzaW9uPgogICAgICAgIDxNdWx0aXBsZUluc3RhbmNlcz5TaW5nbGU8L011bHRpcGxlSW5zdGFuY2VzPgogICAgICAgIDxNYW5kYXRvcnk+TWFuZGF0b3J5PC9NYW5kYXRvcnk+CiAgICAgICAgPFJlc291cmNlcz4KICAgICAgICAgICAgPEl0ZW0gSUQ9IjAiPgogICAgICAgICAgICAgICAgPE5hbWU+VGVzdCBkYXRhPC9OYW1lPgogICAgICAgICAgICAgICAgPE9wZXJhdGlvbnM+UjwvT3BlcmF0aW9ucz4KICAgICAgICAgICAgICAgIDxNdWx0aXBsZUluc3RhbmNlcz5TaW5nbGU8L011bHRpcGxlSW5zdGFuY2VzPgogICAgICAgICAgICAgICAgPE1hbmRhdG9yeT5PcHRpb25hbDwvTWFuZGF0b3J5PgogICAgICAgICAgICAgICAgPFR5cGU+U3RyaW5nPC9UeXBlPgogICAgICAgICAgICAgICAgPFJhbmdlRW51bWVyYXRpb24+PC9SYW5nZUVudW1lcmF0aW9uPgogICAgICAgICAgICAgICAgPFVuaXRzPjwvVW5pdHM+CiAgICAgICAgICAgICAgICA8RGVzY3JpcHRpb24+PCFbQ0RBVEFbVGVzdCBkYXRhXV0+PC9EZXNjcmlwdGlvbj4KICAgICAgICAgICAgPC9JdGVtPgogICAgICAgIDwvUmVzb3VyY2VzPgogICAgICAgIDxEZXNjcmlwdGlvbjI+PC9EZXNjcmlwdGlvbjI+CiAgICA8L09iamVjdD4KPC9MV00yTT4K" |
|||
} |
|||
Loading…
Reference in new issue