diff --git a/xep-0347.xml b/xep-0347.xml new file mode 100644 index 00000000..5761449e --- /dev/null +++ b/xep-0347.xml @@ -0,0 +1,1998 @@ + + + + +%ents; +]> + + +
+ Internet of Things - Discovery + This specification describes an architecture based on the XMPP protocol whereby Things can be installed and safely discovered by their owners and connected into networks of Things. + &LEGALNOTICE; + 0347 + Experimental + Standards Track + Standards + Council + + XMPP Core + XEP-0001 + XEP-0030 + XEP-0077 + XEP-0114 + XEP-0174 + XEP-0323 + XEP-0324 + XEP-0325 + XEP-0326 + + + + NOT_YET_ASSIGNED + + Peter + Waher + peter.waher@clayster.com + peter.waher@jabber.org + http://www.linkedin.com/in/peterwaher + + + Ronny + Klauck + rklauck@informatik.tu-cottbus.de + TBD + http://www-rnks.informatik.tu-cottbus.de/~rklauck + + + 0.1 + 2014-04-10 + editor (mam) + +

Initial published version approved by XMPP Council.

+ + + + 0.0.3 + 2014-04-09 + pw + +

Introduced possibility for hosting Thing Registry as a Jabber Server Component, using XEP-0114.

+

+ Expanded de section Determining Support, explaining how to search through server components. +

+

Removed the possibility to search for nick names, as a way of finding Thing Registries.

+

Added Security and Implementation Notes describing the pros and cons of hosting a Thing Registry as a Server Component vs. as a Client.

+ + + + 0.0.2 + 2014-04-07 + pw + +

Removed any hard-coded account names.

+ + + + 0.0.1 + 2014-03-11 + pw,rk + +

First draft.

+ + +
+ +

+ When installing massive amounts of Things into public networks care has to be taken to make installation simple, but at the same time secure so that the Things cannot be + hijacked or hacked, making sure access to the Thing is controlled by the physical owner of the Thing. One of the main problems is how + to match the characteristics of a Thing, like serial number, manufacturer, model, etc., with information automatically created by the Thing itself, like perhaps its JID, in + an environment with massive amount of Things without rich user interfaces. Care has also to be taken when specifying rules for access rights and user privileges. +

+

+ This document provides a network architecture based on the XMPP protocol that provides a means to safely install, configure, find and connect massive amounts of Things together, and + at the same time minimizing the risk that Things get hijacked. It also provides information how each individual step in the process can be performed with as little manual intervention + as possible, aiming where possible at zero-configuration networking. Furthermore, this document specifies how to create a registry that allows simple access to public Things + without risking their integrity unnecessarily. +

+

+ Internet of Things contains many different architectures and use cases. For this reason, the IoT standards have been divided into multiple XEPs according to the following table: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
XEPDescription
xep-0000-IoT-BatteryPoweredSensorsDefines how to handle the peculiars related to battery powered devices, and other devices intermittently available on the network.
xep-0000-IoT-DiscoveryThis specification. Defines the peculiars of Thing discovery in Internet of Things. Apart from discovering Things by JID, it also defines how to discover Things based on location, etc.
xep-0000-IoT-EventsDefines how Things send events, how event subscription, hysteresis levels, etc., are configured.
xep-0000-IoT-InteroperabilityDefines guidelines for how to achieve interoperability in Internet of Things, publishing interoperability interfaces for different types of devices.
xep-0000-IoT-MulticastDefines how sensor data can be multicast in efficient ways.
xep-0000-IoT-PubSubDefines how efficient publication of sensor data can be made in Internet of Things.
xep-0000-IoT-ChatDefines how human-to-machine interfaces should be constructed using chat messages to be user friendly, automatable and consistent with other IoT extensions and possible underlying architecture.
XEP-0322 + Defines how to EXI can be used in XMPP to achieve efficient compression of data. Albeit not an Internet of Things specific XEP, this XEP should be considered + in all Internet of Things implementations where memory and packet size is an issue. +
XEP-0323 + Provides the underlying architecture, basic operations and data structures for sensor data communication over XMPP networks. + It includes a hardware abstraction model, removing any technical detail implemented in underlying technologies. This XEP is used by all other + Internet of Things XEPs. +
XEP-0324Defines how provisioning, the management of access privileges, etc., can be efficiently and easily implemented.
XEP-0325Defines how to control actuators and other devices in Internet of Things.
XEP-0326Defines how to handle architectures containing concentrators or servers handling multiple Things.
XEP-0331Defines extensions for how color parameters can be handled, based on &xep0004;
XEP-0336Defines extensions for how dynamic forms can be created, based on &xep0004;, &xep0122;, &xep0137; and &xep0141;.
+ + +

The following table lists common terms and corresponding descriptions.

