Giter Club home page Giter Club logo

idprov-standard's Introduction

'idprov' IoT Device Provisioning protocol standard

The IoT Device Provisioning protocol aims provide a secure, simple and easy to use means to provisioning IoT device with a signed certificate.

The protocol definition can be found here: idprov-protocol.md

Status

DEPRECATED in favor of WoT (Web Of Things) W3C standard, as implemented in the HiveOT Hub and Protocol bindings. This standard is no longer active. The standard is currently being validate within the WoST project, where it serves to provision 'Thing devices' with the WoST Hub.

Audience

This project is aimed at IoT developers that need a method of provisioning IoT devices with support for out-of-band verification.

Description

The primary objective of provisioning is for the client to discover the server and establish a trusted relationship between client and server.

IDProv is a simple and easy to implement standard for M2M (machine to machine) service discovery and provisioning of IoT devices and services to enable secure authenticated connections from an IoT device to IoT services.

This standard focuses on provisioning over the local network only. Internet based trust is out of scope as it is already covered with the ACME protocol using DNS and certificate providers. Internet access to local devices can also facilitated by WoST through the use of an Intermediary service. This too is out of scope of provisioning.

Provisioned devices use their signed certificate for establishing a mutual authenticated and secured connection over SSL/TLS with a service provider.

The 'idprov-protocol' document describes the protocol in detail. A reference implementation of client and server in golang is available in 'idprov-go'.

Provisioning Standard

The scope of provisioning by this standard addresses:

  1. Discovery of the provisioning server by the client
  2. Establishing trust of the server by the client
  3. Establishing trust of the client by the server

Discovery

For automated M2M provisioning this standard defines the use of DNS-SD/Zeroconf for discovering the IDProv server on the local network using the '_idprov._tcp' service type and a TXT record with the path "path=/path/to/directory" endpoint.

The server publishes this discovery record on the local network for discovery by clients on the same network. Clients can obtain the IDProv information by querying the published address using the path as the endpoint.

Additional methods of discovery are possible. For example using NFC to transfer the server address to the IoT device and at the same time receive the Device ID and OOB secret. These methods are currently out of scope of this standard but might be included in the future.

Establish trust of the server by the client

Establishing trust of the server means that the client can be guaranteed that the server is who it claims to be and not a malicious actor.

If a CA certificate is already pre-provisioned on the client then full trust is automatically established by the TLS protocol used to connect to the server.

If no CA certificate is available at the time of provisioning then the shared out-of-band secret can be used to establish trust for the client as it does for the server, without the need to take a leap of faith. The protocol provides the means of verifying that the server indeed does possess the shared secret obtained through the out-of-band method.

Establising trust of the client by the server

Establishing trust of the client means that the server can verify that the client is who it claims to be to allow it to publish and subscribe messages. This is addressed by the use of out-of-band secrets, or in case of certificate renewal the use of a client certificate signed by the server CA.

Any out of band verification method can be used that provides the server with a secret. The simplest method is using the serial# as the secret. Depending on the device capabilities, other methods to transfer a secret can be used such as NFC, QR code or Bluetooth. Fundamentally the transfer of a device ID and secret must be supported.

Other Protocols

Several other protocols exist that can be used for provisioning. Most of them have the drawback that they are either not intended for M2M authentication, are more complicated, or difficult to use. IDProv is specifically designed for very simple provisioning over the local network.

Example protocols that can be used for provisioning: This list is not complete but will be updated as other suitable protocols are found.

EAP-NOOB

The EAP-NOOB protocol defines an EAP method where the authentication is based on a user-assisted out-of-band (OOB) channel between the server and peer. Many out of band channels can be supported

Unfortunately it looks like the draft of this protocol has expired. As it is quite suited for M2M authentication support might be added in the future.

EAP-TLS

EAP-TLS is a certificate based mutual authentication protocol.

LWM2M

Light-weight M2M (LwM2M) which requires pre-provisioned credentials on the device

AWS IoT provisioning via MQTT

AWS IoT core API provide several ways to provision a device

Method 1: Install unique certificates on the IoT device ahead of delivery

Register the CA that was used to sign the device certificate with AWS IoT. The device is automatically provisioned on first use.

Method 2: Install unique certificate on an IoT device after delivery using an app.

Method 3: Use a shared claim certificate template to obtain a unique certificate during provisioning.

CreateCertificateFromCsr - the device creates a CSR and publishes it onto '$aws/certificates/create-from-csr/json|cbor'

The certifciate is published on '$aws/certificates/create-from-csr/json|cbor/accepted.'

Note that the IoT device has a private key that is not updated. If however it changes, a new CSR must be sent.

Microsoft Azure Device Provisioning Service

MS Azure IoT Hub Device Provisioning Service is intended for zero-touch provisioning of many devices.

The method uses an enrollment list provided by the manufacturer. One method is to include a x509 certificate during manufacturing, generator using the manufacturer CA. The other is to use a unique key such as serial number or MAC address.

This results in a device enrollment list for use by the DPS.

Contributing

Contributions to WoST projects are always welcome. There are many areas where help is needed, especially with documentation and building plugins for IoT and other devices. See CONTRIBUTING for guidelines.

Credits

This project is inspired by the IETF bootstrapping draft.

This project is part of the WoST project which builds on the Web of Things (WoT) standardization by the W3C.org standards organization. For more information https://www.w3.org/WoT/

idprov-standard's People

Contributors

hspaay avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.