+
+ +
Actuator
+
Device containing at least one configurable property or output that can and should be controlled by some other entity or device.
+ + +
Authority
+
Used synonymously with Provisioning Server.
+ + +
Computed Value
+
A value that is computed instead of measured.
+ + +
Concentrator
+
Device managing a set of devices which it publishes on the XMPP network.
+ + +
Field
+
+ One item of sensor data. Contains information about: Node, Field Name, Value, Precision, Unit, Value Type, Status, Timestamp, Localization information, etc. + Fields should be unique within the triple (Node ID, Field Name, Timestamp). +
+ + +
Field Name
+
Name of a field of sensor data. Examples: Energy, Volume, Flow, Power, etc.
+ + +
Field Type
+
What type of value the field represents. Examples: Momentary Value, Status Value, Identification Value, Calculated Value, Peak Value, Historical Value, etc.
+ + +
Historical Value
+
A value stored in memory from a previous timestamp.
+ + +
Identification Value
+
A value that can be used for identification. (Serial numbers, meter IDs, locations, names, etc.)
+ + +
Localization information
+
Optional information for a field, allowing the sensor to control how the information should be presented to human viewers.
+ + +
Meter
+
A device possible containing multiple sensors, used in metering applications. Examples: Electricity meter, Water Meter, Heat Meter, Cooling Meter, etc.
+ + +
Momentary Value
+
A momentary value represents a value measured at the time of the read-out.
+ + +
Node
+
+ Graphs contain nodes and edges between nodes. In Internet of Things, sensors, actuators, meters, devices, gateways, etc., are often depicted as nodes whereas links between sensors (friendships) + are depicted as edges. In abstract terms, it's easier to talk about a Node, rather than list different possible node types (sensors, actuators, meters, devices, gateways, etc.). + Each Node has a Node ID. +
+ + +
Node ID
+
+ An ID uniquely identifying a node within its corresponding context. If a globally unique ID is desired, an architecture should be used using a universally accepted + ID scheme. +
+ + +
Parameter
+
+ Readable and/or writable property on a node/device. The XEP-0326 &xep0326; deals with reading and writing parameters + on nodes/devices. Fields are not parameters, and parameters are not fields. +
+ + +
Peak Value
+
A maximum or minimum value during a given period.
+ + +
Provisioning Server
+
+ An application that can configure a network and provide services to users or Things. In Internet of Things, a Provisioning Server knows who knows whom, + what privileges users have, who can read what data and who can control what devices and what parts of these devices. +
+ + +
Precision
+
+ In physics, precision determines the number of digits of precision. In sensor networks however, this definition is not easily applicable. Instead, precision + determines, for example, the number of decimals of precision, or power of precision. Example: 123.200 MWh contains 3 decimals of precision. All entities parsing and + delivering field information in sensor networks should always retain the number of decimals in a message. +
+ + +
Sensor
+
+ Device measuring at least one digital value (0 or 1) or analog value (value with precision and physical unit). Examples: Temperature sensor, pressure sensor, etc. + Sensor values are reported as fields during read-out. Each sensor has a unique Node ID. +
+ + +
SN
+
Sensor Network. A network consisting, but not limited to sensors, where transport and use of sensor data is of primary concern. A sensor network may contain actuators, network applications, monitors, services, etc.
+ + +
Status Value
+
A value displaying status information about something.
+ + +
Timestamp
+
Timestamp of value, when the value was sampled or recorded.
+ + +
Thing
+
+ Internet of Things basically consists of Things connected to the Internet. Things can be any device, sensor, actuator etc., that can have an + Internet connection. +
+ + +
Thing Registry
+
+ A registry where Things can register for simple and secure discovery by the owner of the Thing. The registry can also be used as a database for meta information + about Things in the network. +
+ + +
Token
+
+ A client, device or user can get a token from a provisioning server. These tokens can be included in requests to other entities in the network, so these entities can validate + access rights with the provisioning server. +
+ + +
Unit
+
Physical unit of value. Example: MWh, l/s, etc.
+ + +
Value
+
A field value.
+ + +
Value Status
+
Status of field value. Contains important status information for Quality of Service purposes. Examples: Ok, Error, Warning, Time Shifted, Missing, Signed, etc.
+ + +
Value Type
+
Can be numeric, string, boolean, Date & Time, Time Span or Enumeration.
+ + +
WSN
+
Wireless Sensor Network, a sensor network including wireless devices.
+ + +
XMPP Client
+
Application connected to an XMPP network, having a JID. Note that sensors, as well as applications requesting sensor data can be XMPP clients.
+ +
+ + +

+ The life cycle of a Thing can be divided into multiple steps. The following sections will list many of these steps in possible order of occurrence during the + life cycle of the Thing. +

+ +

+ During production of a Thing, decisions have to be made whether the following parameters should be pre-configured, manually entered after installation or + automatically found and/or created by the device if possible (zero-configuration networking): +

+
    +
  • + Address and domain of XMPP Server. +
    • +
  • + JID of the Thing. +
    • +
  • + JID of Thing Registry, if separate from the XMPP Server. +
    • +
  • + JID of first Provisioning Server, if separate from Thing Registry or XMPP Server. +
    • +
+

+ A decision has to be made at this point if global/manufacturer/customer servers should be used, or if local resources should be searched for and used if found. + The first option is easy to configure in a production environment and might have commercial significance, + but cannot use local resources where available. The second leaves much responsibility to the Thing for finding local resources, but has the advantage of allowing for a more + decentralized network architecture. A detailed discussion of the two alternatives goes beyond the scope of this specification, and will not be presented here. +

+ + +

+ Apart from physical installation, and connection to power and communication infrastructure, the installation phase of a Thing might also require manual entry of values that + could not be set in the production environment. Since Things might have very limited human user interfaces, external tools might be required to provide this information. Due + to its complexity, any manual entry of configuration parameters should be avoided, if possible. However, manual entry of some parameters might allow for Things to use local + resources where such cannot be found nor set in a production environment. +

+ + +

+ If the address of an XMPP Server is not preconfigured, the Thing must attempt to find one in its local surroundings. This can be done using one of several methods: +

+
    +
  • DHCP
    • +
  • Multicast DNS
    • +
  • SSDP/UPnP
    • +
+

+ The following sections describe them in more detail. +

+ +

+ DHCP offers an internal structure for advertising configuration information to clients in a network. + This includes configuration parameters and other control elements, which are transmitted in special marked data elements, called 'options', as described in + + RFC 3942 + + RFC 3942: Reclassifying Dynamic Host Configuration Protocol version 4 (DHCPv4) Options <http://tools.ietf.org/html/rfc3942>. + . +

+

+ Dynamic Host Configuration Protocol (DHCP) and Bootstrap Protocol (BOOTP) Parameters lists currently assigned 'options' by IANA. + Note: There does exist no 'option' for XMPP at the moment. + Options 224 to 254 are marked as 'site-specific option range' to support local (to a site) configuration options (i.e., reserved as 'Private Use'). +

+

+ Possible codes for the XMPP server option: +

+
    +
  • Use 'site-specific option range'. Use of 'option-code' 224.
    • +
  • + TBD: Define and register DHCP and BOOTP option as described in Parameters for IoT Discovery. Use of 'option-code' 84. +
    • +
+ +

+ This option specifies the name of the XMPP server. + The name may or may not be qualified with the local domain name. + See &rfc1035; for character set restrictions. +

+

+ The code for this option is 224 (for 'site-specific option range') or 84 (for DHCP and BOOTP Parameters for IoT Discovery), and its minimum length is 1. +

+ + machine]]> + +

So, for example, if the machine name is "pronto", the code for the option is 224, the XMPP server option would be as follows:

+ + + + + +

The following parameters in use as of MONTH 201x. Refer to the DHCP and BOOTP parameters itself for a complete and current list of parameters (this specification might or might not be revised when new parameters are registered).

+ + 84 + XMPP server + N + XMPP Servers DHCP Option + [RFC6120]]]> + + + + +

+ An introduction of mDNS/DNS-SD (e.g., how it works and terminology) is described in &xep0174; (i.e., sections [1.2] and [2]). + For the purpose of IoT Discovery we are interested only in the "xmpp-client" service. + An XMPP server MUST publish four different kinds of DNS records to advertise its availability using the services of type "xmpp-client". + An XMPP chat client (actually its mDNS daemon) can send out multicast DNS queries for services of type "xmpp-client". + Note: the service of type "xmpp-client" is the reservered name for client-to-server connections by IANA, as described in &rfc6120;. +

+ +

In order to advertise its availability, a server MUST publish four different kinds of DNS records:

+
    +
  1. +

    A PTR record of the following form:

    + + + +
    2. +
  2. +

    An address ("A" or "AAAA") record of the following form (where the IP address can be either an IPv4 address or an IPv6 address):

    + + + +
    3. +
  3. +

    A SRV record of the following form:

    + + SRV port-number machine.local.]]> + +
    4. +
  4. +

    + A TXT record whose name is the same as the SRV record and whose value follows the format described in the TXT Record section of this document, consisting of a set of strings that typically represent a series of key-value pairs such as the following: +

    + + + +

    Note: The DNS-SD specification stipulates that the TXT record MUST be published, but that it MAY contain no more than a single zero byte (e.g., if the server does not wish to publish any personal information).

    +
    5. +
+

+ For the purpose of IoT Discovery we are interested only in the "xmpp-client" service. + An XMPP server MUST publish four different kinds of DNS records to advertise its availability using the services of type "xmpp-client". + An XMPP chat client (actually its mDNS daemon) can send out multicast DNS queries for services of type "xmpp-client". + Note: the service of type "xmpp-client" is the reservered name for client-to-server connections by IANA, as described in &rfc6120;. +

+

So, for example, if the machine name is "pronto", the IP address is "10.2.1.188", and the personal information, the DNS records would be as follows:

+ + + +

The IPv4 and IPv6 addresses associated with a machine might vary depending on the local network to which the machine is connected. For example, on an Ethernet connection the physical address might be "192.168.0.100" but when the machine is connected to a wireless network the physical address might change to "10.10.1.188". See &rfc3927; for details.

+

If the machine name asserted by a client is already taken by another machine on the network, the client MUST assert a different machine name, which SHOULD be formed by adding the character "-" and digit "1" to the end of the machine name string (e.g., "pronto-1"), adding the character "-" and digit "2" if the resulting machine name is already taken (e.g., "pronto-2"), and similarly incrementing the digit until a unique machine name is constructed.

+

+ Note: DNS-SD enables service definitions to include a TXT record that specifies parameters to be used in the context of the relevant service type. For detailed information refer to &xep0174; (Link-Local Messaging - TXT Record). +

+ + +

The registration process is described in &xep0174; (Link-Local Messaging - Registration Process).

+

The following submission registers parameters in use as of MONTH 201x. Refer to the registry itself for a complete and current list of parameters (this specification might or might not be revised when new parameters are registered).

+ + + ordom + The "origin domain" of the XMPP service. + recommended + + + + regis + + The username portion of the JID to Thing Registry; + can contain a space-separated list of more than one JID. + + optional + + + + provis + + The username portion of the JID to provisioning server; + can contain a space-separated list of more than one JID. + + optional + ]]> + + + + + +

TBD

+ + +

+ Note: If server-less messaging is to be used, as described in &xep0174; this step can be used to find the Thing Registry and optionally the + Provisioning Server and other peers it want to connect to. The next section can thus be skipped. +

+ + +

+ Once an XMPP Server has been found, a connection can be made. If multiple XMPP Servers are found, the client is free to choose the one that best suits its purposes. +

+

+ If the Thing does not have an account already, an account can be registered along what is specified in &xep0077;. If multiple servers are available, the first XMPP server that + allows account creation can be used. +

+ + +

+ If a Thing Registry is not preconfigured, one must be found. A Thing Registry can be hosted either as a server component using &xep0114; or as an XMPP Client accessible through + a JID. The following lists methods to obtaining the Component Address or JID for the Thing Registry. Note that the last one has security considerations + that need to be taken into account, if implemented. +

+
    +
  1. + Preconfigured Component Address of Thing Registry. A Component address is normally a subdomain to the domain of the XMPP Server that hosts the component. +
    2. +
  2. + Preconfigured bare JID of Thing Registry. +
    3. +
  3. + Preconfigured subdomain part of Component Address. This will be added to the domain of the XMPP Server used to connet to. +
    4. +
  4. + Preconfigured user name of JID. This will be added to the domain of the XMPP Server used to connected to. +
    5. +
  5. + Searching through Server Components on the XMPP Server currently connected to, as described in Determining Support. +
    6. +
+ + +

+ Once a Thing Registry has been found and been befriended, the Thing can register itself with the registry, as follows: +

+ + + + + + + + + + + + ]]> + +

+ There are two types of tags: Tags with string values and tags with numerical values. The distinction is important, since the type of value affects how + comparisons are made later when performing searches in the registry. +

+

+ The Thing should only register parameters required to be known by the owner of the Thing. Dynamic meta information must be avoided at this point. + To claim the ownership of the Thing, the owner needs to present the same meta information as registered by the Thing. Before an owner has claimed + ownership of the Thing, it will not be returned in any search results. A list of predefined meta tag names can be found in the Meta Tags + section below. +

+

+ The Thing can register itself as many times as it wants, and the response is always empty. Only one record per resource-less JID must be created. A new + registration overrides any previous information, including meta tags previously reported but not available in the new registration. Once a Thing has been + claimed by an owner, it should not register itself again, unless it is reset and the installation process restarted. +

+

+ If the Thing tries to register itself even though the Thing has already been claimed in the registry, the registry must not update any meta data in the registry, and instead + respond with the following response. When the thing receives this, it can safely extract the JID of the owner and switch its internal state to claimed. +

+ + + + ]]> + +

+ Note: Meta Tag names are case insensitive. In this document, all tag names have been written using upper case letters. +

+ + +

+ If a thing is self-owned, it can register itself with the Registry as normal, with the addition of setting the attribute selfOwned to true, + as is shown below. This registers the Thing directly as PUBLIC CLAIMED, with no need for an owner to claim ownership of the device. This can be useful if + installing Things that should be publically available. +

+ + + + + + + + + + + + ]]> + + + +

+ A Thing might reside behind a gateway or concentrator and might not be directly connected to the XMPP network itself, as is described in &xep0326;. In these cases, there are three optional + attributes that can be used to identify the Thing behind the JID: The nodeId attribute gives the ID of the Thing (a.k.a. "Node"). The Node might reside in + specific Data Source (large systems might have multiple sources of nodes). In this case, the data source is specified in the sourceId attribute. Normally, the Node ID + is considered to be unique within the concentrator. If multiple data sources are available, the Node ID is unique within the data source. However, a third attribute allows the uniqueness + to be restricted to a given cacheType. Finally, it is the triple (nodeId, sourceId, cacheType) which guarantees + uniqueness within the concentrator. +

+

+ For a Thing controlled by a concentrator to register itself in the Thing Registry, it simply adds the optional attributes nodeId, sourceId + and cacheType as appropriate to the registration request, as follows: +

+ + + + + + + + + + + + ]]> + +

+ If the Thing behind the concentrator is self-owned, it simply adds the selfOwned attribute to the request and sets it to true. +

+ + +

+ As mentioned above, the owner of the Thing must provide the information provided by the Thing to the Registry, in order to claim ownership over it. To avoid the + possibility that somebody can guess the information, the information must necessarily be long. This creates the problem of transfer of information. One method to solve this + is through the use of QR-codes. Such codes can be either printed on a sticker and put on the Thing itself, its wrapping, or displayed on its display when not claimed. + This QR-code can then be photographed by a smart phone or tablet, decoded and the information retrieved can be used in the ownership claim call. +

+

+ If QR-codes are used to transfer Thing meta data for ownership claims, it must be generated as follows: To the string "IoTDisco" is appended all meta tags in order. + Each tag name is prefixed by a semi-colon (;), and if the tag is numeric, the tag is prefixed by an additional hash sign (#). Each tag value is prefixed by a colon (:). + If the meta value contains semi-colons or back-slashes, each one is prefixed by a back-slash. When decoding the string, this allows the decoder to correctly differ + between tag delimiters and characters belonging to tag values. A tag name must never contain colon, hash sign or white space characters. +

+

+ The above meta data would therefore generate the string: +

+ + + +

+ Using UTF-8 encoding when generating the QR-code, this string returns the following QR-code: +

+

+ +

+

+ To generate a QR-code, Google Chart API can be used: + https://chart.googleapis.com/chart?cht=qr&chs=200x200&chl=IoTDisco;SN:394872348732948723;MAN:www.ktc.se;MODEL:IMC;#V:1.2;KEY:4857402340298342 +

+

+ Once the client has the required meta information about the Thing to claim ownership, it sends itself the following request to the Thing Registry: +

+ + + + + + + + + + ]]> + +

+ If this claim is successful, the Thing is marked as a public claimed Thing. The thing can always be removed later, but after the claim, the Thing is public. If you want to claim + a private Thing, you can add the public attribute with value false to the claim, as follows: +

+ + + + + + + + + + ]]> + +

+ In this case, if the claim is successful, the Thing will not be made public in the Thing Registry, after the claim. +

+

+ If a claim is successful, i.e. there's a Thing that has not been claimed with EXACTLY the same meta data (however, the order is not important), the Thing is marked in the + Registry as CLAIMED, and as public or private depending on the public attribute, and an empty result is returned as follows. If there's a claimed Thing with + exactly the same meta data, and the JID of the claimant (without resource) matches the JID of the claimer (without resource), a success response is also returned, containing + the resource-less JID of the Thing, as follows: +

+ + + + ]]> + +

+ If the Thing that has been claimed resides behind a concentrator, the result will contain those of the attributes nodeId, sourceId + and cacheType that are required to access the Thing in calls made using &xep0323;, &xep0324;, &xep0325; and &xep0326;. The following example illustrates + a response where a Thing behind a Concentrator has been claimed: +

+ + + + ]]> + +

+ If, on the other hand, no such Thing was found, or if such a Thing was found, but it is already claimed by somebody else, a failure response is returned. This response + should avoid to inform the client in detail why the claim failed, as follows: +

+ + + + + + ]]> + +

+ When the Thing has been successfully claimed, the Registry sends information about this to the Thing, to inform it that it has been claimed and the resource-less JID of owner. + After receiving this information, it doesn't need to register itself with the Registry anymore. +

+ + + + ]]> + +

+ If the Thing was claimed as a private Thing, this is shown using the public attribute in the response, as follows: +

+ + + + ]]> + +

+ If the public attribute is present and has value false, it means no further meta data updates are necessary, since + the device is not searchable through the Thing Registry. +

+

+ If the Thing resides behind a concentrator, the request must contain those of the attributes nodeId, sourceId + and cacheType that are required to access the Thing, as follows: +

+ + + + ]]> + +

+ The Thing simply returns an empty response to acknowledge the receipt of the information, as follows: +

+ + ]]> + +

+ After receiving this, the thing knows it can accept friendship requests from the corresponding owner. It can also safely send a friendship request to the owner. +

+

+ Note: Meta Tag names are case insensitive. In this document, all tag names have been written using upper case letters. +

+ + +

+ After a Thing has been claimed and is registed as a PUBLIC CLAIMED Thing in the Registry, it implies the Thing is available in searches. The owner can choose to remove + the Thing from the Registry, to avoid that the Thing appears in searches. To remove a Thing from the Registry the owner simply sends a removal request to the Registry + with the resource-less JID of the Thing to remove, as follows: +

+ + + + ]]> + +

+ If the Thing resides behind a concentrator, the request must contain those of the attributes nodeId, sourceId + and cacheType that are required to access the Thing, as follows: +

+ + + + ]]> + +

+ If such a Thing is found and is owned by the caller, it is removed from the Registry, and an empty response is returned, to acknowledge the removal of the Thing + from the registry, as follows: +

+ + ]]> + +

+ However, if such a thing is not found, or if the thing is owned by another, an item-not-found error is returned, as follows: +

+ + + + + + ]]> + +

+ After successfully removing a Thing from the Registry, and if the Thing is friend to the Registry, the Registry informs the Thing it has been removed from the Registry. + It does this, so the Thing can remove the friendship and stop any meta data updates to the Registry. +

+ + + + + + ]]> + +

+ If the Thing lies behind a concentrator, the removal request would look as follows: +

+ + + + ]]> + +

+ The Thing acknowledges the removal request by returning an empty response, as follows: +

+ + ]]> + + + +

+ Up to this point only basic configuration and ownership and visibility of a Thing has been covered. For more advanced operations, a Thing might be required to + use a Provisioning Server to whom it can delegate trust and allow making decisions, controlling access rights and privileges for the Thing, as described in &xep0324;. + If a Provisioning Server is not preconfigured, one must be found. The following lists methods to obtaining the JID for the Provisioning Server. +

+
    +
  1. + Preconfigured Component Address of Provisioning Server. A Component address is normally a subdomain to the domain of the XMPP Server that hosts the component. +
    2. +
  2. + Preconfigured bare JID of Provisioning Server. +
    3. +
  3. + Preconfigured subdomain part of Component Address. This will be added to the domain of the XMPP Server used to connet to. +
    4. +
  4. + Preconfigured user name of JID. This will be added to the domain of the XMPP Server used to connected to. +
    5. +
  5. + The Thing Registry itself can be a Provisioning Server. This can be found out by sending a discovery request to the Thing Registry, + as described in Determining Support. +
    6. +
  6. + The Owner itself can be a Provisioning Server. This can be found out by sending a discovery request to the Owner, + as described in Determining Support. +
    7. +
  7. + Searching through Server Components on the XMPP Server currently connected to, as described in Determining Support. +
    8. +
+ + +

+ Once a Provisioning Server has been found and been befriended, the Thing can delegate its trust to it, according to &xep0324;. +

+ + +

+ Once a Thing has been claimed and chooses to reside as a public Thing in the registry, it can update its meta information at any time. This meta information + will be available in searches made to the registry by third parties and is considered public. However, the Thing should be connected to a provisioning server + at this point, so that correct decisions can be made regarding to friendship, readout and control requests made by parties other than the owner. +

+

+ Meta information updated in this way will only overwrite tags provided in the request, and leave other tags previously reported as is. To remove a string-valued tag, + it should be updated with an empty value. It is also recommended that key meta information required to claim ownership of the Thing after a factory reset is + either removed, truncated or otherwise modified after it has been claimed so that third parties with physical access to a public Thing cannot hijack it by searching + for it, extracting its meta information from the registry, then resetting it and then claiming ownership of it. +

+

+ To update meta data about itself, a Thing simply sends a request to the Thing Registry, as follows: +

+ + + + + + + + + ]]> + +

+ If the Thing resides behind a concentrator, the request must contain those of the attributes nodeId, sourceId + and cacheType that are required to access the Thing, as follows: +

+ + + + + + + + + ]]> + +

+ If the Thing is found in the registry and it is claimed, the registry simply acknowledges the update as follows: +

+ + ]]> + +

+ However, if the Thing is not found in the registry, probably because the owner has removed it from the registry, an error response is returned. When receiving + such a response, the Thing should assume it is the owner who has removed it from the registry, and that further meta data updates are not desired. The Thing + can then unfriend the registry and stop further meta data updates. The error response from the registry would look as follows: +

+ + + + + + ]]> + +

+ If the Thing on the other hand is found in the Registry, but is not claimed, the registry must not update any meta data in the registry, and instead + respond with the following response. When the thing receives this, the Thing can assume it has been disowned, and perform a new registration in the Registry so + that it can be re-claimed. +

+ + + + ]]> + +

+ Note: Meta Tag names are case insensitive. In this document, all tag names have been written using upper case letters. +

+ + +

+ It is possible for anyone with access to the Thing Registry to search for public Things that have been claimed, including self-owned Things. Such searches + will never return things that have not been claimed or have been removed from the registry. +

+

+ A search is performed by providing one or more comparison operators in a search request to the registry. If more than one comparison operator is provided, the + search is assumed to be performed on the intersection (i.e. AND) of all operators. If the union (i.e. OR) of different conditions is desired, multiple consecutive + searches have to be performed. +

+

+ The following table lists available search operators, their element names and meanings: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ElementTypeOperatorDescription
strEqStringtag = cSearches for string values tags with values equal to a provided constant value.
strNEqStringtag <> cSearches for string values tags with values not equal to a provided constant value.
strGtStringtag > cSearches for string values tags with values greater than a provided constant value.
strGtEqStringtag >= cSearches for string values tags with values greater than or equal to a provided constant value.
strLtStringtag < cSearches for string values tags with values lesser than a provided constant value.
strLtEqStringtag <= cSearches for string values tags with values lesser than or equal to a provided constant value.
strRangeStringmin <(=) tag <(=) maxSearches for string values tags with values within a specified range of values. The endpoints can be included or excluded in the search.
strNRangeStringtag <(=) min OR tag >(=) maxSearches for string values tags with values outside of a specified range of values. The endpoints can be included or excluded in the range (and therefore correspondingly excluded or included in the search).
strMaskStringtag LIKE cSearches for string values tags with values similar to a provided constant value including wildcards.
numEqNumerictag = cSearches for numerical values tags with values equal to a provided constant value.
numNEqNumerictag <> cSearches for numerical values tags with values not equal to a provided constant value.
numGtNumerictag > cSearches for numerical values tags with values greater than a provided constant value.
numGtEqNumerictag >= cSearches for numerical values tags with values greater than or equal to a provided constant value.
numLtNumerictag < cSearches for numerical values tags with values lesser than a provided constant value.
numLtEqNumerictag <= cSearches for numerical values tags with values lesser than or equal to a provided constant value.
numRangeNumericmin <(=) tag <(=) maxSearches for numerical values tags with values within a specified range of values. The endpoints can be included or excluded in the search.
numNRangeNumerictag <(=) min OR tag >(=) maxSearches for numerical values tags with values outside of a specified range of values. The endpoints can be included or excluded in the range (and therefore correspondingly excluded or included in the search).
+

+ The following example shows how a search for specific devices within a specific geographic area can be found. More precisely, it searches for a certain kind of PLC + produced by a certain manufacturer, but only versions 1.0 <= v < 2.0 and with serial numbers beginning with 39487. The PLCs must also lie within latitude 33 ad 34 + degrees south and between longitude 70 and 72 west. +

+ + + + + + + + + + + ]]> + +

+ The offset attribute tells the registry the number of responses to skip before returning found things. It provides a mechanism to page result sets + that are too large to return in one response. the maxCount attribute contains the desired maximum number of things to return in the response. The + registry can lower this value, if it decides the requested maximum number is too large. +

+

+ If tag names are not found corresponding to the names provided in the search, the result set will always be empty. There's a reserved tag named KEY + that can be used to provide information shared only between things and their owners. If a search contains an operator referencing this tag name, the result set + must also always be empty. Searches on KEY MUST never find things. Furthermore, search results must never return KEY tags. +

+

+ The registry returns any things found in a response similar to the following: +

+ + + + + + + + + + + + + ... + + ]]> + +

+ If a Thing resides behind a concentrator, the response must contain those of the attributes nodeId, sourceId + and cacheType that are required to access the Thing, as follows: +

+ + + + + + + + + + + + + ... + + ]]> + +

+ If more results are available in the search (accessible by using the offset attribute in a new search), the more attribute is + present with value true. +

+

+ Note: Meta Tag names are case insensitive. In this document, all tag names have been written using upper case letters. +

+ + +

+ A thing can unregister itself from the Registry. This can be done in an uninstallation procedure for instance. To unregister from the registry, it simply sends + an un-registration request to the registry as follows. +

+ + + + ]]> + +

+ If the Thing resides behind a concentrator, the request must contain those of the attributes nodeId, sourceId + and cacheType that are required to access the Thing, as follows: +

+ + + + ]]> + +

+ The registry always returns an empty response, simply to acknowledge the receipt of the request. +

+ + ]]> + + + +

+ The owner of a Thing can disown the Thing, returning it to a state without owner. This is done by sending the following request to the Thing Registry: +

+ + + + ]]> + +

+ If the Thing resides behind a concentrator, the request must contain those of the attributes nodeId, sourceId + and cacheType that are required to access the Thing, as follows: +

+ + + + ]]> + +

+ If such a Thing is not found, or if the thing is not owned by the caller, an item-not-found error is returned, as follows: +

+ + + + + + ]]> + +

+ If such a Thing is found, and it is owned by the caller, but not online as a friend, the Thing cannot be disowned, since it would put the Thing in a state from which + it cannot be re-claimed. Therefore, the Thing Registry must respond in the following manner: +

+ + + + + + ]]> + +

+ Before returning a response to the caller, the Thing Registry informs the Thing it has been disowned. + It does this, so the Thing can remove the friendship to the owner, and perform a new registration. +

+ + + + ]]> + +

+ If the Thing lies behind a concentrator, the disowned request would look as follows: +

+ + + + ]]> + +

+ The Thing acknowledges that it has been disowned by returning an empty response, as follows: +

+ + ]]> + +

+ When receiving the acknowledgement from the Thing, the Thing is set as an unclaimed Thing in the Registry. Furthermore, all tags corresponding to the Thing are removed from the + registry, and a random KEY tag is added of sufficient complexity to make sure other clients cannot claim the Thing by guessing. Finally, an empty response is returned, to + acknowledge that the Thing has been disowned, as follows: +

+ + ]]> + +

+ If for any reason, the Thing does not acknowledge the disowned request, or an error occurs, the Registry returns the same error as if the Thing would have been offline. +

+ + + +

+ If an entity is a Thing Registry and supports the protocol specified herein, it MUST advertise that fact by returning a feature of "urn:xmpp:iot:discovery" in response + to &xep0030; information requests. +

+ + + + ]]> + + + + + ... + + ... + + ]]> + +

+ To search for a Thing Registry hosted as a component on an XMPP Server, you first request a list of available components, as follows: +

+ + + + ]]> + + + + + ... + + ... + + ]]> + +

+ If components (items) are supported, a request for available components is made: +

+ + + + ]]> + + + + + ... + + ... + + ]]> + +

+ The client then loops through all components (items) and checks what features they support, until a Thing Registry is found: +

+ + + + ]]> + + + + + ... + + ... + + ]]> + + + + +

+ A client must treat the connection between a Thing Registry differently if it is hosted as a client, having a JID, or if it is hosted as a Jabber Server Component. + If it is hosted as a server component, there's no need for the thing to become friends with the Thing Registry. Messages and requests can be made directly to the + server component without having to add it to the roster or request presence subscriptions. If the Thing Registry is hosted as a client, having a JID (@ in the address), + the Thing Registry must be added to the roster of the client before the client can communicate with the Thing Registry. +

+ + +

+ This document does not limit the number or names of tags used by Things to register meta information about themselves. However, it provides some general limits and defines + the meaning of a few tags that must have the meanings specified herein. +

+

+ The maximum length of a tag name is 32 characters. Tag names must not include colon (:), hash sign (#) or white space characters. String tag values + must not exceed 128 characters in length. +

+

+ The following table lists predefined tag names and their corresponding meanings. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Tag NameTypeDescription
ALTNumericAltitude (meters)
APTStringApartment associated with the Thing
AREAStringArea associated with the Thing
BLDStringBuilding associated with the Thing
CITYStringCity associated with the Thing
CLASSStringClass of Thing
COUNTRYStringCountry associated with the Thing
KEYStringKey, shared between thing and owner.
LATNumericLatitude (degrees)
LONNumericLongitude (degrees)
MANStringDomain name owned by the Manufacturer
MLOCStringMeter Location ID
MNRStringMeter Number
MODELStringName of Model
NAMEStringName associated with the Thing
PURLStringURL to product information for the Thing.
REGIONStringRegion associated with the Thing
SNStringSerial Number
STREETStringStreet Name
STREETNRStringStreet Number
VNumericVersion Number
+

+ It is up to the Thing Registry to choose which tags it persists and which tags it doesn't. To avoid the possibility of malicious reporting of tags, some limit should be + imposed on what tags are supported. As a minimum, a Thing Registry must support all predefined tags, as listed above. +

+

+ Note: Meta Tag names are case insensitive. In this document, all tag names have been written using upper case letters. +

+ + +

+ In the case the Thing Registry is not the XMPP Server to which the Thing is connected, a friendship relationship between the Thing and the Thing Registry needs to be handled. + To minimize the number of concurrent friends the Thing Registry needs to maintain, a Thing must only maintain an active friendship with the registry if it needs to + communicate with the registry. This means that unless updating meta data frequently, the Thing must unfriend the Registry when done with its communication. If only + updating meta data intermittently, the friendship can be reestablished when needed, and removed when done. +

+ + + + +

+ The &xep0114; provides an elegant way to introduce external services as server components using a third port into the server (the first two being the client-to-server port + and the server-to-server port). But since XEP-0114 is historical, meaning it is not guaranteed to conform to v1.0 of the XMPP specification, it has some serious security + issues: +

+
    +
  1. It lacks SSL/TLS support, or the starttls element to switch to TLS after connecting. This makes it possible to sniff traffic in this port.
    2. +
  2. It lacks SASL authentication. Instead a simple handshake is performed
    3. +
  3. There is no way to actually verify that the server is the server. This makes it possible to create a simple Man-in-the-middle attack.
    4. +
+

+ For these reasons, it is not recommended that a Thing Registry service, publishing itself as a Jabber Server Component, does so from outside of the network. Instead, + the Thing Registry should be installed on the same server or on a server in the same local area network, so that the Jabber Component protocol port is closed to the + Internet. +

+

+ Since it is not guaranteed that an XMPP Server operator allows installation of third party products (such as a Thing Registry), the option to host a Thing Registry using + a normal JID is still available. It can be used in proof of concepts, etc. For scalability issues it is recommended that the Thing Registry be hosted as a Jabber Server + Component when the population of Things grows. +

+ + +

+ If using predefined user names when searching for a Thing Registry or Provisioning Server, care must be taken to which XMPP Server things connect. + It might be possible for third parties to register these predefined account names, and pretend to be a Thing Registry or Provisioning Server and in this way hijack + unsuspecting Things. If installing things using this method of finding a Thing Registry or Provisioning Server, these accounts must be registered beforehand, to make + sure the things cannot be hijacked. +

+ + +

+ The combination of visible key meta information (perhaps in a visible QR-code) and a factory default reset button on a Thing, opens up the possibility to hijack the Thing. + To avoid this, at least one of the two should be removed after successful installation. Either the key meta information (QR-code) should be placed on the package or separate + paper and not on the thing itself, or the factory default reset button should be sealed or hidden and only accessible by licensed maintenance personell. If using an electronic + means to present the key meta information (for instance by displayed a QR-code on a display on the thing), care should be taken so that the information cannot be displayed + without breaking a seal, or other means to protect the Thing. +

+

+ Regardless the above security measures, a Thing can be hijacked by a third party in the time window between successful installation of the device and until the correct owner + has claimed ownership of the device. Minimizing this time window, and using a shared secret (KEY tag) between the Thing and its owner, decreases the possibility of getting the + thing hijacked. +

+ + +

+ Care should be taken what key meta information is used to accept an ownership claim. After a successful claim, this meta information is still available in the registry, + at least until the Thing is removed from the registry. While public in the registry, the meta information can be searched and presented to third parties. Access to this + information can help third parties to hijack Things, if they can reset them to factory default settings. +

+

+ To avoid this, the Thing can do three things after a successful ownership claim: +

+
    +
  • + Including a KEY tag in the key meta information. The KEY tag is not searchable nor presented in search results. +
    • +
  • + Remove, truncate or change some key meta information after a successful ownership claim. Partial information is not sufficient for a successful ownership claim. +
    • +
  • + Remove the Thing from the registry. +
    • +
+ + +

+ The KEY tag is unique in that it is not searchable nor available is search results. For this reason it is ideal for providing secrets shared only + between the Thing and the owner. By providing a sufficiently long KEY value in the key meta information required to claim the Thing, guessing the information even though + the other meta information is available, will be sufficiently hard to make it practically impossible. +

+

+ Even though the KEY tag is not searchable or available in search results, it should be emptied by the Thing after a successful claim, just to make sure + the key cannot be learned by looking into the database of the registry, or by some other means. +

+ + +

+ This document does not limit tag names or the number of tags that can be used by Things. This opens up the possibility of tag spam. Malicious things could fill the database + of the registry by reporting random tag names until the database is full. +

+

+ To prevent such malicious attacks, the registry could limit the tags it allows to be stored in the database. The registry must however allow the storage of the predefined + tag names defined in this document. If it has a configurable list of approved tags that can be stored, or if it allows any tags is an implementation decision. +

+ + +

+ If using external services when creating QR-codes, like the Google Charts API used in this document, make sure HTTPS is used and certificates validated. If HTTP is used, + meta-data tags used in Thing Registry registrations can be found out by sniffing the network, making it possible to hijack the corresponding devices. +

+ + +

TBD

+ + + +

TBD

+ + + +

TBD

+ + + + +

This document requires no interaction with &IANA;.

+ + +

+ The protocol schema needs to be added to the list of XMPP protocol schemas. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +]]> + + + +

+ For more information, please see the following resources: +

+ + + +

+ Thanks to Henrik Svedlund, Ivan Vučica, Joachim Lindborg, Joakim Eriksson, Joakim Ramberg, Johannes Hund, Karin Forsell, Kevin Smith, Lance Stout, Lars Åkerskog, Olof Zandrén, + Philipp Hancke, Steffen Larsen, Teemu Väisänen and Yusuke Doi for all valuable feedback. +

+ +